Rename /download endpoint to /templates (#264)

Rename endpoint /download to /templates. Updated documentation and tests.

Author: e-pettersson-ericsson

src/functionaltest/java/com/ericsson/ei/config/Utils.java

@@ -42,9 +42,9 @@ public static Properties getProperties(final String filePath) {
     /**
      * Extracts a BZip2 archive to a destination folder.
      *
-     * @param firefoxTarballFilePath
+     * @param firefoxBZip2FilePath
      *            string containing the firefox BZip2 filepath.
-     * @param destination
+     * @param destinationPath
      *            string containing a destination path.
      */
     public static void extractBZip2InDir(final String firefoxBZip2FilePath, String destinationPath) {
@@ -73,20 +73,20 @@ public static void extractBZip2InDir(final String firefoxBZip2FilePath, String d
     }
 
     /**
-     * Downloads a file from a given URL to a given destination path.
+     * Downloads a file from a given URL to a given destinationPath path.
      *
      * @param url
      *            string containing a URL.
-     * @param destination
-     *            string containing a destination path.
+     * @param destinationPath
+     *            string containing a destinationPath path.
      */
-    public static void downloadFileFromUrlToDestination(final String url, final String destination) {
-        final File file = new File(destination);
+    public static void downloadFileFromUrlToDestination(final String url, final String destinationPath) {
+        final File file = new File(destinationPath);
         URL urlObj = null;
 
         try {
             urlObj = new URL(url);
-            LOGGER.debug("Downloading file.\nSource: {}\nDestination: {}", url, destination);
+            LOGGER.debug("Downloading file.\nSource: {}\nDestination: {}", url, destinationPath);
             FileUtils.copyURLToFile(urlObj, file);
         } catch (MalformedURLException e) {
             LOGGER.error("Failed to create URL object.\nURL: {}\nError: {}", url, e.getMessage());

src/functionaltest/java/com/ericsson/ei/frontend/TestRulesFunctionality.java

@@ -31,13 +31,13 @@ public class TestRulesFunctionality extends SeleniumBaseClass {
     private static final String BASE_URL = "localhost";
 
     private static final String DOWNLOADED_RULES_TEMPLATE_FILE_PATH = String.join(File.separator, SeleniumConfig.getTempDownloadDirectory().getPath(),
-            "rulesTemplate.json");
+            "rules.json");
     private static final String RULES_TEMPLATE_FILE_PATH = String.join(File.separator, "src", "functionaltest", "resources", "responses",
             "RulesTemplateObject.json");
     private static final String DOWNLOADED_RULES_FILE_PATH = String.join(File.separator, SeleniumConfig.getTempDownloadDirectory().getPath(),
             "rules.json");
     private static final String DOWNLOADED_EVENTS_TEMPLATE_FILE_PATH = String.join(File.separator,
-            SeleniumConfig.getTempDownloadDirectory().getPath(), "eventsTemplate.json");
+            SeleniumConfig.getTempDownloadDirectory().getPath(), "events.json");
     private static final String EVENTS_TEMPLATE_FILE_PATH = String.join(File.separator, "src", "functionaltest", "resources", "responses",
             "EventsTemplateObject.json");
     private static final String AGGREGATED_OBJECT_FILE_PATH = String.join(File.separator, "src", "functionaltest", "resources", "responses",
@@ -108,7 +108,7 @@ private void verifyUploadEventsFile() {
 
     private void verifyDownloadEventsTemplateButton() throws IOException {
         String downloadEventsTemplateMockedResponse = getJSONStringFromFile(EVENTS_TEMPLATE_FILE_PATH);
-        mockClient.when(request().withMethod("GET").withPath("/download/eventsTemplate"))
+        mockClient.when(request().withMethod("GET").withPath("/templates/events"))
                 .respond(response().withStatusCode(200).withBody(downloadEventsTemplateMockedResponse));
 
         testRulesPage.clickDownloadEventsTemplate();
@@ -124,7 +124,7 @@ private void verifyAddAndRemoveRuleButton() {
     }
 
     private void verifyDownloadRulesButton() throws IOException {
-        mockClient.when(request().withMethod("GET").withPath("/download/rules"))
+        mockClient.when(request().withMethod("GET").withPath("/templates/rules"))
                 .respond(response().withStatusCode(200).withBody(downloadedRulesTemplate));
         testRulesPage.clickDownloadRulesButton();
         new WebDriverWait(driver, 10).until((webdriver) -> Files.exists(Paths.get(DOWNLOADED_RULES_FILE_PATH)));
@@ -140,7 +140,7 @@ private void verifyUploadRulesFile() {
 
     private void verifyDownloadRulesTemplateButton() throws IOException {
         String mockedResponse = getJSONStringFromFile(RULES_TEMPLATE_FILE_PATH);
-        mockClient.when(request().withMethod("GET").withPath("/download/rulesTemplate"))
+        mockClient.when(request().withMethod("GET").withPath("/templates/rules"))
                 .respond(response().withStatusCode(200).withBody(mockedResponse));
         testRulesPage.clickDownloadRulesTemplate();
         new WebDriverWait(driver, 10).until((webdriver) -> Files.exists(Paths.get(DOWNLOADED_RULES_TEMPLATE_FILE_PATH)));

src/functionaltest/java/com/ericsson/ei/frontend/TestSubscriptionHandling.java

@@ -342,7 +342,7 @@ private void setupMockEndpoints(boolean security, String user) throws IOExceptio
                                  "Subscription1,Subscription2,Subscription3"))
                        .respond(response().withStatusCode(200).withBody(""));
         clientAndServer.when(
-                request().withMethod("GET").withPath("/download/subscriptionsTemplate"))
+                request().withMethod("GET").withPath("/templates/subscriptions"))
                        .respond(response().withStatusCode(200).withBody(mockedTemplateResponse));
 
         String responseAuth = "{\"security\":" + security + "}";

src/integrationtest/java/com/ericsson/ei/frontend/CommonSteps.java

@@ -159,7 +159,7 @@ public void request_sent_using_list(int index) throws Throwable {
         response = httpRequestList.get(index).performRequest();
     }
 
-    @When("^request is sent for (\\d+) seconds until reponse code no longer matches (\\d+)$")
+    @When("^request is sent for (\\d+) seconds until response code no longer matches (\\d+)$")
     public void request_sent_body_not_received(int seconds, int statusCode) throws Throwable {
         long stopTime = System.currentTimeMillis() + (seconds * 1000);
         do {

src/integrationtest/java/com/ericsson/ei/frontend/DownloadRunnerIT.java renamed to src/integrationtest/java/com/ericsson/ei/frontend/TemplatesRunnerIT.java

@@ -6,9 +6,9 @@
 import cucumber.api.junit.Cucumber;
 
 @RunWith(Cucumber.class)
-@CucumberOptions(features = "src/integrationtest/resources/features/download.feature", glue = {
+@CucumberOptions(features = "src/integrationtest/resources/features/templates.feature", glue = {
         "com.ericsson.ei.frontend" }, plugin = {
-                "html:target/cucumber-reports/DownloadRunnerIT" })
-public class DownloadRunnerIT {
+                "html:target/cucumber-reports/TemplatesRunnerIT" })
+public class TemplatesRunnerIT {
 
 }

src/integrationtest/resources/features/query.feature

@@ -16,7 +16,7 @@ Feature: Query test
     And an aggregated object is created
     When a 'GET' request is prepared for REST API '/queryAggregatedObject'
     And param key 'ID' with value '6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43' is added
-    And request is sent for 30 seconds until reponse code no longer matches 204
+    And request is sent for 30 seconds until response code no longer matches 204
     And response body contains '6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43'
 
   @QueryFreestyleScenario
@@ -25,5 +25,5 @@ Feature: Query test
     And an aggregated object is created
     When a 'POST' request is prepared for REST API '/query'
     And body is set to file 'queryFreestyle.json'
-    And request is sent for 30 seconds until reponse code no longer matches 204
+    And request is sent for 30 seconds until response code no longer matches 204
     And response body contains '6acc3c87-75e0-4b6d-88f5-b1a5d4e62b43'

src/integrationtest/resources/features/download.feature renamed to src/integrationtest/resources/features/templates.feature

@@ -1,26 +1,26 @@
-@DownloadFeature
-Feature: Download test
+@TemplatesFeature
+Feature: Test get templates
 
   @GetSubscriptionsTemplateScenario
   Scenario: Get subscriptions template
     Given frontend is up and running
-    When a 'GET' request is prepared for REST API '/download/subscriptionsTemplate'
+    When a 'GET' request is prepared for REST API '/templates/subscriptions'
     And request is sent
     Then response code 200 is received
     And response body contains 'Subscription1'
 
   @GetRulesTemplateScenario
   Scenario: Get rules template
     Given frontend is up and running
-    When a 'GET' request is prepared for REST API '/download/rulesTemplate'
+    When a 'GET' request is prepared for REST API '/templates/rules'
     And request is sent
     Then response code 200 is received
     And response body contains 'ARTIFACT_TEST'
 
   @GetEventsTemplateScenario
   Scenario: Get events template
     Given frontend is up and running
-    When a 'GET' request is prepared for REST API '/download/eventsTemplate'
+    When a 'GET' request is prepared for REST API '/templates/events'
     And request is sent
     Then response code 200 is received
     And response body contains 'EiffelArtifactCreatedEvent'

src/main/java/com/ericsson/ei/frontend/EIRequestsController.java

@@ -62,23 +62,24 @@ public class EIRequestsController {
     private EIRequestsControllerUtils eiRequestsControllerUtils;
 
     /**
-     * Bridge all EI Http Requests with GET method. Used for fetching Subscription by id or all subscriptions and EI Env
-     * Info.
+     * Bridge all Eiffel Intelligence HTTP GET requests.
      *
      * @param model
-     * @param request
+     * @param incomingRequest
      * @return
      */
     @CrossOrigin
-    @RequestMapping(value = { "/subscriptions", "/subscriptions/*", "/information", "/download/*", "/auth", "/auth/*",
+    @RequestMapping(value = { "/subscriptions", "/subscriptions/*",
+            "/information", "/templates/*", "/auth", "/auth/*",
             "/queryAggregatedObject", "/failed-notifications", "/query", "/rules", "/status",
             "/rules/rule-check/testRulePageEnabled" }, method = RequestMethod.GET)
     public ResponseEntity<String> getRequests(Model model, HttpServletRequest incomingRequest) {
         String eiRequestUrl;
         try {
             eiRequestUrl = eiRequestsControllerUtils.getEIRequestURL(incomingRequest);
         } catch (EiBackendInstancesException e) {
-            LOG.info("Some failure when forwarding request to EI Backend. Error: " + e.getMessage());
+            LOG.error("Some failure when forwarding request to EI Backend. "
+                    + "Error: " + e.getMessage());
             String response = "{\"message\": \"Internal Error: " + e.getMessage() + "\"}";
             return new ResponseEntity<>(response, null, HttpStatus.INTERNAL_SERVER_ERROR);
         }
@@ -90,7 +91,7 @@ public ResponseEntity<String> getRequests(Model model, HttpServletRequest incomi
     }
 
     /**
-     * Bridge all EI Http Requests with POST method.
+     * Bridge all Eiffel Intelligence HTTP POST requests.
      *
      * @param model
      * @param incomingRequest
@@ -104,7 +105,8 @@ public ResponseEntity<String> postRequests(Model model, HttpServletRequest incom
         try {
             eiRequestUrl = eiRequestsControllerUtils.getEIRequestURL(incomingRequest);
         } catch (EiBackendInstancesException e) {
-            LOG.info("Some failure when forwarding request to EI Backend. Error: " + e.getMessage());
+            LOG.error("Some failure when forwarding request to EI Backend. "
+                    + "Error: " + e.getMessage());
             String response = "{\"message\": \"Internal Error: " + e.getMessage() + "\"}";
             return new ResponseEntity<>(response, null, HttpStatus.INTERNAL_SERVER_ERROR);
         }
@@ -121,7 +123,7 @@ public ResponseEntity<String> postRequests(Model model, HttpServletRequest incom
             LOG.error("Forward Request Errors: " + e);
         }
 
-        LOG.debug("Input Request JSON Content to be forwarded:\n" + requestBody);
+        LOG.debug("Input request JSON content to be forwarded:\n" + requestBody);
 
         HttpEntity inputReqJsonEntity = new ByteArrayEntity(requestBody.getBytes());
 
@@ -135,7 +137,8 @@ public ResponseEntity<String> postRequests(Model model, HttpServletRequest incom
     }
 
     /**
-     * Bridge all EI Http Requests with PUT method. E.g. Making Update Subscription Request.
+     * Bridge all Eiffel Intelligence HTTP PUT requests. For example updating
+     * an existing subscription.
      *
      * @param model
      * @param incomingRequest
@@ -148,7 +151,8 @@ public ResponseEntity<String> putRequests(Model model, HttpServletRequest incomi
         try {
             eiRequestUrl = eiRequestsControllerUtils.getEIRequestURL(incomingRequest);
         } catch (EiBackendInstancesException e) {
-            LOG.info("Some failure when forwarding request to EI Backend. Error: " + e.getMessage());
+            LOG.error("Some failure when forwarding request to EI Backend. "
+                    + "Error: " + e.getMessage());
             String response = "{\"message\": \"Internal Error: " + e.getMessage() + "\"}";
             return new ResponseEntity<>(response, null, HttpStatus.INTERNAL_SERVER_ERROR);
         }
@@ -163,7 +167,7 @@ public ResponseEntity<String> putRequests(Model model, HttpServletRequest incomi
             LOG.error("Forward Request Errors: " + e);
         }
 
-        LOG.debug("Input Request JSON Content to be forwarded:\n" + requestBody);
+        LOG.debug("Input request JSON content to be forwarded:\n" + requestBody);
 
         HttpEntity inputReqJsonEntity = new ByteArrayEntity(requestBody.getBytes());
 
@@ -177,7 +181,8 @@ public ResponseEntity<String> putRequests(Model model, HttpServletRequest incomi
     }
 
     /**
-     * Bridge all EI Http Requests with DELETE method. Used for DELETE subscriptions.
+     * Bridge all Eiffel Intelligence HTTP DELETE requests. For example to
+     * delete a subscription.
      *
      * @param model
      * @param incomingRequest
@@ -190,7 +195,8 @@ public ResponseEntity<String> deleteRequests(Model model, HttpServletRequest inc
         try {
             eiRequestUrl = eiRequestsControllerUtils.getEIRequestURL(incomingRequest);
         } catch (EiBackendInstancesException e) {
-            LOG.info("Some failure when forwarding request to EI Backend. Error: " + e.getMessage());
+            LOG.error("Some failure when forwarding request to EI Backend. "
+                    + "Error: " + e.getMessage());
             String response = "{\"message\": \"Internal Error: " + e.getMessage() + "\"}";
             return new ResponseEntity<>(response, null, HttpStatus.INTERNAL_SERVER_ERROR);
         }
@@ -234,7 +240,7 @@ private ResponseEntity<String> executeHttpRequest(HttpRequestBase outgoingReques
             statusCode = HttpStatus.INTERNAL_SERVER_ERROR.value();
             responseBody = "{\"statusCode\": " + statusCode + ", \"error\": \"Forward Request Error: "
                     + String.valueOf(e) + "\"}";
-            LOG.error("Forward Request Errors: " + e);
+            LOG.error("Forward request errors: " + e);
         }
 
         headers.setContentType(MediaType.APPLICATION_JSON);
@@ -243,8 +249,8 @@ private ResponseEntity<String> executeHttpRequest(HttpRequestBase outgoingReques
     }
 
     /**
-     * This function copies headers from the made request and puts it into the response. It also extracts any
-     * x-path-tokens if found.
+     * This function copies headers from the made request and puts it into the response. It also
+     * extracts any x-path-tokens if found.
      *
      * @param headers
      * @param eiResponse
@@ -284,7 +290,7 @@ private HttpHeaders getHeadersFromResponse(HttpHeaders headers, CloseableHttpRes
     }
 
     /**
-     * This function copies headers from the incomming request into the outgoing request headers.
+     * This function copies headers from the incoming request into the outgoing request headers.
      *
      * @param outgoingRequest
      * @param incomingRequest
@@ -316,8 +322,8 @@ private HttpRequestBase addHeadersToRequest(HttpRequestBase outgoingRequest, Htt
     }
 
     /**
-     * This function adds an x-path-token to an outgoing request if it exists for the back-end the request is made
-     * towards.
+     * This function adds an x-path-token to an outgoing request if it exists, for the back-end the
+     * request is made towards.
      *
      * @param outgoingRequest
      * @param incomingRequest
@@ -348,7 +354,8 @@ private HttpRequestBase addXauthTokenToRequest(HttpRequestBase outgoingRequest,
     }
 
     /**
-     * builds an xPathTokenKey, the token will be unique key for each http(s) host and port and stored for each session.
+     * builds an xPathTokenKey, the token will be unique key for each http(s) host and port and
+     * stored for each session.
      *
      * @param uri
      * @return

src/main/java/com/ericsson/ei/frontend/utils/BackendInstancesHandler.java

@@ -111,7 +111,7 @@ public BackendInstance getDefaultBackendInstance() {
     /**
      * Sets the backendInstances list, useful when mocking for tests
      *
-     * @param backendInstances
+     * @param backendInstancesJsonArray
      */
     public void setBackendInstances(JsonArray backendInstancesJsonArray) {
         cleanBackendInstances();

src/main/resources/static/js/common.js

@@ -12,7 +12,7 @@ function addBackendParameter(url) {
 
     var delimiter = "?";
     if (stringContainsSubstring(url, delimiter)) {
-        // url has delimeter ?, then delimeter should be &
+        // url has delimiter ?, then delimiter should be &
         delimiter = "&";
     }