Skip to content

Add SharedModelsValidator #6146

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

Open
wants to merge 1 commit into
base: feature/master/codegen-validation
Choose a base branch
from

Conversation

dagnir
Copy link
Contributor

@dagnir dagnir commented May 30, 2025

Motivation and Context

This validator ensures that when two services share models, any shared model definitions are identical.

Modifications

The diff is on the larger side, but most of the added lines are from the IntelliJ-generated equals() and hashCode() implementations.

The important changes are in SharedModelsValidator.java and SharedModelsValidatorTest.java.

Testing

  • New Unit tests
  • Manual validation by changing AttributeValue in dynamodb and verifying that codegen fails with the SHARED_MODELS_DIFFER error.

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

This validator ensures that when two services share models, any shared
model definitions are identical.
@dagnir dagnir force-pushed the dongie/shared-models-validation-pt3 branch from c29b20c to 20cf7d5 Compare May 30, 2025 22:17
@dagnir dagnir marked this pull request as ready for review May 30, 2025 22:31
@dagnir dagnir requested a review from a team as a code owner May 30, 2025 22:31
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

import software.amazon.awssdk.codegen.validation.ValidationEntry;
import software.amazon.awssdk.utils.Logger;

public class CodeGenerator {
private static final Logger log = Logger.loggerFor(CodeGenerator.class);
private static final String MODEL_DIR_NAME = "models";

// TODO: add validators
private static final List<ModelValidator> DEFAULT_MODEL_VALIDATORS = Collections.emptyList();
private static final List<ModelValidator> DEFAULT_MODEL_VALIDATORS = Collections.singletonList(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to double check, if some validators are manually specified in the CodeGenerator.Builder it will override the DEFAULT_MODEL_VALIDATORS. Is that what we want?

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.

2 participants