Add schema validation to Maven #1380
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add simplified WKT geometry check to schema. Schema validation limitations: - The plugin does not support validation of schema violations. See dataliquid/json-yaml-validator-maven-plugin#51 - The plugin does not support YAML aliases. See dataliquid/json-yaml-validator-maven-plugin#52
|
Full logs: https://github.com/onthegomap/planetiler/actions/runs/18958143687 |
Contributor
|
Instead of doing this through maven what if we add a json schema validator as a dependency. Then we could have the unit tests that validate these files also check they match the json schema. It would also let us add a |
Contributor
Author
|
I have no strong feelings about this approach. Having a |
|
Hi @zstadler, Great news! We've just released https://github.com/dataliquid/json-yaml-validator-maven-plugin/releases/tag/1.1.0 of the json-yaml-validator-maven-plugin which addresses both issues you reported:
Thank you for reporting these issues - they've made the plugin much more robust! About Our JSON Validation ApproachWhen we researched JSON validators a few months ago, we found that while many validators exist, only the networknt/json-schema-validator truly adheres correctly to the JSON Schema specification. Many other validators we tested had issues with spec compliance, particularly with complex features like conditionals, $ref resolution, and proper error reporting. That's why we built this Maven plugin around networknt/json-schema-validator. Our experience has shown it handles even complex JSON validations excellently, including:
Example with v1.1.0's New Features<plugin>
<groupId>com.dataliquid.maven</groupId>
<artifactId>json-yaml-validator-maven-plugin</artifactId>
<version>1.1.0</version>
<executions>
<!-- Validate that invalid configs are properly rejected -->
<execution>
<id>validate-invalid-configs</id>
<goals><goal>validate</goal></goals>
<configuration>
<schemaFile>src/main/resources/planetiler.schema.json</schemaFile>
<sourceDirectory>src/test/resources/invalid-configs</sourceDirectory>
<expectedResult>ERROR</expectedResult>
<expectedErrors>
<expectedError>.*storage.*required.*</expectedError>
<expectedError>.*threads.*minimum.*</expectedError>
</expectedErrors>
</configuration>
</execution>
</executions>
</plugin>I see @msbarry suggested an alternative approach with direct dependency integration. Both approaches could actually complement each other well - our plugin for build-time validation and the direct dependency for runtime validation and CLI commands. Feel free to try v1.1.0 if you'd like to continue with the Maven plugin approach. We're happy to help if you encounter any issues! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Also, add simplified WKT geometry pattern to schema.
Schema validation limitations: