Differential D556

stop passing openQA client instance around all over the place
ClosedPublic
Actions

Authored by adamwill on Sep 3 2015, 9:21 PM.

Details

Reviewers
garretraziel
jskladan
Commits
rOPENQA27f94134e784: stop passing openQA client instance around all over the place
Summary

I noticed that after all the recent change shook out, we're
passing an OpenQA_Client instance all over the place which is
actually *used* exactly twice, once in run_openqa_jobs() and
once in get_passed_testcases(). Instantiating an OpenQA_Client
is pretty much free anyway, so instead of all this pass-the-
parcel crap, let's just have those two places instantiate it
when they need it.

I guess in theory we might want to allow for passing in a
differently-configured OpenQA_Client, but eh, it doesn't seem
really compelling, and you can always just change the client
config file. If we really want to allow for it we can just
have those two function accept an optional 'client' argument
and instantiate if it's not provided.

Test Plan

Check everything still works exactly the same.

Diff Detail

Repository
rOPENQA fedora_openqa
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
adamwill retitled this revision from to stop passing openQA client instance around all over the place.Sep 3 2015, 9:21 PM
adamwill updated this object.
adamwill edited the test plan for this revision. (Show Details)
adamwill added reviewers: garretraziel, jskladan.
This revision is now accepted and ready to land.Sep 4 2015, 1:38 PM
Closed by commit rOPENQA27f94134e784: stop passing openQA client instance around all over the place (authored by adamwill). · Explain WhySep 5 2015, 9:41 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents

Diff 1451

View Options

fedora_openqa_schedule/cli.py

Show All 25 Lines
26# Standard libraries 26​# Standard libraries
27import argparse 27​import argparse
28import logging 28​import logging
29import sys 29​import sys
30 30​
31# External dependencies 31​# External dependencies
32import fedfind.exceptions 32​import fedfind.exceptions
33import fedfind.release 33​import fedfind.release
34from openqa_client.client import OpenQA_Client ​
35# We can at least find images and run OpenQA jobs without wikitcms 34​# We can at least find images and run OpenQA jobs without wikitcms
36try: 35​try:
37 import wikitcms.wiki 36​ import wikitcms.wiki
38except ImportError: 37​except ImportError:
39 wikitcms = None 38​ wikitcms = None
40 39​
41# Internal dependencies 40​# Internal dependencies
42import fedora_openqa_schedule.schedule as schedule 41​import fedora_openqa_schedule.schedule as schedule
43import fedora_openqa_schedule.report as report 42​import fedora_openqa_schedule.report as report
44from fedora_openqa_schedule.config import CONFIG 43​from fedora_openqa_schedule.config import CONFIG
45 44​
46logger = logging.getLogger(__name__) 45​logger = logging.getLogger(__name__)
47 46​
48### SUB-COMMAND METHODS 47​### SUB-COMMAND METHODS
49 48​
50def command_compose(args, wiki, client): 49​def command_compose(args, wiki):
51 """run OpenQA on a specified compose, optionally reporting 50​ """run OpenQA on a specified compose, optionally reporting
52 results if a matching wikitcms ValidationEvent is found by 51​ results if a matching wikitcms ValidationEvent is found by
53 relval/wikitcms. 52​ relval/wikitcms.
54 """ 53​ """
55 # get the fedfind release object 54​ # get the fedfind release object
56 try: 55​ try:
57 logger.debug("querying fedfind on specific compose: %s %s %s", args.release, 56​ logger.debug("querying fedfind on specific compose: %s %s %s", args.release,
58 args.milestone, args.compose) 57​ args.milestone, args.compose)
Show All 22 Lines78 if args.wait:
81 try: 80​ try:
82 ff_release.wait(waittime=args.wait) 81​ ff_release.wait(waittime=args.wait)
83 except fedfind.exceptions.WaitError: 82​ except fedfind.exceptions.WaitError:
84 sys.exit("Waited too long for compose to appear!") 83​ sys.exit("Waited too long for compose to appear!")
85 84​
86 jobs = [] 85​ jobs = []
87 try: 86​ try:
88 if args.arch: 87​ if args.arch:
89 jobs = schedule.jobs_from_fedfind(ff_release, client, [args.arch]) 88​ jobs = schedule.jobs_from_fedfind(ff_release, [args.arch])
90 else: 89​ else:
91 jobs = schedule.jobs_from_fedfind(ff_release, client) 90​ jobs = schedule.jobs_from_fedfind(ff_release)
92 except schedule.TriggerException as e: 91​ except schedule.TriggerException as e:
93 logger.debug("No jobs run: %s", e) 92​ logger.debug("No jobs run: %s", e)
94 sys.exit(1) 93​ sys.exit(1)
95 logger.info("planned jobs: %s", ' '.join(str(j) for j in jobs)) 94​ logger.info("planned jobs: %s", ' '.join(str(j) for j in jobs))
96 if args.submit_results: 95​ if args.submit_results:
97 report.report_results(jobs, client) 96​ report.report_results(jobs)
98 logger.debug("finished") 97​ logger.debug("finished")
99 sys.exit() 98​ sys.exit()
100 99​
101def command_current(args, wiki, client): 100​def command_current(args, wiki):
102 """run OpenQA for current release validation event, if we have 101​ """run OpenQA for current release validation event, if we have
103 not already done it. 102​ not already done it.
104 """ 103​ """
105 logger.info("running on current release") 104​ logger.info("running on current release")
106 try: 105​ try:
107 jobs = schedule.jobs_from_current(wiki, client) 106​ jobs = schedule.jobs_from_current(wiki)
108 except schedule.TriggerException as e: 107​ except schedule.TriggerException as e:
109 logger.debug("No jobs run: %s", e) 108​ logger.debug("No jobs run: %s", e)
110 sys.exit(1) 109​ sys.exit(1)
111 # wait for jobs to finish and display results 110​ # wait for jobs to finish and display results
112 if jobs: 111​ if jobs:
113 logger.info("waiting for jobs: %s", ' '.join(str(j) for j in jobs)) 112​ logger.info("waiting for jobs: %s", ' '.join(str(j) for j in jobs))
114 report.report_results(jobs, client) 113​ report.report_results(jobs)
115 logger.debug("finished") 114​ logger.debug("finished")
116 sys.exit() 115​ sys.exit()
117 116​
118def command_report(args, wiki, client): 117​def command_report(args, wiki):
119 """Map a list of openQA job IDs to Wikitcms test results, and 118​ """Map a list of openQA job IDs to Wikitcms test results, and
120 either display the ResTups for inspection or report the 119​ either display the ResTups for inspection or report the
121 results to the wiki. 120​ results to the wiki.
122 """ 121​ """
123 try: 122​ try:
124 report.report_results( 123​ report.report_results(
125 args.jobs, client=client, wiki=wiki, report=args.submit) 124​ args.jobs, wiki=wiki, report=args.submit)
126 except report.LoginError: 125​ except report.LoginError:
127 # Module logs for us, no need to dupe it. 126​ # Module logs for us, no need to dupe it.
128 sys.exit(1) 127​ sys.exit(1)
129 128​
130### ARGUMENT PARSING AND SUB-COMMAND INIT 129​### ARGUMENT PARSING AND SUB-COMMAND INIT
131 130​
132def run(): 131​def run():
133 """Read in args, set up logging, wikitcms and openQA client, and 132​ """Read in args, set up logging and wikitcms, and run sub-command
134 run sub-command function. 133​ function.
135 """ 134​ """
136 args = parse_args() 135​ args = parse_args()
137 loglevel = getattr( 136​ loglevel = getattr(
138 logging, args.log_level.upper(), logging.INFO) 137​ logging, args.log_level.upper(), logging.INFO)
139 if args.log_file: 138​ if args.log_file:
140 logging.basicConfig(format="%(levelname)s:%(name)s:%(asctime)s:%(message)s", 139​ logging.basicConfig(format="%(levelname)s:%(name)s:%(asctime)s:%(message)s",
141 filename=args.log_file, level=loglevel) 140​ filename=args.log_file, level=loglevel)
142 else: 141​ else:
143 logging.basicConfig(level=loglevel) 142​ logging.basicConfig(level=loglevel)
144 143​
145 wiki = None 144​ wiki = None
146 if args.test: 145​ if args.test:
147 logger.debug("using test wiki") 146​ logger.debug("using test wiki")
148 if wikitcms: 147​ if wikitcms:
149 wiki = wikitcms.wiki.Wiki(('https', 'stg.fedoraproject.org'), '/w/') 148​ wiki = wikitcms.wiki.Wiki(('https', 'stg.fedoraproject.org'), '/w/')
150 else: 149​ else:
151 logger.warn("wikitcms not found, reporting to wiki disabled") 150​ logger.warn("wikitcms not found, reporting to wiki disabled")
152 else: 151​ else:
153 if wikitcms: 152​ if wikitcms:
154 wiki = wikitcms.wiki.Wiki(('https', 'fedoraproject.org'), '/w/') 153​ wiki = wikitcms.wiki.Wiki(('https', 'fedoraproject.org'), '/w/')
155 else: 154​ else:
156 logger.warn("wikitcms not found, reporting to wiki disabled") 155​ logger.warn("wikitcms not found, reporting to wiki disabled")
157 156​
158 client = OpenQA_Client() # uses first server from ~/.config/openqa/client.conf 157​ args.func(args, wiki)
159 ​
160 args.func(args, wiki, client) ​
161 158​
162def parse_args(): 159​def parse_args():
163 """Parse arguments with argparse.""" 160​ """Parse arguments with argparse."""
164 test_help = "Operate on the staging wiki (for testing)" 161​ test_help = "Operate on the staging wiki (for testing)"
165 parser = argparse.ArgumentParser(description=( 162​ parser = argparse.ArgumentParser(description=(
166 "Run OpenQA tests for a release validation test event.")) 163​ "Run OpenQA tests for a release validation test event."))
167 subparsers = parser.add_subparsers() 164​ subparsers = parser.add_subparsers()
168 165​
▲ Show 20 Lines • Show All 68 Lines • Show Last 20 Lines
View Options

fedora_openqa_schedule/report.py

Show All 23 Lines
24""" 24​"""
25 25​
26# standard libraries 26​# standard libraries
27import time 27​import time
28import logging 28​import logging
29from operator import attrgetter 29​from operator import attrgetter
30 30​
31# External dependencies 31​# External dependencies
32​from openqa_client.client import OpenQA_Client
32from wikitcms.wiki import Wiki, ResTuple 33​from wikitcms.wiki import Wiki, ResTuple
33 34​
34# Internal dependencies 35​# Internal dependencies
35import fedora_openqa_schedule.conf_test_suites as conf_test_suites 36​import fedora_openqa_schedule.conf_test_suites as conf_test_suites
36from fedora_openqa_schedule.config import CONFIG 37​from fedora_openqa_schedule.config import CONFIG
37 38​
38logger = logging.getLogger(__name__) 39​logger = logging.getLogger(__name__)
39 40​
40 41​
41class LoginError(Exception): 42​class LoginError(Exception):
42 """Raised when cannot log in to wiki to submit results.""" 43​ """Raised when cannot log in to wiki to submit results."""
43 pass 44​ pass
44 45​
45 46​
46def get_passed_testcases(job_ids, client, waittime=None): 47​def get_passed_testcases(job_ids, waittime=None):
47 """ 48​ """
48 job_ids ~ list of int (job ids) 49​ job_ids ~ list of int (job ids)
49 waittime ~ int or None - how long to wait for jobs, None == read from config 50​ waittime ~ int or None - how long to wait for jobs, None == read from config
50 Returns ~ list of str - names of passed testcases 51​ Returns ~ list of str - names of passed testcases
51 """ 52​ """
52 if waittime is None: 53​ if waittime is None:
53 waittime = CONFIG.getint('report', 'jobs-wait') 54​ waittime = CONFIG.getint('report', 'jobs-wait')
54 # Use the openQA client lib to wait for jobs to be done. We'll 55​ # Use the openQA client lib to wait for jobs to be done. Will
55 # wait 6 hours, what the hell. Will raise an openQA client error 56​ # raise an openQA client error on wait expiry.
56 # on wait expiry. 57​ client = OpenQA_Client()
57 jobs = client.wait_jobs(job_ids, waittime=waittime) 58​ jobs = client.wait_jobs(job_ids, waittime=waittime)
58 passed_testcases = set() 59​ passed_testcases = set()
59 for job in jobs: 60​ for job in jobs:
60 if job['result'] == 'passed': 61​ if job['result'] == 'passed':
61 (release, milestone, compose) = job['settings']['BUILD'].split('_') 62​ (release, milestone, compose) = job['settings']['BUILD'].split('_')
62 testsuite = job['settings']['TEST'] 63​ testsuite = job['settings']['TEST']
63 arch = job['settings']['ARCH'] 64​ arch = job['settings']['ARCH']
64 flavor = job['settings']['FLAVOR'] 65​ flavor = job['settings']['FLAVOR']
Show All 13 Lines78 result = ResTuple(
78 testtype=uniqueres['type'], release=release, milestone=milestone, 79​ testtype=uniqueres['type'], release=release, milestone=milestone,
79 compose=compose, testcase=testcase, section=uniqueres['section'], 80​ compose=compose, testcase=testcase, section=uniqueres['section'],
80 testname=testname, env=env, status='pass', bot=True) 81​ testname=testname, env=env, status='pass', bot=True)
81 passed_testcases.add(result) 82​ passed_testcases.add(result)
82 83​
83 return sorted(list(passed_testcases), key=attrgetter('testcase')) 84​ return sorted(list(passed_testcases), key=attrgetter('testcase'))
84 85​
85 86​
86def report_results(job_ids, client, wiki=None, report=None): 87​def report_results(job_ids, wiki=None, report=None):
87 """Report results from a list of openQA job IDs to Wikitcms. If 88​ """Report results from a list of openQA job IDs to Wikitcms. If
88 report is False, will just print out the python-wikitcms ResTups 89​ report is False, will just print out the python-wikitcms ResTups
89 for inspection. If report is None, will read the setting from the 90​ for inspection. If report is None, will read the setting from the
90 config file; if no config file is present, default is True. 91​ config file; if no config file is present, default is True.
91 """ 92​ """
92 passed_testcases = get_passed_testcases(job_ids, client) 93​ passed_testcases = get_passed_testcases(job_ids)
93 logger.info("passed testcases: %s", passed_testcases) 94​ logger.info("passed testcases: %s", passed_testcases)
94 if report is None: 95​ if report is None:
95 report = CONFIG.getboolean('report', 'submit') 96​ report = CONFIG.getboolean('report', 'submit')
96 97​
97 if report: 98​ if report:
98 logger.info("reporting test passes") 99​ logger.info("reporting test passes")
99 if not wiki: 100​ if not wiki:
100 wiki = Wiki() 101​ wiki = Wiki()
Show All 14 Lines
View Options

fedora_openqa_schedule/schedule.py

Show All 24 Lines
25 25​
26# Standard libraries 26​# Standard libraries
27import json 27​import json
28import logging 28​import logging
29import os.path 29​import os.path
30 30​
31# External dependencies 31​# External dependencies
32import fedfind.release 32​import fedfind.release
33​from openqa_client.client import OpenQA_Client
33from six.moves import configparser 34​from six.moves import configparser
34import urlgrabber 35​import urlgrabber
35 36​
36# Internal dependencies 37​# Internal dependencies
37from fedora_openqa_schedule.config import CONFIG 38​from fedora_openqa_schedule.config import CONFIG
38 39​
39logger = logging.getLogger(__name__) 40​logger = logging.getLogger(__name__)
40 41​
Show All 39 Lines79 if not os.path.isfile(filename):
80 # Icky hack around a urlgrabber bug: 81​ # Icky hack around a urlgrabber bug:
81 # https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=715416 82​ # https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=715416
82 urlgrabber.urlgrab(image.url.replace('https', 'http'), filename) 83​ urlgrabber.urlgrab(image.url.replace('https', 'http'), filename)
83 else: 84​ else:
84 logger.info("%s already exists", filename) 85​ logger.info("%s already exists", filename)
85 return isoname 86​ return isoname
86 87​
87 88​
88def run_openqa_jobs(client, isoname, flavor, arch, build): 89​def run_openqa_jobs(isoname, flavor, arch, build):
89 """# run OpenQA 'isos' job on selected isoname, with given arch 90​ """# run OpenQA 'isos' job on selected isoname, with given arch
90 and a version string. **NOTE**: the version passed to OpenQA as 91​ and a version string. **NOTE**: the version passed to OpenQA as
91 BUILD and is parsed back into the 'relval report-auto' arguments 92​ BUILD and is parsed back into the 'relval report-auto' arguments
92 by report_job_results.py; it is expected to be in the form of a 93​ by report_job_results.py; it is expected to be in the form of a
93 3-tuple on which join('_') has been run, and the three elements 94​ 3-tuple on which join('_') has been run, and the three elements
94 will be passed as release, compose and milestone. Returns list of 95​ will be passed as release, compose and milestone. Returns list of
95 job IDs. 96​ job IDs.
96 """ 97​ """
97 logger.info("sending jobs on OpenQA") 98​ logger.info("sending jobs on OpenQA")
98 99​
99 # starts OpenQA jobs 100​ # starts OpenQA jobs
100 params = { 101​ params = {
101 'ISO': isoname, 102​ 'ISO': isoname,
102 'DISTRI': 'fedora', 103​ 'DISTRI': 'fedora',
103 'VERSION': build.split('_')[0], 104​ 'VERSION': build.split('_')[0],
104 'FLAVOR': flavor, 105​ 'FLAVOR': flavor,
105 'ARCH': arch, 106​ 'ARCH': arch,
106 'BUILD': build 107​ 'BUILD': build
107 } 108​ }
109​ client = OpenQA_Client()
108 output = client.openqa_request('POST', 'isos', params) 110​ output = client.openqa_request('POST', 'isos', params)
109 111​
110 logger.debug("executed") 112​ logger.debug("executed")
111 logger.info("planned jobs: %s", output["ids"]) 113​ logger.info("planned jobs: %s", output["ids"])
112 114​
113 return output["ids"] 115​ return output["ids"]
114 116​
115 117​
116def jobs_from_current(wiki, client): 118​def jobs_from_current(wiki):
117 """Schedule jobs against the 'current' release validation event 119​ """Schedule jobs against the 'current' release validation event
118 (according to wikitcms) if we have not already. Returns the job 120​ (according to wikitcms) if we have not already. Returns the job
119 list. 121​ list.
120 """ 122​ """
121 if not wiki: 123​ if not wiki:
122 logger.warning("python-wikitcms is required for current validation event discovery.") 124​ logger.warning("python-wikitcms is required for current validation event discovery.")
123 return ([], None) 125​ return ([], None)
124 last_versions, json_parsed = read_last() 126​ last_versions, json_parsed = read_last()
Show All 10 Lines135 else:
135 logger.debug("%s will be tested in version %s", arch, currev.sortname) 137​ logger.debug("%s will be tested in version %s", arch, currev.sortname)
136 json_parsed[arch] = currev.sortname 138​ json_parsed[arch] = currev.sortname
137 139​
138 jobs = [] 140​ jobs = []
139 141​
140 if not runarches: 142​ if not runarches:
141 raise TriggerException("Skipped all arches, nothing to do.") 143​ raise TriggerException("Skipped all arches, nothing to do.")
142 144​
143 jobs = jobs_from_fedfind(currev.ff_release, client, runarches) 145​ jobs = jobs_from_fedfind(currev.ff_release, runarches)
144 logger.info("planned jobs: %s", ' '.join(str(j) for j in jobs)) 146​ logger.info("planned jobs: %s", ' '.join(str(j) for j in jobs))
145 147​
146 # write info about latest versions 148​ # write info about latest versions
147 f = open(PERSISTENT, "w") 149​ f = open(PERSISTENT, "w")
148 f.write(json.dumps(json_parsed)) 150​ f.write(json.dumps(json_parsed))
149 f.close() 151​ f.close()
150 logger.debug("written info about newest version") 152​ logger.debug("written info about newest version")
151 153​
152 return jobs 154​ return jobs
153 155​
154 156​
155def jobs_from_fedfind(ff_release, client, arches=ARCHES): 157​def jobs_from_fedfind(ff_release, arches=ARCHES):
156 """Given a fedfind.Release object, find the ISOs we want and run 158​ """Given a fedfind.Release object, find the ISOs we want and run
157 jobs on them. arches is an iterable of arches to run on, if not 159​ jobs on them. arches is an iterable of arches to run on, if not
158 specified, we'll use our constant. 160​ specified, we'll use our constant.
159 """ 161​ """
160 # Find currently-testable images for our arches. 162​ # Find currently-testable images for our arches.
161 jobs = [] 163​ jobs = []
162 queries = ( 164​ queries = (
163 fedfind.release.Query('imagetype', ('boot', 'live')), 165​ fedfind.release.Query('imagetype', ('boot', 'live')),
Show All 39 Lines194 for img in okimgs:
203 if score > bestscore: 205​ if score > bestscore:
204 bestimg = img 206​ bestimg = img
205 bestscore = score 207​ bestscore = score
206 if not bestimg: 208​ if not bestimg:
207 logger.warn("no universal tests image found for %s", arch) 209​ logger.warn("no universal tests image found for %s", arch)
208 continue 210​ continue
209 logger.info("running universal tests for %s with %s", arch, bestimg.desc) 211​ logger.info("running universal tests for %s with %s", arch, bestimg.desc)
210 isoname = download_image(bestimg) 212​ isoname = download_image(bestimg)
211 job_ids = run_openqa_jobs(client, isoname, 'universal', arch, build) 213​ job_ids = run_openqa_jobs(isoname, 'universal', arch, build)
212 jobs.extend(job_ids) 214​ jobs.extend(job_ids)
213 215​
214 # Now schedule per-image jobs. 216​ # Now schedule per-image jobs.
215 for image in images: 217​ for image in images:
216 isoname = download_image(image) 218​ isoname = download_image(image)
217 flavor = '_'.join((image.payload, image.imagetype)) 219​ flavor = '_'.join((image.payload, image.imagetype))
218 job_ids = run_openqa_jobs(client, isoname, flavor, image.arch, build) 220​ job_ids = run_openqa_jobs(isoname, flavor, image.arch, build)
219 jobs.extend(job_ids) 221​ jobs.extend(job_ids)
220 return jobs 222​ return jobs