scripts/system-tests/lava2-submit.py

   1 #!/usr/bin/python3
   2 # Copyright (C) 2016 - Francis Deslauriers <francis.deslauriers@efficios.com>
   3 #
   4 # This program is free software: you can redistribute it and/or modify
   5 # it under the terms of the GNU General Public License as published by
   6 # the Free Software Foundation, either version 3 of the License, or
   7 # (at your option) any later version.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 import argparse
  18 import json
  19 import os
  20 import random
  21 import re
  22 import sys
  23 import time
  24 import xmlrpc.client
  25 from urllib.parse import urljoin
  26 from urllib.request import urlretrieve
  27 import yaml
  28 from jinja2 import Environment, FileSystemLoader
  29
  30 USERNAME = 'lava-jenkins'
  31 HOSTNAME = 'lava-master-02.internal.efficios.com'
  32 OBJSTORE_URL = "https://obj.internal.efficios.com/lava/results/"
  33
  34 def parse_stable_version(stable_version_string):
  35     # Get the major and minor version numbers from the lttng version string.
  36     version_match = re.search('stable-(\d).(\d\d)', stable_version_string)
  37
  38     if version_match is not None:
  39         major_version = int(version_match.group(1))
  40         minor_version = int(version_match.group(2))
  41     else:
  42         # Setting to zero to make the comparison below easier.
  43         major_version = 0
  44         minor_version = 0
  45     return major_version, minor_version
  46
  47
  48 class TestType:
  49     """ Enum like for test type """
  50
  51     baremetal_tests = 1
  52     kvm_tests = 2
  53     values = {
  54         'baremetal-tests': baremetal_tests,
  55         'kvm-tests': kvm_tests,
  56     }
  57
  58
  59 class DeviceType:
  60     """ Enum like for device type """
  61
  62     x86 = 'x86'
  63     kvm = 'qemu'
  64     values = {'kvm': kvm, 'x86': x86}
  65
  66
  67 def get_job_bundle_content(server, job):
  68     try:
  69         bundle_sha = server.scheduler.job_status(str(job))['bundle_sha1']
  70         bundle = server.dashboard.get(bundle_sha)
  71     except xmlrpc.client.Fault as error:
  72         print('Error while fetching results bundle', error.faultString)
  73         raise error
  74
  75     return json.loads(bundle['content'])
  76
  77
  78 def check_job_all_test_cases_state_count(server, job):
  79     """
  80     Parse the results bundle to see the run-tests testcase
  81     of the lttng-kernel-tests passed successfully
  82     """
  83     print("Testcase result:")
  84     content = server.results.get_testjob_results_yaml(str(job))
  85     testcases = yaml.unsafe_load(content)
  86
  87     passed_tests = 0
  88     failed_tests = 0
  89     for testcase in testcases:
  90         if testcase['result'] != 'pass':
  91             print(
  92                 "\tFAILED {}\n\t\t See http://{}{}".format(
  93                     testcase['name'], HOSTNAME, testcase['url']
  94                 )
  95             )
  96             failed_tests += 1
  97         else:
  98             passed_tests += 1
  99     return (passed_tests, failed_tests)
 100
 101
 102 def print_test_output(server, job):
 103     """
 104     Parse the attachment of the testcase to fetch the stdout of the test suite
 105     """
 106     job_finished, log = server.scheduler.jobs.logs(str(job))
 107     logs = yaml.unsafe_load(log.data.decode('ascii'))
 108     print_line = False
 109     for line in logs:
 110         if line['lvl'] != 'target':
 111             continue
 112         if line['msg'] == '<LAVA_SIGNAL_STARTTC run-tests>':
 113             print('---- TEST SUITE OUTPUT BEGIN ----')
 114             print_line = True
 115             continue
 116         if line['msg'] == '<LAVA_SIGNAL_ENDTC run-tests>':
 117             print('----- TEST SUITE OUTPUT END -----')
 118             print_line = False
 119             continue
 120         if print_line:
 121             print("{} {}".format(line['dt'], line['msg']))
 122
 123
 124 def get_vlttng_cmd(
 125     lttng_version, lttng_tools_url, lttng_tools_commit, lttng_ust_url=None, lttng_ust_commit=None
 126 ):
 127     """
 128     Return vlttng cmd to be used in the job template for setup.
 129     """
 130
 131     major_version, minor_version = parse_stable_version(lttng_version)
 132
 133     urcu_profile = ""
 134     if lttng_version == 'master' or (major_version >= 2 and minor_version >= 11):
 135         urcu_profile = "urcu-master"
 136     else:
 137         urcu_profile = "urcu-stable-0.12"
 138
 139     vlttng_cmd = (
 140         'vlttng --jobs=$(nproc) --profile ' + urcu_profile
 141         + ' --override projects.babeltrace.build-env.PYTHON=python3'
 142         ' --override projects.babeltrace.build-env.PYTHON_CONFIG=python3-config'
 143         ' --profile babeltrace-stable-1.5'
 144         ' --profile babeltrace-python'
 145         ' --profile lttng-tools-master'
 146         ' --override projects.lttng-tools.source='
 147         + lttng_tools_url
 148         + ' --override projects.lttng-tools.checkout='
 149         + lttng_tools_commit
 150         + ' --profile lttng-tools-no-man-pages'
 151     )
 152
 153     if lttng_ust_commit is not None:
 154         vlttng_cmd += (
 155             ' --profile lttng-ust-master '
 156             ' --override projects.lttng-ust.source='
 157             + lttng_ust_url
 158             + ' --override projects.lttng-ust.checkout='
 159             + lttng_ust_commit
 160             + ' --profile lttng-ust-no-man-pages'
 161         )
 162
 163
 164     if lttng_version == 'master' or (major_version >= 2 and minor_version >= 11):
 165         vlttng_cmd += (
 166             ' --override projects.lttng-tools.configure+=--enable-test-sdt-uprobe'
 167         )
 168
 169     vlttng_path = '/tmp/virtenv'
 170
 171     vlttng_cmd += ' ' + vlttng_path
 172
 173     return vlttng_cmd
 174
 175
 176 def main():
 177     nfsrootfs = "https://obj.internal.efficios.com/lava/rootfs/rootfs_amd64_xenial_2018-12-05.tar.gz"
 178     test_type = None
 179     parser = argparse.ArgumentParser(description='Launch baremetal test using Lava')
 180     parser.add_argument('-t', '--type', required=True)
 181     parser.add_argument('-lv', '--lttng-version', required=True)
 182     parser.add_argument('-j', '--jobname', required=True)
 183     parser.add_argument('-k', '--kernel', required=True)
 184     parser.add_argument('-lm', '--lmodule', required=True)
 185     parser.add_argument('-tu', '--tools-url', required=True)
 186     parser.add_argument('-tc', '--tools-commit', required=True)
 187     parser.add_argument('-id', '--build-id', required=True)
 188     parser.add_argument('-uu', '--ust-url', required=False)
 189     parser.add_argument('-uc', '--ust-commit', required=False)
 190     parser.add_argument('-d', '--debug', required=False, action='store_true')
 191     args = parser.parse_args()
 192
 193     if args.type not in TestType.values:
 194         print('argument -t/--type {} unrecognized.'.format(args.type))
 195         print('Possible values are:')
 196         for k in TestType.values:
 197             print('\t {}'.format(k))
 198         return -1
 199
 200     lava_api_key = None
 201     if not args.debug:
 202         try:
 203             lava_api_key = os.environ['LAVA2_JENKINS_TOKEN']
 204         except Exception as error:
 205             print(
 206                 'LAVA2_JENKINS_TOKEN not found in the environment variable. Exiting...',
 207                 error,
 208             )
 209             return -1
 210
 211     jinja_loader = FileSystemLoader(os.path.dirname(os.path.realpath(__file__)))
 212     jinja_env = Environment(loader=jinja_loader, trim_blocks=True, lstrip_blocks=True)
 213     jinja_template = jinja_env.get_template('template_lava_job.jinja2')
 214
 215     test_type = TestType.values[args.type]
 216
 217     if test_type is TestType.baremetal_tests:
 218         device_type = DeviceType.x86
 219     else:
 220         device_type = DeviceType.kvm
 221
 222     vlttng_path = '/tmp/virtenv'
 223
 224     vlttng_cmd = get_vlttng_cmd(
 225         args.lttng_version, args.tools_url, args.tools_commit, args.ust_url, args.ust_commit
 226     )
 227
 228     if args.lttng_version == "master":
 229         lttng_version_string = "master"
 230     elif args.lttng_version == "canary":
 231         lttng_version_string = "2.10"
 232     else:
 233         major, minor = parse_stable_version(args.lttng_version)
 234         lttng_version_string = str(major) + "." + str(minor)
 235
 236
 237     context = dict()
 238     context['DeviceType'] = DeviceType
 239     context['TestType'] = TestType
 240
 241     context['job_name'] = args.jobname
 242     context['test_type'] = test_type
 243     context['random_seed'] = random.randint(0, 1000000)
 244     context['device_type'] = device_type
 245
 246     context['vlttng_cmd'] = vlttng_cmd
 247     context['vlttng_path'] = vlttng_path
 248     context['lttng_version_string'] = lttng_version_string
 249
 250     context['kernel_url'] = args.kernel
 251     context['nfsrootfs_url'] = nfsrootfs
 252     context['lttng_modules_url'] = args.lmodule
 253     context['jenkins_build_id'] = args.build_id
 254
 255     context['kprobe_round_nb'] = 10
 256
 257     render = jinja_template.render(context)
 258
 259     print('Job to be submitted:')
 260
 261     print(render)
 262
 263     if args.debug:
 264         return 0
 265
 266     server = xmlrpc.client.ServerProxy(
 267         'http://%s:%s@%s/RPC2' % (USERNAME, lava_api_key, HOSTNAME)
 268     )
 269
 270     for attempt in range(10):
 271         try:
 272             jobid = server.scheduler.submit_job(render)
 273         except xmlrpc.client.ProtocolError as error:
 274             print(
 275                 'Protocol error on submit, sleeping and retrying. Attempt #{}'.format(
 276                     attempt
 277                 )
 278             )
 279             time.sleep(5)
 280             continue
 281         else:
 282             break
 283
 284     print('Lava jobid:{}'.format(jobid))
 285     print(
 286         'Lava job URL: http://lava-master-02.internal.efficios.com/scheduler/job/{}'.format(
 287             jobid
 288         )
 289     )
 290
 291     # Check the status of the job every 30 seconds
 292     jobstatus = server.scheduler.job_state(jobid)['job_state']
 293     running = False
 294     while jobstatus in ['Submitted', 'Scheduling', 'Scheduled', 'Running']:
 295         if not running and jobstatus == 'Running':
 296             print('Job started running')
 297             running = True
 298         time.sleep(30)
 299         try:
 300             jobstatus = server.scheduler.job_state(jobid)['job_state']
 301         except xmlrpc.client.ProtocolError as error:
 302             print('Protocol error, retrying')
 303             continue
 304     print('Job ended with {} status.'.format(jobstatus))
 305
 306     if jobstatus != 'Finished':
 307         return -1
 308
 309     if test_type is TestType.kvm_tests or test_type is TestType.baremetal_tests:
 310         print_test_output(server, jobid)
 311
 312     passed, failed = check_job_all_test_cases_state_count(server, jobid)
 313     print('With {} passed and {} failed Lava test cases.'.format(passed, failed))
 314
 315     if failed != 0:
 316         return -1
 317
 318     return 0
 319
 320
 321 if __name__ == "__main__":
 322     sys.exit(main())