Update documentation and fix path to python test resources

Issue-ID: VNFSDK-731
Signed-off-by: Edyta Krukowska <edyta.krukowska@nokia.com>
Change-Id: Ie7b045fd55a2192bc90c972e60de58ac5aaa66cc

8 files changed, 152 insertions, 51 deletions

diff --git a/csarvalidation/python/main/validation/rules/ActiveRulesTableGenerator.py b/csarvalidation/python/main/validation/rules/ActiveRulesTableGenerator.py
index c8a0f37..56122e7 100644
--- a/csarvalidation/python/main/validation/rules/ActiveRulesTableGenerator.py
+++ b/csarvalidation/python/main/validation/rules/ActiveRulesTableGenerator.py
@@ -1,7 +1,7 @@
 # ============LICENSE_START====================================
 # vnfsdk-validation
 # =========================================================
-# Copyright (C) 2020 Nokia. All rights reserved.
+# Copyright (C) 2021 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.
@@ -47,6 +47,7 @@ class ActiveRulesTableGenerator:
             active_rules_table.add_entity(
                 ActiveRuleEntity(
                     rule,
+                    self._get_release_from_yaml(yaml_description),
                     self._get_description_from_yaml(yaml_description),
                     self._get_product_from_yaml(yaml_description)
                 )
@@ -68,3 +69,7 @@ class ActiveRulesTableGenerator:
     @staticmethod
     def _get_product_from_yaml(yaml_file: dict) -> str:
         return yaml_file['info']['product']
+
+    @staticmethod
+    def _get_release_from_yaml(yaml_file: dict) -> str:
+        return yaml_file['info']['metadata']['release']
diff --git a/csarvalidation/python/main/validation/rules/table/ActiveRuleEntity.py b/csarvalidation/python/main/validation/rules/table/ActiveRuleEntity.py
index ed8c7d5..d3b0088 100644
--- a/csarvalidation/python/main/validation/rules/table/ActiveRuleEntity.py
+++ b/csarvalidation/python/main/validation/rules/table/ActiveRuleEntity.py
@@ -1,7 +1,7 @@
 # ============LICENSE_START====================================
 # vnfsdk-validation
 # =========================================================
-# Copyright (C) 2020 Nokia. All rights reserved.
+# Copyright (C) 2021 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.
@@ -18,7 +18,8 @@
 
 class ActiveRuleEntity:
 
-    def __init__(self, rule, description, product):
+    def __init__(self, rule, release, description, product):
         self.rule = rule
+        self.release = release
         self.description = description
         self.product = product
diff --git a/csarvalidation/python/main/validation/rules/table/ActiveRulesTable.py b/csarvalidation/python/main/validation/rules/table/ActiveRulesTable.py
index 70bb10d..250f0f4 100644
--- a/csarvalidation/python/main/validation/rules/table/ActiveRulesTable.py
+++ b/csarvalidation/python/main/validation/rules/table/ActiveRulesTable.py
@@ -1,7 +1,7 @@
 # ============LICENSE_START====================================
 # vnfsdk-validation
 # =========================================================
-# Copyright (C) 2020 Nokia. All rights reserved.
+# Copyright (C) 2021 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.
@@ -29,9 +29,15 @@ class ActiveRulesTable:
 
     def get_table_in_csv_format(self, values_separator=";", entity_separator="\n") -> str:
         csv_table = ""
-        for entity in self._active_rules_entities:
+        active_rules_entries_sorted_by_release = ActiveRulesTable._sort_by_release(self._active_rules_entities)
+        for entity in active_rules_entries_sorted_by_release:
             csv_table += \
                 entity.product + values_separator + \
+                entity.release + values_separator + \
                 entity.rule + values_separator + \
                 entity.description + entity_separator
         return csv_table
+
+    @staticmethod
+    def _sort_by_release(active_rules_entities: list) -> list:
+        return sorted(active_rules_entities, key=lambda it: it.release)
diff --git a/csarvalidation/python/requirements.txt b/csarvalidation/python/requirements.txt
index 7a997b5..281ba87 100644
--- a/csarvalidation/python/requirements.txt
+++ b/csarvalidation/python/requirements.txt
@@ -1 +1,2 @@
 PyYAML==5.3.1
+jproperties==2.1.0
\ No newline at end of file
diff --git a/csarvalidation/python/test/application_configuration.py b/csarvalidation/python/test/application_configuration.py
new file mode 100644
index 0000000..432b08b
--- /dev/null
+++ b/csarvalidation/python/test/application_configuration.py
@@ -0,0 +1,43 @@
+# ============LICENSE_START====================================
+# vnfsdk-validation
+# =========================================================
+# Copyright (C) 2021 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 pathlib
+from jproperties import Properties
+
+
+def get_releases(path_to_properties: str) -> str:
+    configs = Properties()
+    with open(path_to_properties, 'rb') as properties:
+        configs.load(properties)
+
+    return configs.get('releases.order').data
+
+
+def get_path_to_csarvalidate_folder(current_location: str) -> str:
+    return str(pathlib.Path(current_location).parent.parent.parent.absolute())
+
+
+RESOURCES_DIRECTORY = get_path_to_csarvalidate_folder(__file__) + '/src/main/resources/'
+RULE_DESCRIPTION_SOL001_PATH = RESOURCES_DIRECTORY + 'open-cli-schema/sol001/'
+RULE_DESCRIPTION_SOL004_PATH = RESOURCES_DIRECTORY + 'open-cli-schema/sol004/'
+VNFREWS_PROPERTIES_PATH = RESOURCES_DIRECTORY + 'vnfreqs.properties'
+RULE_DESCRIPTION_FILE_NAME_PATTERN = 'vtp-validate-csar-%s.yaml'
+
+CSV_DELIMITER = ";"
+
+VNF_REQS_TAG = "vnfreqs"
+PNF_REQS_TAG = "pnfreqs"
diff --git a/csarvalidation/python/test/assertion.py b/csarvalidation/python/test/assertion.py
new file mode 100644
index 0000000..12365f3
--- /dev/null
+++ b/csarvalidation/python/test/assertion.py
@@ -0,0 +1,31 @@
+# ============LICENSE_START====================================
+# vnfsdk-validation
+# =========================================================
+# Copyright (C) 2021 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 unittest
+
+
+def verify_that_cvc_line_is_valid(testcase: unittest.TestCase, line: str, releases: str, delimiter: str):
+    values = line.split(delimiter)
+    testcase.assertTrue(len(values) == 4)
+    testcase.assertTrue(values[0].startswith("onap-"))
+    testcase.assertTrue(
+        values[1] in releases,
+        msg="Rule '{}' has wrong release name '{}'. Release name must match to one of '{}'".format(
+            values[2], values[1], releases
+        )
+    )
+    testcase.assertTrue(values[2].startswith("r"))
diff --git a/csarvalidation/python/test/test_ActiveRulesTableGenerator.py b/csarvalidation/python/test/test_ActiveRulesTableGenerator.py
index 3103a23..66119e1 100644
--- a/csarvalidation/python/test/test_ActiveRulesTableGenerator.py
+++ b/csarvalidation/python/test/test_ActiveRulesTableGenerator.py
@@ -1,7 +1,7 @@
 # ============LICENSE_START====================================
 # vnfsdk-validation
 # =========================================================
-# Copyright (C) 2020 Nokia. All rights reserved.
+# Copyright (C) 2021 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.
@@ -18,20 +18,13 @@
 
 import unittest
 
+import application_configuration
+import assertion
 from validation.rules.ActiveRulesTableGenerator import ActiveRulesTableGenerator
 from validation.rules.providers.ActiveRulesProvider import ActiveRulesProvider
 from validation.rules.providers.RulesDescriptionsProvider import RulesDescriptionsProvider
-
-RESOURCES_DIRECTORY = '../src/main/resources/'
-RULE_DESCRIPTION_SOL001_PATH = RESOURCES_DIRECTORY + 'open-cli-schema/sol001/'
-RULE_DESCRIPTION_SOL004_PATH = RESOURCES_DIRECTORY + 'open-cli-schema/sol004/'
-VNFREWS_PROPERTIES_PATH = RESOURCES_DIRECTORY + 'vnfreqs.properties'
-RULE_DESCRIPTION_FILE_NAME_PATTERN = 'vtp-validate-csar-%s.yaml'
-
-CSV_DELIMITER = ";"
-
-VNF_REQS_TAG = "vnfreqs"
-PNF_REQS_TAG = "pnfreqs"
+from validation.rules.table.ActiveRuleEntity import ActiveRuleEntity
+from validation.rules.table.ActiveRulesTable import ActiveRulesTable
 
 
 class ActiveRulesTableGeneratorTest(unittest.TestCase):
@@ -40,38 +33,65 @@ class ActiveRulesTableGeneratorTest(unittest.TestCase):
     def generate_tables_with_active_rules(requs_tags: list) -> list:
         return ActiveRulesTableGenerator(
             [
-                RulesDescriptionsProvider(RULE_DESCRIPTION_SOL001_PATH, RULE_DESCRIPTION_FILE_NAME_PATTERN),
-                RulesDescriptionsProvider(RULE_DESCRIPTION_SOL004_PATH, RULE_DESCRIPTION_FILE_NAME_PATTERN)
+                RulesDescriptionsProvider(application_configuration.RULE_DESCRIPTION_SOL001_PATH,
+                                          application_configuration.RULE_DESCRIPTION_FILE_NAME_PATTERN),
+                RulesDescriptionsProvider(application_configuration.RULE_DESCRIPTION_SOL004_PATH,
+                                          application_configuration.RULE_DESCRIPTION_FILE_NAME_PATTERN)
             ],
-            ActiveRulesProvider(VNFREWS_PROPERTIES_PATH)
+            ActiveRulesProvider(application_configuration.VNFREWS_PROPERTIES_PATH)
         ).generate_active_validation_rule_tables(requs_tags)
 
     def test_generate_table_with_active_pnf_rules(self):
-        tables = self.generate_tables_with_active_rules([PNF_REQS_TAG])
+        tables = self.generate_tables_with_active_rules([application_configuration.PNF_REQS_TAG])
 
         self.assertTrue(len(tables) == 1)
         self.validate_csv_table_with_rules(tables[0].get_table_in_csv_format())
 
     def test_generate_table_with_active_vnf_rules(self):
-        tables = self.generate_tables_with_active_rules([VNF_REQS_TAG])
+        tables = self.generate_tables_with_active_rules([application_configuration.VNF_REQS_TAG])
 
         self.assertTrue(len(tables) == 1)
         self.validate_csv_table_with_rules(tables[0].get_table_in_csv_format())
 
     def test_generate_tables_with_active_vnf_and_pnf_rules(self):
-        tables = self.generate_tables_with_active_rules([PNF_REQS_TAG, VNF_REQS_TAG])
+        tables = self.generate_tables_with_active_rules([application_configuration.PNF_REQS_TAG,
+                                                         application_configuration.VNF_REQS_TAG])
 
         self.assertTrue(len(tables) == 2)
-        self.validate_csv_table_with_rules(tables[0].get_table_in_csv_format(values_separator=CSV_DELIMITER))
-        self.validate_csv_table_with_rules(tables[1].get_table_in_csv_format(values_separator=CSV_DELIMITER))
+        self.validate_csv_table_with_rules(tables[0].get_table_in_csv_format(values_separator=
+                                                                             application_configuration.CSV_DELIMITER))
+        self.validate_csv_table_with_rules(tables[1].get_table_in_csv_format(values_separator=
+                                                                             application_configuration.CSV_DELIMITER))
 
     def validate_csv_table_with_rules(self, vnf_rules: str):
+        releases = application_configuration.get_releases(application_configuration.VNFREWS_PROPERTIES_PATH)
         lines = vnf_rules.splitlines()
         for line in lines:
-            values = line.split(CSV_DELIMITER)
-            self.assertTrue(len(values) == 3)
-            self.assertTrue(values[0].startswith("onap-"))
-            self.assertTrue(values[1].startswith("r"))
+            assertion.verify_that_cvc_line_is_valid(self, line, releases, application_configuration.CSV_DELIMITER)
+
+    def test_sort_active_rule_entries_by_release(self):
+        # given
+        rule_entries = [
+            ActiveRuleEntity(product="onap-vtp", rule="r-1", release="honolulu", description="Some desc"),
+            ActiveRuleEntity(product="onap-vtp", rule="r-2", release="guilin", description="Some desc"),
+            ActiveRuleEntity(product="onap-vtp", rule="r-3", release="amsterdam", description="Some desc"),
+            ActiveRuleEntity(product="onap-vtp", rule="r-4", release="casablanca", description="Some desc"),
+            ActiveRuleEntity(product="onap-vtp", rule="r-5", release="frankfurt", description="Some desc"),
+            ActiveRuleEntity(product="onap-vtp", rule="r-6", release="amsterdam", description="Some desc")
+        ]
+
+        # when
+        sorted_entries = ActiveRulesTable._sort_by_release(rule_entries)
+
+        # then
+        self.assertTrue(sorted_entries[0].release == 'amsterdam')
+        self.assertTrue(sorted_entries[1].release == 'amsterdam')
+        self.assertTrue(sorted_entries[2].release == 'casablanca')
+        self.assertTrue(sorted_entries[3].release == 'frankfurt')
+        self.assertTrue(sorted_entries[4].release == 'guilin')
+        self.assertTrue(sorted_entries[5].release == 'honolulu')
+
+
 
 
 if __name__ == '__main__':
diff --git a/csarvalidation/python/test/test_FileManager.py b/csarvalidation/python/test/test_FileManager.py
index 722d1a9..0b6f413 100644
--- a/csarvalidation/python/test/test_FileManager.py
+++ b/csarvalidation/python/test/test_FileManager.py
@@ -1,7 +1,7 @@
 # ============LICENSE_START====================================
 # vnfsdk-validation
 # =========================================================
-# Copyright (C) 2020 Nokia. All rights reserved.
+# Copyright (C) 2021 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.
@@ -19,23 +19,14 @@
 import os
 import shutil
 import unittest
+import application_configuration
+import assertion
 
 from validation.FileManager import FileManager
 from validation.rules.ActiveRulesTableGenerator import ActiveRulesTableGenerator
 from validation.rules.providers.ActiveRulesProvider import ActiveRulesProvider
 from validation.rules.providers.RulesDescriptionsProvider import RulesDescriptionsProvider
 
-RESOURCES_DIRECTORY = '../src/main/resources/'
-RULE_DESCRIPTION_SOL001_PATH = RESOURCES_DIRECTORY + 'open-cli-schema/sol001/'
-RULE_DESCRIPTION_SOL004_PATH = RESOURCES_DIRECTORY + 'open-cli-schema/sol004/'
-VNFREWS_PROPERTIES_PATH = RESOURCES_DIRECTORY + 'vnfreqs.properties'
-RULE_DESCRIPTION_FILE_NAME_PATTERN = 'vtp-validate-csar-%s.yaml'
-
-CSV_DELIMITER = ";"
-
-VNF_REQS_TAG = "vnfreqs"
-PNF_REQS_TAG = "pnfreqs"
-
 OUTPUT_DIRECTORY = './active_rules_table_generator_test/'
 
 TABLE_WITH_VNF_RULES = OUTPUT_DIRECTORY + 'VnfActiveRulesTable.csv'
@@ -49,21 +40,26 @@ class FileManagerTest(unittest.TestCase):
     def generate_tables_with_active_rules(requs_tags: list) -> list:
         return ActiveRulesTableGenerator(
             [
-                RulesDescriptionsProvider(RULE_DESCRIPTION_SOL001_PATH, RULE_DESCRIPTION_FILE_NAME_PATTERN),
-                RulesDescriptionsProvider(RULE_DESCRIPTION_SOL004_PATH, RULE_DESCRIPTION_FILE_NAME_PATTERN)
+                RulesDescriptionsProvider(application_configuration.RULE_DESCRIPTION_SOL001_PATH,
+                                          application_configuration.RULE_DESCRIPTION_FILE_NAME_PATTERN),
+                RulesDescriptionsProvider(application_configuration.RULE_DESCRIPTION_SOL004_PATH,
+                                          application_configuration.RULE_DESCRIPTION_FILE_NAME_PATTERN)
             ],
-            ActiveRulesProvider(VNFREWS_PROPERTIES_PATH)
+            ActiveRulesProvider(application_configuration.VNFREWS_PROPERTIES_PATH)
         ).generate_active_validation_rule_tables(requs_tags)
 
     def generate_and_save_tables(self):
-        tables = self.generate_tables_with_active_rules([VNF_REQS_TAG, PNF_REQS_TAG])
+        tables = self.generate_tables_with_active_rules([application_configuration.VNF_REQS_TAG,
+                                                         application_configuration.PNF_REQS_TAG])
         file_manager = FileManager(OUTPUT_DIRECTORY)
         file_manager.save_rule_table(
-            tables[0].get_table_in_csv_format(values_separator=CSV_DELIMITER),
+            tables[0].get_table_in_csv_format(values_separator=
+                                              application_configuration.CSV_DELIMITER),
             TABLE_WITH_VNF_RULES
         )
         file_manager.save_rule_table(
-            tables[1].get_table_in_csv_format(values_separator=CSV_DELIMITER),
+            tables[1].get_table_in_csv_format(values_separator=
+                                              application_configuration.CSV_DELIMITER),
             TABLE_WITH_PNF_RULES
         )
 
@@ -83,12 +79,10 @@ class FileManagerTest(unittest.TestCase):
             self.validate_csv_table_with_rules(pnf_rules)
 
     def validate_csv_table_with_rules(self, vnf_rules):
+        releases = application_configuration.get_releases(application_configuration.VNFREWS_PROPERTIES_PATH)
         lines = vnf_rules.read().splitlines()
         for line in lines:
-            values = line.split(CSV_DELIMITER)
-            self.assertTrue(len(values) == 3)
-            self.assertTrue(values[0].startswith("onap-"))
-            self.assertTrue(values[1].startswith("r"))
+            assertion.verify_that_cvc_line_is_valid(self, line, releases, application_configuration.CSV_DELIMITER)
 
 
 if __name__ == '__main__':