Merge pull request #50398 from danielsoro/fix-rest-scope-definition

RestClient processor with NullPointerException during scope definition

Author: geoand

extensions/resteasy-classic/rest-client-config/deployment/src/main/java/io/quarkus/restclient/config/deployment/RestClientsBuildTimeConfigBuildItem.java

@@ -20,6 +20,7 @@
 import io.quarkus.restclient.config.RegisteredRestClient;
 import io.quarkus.restclient.config.RestClientKeysProvider;
 import io.quarkus.restclient.config.RestClientsBuildTimeConfig;
+import io.quarkus.runtime.configuration.ConfigurationException;
 import io.smallrye.config.ConfigValue;
 import io.smallrye.config.DefaultValuesConfigSource;
 import io.smallrye.config.SmallRyeConfig;
@@ -105,7 +106,8 @@ public Optional<BuiltinScope> getScope(final Capabilities capabilities, final Cl
 
         // First config in the rest client service
         restClientsBuildTimeConfig.clients().get(restClientInterface.name().toString()).scope()
-                .ifPresent(s -> discoveredScopes.add(Optional.of(builtinScopeFromName(DotName.createSimple(s)))));
+                .ifPresent(s -> discoveredScopes
+                        .add(builtinScopeFromName(DotName.createSimple(s), restClientInterface.name().toString())));
 
         // Second annotation in the rest client declaration
         Set<DotName> annotations = restClientInterface.annotationsMap().keySet();
@@ -118,7 +120,8 @@ public Optional<BuiltinScope> getScope(final Capabilities capabilities, final Cl
 
         // Third global config
         restClientsBuildTimeConfig.scope()
-                .ifPresent(s -> discoveredScopes.add(Optional.of(builtinScopeFromName(DotName.createSimple(s)))));
+                .ifPresent(s -> discoveredScopes
+                        .add(builtinScopeFromName(DotName.createSimple(s), restClientInterface.name().toString())));
 
         Optional<BuiltinScope> scope = discoveredScopes.stream()
                 .filter(Optional::isPresent)
@@ -136,15 +139,18 @@ public Optional<BuiltinScope> getScope(final Capabilities capabilities, final Cl
         return Optional.empty();
     }
 
-    private static BuiltinScope builtinScopeFromName(DotName scopeName) {
+    private static Optional<BuiltinScope> builtinScopeFromName(DotName scopeName, String restClientClass) {
         BuiltinScope scope = BuiltinScope.from(scopeName);
-        if (scope == null) {
-            for (BuiltinScope builtinScope : BuiltinScope.values()) {
-                if (builtinScope.getName().withoutPackagePrefix().equalsIgnoreCase(scopeName.toString())) {
-                    scope = builtinScope;
-                }
+        if (scope != null) {
+            return Optional.of(scope);
+        }
+
+        for (BuiltinScope builtinScope : BuiltinScope.values()) {
+            if (builtinScope.getName().withoutPackagePrefix().equalsIgnoreCase(scopeName.toString())) {
+                return Optional.of(builtinScope);
             }
         }
-        return scope;
+        throw new ConfigurationException(
+                String.format("Not possible to define the scope %s for the REST client %s ", scopeName, restClientClass));
     }
 }

extensions/resteasy-classic/resteasy-client/deployment/src/test/java/io/quarkus/restclient/configuration/ClientWithWrongScopeTest.java

@@ -0,0 +1,42 @@
+package io.quarkus.restclient.configuration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.fail;
+
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+
+import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;
+import org.eclipse.microprofile.rest.client.inject.RestClient;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.test.QuarkusUnitTest;
+
+public class ClientWithWrongScopeTest {
+
+    @RegisterExtension
+    static final QuarkusUnitTest config = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(MyClient.class))
+            .withConfigurationResource("client-with-wrong-scope.properties")
+            .assertException(t -> assertThat(t).hasMessageContaining("Not possible to define the scope"));
+
+    @RestClient
+    MyClient client;
+
+    @Test
+    public void testValidationFailed() {
+        // This method should not be invoked
+        fail();
+    }
+
+    @Path("/client")
+    @RegisterRestClient(configKey = "my-client")
+    public interface MyClient {
+
+        @GET
+        @Path("/")
+        String get();
+    }
+}

extensions/resteasy-classic/resteasy-client/deployment/src/test/resources/client-with-wrong-scope.properties

@@ -0,0 +1,2 @@
+my-client/mp-rest/url=http://localhost:${quarkus.http.test-port:8081}
+my-client/mp-rest/scope=wrong-scope

extensions/resteasy-reactive/rest-client/deployment/src/test/java/io/quarkus/rest/client/reactive/ClientWithWrongScopeTest.java

@@ -0,0 +1,37 @@
+package io.quarkus.rest.client.reactive;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.jupiter.api.Assertions.fail;
+
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+
+import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.test.QuarkusUnitTest;
+
+public class ClientWithWrongScopeTest {
+    @RegisterExtension
+    static final QuarkusUnitTest TEST = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(MyClient.class))
+            .withConfigurationResource("wrong-scope-test-application.properties")
+            .assertException(t -> assertThat(t).hasMessageContaining("Not possible to define the scope"));
+
+    @Test
+    public void testValidationFailed() {
+        // This method should not be invoked
+        fail();
+    }
+
+    @Path("/client")
+    @RegisterRestClient(configKey = "my-client")
+    public interface MyClient {
+
+        @GET
+        @Path("/")
+        String get();
+    }
+}

extensions/resteasy-reactive/rest-client/deployment/src/test/resources/wrong-scope-test-application.properties

@@ -0,0 +1,2 @@
+my-client/mp-rest/url=http://localhost:${quarkus.http.test-port:8081}
+my-client/mp-rest/scope=wrong-scope