Skip to content

No Issue - Add a warn in the logs when elements have duplicated vars #823

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

Merged
merged 3 commits into from
Oct 17, 2024
Merged

No Issue - Add a warn in the logs when elements have duplicated vars #823

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f525c91
No Issue - Add a warn in the logs when elements have duplicated vars
ricardozanini Oct 16, 2024
d327f5a
Fix imports
ricardozanini Oct 16, 2024
0e25fdb
Add the Override annotation
ricardozanini Oct 16, 2024
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
30 changes: 30 additions & 0 deletions ...in/java/io/quarkiverse/openapi/generator/deployment/wrapper/QuarkusJavaClientCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,12 @@
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;

import org.openapitools.codegen.CodegenModel;
import org.openapitools.codegen.CodegenProperty;
import org.openapitools.codegen.SupportingFile;
import org.openapitools.codegen.config.GlobalSettings;
import org.openapitools.codegen.languages.JavaClientCodegen;
Expand All @@ -18,6 +22,7 @@
import org.slf4j.LoggerFactory;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.Schema;
import io.swagger.v3.oas.models.servers.Server;

public class QuarkusJavaClientCodegen extends JavaClientCodegen {
Expand Down Expand Up @@ -129,6 +134,31 @@ public void postProcess() {

}

@Override
public CodegenModel fromModel(String name, Schema model) {
CodegenModel codegenModel = super.fromModel(name, model);
warnIfDuplicated(codegenModel);
return codegenModel;
}

private void warnIfDuplicated(CodegenModel m) {
Set<String> propertyNames = new TreeSet<>();
for (CodegenProperty element : m.allVars) {
if (element.deprecated) {
continue;
}

// We can have baseName as `my-type` and `myType`, that are duplicates
if (propertyNames.contains(element.name)) {
LOGGER.warn(
"Variable {} is duplicated in the OpenAPI spec file. Consider adding the 'deprecated' attribute to it or remove it from the file. Java class {} will fail to compile.",
element.baseName, m.classFilename);
} else {
propertyNames.add(element.name);
}
}
}

@Override
public String toEnumVarName(String value, String datatype) {

Expand Down
20 changes: 20 additions & 0 deletions ...o/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapperTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,26 @@

public class OpenApiClientGeneratorWrapperTest {

@Test
void verifyFlink() throws URISyntaxException, FileNotFoundException {
OpenApiClientGeneratorWrapper generatorWrapper = createGeneratorWrapper("issue-flink.yaml");
final List<File> generatedFiles = generatorWrapper.generate("org.acme.flink");
assertNotNull(generatedFiles);
assertFalse(generatedFiles.isEmpty());

final Optional<File> duplicatedVars = generatedFiles.stream()
.filter(f -> f.getName().endsWith("AsynchronousOperationResultOperation.java")).findFirst();
assertThat(duplicatedVars).isPresent();

CompilationUnit compilationUnit = StaticJavaParser.parse(duplicatedVars.orElseThrow());
List<VariableDeclarator> vars = compilationUnit.findAll(VariableDeclarator.class);
assertThat(vars).isNotEmpty();

// This openApi file has a duplicated field
assertThat(vars.stream()
.filter(v -> "failureCause".equals(v.getNameAsString())).count()).isEqualTo(4);
}

@Test
void verifySuffixPrefix() throws URISyntaxException {
OpenApiClientGeneratorWrapper generatorWrapper = createGeneratorWrapper("suffix-prefix-openapi.json");
Expand Down
Loading