Merge changes from topic 'feature/sdc-controller'

* changes:
  Rework CldsReferenceProp class
  Add controller config code
  Add new exceptions for SDC

11 files changed, 477 insertions, 2 deletions

diff --git a/src/main/java/org/onap/clamp/clds/config/CldsReferenceProperties.java b/src/main/java/org/onap/clamp/clds/config/CldsReferenceProperties.java
index a8acdee1..c0f7a728 100644
--- a/src/main/java/org/onap/clamp/clds/config/CldsReferenceProperties.java
+++ b/src/main/java/org/onap/clamp/clds/config/CldsReferenceProperties.java
@@ -50,12 +50,20 @@ public class CldsReferenceProperties {
     private String cldsReferenceValuesFile;
 
     @PostConstruct
-    public void loadConfig() throws IOException {
+    public void loadConfiguration() throws IOException {
         prop = new Properties();
         Resource resource = appContext.getResource(cldsReferenceValuesFile);
         prop.load(resource.getInputStream());
     }
 
+    public CldsReferenceProperties(String referenceValuesFile) throws IOException {
+        cldsReferenceValuesFile = referenceValuesFile;
+        loadConfiguration();
+    }
+
+    public CldsReferenceProperties() {
+    }
+
     /**
      * get property value
      *
@@ -105,6 +113,7 @@ public class CldsReferenceProperties {
      */
     public JsonNode getJsonTemplate(String key1, String key2) throws IOException {
         ObjectMapper objectMapper = new ObjectMapper();
-        return objectMapper.readValue(getStringValue(key1, key2), JsonNode.class);
+        String result = getStringValue(key1, key2);
+        return (result != null) ? objectMapper.readValue(result, JsonNode.class) : null;
     }
 }
diff --git a/src/main/java/org/onap/clamp/clds/config/sdc/SdcControllersConfiguration.java b/src/main/java/org/onap/clamp/clds/config/sdc/SdcControllersConfiguration.java
new file mode 100644
index 00000000..c99dd21f
--- /dev/null
+++ b/src/main/java/org/onap/clamp/clds/config/sdc/SdcControllersConfiguration.java
@@ -0,0 +1,94 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP CLAMP
+ * ================================================================================
+ * Copyright (C) 2018 AT&T Intellectual Property. 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============================================
+ * ===================================================================
+ * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ */
+
+package org.onap.clamp.clds.config.sdc;
+
+import com.att.eelf.configuration.EELFLogger;
+import com.att.eelf.configuration.EELFManager;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.annotation.PostConstruct;
+
+import org.onap.clamp.clds.exception.sdc.controller.SdcParametersException;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.ApplicationContext;
+import org.springframework.core.io.Resource;
+import org.springframework.stereotype.Component;
+
+/**
+ * This class maps the SDC config JSON file. This JSON can have multiple
+ * sdc-controller config. So the json is loaded in a static way and the instance
+ * must specify the controller name that it represents.
+ */
+@Component
+public class SdcControllersConfiguration {
+
+    private static final EELFLogger logger = EELFManager.getInstance().getLogger(SdcControllersConfiguration.class);
+    public static final String CONTROLLER_SUBTREE_KEY = "sdc-connections";
+    @Autowired
+    protected ApplicationContext appContext;
+    /**
+     * The file name that will be loaded by Spring.
+     */
+    @Value("${org.onap.clamp.config.files.sdcController:'classpath:/clds/sdc-controllers-config.json'}")
+    protected String sdcControllerFile;
+    /**
+     * The root of the JSON.
+     */
+    private JsonNode jsonRootNode;
+
+    @PostConstruct
+    public void loadConfiguration() throws IOException {
+        Resource resource = appContext.getResource(sdcControllerFile);
+        // Try to load json tree
+        jsonRootNode = new ObjectMapper().readValue(resource.getInputStream(), JsonNode.class);
+    }
+
+    public SdcSingleControllerConfiguration getSdcSingleControllerConfiguration(String controllerName) {
+        Map<String, SdcSingleControllerConfiguration> controllerMap = getAllDefinedControllers();
+        return controllerMap.get(controllerName);
+    }
+
+    /**
+     * This method reads all Controllers configurations and returns them.
+     *
+     * @return A list of controller Names defined in the config
+     */
+    public Map<String, SdcSingleControllerConfiguration> getAllDefinedControllers() {
+        Map<String, SdcSingleControllerConfiguration> result = new HashMap<>();
+        if (jsonRootNode.get(CONTROLLER_SUBTREE_KEY) != null) {
+            jsonRootNode.get(CONTROLLER_SUBTREE_KEY).fields().forEachRemaining(entry -> result.put(entry.getKey(),
+                    new SdcSingleControllerConfiguration(entry.getValue(), entry.getKey())));
+        } else {
+            throw new SdcParametersException(
+                    CONTROLLER_SUBTREE_KEY + " key not found in the file: " + sdcControllerFile);
+        }
+        return result;
+    }
+}
diff --git a/src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcArtifactInstallerException.java b/src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcArtifactInstallerException.java
new file mode 100644
index 00000000..973081c2
--- /dev/null
+++ b/src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcArtifactInstallerException.java
@@ -0,0 +1,55 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP CLAMP
+ * ================================================================================
+ * Copyright (C) 2018 AT&T Intellectual Property. 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============================================
+ * ===================================================================
+ * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ */
+
+package org.onap.clamp.clds.exception.sdc.controller;
+
+/**
+ * Exception during SDC artifact installation.
+ */
+public class SdcArtifactInstallerException extends Exception {
+
+    /**
+     * serialization id.
+     */
+    private static final long serialVersionUID = 4095937499475915021L;
+
+    /**
+     * @param message
+     *            The message to dump
+     * @param cause
+     *            The Throwable cause object
+     */
+    public SdcArtifactInstallerException(final String message) {
+        super(message);
+    }
+
+    /**
+     * @param message
+     *            The message to dump
+     * @param cause
+     *            The Throwable cause object
+     */
+    public SdcArtifactInstallerException(final String message, final Throwable cause) {
+        super(message, cause);
+    }
+}
diff --git a/src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcControllerException.java b/src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcControllerException.java
new file mode 100644
index 00000000..9c347572
--- /dev/null
+++ b/src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcControllerException.java
@@ -0,0 +1,55 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP CLAMP
+ * ================================================================================
+ * Copyright (C) 2018 AT&T Intellectual Property. 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============================================
+ * ===================================================================
+ * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ */
+
+package org.onap.clamp.clds.exception.sdc.controller;
+
+/**
+ * Exception of the SDC controller.
+ */
+public class SdcControllerException extends Exception {
+
+    /**
+     * serialization id.
+     */
+    private static final long serialVersionUID = -4236006447255525130L;
+
+    /**
+     * @param message
+     *            The message to dump
+     * @param cause
+     *            The Throwable cause object
+     */
+    public SdcControllerException(final String message) {
+        super(message);
+    }
+
+    /**
+     * @param message
+     *            The message to dump
+     * @param cause
+     *            The Throwable cause object
+     */
+    public SdcControllerException(final String message, final Throwable cause) {
+        super(message, cause);
+    }
+}
diff --git a/src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcDownloadException.java b/src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcDownloadException.java
new file mode 100644
index 00000000..bace1ac4
--- /dev/null
+++ b/src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcDownloadException.java
@@ -0,0 +1,55 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP CLAMP
+ * ================================================================================
+ * Copyright (C) 2018 AT&T Intellectual Property. 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============================================
+ * ===================================================================
+ * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ */
+
+package org.onap.clamp.clds.exception.sdc.controller;
+
+/**
+ * Exception during download from SDC.
+ */
+public class SdcDownloadException extends Exception {
+
+    /**
+     * serialization id.
+     */
+    private static final long serialVersionUID = -5276848693231134901L;
+
+    /**
+     * @param message
+     *            The message to dump
+     * @param cause
+     *            The Throwable cause object
+     */
+    public SdcDownloadException(final String message) {
+        super(message);
+    }
+
+    /**
+     * @param message
+     *            The message to dump
+     * @param cause
+     *            The Throwable cause object
+     */
+    public SdcDownloadException(final String message, final Throwable cause) {
+        super(message, cause);
+    }
+}
diff --git a/src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcParametersException.java b/src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcParametersException.java
new file mode 100644
index 00000000..6ff0f154
--- /dev/null
+++ b/src/main/java/org/onap/clamp/clds/exception/sdc/controller/SdcParametersException.java
@@ -0,0 +1,55 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP CLAMP
+ * ================================================================================
+ * Copyright (C) 2018 AT&T Intellectual Property. 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============================================
+ * ===================================================================
+ * ECOMP is a trademark and service mark of AT&T Intellectual Property.
+ */
+
+package org.onap.clamp.clds.exception.sdc.controller;
+
+/**
+ * Exception of the SDC controller.
+ */
+public class SdcParametersException extends RuntimeException {
+
+    /**
+     * serialization id.
+     */
+    private static final long serialVersionUID = 8425657297510362736L;
+
+    /**
+     * @param message
+     *            The message to dump
+     * @param cause
+     *            The Throwable cause object
+     */
+    public SdcParametersException(final String message) {
+        super(message);
+    }
+
+    /**
+     * @param message
+     *            The message to dump
+     * @param cause
+     *            The Throwable cause object
+     */
+    public SdcParametersException(final String message, final Throwable cause) {
+        super(message, cause);
+    }
+}
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
index 38a719d8..2ac53e0b 100644
--- a/src/main/resources/application.properties
+++ b/src/main/resources/application.properties
@@ -110,6 +110,7 @@ org.onap.clamp.config.files.cldsReference=classpath:/clds/clds-reference.propert
 org.onap.clamp.config.files.cldsPolicyConfig=classpath:/clds/clds-policy-config.properties

 org.onap.clamp.config.files.cldsUsers=classpath:/clds/clds-users.json

 org.onap.clamp.config.files.globalClds=classpath:/clds/globalClds.properties

+org.onap.clamp.config.files.sdcController=classpath:/clds/sdc-controllers-config.json

 

 #Define user permission related parameters, the permission type can be changed but MUST be redefined in clds-users.properties in that case !

 CLDS_PERMISSION_TYPE_CL=permission-type-cl

diff --git a/src/test/java/org/onap/clamp/clds/it/config/SdcControllersConfigurationItCase.java b/src/test/java/org/onap/clamp/clds/it/config/SdcControllersConfigurationItCase.java
new file mode 100644
index 00000000..4b632488
--- /dev/null
+++ b/src/test/java/org/onap/clamp/clds/it/config/SdcControllersConfigurationItCase.java
@@ -0,0 +1,86 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP - SO
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property. 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=========================================================
+ */
+
+package org.onap.clamp.clds.it.config;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
+import java.io.IOException;
+import java.util.Map;
+
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.onap.clamp.clds.config.sdc.SdcControllersConfiguration;
+import org.onap.clamp.clds.config.sdc.SdcSingleControllerConfiguration;
+import org.onap.clamp.clds.exception.sdc.controller.SdcParametersException;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.util.ReflectionTestUtils;
+
+/**
+ * This class tests the SDC Controller config.
+ */
+@RunWith(SpringRunner.class)
+@SpringBootTest
+public class SdcControllersConfigurationItCase {
+
+    @Autowired
+    private SdcControllersConfiguration sdcControllersConfiguration;
+
+    public final void loadFile(String fileName) throws IOException {
+        ReflectionTestUtils.setField(sdcControllersConfiguration, "sdcControllerFile", fileName);
+        sdcControllersConfiguration.loadConfiguration();
+    }
+
+    @Test
+    public void testGetAllDefinedControllers() throws IOException {
+        loadFile("classpath:/clds/sdc-controllers-config.json");
+        Map<String, SdcSingleControllerConfiguration> mapResult = sdcControllersConfiguration
+                .getAllDefinedControllers();
+        assertTrue(mapResult.size() == 2);
+        assertEquals("sdc-controller1", mapResult.get("sdc-controller1").getSdcControllerName());
+        assertEquals("sdc-controller2", mapResult.get("sdc-controller2").getSdcControllerName());
+    }
+
+    @Test
+    public void testGetSdcSingleControllerConfiguration() throws IOException {
+        loadFile("classpath:/clds/sdc-controllers-config.json");
+        assertEquals("sdc-controller1", sdcControllersConfiguration
+                .getSdcSingleControllerConfiguration("sdc-controller1").getSdcControllerName());
+        assertEquals("sdc-controller2", sdcControllersConfiguration
+                .getSdcSingleControllerConfiguration("sdc-controller2").getSdcControllerName());
+    }
+
+    @Test(expected = IOException.class)
+    public void testBadJsonLoading() throws IOException {
+        loadFile("classpath:/clds/sdc-controllers-config-bad.json");
+        fail("Should have raised an exception");
+    }
+
+    @Test(expected = SdcParametersException.class)
+    public void testMissingParamInJsonLoading() throws IOException {
+        loadFile("classpath:/clds/sdc-controllers-config-missing-param.json");
+        sdcControllersConfiguration.getAllDefinedControllers();
+        fail("Should have raised an exception");
+    }
+}
diff --git a/src/test/resources/clds/sdc-controllers-config-bad.json b/src/test/resources/clds/sdc-controllers-config-bad.json
new file mode 100644
index 00000000..0b417b74
--- /dev/null
+++ b/src/test/resources/clds/sdc-controllers-config-bad.json
@@ -0,0 +1,26 @@
+{
+  "sdc-connections":{,
+    "sdc-controller1":{
+        "user": "User1",
+        "consumerGroup": "consumerGroup1",
+        "consumerId": "consumerId1",
+        "environmentName": "environmentName1",
+        "sdcAddress": "hostname1",
+        "password": "bb3871669d893c7fb8aaacda31b77b4f537E67A081C2726889548ED7BC4C2DE6",
+        "pollingInterval":10,
+        "pollingTimeout":30
+        
+    },
+     "sdc-controller2":{
+        "user": "User2",
+        "consumerGroup": "consumerGroup2",
+        "consumerId": "consumerId2",
+        "environmentName": "environmentName2",
+        "sdcAddress": "hostname2",
+        "password": "bb3871669d893c7fb8aaacda31b77b4f537E67A081C2726889548ED7BC4C2DE6",
+        "pollingInterval":10,
+        "pollingTimeout":30
+        
+    }
+  }
+}
diff --git a/src/test/resources/clds/sdc-controllers-config-missing-param.json b/src/test/resources/clds/sdc-controllers-config-missing-param.json
new file mode 100644
index 00000000..d99ed580
--- /dev/null
+++ b/src/test/resources/clds/sdc-controllers-config-missing-param.json
@@ -0,0 +1,13 @@
+{
+	"sdc-connections": {
+		"sdc-controller1": {
+			"user": "testuser",
+			"consumerGroup": "consumerGroup",
+			"consumerId": "consumerId",
+			"environmentName": "environmentName",
+			"sdcAddress": "hostname1",
+			"pollingInterval": 10,
+			"pollingTimeout": 30
+		}
+	}
+}
diff --git a/src/test/resources/clds/sdc-controllers-config.json b/src/test/resources/clds/sdc-controllers-config.json
new file mode 100644
index 00000000..df73a504
--- /dev/null
+++ b/src/test/resources/clds/sdc-controllers-config.json
@@ -0,0 +1,26 @@
+{
+  "sdc-connections":{
+    "sdc-controller1":{
+        "user": "User1",
+        "consumerGroup": "consumerGroup1",
+        "consumerId": "consumerId1",
+        "environmentName": "environmentName1",
+        "sdcAddress": "hostname1",
+        "password": "bb3871669d893c7fb8aaacda31b77b4f537E67A081C2726889548ED7BC4C2DE6",
+        "pollingInterval":10,
+        "pollingTimeout":30
+        
+    },
+     "sdc-controller2":{
+        "user": "User2",
+        "consumerGroup": "consumerGroup2",
+        "consumerId": "consumerId2",
+        "environmentName": "environmentName2",
+        "sdcAddress": "hostname2",
+        "password": "bb3871669d893c7fb8aaacda31b77b4f537E67A081C2726889548ED7BC4C2DE6",
+        "pollingInterval":10,
+        "pollingTimeout":30
+        
+    }
+  }
+}