Skip to content
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

Skip groovy.lang package in ModelConverters #4594

Merged
merged 3 commits into from
Jan 15, 2024
Merged

Skip groovy.lang package in ModelConverters #4594

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
5958343
Add 'groovy.lang' to ModelConverters skipped packages
micryc Jan 12, 2024
ab4b1c2
Add process test
micryc Jan 15, 2024
5b82045
Change skippedPackages access modifier to private
micryc Jan 15, 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
7 changes: 6 additions & 1 deletion modules/swagger-core/src/main/java/io/swagger/v3/core/converter/ModelConverters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ public ModelConverters(boolean openapi31) {
}
}

public Set<String> getSkippedPackages() {
return skippedPackages;
}

public static ModelConverters getInstance(boolean openapi31) {
if (openapi31) {
if (SINGLETON31 == null) {
Expand All @@ -58,7 +62,8 @@ public static ModelConverters getInstance(boolean openapi31) {
}

private static void init(ModelConverters converter) {
converter.skippedPackages.add("java.lang");
converter.addPackageToSkip("java.lang");
converter.addPackageToSkip("groovy.lang");

ServiceLoader<ModelConverter> loader = ServiceLoader.load(ModelConverter.class);
Iterator<ModelConverter> itr = loader.iterator();
Expand Down
18 changes: 18 additions & 0 deletions modules/swagger-core/src/test/java/io/swagger/v3/core/converting/ModelConverterTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -383,6 +383,23 @@ public void indirectPropertiesRecognized() {
assertEquals(model.getProperties().size(), 1);
}

@Test
public void checkDefaultSkippedPackages(){
ModelConverters modelConverters = ModelConverters.getInstance();

assertTrue(modelConverters.getSkippedPackages().contains("java.lang"));
assertTrue(modelConverters.getSkippedPackages().contains("groovy.lang"));
}

@Test(description = "It should not process skipped package")
public void ignoreSkippedPackage() throws ClassNotFoundException {
ModelConverters modelConverters = ModelConverters.getInstance();
final Type type = Class.forName("java.lang.String");
assertNull(modelConverters.readAllAsResolvedSchema(type));


}

@JsonSerialize(as = AnnotatedImplementationClass.class)
abstract class BaseClass {
public abstract String field();
Expand All @@ -406,6 +423,7 @@ public void directPropertiesRecognized() {
assertEquals(model.getProperties().size(), 1);
}


abstract class AnnotatedBaseClass {
@JsonProperty
public abstract String field();
Expand Down
Loading