X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FN2VC.git;a=blobdiff_plain;f=n2vc%2Ftests%2Funit%2Ftest_k8s_helm3_conn.py;fp=n2vc%2Ftests%2Funit%2Ftest_k8s_helm3_conn.py;h=e5af88161d91f705c2c8269ed6413e411a01647f;hp=0000000000000000000000000000000000000000;hb=1c83f2e4d061ad37ba898e114cb42e70fdee5145;hpb=e308c71201537413caf28f8814051470f0418504 diff --git a/n2vc/tests/unit/test_k8s_helm3_conn.py b/n2vc/tests/unit/test_k8s_helm3_conn.py new file mode 100644 index 0000000..e5af881 --- /dev/null +++ b/n2vc/tests/unit/test_k8s_helm3_conn.py @@ -0,0 +1,506 @@ +## +# 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. +# +# For those usages not covered by the Apache License, Version 2.0 please +# contact: alfonso.tiernosepulveda@telefonica.com +## + +import asynctest +import logging + +from asynctest.mock import Mock +from osm_common.dbmemory import DbMemory +from osm_common.fslocal import FsLocal +from n2vc.k8s_helm3_conn import K8sHelm3Connector + +__author__ = "Isabel Lloret " + + +class TestK8sHelm3Conn(asynctest.TestCase): + logging.basicConfig(level=logging.DEBUG) + logger = logging.getLogger(__name__) + logger.setLevel(logging.DEBUG) + + async def setUp(self): + self.db = Mock(DbMemory()) + self.fs = asynctest.Mock(FsLocal()) + self.fs.path = "./tmp/" + self.namespace = "testk8s" + self.cluster_id = "helm3_cluster_id" + self.cluster_uuid = "{}:{}".format(self.namespace, self.cluster_id) + # pass fake kubectl and helm commands to make sure it does not call actual commands + K8sHelm3Connector._check_file_exists = asynctest.Mock(return_value=True) + cluster_dir = self.fs.path + self.cluster_id + self.env = { + "HELM_CACHE_HOME": "{}/.cache/helm".format(cluster_dir), + "HELM_CONFIG_HOME": "{}/.config/helm".format(cluster_dir), + "HELM_DATA_HOME": "{}/.local/share/helm".format(cluster_dir), + "KUBECONFIG": "{}/.kube/config".format(cluster_dir) + } + self.helm_conn = K8sHelm3Connector(self.fs, self.db, + log=self.logger) + self.logger.debug("Set up executed") + + @asynctest.fail_on(active_handles=True) + async def test_init_env(self): + k8s_creds = "false_credentials_string" + self.helm_conn._get_namespaces = asynctest.CoroutineMock(return_value=[]) + self.helm_conn._create_namespace = asynctest.CoroutineMock() + self.helm_conn.repo_list = asynctest.CoroutineMock(return_value=[]) + self.helm_conn.repo_add = asynctest.CoroutineMock() + + k8scluster_uuid, installed = await self.helm_conn.init_env( + k8s_creds, namespace=self.namespace, reuse_cluster_uuid=self.cluster_id) + + self.assertEqual(k8scluster_uuid, "{}:{}".format(self.namespace, self.cluster_id), + "Check cluster_uuid format: .") + self.helm_conn._get_namespaces.assert_called_once_with(self.cluster_id) + self.helm_conn._create_namespace.assert_called_once_with(self.cluster_id, self.namespace) + self.helm_conn.repo_list.assert_called_once_with(k8scluster_uuid) + self.helm_conn.repo_add.assert_called_once_with( + k8scluster_uuid, "stable", "https://kubernetes-charts.storage.googleapis.com/") + self.helm_conn.fs.reverse_sync.assert_called_once_with(from_path=self.cluster_id) + self.logger.debug(f"cluster_uuid: {k8scluster_uuid}") + + @asynctest.fail_on(active_handles=True) + async def test_repo_add(self): + repo_name = "bitnami" + repo_url = "https://charts.bitnami.com/bitnami" + self.helm_conn._local_async_exec = asynctest.CoroutineMock(return_value=("", 0)) + + await self.helm_conn.repo_add(self.cluster_uuid, repo_name, repo_url) + + self.helm_conn.fs.sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn.fs.reverse_sync.assert_called_once_with(from_path=self.cluster_id) + self.assertEqual(self.helm_conn._local_async_exec.call_count, 2, + "local_async_exec expected 2 calls, called {}".format( + self.helm_conn._local_async_exec.call_count)) + + repo_update_command = "/usr/bin/helm3 repo update" + repo_add_command = "/usr/bin/helm3 repo add {} {}".format(repo_name, repo_url) + calls = self.helm_conn._local_async_exec.call_args_list + call0_kargs = calls[0][1] + self.assertEqual(call0_kargs.get("command"), repo_update_command, + "Invalid repo update command: {}".format(call0_kargs.get("command"))) + self.assertEqual(call0_kargs.get("env"), self.env, + "Invalid env for update command: {}".format(call0_kargs.get("env"))) + call1_kargs = calls[1][1] + self.assertEqual(call1_kargs.get("command"), repo_add_command, + "Invalid repo add command: {}".format(call1_kargs.get("command"))) + self.assertEqual(call1_kargs.get("env"), self.env, + "Invalid env for add command: {}".format(call1_kargs.get("env"))) + + @asynctest.fail_on(active_handles=True) + async def test_repo_list(self): + + self.helm_conn._local_async_exec = asynctest.CoroutineMock(return_value=("", 0)) + + await self.helm_conn.repo_list(self.cluster_uuid) + + self.helm_conn.fs.sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn.fs.reverse_sync.assert_called_once_with(from_path=self.cluster_id) + command = "/usr/bin/helm3 repo list --output yaml" + self.helm_conn._local_async_exec.assert_called_with(command=command, env=self.env, + raise_exception_on_error=False) + + @asynctest.fail_on(active_handles=True) + async def test_repo_remove(self): + + self.helm_conn._local_async_exec = asynctest.CoroutineMock(return_value=("", 0)) + repo_name = "bitnami" + await self.helm_conn.repo_remove(self.cluster_uuid, repo_name) + + self.helm_conn.fs.sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn.fs.reverse_sync.assert_called_once_with(from_path=self.cluster_id) + command = "/usr/bin/helm3 repo remove {}".format(repo_name) + self.helm_conn._local_async_exec.assert_called_with(command=command, env=self.env, + raise_exception_on_error=True) + + @asynctest.fail_on(active_handles=True) + async def test_install(self): + kdu_model = "stable/openldap:1.2.2" + kdu_instance = "stable-openldap-0005399828" + db_dict = {} + self.helm_conn._local_async_exec = asynctest.CoroutineMock(return_value=("", 0)) + self.helm_conn._status_kdu = asynctest.CoroutineMock(return_value=None) + self.helm_conn._store_status = asynctest.CoroutineMock() + self.helm_conn._generate_release_name = Mock(return_value="stable-openldap-0005399828") + + kdu_instance = await self.helm_conn.install(self.cluster_uuid, + kdu_model, + atomic=True, + namespace=self.namespace, + db_dict=db_dict) + + self.helm_conn.fs.sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn.fs.reverse_sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn._generate_release_name.assert_called_once_with("stable/openldap") + self.helm_conn._status_kdu.assert_called_once_with(cluster_id=self.cluster_id, + kdu_instance=kdu_instance, + namespace=self.namespace, + show_error_log=False) + self.helm_conn._store_status.assert_called_with(cluster_id=self.cluster_id, + kdu_instance=kdu_instance, + namespace=self.namespace, + db_dict=db_dict, + operation="install", + run_once=True, + check_every=0) + command = "/usr/bin/helm3 install stable-openldap-0005399828 --atomic --output yaml " \ + "--timeout 300s --namespace testk8s stable/openldap --version 1.2.2" + self.helm_conn._local_async_exec.assert_called_once_with(command=command, + env=self.env, + raise_exception_on_error=False) + + @asynctest.fail_on(active_handles=True) + async def test_upgrade(self): + kdu_model = "stable/openldap:1.2.3" + kdu_instance = "stable-openldap-0005399828" + db_dict = {} + instance_info = { + "chart": "openldap-1.2.2", + "name": kdu_instance, + "namespace": self.namespace, + "revision": 1, + "status": "DEPLOYED" + } + self.helm_conn._local_async_exec = asynctest.CoroutineMock(return_value=("", 0)) + self.helm_conn._store_status = asynctest.CoroutineMock() + self.helm_conn.get_instance_info = asynctest.CoroutineMock(return_value=instance_info) + + await self.helm_conn.upgrade(self.cluster_uuid, + kdu_instance, + kdu_model, + atomic=True, + db_dict=db_dict) + self.helm_conn.fs.sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn.fs.reverse_sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn._store_status.assert_called_with(cluster_id=self.cluster_id, + kdu_instance=kdu_instance, + namespace=self.namespace, + db_dict=db_dict, + operation="upgrade", + run_once=True, + check_every=0) + command = "/usr/bin/helm3 upgrade stable-openldap-0005399828 stable/openldap " \ + "--namespace testk8s --atomic --output yaml --timeout 300s " \ + "--version 1.2.3" + self.helm_conn._local_async_exec.assert_called_once_with(command=command, + env=self.env, + raise_exception_on_error=False) + + @asynctest.fail_on(active_handles=True) + async def test_rollback(self): + kdu_instance = "stable-openldap-0005399828" + db_dict = {} + instance_info = { + "chart": "openldap-1.2.3", + "name": kdu_instance, + "namespace": self.namespace, + "revision": 2, + "status": "DEPLOYED" + } + self.helm_conn._local_async_exec = asynctest.CoroutineMock(return_value=("", 0)) + self.helm_conn._store_status = asynctest.CoroutineMock() + self.helm_conn.get_instance_info = asynctest.CoroutineMock(return_value=instance_info) + + await self.helm_conn.rollback(self.cluster_uuid, + kdu_instance=kdu_instance, + revision=1, + db_dict=db_dict) + self.helm_conn.fs.sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn.fs.reverse_sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn._store_status.assert_called_with(cluster_id=self.cluster_id, + kdu_instance=kdu_instance, + namespace=self.namespace, + db_dict=db_dict, + operation="rollback", + run_once=True, + check_every=0) + command = "/usr/bin/helm3 rollback stable-openldap-0005399828 1 --namespace=testk8s --wait" + self.helm_conn._local_async_exec.assert_called_once_with(command=command, + env=self.env, + raise_exception_on_error=False) + + @asynctest.fail_on(active_handles=True) + async def test_uninstall(self): + kdu_instance = "stable-openldap-0005399828" + instance_info = { + "chart": "openldap-1.2.2", + "name": kdu_instance, + "namespace": self.namespace, + "revision": 3, + "status": "DEPLOYED" + } + self.helm_conn._local_async_exec = asynctest.CoroutineMock(return_value=("", 0)) + self.helm_conn._store_status = asynctest.CoroutineMock() + self.helm_conn.get_instance_info = asynctest.CoroutineMock(return_value=instance_info) + + await self.helm_conn.uninstall(self.cluster_uuid, kdu_instance) + self.helm_conn.fs.sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn.fs.reverse_sync.assert_called_once_with(from_path=self.cluster_id) + command = "/usr/bin/helm3 uninstall {} --namespace={}".format( + kdu_instance, self.namespace) + self.helm_conn._local_async_exec.assert_called_once_with(command=command, + env=self.env, + raise_exception_on_error=True) + + @asynctest.fail_on(active_handles=True) + async def test_get_services(self): + kdu_instance = "test_services_1" + service = { + "name": "testservice", + "type": "LoadBalancer" + } + self.helm_conn._local_async_exec_pipe = asynctest.CoroutineMock(return_value=("", 0)) + self.helm_conn._parse_services = Mock(return_value=["testservice"]) + self.helm_conn._get_service = asynctest.CoroutineMock(return_value=service) + + services = await self.helm_conn.get_services(self.cluster_uuid, kdu_instance, + self.namespace) + self.helm_conn.fs.sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn.fs.reverse_sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn._parse_services.assert_called_once() + command1 = "/usr/bin/helm3 get manifest {} --namespace=testk8s".format(kdu_instance) + command2 = "/usr/bin/kubectl get --namespace={} -f -".format(self.namespace) + self.helm_conn._local_async_exec_pipe.assert_called_once_with(command1, command2, + env=self.env, + raise_exception_on_error=True) + self.assertEqual(services, [service], "Invalid service returned from get_service") + + @asynctest.fail_on(active_handles=True) + async def test_get_service(self): + service_name = "service1" + + self.helm_conn._local_async_exec = asynctest.CoroutineMock(return_value=("", 0)) + await self.helm_conn.get_service(self.cluster_uuid, service_name, self.namespace) + + self.helm_conn.fs.sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn.fs.reverse_sync.assert_called_once_with(from_path=self.cluster_id) + command = "/usr/bin/kubectl --kubeconfig=./tmp/helm3_cluster_id/.kube/config " \ + "--namespace=testk8s get service service1 -o=yaml" + self.helm_conn._local_async_exec.assert_called_once_with(command=command, + env=self.env, + raise_exception_on_error=True) + + @asynctest.fail_on(active_handles=True) + async def test_inspect_kdu(self): + self.helm_conn._local_async_exec = asynctest.CoroutineMock(return_value=("", 0)) + + kdu_model = "stable/openldap:1.2.4" + repo_url = "https://kubernetes-charts.storage.googleapis.com/" + await self.helm_conn.inspect_kdu(kdu_model, repo_url) + + command = "/usr/bin/helm3 show all openldap --repo " \ + "https://kubernetes-charts.storage.googleapis.com/ " \ + "--version 1.2.4" + self.helm_conn._local_async_exec.assert_called_with(command=command, encode_utf8=True) + + @asynctest.fail_on(active_handles=True) + async def test_help_kdu(self): + self.helm_conn._local_async_exec = asynctest.CoroutineMock(return_value=("", 0)) + + kdu_model = "stable/openldap:1.2.4" + repo_url = "https://kubernetes-charts.storage.googleapis.com/" + await self.helm_conn.help_kdu(kdu_model, repo_url) + + command = "/usr/bin/helm3 show readme openldap --repo " \ + "https://kubernetes-charts.storage.googleapis.com/ " \ + "--version 1.2.4" + self.helm_conn._local_async_exec.assert_called_with(command=command, encode_utf8=True) + + @asynctest.fail_on(active_handles=True) + async def test_values_kdu(self): + self.helm_conn._local_async_exec = asynctest.CoroutineMock(return_value=("", 0)) + + kdu_model = "stable/openldap:1.2.4" + repo_url = "https://kubernetes-charts.storage.googleapis.com/" + await self.helm_conn.values_kdu(kdu_model, repo_url) + + command = "/usr/bin/helm3 show values openldap --repo " \ + "https://kubernetes-charts.storage.googleapis.com/ " \ + "--version 1.2.4" + self.helm_conn._local_async_exec.assert_called_with(command=command, encode_utf8=True) + + @asynctest.fail_on(active_handles=True) + async def test_instances_list(self): + self.helm_conn._local_async_exec = asynctest.CoroutineMock(return_value=("", 0)) + + await self.helm_conn.instances_list(self.cluster_uuid) + self.helm_conn.fs.sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn.fs.reverse_sync.assert_called_once_with(from_path=self.cluster_id) + command = "/usr/bin/helm3 list --all-namespaces --output yaml" + self.helm_conn._local_async_exec.assert_called_once_with(command=command, + env=self.env, + raise_exception_on_error=True) + + @asynctest.fail_on(active_handles=True) + async def test_status_kdu(self): + kdu_instance = "stable-openldap-0005399828" + self.helm_conn._local_async_exec = asynctest.CoroutineMock(return_value=("", 0)) + + await self.helm_conn._status_kdu(self.cluster_id, kdu_instance, + self.namespace, return_text=True) + command = "/usr/bin/helm3 status {} --namespace={} --output yaml".format( + kdu_instance, self.namespace + ) + self.helm_conn._local_async_exec.assert_called_once_with(command=command, + env=self.env, + raise_exception_on_error=True, + show_error_log=False) + + @asynctest.fail_on(active_handles=True) + async def test_store_status(self): + kdu_instance = "stable-openldap-0005399828" + db_dict = {} + status = { + "info": { + "description": "Install complete", + "status": { + "code": "1", + "notes": "The openldap helm chart has been installed" + } + } + } + self.helm_conn._status_kdu = asynctest.CoroutineMock(return_value=status) + self.helm_conn.write_app_status_to_db = asynctest.CoroutineMock(return_value=status) + + await self.helm_conn._store_status(cluster_id=self.cluster_id, + kdu_instance=kdu_instance, + namespace=self.namespace, + db_dict=db_dict, + operation="install", + run_once=True, + check_every=0) + self.helm_conn._status_kdu.assert_called_once_with(cluster_id=self.cluster_id, + kdu_instance=kdu_instance, + namespace=self.namespace, + return_text=False) + self.helm_conn.write_app_status_to_db.assert_called_once_with(db_dict=db_dict, + status="Install complete", + detailed_status=str(status), + operation="install") + + @asynctest.fail_on(active_handles=True) + async def test_reset_uninstall_false(self): + self.helm_conn._uninstall_sw = asynctest.CoroutineMock() + + await self.helm_conn.reset(self.cluster_uuid, force=False, uninstall_sw=False) + self.helm_conn.fs.sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn.fs.file_delete.assert_called_once_with(self.cluster_id, + ignore_non_exist=True) + self.helm_conn._uninstall_sw.assert_not_called() + + @asynctest.fail_on(active_handles=True) + async def test_reset_uninstall(self): + kdu_instance = 'stable-openldap-0021099429' + instances = [ + { + 'app_version': '2.4.48', + 'chart': 'openldap-1.2.3', + 'name': kdu_instance, + 'namespace': self.namespace, + 'revision': '1', + 'status': 'deployed', + 'updated': '2020-10-30 11:11:20.376744191 +0000 UTC' + } + ] + self.helm_conn._uninstall_sw = asynctest.CoroutineMock() + self.helm_conn.instances_list = asynctest.CoroutineMock(return_value=instances) + self.helm_conn.uninstall = asynctest.CoroutineMock() + + await self.helm_conn.reset(self.cluster_uuid, force=True, uninstall_sw=True) + self.helm_conn.fs.sync.assert_called_once_with(from_path=self.cluster_id) + self.helm_conn.fs.file_delete.assert_called_once_with(self.cluster_id, + ignore_non_exist=True) + self.helm_conn.instances_list.assert_called_once_with(cluster_uuid=self.cluster_uuid) + self.helm_conn.uninstall.assert_called_once_with(cluster_uuid=self.cluster_uuid, + kdu_instance=kdu_instance) + self.helm_conn._uninstall_sw.assert_called_once_with(self.cluster_id, self.namespace) + + @asynctest.fail_on(active_handles=True) + async def test_sync_repos_add(self): + repo_list = [ + { + "name": "stable", + "url": "https://kubernetes-charts.storage.googleapis.com/" + } + ] + self.helm_conn.repo_list = asynctest.CoroutineMock(return_value=repo_list) + + def get_one_result(*args, **kwargs): + if args[0] == "k8sclusters": + return { + "_admin": { + "helm_chart_repos" : [ + "4b5550a9-990d-4d95-8a48-1f4614d6ac9c" + ] + } + } + elif args[0] == "k8srepos": + return { + "_id": "4b5550a9-990d-4d95-8a48-1f4614d6ac9c", + "type": "helm-chart", + "name": "bitnami", + "url": "https://charts.bitnami.com/bitnami" + } + self.helm_conn.db.get_one = asynctest.Mock() + self.helm_conn.db.get_one.side_effect = get_one_result + + self.helm_conn.repo_add = asynctest.CoroutineMock() + self.helm_conn.repo_remove = asynctest.CoroutineMock() + + deleted_repo_list, added_repo_dict = await self.helm_conn.synchronize_repos( + self.cluster_uuid) + self.helm_conn.repo_remove.assert_not_called() + self.helm_conn.repo_add.assert_called_once_with(self.cluster_uuid, "bitnami", + "https://charts.bitnami.com/bitnami") + self.assertEqual(deleted_repo_list, [], "Deleted repo list should be empty") + self.assertEqual(added_repo_dict, + {"4b5550a9-990d-4d95-8a48-1f4614d6ac9c": "bitnami"}, + "Repos added should include only one bitnami") + + @asynctest.fail_on(active_handles=True) + async def test_sync_repos_delete(self): + repo_list = [ + { + "name": "stable", + "url": "https://kubernetes-charts.storage.googleapis.com/" + }, + { + "name": "bitnami", + "url": "https://charts.bitnami.com/bitnami" + } + ] + self.helm_conn.repo_list = asynctest.CoroutineMock(return_value=repo_list) + + def get_one_result(*args, **kwargs): + if args[0] == "k8sclusters": + return { + "_admin": { + "helm_chart_repos": [] + } + } + + self.helm_conn.db.get_one = asynctest.Mock() + self.helm_conn.db.get_one.side_effect = get_one_result + + self.helm_conn.repo_add = asynctest.CoroutineMock() + self.helm_conn.repo_remove = asynctest.CoroutineMock() + + deleted_repo_list, added_repo_dict = await self.helm_conn.synchronize_repos( + self.cluster_uuid) + self.helm_conn.repo_add.assert_not_called() + self.helm_conn.repo_remove.assert_called_once_with(self.cluster_uuid, "bitnami") + self.assertEqual(deleted_repo_list, ["bitnami"], "Deleted repo list should be bitnami") + self.assertEqual(added_repo_dict, {}, "No repos should be added")