Clean up annotations for application class and test classes (#888)

* remove @componentscan in favor of @SpringBootApplication and remove the redundant org.fairdatateam.fairdatapoint

* remove @EnableWebMvc in favor of the existing WebConfig (WebMvcConfigurer) class

* rename WebConfig to WebMvcConfig

* remove @EnableAsync in favor of the existing AsyncConfig class

* remove redundant package name from @ConfigurationPropertiesScan

* move the rdf4j sparql component scan to a separate Rdf4jSparqlConfig class (note that RepositoryConfig should actually be called Rdf4jRepositoryConfig, for consistency)

* remove allow-bean-definition-overriding from BaseIntegrationTest (no longer necessary after removing the test config classes in #902)

* remove SpringExtension from test base classes because this is already included in @SpringBootTest

* re-enable async processing in index trigger and ping tests

* remove unused @AutoConfigureMockMvc from WebIntegrationTest class because MockMvc is not used anywhere

* switch from WebEnvironment.DEFINED_PORT to WebEnvironment.RANDOM_PORT in WebIntegrationTest class to prevent issues with occupied port

see spring-boot testing docs for more info: https://docs.spring.io/spring-boot/reference/testing/spring-boot-applications.html

Author: dennisvang

src/main/java/org/fairdatateam/fairdatapoint/Application.java

@@ -25,18 +25,9 @@
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
-import org.springframework.context.annotation.ComponentScan;
-import org.springframework.scheduling.annotation.EnableAsync;
-import org.springframework.web.servlet.config.annotation.EnableWebMvc;
 
 @SpringBootApplication
-@EnableWebMvc
-@EnableAsync
-@ComponentScan(basePackages = {
-    "org.eclipse.rdf4j.http.server.readonly.sparql",
-    "org.fairdatateam.fairdatapoint.*"
-})
-@ConfigurationPropertiesScan("org.fairdatateam.fairdatapoint.config.*")
+@ConfigurationPropertiesScan
 public class Application {
 
     public static void main(String[] args) {

src/main/java/org/fairdatateam/fairdatapoint/config/Rdf4jSparqlConfig.java

@@ -0,0 +1,34 @@
+/**
+ * The MIT License
+ * Copyright © 2017 FAIR Data Team
+ *
+ * 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 org.fairdatateam.fairdatapoint.config;
+
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * Make sure the SparqlQueryEvaluator implementation bean can be found (SparqlQueryEvaluatorDefault)
+ */
+@Configuration
+@ComponentScan("org.eclipse.rdf4j.http.server.readonly.sparql")
+public class Rdf4jSparqlConfig {
+}

…team/fairdatapoint/config/WebConfig.java …m/fairdatapoint/config/WebMvcConfig.javasrc/main/java/org/fairdatateam/fairdatapoint/config/WebConfig.java renamed to src/main/java/org/fairdatateam/fairdatapoint/config/WebMvcConfig.java src/main/java/org/fairdatateam/fairdatapoint/config/WebConfig.java renamed to src/main/java/org/fairdatateam/fairdatapoint/config/WebMvcConfig.java

@@ -43,7 +43,7 @@
 import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL;
 
 @Configuration
-public class WebConfig implements WebMvcConfigurer {
+public class WebMvcConfig implements WebMvcConfigurer {
 
     @Autowired
     private List<ErrorConverter> errorConverters;

src/test/java/org/fairdatateam/fairdatapoint/BaseIntegrationTest.java

@@ -22,13 +22,10 @@
  */
 package org.fairdatateam.fairdatapoint;
 
-import org.junit.jupiter.api.extension.ExtendWith;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.test.context.ActiveProfiles;
-import org.springframework.test.context.junit.jupiter.SpringExtension;
 
-@ExtendWith(SpringExtension.class)
 @ActiveProfiles(Profiles.TESTING)
-@SpringBootTest(properties = {"spring.main.allow-bean-definition-overriding=true"})
+@SpringBootTest
 public abstract class BaseIntegrationTest {
 }

src/test/java/org/fairdatateam/fairdatapoint/WebIntegrationTest.java

@@ -25,18 +25,14 @@
 import org.fairdatateam.fairdatapoint.database.mongo.migration.development.MigrationRunner;
 import org.fairdatateam.fairdatapoint.database.rdf.migration.development.RdfDevelopmentMigrationRunner;
 import org.junit.jupiter.api.BeforeEach;
-import org.junit.jupiter.api.extension.ExtendWith;
 import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.boot.test.web.client.TestRestTemplate;
 import org.springframework.test.context.ActiveProfiles;
-import org.springframework.test.context.junit.jupiter.SpringExtension;
 
-@ExtendWith(SpringExtension.class)
 @ActiveProfiles(Profiles.TESTING)
-@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT)
-@AutoConfigureMockMvc
+// todo: in most cases we can probably use WebEnvironment.MOCK with MockMvc instead of TestRestTemplate (see #862)
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
 public abstract class WebIntegrationTest {
 
     public static final String ADMIN_TOKEN = "Bearer eyJhbGciOiJIUzUxMiJ9" +

src/test/java/org/fairdatateam/fairdatapoint/acceptance/index/admin/List_Trigger_POST.java

@@ -34,11 +34,13 @@
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.TestConfiguration;
 import org.springframework.core.ParameterizedTypeReference;
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.RequestEntity;
 import org.springframework.http.ResponseEntity;
+import org.springframework.scheduling.annotation.EnableAsync;
 
 import java.net.URI;
 import java.util.List;
@@ -202,4 +204,16 @@ public void res404_triggerOne() {
         assertThat("One AdminTrigger event is created", events.size(), is(equalTo(1)));
         assertThat("Records correct client URL", events.get(0).getAdminTrigger().getClientUrl(), is(equalTo(entry.getClientUrl())));
     }
+
+    /**
+     * Enables asynchronous request processing.
+     * This reproduces the exception handling behaviour of the production config,
+     * which causes RDF parsing exceptions to be ignored by the ExceptionControllerAdvice,
+     * because they occur in worker threads.
+     * The parsing exceptions should be reflected in the resulting IndexEntryState instead.
+     */
+    @TestConfiguration
+    @EnableAsync
+    public static class AsyncConfig {
+    }
 }

src/test/java/org/fairdatateam/fairdatapoint/acceptance/index/ping/List_POST.java

@@ -31,11 +31,13 @@
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.TestConfiguration;
 import org.springframework.core.ParameterizedTypeReference;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.RequestEntity;
 import org.springframework.http.ResponseEntity;
+import org.springframework.scheduling.annotation.EnableAsync;
 
 import java.net.URI;
 import java.util.HashMap;
@@ -177,4 +179,16 @@ public void res400_differentBody() {
         // THEN
         assertThat("Correct response code is received", result.getStatusCode(), is(equalTo(HttpStatus.BAD_REQUEST)));
     }
+
+    /**
+     * Enables asynchronous request processing.
+     * This reproduces the exception handling behaviour of the production config,
+     * which causes RDF parsing exceptions to be ignored by the ExceptionControllerAdvice,
+     * because they occur in worker threads.
+     * The parsing exceptions should be reflected in the resulting IndexEntryState instead.
+     */
+    @TestConfiguration
+    @EnableAsync
+    public static class AsyncConfig {
+    }
 }