aboutsummaryrefslogtreecommitdiffstats
path: root/src/onaptests/steps/cloud/check_status.py
blob: 5a4b9626f65d5495f6bc75f50cbb9b0549cd7750 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# SPDX-License-Identifier: Apache-2.0
import json
import logging
import os
import re
from pathlib import Path

from jinja2 import Environment, PackageLoader, select_autoescape
from kubernetes import client, config
from kubernetes.stream import stream
from natural.date import delta
from onapsdk.configuration import settings
from urllib3.exceptions import MaxRetryError, NewConnectionError
from xtesting.core import testcase

from onaptests.utils.exceptions import StatusCheckException

from ..base import BaseStep
from .resources import (ConfigMap, Container, DaemonSet, Deployment, Ingress,
                        Job, Pod, Pvc, ReplicaSet, Secret, Service,
                        StatefulSet, Node)


class CheckK8sResourcesStep(BaseStep):
    """Base step for check of k8s resources in the selected namespace."""

    __logger = logging.getLogger(__name__)

    def __init__(self, namespace: str, resource_type: str, break_on_error=False):
        """Init CheckK8sResourcesStep."""
        super().__init__(cleanup=BaseStep.HAS_NO_CLEANUP, break_on_error=break_on_error)
        self.core = client.CoreV1Api()
        self.batch = client.BatchV1Api()
        self.app = client.AppsV1Api()
        self.networking = client.NetworkingV1Api()
        self.namespace = namespace

        if settings.STATUS_RESULTS_DIRECTORY:
            self.res_dir = f"{settings.STATUS_RESULTS_DIRECTORY}"
        else:
            self.res_dir = f"{testcase.TestCase.dir_results}/kubernetes-status"

        if not self.is_primary:
            self.res_dir = f"{self.res_dir}/{self.namespace}"

        self.failing = False
        self.resource_type = resource_type
        self.k8s_resources = []
        self.all_resources = []
        self.failing_resources = []
        self.jinja_env = Environment(autoescape=select_autoescape(['html']),
                                     loader=PackageLoader('onaptests.templates', 'status'))

    @property
    def component(self) -> str:
        """Component name."""
        return "ALL"

    @property
    def description(self) -> str:
        """Step description."""
        return f"Check status of all k8s {self.resource_type}s in the {self.namespace} namespace."

    @property
    def is_primary(self) -> bool:
        """Does step analyses primary namespace."""
        return self.namespace == settings.K8S_TESTS_NAMESPACE

    def _init_resources(self):
        if self.resource_type != "":
            self.__logger.debug(f"Loading all k8s {self.resource_type}s"
                                " in the {NAMESPACE} namespace")

    def _parse_resources(self):
        """Parse the resources."""
        return []

    def _add_failing_resource(self, resource):
        if (hasattr(resource, 'labels') and resource.labels and settings.EXCLUDED_LABELS
                and (resource.labels.keys() and settings.EXCLUDED_LABELS.keys())):
            for label in resource.labels.items():
                for waived_label in settings.EXCLUDED_LABELS.items():
                    if label[0] in waived_label[0] and label[1] in waived_label[1]:
                        return
        self.__logger.warning("a {} is in error: {}".format(self.resource_type, resource.name))
        self.failing_resources.append(resource)
        self.failing = True

    def execute(self):
        super().execute()
        os.makedirs(self.res_dir, exist_ok=True)
        try:
            self._init_resources()
            if len(self.k8s_resources) > 0:
                self.__logger.info("%4s %ss in the namespace",
                                   len(self.k8s_resources),
                                   self.resource_type)
                self._parse_resources()
                self.__logger.info("%4s %ss parsed, %s failing",
                                   len(self.all_resources),
                                   self.resource_type,
                                   len(self.failing_resources))
                if self.failing:
                    raise StatusCheckException(f"{self.resource_type} test failed")
        except (ConnectionRefusedError, MaxRetryError, NewConnectionError) as e:
            self.__logger.error("Test of k8s %ss failed.", self.resource_type)
            self.__logger.error("Cannot connect to Kubernetes.")
            raise StatusCheckException from e


class CheckBasicK8sResourcesStep(CheckK8sResourcesStep):
    """Basic check of k8s resources in the selected namespace."""

    def __init__(self, namespace: str, resource_type: str, k8s_res_class):
        """Init CheckBasicK8sResourcesStep."""
        super().__init__(namespace=namespace, resource_type=resource_type)
        self.k8s_res_class = k8s_res_class

    def _parse_resources(self):
        """Parse simple k8s resources."""
        super()._parse_resources()
        for k8s in self.k8s_resources:
            resource = self.k8s_res_class(k8s=k8s)
            self.all_resources.append(resource)

    @BaseStep.store_state
    def execute(self):
        super().execute()


class CheckK8sConfigMapsStep(CheckBasicK8sResourcesStep):
    """Check of k8s configmap in the selected namespace."""

    def __init__(self, namespace: str):
        """Init CheckK8sConfigMapsStep."""
        super().__init__(namespace=namespace, resource_type="configmap", k8s_res_class=ConfigMap)

    def _init_resources(self):
        super()._init_resources()
        self.k8s_resources = self.core.list_namespaced_config_map(self.namespace).items


class CheckK8sSecretsStep(CheckBasicK8sResourcesStep):
    """Check of k8s secrets in the selected namespace."""

    def __init__(self, namespace: str):
        """Init CheckK8sSecretsStep."""
        super().__init__(namespace=namespace, resource_type="secret", k8s_res_class=Secret)

    def _init_resources(self):
        super()._init_resources()
        self.k8s_resources = self.core.list_namespaced_secret(self.namespace).items


class CheckK8sIngressesStep(CheckBasicK8sResourcesStep):
    """Check of k8s ingress in the selected namespace."""

    def __init__(self, namespace: str):
        """Init CheckK8sIngressesStep."""
        super().__init__(namespace=namespace, resource_type="ingress", k8s_res_class=Ingress)

    def _init_resources(self):
        super()._init_resources()
        self.k8s_resources = self.networking.list_namespaced_ingress(self.namespace).items


class CheckK8sPvcsStep(CheckK8sResourcesStep):
    """Check of k8s pvcs in the selected namespace."""

    def __init__(self, namespace: str):
        """Init CheckK8sPvcsStep."""
        super().__init__(namespace=namespace, resource_type="pvc")

    def _init_resources(self):
        super()._init_resources()
        self.k8s_resources = self.core.list_namespaced_persistent_volume_claim(self.namespace).items

    def _parse_resources(self):
        """Parse the jobs.
        Return a list of Pods that were created to perform jobs.
        """
        super()._parse_resources()
        for k8s in self.k8s_resources:
            pvc = Pvc(k8s=k8s)
            field_selector = (f"involvedObject.name={pvc.name},"
                              "involvedObject.kind=PersistentVolumeClaim")
            pvc.events = self.core.list_namespaced_event(
                self.namespace,
                field_selector=field_selector).items

            if k8s.status.phase != "Bound":
                self._add_failing_resource(pvc)
            self.all_resources.append(pvc)

    @BaseStep.store_state
    def execute(self):
        super().execute()


class CheckK8sNodesStep(CheckK8sResourcesStep):
    """Check of k8s nodes in the selected namespace."""

    __logger = logging.getLogger(__name__)

    def __init__(self, namespace: str):
        """Init CheckK8sNodesStep."""
        super().__init__(namespace=namespace, resource_type="node")

    def _init_resources(self):
        super()._init_resources()
        self.k8s_resources = self.core.list_node().items

    def _parse_resources(self):
        """Parse the nodes.
        Return a list of Nodes.
        """
        super()._parse_resources()
        for k8s in self.k8s_resources:
            node = Node(k8s=k8s)
            for condition in k8s.status.conditions:
                failing = False
                if condition.status == 'False' and condition.type == 'Ready':
                    failing = True
                elif condition.status == 'True' and condition.type != 'Ready':
                    failing = True
                if failing:
                    self._add_failing_resource(node)
                    self.__logger.error(
                        f"Node {node.name} {condition.type} status is {condition.status}")
            self.all_resources.append(node)

    @BaseStep.store_state
    def execute(self):
        super().execute()


class CheckK8sResourcesUsingPodsStep(CheckK8sResourcesStep):
    """Check of k8s respurces with pods in the selected namespace."""

    def __init__(self, namespace: str, resource_type: str, pods_source):
        """Init CheckK8sResourcesUsingPodsStep."""
        super().__init__(namespace=namespace, resource_type=resource_type)
        self.pods_source = pods_source

    def _get_used_pods(self):
        pods = []
        if self.pods_source is not None:
            pods = self.pods_source.all_resources
        return pods

    def _find_child_pods(self, selector):
        pods_used = self._get_used_pods()
        pods_list = []
        failed_pods = 0
        if selector:
            raw_selector = ''
            for key, value in selector.items():
                raw_selector += key + '=' + value + ','
            raw_selector = raw_selector[:-1]
            pods = self.core.list_namespaced_pod(
                self.namespace, label_selector=raw_selector).items
            for pod in pods:
                for known_pod in pods_used:
                    if known_pod.name == pod.metadata.name:
                        pods_list.append(known_pod)
                        if not known_pod.ready():
                            failed_pods += 1
        return (pods_list, failed_pods)

    @BaseStep.store_state
    def execute(self):
        super().execute()


class CheckK8sJobsStep(CheckK8sResourcesUsingPodsStep):
    """Check of k8s jobs in the selected namespace."""

    __logger = logging.getLogger(__name__)

    def __init__(self, namespace: str):
        """Init CheckK8sJobsStep."""
        super().__init__(namespace=namespace, resource_type="job", pods_source=None)

    def _init_resources(self):
        super()._init_resources()
        self.k8s_resources = self.batch.list_namespaced_job(self.namespace).items

    def _parse_resources(self):
        """Parse the jobs.
        Return a list of Pods that were created to perform jobs.
        """
        super()._parse_resources()
        jobs_pods = []
        cron_jobs = {}
        for k8s in self.k8s_resources:
            job = Job(k8s=k8s)
            job_pods = []

            if k8s.spec.selector and k8s.spec.selector.match_labels:
                (job.pods, job.failed_pods) = self._find_child_pods(
                    k8s.spec.selector.match_labels)
                job_pods += job.pods
            field_selector = "involvedObject.name={}".format(job.name)
            field_selector += ",involvedObject.kind=Job"
            job.events = self.core.list_namespaced_event(
                self.namespace,
                field_selector=field_selector).items

            self.jinja_env.get_template('job.html.j2').stream(job=job).dump(
                '{}/job-{}.html'.format(self.res_dir, job.name))

            if not any(waiver_elt in job.name for waiver_elt in settings.WAIVER_LIST):
                cron_job = self._get_cron_job_name(k8s)
                if cron_job:
                    if cron_job not in cron_jobs:
                        cron_jobs[cron_job] = []
                    cron_jobs[cron_job].append(job)
                elif not k8s.status.completion_time:
                    # timemout job
                    self._add_failing_resource(job)
                self.all_resources.append(job)
            else:
                self.__logger.warning(
                    "Waiver pattern found in job, exclude %s", job.name)
            jobs_pods += job_pods
        for cron_job, jobs in cron_jobs.items():
            if len(jobs) > 1:
                jobs = sorted(jobs,
                              key=lambda job: job.k8s.metadata.creation_timestamp,
                              reverse=True)
            if not jobs[0].k8s.status.completion_time:
                self._add_failing_resource(jobs[0])

    def _get_cron_job_name(self, k8s):
        if k8s.metadata.owner_references:
            for owner in k8s.metadata.owner_references:
                if owner.kind == "CronJob":
                    return owner.name
        return None


class CheckK8sPodsStep(CheckK8sResourcesUsingPodsStep):
    """Check of k8s pods in the selected namespace."""

    __logger = logging.getLogger(__name__)

    def __init__(self, namespace: str, pods):
        """Init CheckK8sPodsStep."""
        super().__init__(namespace=namespace, resource_type="pod", pods_source=pods)

    def _init_resources(self):
        super()._init_resources()
        self.k8s_resources = self.core.list_namespaced_pod(self.namespace).items

    def _parse_resources(self):  # noqa
        """Parse the pods."""
        super()._parse_resources()
        excluded_pods = self._get_used_pods()
        pod_versions = []
        containers = {}
        for k8s in self.k8s_resources:
            pod = Pod(k8s=k8s)

            # check version firstly
            if settings.CHECK_POD_VERSIONS:
                pod_component = k8s.metadata.name
                pod_component_from_label = None
                if hasattr(k8s.metadata, "labels") and k8s.metadata.labels is not None:
                    if 'app' in k8s.metadata.labels:
                        pod_component_from_label = k8s.metadata.labels['app']
                    else:
                        if 'app.kubernetes.io/name' in k8s.metadata.labels:
                            pod_component_from_label = k8s.metadata.labels[
                                'app.kubernetes.io/name']
                if pod_component_from_label is None:
                    self.__logger.error("pod %s has no 'app' or 'app.kubernetes.io/name' "
                                        "in metadata: %s", pod_component, k8s.metadata.labels)
                else:
                    pod_component = pod_component_from_label

                # looks for docker version
                for container in k8s.spec.containers:
                    pod_version = {}
                    pod_container_version = container.image.rsplit(":", 1)
                    pod_container_image = pod_container_version[0]
                    pod_container_tag = "latest"
                    if len(pod_container_version) > 1:
                        pod_container_tag = pod_container_version[1]

                    pod_version.update({
                        'container': container.name,
                        'component': pod_component,
                        'image': pod_container_image,
                        'version': pod_container_tag
                    })
                    pod_versions.append(pod_version)

                    search_rule = "^(?P<source>[^/]*)/*(?P<container>[^:]*):*(?P<version>.*)$"
                    search = re.search(search_rule, container.image)
                    name = "{}/{}".format(search.group('source'),
                                          search.group('container'))
                    version = search.group('version')
                    if name[-1] == '/':
                        name = name[0:-1]
                    source = "default"
                    if search.group('source') in settings.DOCKER_REPOSITORIES:
                        source = search.group('source')
                        name = search.group('container')
                    container_search_rule = "^library/(?P<real_container>[^:]*)$"
                    container_search = re.search(container_search_rule, name)
                    if container_search:
                        name = container_search.group('real_container')
                    for common_component in settings.GENERIC_NAMES.keys():
                        if name in settings.GENERIC_NAMES[common_component]:
                            version = "{}:{}".format(name, version)
                            name = common_component
                            break

                    repository = settings.DOCKER_REPOSITORIES_NICKNAMES[source]
                    if name in containers:
                        if version in containers[name]['versions']:
                            if not (pod_component in containers[name]['versions']
                                    [version]['components']):
                                containers[name]['versions'][version][
                                    'components'].append(pod_component)
                                containers[name]['number_components'] += 1
                            if not (repository in containers[name]['versions']
                                    [version]['repositories']):
                                containers[name]['versions'][version][
                                    'repositories'].append(repository)
                        else:
                            containers[name]['versions'][version] = {
                                'repositories': [repository],
                                'components': [pod_component]
                            }
                            containers[name]['number_components'] += 1
                    else:
                        containers[name] = {
                            'versions': {
                                version: {
                                    'repositories': [repository],
                                    'components': [pod_component]
                                }
                            },
                            'number_components': 1
                        }
            # pod version check end
            if excluded_pods and pod in excluded_pods:
                continue

            if k8s.status.init_container_statuses:
                for k8s_container in k8s.status.init_container_statuses:
                    pod.runned_init_containers += self._parse_container(
                        pod, k8s_container, init=True)
            if k8s.status.container_statuses:
                for k8s_container in k8s.status.container_statuses:
                    pod.running_containers += self._parse_container(
                        pod, k8s_container)
            pod.events = self.core.list_namespaced_event(
                self.namespace,
                field_selector="involvedObject.name={}".format(pod.name)).items
            self.jinja_env.get_template('pod.html.j2').stream(pod=pod).dump(
                '{}/pod-{}.html'.format(self.res_dir, pod.name))
            if any(waiver_elt in pod.name for waiver_elt in settings.WAIVER_LIST):
                self.__logger.warning("Waiver pattern found in pod, exclude %s", pod.name)
            else:
                self.all_resources.append(pod)

        if settings.CHECK_POD_VERSIONS:
            self.jinja_env.get_template('version.html.j2').stream(
                pod_versions=pod_versions).dump('{}/versions.html'.format(
                    self.res_dir))
            self.jinja_env.get_template('container_versions.html.j2').stream(
                containers=containers).dump('{}/container_versions.html'.format(
                    self.res_dir))
            # create a json file for version tracking
            with open(self.res_dir + "/onap_versions.json", "w", encoding="utf-8") as write_file:
                json.dump(pod_versions, write_file)

    def _get_container_logs(self, pod, container, full=True, previous=False):
        logs = ""
        limit_bytes = settings.MAX_LOG_BYTES
        if full:
            limit_bytes = settings.UNLIMITED_LOG_BYTES
        try:
            logs = self.core.read_namespaced_pod_log(
                pod.name,
                self.namespace,
                container=container.name,
                limit_bytes=limit_bytes,
                previous=previous
            )
        except UnicodeDecodeError:
            logs = "{0} has an unicode decode error...".format(pod.name)
            self.__logger.error(logs)
        return logs

    def _parse_container(self, pod, k8s_container, init=False):  # noqa
        """Get the logs of a container."""
        logs = ""
        old_logs = ""
        prefix = ""
        containers_list = pod.containers
        container = Container(name=k8s_container.name)
        container.restart_count = k8s_container.restart_count
        container.set_status(k8s_container.state)
        container.ready = k8s_container.ready
        container.image = k8s_container.image
        if init:
            prefix = "init "
            containers_list = pod.init_containers
            pod.init_restart_count = max(pod.init_restart_count, container.restart_count)
            if not container.ready:
                pod.init_done = False
        else:
            pod.restart_count = max(pod.restart_count, container.restart_count)
        if settings.STORE_ARTIFACTS:
            try:
                log_files = {}
                logs = self._get_container_logs(pod=pod, container=container, full=False)
                with open(
                        "{}/pod-{}-{}.log".format(self.res_dir,
                                                  pod.name, container.name),
                        'w', encoding="utf-8") as log_result:
                    log_result.write(logs)
                if (not container.ready) and container.restart_count > 0:
                    old_logs = self._get_container_logs(pod=pod, container=container,
                                                        previous=True)
                    with open(
                            "{}/pod-{}-{}.old.log".format(self.res_dir,
                                                          pod.name,
                                                          container.name),
                            'w', encoding="utf-8") as log_result:
                        log_result.write(old_logs)
                if container.name in settings.FULL_LOGS_CONTAINERS:
                    logs = self._get_container_logs(pod=pod, container=container)
                    with open(
                            "{}/pod-{}-{}.log".format(self.res_dir,
                                                      pod.name, container.name),
                            'w', encoding="utf-8") as log_result:
                        log_result.write(logs)
                if container.name in settings.SPECIFIC_LOGS_CONTAINERS:
                    for log_file in settings.SPECIFIC_LOGS_CONTAINERS[container.name]:
                        exec_command = ['/bin/sh', '-c', "cat {}".format(log_file)]
                        log_files[log_file] = stream(
                            self.core.connect_get_namespaced_pod_exec,
                            pod.name,
                            self.namespace,
                            container=container.name,
                            command=exec_command,
                            stderr=True,
                            stdin=False,
                            stdout=True,
                            tty=False)
                        log_file_slug = log_file.split('.')[0].split('/')[-1]
                        with open(
                                "{}/pod-{}-{}-{}.log".format(
                                    self.res_dir, pod.name,
                                    container.name, log_file_slug),
                                'w', encoding="utf-8") as log_result:
                            log_result.write(log_files[log_file])
            except client.rest.ApiException as exc:
                self.__logger.warning("%scontainer %s of pod %s has an exception: %s",
                                      prefix, container.name, pod.name, exc.reason)
            self.jinja_env.get_template('container_log.html.j2').stream(
                container=container,
                pod_name=pod.name,
                logs=logs,
                old_logs=old_logs,
                log_files=log_files).dump('{}/pod-{}-{}-logs.html'.format(
                    self.res_dir, pod.name, container.name))
        if any(waiver_elt in container.name for waiver_elt in settings.WAIVER_LIST):
            self.__logger.warning(
                "Waiver pattern found in container, exclude %s", container.name)
        else:
            containers_list.append(container)
            if k8s_container.ready:
                return 1
        return 0


class CheckK8sServicesStep(CheckK8sResourcesUsingPodsStep):
    """Check of k8s services in the selected namespace."""

    def __init__(self, namespace: str, pods):
        """Init CheckK8sServicesStep."""
        super().__init__(namespace=namespace, resource_type="service", pods_source=pods)

    def _init_resources(self):
        super()._init_resources()
        self.k8s_resources = self.core.list_namespaced_service(self.namespace).items

    def _parse_resources(self):
        """Parse the services."""
        super()._parse_resources()
        for k8s in self.k8s_resources:
            service = Service(k8s=k8s)

            (service.pods,
             service.failed_pods) = self._find_child_pods(k8s.spec.selector)

            self.jinja_env.get_template('service.html.j2').stream(
                service=service).dump('{}/service-{}.html'.format(
                    self.res_dir, service.name))
            self.all_resources.append(service)


class CheckK8sDeploymentsStep(CheckK8sResourcesUsingPodsStep):
    """Check of k8s deployments in the selected namespace."""

    def __init__(self, namespace: str, pods):
        """Init CheckK8sDeploymentsStep."""
        super().__init__(namespace=namespace, resource_type="deployment", pods_source=pods)

    def _init_resources(self):
        super()._init_resources()
        self.k8s_resources = self.app.list_namespaced_deployment(self.namespace).items

    def _parse_resources(self):
        """Parse the deployments."""
        super()._parse_resources()
        for k8s in self.k8s_resources:
            deployment = Deployment(k8s=k8s)

            if settings.IGNORE_EMPTY_REPLICAS and k8s.spec.replicas == 0:
                continue
            if k8s.spec.selector and k8s.spec.selector.match_labels:
                (deployment.pods,
                 deployment.failed_pods) = self._find_child_pods(
                     k8s.spec.selector.match_labels)
            field_selector = "involvedObject.name={}".format(deployment.name)
            field_selector += ",involvedObject.kind=Deployment"
            deployment.events = self.core.list_namespaced_event(
                self.namespace,
                field_selector=field_selector).items

            self.jinja_env.get_template('deployment.html.j2').stream(
                deployment=deployment).dump('{}/deployment-{}.html'.format(
                    self.res_dir, deployment.name))

            if k8s.status.unavailable_replicas:
                self._add_failing_resource(deployment)

            self.all_resources.append(deployment)


class CheckK8sReplicaSetsStep(CheckK8sResourcesUsingPodsStep):
    """Check of k8s replicasets in the selected namespace."""

    def __init__(self, namespace: str, pods):
        """Init CheckK8sReplicaSetsStep."""
        super().__init__(namespace=namespace, resource_type="replicaset", pods_source=pods)

    def _init_resources(self):
        super()._init_resources()
        self.k8s_resources = self.app.list_namespaced_replica_set(self.namespace).items

    def _parse_resources(self):
        """Parse the replicasets."""
        super()._parse_resources()
        for k8s in self.k8s_resources:
            replicaset = ReplicaSet(k8s=k8s)

            if settings.IGNORE_EMPTY_REPLICAS and k8s.spec.replicas == 0:
                continue

            if k8s.spec.selector and k8s.spec.selector.match_labels:
                (replicaset.pods,
                 replicaset.failed_pods) = self._find_child_pods(
                     k8s.spec.selector.match_labels)
            field_selector = "involvedObject.name={}".format(replicaset.name)
            field_selector += ",involvedObject.kind=ReplicaSet"
            replicaset.events = self.core.list_namespaced_event(
                self.namespace,
                field_selector=field_selector).items

            self.jinja_env.get_template('replicaset.html.j2').stream(
                replicaset=replicaset).dump('{}/replicaset-{}.html'.format(
                    self.res_dir, replicaset.name))

            if (not k8s.status.ready_replicas or
                    (k8s.status.ready_replicas < k8s.status.replicas)):
                self._add_failing_resource(replicaset)

            self.all_resources.append(replicaset)


class CheckK8sStatefulSetsStep(CheckK8sResourcesUsingPodsStep):
    """Check of k8s statefulsets in the selected namespace."""

    def __init__(self, namespace: str, pods):
        """Init CheckK8sStatefulSetsStep."""
        super().__init__(namespace=namespace, resource_type="statefulset", pods_source=pods)

    def _init_resources(self):
        super()._init_resources()
        self.k8s_resources = self.app.list_namespaced_stateful_set(self.namespace).items

    def _parse_resources(self):
        """Parse the statefulsets."""
        super()._parse_resources()
        for k8s in self.k8s_resources:
            statefulset = StatefulSet(k8s=k8s)

            if settings.IGNORE_EMPTY_REPLICAS and k8s.spec.replicas == 0:
                continue

            if k8s.spec.selector and k8s.spec.selector.match_labels:
                (statefulset.pods,
                 statefulset.failed_pods) = self._find_child_pods(
                     k8s.spec.selector.match_labels)
            field_selector = "involvedObject.name={}".format(statefulset.name)
            field_selector += ",involvedObject.kind=StatefulSet"
            statefulset.events = self.core.list_namespaced_event(
                self.namespace,
                field_selector=field_selector).items

            self.jinja_env.get_template('statefulset.html.j2').stream(
                statefulset=statefulset).dump('{}/statefulset-{}.html'.format(
                    self.res_dir, statefulset.name))

            if ((not k8s.status.ready_replicas)
                    or (k8s.status.ready_replicas < k8s.status.replicas)):
                self._add_failing_resource(statefulset)

            self.all_resources.append(statefulset)


class CheckK8sDaemonSetsStep(CheckK8sResourcesUsingPodsStep):
    """Check of k8s daemonsets in the selected namespace."""

    def __init__(self, namespace: str, pods):
        """Init CheckK8sDaemonSetsStep."""
        super().__init__(namespace=namespace, resource_type="daemonset", pods_source=pods)

    def _init_resources(self):
        super()._init_resources()
        self.k8s_resources = self.app.list_namespaced_daemon_set(self.namespace).items

    def _parse_resources(self):
        """Parse the daemonsets."""
        super()._parse_resources()
        for k8s in self.k8s_resources:
            daemonset = DaemonSet(k8s=k8s)

            if k8s.spec.selector and k8s.spec.selector.match_labels:
                (daemonset.pods,
                 daemonset.failed_pods) = self._find_child_pods(
                     k8s.spec.selector.match_labels)
            field_selector = "involvedObject.name={}".format(daemonset.name)
            field_selector += ",involvedObject.kind=DaemonSet"
            daemonset.events = self.core.list_namespaced_event(
                self.namespace,
                field_selector=field_selector).items

            self.jinja_env.get_template('daemonset.html.j2').stream(
                daemonset=daemonset).dump('{}/daemonset-{}.html'.format(
                    self.res_dir, daemonset.name))

            if k8s.status.number_ready < k8s.status.desired_number_scheduled:
                self._add_failing_resource(daemonset)

            self.all_resources.append(daemonset)


class CheckNamespaceStatusStep(CheckK8sResourcesStep):
    """Check status of all k8s resources in the selected namespace."""

    __logger = logging.getLogger(__name__)

    def __init__(self):
        """Init CheckNamespaceStatusStep."""
        super().__init__(namespace=settings.K8S_TESTS_NAMESPACE, resource_type="")
        self.__logger.debug("K8s namespaces status test init started")

        self.job_list_step = None
        self.pod_list_step = None
        self.service_list_step = None
        self.deployment_list_step = None
        self.replicaset_list_step = None
        self.statefulset_list_step = None
        self.daemonset_list_step = None
        self.configmap_list_step = None
        self.secret_list_step = None
        self.ingress_list_step = None
        self.pvc_list_step = None
        self.node_list_step = None
        if not settings.IF_VALIDATION:
            if settings.IN_CLUSTER:
                config.load_incluster_config()
            else:
                config.load_kube_config(config_file=settings.K8S_CONFIG)
        if settings.CHECK_ALL_NAMESPACES or settings.EXCLUDE_NAMESPACE_LIST:
            self.namespaces_to_check_set = {namespace.metadata.name for namespace in
                                            client.CoreV1Api().list_namespace().items} - set(
                                                settings.EXCLUDE_NAMESPACE_LIST)
        else:
            self.namespaces_to_check_set = set([self.namespace] + settings.EXTRA_NAMESPACE_LIST)
        for namespace in self.namespaces_to_check_set:
            self._init_namespace_steps(namespace)
        self.pods = []
        self.services = []
        self.jobs = []
        self.deployments = []
        self.replicasets = []
        self.statefulsets = []
        self.daemonsets = []
        self.pvcs = []
        self.configmaps = []
        self.secrets = []
        self.ingresses = []
        self.nodes = []
        self.failing_statefulsets = []
        self.failing_jobs = []
        self.failing_deployments = []
        self.failing_replicasets = []
        self.failing_daemonsets = []
        self.failing_pvcs = []
        self.failing_nodes = []

    def _init_namespace_steps(self, namespace: str):
        job_list_step = CheckK8sJobsStep(namespace)
        pod_list_step = CheckK8sPodsStep(namespace, job_list_step)
        service_list_step = CheckK8sServicesStep(namespace, pod_list_step)
        deployment_list_step = CheckK8sDeploymentsStep(namespace, pod_list_step)
        replicaset_list_step = CheckK8sReplicaSetsStep(namespace, pod_list_step)
        statefulset_list_step = CheckK8sStatefulSetsStep(namespace, pod_list_step)
        daemonset_list_step = CheckK8sDaemonSetsStep(namespace, pod_list_step)
        configmap_list_step = CheckK8sConfigMapsStep(namespace)
        secret_list_step = CheckK8sSecretsStep(namespace)
        ingress_list_step = CheckK8sIngressesStep(namespace)
        pvc_list_step = CheckK8sPvcsStep(namespace)
        node_list_step = CheckK8sNodesStep(namespace)
        if namespace == settings.K8S_TESTS_NAMESPACE:
            self.job_list_step = job_list_step
            self.pod_list_step = pod_list_step
            self.service_list_step = service_list_step
            self.deployment_list_step = deployment_list_step
            self.replicaset_list_step = replicaset_list_step
            self.statefulset_list_step = statefulset_list_step
            self.daemonset_list_step = daemonset_list_step
            self.configmap_list_step = configmap_list_step
            self.secret_list_step = secret_list_step
            self.ingress_list_step = ingress_list_step
            self.pvc_list_step = pvc_list_step
            self.node_list_step = node_list_step
            self.add_step(node_list_step)
        self.add_step(job_list_step)
        self.add_step(pod_list_step)
        self.add_step(service_list_step)
        self.add_step(deployment_list_step)
        self.add_step(replicaset_list_step)
        self.add_step(statefulset_list_step)
        self.add_step(daemonset_list_step)
        self.add_step(configmap_list_step)
        self.add_step(secret_list_step)
        self.add_step(ingress_list_step)
        self.add_step(pvc_list_step)

    @property
    def description(self) -> str:
        """Step description."""
        return "Check status of all k8s resources in the selected namespaces."

    @property
    def component(self) -> str:
        """Component name."""
        return "ALL"

    @BaseStep.store_state
    def execute(self):
        """Check status of all k8s resources in the selected namespaces.

        Use settings values:
         - K8S_TESTS_NAMESPACE
         - STATUS_RESULTS_DIRECTORY
         - STORE_ARTIFACTS
         - CHECK_POD_VERSIONS
         - IGNORE_EMPTY_REPLICAS
         - INCLUDE_ALL_RES_IN_DETAILS
        """
        super().execute()

        self.pods = self.pod_list_step.all_resources
        self.services = self.service_list_step.all_resources
        self.jobs = self.job_list_step.all_resources
        self.deployments = self.deployment_list_step.all_resources
        self.replicasets = self.replicaset_list_step.all_resources
        self.statefulsets = self.statefulset_list_step.all_resources
        self.daemonsets = self.daemonset_list_step.all_resources
        self.pvcs = self.pvc_list_step.all_resources
        self.configmaps = self.configmap_list_step.all_resources
        self.secrets = self.secret_list_step.all_resources
        self.ingresses = self.ingress_list_step.all_resources

        self.failing_statefulsets = self.statefulset_list_step.failing_resources
        self.failing_jobs = self.job_list_step.failing_resources
        self.failing_deployments = self.deployment_list_step.failing_resources
        self.failing_replicasets = self.replicaset_list_step.failing_resources
        self.failing_daemonsets = self.daemonset_list_step.failing_resources
        self.failing_pvcs = self.pvc_list_step.failing_resources

        self.jinja_env.get_template('index.html.j2').stream(
            ns=self,
            delta=delta).dump('{}/index.html'.format(self.res_dir))
        self.jinja_env.get_template('raw_output.txt.j2').stream(
            ns=self, namespace=self.namespace).dump('{}/onap-k8s.log'.format(
                self.res_dir))

        details = {"namespace": {
            "all": list(self.namespaces_to_check_set - set([self.namespace])),
            "resources": {}
        }}

        def store_results(result_dict, step):
            result_dict[step.resource_type] = {
                'number_failing': len(step.failing_resources),
                'failing': self.map_by_name(step.failing_resources)
            }
            if settings.INCLUDE_ALL_RES_IN_DETAILS:
                result_dict[step.resource_type]['all'] = self.map_by_name(step.all_resources)
                result_dict[step.resource_type]['number_all'] = len(step.all_resources)

        for step in self._steps:
            if step.failing:
                self.failing = True
                self.__logger.info("%s failing: %s",
                                   step.resource_type,
                                   len(step.failing_resources))
            if step.is_primary:
                store_results(details, step)
            else:
                ns_details = details["namespace"]["resources"]
                if step.namespace not in ns_details:
                    ns_details[step.namespace] = {}
                ns_details = ns_details[step.namespace]
                store_results(ns_details, step)

        with (Path(self.res_dir).joinpath(settings.STATUS_DETAILS_JSON)
              ).open('w', encoding="utf-8") as file:
            json.dump(details, file, indent=4)
        if self.failing:
            raise StatusCheckException

    def map_by_name(self, resources):
        """Get resources' names."""
        return list(map(lambda resource: resource.name, resources))