Adding policy decoder to extract file from csar

* Adding decoder configuration parameters infrastructure to support
plugin based architecture. Adding a new policy decoder after this will be just
creating a new decoder class and its corresponding parameter class.

* Adding a new decoder which extracts policy file from given csar. It is
written in a generic way to extract file for any pdp like apex, drools.

* Adding configuration parameters for the new decoder. The policy file name and
policy type is passed as parameter to the decoder.

* Fixing few broken package declaration in pdpx decoder tests.
* Adding test cases for all code changes.

Change-Id: I95e68cebce0f9747ca63b090f9b9116ce8836939
Issue-ID: POLICY-1101
Signed-off-by: ramverma <ram.krishna.verma@ericsson.com>

4 files changed, 198 insertions, 35 deletions

diff --git a/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/pdpx/PolicyDecoderCsarPdpx.java b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/pdpx/PolicyDecoderCsarPdpx.java
index 0cd7bc16..6c4f285a 100644
--- a/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/pdpx/PolicyDecoderCsarPdpx.java
+++ b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/pdpx/PolicyDecoderCsarPdpx.java
@@ -5,15 +5,15 @@
  * 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=========================================================
  */
@@ -22,26 +22,18 @@ package org.onap.policy.distribution.reception.decoding.pdpx;
 
 import java.io.File;
 import java.util.ArrayList;
-import java.util.List;
-
 import java.util.Collection;
-import java.util.Collections;
-
+import java.util.List;
 
 import org.onap.policy.common.logging.flexlogger.FlexLogger;
 import org.onap.policy.common.logging.flexlogger.Logger;
-
-import org.onap.policy.distribution.model.PolicyInput;
 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.sdc.tosca.parser.api.ISdcCsarHelper;
-import org.onap.sdc.tosca.parser.impl.SdcCsarHelperImpl;
 import org.onap.sdc.tosca.parser.impl.SdcToscaParserFactory;
-
 import org.onap.sdc.toscaparser.api.NodeTemplate;
-import org.onap.sdc.toscaparser.api.elements.Metadata;
 
 /**
  * Decodes PDP-X policies from a TOSCA file.
@@ -51,16 +43,16 @@ public class PolicyDecoderCsarPdpx implements PolicyDecoder<Csar, PdpxPolicy> {
     private static final Logger LOGGER = FlexLogger.getLogger(PolicyDecoderCsarPdpx.class);
 
     @Override
-    public Collection<PdpxPolicy> decode(Csar csar) throws PolicyDecodingException {
-        // logic for generating the policies from the CSAR. 
-        List<PdpxPolicy> lPdpxPolicy = new ArrayList<>();
-        ISdcCsarHelper sdcCsarHelper = parseCsar(csar);
-        List<NodeTemplate> lnodeVf = sdcCsarHelper.getServiceVfList();
+    public Collection<PdpxPolicy> decode(final Csar csar) throws PolicyDecodingException {
+        // logic for generating the policies from the CSAR.
+        final List<PdpxPolicy> lPdpxPolicy = new ArrayList<>();
+        final ISdcCsarHelper sdcCsarHelper = parseCsar(csar);
+        final List<NodeTemplate> lnodeVf = sdcCsarHelper.getServiceVfList();
         LOGGER.debug("the size of Vf = " + lnodeVf.size());
-        ExtractFromNode extractFromNode = new ExtractFromNode();
+        final ExtractFromNode extractFromNode = new ExtractFromNode();
         extractFromNode.setSdcCsarHelper(sdcCsarHelper);
-        for ( NodeTemplate node : lnodeVf) {
-            PdpxPolicy ret = extractFromNode.extractInfo(node);
+        for (final NodeTemplate node : lnodeVf) {
+            final PdpxPolicy ret = extractFromNode.extractInfo(node);
             if (ret != null) {
                 lPdpxPolicy.add(ret);
             }
@@ -69,34 +61,37 @@ public class PolicyDecoderCsarPdpx implements PolicyDecoder<Csar, PdpxPolicy> {
     }
 
     @Override
-    public boolean canHandle(PolicyInput policyInput) {
+    public boolean canHandle(final PolicyInput policyInput) {
         return policyInput.getClass().isAssignableFrom(Csar.class);
     }
 
-    /** 
+    /**
      * Parse the input Csar by SDC tosca tool.
      *
      * @param csar represents the service TOSCA Csar
      * @return the object to represents the content of input csar
      * @throws PolicyDecodingException if parse fails
      */
-    public ISdcCsarHelper parseCsar(Csar csar)  throws PolicyDecodingException {
-        ISdcCsarHelper sdcCsarHelper ;
+    public ISdcCsarHelper parseCsar(final Csar csar) throws PolicyDecodingException {
+        ISdcCsarHelper sdcCsarHelper;
         try {
 
-            SdcToscaParserFactory factory = SdcToscaParserFactory.getInstance();//Autoclosable
+            final SdcToscaParserFactory factory = SdcToscaParserFactory.getInstance();// Autoclosable
 
             LOGGER.debug("tosca File Path = " + csar.getCsarPath());
 
-            File spoolFile = new File(csar.getCsarPath());
+            final File spoolFile = new File(csar.getCsarPath());
 
             sdcCsarHelper = factory.getSdcCsarHelper(spoolFile.getAbsolutePath());
 
-        } catch (Exception e) {
-            LOGGER.error("Exception got in parseTosca",e);
-            throw new PolicyDecodingException ("Exception caught when passing the csar file to the parser ", e);
+        } catch (final Exception e) {
+            LOGGER.error("Exception got in parseTosca", e);
+            throw new PolicyDecodingException("Exception caught when passing the csar file to the parser ", e);
         }
         return sdcCsarHelper;
     }
 
+    @Override
+    public void configure(final String parameterGroupName) {}
+
 }
diff --git a/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/pdpx/PolicyDecoderToscaPdpx.java b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/pdpx/PolicyDecoderToscaPdpx.java
index fa993579..40b33359 100644
--- a/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/pdpx/PolicyDecoderToscaPdpx.java
+++ b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/pdpx/PolicyDecoderToscaPdpx.java
@@ -5,15 +5,15 @@
  * 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=========================================================
  */
@@ -22,6 +22,7 @@ package org.onap.policy.distribution.reception.decoding.pdpx;
 
 import java.util.Collection;
 import java.util.Collections;
+
 import org.onap.policy.distribution.model.PolicyInput;
 import org.onap.policy.distribution.model.Tosca;
 import org.onap.policy.distribution.reception.decoding.PolicyDecoder;
@@ -32,14 +33,17 @@ import org.onap.policy.distribution.reception.decoding.PolicyDecoder;
 public class PolicyDecoderToscaPdpx implements PolicyDecoder<Tosca, PdpxPolicy> {
 
     @Override
-    public Collection<PdpxPolicy> decode(Tosca tosca) {
+    public Collection<PdpxPolicy> decode(final Tosca tosca) {
         // Add logic for generating the policies from the TOSCA
         return Collections.emptySet();
     }
 
     @Override
-    public boolean canHandle(PolicyInput policyInput) {
+    public boolean canHandle(final PolicyInput policyInput) {
         return policyInput.getClass().isAssignableFrom(Tosca.class);
     }
 
+    @Override
+    public void configure(final String parameterGroupName) {}
+
 }
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
new file mode 100644
index 00000000..9516ad70
--- /dev/null
+++ b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/policy/file/PolicyDecoderFileInCsarToPolicy.java
@@ -0,0 +1,94 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2018 Ericsson. 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.distribution.reception.decoding.policy.file;
+
+import java.io.IOException;
+import java.io.StringWriter;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Enumeration;
+import java.util.zip.ZipEntry;
+import java.util.zip.ZipFile;
+
+import org.apache.commons.io.IOUtils;
+import org.onap.policy.common.logging.flexlogger.FlexLogger;
+import org.onap.policy.common.logging.flexlogger.Logger;
+import org.onap.policy.common.parameters.ParameterService;
+import org.onap.policy.distribution.model.Csar;
+import org.onap.policy.distribution.model.PolicyAsString;
+import org.onap.policy.distribution.model.PolicyInput;
+import org.onap.policy.distribution.reception.decoding.PolicyDecoder;
+import org.onap.policy.distribution.reception.decoding.PolicyDecodingException;
+
+/**
+ * This class extracts policy files from a CSAR file.
+ *
+ * @author Ram Krishna Verma (ram.krishna.verma@ericsson.com)
+ */
+public class PolicyDecoderFileInCsarToPolicy implements PolicyDecoder<Csar, PolicyAsString> {
+
+    private static final Logger LOGGER = FlexLogger.getLogger(PolicyDecoderFileInCsarToPolicy.class);
+    PolicyDecoderFileInCsarToPolicyParameterGroup decoderParameters;
+
+    /**
+     * {@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<PolicyAsString> decode(final Csar csar) throws PolicyDecodingException {
+        final Collection<PolicyAsString> policyList = new ArrayList<>();
+
+        try (ZipFile zipFile = new ZipFile(csar.getCsarPath())) {
+            final Enumeration<? extends ZipEntry> entries = zipFile.entries();
+            while (entries.hasMoreElements()) {
+                final ZipEntry entry = entries.nextElement();
+                if (entry.getName().contains(decoderParameters.getPolicyFileName())) {
+                    final StringWriter writer = new StringWriter();
+                    IOUtils.copy(zipFile.getInputStream(entry), writer, "UTF-8");
+                    final PolicyAsString poilcy = new PolicyAsString(decoderParameters.getPolicyFileName(),
+                            decoderParameters.getPolicyType(), writer.toString());
+                    policyList.add(poilcy);
+                }
+            }
+        } catch (final IOException exp) {
+            final String message = "Failed decoding the policy";
+            LOGGER.error(message, exp);
+            throw new PolicyDecodingException(message, exp);
+        }
+
+        return policyList;
+    }
+}
diff --git a/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/policy/file/PolicyDecoderFileInCsarToPolicyParameterGroup.java b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/policy/file/PolicyDecoderFileInCsarToPolicyParameterGroup.java
new file mode 100644
index 00000000..958180db
--- /dev/null
+++ b/plugins/reception-plugins/src/main/java/org/onap/policy/distribution/reception/decoding/policy/file/PolicyDecoderFileInCsarToPolicyParameterGroup.java
@@ -0,0 +1,70 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2018 Ericsson. 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.distribution.reception.decoding.policy.file;
+
+import org.onap.policy.common.parameters.GroupValidationResult;
+import org.onap.policy.common.parameters.ValidationStatus;
+import org.onap.policy.common.utils.validation.ParameterValidationUtils;
+import org.onap.policy.distribution.reception.parameters.PolicyDecoderConfigurationParameterGroup;
+
+/**
+ * Holds the parameters for the{@link PolicyDecoderFileInCsarToPolicy}.
+ *
+ * @author Ram Krishna Verma (ram.krishna.verma@ericsson.com)
+ */
+public class PolicyDecoderFileInCsarToPolicyParameterGroup extends PolicyDecoderConfigurationParameterGroup {
+
+    private String policyFileName;
+    private String policyType;
+
+    /**
+     * Constructor for instantiating {@link PolicyDecoderFileInCsarToPolicyParameterGroup} class.
+     *
+     * @param policyFileName the policy file name
+     * @param policyType the policy type
+     */
+    public PolicyDecoderFileInCsarToPolicyParameterGroup(final String policyFileName, final String policyType) {
+        this.policyFileName = policyFileName;
+        this.policyType = policyType;
+    }
+
+    public String getPolicyFileName() {
+        return policyFileName;
+    }
+
+    public String getPolicyType() {
+        return policyType;
+    }
+
+    @Override
+    public GroupValidationResult validate() {
+        final GroupValidationResult validationResult = new GroupValidationResult(this);
+        if (!ParameterValidationUtils.validateStringParameter(policyFileName)) {
+            validationResult.setResult("policyFileName", ValidationStatus.INVALID,
+                    "must be a non-blank string containing the policy file name");
+        }
+        if (!ParameterValidationUtils.validateStringParameter(policyType)) {
+            validationResult.setResult("policyType", ValidationStatus.INVALID,
+                    "must be a non-blank string containing the policy type");
+        }
+        return validationResult;
+    }
+}