[AVRO-1933] SchemaCompatibility class could be more user-friendly about incompatibilities

• Type: Improvement
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.7.7, 1.8.1
• Fix Version/s: 1.9.0
• Component/s: java

Environment

Any Java env

• Hadoop Flags: Incompatible change
• Release Note: SchemaCompatibility returns the more detailed object SchemaCompatibilityResult instead of the simple enum SchemaCompatibilityType.
• Flags: Patch
• Assignee: Anders Sundelin
• Reporter: Anders Sundelin
• Created: 12/Oct/16 12:40
• Updated: 07/Sep/17 12:24
• Resolved: 07/Sep/17 12:24

Description

Today, the class SchemaCompatibility reports incompatibilities with quite little detail. The whole reader and the whole writer schema is listed, and no particular detail about what was incompatible.

The attached patch fixes this, introducing a new enum (SchemaIncompatibilityType), and more specific sub-schemas that were incompatible.
The old, overall picture, is still there - the new compatibility state is encapsulated in the SchemaCompatibilityDetails class.
Lots of test cases have been added, and there has been refactoring done in the TestSchemaCompatibility and other test classes.

Issue Links

• is depended upon by: AVRO-2003 Report specific location of schema incompatibilities
• relates to: AVRO-2072 ResolvingGrammarGenerator doesn't implement schema resolution correctly for unions
• links to: GitHub Pull Request #200