Merge "VES collector application settings provider"

4 files changed, 444 insertions, 10 deletions

diff --git a/src/test/java/org/onap/dcae/ApplicationSettingsTest.java b/src/test/java/org/onap/dcae/ApplicationSettingsTest.java
new file mode 100644
index 00000000..b162cef2
--- /dev/null
+++ b/src/test/java/org/onap/dcae/ApplicationSettingsTest.java
@@ -0,0 +1,417 @@
+package org.onap.dcae;
+
+/*-
+ * ============LICENSE_START=======================================================
+ * org.onap.dcaegen2.collectors.ves
+ * ================================================================================
+ * Copyright (C) 2018 Nokia. All rights reserved.
+ * ================================================================================
+ * 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.
+ * ============LICENSE_END=========================================================
+ */
+
+import io.vavr.collection.HashMap;
+import io.vavr.collection.Map;
+import org.json.JSONObject;
+import org.junit.Test;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.util.Arrays;
+import java.util.Objects;
+
+import static java.util.Collections.singletonList;
+import static org.junit.Assert.*;
+import static org.onap.dcae.CLIUtils.processCmdLine;
+
+public class ApplicationSettingsTest {
+
+    @Test
+    public void shouldMakeApplicationSettingsOutOfCLIArguments() {
+        // given
+        String[] cliArguments = {"-param1", "param1value", "-param2", "param2value"};
+
+        // when
+        ApplicationSettings configurationAccessor = new ApplicationSettings(cliArguments, CLIUtils::processCmdLine);
+        String param1value = configurationAccessor.getStringDirectly("param1");
+        String param2value = configurationAccessor.getStringDirectly("param2");
+
+        // then
+        assertEquals("param1value", param1value);
+        assertEquals("param2value", param2value);
+    }
+
+    @Test
+    public void shouldMakeApplicationSettingsOutOfCLIArgumentsAndAConfigurationFile()
+            throws IOException {
+        // given
+        File tempConfFile = File.createTempFile("doesNotMatter", "doesNotMatter");
+        Files.write(tempConfFile.toPath(), Arrays.asList("section.subSection1=abc", "section.subSection2=zxc"));
+        tempConfFile.deleteOnExit();
+        String[] cliArguments = {"-param1", "param1value", "-param2", "param2value", "-c", tempConfFile.toString()};
+
+        // when
+        ApplicationSettings configurationAccessor = new ApplicationSettings(cliArguments, CLIUtils::processCmdLine);
+        String param1value = configurationAccessor.getStringDirectly("param1");
+        String param2value = configurationAccessor.getStringDirectly("param2");
+        String fromFileParam1Value = configurationAccessor.getStringDirectly("section.subSection1");
+        String fromFileParam2Value = configurationAccessor.getStringDirectly("section.subSection2");
+
+        // then
+        assertEquals("param1value", param1value);
+        assertEquals("param2value", param2value);
+        assertEquals("abc", fromFileParam1Value);
+        assertEquals("zxc", fromFileParam2Value);
+    }
+
+    @Test
+    public void shouldCLIArgumentsOverrideConfigFileParameters() throws IOException {
+        // given
+        String[] cliArguments = {"-section.subSection1", "abc"};
+        File tempConfFile = File.createTempFile("doesNotMatter", "doesNotMatter");
+        Files.write(tempConfFile.toPath(), singletonList("section.subSection1=zxc"));
+        tempConfFile.deleteOnExit();
+
+        // when
+        ApplicationSettings configurationAccessor = new ApplicationSettings(cliArguments, CLIUtils::processCmdLine);
+        String actuallyOverridenByCLIParam = configurationAccessor.getStringDirectly("section.subSection1");
+
+        // then
+        assertEquals("abc", actuallyOverridenByCLIParam);
+    }
+
+    @Test
+    public void shouldReturnHTTPPort() throws IOException {
+        // when
+        int applicationPort = fromTemporaryConfiguration("collector.service.port=8090")
+                .httpPort();
+
+        // then
+        assertEquals(8090, applicationPort);
+    }
+
+    @Test
+    public void shouldReturnDefaultHTTPPort() throws IOException {
+        // when
+        int applicationPort = fromTemporaryConfiguration().httpPort();
+
+        // then
+        assertEquals(8080, applicationPort);
+    }
+
+    @Test
+    public void shouldReturnIfHTTPSIsEnabled() throws IOException {
+        // when
+        boolean httpsEnabled = fromTemporaryConfiguration("collector.service.secure.port=8443")
+                .httpsEnabled();
+
+        // then
+        assertTrue(httpsEnabled);
+    }
+
+    @Test
+    public void shouldReturnIfHTTPIsEnabled() throws IOException {
+        // when
+        boolean httpsEnabled = fromTemporaryConfiguration("collector.service.port=8080").httpsEnabled();
+        // then
+        assertTrue(httpsEnabled);
+    }
+
+    @Test
+    public void shouldByDefaultHTTPSBeDisabled() throws IOException {
+        // when
+        boolean httpsEnabled = fromTemporaryConfiguration().httpsEnabled();
+
+        // then
+        assertTrue(httpsEnabled);
+    }
+
+    @Test
+    public void shouldReturnHTTPSPort() throws IOException {
+        // when
+        int httpsPort = fromTemporaryConfiguration("collector.service.secure.port=8443")
+                .httpsPort();
+
+        // then
+        assertEquals(8443, httpsPort);
+    }
+
+    @Test
+    public void shouldReturnLocationOfThePasswordFile() throws IOException {
+        // when
+        String passwordFileLocation = fromTemporaryConfiguration("collector.keystore.passwordfile=/somewhere/password").keystorePasswordFileLocation();
+
+        // then
+        assertEquals("/somewhere/password", passwordFileLocation);
+    }
+
+    @Test
+    public void shouldReturnDefaultLocationOfThePasswordFile() throws IOException {
+        // when
+        String passwordFileLocation = fromTemporaryConfiguration().keystorePasswordFileLocation();
+
+        // then
+        assertEquals("./etc/passwordfile", passwordFileLocation);
+    }
+
+    @Test
+    public void shouldReturnLocationOfTheKeystoreFile() throws IOException {
+        // when
+        String keystoreFileLocation = fromTemporaryConfiguration("collector.keystore.file.location=/somewhere/keystore")
+                .keystoreFileLocation();
+
+        // then
+        assertEquals("/somewhere/keystore", keystoreFileLocation);
+    }
+
+    @Test
+    public void shouldReturnLocationOfTheDefaultKeystoreFile() throws IOException {
+        // when
+        String keystoreFileLocation = fromTemporaryConfiguration().keystoreFileLocation();
+
+        // then
+        assertEquals("../etc/keystore", keystoreFileLocation);
+    }
+
+
+    @Test
+    public void shouldReturnKeystoreAlias() throws IOException {
+        // when
+        String keystoreAlias = fromTemporaryConfiguration("collector.keystore.alias=alias").keystoreAlias();
+
+        // then
+        assertEquals("alias", keystoreAlias);
+    }
+
+    @Test
+    public void shouldReturnDefaultKeystoreAlias() throws IOException {
+        // when
+        String keystoreAlias = fromTemporaryConfiguration().keystoreAlias();
+
+        // then
+        assertEquals("tomcat", keystoreAlias);
+    }
+
+    @Test
+    public void shouldReturnDMAAPConfigFileLocation() throws IOException {
+        // when
+        String dmaapConfigFileLocation = fromTemporaryConfiguration("collector.dmaapfile=/somewhere/dmaapFile").cambriaConfigurationFileLocation();
+
+        // then
+        assertEquals("/somewhere/dmaapFile", dmaapConfigFileLocation);
+    }
+
+    @Test
+    public void shouldReturnDefaultDMAAPConfigFileLocation() throws IOException {
+        // when
+        String dmaapConfigFileLocation = fromTemporaryConfiguration().cambriaConfigurationFileLocation();
+
+        // then
+        assertEquals("./etc/DmaapConfig.json", dmaapConfigFileLocation);
+    }
+
+    @Test
+    public void shouldReturnMaximumAllowedQueuedEvents() throws IOException {
+        // when
+        int maximumAllowedQueuedEvents = fromTemporaryConfiguration("collector.inputQueue.maxPending=10000")
+                .maximumAllowedQueuedEvents();
+
+        // then
+        assertEquals(10000, maximumAllowedQueuedEvents);
+    }
+
+    @Test
+    public void shouldReturnDefaultMaximumAllowedQueuedEvents() throws IOException {
+        // when
+        int maximumAllowedQueuedEvents = fromTemporaryConfiguration().maximumAllowedQueuedEvents();
+
+        // then
+        assertEquals(1024 * 4, maximumAllowedQueuedEvents);
+    }
+
+    @Test
+    public void shouldTellIfSchemaValidationIsEnabled() throws IOException {
+        // when
+        boolean jsonSchemaValidationEnabled = fromTemporaryConfiguration("collector.schema.checkflag=1")
+                .jsonSchemaValidationEnabled();
+
+        // then
+        assertTrue(jsonSchemaValidationEnabled);
+    }
+
+    @Test
+    public void shouldByDefaultSchemaValidationBeDisabled() throws IOException {
+        // when
+        boolean jsonSchemaValidationEnabled = fromTemporaryConfiguration().jsonSchemaValidationEnabled();
+
+        // then
+        assertFalse(jsonSchemaValidationEnabled);
+    }
+
+    @Test
+    public void shouldReturnJSONSchema() throws IOException {
+        // when
+        JSONObject jsonSchema = fromTemporaryConfiguration("collector.schema.file={\"v1\": {}}")
+                .jsonSchema();
+
+        // then
+        assertEquals(new JSONObject("{\"v1\": {}}").toMap(), jsonSchema.toMap());
+    }
+
+    @Test
+    public void shouldReturnDefaultJSONSchema() throws IOException {
+        // when
+        JSONObject jsonSchema = fromTemporaryConfiguration().jsonSchema();
+
+        // then
+        assertEquals(new JSONObject("{\"v5\":\"./etc/CommonEventFormat_28.3.json\"}").toMap(), jsonSchema.toMap());
+    }
+
+    @Test
+    public void shouldReturnExceptionConfigFileLocation() throws IOException {
+        // when
+        String exceptionConfigFileLocation = fromTemporaryConfiguration("exceptionConfig=/somewhere/exceptionFile")
+                .exceptionConfigFileLocation();
+
+        // then
+        assertEquals("/somewhere/exceptionFile", exceptionConfigFileLocation);
+    }
+
+    @Test
+    public void shouldReturnDefaultExceptionConfigFileLocation() throws IOException {
+        // when
+        String exceptionConfigFileLocation = fromTemporaryConfiguration().exceptionConfigFileLocation();
+
+        // then
+        assertNull(exceptionConfigFileLocation);
+    }
+
+
+    @Test
+    public void shouldReturnDMAAPStreamId() throws IOException {
+        // given
+        Map<String, String[]> expected = HashMap.of(
+                "s", new String[]{"something", "something2"},
+                "s2", new String[]{"something3"}
+        );
+
+        // when
+        Map<String, String[]> dmaapStreamID = fromTemporaryConfiguration("collector.dmaap.streamid=s=something,something2|s2=something3")
+                .dMaaPStreamsMapping();
+
+        // then
+        assertArrayEquals(expected.get("s").get(), Objects.requireNonNull(dmaapStreamID).get("s").get());
+        assertArrayEquals(expected.get("s2").get(), Objects.requireNonNull(dmaapStreamID).get("s2").get());
+        assertEquals(expected.keySet(), dmaapStreamID.keySet());
+    }
+
+    @Test
+    public void shouldReturnDefaultDMAAPStreamId() throws IOException {
+        // when
+        Map<String, String[]> dmaapStreamID = fromTemporaryConfiguration().dMaaPStreamsMapping();
+
+        // then
+        assertEquals(dmaapStreamID, HashMap.empty());
+    }
+
+    @Test
+    public void shouldReturnIfAuthorizationIsEnabled() throws IOException {
+        // when
+        boolean authorizationEnabled = fromTemporaryConfiguration("header.authflag=1")
+                .authorizationEnabled();
+
+        // then
+        assertTrue(authorizationEnabled);
+    }
+
+    @Test
+    public void shouldAuthorizationBeDisabledByDefault() throws IOException {
+        // when
+        boolean authorizationEnabled = fromTemporaryConfiguration().authorizationEnabled();
+
+        // then
+        assertFalse(authorizationEnabled);
+    }
+
+    @Test
+    public void shouldReturnValidCredentials() throws IOException {
+        // when
+        String userToBase64PasswordDelimitedByCommaSeparatedByPipes = fromTemporaryConfiguration(
+                "header.authlist=pasza,123jsad1|someoneelse,12asd31"
+        ).validAuthorizationCredentials();
+
+        // then
+        assertEquals("pasza,123jsad1|someoneelse,12asd31", userToBase64PasswordDelimitedByCommaSeparatedByPipes);
+    }
+
+    @Test
+    public void shouldbyDefaultThereShouldBeNoValidCredentials() throws IOException {
+        // when
+        String userToBase64PasswordDelimitedByCommaSeparatedByPipes = fromTemporaryConfiguration().
+                validAuthorizationCredentials();
+
+        // then
+        assertNull(userToBase64PasswordDelimitedByCommaSeparatedByPipes);
+    }
+
+
+    @Test
+    public void shouldReturnIfEventTransformingIsEnabled() throws IOException {
+        // when
+        boolean isEventTransformingEnabled = fromTemporaryConfiguration("event.transform.flag=0")
+                .eventTransformingEnabled();
+
+        // then
+        assertFalse(isEventTransformingEnabled);
+    }
+
+    @Test
+    public void shouldEventTransformingBeEnabledByDefault() throws IOException {
+        // when
+        boolean isEventTransformingEnabled = fromTemporaryConfiguration().eventTransformingEnabled();
+
+        // then
+        assertTrue(isEventTransformingEnabled);
+    }
+
+    @Test
+    public void shouldReturnCambriaConfigurationFileLocation() throws IOException {
+        // when
+        String cambriaConfigurationFileLocation = fromTemporaryConfiguration("collector.dmaapfile=/somewhere/dmaapConfig")
+                .cambriaConfigurationFileLocation();
+
+        // then
+        assertEquals("/somewhere/dmaapConfig", cambriaConfigurationFileLocation);
+    }
+
+    @Test
+    public void shouldReturnDefaultCambriaConfigurationFileLocation() throws IOException {
+        // when
+        String cambriaConfigurationFileLocation = fromTemporaryConfiguration()
+                .cambriaConfigurationFileLocation();
+
+        // then
+        assertEquals("./etc/DmaapConfig.json", cambriaConfigurationFileLocation);
+    }
+
+    private static ApplicationSettings fromTemporaryConfiguration(String... fileLines)
+            throws IOException {
+        File tempConfFile = File.createTempFile("doesNotMatter", "doesNotMatter");
+        Files.write(tempConfFile.toPath(), Arrays.asList(fileLines));
+        tempConfFile.deleteOnExit();
+        return new ApplicationSettings(new String[]{"-c", tempConfFile.toString()}, args -> processCmdLine(args));
+    }
+
+
+}
\ No newline at end of file
diff --git a/src/test/java/org/onap/dcae/commonFunction/TestCommonStartup.java b/src/test/java/org/onap/dcae/commonFunction/CommonStartupTest.java
index 12428024..5a171484 100644
--- a/src/test/java/org/onap/dcae/commonFunction/TestCommonStartup.java
+++ b/src/test/java/org/onap/dcae/commonFunction/CommonStartupTest.java
@@ -39,16 +39,20 @@ import java.io.FileReader;
 import java.io.IOException;
 import java.util.Map;
 import java.util.concurrent.LinkedBlockingQueue;
+
 import org.json.JSONArray;
 import org.json.JSONObject;
 import org.junit.Test;
 import org.mockito.Mockito;
+import org.onap.dcae.ApplicationSettings;
+import org.onap.dcae.CLIUtils;
 import org.onap.dcae.commonFunction.CommonStartup.QueueFullException;
 import org.onap.dcae.commonFunction.event.publishing.EventPublisher;
 import org.onap.dcae.restapi.RestfulCollectorServlet;
+import org.onap.dcae.vestest.TestingUtilities;
 
 
-public class TestCommonStartup {
+public class CommonStartupTest {
 
     @Test
     public void testParseCLIArguments() {
@@ -67,7 +71,7 @@ public class TestCommonStartup {
     public void shouldPutValidVESEventOnProcessingQueueWithoutExceptions() throws IOException, QueueFullException {
         // given
         CommonStartup.fProcessingInputQueue = new LinkedBlockingQueue<>(
-            CommonStartup.KDEFAULT_MAXQUEUEDEVENTS);
+            CommonStartup.maxQueueEvent);
         JsonElement vesEvent = new JsonParser().parse(new FileReader("src/test/resources/VES_valid.txt"));
         JSONObject validVESEvent = new JSONObject(vesEvent.toString());
         JSONArray jsonArrayMod = new JSONArray().put(validVESEvent);
@@ -80,9 +84,9 @@ public class TestCommonStartup {
     @Test
     public void testParseStreamIdToStreamHashMapping() {
         // given
-        CommonStartup.streamID = "fault=sec_fault|syslog=sec_syslog|heartbeat=sec_heartbeat|measurementsForVfScaling=sec_measurement|mobileFlow=sec_mobileflow|other=sec_other|stateChange=sec_statechange|thresholdCrossingAlert=sec_thresholdCrossingAlert|voiceQuality=ves_voicequality|sipSignaling=ves_sipsignaling";
-        EventProcessor eventProcessor = new EventProcessor(mock(EventPublisher.class));
 
+        CommonStartup.streamID = TestingUtilities.convertDMaaPStreamsPropertyToMap("fault=sec_fault|syslog=sec_syslog|heartbeat=sec_heartbeat|measurementsForVfScaling=sec_measurement|mobileFlow=sec_mobileflow|other=sec_other|stateChange=sec_statechange|thresholdCrossingAlert=sec_thresholdCrossingAlert|voiceQuality=ves_voicequality|sipSignaling=ves_sipsignaling");
+        EventProcessor eventProcessor = new EventProcessor(mock(EventPublisher.class));
         // when
         Map<String, String[]> streamHashMapping = EventProcessor.streamidHash;
 
@@ -94,7 +98,7 @@ public class TestCommonStartup {
     @Test
     public void testAuthListHandler() throws loadException, missingReqdSetting {
         // given
-        final nvReadableStack settings = new nvReadableStack();
+        ApplicationSettings settings = new ApplicationSettings(new String[]{}, CLIUtils::processCmdLine);
 
         String user1 = "secureid";
         String password1Hashed = "IWRjYWVSb2FkbTEyMyEt";
@@ -118,8 +122,6 @@ public class TestCommonStartup {
         // then
         assertEquals(authentic.getSecret(), password1UnHashed);
     }
-
-
 }
 
 
diff --git a/src/test/java/org/onap/dcae/commonFunction/EventProcessorTest.java b/src/test/java/org/onap/dcae/commonFunction/EventProcessorTest.java
index e211c12a..77ef005f 100644
--- a/src/test/java/org/onap/dcae/commonFunction/EventProcessorTest.java
+++ b/src/test/java/org/onap/dcae/commonFunction/EventProcessorTest.java
@@ -22,6 +22,8 @@ package org.onap.dcae.commonFunction;
 
 import com.google.gson.Gson;
 import java.util.concurrent.atomic.AtomicReference;
+
+import io.vavr.collection.HashMap;
 import org.json.JSONObject;
 import org.junit.Before;
 import org.junit.Test;
@@ -29,6 +31,7 @@ import org.mockito.ArgumentCaptor;
 
 import java.util.List;
 import org.onap.dcae.commonFunction.event.publishing.EventPublisher;
+import org.onap.dcae.vestest.TestingUtilities;
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.Assert.assertTrue;
@@ -45,8 +48,7 @@ public class EventProcessorTest {
 
     @Before
     public void setUp() {
-        CommonStartup.streamID = "fault=sec_fault|syslog=sec_syslog|heartbeat=sec_heartbeat|measurementsForVfScaling=sec_measurement|mobileFlow=sec_mobileflow|other=sec_other|stateChange=sec_statechange|thresholdCrossingAlert=sec_thresholdCrossingAlert|voiceQuality=ves_voicequality|sipSignaling=ves_sipsignaling";
-        CommonStartup.eventTransformFlag = 1;
+        CommonStartup.streamID = TestingUtilities.convertDMaaPStreamsPropertyToMap("fault=sec_fault|syslog=sec_syslog|heartbeat=sec_heartbeat|measurementsForVfScaling=sec_measurement|mobileFlow=sec_mobileflow|other=sec_other|stateChange=sec_statechange|thresholdCrossingAlert=sec_thresholdCrossingAlert|voiceQuality=ves_voicequality|sipSignaling=ves_sipsignaling");
     }
 
     @Test
diff --git a/src/test/java/org/onap/dcae/vestest/TestingUtilities.java b/src/test/java/org/onap/dcae/vestest/TestingUtilities.java
index 7c7c09dc..eff31f6d 100644
--- a/src/test/java/org/onap/dcae/vestest/TestingUtilities.java
+++ b/src/test/java/org/onap/dcae/vestest/TestingUtilities.java
@@ -23,6 +23,8 @@ import static java.nio.file.Files.readAllBytes;
 
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
+import io.vavr.collection.HashMap;
+
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -30,7 +32,7 @@ import java.nio.file.Paths;
 /**
  * @author Pawel Szalapski (pawel.szalapski@nokia.com)
  */
-final class TestingUtilities {
+public final class TestingUtilities {
 
     private TestingUtilities() {
         // utility class, no objects allowed
@@ -50,6 +52,17 @@ final class TestingUtilities {
         });
     }
 
+    public static HashMap<String, String[]> convertDMaaPStreamsPropertyToMap(String streamIdsProperty) {
+        java.util.HashMap<String, String[]> domainToStreamIdsMapping = new java.util.HashMap<>();
+        String[] topics = streamIdsProperty.split("\\|");
+        for (String t : topics) {
+            String domain = t.split("=")[0];
+            String[] streamIds = t.split("=")[1].split(",");
+            domainToStreamIdsMapping.put(domain, streamIds);
+        }
+        return HashMap.ofAll(domainToStreamIdsMapping);
+    }
+
     private static Path createFile(String path) {
         return rethrow(() -> Files.createFile(Paths.get(path)));
     }