Add ControlLoop distribution to runtime

This commit unpacks the csar received either from SDC or for local
verification from file-system, prepares the toscaservicetemplate with
needed node-types and data-types, forwards the template to controlloop
runtime components for commisioning of controlloop.

Issue-ID: POLICY-3808
Signed-off-by: Sirisha_Manchikanti <sirisha.manchikanti@est.tech>
Change-Id: Ib3600542aca7b32ae19242c2f924bdaf2ab870a8

4 files changed, 264 insertions, 69 deletions

diff --git a/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/policy/file/ControlLoopDecoderFileInCsar.java b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/policy/file/ControlLoopDecoderFileInCsar.java
new file mode 100644
index 00000000..96db632c
--- /dev/null
+++ b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/policy/file/ControlLoopDecoderFileInCsar.java
@@ -0,0 +1,117 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2022 Nordix Foundation.
+ *  Modifications Copyright (C) 2022 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.distribution.reception.decoding.policy.file;
+
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Enumeration;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipFile;
+import org.onap.policy.common.parameters.ParameterService;
+import org.onap.policy.common.utils.coder.CoderException;
+import org.onap.policy.distribution.model.Csar;
+import org.onap.policy.distribution.model.PolicyInput;
+import org.onap.policy.distribution.reception.decoding.PolicyDecoder;
+import org.onap.policy.distribution.reception.decoding.PolicyDecodingException;
+import org.onap.policy.distribution.reception.util.ReceptionUtil;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
+
+/**
+ * This class extracts controlloop information from a CSAR file.
+ *
+ * @author Sirisha Manchikanti (sirisha.manchikanti@est.tech)
+ */
+public class ControlLoopDecoderFileInCsar implements PolicyDecoder<Csar, ToscaEntity> {
+
+    private ControlLoopDecoderFileInCsarParameterGroup decoderParameters;
+    private static final String NODE_TYPES = "nodes.yml";
+    private static final String DATA_TYPES = "data.yml";
+
+    /**
+     * {@inheritDoc}.
+     */
+    @Override
+    public void configure(final String parameterGroupName) {
+        decoderParameters = ParameterService.get(parameterGroupName);
+    }
+
+    /**
+     * {@inheritDoc}.
+     */
+    @Override
+    public boolean canHandle(final PolicyInput policyInput) {
+        return policyInput.getClass().isAssignableFrom(Csar.class);
+    }
+
+    /**
+     * {@inheritDoc}.
+     */
+    @Override
+    public Collection<ToscaEntity> decode(final Csar csar) throws PolicyDecodingException {
+        final Collection<ToscaEntity> controlLoopList = new ArrayList<>();
+        ToscaServiceTemplate nodeTypes = null;
+        ToscaServiceTemplate dataTypes = null;
+
+        try (var zipFile = new ZipFile(csar.getCsarFilePath())) {
+            final Enumeration<? extends ZipEntry> entries = zipFile.entries();
+            while (entries.hasMoreElements()) {
+                //
+                // Sonar will flag this as a Security Hotspot
+                // "Expanding archive files is security-sensitive"
+                // isZipEntryValid ensures the file being read exists in the archive
+                //
+                final ZipEntry entry = entries.nextElement(); // NOSONAR
+                final String entryName = entry.getName();
+
+                // Store node_types
+                if (entryName.contains(NODE_TYPES)) {
+                    nodeTypes = ReceptionUtil.decodeFile(zipFile, entry);
+                }
+
+                // Store data_types
+                if (entryName.contains(DATA_TYPES)) {
+                    dataTypes = ReceptionUtil.decodeFile(zipFile, entry);
+                }
+
+                if (entryName.contains(decoderParameters.getControlLoopType())) {
+                    ReceptionUtil.validateZipEntry(entryName, csar.getCsarFilePath(), entry.getSize());
+                    final ToscaServiceTemplate controlLoop = ReceptionUtil.decodeFile(zipFile, entry);
+                    if (null != controlLoop.getToscaTopologyTemplate()) {
+                        if (null != nodeTypes) {
+                            controlLoop.setNodeTypes(nodeTypes.getNodeTypes());
+                        }
+                        if (null != dataTypes) {
+                            controlLoop.setDataTypes(dataTypes.getDataTypes());
+                        }
+                        controlLoopList.add(controlLoop);
+                    }
+                }
+            }
+        } catch (final IOException | CoderException exp) {
+            throw new PolicyDecodingException("Failed decoding the controlloop", exp);
+        }
+
+        return controlLoopList;
+    }
+}
diff --git a/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/policy/file/ControlLoopDecoderFileInCsarParameterGroup.java b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/policy/file/ControlLoopDecoderFileInCsarParameterGroup.java
new file mode 100644
index 00000000..358b1f87
--- /dev/null
+++ b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/policy/file/ControlLoopDecoderFileInCsarParameterGroup.java
@@ -0,0 +1,44 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2022 Nordix Foundation.
+ *  Modifications Copyright (C) 2022 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.distribution.reception.decoding.policy.file;
+
+import lombok.Getter;
+import org.onap.policy.common.parameters.annotations.NotBlank;
+import org.onap.policy.common.parameters.annotations.NotNull;
+import org.onap.policy.distribution.reception.parameters.PolicyDecoderConfigurationParameterGroup;
+
+/**
+ * Holds the parameters for the{@link ControlLoopDecoderFileInCsar}.
+ *
+ * @author Sirisha Manchikanti (sirisha.manchikanti@est.tech)
+ */
+@Getter
+@NotNull
+@NotBlank
+public class ControlLoopDecoderFileInCsarParameterGroup extends PolicyDecoderConfigurationParameterGroup {
+
+    private String controlLoopType;
+
+    public ControlLoopDecoderFileInCsarParameterGroup() {
+        super(ControlLoopDecoderFileInCsarParameterGroup.class.getSimpleName());
+    }
+}
diff --git a/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/policy/file/PolicyDecoderFileInCsarToPolicy.java b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/policy/file/PolicyDecoderFileInCsarToPolicy.java
index 72316f28..c4ba21fe 100644
--- a/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/policy/file/PolicyDecoderFileInCsarToPolicy.java
+++ b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/policy/file/PolicyDecoderFileInCsarToPolicy.java
@@ -1,7 +1,7 @@
 /*-
  * ============LICENSE_START=======================================================
  *  Copyright (C) 2018 Ericsson. All rights reserved.
- *  Copyright (C) 2019 Nordix Foundation.
+ *  Copyright (C) 2022 Nordix Foundation.
  *  Modifications Copyright (C) 2020-2021 AT&T Intellectual Property. All rights reserved.
  *  Modifications Copyright (C) 2021 Bell Canada. All rights reserved.
  * ================================================================================
@@ -24,7 +24,6 @@
 package org.onap.policy.distribution.reception.decoding.policy.file;
 
 import java.io.IOException;
-import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Enumeration;
@@ -32,12 +31,11 @@ import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
 import org.onap.policy.common.parameters.ParameterService;
 import org.onap.policy.common.utils.coder.CoderException;
-import org.onap.policy.common.utils.coder.StandardCoder;
-import org.onap.policy.common.utils.coder.StandardYamlCoder;
 import org.onap.policy.distribution.model.Csar;
 import org.onap.policy.distribution.model.PolicyInput;
 import org.onap.policy.distribution.reception.decoding.PolicyDecoder;
 import org.onap.policy.distribution.reception.decoding.PolicyDecodingException;
+import org.onap.policy.distribution.reception.util.ReceptionUtil;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;
 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
 
@@ -49,9 +47,6 @@ import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
 public class PolicyDecoderFileInCsarToPolicy implements PolicyDecoder<Csar, ToscaEntity> {
 
     private PolicyDecoderFileInCsarToPolicyParameterGroup decoderParameters;
-    private StandardCoder coder;
-    private StandardYamlCoder yamlCoder;
-    private static final long MAX_FILE_SIZE = 512L * 1024;
 
     /**
      * {@inheritDoc}.
@@ -59,8 +54,6 @@ public class PolicyDecoderFileInCsarToPolicy implements PolicyDecoder<Csar, Tosc
     @Override
     public void configure(final String parameterGroupName) {
         decoderParameters = ParameterService.get(parameterGroupName);
-        coder = new StandardCoder();
-        yamlCoder = new StandardYamlCoder();
     }
 
     /**
@@ -87,9 +80,15 @@ public class PolicyDecoderFileInCsarToPolicy implements PolicyDecoder<Csar, Tosc
                 // isZipEntryValid ensures the file being read exists in the archive
                 //
                 final ZipEntry entry = entries.nextElement(); // NOSONAR
-                if (isZipEntryValid(entry.getName(), csar.getCsarFilePath(), entry.getSize())) {
-                    final ToscaServiceTemplate policy =
-                            decodeFile(zipFile, entry);
+                final String entryName = entry.getName();
+
+                //
+                // We only care about policy types and policies
+                //
+                if (entryName.contains(decoderParameters.getPolicyTypeFileName())
+                        || entryName.contains(decoderParameters.getPolicyFileName())) {
+                    ReceptionUtil.validateZipEntry(entryName, csar.getCsarFilePath(), entry.getSize());
+                    final ToscaServiceTemplate policy = ReceptionUtil.decodeFile(zipFile, entry);
                     policyList.add(policy);
                 }
             }
@@ -99,61 +98,4 @@ public class PolicyDecoderFileInCsarToPolicy implements PolicyDecoder<Csar, Tosc
 
         return policyList;
     }
-
-    /**
-     * Method to filter out Policy type and Policy files. In addition,
-     * ensures validation of entries in the Zipfile. Attempts to solve path
-     * injection java security issues.
-     *
-     * @param entryName name of the ZipEntry to check
-     * @param csarPath Absolute path to the csar the ZipEntry is in
-     * @param entrySize size of the ZipEntry
-     * @return true if no injection detected, and it is a policy type  or policy file.
-     * @throws PolicyDecodingException if the file size is too large
-     */
-    private boolean isZipEntryValid(String entryName, String csarPath, long entrySize) throws PolicyDecodingException {
-        //
-        // We only care about policy types and policies
-        //
-        if (entryName.contains(decoderParameters.getPolicyTypeFileName())
-                || entryName.contains(decoderParameters.getPolicyFileName())) {
-            //
-            // Check file size
-            //
-            if (entrySize > MAX_FILE_SIZE) {
-                throw new PolicyDecodingException("Zip entry for " + entryName + " is too large " + entrySize);
-            }
-            //
-            // Now ensure that there is no path injection
-            //
-            var path = Path.of(csarPath, entryName).normalize();
-            //
-            // Throw an exception if path is outside the csar
-            //
-            if (! path.startsWith(csarPath)) {
-                throw new PolicyDecodingException("Potential path injection for zip entry " + entryName);
-            }
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * Method to decode either a json or yaml file into an object.
-     *
-     * @param zipFile the zip file
-     * @param entry the entry to read in the zip file.
-     * @return the decoded ToscaServiceTemplate object.
-     * @throws CoderException IOException if the file decoding fails.
-     */
-    private ToscaServiceTemplate decodeFile(ZipFile zipFile, final ZipEntry entry) throws IOException, CoderException {
-        ToscaServiceTemplate policy = null;
-        if (entry.getName().endsWith(".json")) {
-            policy = coder.decode(zipFile.getInputStream(entry), ToscaServiceTemplate.class);
-        } else if (entry.getName().endsWith(".yaml")) {
-            policy = yamlCoder.decode(zipFile.getInputStream(entry), ToscaServiceTemplate.class);
-        }
-        return policy;
-    }
 }
diff --git a/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/util/ReceptionUtil.java b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/util/ReceptionUtil.java
new file mode 100644
index 00000000..9c0bab43
--- /dev/null
+++ b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/util/ReceptionUtil.java
@@ -0,0 +1,92 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2022 Nordix Foundation.
+ *  Modifications Copyright (C) 2022 Nordix Foundation.
+ * ================================================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.distribution.reception.util;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipFile;
+import org.onap.policy.common.utils.coder.CoderException;
+import org.onap.policy.common.utils.coder.StandardCoder;
+import org.onap.policy.common.utils.coder.StandardYamlCoder;
+import org.onap.policy.distribution.reception.decoding.PolicyDecodingException;
+import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
+
+/**
+ * This class extracts and validates information from a CSAR file.
+ *
+ * @author Sirisha Manchikanti (sirisha.manchikanti@est.tech)
+ */
+public class ReceptionUtil {
+
+    private static StandardCoder coder = new StandardCoder();
+    private static StandardYamlCoder yamlCoder = new StandardYamlCoder();
+    private static final long MAX_FILE_SIZE = 512L * 1024;
+
+    /**
+     * Method to ensure validation of entries in the Zipfile. Attempts to solve path
+     * injection java security issues.
+     *
+     * @param entryName name of the ZipEntry to check
+     * @param csarPath Absolute path to the csar the ZipEntry is in
+     * @param entrySize size of the ZipEntry
+     * @throws PolicyDecodingException if the file size is too large
+     */
+    public static void validateZipEntry(String entryName, String csarPath, long entrySize)
+            throws PolicyDecodingException {
+        //
+        // Check file size
+        //
+        if (entrySize > MAX_FILE_SIZE) {
+            throw new PolicyDecodingException("Zip entry for " + entryName + " is too large " + entrySize);
+        }
+        //
+        // Now ensure that there is no path injection
+        //
+        var path = Path.of(csarPath, entryName).normalize();
+        //
+        // Throw an exception if path is outside the csar
+        //
+        if (! path.startsWith(csarPath)) {
+            throw new PolicyDecodingException("Potential path injection for zip entry " + entryName);
+        }
+    }
+
+    /**
+     * Method to decode either a json or yaml file into an object.
+     *
+     * @param zipFile the zip file
+     * @param entry the entry to read in the zip file.
+     * @return the decoded ToscaServiceTemplate object.
+     * @throws CoderException IOException if the file decoding fails.
+     */
+    public static ToscaServiceTemplate decodeFile(ZipFile zipFile, final ZipEntry entry)
+            throws IOException, CoderException {
+        ToscaServiceTemplate toscaServiceTemplate = null;
+        if (entry.getName().endsWith(".json")) {
+            toscaServiceTemplate = coder.decode(zipFile.getInputStream(entry), ToscaServiceTemplate.class);
+        } else if (entry.getName().endsWith(".yml")) {
+            toscaServiceTemplate = yamlCoder.decode(zipFile.getInputStream(entry), ToscaServiceTemplate.class);
+        }
+        return toscaServiceTemplate;
+    }
+}