Differential D816

burn down all the 'wait' stuff
ClosedPublic
Actions

Authored by adamwill on Apr 16 2016, 12:09 AM.

Details

Reviewers
garretraziel
jskladan
Commits
rOPENQAedb3301f4cbb: burn down all the 'wait' stuff
Summary

Thanks to the glories of fedmsg, we no longer need the 'wait
for jobs to complete' stuff. Kill wait_and_report, make report_
results accept job IDs or build, use report_results instead of
wait_and_report everywhere, and drop the 'wait' config stuff.
Note this requires 1.1 of the openQA client.

Test Plan

Check that reporting results both manually and via
the fedmsg consumer works.

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 burn down all the 'wait' stuff.Apr 16 2016, 12:09 AM
adamwill updated this object.
adamwill edited the test plan for this revision. (Show Details)
adamwill added reviewers: jskladan, garretraziel.
garretraziel added a comment.Apr 18 2016, 11:47 AM

I'm generally okay with this stuff, but just to be sure - this disables "run scheduler from terminal, it will schedule tasks and it will wait for them to finish and reports them" scenario, am I right? I'm scheduling tasks using scheduler by hand from time to time, but I don't need it to report results to wiki, so I don't mind.

adamwill added a comment.EditedApr 18 2016, 2:57 PM

Yes it does, scheduling jobs from CLI will just return as soon as the jobs are sent. I'm not using the 'wait for the jobs to complete and report them' part of that feature any more either, I don't think we need it. If you really need to report results manually in some unusual situation it's easy to do with just report (compose id) subcommand these days.

Your comment did make me realize there's one bug in this (the CLI 'schedule' command shouldn't try to report results immediately after scheduling the jobs, duh) and some other bits I should improve (I don't think -ns report is doing what we intended it to do at present, but it wasn't before this change either). I'll tweak it a bit more today.

adamwill updated this revision to Diff 2084.Apr 18 2016, 3:10 PM

CLI schedule: just print job IDs and exit after submitting

There's no sense in running report_results after scheduling
jobs, as they won't have finished yet; it only made sense for
wait_and_report. So instead of that, just print the scheduled
job IDs and exit successfully.

adamwill added a comment.Apr 18 2016, 3:12 PM

OK, so logging of results when submitting is actually working fine, I just forgot where it was done. So I just had to fix the compose subcommand not to try and report results after submitting jobs.

garretraziel accepted this revision.Apr 19 2016, 9:34 AM

Works without problem.

This revision is now accepted and ready to land.Apr 19 2016, 9:34 AM
Closed by commit rOPENQAedb3301f4cbb: burn down all the 'wait' stuff (authored by adamwill). · Explain WhyApr 19 2016, 2:25 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents

Diff 2085

View Options

scheduler/fedora_openqa_schedule/cli.py

Show First 20 Lines • Show All 47 Lines • ▼ Show 20 Line(s)40def command_compose(args, wiki_url):
48 try: 48​ try:
49 (compose, jobs) = schedule.jobs_from_compose( 49​ (compose, jobs) = schedule.jobs_from_compose(
50 args.location, force=args.force, extraparams=extraparams) 50​ args.location, force=args.force, extraparams=extraparams)
51 except schedule.TriggerException as err: 51​ except schedule.TriggerException as err:
52 logger.warning("No jobs run! %s", err) 52​ logger.warning("No jobs run! %s", err)
53 sys.exit(1) 53​ sys.exit(1)
54 54​
55 if jobs: 55​ if jobs:
56 report.wait_and_report(wiki_url, build=compose, do_report=args.submit) 56​ print("Scheduled jobs: {0}".format(jobs))
57​ sys.exit()
57 else: 58​ else:
58 msg = "No jobs run!" 59​ msg = "No jobs run!"
59 if not args.force: 60​ if not args.force:
60 msg = "{0} {1}".format( 61​ msg = "{0} {1}".format(
61 msg, "You did not pass --force: maybe jobs exist for all ISOs/flavors") 62​ msg, "You did not pass --force: maybe jobs exist for all ISOs/flavors")
62 logger.warning(msg) 63​ logger.warning(msg)
63 sys.exit(1) 64​ sys.exit(1)
64 65​
65 logger.debug("finished") 66​ logger.debug("finished")
66 sys.exit() 67​ sys.exit()
67 68​
68def command_report(args, wiki_url): 69​def command_report(args, wiki_url):
69 """Map a list of openQA job IDs and/or builds to Wikitcms test 70​ """Map a list of openQA job IDs and/or builds to Wikitcms test
70 results, and either display the ResTups for inspection or report 71​ results, and either display the ResTups for inspection or report
71 the results to the wiki. 72​ the results to the wiki.
72 """ 73​ """
73 jobs = [int(job) for job in args.jobs if job.isdigit()] 74​ jobs = [int(job) for job in args.jobs if job.isdigit()]
74 builds = [build for build in args.jobs if not build.isdigit()] 75​ builds = [build for build in args.jobs if not build.isdigit()]
75 try: 76​ try:
76 if jobs: 77​ if jobs:
77 report.wait_and_report( 78​ report.report_results(
78 wiki_url, job_ids=jobs, do_report=args.submit) 79​ wiki_url, jobs=jobs, do_report=args.submit)
79 if builds: 80​ if builds:
80 for build in builds: 81​ for build in builds:
81 report.wait_and_report( 82​ report.report_results(
82 wiki_url, build=build, do_report=args.submit) 83​ wiki_url, build=build, do_report=args.submit)
83 except report.LoginError: 84​ except report.LoginError:
84 # Module logs for us, no need to dupe it. 85​ # Module logs for us, no need to dupe it.
85 sys.exit(1) 86​ sys.exit(1)
86 87​
87### ARGUMENT PARSING AND SUB-COMMAND INIT 88​### ARGUMENT PARSING AND SUB-COMMAND INIT
88 89​
89def run(): 90​def run():
▲ Show 20 Lines • Show All 82 Lines • Show Last 20 Lines
View Options

scheduler/fedora_openqa_schedule/consumer.py

Show First 20 Lines • Show All 87 Lines • ▼ Show 20 Line(s)81class OpenQAWikiConsumer(fedmsg.consumers.FedmsgConsumer):
88 openQA but retrieving the jobs with those same IDs from the other 88​ openQA but retrieving the jobs with those same IDs from the other
89 openQA). 89​ openQA).
90 """ 90​ """
91 91​
92 def consume(self, message): 92​ def consume(self, message):
93 """Consume incoming message.""" 93​ """Consume incoming message."""
94 job = message['body']['msg']['id'] 94​ job = message['body']['msg']['id']
95 self.log.info("%s: reporting results for %s", self.__class__.__name__, job) 95​ self.log.info("%s: reporting results for %s", self.__class__.__name__, job)
96 results = report.wait_and_report( 96​ results = report.report_results(self.url, jobs=[job], do_report=self.report)
97 self.url, job_ids=[job], do_report=self.report, waittime=0) ​
98 if not self.report: 97​ if not self.report:
99 for res in results: 98​ for res in results:
100 self.log.info("%s: would report %s", self.__class__.__name__, res) 99​ self.log.info("%s: would report %s", self.__class__.__name__, res)
101 100​
102 101​
103class OpenQAProductionWikiConsumer(OpenQAWikiConsumer): 102​class OpenQAProductionWikiConsumer(OpenQAWikiConsumer):
104 """A result reporting consumer that listens for production fedmsgs 103​ """A result reporting consumer that listens for production fedmsgs
105 and reports to the production wiki. Only one of these should ever 104​ and reports to the production wiki. Only one of these should ever
Show All 36 Lines
View Options

scheduler/fedora_openqa_schedule/report.py

Show First 20 Lines • Show All 120 Lines • ▼ Show 20 Line(s)120 result = ResTuple(
121 testtype=uniqueres['type'], testcase=testcase, 121​ testtype=uniqueres['type'], testcase=testcase,
122 section=uniqueres.get('section'), testname=uniqueres.get('name', ''), 122​ section=uniqueres.get('section'), testname=uniqueres.get('name', ''),
123 env=uniqueres.get('env', ''), status='pass', bot=True, cid=composeid) 123​ env=uniqueres.get('env', ''), status='pass', bot=True, cid=composeid)
124 passed_testcases.add(result) 124​ passed_testcases.add(result)
125 125​
126 return sorted(list(passed_testcases), key=attrgetter('testcase')) 126​ return sorted(list(passed_testcases), key=attrgetter('testcase'))
127 127​
128 128​
129def wait_and_report(wiki_url, job_ids=None, build=None, do_report=None, waittime=None): 129​def report_results(wiki_url, jobs=None, build=None, do_report=None):
130 """Find some openQA jobs and report the results to Wikitcms (via 130​ """Report results from openQA jobs to Wikitcms. Either jobs (an
131 report_results). Either job_ids (an iterable of IDs) or build (an 131​ iterable of job IDs) or build (an openQA BUILD string, usually a
132 openQA BUILD string) is required. wiki_url and do_report are passed to 132​ Fedora compose ID) is required (if neither is specified, the
133 report_results and documented there. waittime (int) is how long to 133​ openQA client will raise TypeError). If do_report is False, will
134 wait for jobs to complete before giving up; if 'build' is used, 134​ just print out the python-wikitcms ResTups for inspection. If
135 will also wait for jobs to appear. If jobs are not present and 135​ do_report is None, will read the setting from the config file; if
136 complete when waittime expires, 136​ no config file is present, default is True.
137 openqa_client.exceptions.WaitException will be raised. If waittime ​
138 is 0, no waiting is done, and if jobs are not complete, the ​
139 exception will raise immediately. ​
140 """ 137​ """
141 if not job_ids and not build: ​
142 raise ValueError("wait_and_report requires either job_ids or build.") ​
143 ​
144 ret = [] ​
145 if waittime is None: ​
146 waittime = CONFIG.getint('report', 'jobs-wait') ​
147 # Use the openQA client lib to wait for jobs to be done. Will ​
148 # raise an openQA client error on wait expiry. ​
149 client = OpenQA_Client() 138​ client = OpenQA_Client()
150 # iterate_jobs can work on jobs or build; whichever is set will be used 139​ jobs = client.get_jobs(jobs=jobs, build=build)
151 for joblist in client.iterate_jobs(jobs=job_ids, build=build, waittime=waittime): ​
152 ret.extend(report_results(joblist, wiki_url, do_report=do_report)) ​
153 return ret ​
154 ​
155 ​
156def report_results(jobs, wiki_url, do_report=None): ​
157 """Report results from openQA jobs to Wikitcms. jobs is an ​
158 iterable of openQA job dicts. If do_report is False, will just print ​
159 out the python-wikitcms ResTups for inspection. If do_report is None, ​
160 will read the setting from the config file; if no config file is ​
161 present, default is True. ​
162 """ ​
163 passed_testcases = get_passed_testcases(jobs) 140​ passed_testcases = get_passed_testcases(jobs)
164 logger.info("passed testcases: %s", passed_testcases) 141​ logger.info("passed testcases: %s", passed_testcases)
165 if do_report is None: 142​ if do_report is None:
166 do_report = CONFIG.getboolean('report', 'submit') 143​ do_report = CONFIG.getboolean('report', 'submit')
167 144​
168 if do_report: 145​ if do_report:
169 logger.info("reporting test passes") 146​ logger.info("reporting test passes")
170 wiki = Wiki(('https', wiki_url), '/w/') 147​ wiki = Wiki(('https', wiki_url), '/w/')
Show All 19 Lines
View Options

scheduler/schedule.conf.sample

1# fedora-openqa-schedule (both CLI and module) will read configuration from 1​# fedora-openqa-schedule (both CLI and module) will read configuration from
2# /etc/fedora-qa/schedule.conf or ~/.config/fedora-qa/schedule.conf (with the 2​# /etc/fedora-qa/schedule.conf or ~/.config/fedora-qa/schedule.conf (with the
3# latter taking priority if both exist). Most of these settings may be 3​# latter taking priority if both exist). Most of these settings may be
4# overridden with CLI arguments, when using the CLI. Values in this sample 4​# overridden with CLI arguments, when using the CLI. Values in this sample
5# config indicate the defaults. 5​# config indicate the defaults.
6 6​
7[cli] 7​[cli]
8# File to log to (if not set, will log to stdout) 8​# File to log to (if not set, will log to stdout)
9log-file: 9​log-file:
10 10​
11# Logging level (debug, info, warning, error, critical) 11​# Logging level (debug, info, warning, error, critical)
12log-level: info 12​log-level: info
13 13​
14[report] 14​[report]
15# Whether to submit results to the Wiki (if false, just log them) 15​# Whether to submit results to the Wiki (if false, just log them)
16submit: true 16​submit: true
17 ​
18# Minutes to wait for openQA jobs to be complete (0 means 'do not wait') ​
19jobs-wait: 360 ​
View Options

scheduler/setup.py

Show All 24 Lines12setup(
25 }, 25​ },
26 author = "Fedora QA devel team", 26​ author = "Fedora QA devel team",
27 author_email = "qa-devel@lists.fedoraproject.org", 27​ author_email = "qa-devel@lists.fedoraproject.org",
28 description = "Fedora openQA scheduler", 28​ description = "Fedora openQA scheduler",
29 license = "GPLv3+", 29​ license = "GPLv3+",
30 keywords = "fedora openqa test qa", 30​ keywords = "fedora openqa test qa",
31 url = "https://bitbucket.org/rajcze/openqa_fedora_tools", 31​ url = "https://bitbucket.org/rajcze/openqa_fedora_tools",
32 packages = ["fedora_openqa_schedule"], 32​ packages = ["fedora_openqa_schedule"],
33 install_requires = ['fedfind>=1.5', 'fedmsg', 'openqa-client', 'setuptools', 'six'], 33​ install_requires = ['fedfind>=1.5', 'fedmsg', 'openqa-client>=1.1', 'setuptools', 'six'],
34 long_description=read('README.md'), 34​ long_description=read('README.md'),
35 classifiers=[ 35​ classifiers=[
36 "Development Status :: 3 - Alpha", 36​ "Development Status :: 3 - Alpha",
37 "Topic :: Utilities", 37​ "Topic :: Utilities",
38 "License :: OSI Approved :: GNU General Public License v3 or later " 38​ "License :: OSI Approved :: GNU General Public License v3 or later "
39 "(GPLv3+)", 39​ "(GPLv3+)",
40 ], 40​ ],
41) 41​)