functest_kubernetes/k8stest.py

   1 #!/usr/bin/env python
   2 #
   3 # Copyright (c) 2018 All rights reserved
   4 # This program and the accompanying materials
   5 # are made available under the terms of the Apache License, Version 2.0
   6 # which accompanies this distribution, and is available at
   7 #
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10
  11 """
  12 Define the parent for Kubernetes testing.
  13 """
  14
  15 from __future__ import division
  16
  17 import logging
  18 import os
  19 import re
  20 import subprocess
  21 import time
  22 import yaml
  23
  24 from xtesting.core import testcase
  25
  26
  27 class E2ETesting(testcase.TestCase):
  28     """Kubernetes test runner"""
  29     # pylint: disable=too-many-instance-attributes
  30
  31     __logger = logging.getLogger(__name__)
  32
  33     config = '~/.kube/config'
  34     gcr_repo = os.getenv("MIRROR_REPO", "gcr.io")
  35     k8s_gcr_repo = os.getenv("MIRROR_REPO", "k8s.gcr.io")
  36
  37     def __init__(self, **kwargs):
  38         super().__init__(**kwargs)
  39         self.cmd = []
  40         self.dir_results = "/home/opnfv/functest/results"
  41         self.res_dir = os.path.join(self.dir_results, self.case_name)
  42         self.result = 0
  43         self.start_time = 0
  44         self.stop_time = 0
  45         self.output_log_name = 'functest-kubernetes.log'
  46         self.output_debug_log_name = 'functest-kubernetes.debug.log'
  47
  48     @staticmethod
  49     def convert_ini_to_dict(value):
  50         "Convert oslo.conf input to dict"
  51         assert isinstance(value, str)
  52         try:
  53             return dict((x.rsplit(':', 1) for x in value.split(',')))
  54         except ValueError:
  55             return {}
  56
  57     def run_kubetest(self, **kwargs):  # pylint: disable=too-many-branches
  58         """Run the test suites"""
  59         cmd_line = [
  60             'ginkgo', f'--nodes={kwargs.get("nodes", 1)}',
  61             '--no-color', '/usr/local/bin/e2e.test', '--',
  62             '-kubeconfig', self.config,
  63             '-provider', kwargs.get('provider', 'local'),
  64             '-report-dir', self.res_dir]
  65         for arg in kwargs.get("ginkgo", {}):
  66             cmd_line.extend([f'-ginkgo.{arg}', kwargs["ginkgo"][arg]])
  67         for key, value in self.convert_ini_to_dict(
  68                 os.environ.get("E2E_TEST_OPTS", "")).items():
  69             cmd_line.extend([f'-{key}', value])
  70         if "NON_BLOCKING_TAINTS" in os.environ:
  71             cmd_line.extend(
  72                 ['-non-blocking-taints', os.environ["NON_BLOCKING_TAINTS"]])
  73         cmd_line.extend(['-disable-log-dump', 'true'])
  74         self._generate_repo_list_file()
  75         self.__logger.info("Starting k8s test: '%s'.", cmd_line)
  76         env = os.environ.copy()
  77         env["KUBE_TEST_REPO_LIST"] = f"{self.res_dir}/repositories.yml"
  78         with subprocess.Popen(
  79                 cmd_line, stdout=subprocess.PIPE,
  80                 stderr=subprocess.STDOUT, env=env) as process:
  81             boutput = process.stdout.read()
  82         with open(os.path.join(
  83                 self.res_dir, 'e2e.log'), 'w', encoding='utf-8') as foutput:
  84             foutput.write(boutput.decode("utf-8"))
  85         grp = re.search(
  86             r'^(FAIL|SUCCESS)!.* ([0-9]+) Passed \| ([0-9]+) Failed \|'
  87             r' ([0-9]+) Pending \| ([0-9]+) Skipped',
  88             boutput.decode("utf-8", errors="ignore"),
  89             re.MULTILINE | re.DOTALL)
  90         assert grp
  91         self.details['passed'] = int(grp.group(2))
  92         self.details['failed'] = int(grp.group(3))
  93         self.details['pending'] = int(grp.group(4))
  94         self.details['skipped'] = int(grp.group(5))
  95         self.__logger.debug("details: %s", self.details)
  96         self.result = self.details['passed'] * 100 / (
  97             self.details['passed'] + self.details['failed'] +
  98             self.details['pending'])
  99         self.__logger.debug("result: %s", self.result)
 100         if grp.group(1) == 'FAIL':
 101             grp2 = re.search(
 102                 r'^(Summarizing [0-9]+ Failure.*)Ran',
 103                 boutput.decode("utf-8", errors="ignore"),
 104                 re.MULTILINE | re.DOTALL)
 105             if grp2:
 106                 self.__logger.error(grp2.group(1))
 107
 108     def run(self, **kwargs):
 109         if not os.path.exists(self.res_dir):
 110             os.makedirs(self.res_dir)
 111         if not os.path.isfile(self.config):
 112             self.__logger.error(
 113                 "Cannot run k8s testcases. Config file not found")
 114             return self.EX_RUN_ERROR
 115         self.start_time = time.time()
 116         try:
 117             self.run_kubetest(**kwargs)
 118             res = self.EX_OK
 119         except Exception:  # pylint: disable=broad-except
 120             self.__logger.exception("Error with running kubetest:")
 121             res = self.EX_RUN_ERROR
 122         self.stop_time = time.time()
 123         return res
 124
 125     def _generate_repo_list_file(self):
 126         """Generate the repositories list for the test."""
 127         # The list is taken from
 128         # https://github.com/kubernetes/kubernetes/blob/master/test/utils/image/manifest.go
 129         # It may needs update regularly
 130         gcr_repo = os.getenv("GCR_REPO", self.gcr_repo)
 131         k8s_gcr_repo = os.getenv("K8S_GCR_REPO", self.k8s_gcr_repo)
 132         repo_list = {
 133             "GcAuthenticatedRegistry":
 134                 f"{gcr_repo}/authenticated-image-pulling",
 135             "E2eRegistry": f"{gcr_repo}/kubernetes-e2e-test-images",
 136             "PromoterE2eRegistry": f"{k8s_gcr_repo}/e2e-test-images",
 137             "BuildImageRegistry": f"{k8s_gcr_repo}/build-image",
 138             "InvalidRegistry": "invalid.com/invalid",
 139             "GcEtcdRegistry": k8s_gcr_repo,
 140             "GcRegistry": k8s_gcr_repo,
 141             "SigStorageRegistry": f"{k8s_gcr_repo}/sig-storage",
 142             "PrivateRegistry": f"{gcr_repo}/k8s-authenticated-test",
 143             "SampleRegistry": f"{gcr_repo}/google-samples",
 144             "GcrReleaseRegistry": f"{gcr_repo}/gke-release",
 145             "MicrosoftRegistry": "mcr.microsoft.com"
 146         }
 147         with open(
 148                 f"{self.res_dir}/repositories.yml", 'w',
 149                 encoding='utf-8') as file:
 150             yaml.dump(repo_list, file)