Merge pull request #112 from abnamro/2332710-bug-fix-helm-deployment-command

2332710 bug fix in resc-helm-wizard

Author: amrityamrout

deployment/resc-helm-wizard/MANIFEST.in

@@ -1,4 +1,3 @@
 exclude README.md
 exclude MANIFEST.in
-include resources/*
-include images/*
+include config/*.yaml

deployment/resc-helm-wizard/README.md

@@ -1,4 +1,4 @@
-# Helm Values YAML Wizard
+# Repository Scanner Helm Wizard (resc-helm-wizard)
 
 <!-- TABLE OF CONTENTS -->
 ## Table of contents

deployment/resc-helm-wizard/setup.cfg

@@ -1,7 +1,7 @@
 [metadata]
 name = resc_helm_wizard
 description = Repository Scanner - Helm Wizard
-version = 1.0.2
+version = 1.0.3
 author = ABN AMRO
 author_email = resc@nl.abnamro.com
 url = https://github.com/ABNAMRO/repository-scanner
@@ -11,7 +11,7 @@ long_description_content_type = text/markdown
 
 [options]
 requires_python = >=3.9
-include_package_data = False
+include_package_data = True
 zip_safe = False
 package_dir = = src
 packages = find:
@@ -21,7 +21,7 @@ where = src
 
 [options.package_data]
 resc_helm_wizard =
-    static/*.ini
+    static/*.ini, config/*.yaml
 
 [options.entry_points]
 console_scripts =

deployment/resc-helm-wizard/src/resc_helm_wizard/common.py

@@ -7,6 +7,7 @@
 from urllib.parse import urlparse
 
 # Third Party
+import pkg_resources
 import requests
 import yaml
 
@@ -15,8 +16,9 @@
 from resc_helm_wizard.helm_utilities import (
     add_helm_repository,
     install_or_upgrade_helm_release,
-    is_chart_version_already_installed,
-    update_helm_repository
+    is_chart_already_installed,
+    update_helm_repository,
+    validate_helm_deployment_status
 )
 from resc_helm_wizard.helm_value import HelmValue
 from resc_helm_wizard.kubernetes_utilities import create_namespace_if_not_exists
@@ -160,8 +162,7 @@ def create_helm_values_yaml(helm_values: HelmValue, input_values_yaml_file: str)
                                 "blob/main/deployment/kubernetes/README.md"
 
     try:
-        with open(input_values_yaml_file, "r", encoding="utf-8") as file_in:
-            values_dict = yaml.safe_load(file_in)
+        values_dict = read_yaml_file(input_values_yaml_file)
 
         values_dict["resc-database"]["hostOS"] = helm_values.operating_system
         values_dict["resc-database"]["database"]["pvc_path"] = helm_values.db_storage_path
@@ -195,6 +196,19 @@ def create_helm_values_yaml(helm_values: HelmValue, input_values_yaml_file: str)
     return output_file_generated
 
 
+def read_yaml_file(file_path):
+    """
+        Read content of yaml file
+    :param file_path:
+        path of yaml file
+    :return: stream
+        Returns yaml content
+    """
+    with pkg_resources.resource_stream(__name__, file_path) as file_in:
+        data = yaml.safe_load(file_in)
+    return data
+
+
 def get_scheme_host_port_from_url(url: str):
     """
         Get scheme, host, port from url
@@ -322,17 +336,19 @@ def run_deployment():
     if namespace_created:
         # Check if release is already installed
         output = subprocess.run(["helm", "list", "-n", constants.NAMESPACE], capture_output=True, text=True, check=True)
-        # Check if same chart version is already installed
-        version_installed = is_chart_version_already_installed()
-        if constants.RELEASE_NAME in output.stdout and version_installed is True:
+        # Check if deployment is already running
+        chart_installed = is_chart_already_installed()
+        if constants.RELEASE_NAME in output.stdout and chart_installed:
             run_upgrade_confirm_msg = f"Release {constants.RELEASE_NAME} is already installed in " \
                                       f"{constants.NAMESPACE} namespace. Do you want to upgrade the release?"
             run_upgrade_confirm = questions.ask_user_confirmation(msg=run_upgrade_confirm_msg)
             if run_upgrade_confirm is True:
                 deployment_status = install_or_upgrade_helm_release(action="upgrade")
+                validate_helm_deployment_status()
             else:
                 logging.info("Skipping deployment...")
 
         else:
             deployment_status = install_or_upgrade_helm_release(action="install")
+            validate_helm_deployment_status()
     return deployment_status

deployment/resc-helm-wizard/resources/example-values.yaml deployment/resc-helm-wizard/src/resc_helm_wizard/config/example-values.yaml

@@ -31,31 +31,30 @@ def install_or_upgrade_helm_release(action: str) -> bool:
         return False
 
 
-def is_chart_version_already_installed() -> bool:
+def get_deployment_status_from_installed_chart() -> str:
     """
-        Checks if chart installed or not
-    :return: bool
-        Returns true if chart already installed else returns false
-    """
-    downloaded_version = get_version_from_downloaded_chart()
-    installed_version = get_version_from_installed_chart()
-    return downloaded_version == installed_version
-
-
-def get_version_from_installed_chart() -> str:
-    """
-        Get version of the installed chart
+        Get status of the installed chart
     :return: str
-        Returns version of the installed chart
+        Returns status of the installed chart
     """
     cmd = f"helm list -f {constants.CHART_NAME} -n {constants.NAMESPACE} -o json"
     output = subprocess.check_output(cmd, shell=True)
     chart_info = json.loads(output.decode("utf-8"))
-    if chart_info and "chart" in chart_info[0]:
-        return chart_info[0]["chart"].split("-")[1]
+    if chart_info and "status" in chart_info[0]:
+        return chart_info[0]["status"]
     return None
 
 
+def is_chart_already_installed() -> bool:
+    """
+        Checks if chart installed or not
+    :return: bool
+        Returns true if chart already installed else returns false
+    """
+    status = get_deployment_status_from_installed_chart()
+    return bool(status == "deployed")
+
+
 def get_version_from_downloaded_chart() -> str:
     """
         Get version of the downloaded chart
@@ -93,3 +92,18 @@ def update_helm_repository():
     except subprocess.CalledProcessError:
         logging.error("An error occurred while updating the helm repository")
         sys.exit(1)
+
+
+def validate_helm_deployment_status():
+    """
+        Validate the status of the helm deployment
+    """
+    try:
+        result = subprocess.run(['helm', 'status', constants.RELEASE_NAME, "-n", constants.NAMESPACE],
+                                capture_output=True, check=True, text=True)
+        output = result.stdout.strip()
+        if "STATUS: deployed" in output:
+            logging.info("The deployment was successful. Visit http://127.0.0.1:30000 to get started with RESC!")
+    except subprocess.CalledProcessError:
+        logging.error("An error occurred during deployment.")
+        sys.exit(1)

deployment/resc-helm-wizard/src/resc_helm_wizard/helm_utilities.py

@@ -37,7 +37,7 @@ def prompt_questions():
                 )
 
                 common.create_helm_values_yaml(helm_values=helm_values,
-                                               input_values_yaml_file="resources/example-values.yaml")
+                                               input_values_yaml_file="config/example-values.yaml")
                 common.run_deployment_as_per_user_confirmation()
     except KeyboardInterrupt:
         logging.error("Aborting the program! operation cancelled by user")

deployment/resc-helm-wizard/src/resc_helm_wizard/run_wizard.py

@@ -7,6 +7,7 @@
 
 # Third Party
 import pytest
+import yaml
 
 # First Party
 from resc_helm_wizard.common import (
@@ -251,9 +252,10 @@ def test_create_storage_for_db_and_rabbitmq_where_path_does_not_exist_and_dir_co
     assert excinfo.value.code == 1
 
 
+@patch("resc_helm_wizard.common.read_yaml_file")
 @patch("os.path.exists")
 def test_create_helm_values_yaml_success(
-        mock_file_path_exists):
+        mock_file_path_exists, mock_read_yaml_file):
     vcs_instance1 = VcsInstance(
         provider_type="GITHUB_PUBLIC",
         scheme="https",
@@ -272,8 +274,12 @@ def test_create_helm_values_yaml_success(
         rabbitmq_storage_path="/temp/rabbitmq",
         vcs_instances=vcs_instances
     )
+
     mock_file_path_exists.return_type = True
     input_file_path = os.path.join(THIS_DIR.parent, "tests", "fixtures", "test-values.yaml")
+    with open(input_file_path, "r", encoding="utf-8") as file_in:
+        values_dict = yaml.safe_load(file_in)
+    mock_read_yaml_file.return_value = values_dict
     generated_file_path = os.path.join(THIS_DIR.parent, "custom-values.yaml")
     output_file_generated = create_helm_values_yaml(helm_values=helm_values, input_values_yaml_file=input_file_path)
     assert output_file_generated is True
@@ -291,8 +297,9 @@ def test_create_helm_values_sys_exit_when_file_not_exists(mock_error_log):
     assert excinfo.value.code == 1
 
 
+@patch("resc_helm_wizard.common.read_yaml_file")
 @patch("logging.Logger.error")
-def test_create_helm_values_sys_exit_when_key_not_exists(mock_error_log):
+def test_create_helm_values_sys_exit_when_key_not_exists(mock_error_log, mock_read_yaml_file):
     helm_values = HelmValue(
         operating_system="linux",
         db_password="dummy_pass",
@@ -301,6 +308,9 @@ def test_create_helm_values_sys_exit_when_key_not_exists(mock_error_log):
         vcs_instances=[]
     )
     input_file_path = os.path.join(THIS_DIR.parent, "tests", "fixtures", "test-invalid-values.yaml")
+    with open(input_file_path, "r", encoding="utf-8") as file_in:
+        values_dict = yaml.safe_load(file_in)
+    mock_read_yaml_file.return_value = values_dict
     expected_error_log = f"Aborting the program! 'resc-database' was missing in {input_file_path}"
     with pytest.raises(SystemExit) as excinfo:
         create_helm_values_yaml(helm_values=helm_values, input_values_yaml_file=input_file_path)

deployment/resc-helm-wizard/tests/test_common.py

@@ -8,11 +8,12 @@
 from resc_helm_wizard import constants
 from resc_helm_wizard.helm_utilities import (
     add_helm_repository,
+    get_deployment_status_from_installed_chart,
     get_version_from_downloaded_chart,
-    get_version_from_installed_chart,
     install_or_upgrade_helm_release,
-    is_chart_version_already_installed,
-    update_helm_repository
+    is_chart_already_installed,
+    update_helm_repository,
+    validate_helm_deployment_status
 )
 
 sys.path.insert(0, "src")
@@ -40,45 +41,37 @@ def test_install_or_upgrade_helm_release_failure(mock_error_log):
         mock_error_log.assert_called_with(expected_error_log)
 
 
-@patch("resc_helm_wizard.helm_utilities.get_version_from_downloaded_chart")
-@patch("resc_helm_wizard.helm_utilities.get_version_from_installed_chart")
-def test_is_chart_version_already_installed_is_true(get_version_from_installed_chart,
-                                                    get_version_from_downloaded_chart):
-    get_version_from_installed_chart.return_value = "1.0.0"
-    get_version_from_downloaded_chart.return_value = "1.0.0"
-    already_installed = is_chart_version_already_installed()
-    get_version_from_installed_chart.assert_called_once_with()
-    get_version_from_downloaded_chart.assert_called_once_with()
+@patch("resc_helm_wizard.helm_utilities.get_deployment_status_from_installed_chart")
+def test_is_chart_already_installed_is_true(get_deployment_status_from_installed_chart):
+    get_deployment_status_from_installed_chart.return_value = "deployed"
+    already_installed = is_chart_already_installed()
+    get_deployment_status_from_installed_chart.assert_called_once_with()
     assert already_installed is True
 
 
-@patch("resc_helm_wizard.helm_utilities.get_version_from_downloaded_chart")
-@patch("resc_helm_wizard.helm_utilities.get_version_from_installed_chart")
-def test_is_chart_version_already_installed_is_false(get_version_from_installed_chart,
-                                                     get_version_from_downloaded_chart):
-    get_version_from_installed_chart.return_value = "1.0.0"
-    get_version_from_downloaded_chart.return_value = "1.0.1"
-    already_installed = is_chart_version_already_installed()
-    get_version_from_installed_chart.assert_called_once_with()
-    get_version_from_downloaded_chart.assert_called_once_with()
+@patch("resc_helm_wizard.helm_utilities.get_deployment_status_from_installed_chart")
+def test_is_chart_already_installed_is_false(get_deployment_status_from_installed_chart):
+    get_deployment_status_from_installed_chart.return_value = None
+    already_installed = is_chart_already_installed()
+    get_deployment_status_from_installed_chart.assert_called_once_with()
     assert already_installed is False
 
 
 @patch("subprocess.check_output")
-def test_get_version_from_installed_chart_success(mock_check_output):
+def test_get_deployment_status_from_installed_chart_success(mock_check_output):
     expected_output = b'[{"name":"resc","namespace":"resc","revision":"1",' \
                       b'"updated":"2023-03-30 10:16:56.211749 +0200 CEST","status":"deployed",' \
                       b'"chart":"resc-1.1.0","app_version":"1.1.0"}]\n'
     mock_check_output.return_value = expected_output
-    actual_output = get_version_from_installed_chart()
-    assert actual_output == "1.1.0"
+    actual_output = get_deployment_status_from_installed_chart()
+    assert actual_output == "deployed"
 
 
 @patch("subprocess.check_output")
-def test_get_version_from_installed_chart_failure(mock_check_output):
+def test_get_deployment_status_from_installed_chart_failure(mock_check_output):
     expected_output = b'{}'
     mock_check_output.return_value = expected_output
-    actual_output = get_version_from_installed_chart()
+    actual_output = get_deployment_status_from_installed_chart()
     assert actual_output is None
 
 
@@ -141,3 +134,30 @@ def test_update_helm_repository_failure(mock_error_log):
         mock_error_log.assert_called_with(expected_error_log)
         mock_check_output.assert_called_once_with(cmd, check=True)
         mock_sys_exit.assert_called_once_with(1)
+
+
+@patch("subprocess.run")
+@patch("logging.Logger.info")
+def test_validate_helm_deployment_status_success(mock_info_log, mock_check_output):
+    cmd = ['helm', 'status', constants.RELEASE_NAME, "-n", constants.NAMESPACE]
+    expected_output = "RELEASE STATUS: deployed"
+    expected_info_log = "The deployment was successful. Visit http://127.0.0.1:30000 to get started with RESC!"
+    mock_check_output.return_value.stdout = expected_output
+    validate_helm_deployment_status()
+    assert mock_check_output.called
+    mock_check_output.assert_called_once_with(cmd, capture_output=True, check=True, text=True)
+    mock_info_log.assert_called_with(expected_info_log)
+
+
+@patch("logging.Logger.error")
+def test_validate_helm_deployment_status_failure(mock_error_log):
+    cmd = ['helm', 'status', constants.RELEASE_NAME, "-n", constants.NAMESPACE]
+    expected_error_log = "An error occurred during deployment."
+    with mock.patch("subprocess.run") as mock_check_output, \
+            mock.patch("sys.exit") as mock_sys_exit:
+        mock_check_output.side_effect = subprocess.CalledProcessError(returncode=1, cmd=cmd)
+        validate_helm_deployment_status()
+        assert mock_check_output.called
+        mock_error_log.assert_called_with(expected_error_log)
+        mock_check_output.assert_called_once_with(cmd, capture_output=True, check=True, text=True)
+        mock_sys_exit.assert_called_once_with(1)