WIP - unit tests for exception advice

Author: anjeyy

grpc-server-spring-boot-autoconfigure/build.gradle

@@ -16,12 +16,14 @@ dependencies {
     api project(':grpc-common-spring-boot')
     api 'org.springframework.boot:spring-boot-starter'
     optionalSupportImplementation 'org.springframework.boot:spring-boot-starter-actuator'
+    optionalSupportImplementation 'org.springframework.boot:spring-boot-starter-aop'
     optionalSupportImplementation 'org.springframework.security:spring-security-core'
     optionalSupportImplementation 'org.springframework.cloud:spring-cloud-starter-sleuth'
     optionalSupportImplementation 'org.springframework.cloud:spring-cloud-starter-consul-discovery'
     optionalSupportImplementation 'org.springframework.cloud:spring-cloud-starter-netflix-eureka-client'
     optionalSupportImplementation "com.alibaba.cloud:spring-cloud-starter-alibaba-nacos-discovery:${springCloudAlibabaNacosVersion}"
-    optionalSupportImplementation 'com.google.inject:guice:4.2.3' // Only needed to avoid some warnings during compilation (for eureka)
+    // Only needed to avoid some warnings during compilation (for eureka)
+    optionalSupportImplementation 'com.google.inject:guice:4.2.3'
     optionalSupportImplementation 'io.zipkin.brave:brave-instrumentation-grpc'
     optionalSupportApi 'io.grpc:grpc-netty'
     api 'io.grpc:grpc-netty-shaded'
@@ -37,5 +39,6 @@ dependencies {
         exclude module: 'junit'
     }
 
+    runtimeOnly 'org.aspectj:aspectjweaver'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'
 }

tests/src/test/java/net/devh/boot/grpc/test/config/BaseExceptionAdviceAutoConfiguration.java

@@ -0,0 +1,36 @@
+/*
+ * Copyright (c) 2016-2020 Michael Zhang <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package net.devh.boot.grpc.test.config;
+
+import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
+import org.springframework.context.annotation.Configuration;
+
+import net.devh.boot.grpc.server.service.exceptionhandling.GrpcExceptionHandlerMethodResolver;
+import net.devh.boot.grpc.server.service.exceptionhandling.GrpcServiceAdviceDiscoverer;
+import net.devh.boot.grpc.server.service.exceptionhandling.GrpcServiceAdviceExceptionHandler;
+import net.devh.boot.grpc.server.service.exceptionhandling.GrpcServiceAdviceIsPresent;
+
+@Configuration
+@ImportAutoConfiguration({
+        GrpcServiceAdviceIsPresent.class,
+        GrpcServiceAdviceDiscoverer.class,
+        GrpcExceptionHandlerMethodResolver.class,
+        GrpcServiceAdviceExceptionHandler.class})
+public class BaseExceptionAdviceAutoConfiguration {
+
+}

tests/src/test/java/net/devh/boot/grpc/test/config/GrpcServiceAdviceConfig.java

@@ -17,40 +17,38 @@
 
 package net.devh.boot.grpc.test.config;
 
-import java.util.concurrent.atomic.AtomicBoolean;
-
-import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 
 import com.google.protobuf.Empty;
 
+import io.grpc.Status;
 import io.grpc.stub.StreamObserver;
 import net.devh.boot.grpc.server.service.GrpcService;
+import net.devh.boot.grpc.server.service.exceptionhandling.GrpcExceptionHandler;
+import net.devh.boot.grpc.server.service.exceptionhandling.GrpcServiceAdvice;
 import net.devh.boot.grpc.test.proto.SomeType;
-import net.devh.boot.grpc.test.proto.TestServiceGrpc.TestServiceImplBase;
+import net.devh.boot.grpc.test.proto.TestServiceGrpc;
 
 @Configuration
 public class GrpcServiceAdviceConfig {
 
-    @Bean
-    AtomicBoolean invocationCheck() {
-        return new AtomicBoolean(false);
-    }
 
     @GrpcService
-    TestServiceImplBase testServiceImplBase(final AtomicBoolean invocationCheck) {
-        return new TestServiceImplBase() {
-
-            @Override
-            public void normal(final Empty request, final StreamObserver<SomeType> responseObserver) {
-                throw new IllegalArgumentException("Trigger GrpcServiceAdvice");
-                // invocationCheck.set(true);
-                // final SomeType version = SomeType.newBuilder().setVersion("1.2.3").build();
-                // responseObserver.onNext(version);
-                // responseObserver.onCompleted();
-            }
-
-        };
+    public class TestGrpcService extends TestServiceGrpc.TestServiceImplBase {
+
+        @Override
+        public void normal(final Empty request, final StreamObserver<SomeType> responseObserver) {
+            throw new IllegalArgumentException("Trigger GrpcServiceAdvice");
+        }
+    }
+
+    @GrpcServiceAdvice
+    public class TestAdvice {
+
+        @GrpcExceptionHandler
+        public Status handleIllegalArgumentException(IllegalArgumentException e) {
+            return Status.NOT_FOUND.withCause(e).withDescription(e.getMessage());
+        }
     }
 
 }

tests/src/test/java/net/devh/boot/grpc/test/setup/GrpcServiceAdviceTest.java

@@ -17,24 +17,25 @@
 
 package net.devh.boot.grpc.test.setup;
 
-import static org.junit.jupiter.api.Assertions.assertFalse;
-import static org.junit.jupiter.api.Assertions.assertTrue;
-
 import java.util.concurrent.ExecutionException;
-import java.util.concurrent.atomic.AtomicBoolean;
 
+import org.assertj.core.api.Assertions;
+import org.junit.jupiter.api.Disabled;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.test.annotation.DirtiesContext;
 import org.springframework.test.context.junit.jupiter.SpringJUnitConfig;
 
+import io.grpc.Status;
+import io.grpc.StatusRuntimeException;
 import lombok.extern.slf4j.Slf4j;
 import net.devh.boot.grpc.server.service.exceptionhandling.GrpcServiceAdvice;
-import net.devh.boot.grpc.server.service.exceptionhandling.GrpcServiceAdviceExceptionHandler;
 import net.devh.boot.grpc.test.config.BaseAutoConfiguration;
+import net.devh.boot.grpc.test.config.BaseExceptionAdviceAutoConfiguration;
 import net.devh.boot.grpc.test.config.GrpcServiceAdviceConfig;
+import net.devh.boot.grpc.test.config.GrpcServiceAdviceConfig.TestGrpcService;
 import net.devh.boot.grpc.test.config.InProcessConfiguration;
 
 /**
@@ -48,37 +49,33 @@
         InProcessConfiguration.class,
         GrpcServiceAdviceConfig.class,
         BaseAutoConfiguration.class,
-        GrpcServiceAdviceExceptionHandler.class})
+        BaseExceptionAdviceAutoConfiguration.class})
 @DirtiesContext
 class GrpcServiceAdviceTest extends AbstractSimpleServerClientTest {
 
     public GrpcServiceAdviceTest() {
         log.info("--- GrpcServiceAdviceTest ---");
     }
 
-
-    // @GrpcServiceAdvice
-    // class TestAdvice {
-    //
-    // @GrpcExceptionHandler
-    // public StatusRuntimeException throwSomeError(IllegalArgumentException e) {
-    // return Status.NOT_FOUND.withDescription("Something not found").withCause(e).asRuntimeException();
-    // }
-    // }
-
     @Autowired
-    GrpcServiceAdviceExceptionHandler grpcServiceAdviceExceptionHandler;
+    private GrpcServiceAdviceConfig.TestAdvice testAdvice;
 
     @Autowired
-    AtomicBoolean invoked;
+    private TestGrpcService testGrpcService;
+
 
-    // @Override
+    @Disabled
     @Test
+    @Override
     void testSuccessfulCall() throws InterruptedException, ExecutionException {
 
-        assertFalse(this.invoked.get());
-        super.testSuccessfulCall();
-        assertTrue(this.invoked.get());
+        // TODO - @Aspect in GrpcServiceAdviceExceptionHandler not triggered
+        Assertions.assertThatThrownBy(super::testSuccessfulCall)
+                .isInstanceOf(StatusRuntimeException.class)
+                .hasMessage(Status.NOT_FOUND.toString())
+                .getCause()
+                .isInstanceOf(IllegalArgumentException.class)
+                .hasMessage("Trigger GrpcServiceAdvice");
     }
 
 }