Add requested changes

Signed-off-by: Divya Madala <divyaasm@amazon.com>

Author: Divyaasm

src/validation_workflow/deb/validation_deb.py

@@ -42,7 +42,8 @@ def start_cluster(self) -> bool:
 
     def validation(self) -> bool:
         if self.check_cluster_readiness():
-            test_result, counter = ApiTestCases().test_apis(self.args.version, self.args.projects, self.check_for_security_plugin(os.path.join(os.sep, "usr", "share", "opensearch")) if not self.args.force_https else True)  # noqa: E501
+            test_result, counter = ApiTestCases().test_apis(self.args.version, self.args.projects,
+                                                            self.check_for_security_plugin(os.path.join(os.sep, "usr", "share", "opensearch")) if self.args.allow_http else True)
             if (test_result):
                 logging.info(f'All tests Pass : {counter}')
                 return True

src/validation_workflow/rpm/validation_rpm.py

@@ -48,7 +48,8 @@ def start_cluster(self) -> bool:
 
     def validation(self) -> bool:
         if self.check_cluster_readiness():
-            test_result, counter = ApiTestCases().test_apis(self.args.version, self.args.projects, self.check_for_security_plugin(os.path.join(os.sep, "usr", "share", "opensearch")) if not self.args.force_https else True)  # noqa: E501
+            test_result, counter = ApiTestCases().test_apis(self.args.version, self.args.projects,
+                                                            self.check_for_security_plugin(os.path.join(os.sep, "usr", "share", "opensearch")) if self.args.allow_http else True)
             if (test_result):
                 logging.info(f'All tests Pass : {counter}')
                 return True

src/validation_workflow/tar/validation_tar.py

@@ -45,7 +45,8 @@ def start_cluster(self) -> bool:
 
     def validation(self) -> bool:
         if self.check_cluster_readiness():
-            test_result, counter = ApiTestCases().test_apis(self.args.version, self.args.projects, self.check_for_security_plugin(os.path.join(self.tmp_dir.path, "opensearch")) if not self.args.force_https else True)  # noqa: E501
+            test_result, counter = ApiTestCases().test_apis(self.args.version, self.args.projects,
+                                                            self.check_for_security_plugin(os.path.join(self.tmp_dir.path, "opensearch")) if self.args.allow_http else True)
             if (test_result):
                 logging.info(f'All tests Pass : {counter}')
                 return True

src/validation_workflow/validation.py

@@ -95,10 +95,10 @@ def check_cluster_readiness(self) -> bool:
         max_retry = 20
         retry_count = 0
         while retry_count < max_retry:
-            logging.info(f'sleeping 5sec for retry {retry_count + 1}/{max_retry}')
+            logging.info(f'Sleeping 5sec for retry {retry_count + 1}/{max_retry}')
             time.sleep(5)
             if self.check_http_request():
-                logging.info('\n\ncluster is now ready for API test\n\n')
+                logging.info('\n\nCluster is now ready for API test\n\n')
                 return True
             retry_count += 1
         logging.error(f"Maximum number of retries ({max_retry}) reached. Cluster is not ready for API test.")

src/validation_workflow/validation_args.py

@@ -113,10 +113,10 @@ def __init__(self) -> None:
         )
         parser.add_argument(
             "-f",
-            "--force-https",
-            action="store_false",
-            default=True,
-            help="If False, use http/https to connect based on the existence of security plugin, else always use https, default to True"
+            "--allow-http",
+            action="store_true",
+            default=False,
+            help="If True, use http/https to connect based on the existence of security plugin, else always use https, default to False"
         )
         group = parser.add_mutually_exclusive_group()
         group.add_argument(
@@ -146,14 +146,14 @@ def __init__(self) -> None:
 
         if args.distribution == "docker":
             if args.osd_build_number != "latest" and "opensearch-dashboards" not in args.projects:
-                raise Exception("Provide opensearch-dashboards in projects argument to validate OpenSearch-Dashboards")
-            if not(args.validate_digest_only or args.using_staging_artifact_only):
+                raise Exception("osd_build_number argument cannot be provided without specifying opensearch-dashboards in --projects")
+            if not(args.validate_digest_only) and not(args.using_staging_artifact_only):
                 raise Exception("Provide either of --validate-digest-only and --using-staging-artifact-only for Docker Validation")
 
         self.version = args.version
         self.file_path = args.file_path
         self.artifact_type = args.artifact_type
-        self.force_https = args.force_https
+        self.allow_http = args.allow_http
         self.logging_level = args.logging_level
         self.distribution = args.distribution
         self.platform = args.platform

src/validation_workflow/yum/validation_yum.py

@@ -46,7 +46,8 @@ def start_cluster(self) -> bool:
 
     def validation(self) -> bool:
         if self.check_cluster_readiness():
-            test_result, counter = ApiTestCases().test_apis(self.args.version, self.args.projects, self.check_for_security_plugin(os.path.join(os.sep, "usr", "share", "opensearch")) if not self.args.force_https else True)  # noqa: E501
+            test_result, counter = ApiTestCases().test_apis(self.args.version, self.args.projects,
+                                                            self.check_for_security_plugin(os.path.join(os.sep, "usr", "share", "opensearch")) if self.args.allow_http else True)
             if (test_result):
                 logging.info(f'All tests Pass : {counter}')
                 return True

src/validation_workflow/zip/validation_zip.py

@@ -34,7 +34,8 @@ def installation(self) -> bool:
 
     def start_cluster(self) -> bool:
         try:
-            self.os_process.start(f"env OPENSEARCH_INITIAL_ADMIN_PASSWORD={get_password(str(self.args.version))} .\\opensearch-windows-install.bat", os.path.join(self.tmp_dir.path, f"opensearch-{self.args.version}"), False)  # noqa: E501
+            self.os_process.start(f"env OPENSEARCH_INITIAL_ADMIN_PASSWORD={get_password(str(self.args.version))} .\\opensearch-windows-install.bat",
+                                  os.path.join(self.tmp_dir.path, f"opensearch-{self.args.version}"), False)
             if "opensearch-dashboards" in self.args.projects:
                 self.osd_process.start(".\\bin\\opensearch-dashboards.bat", os.path.join(self.tmp_dir.path, f"opensearch-dashboards-{self.args.version}"), False)
             logging.info("Starting cluster")
@@ -44,7 +45,8 @@ def start_cluster(self) -> bool:
 
     def validation(self) -> bool:
         if self.check_cluster_readiness():
-            test_result, counter = ApiTestCases().test_apis(self.args.version, self.args.projects, self.check_for_security_plugin(os.path.join(self.tmp_dir.path, "opensearch")) if not self.args.force_https else True)  # noqa: E501
+            test_result, counter = ApiTestCases().test_apis(self.args.version, self.args.projects,
+                                                            self.check_for_security_plugin(os.path.join(self.tmp_dir.path, "opensearch")) if self.args.allow_http else True)
             if (test_result):
                 logging.info(f'All tests Pass : {counter}')
                 return True

tests/tests_validation_workflow/test_validation.py

@@ -81,7 +81,7 @@ def test_check_for_security_plugin(self, mock_validation_args: Mock, mock_path_e
     def test_check_cluster_readiness_error(self, mock_validation_args: Mock, mock_check_http: Mock, mock_sleep: Mock) -> None:
         mock_validation_args.return_value.version = '1.0.0.1000'
         mock_validation_args.return_value.validate_digest_only = False
-        mock_validation_args.return_value.force_https = False
+        mock_validation_args.return_value.allow_http = False
         mock_validation_args.return_value.projects = ["opensearch"]
         mock_check_http.return_value = False
 
@@ -96,7 +96,7 @@ def test_check_cluster_readiness_error(self, mock_validation_args: Mock, mock_ch
     def test_check_http_request(self, mock_api_get: Mock, mock_validation_args: Mock, mock_sleep: Mock) -> None:
         mock_validation_args.return_value.version = '1.3.13'
         mock_validation_args.return_value.validate_digest_only = False
-        mock_validation_args.return_value.force_https = False
+        mock_validation_args.return_value.allow_http = False
         mock_validation_args.return_value.projects = ["opensearch", "opensearch-dashboards"]
         mock_api_get.return_value = (200, "text")
 
@@ -111,7 +111,7 @@ def test_check_http_request(self, mock_api_get: Mock, mock_validation_args: Mock
     def test_check_http_request_error(self, mock_api_get: Mock, mock_validation_args: Mock, mock_sleep: Mock) -> None:
         mock_validation_args.return_value.version = '1.3.14'
         mock_validation_args.return_value.validate_digest_only = False
-        mock_validation_args.return_value.force_https = False
+        mock_validation_args.return_value.allow_http = False
         mock_validation_args.return_value.projects = ["opensearch"]
         mock_api_get.return_value = (400, "text")
 
@@ -126,7 +126,7 @@ def test_check_http_request_error(self, mock_api_get: Mock, mock_validation_args
     def test_check_http_request_connection_error(self, mock_api_get: Mock, mock_validation_args: Mock, mock_sleep: Mock) -> None:
         mock_validation_args.return_value.version = '2.3.0'
         mock_validation_args.return_value.validate_digest_only = False
-        mock_validation_args.return_value.force_https = False
+        mock_validation_args.return_value.allow_http = False
         mock_validation_args.return_value.projects = ["opensearch"]
         mock_api_get.side_effect = requests.exceptions.ConnectionError
 

tests/tests_validation_workflow/test_validation_args.py

@@ -67,30 +67,33 @@ def test_file_path(self) -> None:
     def test_artifact_type(self) -> None:
         self.assertNotEqual(ValidationArgs().artifact_type, "production")
 
-    @patch("argparse._sys.argv", [VALIDATION_PY, "--version", "1.3.6", "--distribution", "rpm", "--artifact-type", "staging", "--os-build-number", "1234", "--osd-build-number", "2312", "--force-https"])  # noqa: E501
-    def test_force_https(self) -> None:
-        self.assertEqual(ValidationArgs().force_https, False)
+    @patch("argparse._sys.argv", [VALIDATION_PY, "--version", "1.3.6", "--distribution", "rpm", "--artifact-type", "staging",
+                                  "--os-build-number", "1234", "--osd-build-number", "2312", "--allow-http"])
+    def test_allow_http(self) -> None:
+        self.assertEqual(ValidationArgs().allow_http, True)
 
     @patch("argparse._sys.argv", [VALIDATION_PY, "--version", "1.3.6", "--distribution", "rpm", "--artifact-type", "staging", "--os-build-number", "1234", "--osd-build-number", "2312"])
-    def test_without_force_https(self) -> None:
-        self.assertEqual(ValidationArgs().force_https, True)
+    def test_do_not_allow_http(self) -> None:
+        self.assertEqual(ValidationArgs().allow_http, False)
 
     @patch("argparse._sys.argv", [VALIDATION_PY, "--version", "1.3.0", "--projects", "opensearch"])
     def test_set_projects(self) -> None:
         self.assertEqual(ValidationArgs().projects, ["opensearch"])
 
-    @patch('sys.argv', [VALIDATION_PY, "--file-path", "opensearch=https://opensearch.org/releases/opensearch/2.8.0/opensearch-2.8.0-linux-x64.rpm", "opensearch-dashboard=https://opensearch.org/releases/opensearch/2.8.0/opensearch-dashboards-2.8.0-linux-x64.rpm"])  # noqa: E501
+    @patch('sys.argv', [VALIDATION_PY, "--file-path", "opensearch=https://opensearch.org/releases/opensearch/2.8.0/opensearch-2.8.0-linux-x64.rpm",
+                        "opensearch-dashboard=https://opensearch.org/releases/opensearch/2.8.0/opensearch-dashboards-2.8.0-linux-x64.rpm"])
     def test_dashboards_exception(self) -> None:
         with self.assertRaises(Exception) as ctx:
             self.assertEqual(ValidationArgs().distribution, "rpm")
         self.assertEqual(str(ctx.exception), "Missing OpenSearch artifact details! Please provide the valid product names among opensearch and opensearch-dashboards")
 
-    @patch("argparse._sys.argv", [VALIDATION_PY, "--version", "2.4.0", "--distribution", "docker", "--os-build-number", "1234", "--osd-build-number", "8393", "--projects", "opensearch", "--using-staging-artifact-only"])  # noqa: E501
+    @patch("argparse._sys.argv", [VALIDATION_PY, "--version", "2.4.0", "--distribution", "docker", "--os-build-number", "1234",
+                                  "--osd-build-number", "8393", "--projects", "opensearch", "--using-staging-artifact-only"])
     def test_docker_exception(self) -> None:
         with self.assertRaises(Exception) as ctx:
             self.assertEqual(ValidationArgs().projects, ["opensearch"])
             self.assertEqual(ValidationArgs().osd_build_number, "1234")
-        self.assertEqual(str(ctx.exception), "Provide opensearch-dashboards in projects argument to validate OpenSearch-Dashboards")
+        self.assertEqual(str(ctx.exception), "osd_build_number argument cannot be provided without specifying opensearch-dashboards in --projects")
 
     @patch("argparse._sys.argv", [VALIDATION_PY, "--version", "2.4.0", "--distribution", "docker", "--os-build-number", "1234", "--projects", "opensearch"])
     def test_docker_arguments_exception(self) -> None:

tests/tests_validation_workflow/test_validation_deb.py

@@ -19,8 +19,6 @@ def setUp(self) -> None:
         self.mock_args.projects = ["opensearch"]
         self.mock_args.file_path = {"opensearch": "/src/opensearch/opensearch-1.3.12.staging.deb"}
         self.mock_args.platform = "linux"
-        self.mock_args.force_https_check = True
-        self.mock_args.force_https = True
         self.call_methods = ValidateDeb(self.mock_args)
 
     @patch("validation_workflow.deb.validation_deb.execute")
@@ -94,10 +92,9 @@ def test_validation(self, mock_check_cluster: Mock, mock_test_apis: Mock) -> Non
     @patch('validation_workflow.validation.Validation.check_for_security_plugin')
     @patch('validation_workflow.validation.Validation.check_cluster_readiness')
     @patch('validation_workflow.tar.validation_tar.ValidationArgs')
-    def test_validation_without_force_https_check(self, mock_validation_args: Mock, mock_check_cluster: Mock, mock_security: Mock, mock_system: Mock,
-                                                  mock_basename: Mock, mock_test_apis: Mock) -> None:
+    def test_validation_with_allow_http(self, mock_validation_args: Mock, mock_check_cluster: Mock, mock_security: Mock, mock_system: Mock, mock_basename: Mock, mock_test_apis: Mock) -> None:
         mock_validation_args.return_value.version = '2.3.0'
-        mock_validation_args.return_value.force_https = False
+        mock_validation_args.return_value.allow_http = True
         validate_deb = ValidateDeb(mock_validation_args.return_value)
         mock_check_cluster.return_value = True
         mock_basename.side_effect = lambda path: "mocked_filename"

tests/tests_validation_workflow/test_validation_docker.py

@@ -49,7 +49,7 @@ def test_staging(self, mock_digest: Mock, mock_container: Mock, mock_test: Mock,
         # Set up mock objects
         mock_validation_args.return_value.version = '1.0.0.1000'
         mock_validation_args.return_value.validate_digest_only = False
-        mock_validation_args.return_value.force_https = False
+        mock_validation_args.return_value.allow_http = False
         mock_validation_args.return_value.projects = ["opensearch"]
         mock_docker_image.return_value = MagicMock()
         mock_container.return_value = (True, 'test_file.yml')
@@ -79,7 +79,7 @@ def test_staging_cluster_not_ready(self, mock_container: Mock, mock_validation_a
                                        mock_cluster_readiness: Mock) -> None:
         mock_validation_args.return_value.version = '1.0.0.1000'
         mock_validation_args.return_value.validate_digest_only = False
-        mock_validation_args.return_value.force_https = False
+        mock_validation_args.return_value.allow_http = False
         mock_validation_args.return_value.projects = ["opensearch"]
         mock_cluster_readiness.return_value = False
         mock_container.return_value = (True, 'test_file.yml')
@@ -98,7 +98,7 @@ def test_staging_cluster_not_ready(self, mock_container: Mock, mock_validation_a
     def test_container_startup_exception(self, mock_container: Mock, mock_validation_args: Mock) -> None:
         mock_validation_args.return_value.version = '1.0.0.1000'
         mock_validation_args.return_value.validate_digest_only = False
-        mock_validation_args.return_value.force_https = False
+        mock_validation_args.return_value.allow_http = False
         mock_validation_args.return_value.projects = ["opensearch"]
         mock_container.return_value = (False, 'test_file.yml')
 

tests/tests_validation_workflow/test_validation_rpm.py

@@ -84,15 +84,16 @@ def test_exceptions(self, mock_validation_args: Mock) -> None:
             mock_validation_args.return_value.projects = ["opensearch", "opensearch-dashboards"]
             validate_rpm = ValidateRpm(mock_validation_args.return_value)
             validate_rpm.cleanup()
-        self.assertIn("Exception occurred either while attempting to stop cluster or removing OpenSearch/OpenSearch-Dashboards.", str(e3.exception))  # noqa: E501
+        self.assertIn("Exception occurred either while attempting to stop cluster or removing OpenSearch/OpenSearch-Dashboards.",
+                      str(e3.exception))
 
     @patch('validation_workflow.rpm.validation_rpm.ValidationArgs')
     @patch("validation_workflow.rpm.validation_rpm.execute")
     def test_installation(self, mock_system: Mock, mock_validation_args: Mock) -> None:
         mock_validation_args.return_value.version = '2.3.0'
         mock_validation_args.return_value.arch = 'x64'
         mock_validation_args.return_value.platform = 'linux'
-        mock_validation_args.return_value.force_https = True
+        mock_validation_args.return_value.allow_http = True
         mock_validation_args.return_value.projects = ["opensearch"]
 
         validate_rpm = ValidateRpm(mock_validation_args.return_value)
@@ -132,11 +133,9 @@ def test_validation(self, mock_check_cluster: Mock, mock_test_apis: Mock, mock_v
     @patch('validation_workflow.rpm.validation_rpm.execute')
     @patch('validation_workflow.validation.Validation.check_for_security_plugin')
     @patch('validation_workflow.validation.Validation.check_cluster_readiness')
-    def test_validation_without_force_https_check(self, mock_check_cluster: Mock, mock_security: Mock,
-                                                  mock_system: Mock, mock_basename: Mock, mock_test_apis: Mock,
-                                                  mock_validation_args: Mock) -> None:
+    def test_validation_with_allow_http_check(self, mock_check_cluster: Mock, mock_security: Mock, mock_system: Mock, mock_basename: Mock, mock_test_apis: Mock, mock_validation_args: Mock) -> None:
         mock_validation_args.return_value.version = '2.3.0'
-        mock_validation_args.return_value.force_https = False
+        mock_validation_args.return_value.allow_http = True
         validate_rpm = ValidateRpm(mock_validation_args.return_value)
         mock_check_cluster.return_value = True
         mock_basename.side_effect = lambda path: "mocked_filename"