Add support for new authentication type BASIC_AUTH_JENKINS_CSRF (#294)

NON BACKWARDS COMPATIBLE CHANGES!

* Add support for new authentication type BASIC_AUTH_JENKINS_CSRF
- EI now fetches Jenkins crumb only when BASIC_AUTH_JENKINS_CSRF
  is used.
- Better error handling caused by failure to connect to rest services

Author: Anders Breid

.travis.yml

@@ -21,7 +21,7 @@ before_install:
 
 
 # This is only run before integrationTests job
-# To ensure docker containers are fully up and running we sleep 20s
+# To ensure docker containers are fully up and running we sleep 60s
 before_script:
   - source src/main/docker/env.bash
   - docker-compose -f src/main/docker/docker-compose.yml up -d mongodb rabbitmq eiffel-er jenkins mail-server

pom.xml

@@ -29,7 +29,7 @@
         <springLdapVersion>2.3.2.RELEASE</springLdapVersion>
         <springSecurityVersion>5.0.6.RELEASE</springSecurityVersion>
         <springSessionVersion>2.0.2.RELEASE</springSessionVersion>
-        <forkCountTests>2.0C</forkCountTests>
+        <forkCountTests>2C</forkCountTests>
     </properties>
 
     <!-- Reporting Plugins -->
@@ -74,7 +74,7 @@
         <dependency>
             <groupId>com.github.eiffel-community</groupId>
             <artifactId>eiffel-commons</artifactId>
-            <version>0.0.10</version>
+            <version>0.0.12</version>
         </dependency>
 
         <dependency>

src/functionaltests/java/com/ericsson/ei/notifications/ttl/TestTTLSteps.java

@@ -25,6 +25,7 @@
 import org.springframework.test.context.TestPropertySource;
 import org.springframework.util.SocketUtils;
 
+import com.ericsson.ei.exception.AuthenticationException;
 import com.ericsson.ei.handlers.MongoDBHandler;
 import com.ericsson.ei.subscription.InformSubscriber;
 import com.ericsson.ei.utils.FunctionalTestBase;
@@ -115,7 +116,7 @@ public void create_subscription_object() throws IOException, JSONException {
     }
 
     @When("^I want to inform subscriber$")
-    public void inform_subscriber() throws IOException {
+    public void inform_subscriber() throws IOException, AuthenticationException {
         JsonNode aggregatedObject = eventManager.getJSONFromFile(AGGREGATED_OBJECT_FILE_PATH);
         informSubscriber.informSubscriber(aggregatedObject.toString(), subscriptionObject);
     }

src/functionaltests/java/com/ericsson/ei/rules/RulesHandlerSteps.java

@@ -57,11 +57,12 @@ public void file_with_path(String rulesPath) {
     @Given("^path is made absolute$")
     public void path_is_absolute() {
         rulesPath = new File(rulesPath).getAbsolutePath();
+        rulesPath = rulesPath.replace("\\", "/");
     }
 
     @Given("^path is URI with \"([^\"]*)\" scheme$")
     public void path_is_uri(String scheme) {
-        rulesPath = scheme + "://" + rulesPath;
+        rulesPath = scheme + rulesPath;
     }
 
     @Then("^rules are loaded$")
@@ -79,8 +80,7 @@ public void rules_are_loaded_with_exception() throws Exception {
     }
 
     /**
-     * Create a new instance of RulesHandler using a rules.path
-     * set by the rulesPath variable.
+     * Create a new instance of RulesHandler using a rules.path set by the rulesPath variable.
      *
      * @throws Exception
      */
@@ -100,7 +100,9 @@ private void setupRestEndpoints() {
 
         LOGGER.debug("Setting up endpoints on host '" + HOST + "' and port '" + port + "'");
         mockClient = new MockServerClient(HOST, port);
-        mockClient.when(request().withMethod("GET").withPath(ROUTE_RULES_FILE)).respond(response().withStatusCode(201).withBody(BODY));
-        mockClient.when(request().withMethod("GET").withPath(ROUTE_RULES_FILE_EMPTY)).respond(response().withStatusCode(201).withBody(EMPTY));
+        mockClient.when(request().withMethod("GET").withPath(ROUTE_RULES_FILE))
+                  .respond(response().withStatusCode(201).withBody(BODY));
+        mockClient.when(request().withMethod("GET").withPath(ROUTE_RULES_FILE_EMPTY))
+                  .respond(response().withStatusCode(201).withBody(EMPTY));
     }
 }

src/functionaltests/resources/features/rulesHandler.feature

@@ -18,23 +18,23 @@ Feature: Test Rules Handler
   Scenario: Test URI with file scheme
   Given a file with path "src/main/resources/rules/ArtifactRules-Eiffel-Agen-Version.json"
   And path is made absolute
-  And path is URI with "file" scheme
+  And path is URI with "file:///" scheme
   Then rules are loaded
 
   @RulesHandlerHttpURI
   Scenario: Test URI with http scheme
   Given a file with path "localhost:{port}/some/route/MyRules.json"
-  And path is URI with "http" scheme
+  And path is URI with "http://" scheme
   Then rules are loaded
 
   @RulesHandlerIncorrectPath
   Scenario: Test incorrect rules path
   Given a file with path "localhost:{port}/wrong/route/MyRules.json"
-  And path is URI with "http" scheme
+  And path is URI with "http://" scheme
   Then rules are loaded with expected exception
 
   @RulesHandlerEmptyRules
   Scenario: Test empty rules file
   Given a file with path "localhost:{port}/wrong/route/EmptyRules.json"
-  And path is URI with "http" scheme
+  And path is URI with "http://" scheme
   Then rules are loaded with expected exception

src/integrationtests/java/com/ericsson/ei/integrationtests/FlowStepsIT.java

@@ -100,8 +100,7 @@ public void the_resulting_aggregated_object(String aggregatedObjectFilePath) thr
     public void the_upstream_input(String upstreamInputFile) throws Throwable {
         this.upstreamInputFile = upstreamInputFile;
 
-        final URL upStreamInput = new File(upstreamInputFile).toURI()
-                                                             .toURL();
+        final URL upStreamInput = new File(upstreamInputFile).toURI().toURL();
         ArrayNode upstreamJson = (ArrayNode) objectMapper.readTree(upStreamInput);
         extraEventsCount = upstreamJson.size();
     }
@@ -112,8 +111,8 @@ public void jenkins_data_is_prepared() throws Throwable {
     }
 
     @Given("^subscription object for \"([^\"]*)\" with name \"([^\"]*)\" is created$")
-    public void subscription_object_for_with_name_is_created(String subscriptionType, String subscriptionName)
-            throws Throwable {
+    public void subscription_object_for_with_name_is_created(String subscriptionType,
+            String subscriptionName) throws Throwable {
         if (subscriptionType.equalsIgnoreCase("Mail")) {
             subscriptionObject = new MailSubscriptionObject(subscriptionName);
         } else {
@@ -132,18 +131,22 @@ public void notification_meta_is_set_in_subscription(String notificationMeta) th
         subscriptionObject.setNotificationMeta(notificationMeta);
     }
 
-    @When("^basic_auth authentication with username \"([^\"]*)\" and password \"([^\"]*)\" is set in subscription$")
-    public void basic_auth_authentication_with_username_and_password_is_set_in_subscription(String username,
-                                                                                            String password)
-            throws Throwable {
-        if (subscriptionObject instanceof RestPostSubscriptionObject) {
-            ((RestPostSubscriptionObject) subscriptionObject).setBasicAuth(username, password);
+    @When("^\"([^\"]*)\" authentication with username \"([^\"]*)\" and password \"([^\"]*)\" is set in subscription$")
+    public void basic_auth_authentication_with_username_and_password_is_set_in_subscription(
+            String authenticationType, String username, String password) throws Throwable {
+
+        RestPostSubscriptionObject restPostSubscriptionObject = (RestPostSubscriptionObject) subscriptionObject;
+        if (restPostSubscriptionObject != null) {
+            restPostSubscriptionObject.setAuthenticationType(authenticationType)
+                                      .setUsername(username)
+                                      .setPassword(password);
+            subscriptionObject = restPostSubscriptionObject;
         }
     }
 
     @When("^rest post body media type is set to \"([^\"]*)\" is set in subscription$")
-    public void rest_post_body_media_type_is_set_to_is_set_in_subscription(String restPostBodyMediaType)
-            throws Throwable {
+    public void rest_post_body_media_type_is_set_to_is_set_in_subscription(
+            String restPostBodyMediaType) throws Throwable {
         subscriptionObject.setRestPostBodyMediaType(restPostBodyMediaType);
 
     }
@@ -154,9 +157,10 @@ public void parameter_key_and_value_is_added_in_subscription(String formKey, Str
     }
 
     @When("^condition \"([^\"]*)\" at requirement index '(\\d+)' is added in subscription$")
-    public void requirement_for_condition_is_added_in_subscription(String condition, int requirementIndex)
-            throws Throwable {
-        subscriptionObject.addConditionToRequirement(requirementIndex, new JSONObject().put("jmespath", condition));
+    public void requirement_for_condition_is_added_in_subscription(String condition,
+            int requirementIndex) throws Throwable {
+        subscriptionObject.addConditionToRequirement(requirementIndex, new JSONObject().put(
+                "jmespath", condition));
     }
 
     @When("^the eiffel events are sent$")
@@ -166,8 +170,7 @@ public void eiffel_events_are_sent() throws Throwable {
 
     @When("^the upstream input events are sent")
     public void upstream_input_events_are_sent() throws IOException {
-        final URL upStreamInput = new File(upstreamInputFile).toURI()
-                                                             .toURL();
+        final URL upStreamInput = new File(upstreamInputFile).toURI().toURL();
         ArrayNode upstreamJson = (ArrayNode) objectMapper.readTree(upStreamInput);
         if (upstreamJson != null) {
             for (JsonNode event : upstreamJson) {
@@ -210,7 +213,7 @@ public void the_jenkins_job_should_have_been_triggered() throws Throwable {
             }
         }
 
-        assertEquals(true, jobStatusDataFetched);
+        assertEquals("Failed to fetch Job Status Data: ", true, jobStatusDataFetched);
     }
 
     @Then("^the expected aggregated object ID is \"([^\"]*)\"$")
@@ -219,7 +222,8 @@ public void the_expected_aggregated_object_ID_is(String aggregatedObjectID) thro
     }
 
     @Then("^verify jenkins job data timestamp is after test subscription was created$")
-    public void verify_jenkins_job_data_timestamp_is_after_test_subscription_was_created() throws Throwable {
+    public void verify_jenkins_job_data_timestamp_is_after_test_subscription_was_created()
+            throws Throwable {
         long jenkinsTriggeredTime = jobStatusData.getLong("timestamp");
         assert (jenkinsTriggeredTime >= startTime) : "Jenkins job was triggered before execution of this test.";
     }
@@ -246,15 +250,12 @@ public void mongodb_should_contain_mails(int amountOfMails) throws Exception {
 
             if (newestMailJson != null) {
                 JsonNode to = newestMailJson.get("to");
-                assertEquals("Sent mails " + to.size() + ". Expected " + amountOfMails, amountOfMails, to.size());
+                assertEquals("Sent mails " + to.size() + ". Expected " + amountOfMails,
+                        amountOfMails, to.size());
 
-                String createdDate = newestMailJson.get("created")
-                                                   .get("$date")
-                                                   .asText();
+                String createdDate = newestMailJson.get("created").get("$date").asText();
 
-                createdDateInMillis = ZonedDateTime.parse(createdDate)
-                                                   .toInstant()
-                                                   .toEpochMilli();
+                createdDateInMillis = ZonedDateTime.parse(createdDate).toInstant().toEpochMilli();
                 mailHasBeenDelivered = createdDateInMillis >= startTime;
             }
 
@@ -267,8 +268,8 @@ public void mongodb_should_contain_mails(int amountOfMails) throws Exception {
 
     @Then("^jenkins is set up with job name \"([^\"]*)\"$")
     public void jenkins_is_set_up_with_job_name(String JobName) throws Throwable {
-        jenkinsManager = new JenkinsManager(jenkinsProtocol, jenkinsHost, jenkinsPort, jenkinsUsername,
-                jenkinsPassword);
+        jenkinsManager = new JenkinsManager(jenkinsProtocol, jenkinsHost, jenkinsPort,
+                jenkinsUsername, jenkinsPassword);
         jenkinsManager.forceCreateJob(JobName, jenkinsXmlData.getXmlAsString());
         jenkinsJobName = JobName;
     }
@@ -285,8 +286,7 @@ public void subscription_is_uploaded() throws URISyntaxException {
                    .setPort(port)
                    .setEndpoint("/subscriptions")
                    .addHeader("Content-type", "application/json")
-                   .setBody(subscriptionObject.getAsSubscriptions()
-                                              .toString());
+                   .setBody(subscriptionObject.getAsSubscriptions().toString());
 
         ResponseEntity<String> response = postRequest.performRequest();
         assertEquals(200, response.getStatusCodeValue());
@@ -340,7 +340,8 @@ private String extractValueForKeyInJobData(String key) {
     }
 
     /**
-     * Iterates the parameter array and returns the value if the key is found in given parameter array.
+     * Iterates the parameter array and returns the value if the key is found in given parameter
+     * array.
      *
      * @param parameters
      * @param key
@@ -361,7 +362,8 @@ private String extractValueFromParameters(JSONArray parameters, String key) {
     }
 
     private JsonNode getNewestMailFromDatabase() throws Exception {
-        ArrayList<String> allMails = mongoDBHandler.getAllDocuments(MAILHOG_DATABASE_NAME, "messages");
+        ArrayList<String> allMails = mongoDBHandler.getAllDocuments(MAILHOG_DATABASE_NAME,
+                "messages");
 
         if (allMails.size() > 0) {
             String mailString = allMails.get(allMails.size() - 1);
@@ -372,8 +374,9 @@ private JsonNode getNewestMailFromDatabase() throws Exception {
     }
 
     /**
-     * Replaces given input parameters if user wishes with test defined parameters. If user want the user may specify
-     * the host, port job name and token directly in the feauture file and they will not be replaced.
+     * Replaces given input parameters if user wishes with test defined parameters. If user want the
+     * user may specify the host, port job name and token directly in the feauture file and they
+     * will not be replaced.
      * <p>
      * ${jenkinsHost} is replaced with jenkins host.
      * <p>
@@ -388,9 +391,12 @@ private JsonNode getNewestMailFromDatabase() throws Exception {
      */
     private String replaceVariablesInNotificationMeta(String notificationMeta) {
         notificationMeta = notificationMeta.replaceAll("\\$\\{jenkinsHost\\}", jenkinsHost);
-        notificationMeta = notificationMeta.replaceAll("\\$\\{jenkinsPort\\}", String.valueOf(jenkinsPort));
-        notificationMeta = notificationMeta.replaceAll("\\$\\{jenkinsJobName\\}", this.jenkinsJobName);
-        notificationMeta = notificationMeta.replaceAll("\\$\\{jenkinsJobToken\\}", this.jenkinsJobToken);
+        notificationMeta = notificationMeta.replaceAll("\\$\\{jenkinsPort\\}", String.valueOf(
+                jenkinsPort));
+        notificationMeta = notificationMeta.replaceAll("\\$\\{jenkinsJobName\\}",
+                this.jenkinsJobName);
+        notificationMeta = notificationMeta.replaceAll("\\$\\{jenkinsJobToken\\}",
+                this.jenkinsJobToken);
         return notificationMeta;
     }
 }

src/integrationtests/resources/features/SourceChangeFlowIT.feature

@@ -23,7 +23,7 @@ Feature: Source change flow integrationtest
     # Setup subscription
     Given subscription object for "REST/POST" with name "ParameterizedTriggerSubscription" is created
     When notification meta "http://${jenkinsHost}:${jenkinsPort}/job/${jenkinsJobName}/buildWithParameters?token='test-token-123'&test_key=id" is set in subscription
-    And basic_auth authentication with username "admin" and password "admin" is set in subscription
+    And "BASIC_AUTH_JENKINS_CSRF" authentication with username "admin" and password "admin" is set in subscription
     And rest post body media type is set to "application/x-www-form-urlencoded" is set in subscription
     And condition "id=='sb6efi4n-25fb-4d77-b9fd-5f2xrrefe66de47'" at requirement index '0' is added in subscription
     Then subscription is uploaded
@@ -60,7 +60,7 @@ Feature: Source change flow integrationtest
     # Setup subscription
     Given subscription object for "REST/POST" with name "ParameterInBodyTriggerSubscription" is created
     When notification meta "http://${jenkinsHost}:${jenkinsPort}/job/${jenkinsJobName}/build?token='test-token-123'" is set in subscription
-    And basic_auth authentication with username "admin" and password "admin" is set in subscription
+    And "BASIC_AUTH_JENKINS_CSRF" authentication with username "admin" and password "admin" is set in subscription
     And rest post body media type is set to "application/x-www-form-urlencoded" is set in subscription
     And parameter form key "json" and form value "{parameter: [{name:'test_param_1', value:'Test Input Value'}, {name:'test_param_2', value:id}]}" is added in subscription
     And condition "id=='sb6efi4n-25fb-4d77-b9fd-5f2xrrefe66de47'" at requirement index '0' is added in subscription

src/integrationtests/resources/features/TestExecutionFlowIT.feature

@@ -23,7 +23,7 @@ Feature: Test execution flow integrationtest
     # Setup subscription
     Given subscription object for "REST/POST" with name "ParameterizedTriggerSubscription" is created
     When notification meta "http://${jenkinsHost}:${jenkinsPort}/job/${jenkinsJobName}/buildWithParameters?token='test-token-123'&test_key=activity_triggered_event_id" is set in subscription
-    And basic_auth authentication with username "admin" and password "admin" is set in subscription
+    And "BASIC_AUTH_JENKINS_CSRF" authentication with username "admin" and password "admin" is set in subscription
     And rest post body media type is set to "application/x-www-form-urlencoded" is set in subscription
     And condition "activity_triggered_event_id=='e46ef12d-25gb-4d7y-b9fd-8763re66de47'" at requirement index '0' is added in subscription
     Then subscription is uploaded
@@ -58,7 +58,7 @@ Feature: Test execution flow integrationtest
     # Setup subscription
     Given subscription object for "REST/POST" with name "ParameterInBodyTriggerSubscription" is created
     When notification meta "http://${jenkinsHost}:${jenkinsPort}/job/${jenkinsJobName}/build?token='test-token-123'" is set in subscription
-    And basic_auth authentication with username "admin" and password "admin" is set in subscription
+    And "BASIC_AUTH_JENKINS_CSRF" authentication with username "admin" and password "admin" is set in subscription
     And rest post body media type is set to "application/x-www-form-urlencoded" is set in subscription
     And parameter form key "json" and form value "{parameter: [{name:'test_param_1', value:'test_value'}, {name:'test_param_2', value:activity_triggered_event_id}]}" is added in subscription
     And condition "activity_triggered_event_id=='e46ef12d-25gb-4d7y-b9fd-8763re66de47'" at requirement index '0' is added in subscription

src/main/java/com/ericsson/ei/exception/AuthenticationException.java

@@ -0,0 +1,35 @@
+/*
+   Copyright 2019 Ericsson AB.
+   For a full list of individual contributors, please see the commit history.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+package com.ericsson.ei.exception;
+
+public class AuthenticationException extends Exception {
+
+    private static final long serialVersionUID = 2L;
+
+    public AuthenticationException() {
+        super();
+    }
+
+    public AuthenticationException(String message) {
+        super(message);
+    }
+
+    public AuthenticationException(String message, Throwable e) {
+        super(message, e);
+    }
+
+}

src/main/java/com/ericsson/ei/rules/RulesHandler.java

@@ -125,7 +125,8 @@ private String readRulesFileContent() throws Exception {
      * @throws URISyntaxException
      */
     private String readRulesFileFromURI() throws IOException, URISyntaxException {
-        return IOUtils.toString(new URI(rulesFilePath), "UTF-8");
+        URI fileUri = new URI(rulesFilePath);
+        return IOUtils.toString(fileUri, "UTF-8");
     }
 
     /**