Skip to content

[Java] Fix Potential Flaky Tests#10485

Merged
wing328 merged 7 commits intoOpenAPITools:masterfrom
xiedaxia1hao:master
Sep 28, 2021
Merged

[Java] Fix Potential Flaky Tests#10485
wing328 merged 7 commits intoOpenAPITools:masterfrom
xiedaxia1hao:master

Conversation

@xiedaxia1hao
Copy link
Copy Markdown
Contributor

This PR fixes some potential flaky tests in org.openapitools.codegen.java.AbstractJavaCodegenTest file.

In these tests, we assigned some hardcoded elements into the codegen's AdditionalModelTypeAnnotations.

However, according to the code where we set this value, we split the input string by a regex, convert it to a HashSet, and store in an ArrayList:

// org/openapitools/codegen/languages/AbstractJavaCodegen.java:347
if (additionalProperties.containsKey(ADDITIONAL_MODEL_TYPE_ANNOTATIONS)) {
    String additionalAnnotationsList = additionalProperties.get(ADDITIONAL_MODEL_TYPE_ANNOTATIONS).toString();
    this.setAdditionalModelTypeAnnotations(new ArrayList<>(Sets.newHashSet(additionalAnnotationsList.trim().split("\\s*(;|\\r?\\n)\\s*"))));
}

The problem is that HashSet is not guarantee that the order will remain constant over time according to the Java documentation. Thus, these assertions will fail in some platforms or specific machines that adopt a different iteration order.

To fix it, I sort the both additionalModelTypeAnnotations and codegen.getAdditionalModelTypeAnnotations() to make sure that their order is deterministic.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328
Copy link
Copy Markdown
Member

wing328 commented Sep 28, 2021

LGTM. Will merge after all tests pass

@wing328
Copy link
Copy Markdown
Member

wing328 commented Sep 28, 2021

Failed tests already fixes in the master.

@wing328 wing328 merged commit c09c626 into OpenAPITools:master Sep 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants