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.

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

Make scanning all JAX-RS packages explicit #3283

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import java.util.Set;

public class JaxrsAnnotationScanner<T extends JaxrsAnnotationScanner<T>> implements JaxrsOpenApiScanner {
private static final String ALL_PACKAGES = "*";

static final Set<String> ignored = new HashSet();

Expand Down Expand Up @@ -76,15 +77,18 @@ public Set<Class<?>> classes() {

boolean allowAllPackages = false;
if (openApiConfiguration.getResourcePackages() != null && !openApiConfiguration.getResourcePackages().isEmpty()) {
for (String pkg : openApiConfiguration.getResourcePackages()) {
if (!isIgnored(pkg)) {
acceptablePackages.add(pkg);
graph.whitelistPackages(pkg);
if (openApiConfiguration.getResourcePackages().contains(ALL_PACKAGES)) {
allowAllPackages = true;
} else {
for (String pkg : openApiConfiguration.getResourcePackages()) {
if (!isIgnored(pkg)) {
acceptablePackages.add(pkg);
graph.whitelistPackages(pkg);
}
}
}
} else {
allowAllPackages = true;
}
}

final Set<Class<?>> classes;
try (ScanResult scanResult = graph.scan()) {
classes = new HashSet<>(scanResult.getClassesWithAnnotation(javax.ws.rs.Path.class.getName()).loadClasses());
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
package io.swagger.v3.jaxrs2.integration;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Set;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.core.Application;

import org.my.project.resources.ResourceInPackageB;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;

import com.my.project.resources.ResourceInPackageA;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.integration.SwaggerConfiguration;

import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertNotEquals;
import static org.testng.Assert.assertTrue;

public class JaxrsApplicationAndAnnotationScannerTest {
private JaxrsApplicationAndAnnotationScanner scanner;

@Path("/app")
public static class ResourceInApplication {
@Operation(operationId = "test.")
@GET
public void getTest(@Parameter(name = "test") ArrayList<String> tenantId) {
return;
}
}

@BeforeMethod
public void setUp() {
scanner = new JaxrsApplicationAndAnnotationScanner();

scanner.setApplication(new Application() {
@Override
public Set<Class<?>> getClasses() {
return Collections.singleton(ResourceInApplication.class);
}
});
}

@Test(description = "scan classes from Application")
public void shouldOnlyScanClassesFromApplication() throws Exception {
assertEquals(scanner.classes().size(), 1);
assertTrue(scanner.classes().contains(ResourceInApplication.class));
}

@Test(description = "scan classes from all packages and Application")
public void shouldOnlyScanClassesFromAllPackagesAndApplication() throws Exception {
SwaggerConfiguration openApiConfiguration = new SwaggerConfiguration();
openApiConfiguration.setResourcePackages(Collections.singleton("*"));
scanner.setConfiguration(openApiConfiguration);

assertNotEquals(scanner.classes().size(), 1);
assertTrue(scanner.classes().contains(ResourceInPackageA.class));
assertTrue(scanner.classes().contains(ResourceInPackageB.class));
assertTrue(scanner.classes().contains(ResourceInApplication.class));
}

@Test(description = "scan classes from the packages and Application")
public void shouldOnlyScanClassesFromPackagesAndApplication() throws Exception {
SwaggerConfiguration openApiConfiguration = new SwaggerConfiguration();
openApiConfiguration.setResourcePackages(Collections.singleton("com.my.project.resources"));
scanner.setConfiguration(openApiConfiguration);

assertEquals(scanner.classes().size(), 2);
assertTrue(scanner.classes().contains(ResourceInPackageA.class));
assertTrue(scanner.classes().contains(ResourceInApplication.class));
}
}