Skip to content

Dongie/shared models validation pt3 #6145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from

Conversation

dagnir
Copy link
Contributor

@dagnir dagnir commented May 30, 2025

Motivation and Context

Modifications

Testing

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)

Checklist

  • I have read the CONTRIBUTING document
  • Local run of mvn install succeeds
  • My code follows the code style of this project
  • My change requires a change to the Javadoc documentation
  • I have updated the Javadoc documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed
  • I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
  • My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

  • I confirm that this pull request can be released under the Apache 2 license

dagnir and others added 3 commits May 29, 2025 13:24
* Add support for validating models in generator

This commit introduces `ModelValidator` which allows us to do validation
of the `IntermediateModel` before generation starts; violations are
emitted to a `validation-report.json` file under
`generated-sources/sdk/models`.

As part of this change, `CodeGenerator` was updated to accept
`IntermediateModel` as a parameter. This is because all validators
operate on the `IntermediateModel`, which already have any SDK specific
customizations applied. Since some validators require referencing
multiple models, (such as when we start validating shared shapes),
having the ability to pass in `IntermediateModel` directly means we only
need to build these models once, upfront.

* Changelog

* Add javadocs
This commit updates the generation mojo to suppport validators:

 - Add flag for controling whether the validation report is written to
   disk
 - Build all models to IntermediateModel upfront
 - If a service model targets another for sharing shapes, also pass in
   the target service IntermedidateModel
This validator ensures that when two services share models, any shared
model definitions are identical.
@dagnir dagnir closed this May 30, 2025
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
E Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant