Skip to content

Checking the uniqueness of elements in the ENUM to ensure the correctness of the generated classes #14366

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.

Sign up for GitHub

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 2 commits into
base: master
Choose a base branch
from
Open

Checking the uniqueness of elements in the ENUM to ensure the correctness of the generated classes #14366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9379358
Checking the uniqueness of elements in the ENUM to ensure the correct…
shmakovalexey Jan 2, 2023
60577ce
refactoring - use Map::getOrDefault
shmakovalexey Jan 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6330,7 +6330,7 @@ protected List<Map<String, Object>> buildEnumVars(List<Object> values, String da
String commonPrefix = findCommonPrefixOfVars(values);
truncateIdx = commonPrefix.length();
}

Map<String, Integer> uniqueNames = new HashMap<>();
for (Object value : values) {
Map<String, Object> enumVar = new HashMap<>();
String enumName;
Expand All @@ -6342,8 +6342,8 @@ protected List<Map<String, Object>> buildEnumVars(List<Object> values, String da
enumName = value.toString();
}
}

enumVar.put("name", toEnumVarName(enumName, dataType));
String varName = toEnumVarName(enumName, dataType);
enumVar.put("name", ensureUniqueName(uniqueNames, varName));
enumVar.put("value", toEnumValue(String.valueOf(value), dataType));
enumVar.put("isString", isDataTypeString(dataType));
enumVars.add(enumVar);
Expand Down Expand Up @@ -6377,6 +6377,19 @@ protected List<Map<String, Object>> buildEnumVars(List<Object> values, String da
return enumVars;
}

/**
* If necessary, appends a suffix to enforce uniqueness of names within a namespace.
* @param uniqueNames Counts name occurrences within a namespace.
* @param name The proposed name.
* @return <code>name</code>, uniquely suffixed as necessary.
*/
protected String ensureUniqueName(Map<String, Integer> uniqueNames, String name) {
int count = uniqueNames.getOrDefault(name, 0) + 1 ;
if (uniqueNames.put(name, count) != null)
name = name + '_' + count;
return name;
}

protected void updateEnumVarsWithExtensions(List<Map<String, Object>> enumVars, Map<String, Object> vendorExtensions, String dataType) {
if (vendorExtensions != null) {
updateEnumVarsWithExtensions(enumVars, vendorExtensions, "x-enum-varnames", "name");
Expand Down
89 changes: 89 additions & 0 deletions modules/openapi-generator/src/test/java/org/openapitools/codegen/DefaultCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -789,6 +789,53 @@ public void updateCodegenPropertyEnumWithoutPrefixRemoved() {
Assert.assertEquals(enumVars.get(1).getOrDefault("value", ""), "\"animal_cat\"");
}


@Test
public void updateCodegenPropertyEnumWithMultiByteChars() {
{
final DefaultCodegen codegen = new DefaultCodegen();
codegen.setRemoveEnumValuePrefix(false);

CodegenProperty enumProperty = codegenProperty(Arrays.asList("猫", "Пёс", "Χάμστερ"));

codegen.updateCodegenPropertyEnum(enumProperty);

List<Map<String, Object>> enumVars = (List<Map<String, Object>>) enumProperty.getItems().getAllowableValues().get("enumVars");

Assert.assertNotNull(enumVars);
Assert.assertNotNull(enumVars.get(0));
Assert.assertEquals(enumVars.get(0).getOrDefault("name", ""), "_");
Assert.assertEquals(enumVars.get(0).getOrDefault("value", ""), "\"猫\"");
Assert.assertNotNull(enumVars.get(1));
Assert.assertEquals(enumVars.get(1).getOrDefault("name", ""), "__2");
Assert.assertEquals(enumVars.get(1).getOrDefault("value", ""), "\"Пёс\"");
Assert.assertNotNull(enumVars.get(2));
Assert.assertEquals(enumVars.get(2).getOrDefault("name", ""), "__3");
Assert.assertEquals(enumVars.get(2).getOrDefault("value", ""), "\"Χάμστερ\"");
}
{
final DefaultCodegen codegen = new DefaultCodegen();
codegen.setRemoveEnumValuePrefix(false);

CodegenProperty enumProperty = codegenProperty(Arrays.asList("1ый квартал", "1ый день", "1ая смена"));

codegen.updateCodegenPropertyEnum(enumProperty);

List<Map<String, Object>> enumVars = (List<Map<String, Object>>) enumProperty.getItems().getAllowableValues().get("enumVars");

Assert.assertNotNull(enumVars);
Assert.assertNotNull(enumVars.get(0));
Assert.assertEquals(enumVars.get(0).getOrDefault("name", ""), "_1_");
Assert.assertEquals(enumVars.get(0).getOrDefault("value", ""), "\"1ый квартал\"");
Assert.assertNotNull(enumVars.get(1));
Assert.assertEquals(enumVars.get(1).getOrDefault("name", ""), "_1__2");
Assert.assertEquals(enumVars.get(1).getOrDefault("value", ""), "\"1ый день\"");
Assert.assertNotNull(enumVars.get(2));
Assert.assertEquals(enumVars.get(2).getOrDefault("name", ""), "_1__3");
Assert.assertEquals(enumVars.get(2).getOrDefault("value", ""), "\"1ая смена\"");
}
}

@Test
public void postProcessModelsEnumWithPrefixRemoved() {
final DefaultCodegen codegen = new DefaultCodegen();
Expand Down Expand Up @@ -846,6 +893,48 @@ public void postProcessModelsEnumWithExtension() {
Assert.assertEquals(enumVars.get(1).getOrDefault("enumDescription", ""), "This is a cat");
}

@Test
public void postProcessModelsEnumWithMultiByteChars() {
{
final DefaultCodegen codegen = new DefaultCodegen();
ModelsMap objs = codegenModel(Arrays.asList("猫", "Пёс", "Χάμστερ"));
CodegenModel cm = objs.getModels().get(0).getModel();

codegen.postProcessModelsEnum(objs);

List<Map<String, Object>> enumVars = (List<Map<String, Object>>) cm.getAllowableValues().get("enumVars");
Assert.assertNotNull(enumVars);
Assert.assertNotNull(enumVars.get(0));
Assert.assertEquals(enumVars.get(0).getOrDefault("name", ""), "_");
Assert.assertEquals(enumVars.get(0).getOrDefault("value", ""), "\"猫\"");
Assert.assertNotNull(enumVars.get(1));
Assert.assertEquals(enumVars.get(1).getOrDefault("name", ""), "__2");
Assert.assertEquals(enumVars.get(1).getOrDefault("value", ""), "\"Пёс\"");
Assert.assertNotNull(enumVars.get(2));
Assert.assertEquals(enumVars.get(2).getOrDefault("name", ""), "__3");
Assert.assertEquals(enumVars.get(2).getOrDefault("value", ""), "\"Χάμστερ\"");
}
{
final DefaultCodegen codegen = new DefaultCodegen();
ModelsMap objs = codegenModel(Arrays.asList("1ый квартал", "1ый день", "1ая смена"));
CodegenModel cm = objs.getModels().get(0).getModel();

codegen.postProcessModelsEnum(objs);

List<Map<String, Object>> enumVars = (List<Map<String, Object>>) cm.getAllowableValues().get("enumVars");
Assert.assertNotNull(enumVars);
Assert.assertNotNull(enumVars.get(0));
Assert.assertEquals(enumVars.get(0).getOrDefault("name", ""), "_1_");
Assert.assertEquals(enumVars.get(0).getOrDefault("value", ""), "\"1ый квартал\"");
Assert.assertNotNull(enumVars.get(1));
Assert.assertEquals(enumVars.get(1).getOrDefault("name", ""), "_1__2");
Assert.assertEquals(enumVars.get(1).getOrDefault("value", ""), "\"1ый день\"");
Assert.assertNotNull(enumVars.get(2));
Assert.assertEquals(enumVars.get(2).getOrDefault("name", ""), "_1__3");
Assert.assertEquals(enumVars.get(2).getOrDefault("value", ""), "\"1ая смена\"");
}
}

@Test
public void testExample1() {
final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/examples.yaml");
Expand Down