Create pnf scar archive module

Change-Id: Iad552af5d4e9f446de9abecdded317ee2065edc4
Issue-ID: VNFSDK-377
Signed-off-by: Zebek Bogumil <bogumil.zebek@nokia.com>

6 files changed, 398 insertions, 0 deletions

diff --git a/csarvalidation/src/test/java/org/onap/cvc/csar/PnfCSARArchiveTest.java b/csarvalidation/src/test/java/org/onap/cvc/csar/PnfCSARArchiveTest.java
new file mode 100644
index 0000000..4a211a5
--- /dev/null
+++ b/csarvalidation/src/test/java/org/onap/cvc/csar/PnfCSARArchiveTest.java
@@ -0,0 +1,75 @@
+/**
+ * Copyright 2019 Nokia
+ *
+ * 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 org.onap.cvc.csar;
+
+
+import com.google.common.collect.Lists;
+import org.junit.Test;
+
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.util.List;
+import java.util.Map;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class PnfCSARArchiveTest {
+
+    @Test
+    public void shouldUseDataStoredInManifestMfFileToConfigurePnfCSARArchive() throws IOException, URISyntaxException {
+        // given
+        String fileName = PnfCSARArchiveTest.class.getClassLoader().getResource("pnf/dummyPnfv2.csar")
+                .toURI().getPath();
+        PnfCSARArchive pnfCSARArchive = new PnfCSARArchive();
+        pnfCSARArchive.init(fileName);
+
+        // when
+        try {
+            pnfCSARArchive.parse();
+        }finally {
+            pnfCSARArchive.cleanup();
+        }
+
+        // then
+        verifyThatMetadataWasSet(pnfCSARArchive);
+        verifyThatNonManoArtifactsWereSet(pnfCSARArchive);
+    }
+
+    private void verifyThatNonManoArtifactsWereSet(PnfCSARArchive pnfCSARArchive) {
+        Map<String, Map<String, List<String>>> nonManoArtifacts = pnfCSARArchive.getManifest().getNonMano();
+        assertThat(nonManoArtifacts.get("prv.onap.ves_event").get("Source"))
+                .isEqualTo(Lists.newArrayList("Artifacts/Deployment/Events/RadioNode_Pnf_v1.yml")
+                );
+        assertThat(nonManoArtifacts.get("prv.onap.pm_dictionary").get("Source"))
+                .isEqualTo(Lists.newArrayList("Artifacts/Deployment/Measurements/PM_Dictionary.yml")
+                );
+        assertThat(nonManoArtifacts.get("prv.onap.yang_modules").get("Source"))
+                .isEqualTo(Lists.newArrayList(
+                        "Artifacts/Deployment/Yang_module/yang-module1.yang",
+                        "Artifacts/Deployment/Yang_module/yang-module2.yang"
+                )
+        );
+    }
+
+    private void verifyThatMetadataWasSet(PnfCSARArchive pnfCSARArchive) {
+        CSARArchive.Manifest.Metadata metadata = pnfCSARArchive.getManifest().getMetadata();
+        assertThat(metadata.getProductName()).isEqualTo("RadioNode");
+        assertThat(metadata.getProviderId()).isEqualTo("Ericsson");
+        assertThat(metadata.getPackageVersion()).isEqualTo("1.0");
+        assertThat(metadata.getReleaseDateTime()).isEqualTo("2019-01-14T11:25:00+00:00");
+    }
+
+}
\ No newline at end of file
diff --git a/csarvalidation/src/test/java/org/onap/cvc/csar/PnfManifestParserTest.java b/csarvalidation/src/test/java/org/onap/cvc/csar/PnfManifestParserTest.java
new file mode 100644
index 0000000..a925674
--- /dev/null
+++ b/csarvalidation/src/test/java/org/onap/cvc/csar/PnfManifestParserTest.java
@@ -0,0 +1,76 @@
+/**
+ * Copyright 2019 Nokia
+ * <p>
+ * 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
+ * <p>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 org.onap.cvc.csar;
+
+import com.google.common.collect.Lists;
+import org.apache.commons.lang3.tuple.Pair;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.util.List;
+import java.util.Map;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+
+public class PnfManifestParserTest {
+
+    private PnfManifestParser pnfManifestParser;
+
+    @Before
+    public void setUp() throws URISyntaxException, IOException {
+        String fileName = PnfManifestParserTest.class.getClassLoader().getResource("pnf/MainServiceTemplate.mf")
+                .toURI().getPath();
+        pnfManifestParser = PnfManifestParser.getInstance(fileName);
+    }
+
+    @Test
+    public void shouldFetchMetadataFromFile() {
+        Pair<CSARArchive.Manifest.Metadata, List<CSARArchive.CSARError>> metadataListPair = pnfManifestParser.fetchMetadata();
+        CSARArchive.Manifest.Metadata metadata = metadataListPair.getKey();
+        List<CSARArchive.CSARError> errors= metadataListPair.getValue();
+
+        assertThat(metadata.getProductName()).isEqualTo("RadioNode");
+        assertThat(metadata.getProviderId()).isEqualTo("Ericsson");
+        assertThat(metadata.getPackageVersion()).isEqualTo("1.0");
+        assertThat(metadata.getReleaseDateTime()).isEqualTo("2019-01-14T11:25:00+00:00");
+        assertThat(errors.size()).isEqualTo(0);
+    }
+
+
+    @Test
+    public void shouldFetchNonManoArtifactsFromFile() {
+        Pair<Map<String, Map<String, List<String>>>, List<CSARArchive.CSARError>> mapListPair = pnfManifestParser.fetchNonManoArtifacts();
+        Map<String, Map<String, List<String>>> nonManoArtifacts = mapListPair.getKey();
+        List<CSARArchive.CSARError> errors= mapListPair.getValue();
+
+        assertThat(nonManoArtifacts.get("prv.onap.ves_event").get("Source"))
+                .isEqualTo(Lists.newArrayList("Artifacts/Deployment/Events/RadioNode_Pnf_v1.yml")
+                );
+        assertThat(nonManoArtifacts.get("prv.onap.pm_dictionary").get("Source"))
+                .isEqualTo(Lists.newArrayList("Artifacts/Deployment/Measurements/PM_Dictionary.yml")
+                );
+        assertThat(nonManoArtifacts.get("prv.onap.yang_modules").get("Source"))
+                .isEqualTo(Lists.newArrayList(
+                        "Artifacts/Deployment/Yang_module/yang-module1.yang",
+                        "Artifacts/Deployment/Yang_module/yang-module2.yang"
+                        )
+                );
+        assertThat(errors.size()).isEqualTo(0);
+    }
+}
\ No newline at end of file
diff --git a/csarvalidation/src/test/java/org/onap/cvc/csar/PnfMetadataParserTest.java b/csarvalidation/src/test/java/org/onap/cvc/csar/PnfMetadataParserTest.java
new file mode 100644
index 0000000..500fdd6
--- /dev/null
+++ b/csarvalidation/src/test/java/org/onap/cvc/csar/PnfMetadataParserTest.java
@@ -0,0 +1,155 @@
+/**
+ * Copyright 2019 Nokia
+ *
+ * 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 org.onap.cvc.csar;
+
+import com.google.common.collect.Lists;
+import org.apache.commons.lang3.tuple.Pair;
+import org.junit.Test;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class PnfMetadataParserTest {
+
+    @Test
+    public void shouldReportAnErrorWhenMetadataSectionIsNotAvailable() {
+        // given
+        List<String> lines = Lists.newArrayList(
+                "someSection:",
+                "param_name: some value",
+                "nextSection:",
+                "param_name: some value"
+        );
+
+
+        // when
+        PnfManifestParser pnfManifestParser = new PnfManifestParser(lines, "fileName");
+        Pair<CSARArchive.Manifest.Metadata, List<CSARArchive.CSARError>> data = pnfManifestParser.fetchMetadata();
+
+        //then
+        List<CSARArchive.CSARError> errors = data.getRight();
+        assertThat(errors.size()).isEqualTo(1);
+        assertThat(errors.stream().map(CSARArchive.CSARError::getMessage).collect(Collectors.toList())).contains(
+                "Missing. Entry [metadata]"
+        );
+    }
+
+    @Test
+    public void shouldReportInvalidEntriesInMetadataSection() {
+
+        // given
+        List<String> lines = Lists.newArrayList(
+                "metadata:",
+                "pnf_product_name: RadioNode",
+                "pnf_provider_id: Ericsson",
+                "pnf_package_version: 1.0",
+                "pnf_release_date_time: 2019-01-14T11:25:00+00:00",
+                "extra_param_1: some value",
+                "extra_param_2: some value"
+        );
+
+        // when
+        PnfManifestParser pnfManifestParser = new PnfManifestParser(lines, "fileName");
+        Pair<CSARArchive.Manifest.Metadata, List<CSARArchive.CSARError>> data = pnfManifestParser.fetchMetadata();
+
+        //then
+        List<CSARArchive.CSARError> errors = data.getRight();
+        assertThat(errors.size()).isEqualTo(2);
+        assertThat(errors.stream().map(CSARArchive.CSARError::getMessage).collect(Collectors.toList())).contains(
+                "Invalid. Entry [extra_param_1]",
+                "Invalid. Entry [extra_param_2]"
+        );
+    }
+
+
+    @Test
+    public void shouldParseMetadataToKnownSectionAndDoNotReportAnyError() {
+
+        // given
+        List<String> lines = Lists.newArrayList(
+                "metadata:",
+                "pnf_product_name: RadioNode",
+                "pnf_provider_id: Ericsson",
+                "pnf_package_version: 1.0",
+                "pnf_release_date_time: 2019-01-14T11:25:00+00:00",
+                "non_mano_artifact_sets:",
+                "param_name: some value"
+        );
+
+        // when
+        PnfManifestParser pnfManifestParser = new PnfManifestParser(lines, "fileName");
+        Pair<CSARArchive.Manifest.Metadata, List<CSARArchive.CSARError>> data = pnfManifestParser.fetchMetadata();
+
+        //then
+        List<CSARArchive.CSARError> errors = data.getRight();
+        assertThat(errors.size()).isEqualTo(0);
+
+    }
+
+
+
+    @Test
+    public void shouldReportAWarningWhenUnrecognizedSectionWasFoundDuringMetadataSectionParsing() {
+        // given
+        List<String> lines = Lists.newArrayList(
+                "metadata:",
+                "pnf_product_name: RadioNode",
+                "pnf_provider_id: Ericsson",
+                "pnf_package_version: 1.0",
+                "pnf_release_date_time: 2019-01-14T11:25:00+00:00",
+                "unknown_section:",
+                "param_name: some value"
+        );
+
+        // when
+        PnfManifestParser pnfManifestParser = new PnfManifestParser(lines, "fileName");
+        Pair<CSARArchive.Manifest.Metadata, List<CSARArchive.CSARError>> data = pnfManifestParser.fetchMetadata();
+
+        //then
+        List<CSARArchive.CSARError> errors = data.getRight();
+        assertThat(errors.size()).isEqualTo(1);
+        assertThat(errors.stream().map(CSARArchive.CSARError::getMessage).collect(Collectors.toList())).contains(
+                "Warning. Entry [unknown_section]"
+        );
+    }
+
+
+    @Test
+    public void shouldReportAWarningWhenTokenWithOutColonWasFoundDuringMetadataProcessing() {
+        // given
+        List<String> lines = Lists.newArrayList(
+                "metadata:",
+                "pnf_product_name RadioNode",
+                "pnf_provider_id: Ericsson",
+                "pnf_package_version: 1.0",
+                "pnf_release_date_time: 2019-01-14T11:25:00+00:00"
+        );
+
+        // when
+        PnfManifestParser pnfManifestParser = new PnfManifestParser(lines, "fileName");
+        Pair<CSARArchive.Manifest.Metadata, List<CSARArchive.CSARError>> data = pnfManifestParser.fetchMetadata();
+
+        //then
+        List<CSARArchive.CSARError> errors = data.getRight();
+        assertThat(errors.size()).isEqualTo(1);
+        assertThat(errors.stream().map(CSARArchive.CSARError::getMessage).collect(Collectors.toList())).contains(
+                "Warning. Entry [pnf_product_name RadioNode]"
+        );
+    }
+
+}
diff --git a/csarvalidation/src/test/java/org/onap/cvc/csar/PnfNonManoArtifactsParserTest.java b/csarvalidation/src/test/java/org/onap/cvc/csar/PnfNonManoArtifactsParserTest.java
new file mode 100644
index 0000000..95526bb
--- /dev/null
+++ b/csarvalidation/src/test/java/org/onap/cvc/csar/PnfNonManoArtifactsParserTest.java
@@ -0,0 +1,78 @@
+/**
+ * Copyright 2019 Nokia
+ *
+ * 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 org.onap.cvc.csar;
+
+import com.google.common.collect.Lists;
+import org.apache.commons.lang3.tuple.Pair;
+import org.junit.Test;
+
+import java.util.List;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class PnfNonManoArtifactsParserTest {
+
+    @Test
+    public void shouldReportAnErrorWhenNonManoArtifactSectionIsNotAvailable() {
+        // given
+        List<String> lines = Lists.newArrayList(
+                "someSection:",
+                "param_name: some value",
+                "nextSection:",
+                "param_name: some value"
+        );
+
+
+        // when
+        PnfManifestParser pnfManifestParser = new PnfManifestParser(lines, "fileName");
+        Pair<Map<String, Map<String, List<String>>>, List<CSARArchive.CSARError>>  data = pnfManifestParser.fetchNonManoArtifacts();
+
+        //then
+        List<CSARArchive.CSARError> errors = data.getRight();
+        assertThat(errors.size()).isEqualTo(1);
+        assertThat(errors.stream().map(CSARArchive.CSARError::getMessage).collect(Collectors.toList())).contains(
+                "Missing. Entry [non_mano_artifact_sets]"
+        );
+    }
+
+    @Test
+    public void shouldParseNonManoArtifactsInProperFormatAndDoNotReportAnyError() {
+
+        // given
+        List<String> lines = Lists.newArrayList(
+                "non_mano_artifact_sets:",
+                                "prv.onap.ves_event:  # if private else onap_ves_event if public",
+                                    "Source: Artifacts/Deployment/Events/RadioNode_Pnf_v1.yml",
+                                    "extra_param_1: some value",
+                                    "extra_param_2: some value",
+                                "prv.onap.pm_dictionary:    # if private else onap_pm_dictionary if public",
+                                    "Source: Artifacts/Deployment/Measurements/PM_Dictionary.yml",
+                                "param name:     # if private else onap_yang_modules if public",
+                                    "key: value"
+        );
+
+        // when
+        PnfManifestParser pnfManifestParser = new PnfManifestParser(lines, "fileName");
+        Pair<Map<String, Map<String, List<String>>>, List<CSARArchive.CSARError>>  data = pnfManifestParser.fetchNonManoArtifacts();
+
+        //then
+        List<CSARArchive.CSARError> errors = data.getRight();
+        assertThat(errors.size()).isEqualTo(0);
+
+    }
+}
diff --git a/csarvalidation/src/test/resources/pnf/MainServiceTemplate.mf b/csarvalidation/src/test/resources/pnf/MainServiceTemplate.mf
new file mode 100644
index 0000000..c5a498c
--- /dev/null
+++ b/csarvalidation/src/test/resources/pnf/MainServiceTemplate.mf
@@ -0,0 +1,14 @@
+metadata:
+    pnf_product_name: RadioNode
+    pnf_provider_id: Ericsson
+    pnf_package_version: 1.0
+    pnf_release_date_time: 2019-01-14T11:25:00+00:00
+
+non_mano_artifact_sets:
+    prv.onap.ves_event:  # if private else onap_ves_event if public
+        Source: Artifacts/Deployment/Events/RadioNode_Pnf_v1.yml
+    prv.onap.pm_dictionary:    # if private else onap_pm_dictionary if public
+        Source: Artifacts/Deployment/Measurements/PM_Dictionary.yml
+    prv.onap.yang_modules:     # if private else onap_yang_modules if public
+        Source: Artifacts/Deployment/Yang_module/yang-module1.yang
+        Source: Artifacts/Deployment/Yang_module/yang-module2.yang
\ No newline at end of file
diff --git a/csarvalidation/src/test/resources/pnf/dummyPnfv2.csar b/csarvalidation/src/test/resources/pnf/dummyPnfv2.csar
new file mode 100644
index 0000000..2c626ed
--- /dev/null
+++ b/csarvalidation/src/test/resources/pnf/dummyPnfv2.csar