2 # Licensed under the Apache License, Version 2.0 (the "License"); you may
3 # not use this file except in compliance with the License. You may obtain
4 # a copy of the License at
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
10 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
11 # License for the specific language governing permissions and limitations
14 # For those usages not covered by the Apache License, Version 2.0 please
15 # contact: alfonso.tiernosepulveda@telefonica.com
21 from asynctest
.mock
import Mock
22 from osm_common
.dbmemory
import DbMemory
23 from osm_common
.fslocal
import FsLocal
24 from n2vc
.k8s_helm_conn
import K8sHelmConnector
26 __author__
= "Isabel Lloret <illoret@indra.es>"
29 class TestK8sHelmConn(asynctest
.TestCase
):
30 logging
.basicConfig(level
=logging
.DEBUG
)
31 logger
= logging
.getLogger(__name__
)
32 logger
.setLevel(logging
.DEBUG
)
34 async def setUp(self
):
35 self
.db
= Mock(DbMemory())
36 self
.fs
= asynctest
.Mock(FsLocal())
37 self
.fs
.path
= "./tmp/"
38 self
.namespace
= "testk8s"
39 self
.service_account
= "osm"
40 self
.cluster_id
= "helm_cluster_id"
41 self
.cluster_uuid
= self
.cluster_id
42 # pass fake kubectl and helm commands to make sure it does not call actual commands
43 K8sHelmConnector
._check
_file
_exists
= asynctest
.Mock(return_value
=True)
44 K8sHelmConnector
._local
_async
_exec
= asynctest
.CoroutineMock(
47 cluster_dir
= self
.fs
.path
+ self
.cluster_id
48 self
.kube_config
= self
.fs
.path
+ self
.cluster_id
+ "/.kube/config"
49 self
.helm_home
= self
.fs
.path
+ self
.cluster_id
+ "/.helm"
51 "HELM_HOME": "{}/.helm".format(cluster_dir
),
52 "KUBECONFIG": "{}/.kube/config".format(cluster_dir
),
54 self
.helm_conn
= K8sHelmConnector(self
.fs
, self
.db
, log
=self
.logger
)
55 self
.logger
.debug("Set up executed")
57 @asynctest.fail_on(active_handles
=True)
58 async def test_init_env(self
):
62 @asynctest.fail_on(active_handles
=True)
63 async def test_repo_add(self
):
65 repo_url
= "https://charts.bitnami.com/bitnami"
66 self
.helm_conn
._local
_async
_exec
= asynctest
.CoroutineMock(return_value
=("", 0))
68 await self
.helm_conn
.repo_add(self
.cluster_uuid
, repo_name
, repo_url
)
70 self
.helm_conn
.fs
.sync
.assert_called_once_with(from_path
=self
.cluster_id
)
71 self
.helm_conn
.fs
.reverse_sync
.assert_called_once_with(
72 from_path
=self
.cluster_id
75 self
.helm_conn
._local
_async
_exec
.call_count
,
77 "local_async_exec expected 2 calls, called {}".format(
78 self
.helm_conn
._local
_async
_exec
.call_count
82 repo_update_command
= (
83 "env KUBECONFIG=./tmp/helm_cluster_id/.kube/config /usr/bin/helm repo update {}"
86 "env KUBECONFIG=./tmp/helm_cluster_id/.kube/config /usr/bin/helm repo add {} {}"
87 ).format(repo_name
, repo_url
)
88 calls
= self
.helm_conn
._local
_async
_exec
.call_args_list
89 call0_kargs
= calls
[0][1]
91 call0_kargs
.get("command"),
93 "Invalid repo add command: {}".format(call0_kargs
.get("command")),
96 call0_kargs
.get("env"),
98 "Invalid env for add command: {}".format(call0_kargs
.get("env")),
100 call1_kargs
= calls
[1][1]
102 call1_kargs
.get("command"),
104 "Invalid repo update command: {}".format(call1_kargs
.get("command")),
107 call1_kargs
.get("env"),
109 "Invalid env for update command: {}".format(call1_kargs
.get("env")),
112 @asynctest.fail_on(active_handles
=True)
113 async def test_repo_list(self
):
114 self
.helm_conn
._local
_async
_exec
= asynctest
.CoroutineMock(return_value
=("", 0))
116 await self
.helm_conn
.repo_list(self
.cluster_uuid
)
118 self
.helm_conn
.fs
.sync
.assert_called_once_with(from_path
=self
.cluster_id
)
119 self
.helm_conn
.fs
.reverse_sync
.assert_called_once_with(
120 from_path
=self
.cluster_id
122 command
= "env KUBECONFIG=./tmp/helm_cluster_id/.kube/config /usr/bin/helm repo list --output yaml"
123 self
.helm_conn
._local
_async
_exec
.assert_called_with(
124 command
=command
, env
=self
.env
, raise_exception_on_error
=False
127 @asynctest.fail_on(active_handles
=True)
128 async def test_repo_remove(self
):
129 self
.helm_conn
._local
_async
_exec
= asynctest
.CoroutineMock(return_value
=("", 0))
130 repo_name
= "bitnami"
131 await self
.helm_conn
.repo_remove(self
.cluster_uuid
, repo_name
)
133 self
.helm_conn
.fs
.sync
.assert_called_once_with(from_path
=self
.cluster_id
)
134 self
.helm_conn
.fs
.reverse_sync
.assert_called_once_with(
135 from_path
=self
.cluster_id
137 command
= "env KUBECONFIG=./tmp/helm_cluster_id/.kube/config /usr/bin/helm repo remove {}".format(
140 self
.helm_conn
._local
_async
_exec
.assert_called_once_with(
141 command
=command
, env
=self
.env
, raise_exception_on_error
=True
144 @asynctest.fail_on(active_handles
=True)
145 async def test_install(self
):
146 kdu_model
= "stable/openldap:1.2.2"
147 kdu_instance
= "stable-openldap-0005399828"
149 self
.helm_conn
._local
_async
_exec
= asynctest
.CoroutineMock(return_value
=("", 0))
150 self
.helm_conn
._status
_kdu
= asynctest
.CoroutineMock(return_value
=None)
151 self
.helm_conn
._store
_status
= asynctest
.CoroutineMock()
152 self
.helm_conn
.generate_kdu_instance_name
= Mock(return_value
=kdu_instance
)
154 await self
.helm_conn
.install(
159 namespace
=self
.namespace
,
163 self
.helm_conn
.fs
.sync
.assert_called_once_with(from_path
=self
.cluster_id
)
164 self
.helm_conn
.fs
.reverse_sync
.assert_called_once_with(
165 from_path
=self
.cluster_id
167 self
.helm_conn
._store
_status
.assert_called_with(
168 cluster_id
=self
.cluster_id
,
169 kdu_instance
=kdu_instance
,
170 namespace
=self
.namespace
,
175 "env KUBECONFIG=./tmp/helm_cluster_id/.kube/config /usr/bin/helm install "
176 "--atomic --output yaml --timeout 300 "
177 "--name=stable-openldap-0005399828 --namespace testk8s stable/openldap "
180 self
.helm_conn
._local
_async
_exec
.assert_called_once_with(
181 command
=command
, env
=self
.env
, raise_exception_on_error
=False
184 @asynctest.fail_on(active_handles
=True)
185 async def test_upgrade(self
):
186 kdu_model
= "stable/openldap:1.2.3"
187 kdu_instance
= "stable-openldap-0005399828"
190 "chart": "openldap-1.2.2",
191 "name": kdu_instance
,
192 "namespace": self
.namespace
,
194 "status": "DEPLOYED",
196 self
.helm_conn
._local
_async
_exec
= asynctest
.CoroutineMock(return_value
=("", 0))
197 self
.helm_conn
._store
_status
= asynctest
.CoroutineMock()
198 self
.helm_conn
.get_instance_info
= asynctest
.CoroutineMock(
199 return_value
=instance_info
202 await self
.helm_conn
.upgrade(
203 self
.cluster_uuid
, kdu_instance
, kdu_model
, atomic
=True, db_dict
=db_dict
205 self
.helm_conn
.fs
.sync
.assert_called_with(from_path
=self
.cluster_id
)
206 self
.helm_conn
.fs
.reverse_sync
.assert_called_once_with(
207 from_path
=self
.cluster_id
209 self
.helm_conn
._store
_status
.assert_called_with(
210 cluster_id
=self
.cluster_id
,
211 kdu_instance
=kdu_instance
,
212 namespace
=self
.namespace
,
217 "env KUBECONFIG=./tmp/helm_cluster_id/.kube/config /usr/bin/helm upgrade "
218 "--atomic --output yaml --timeout 300 stable-openldap-0005399828 stable/openldap --version 1.2.3"
220 self
.helm_conn
._local
_async
_exec
.assert_called_once_with(
221 command
=command
, env
=self
.env
, raise_exception_on_error
=False
224 @asynctest.fail_on(active_handles
=True)
225 async def test_rollback(self
):
226 kdu_instance
= "stable-openldap-0005399828"
229 "chart": "openldap-1.2.3",
230 "name": kdu_instance
,
231 "namespace": self
.namespace
,
233 "status": "DEPLOYED",
235 self
.helm_conn
._local
_async
_exec
= asynctest
.CoroutineMock(return_value
=("", 0))
236 self
.helm_conn
._store
_status
= asynctest
.CoroutineMock()
237 self
.helm_conn
.get_instance_info
= asynctest
.CoroutineMock(
238 return_value
=instance_info
241 await self
.helm_conn
.rollback(
242 self
.cluster_uuid
, kdu_instance
=kdu_instance
, revision
=1, db_dict
=db_dict
244 self
.helm_conn
.fs
.sync
.assert_called_with(from_path
=self
.cluster_id
)
245 self
.helm_conn
.fs
.reverse_sync
.assert_called_once_with(
246 from_path
=self
.cluster_id
248 self
.helm_conn
._store
_status
.assert_called_with(
249 cluster_id
=self
.cluster_id
,
250 kdu_instance
=kdu_instance
,
251 namespace
=self
.namespace
,
253 operation
="rollback",
256 "env KUBECONFIG=./tmp/helm_cluster_id/.kube/config "
257 "/usr/bin/helm rollback stable-openldap-0005399828 1 --wait"
259 self
.helm_conn
._local
_async
_exec
.assert_called_once_with(
260 command
=command
, env
=self
.env
, raise_exception_on_error
=False
263 @asynctest.fail_on(active_handles
=True)
264 async def test_uninstall(self
):
265 kdu_instance
= "stable-openldap-0005399828"
267 "chart": "openldap-1.2.2",
268 "name": kdu_instance
,
269 "namespace": self
.namespace
,
271 "status": "DEPLOYED",
273 self
.helm_conn
._local
_async
_exec
= asynctest
.CoroutineMock(return_value
=("", 0))
274 self
.helm_conn
._store
_status
= asynctest
.CoroutineMock()
275 self
.helm_conn
.get_instance_info
= asynctest
.CoroutineMock(
276 return_value
=instance_info
279 await self
.helm_conn
.uninstall(self
.cluster_uuid
, kdu_instance
)
280 self
.helm_conn
.fs
.sync
.assert_called_with(from_path
=self
.cluster_id
)
281 self
.helm_conn
.fs
.reverse_sync
.assert_called_once_with(
282 from_path
=self
.cluster_id
284 command
= "env KUBECONFIG=./tmp/helm_cluster_id/.kube/config /usr/bin/helm delete --purge {}".format(
287 self
.helm_conn
._local
_async
_exec
.assert_called_once_with(
288 command
=command
, env
=self
.env
, raise_exception_on_error
=True
291 @asynctest.fail_on(active_handles
=True)
292 async def test_get_services(self
):
293 kdu_instance
= "test_services_1"
294 service
= {"name": "testservice", "type": "LoadBalancer"}
295 self
.helm_conn
._local
_async
_exec
_pipe
= asynctest
.CoroutineMock(
298 self
.helm_conn
._parse
_services
= Mock(return_value
=["testservice"])
299 self
.helm_conn
._get
_service
= asynctest
.CoroutineMock(return_value
=service
)
301 services
= await self
.helm_conn
.get_services(
302 self
.cluster_uuid
, kdu_instance
, self
.namespace
304 self
.helm_conn
.fs
.sync
.assert_called_once_with(from_path
=self
.cluster_id
)
305 self
.helm_conn
.fs
.reverse_sync
.assert_called_once_with(
306 from_path
=self
.cluster_id
308 self
.helm_conn
._parse
_services
.assert_called_once()
309 command1
= "env KUBECONFIG=./tmp/helm_cluster_id/.kube/config /usr/bin/helm get manifest {} ".format(
312 command2
= "/usr/bin/kubectl get --namespace={} -f -".format(self
.namespace
)
313 self
.helm_conn
._local
_async
_exec
_pipe
.assert_called_once_with(
314 command1
, command2
, env
=self
.env
, raise_exception_on_error
=True
317 services
, [service
], "Invalid service returned from get_service"
320 @asynctest.fail_on(active_handles
=True)
321 async def test_get_service(self
):
322 service_name
= "service1"
324 self
.helm_conn
._local
_async
_exec
= asynctest
.CoroutineMock(return_value
=("", 0))
325 await self
.helm_conn
.get_service(
326 self
.cluster_uuid
, service_name
, self
.namespace
329 self
.helm_conn
.fs
.sync
.assert_called_once_with(from_path
=self
.cluster_id
)
330 self
.helm_conn
.fs
.reverse_sync
.assert_called_once_with(
331 from_path
=self
.cluster_id
334 "/usr/bin/kubectl --kubeconfig=./tmp/helm_cluster_id/.kube/config "
335 "--namespace=testk8s get service service1 -o=yaml"
337 self
.helm_conn
._local
_async
_exec
.assert_called_once_with(
338 command
=command
, env
=self
.env
, raise_exception_on_error
=True
341 @asynctest.fail_on(active_handles
=True)
342 async def test_inspect_kdu(self
):
343 self
.helm_conn
._local
_async
_exec
= asynctest
.CoroutineMock(return_value
=("", 0))
345 kdu_model
= "stable/openldap:1.2.4"
346 repo_url
= "https://kubernetes-charts.storage.googleapis.com/"
347 await self
.helm_conn
.inspect_kdu(kdu_model
, repo_url
)
350 "/usr/bin/helm inspect openldap --repo "
351 "https://kubernetes-charts.storage.googleapis.com/ "
354 self
.helm_conn
._local
_async
_exec
.assert_called_with(
355 command
=command
, encode_utf8
=True
358 @asynctest.fail_on(active_handles
=True)
359 async def test_help_kdu(self
):
360 self
.helm_conn
._local
_async
_exec
= asynctest
.CoroutineMock(return_value
=("", 0))
362 kdu_model
= "stable/openldap:1.2.4"
363 repo_url
= "https://kubernetes-charts.storage.googleapis.com/"
364 await self
.helm_conn
.help_kdu(kdu_model
, repo_url
)
367 "/usr/bin/helm inspect readme openldap --repo "
368 "https://kubernetes-charts.storage.googleapis.com/ "
371 self
.helm_conn
._local
_async
_exec
.assert_called_with(
372 command
=command
, encode_utf8
=True
375 @asynctest.fail_on(active_handles
=True)
376 async def test_values_kdu(self
):
377 self
.helm_conn
._local
_async
_exec
= asynctest
.CoroutineMock(return_value
=("", 0))
379 kdu_model
= "stable/openldap:1.2.4"
380 repo_url
= "https://kubernetes-charts.storage.googleapis.com/"
381 await self
.helm_conn
.values_kdu(kdu_model
, repo_url
)
384 "/usr/bin/helm inspect values openldap --repo "
385 "https://kubernetes-charts.storage.googleapis.com/ "
388 self
.helm_conn
._local
_async
_exec
.assert_called_with(
389 command
=command
, encode_utf8
=True
392 @asynctest.fail_on(active_handles
=True)
393 async def test_instances_list(self
):
394 self
.helm_conn
._local
_async
_exec
= asynctest
.CoroutineMock(return_value
=("", 0))
396 await self
.helm_conn
.instances_list(self
.cluster_uuid
)
397 self
.helm_conn
.fs
.sync
.assert_called_once_with(from_path
=self
.cluster_id
)
398 self
.helm_conn
.fs
.reverse_sync
.assert_called_once_with(
399 from_path
=self
.cluster_id
401 command
= "/usr/bin/helm list --output yaml"
402 self
.helm_conn
._local
_async
_exec
.assert_called_once_with(
403 command
=command
, env
=self
.env
, raise_exception_on_error
=True
406 @asynctest.fail_on(active_handles
=True)
407 async def test_status_kdu(self
):
408 kdu_instance
= "stable-openldap-0005399828"
409 self
.helm_conn
._local
_async
_exec
= asynctest
.CoroutineMock(return_value
=("", 0))
411 await self
.helm_conn
._status
_kdu
(
412 self
.cluster_id
, kdu_instance
, self
.namespace
, yaml_format
=True
415 "env KUBECONFIG=./tmp/helm_cluster_id/.kube/config /usr/bin/helm status {} --output yaml"
416 ).format(kdu_instance
)
417 self
.helm_conn
._local
_async
_exec
.assert_called_once_with(
420 raise_exception_on_error
=True,
421 show_error_log
=False,
424 @asynctest.fail_on(active_handles
=True)
425 async def test_store_status(self
):
426 kdu_instance
= "stable-openldap-0005399828"
430 "description": "Install complete",
433 "notes": "The openldap helm chart has been installed",
437 self
.helm_conn
._status
_kdu
= asynctest
.CoroutineMock(return_value
=status
)
438 self
.helm_conn
.write_app_status_to_db
= asynctest
.CoroutineMock(
442 await self
.helm_conn
._store
_status
(
443 cluster_id
=self
.cluster_id
,
444 kdu_instance
=kdu_instance
,
445 namespace
=self
.namespace
,
449 self
.helm_conn
._status
_kdu
.assert_called_once_with(
450 cluster_id
=self
.cluster_id
,
451 kdu_instance
=kdu_instance
,
452 namespace
=self
.namespace
,
455 self
.helm_conn
.write_app_status_to_db
.assert_called_once_with(
457 status
="Install complete",
458 detailed_status
=str(status
),
462 @asynctest.fail_on(active_handles
=True)
463 async def test_reset_uninstall_false(self
):
464 self
.helm_conn
._uninstall
_sw
= asynctest
.CoroutineMock()
466 await self
.helm_conn
.reset(self
.cluster_uuid
, force
=False, uninstall_sw
=False)
467 self
.helm_conn
.fs
.sync
.assert_called_once_with(from_path
=self
.cluster_id
)
468 self
.helm_conn
.fs
.file_delete
.assert_called_once_with(
469 self
.cluster_id
, ignore_non_exist
=True
471 self
.helm_conn
._uninstall
_sw
.assert_not_called()
473 @asynctest.fail_on(active_handles
=True)
474 async def test_reset_uninstall(self
):
475 kdu_instance
= "stable-openldap-0021099429"
478 "app_version": "2.4.48",
479 "chart": "openldap-1.2.3",
480 "name": kdu_instance
,
481 "namespace": self
.namespace
,
483 "status": "deployed",
484 "updated": "2020-10-30 11:11:20.376744191 +0000 UTC",
487 self
.helm_conn
._get
_namespace
= Mock(return_value
=self
.namespace
)
488 self
.helm_conn
._uninstall
_sw
= asynctest
.CoroutineMock()
489 self
.helm_conn
.instances_list
= asynctest
.CoroutineMock(return_value
=instances
)
490 self
.helm_conn
.uninstall
= asynctest
.CoroutineMock()
492 await self
.helm_conn
.reset(self
.cluster_uuid
, force
=True, uninstall_sw
=True)
493 self
.helm_conn
.fs
.sync
.assert_called_once_with(from_path
=self
.cluster_id
)
494 self
.helm_conn
.fs
.file_delete
.assert_called_once_with(
495 self
.cluster_id
, ignore_non_exist
=True
497 self
.helm_conn
._get
_namespace
.assert_called_once_with(
498 cluster_uuid
=self
.cluster_uuid
500 self
.helm_conn
.instances_list
.assert_called_once_with(
501 cluster_uuid
=self
.cluster_uuid
503 self
.helm_conn
.uninstall
.assert_called_once_with(
504 cluster_uuid
=self
.cluster_uuid
, kdu_instance
=kdu_instance
506 self
.helm_conn
._uninstall
_sw
.assert_called_once_with(
507 cluster_id
=self
.cluster_id
, namespace
=self
.namespace
510 @asynctest.fail_on(active_handles
=True)
511 async def test_uninstall_sw_namespace(self
):
512 self
.helm_conn
._local
_async
_exec
= asynctest
.CoroutineMock(return_value
=("", 0))
514 await self
.helm_conn
._uninstall
_sw
(self
.cluster_id
, self
.namespace
)
515 calls
= self
.helm_conn
._local
_async
_exec
.call_args_list
517 len(calls
), 3, "To uninstall should have executed three commands"
519 call0_kargs
= calls
[0][1]
520 command_0
= "/usr/bin/helm --kubeconfig={} --home={} reset".format(
521 self
.kube_config
, self
.helm_home
525 {"command": command_0
, "raise_exception_on_error": True, "env": self
.env
},
526 "Invalid args for first call to local_exec",
528 call1_kargs
= calls
[1][1]
530 "/usr/bin/kubectl --kubeconfig={} delete "
531 "clusterrolebinding.rbac.authorization.k8s.io/osm-tiller-cluster-rule".format(
537 {"command": command_1
, "raise_exception_on_error": False, "env": self
.env
},
538 "Invalid args for second call to local_exec",
540 call2_kargs
= calls
[2][1]
542 "/usr/bin/kubectl --kubeconfig={} --namespace {} delete "
543 "serviceaccount/{}".format(
544 self
.kube_config
, self
.namespace
, self
.service_account
549 {"command": command_2
, "raise_exception_on_error": False, "env": self
.env
},
550 "Invalid args for third call to local_exec",