Update /auth endpoint to /authentication (#375)

- Update raml to have /authentication and not /auth
- Update AthControllerImpl.java to AuthenticationControllerImpl.java
- Update tests
- Update documentation

Author: Anders Breid

src/functionaltests/resources/features/authentication.feature

@@ -23,31 +23,31 @@ Feature: Test Authentication
   @RESTWithSessionCookie
   Scenario: Call an REST API with session credentials
     Given LDAP is activated
-    When a GET request is prepared for REST API "/auth/login"
+    When a GET request is prepared for REST API "/authentication/login"
     And request is sent
     Then response code 401 is received
-    When a GET request is prepared for REST API "/auth/login"
+    When a GET request is prepared for REST API "/authentication/login"
     And username "gauss" and password "password" is used as credentials
     And request is sent
     Then response code 200 is received
-    When a GET request is prepared for REST API "/auth/login"
+    When a GET request is prepared for REST API "/authentication/login"
     And request is sent
     Then response code 200 is received
 
   @RESTWithTokenId
   Scenario: Call an REST API with session credentials
     Given LDAP is activated
-    When a GET request is prepared for REST API "/auth/logout"
+    When a GET request is prepared for REST API "/authentication/logout"
     And request is sent
-    When a GET request is prepared for REST API "/auth/login"
+    When a GET request is prepared for REST API "/authentication/login"
     And request is sent
     Then response code 401 is received
-    When a GET request is prepared for REST API "/auth/login"
+    When a GET request is prepared for REST API "/authentication/login"
     And username "gauss" and password "password" is used as credentials
     And request is sent
     Then response code 200 is received
     And authentication token is saved    
-    When a GET request is prepared for REST API "/auth/login"
+    When a GET request is prepared for REST API "/authentication/login"
     And client is replaced
     And authentication token is attached
     And request is sent

src/functionaltests/resources/features/authenticationMultiLDAP.feature

@@ -6,27 +6,27 @@ Feature: Test Authentication with multiple LDAP servers
   @RESTWithUniqueUsersInDifferentLDAPServers
   Scenario: Login using unique users from two different LDAP servers
     Given LDAP is activated
-    When a GET request is prepared for REST API "/auth/login"
+    When a GET request is prepared for REST API "/authentication/login"
     And username "gauss" and password "password" is used as credentials
     And request is sent
     Then response code 200 is received
-    When a GET request is prepared for REST API "/auth/logout"
+    When a GET request is prepared for REST API "/authentication/logout"
     And request is sent
-    When a GET request is prepared for REST API "/auth/login"
+    When a GET request is prepared for REST API "/authentication/login"
     And username "einstein" and password "e=mc2" is used as credentials
     And request is sent
     Then response code 200 is received
 
   @RESTWithIdenticalUsernamesInDifferentLDAPServers
   Scenario: Login using identical usernames with different passwords from two different LDAP servers
     Given LDAP is activated
-    When a GET request is prepared for REST API "/auth/login"
+    When a GET request is prepared for REST API "/authentication/login"
     And username "newton" and password "password" is used as credentials
     And request is sent
     Then response code 200 is received
-    When a GET request is prepared for REST API "/auth/logout"
+    When a GET request is prepared for REST API "/authentication/logout"
     And request is sent
-    When a GET request is prepared for REST API "/auth/login"
+    When a GET request is prepared for REST API "/authentication/login"
     And username "newton" and password "password2" is used as credentials
     And request is sent
     Then response code 200 is received

src/functionaltests/resources/features/restEndpoints.feature

@@ -14,8 +14,8 @@ Feature: Test Rest Endpoints
   Examples:
     | responsecode | endpoint                               |
     | 200          | /information                           |
-    | 200          | /auth                                  |
-    | 200          | /auth/login                            |
+    | 200          | /authentication                        |
+    | 200          | /authentication/login                  |
     | 200          | /status                                |
     | 200          | /templates                             |
     | 200          | /templates/events                      |

src/main/java/com/ericsson/ei/controller/AuthController.java renamed to src/main/java/com/ericsson/ei/controller/AuthenticationController.java

@@ -16,22 +16,22 @@
  */
 @RestController
 @Validated
-@RequestMapping(value = "/auth", produces = "application/json")
-public interface AuthController {
+@RequestMapping(value = "/authentication", produces = "application/json")
+public interface AuthenticationController {
 
 
     /**
      * This method checks if security is enabled.
      * 
      */
     @RequestMapping(value = "", method = RequestMethod.GET)
-    public ResponseEntity<?> getAuth(HttpServletRequest httpRequest);
+    public ResponseEntity<?> getAuthentication(HttpServletRequest httpRequest);
 
     /**
      * This method returns a logged in user.
      * 
      */
     @RequestMapping(value = "/login", method = RequestMethod.GET)
-    public ResponseEntity<?> getAuthLogin(HttpServletRequest httpRequest);
+    public ResponseEntity<?> getAuthenticationLogin(HttpServletRequest httpRequest);
 
 }

src/main/java/com/ericsson/ei/controller/AuthControllerImpl.java renamed to src/main/java/com/ericsson/ei/controller/AuthenticationControllerImpl.java

@@ -1,5 +1,5 @@
 /*
-   Copyright 2018 Ericsson AB.
+authentication   Copyright 2018 Ericsson AB.
    For a full list of individual contributors, please see the commit history.
 
    Licensed under the Apache License, Version 2.0 (the "License");
@@ -34,23 +34,23 @@
 import io.swagger.annotations.ApiOperation;
 
 /**
- * Endpoint /auth/login should be secured if LDAP is enabled.
- * Endpoint /auth should never be secured.
+ * Endpoint /authentication/login should be secured if LDAP is enabled.
+ * Endpoint /authentication should never be secured.
  */
 @Component
 @CrossOrigin
 @Api(value = "Auth", tags = { "Authentication" })
-public class AuthControllerImpl implements AuthController {
+public class AuthenticationControllerImpl implements AuthenticationController {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(AuthControllerImpl.class);
+    private static final Logger LOGGER = LoggerFactory.getLogger(AuthenticationControllerImpl.class);
 
     @Value("${ldap.enabled:false}")
     private boolean ldapEnabled;
 
     @Override
     @CrossOrigin
     @ApiOperation(value = "To check if security is enabled", response = String.class)
-    public ResponseEntity<?> getAuth(final HttpServletRequest httpRequest) {
+    public ResponseEntity<?> getAuthentication(final HttpServletRequest httpRequest) {
         try {
             return new ResponseEntity<>(new JSONObject().put("security", ldapEnabled).toString(),
                     HttpStatus.OK);
@@ -65,7 +65,7 @@ public ResponseEntity<?> getAuth(final HttpServletRequest httpRequest) {
     @Override
     @CrossOrigin
     @ApiOperation(value = "To get login of current user", response = String.class)
-    public ResponseEntity<?> getAuthLogin(final HttpServletRequest httpRequest) {
+    public ResponseEntity<?> getAuthenticationLogin(final HttpServletRequest httpRequest) {
         try {
             String currentUser = SecurityContextHolder.getContext().getAuthentication().getName();
             return new ResponseEntity<>(new JSONObject().put("user", currentUser).toString(),

src/main/java/com/ericsson/ei/handlers/StatusHandler.java

@@ -35,7 +35,7 @@
 public class StatusHandler {
 
     private static final String INITIAL_DELAY_OF_FIRST_STATUS_UPDATE = "1000";
-    private static final String INTERVAL_TO_RUN_STATUS_UPDATES = "30000";
+    private static final String INTERVAL_TO_RUN_STATUS_UPDATES = "5000";
 
     private StatusData statusData = new StatusData();
     private ObjectMapper objectMapper = new ObjectMapper();

src/main/resources/public/raml/eiffel-intelligence.raml

@@ -40,6 +40,6 @@ baseUri: /
 /templates: !include resourceTypes/templates.raml
 /failed-notifications: !include resourceTypes/failed-notifications.raml
 /rules: !include resourceTypes/rules.raml
-/auth: !include resourceTypes/auth.raml
+/authentication: !include resourceTypes/authentication.raml
 /status: !include resourceTypes/status.raml
 /information: !include resourceTypes/instance_info.raml

src/main/resources/public/raml/resourceTypes/auth.raml renamed to src/main/resources/public/raml/resourceTypes/authentication.raml

@@ -0,0 +1,45 @@
+package com.ericsson.ei.controller;
+
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.http.MediaType;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.MvcResult;
+import org.springframework.test.web.servlet.RequestBuilder;
+import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
+
+@AutoConfigureMockMvc
+public class ControllerTestBaseClass {
+
+    @Autowired
+    private MockMvc mockMvc;
+
+    protected void assertOkResponseStatus(String endpoint) throws Throwable {
+        mockMvc.perform(MockMvcRequestBuilders.get(endpoint)
+                                              .accept(MediaType.APPLICATION_JSON_VALUE))
+               .andExpect(status().isOk())
+               .andReturn();
+    }
+
+    protected void assertExpectedResponse(String endpoint, String responseBody) throws Throwable {
+        mockMvc.perform(MockMvcRequestBuilders.get(endpoint)
+                                              .accept(MediaType.APPLICATION_JSON_VALUE))
+               .andExpect(status().isOk())
+               .andExpect(content().string(responseBody))
+               .andReturn();
+    }
+
+    protected MvcResult performMockMvcRequest(String endpoint, String body) throws Throwable {
+        RequestBuilder requestBuilder = MockMvcRequestBuilders.post(endpoint)
+                                                              .accept(MediaType.ALL)
+                                                              .content(body)
+                                                              .contentType(
+                                                                      MediaType.APPLICATION_JSON);
+
+        return mockMvc.perform(requestBuilder).andReturn();
+    }
+
+}

src/test/java/com/ericsson/ei/controller/ControllerTestBaseClass.java

@@ -16,22 +16,14 @@
 */
 package com.ericsson.ei.controller;
 
-import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
-import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
-
 import org.json.JSONObject;
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
 import org.springframework.boot.test.context.SpringBootContextLoader;
 import org.springframework.boot.test.context.SpringBootTest;
-import org.springframework.http.MediaType;
 import org.springframework.test.context.ContextConfiguration;
 import org.springframework.test.context.TestPropertySource;
 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
-import org.springframework.test.web.servlet.MockMvc;
-import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
 
 import com.ericsson.ei.App;
 import com.ericsson.ei.utils.TestContextInitializer;
@@ -41,30 +33,21 @@
         "failed.notification.database-name: TestAuthControllerImpl-failedNotifications",
         "rabbitmq.exchange.name: TestAuthControllerImpl-exchange",
         "rabbitmq.consumerName: TestAuthControllerImpl" })
-@ContextConfiguration(
-        classes = App.class,
-        loader = SpringBootContextLoader.class,
-        initializers = TestContextInitializer.class)
+@ContextConfiguration(classes = App.class, loader = SpringBootContextLoader.class, initializers = TestContextInitializer.class)
 @RunWith(SpringJUnit4ClassRunner.class)
 @SpringBootTest(classes = { App.class })
-@AutoConfigureMockMvc
-public class TestAuthControllerImpl {
-
-    @Autowired
-    private MockMvc mockMvc;
+public class TestAuthenticationControllerImpl extends ControllerTestBaseClass {
 
     @Test
-    public void testGetAuth() throws Exception {
+    public void testGetAuthentication() throws Throwable {
         String responseBody = new JSONObject().put("security", false).toString();
-        mockMvc.perform(MockMvcRequestBuilders.get("/auth").accept(MediaType.APPLICATION_JSON_VALUE))
-                .andExpect(status().isOk()).andExpect(content().string(responseBody)).andReturn();
+        assertExpectedResponse("/authentication", responseBody);
     }
 
     @Test
-    public void testGetLogin() throws Exception {
+    public void testGetLogin() throws Throwable {
         String responseBody = new JSONObject().put("user", "anonymousUser").toString();
-        mockMvc.perform(MockMvcRequestBuilders.get("/auth/login").accept(MediaType.APPLICATION_JSON_VALUE))
-                .andExpect(status().isOk()).andExpect(content().string(responseBody)).andReturn();
+        assertExpectedResponse("/authentication/login", responseBody);
     }
 
 }