Differential D553

allow reading most config settings from file
ClosedPublic
Actions

Authored by adamwill on Sep 2 2015, 9:25 PM.

Details

Reviewers
garretraziel
jskladan
Commits
rOPENQAfc81dcab4931: allow reading most config settings from file
Summary

This allows most settings to be specified in the config file.
Defaults for these are set in the config parser; config file
values override defaults, CLI argument values override both
config file and defaults.

There's a few icky little details here, but I can't find any
cleaner way to do this. It'll all be a bit more consistent when
we implement T602: I set up the config file values as if we'd
already done that, so 'compose-wait' is in the 'schedule'
section not the CLI section, but until we do implement T602,
the CLI module has to read that one in. Otherwise the general
rule is that the module methods read in the values from config
if they're passed None, and the CLI passes None if the argument
is not passed. The alternative would be to have the methods
specify their defaults as CONFIG.get(blah) and also have the CLI
arguments' defaults set as CONFIG.get(blah), which avoids the
'if blah is None:' in the methods but means we're duplicating
the 'read default value in from config' logic; it seemed kinda
a toss-up which way was 'better', I went for 'slightly ugly'
over 'duplicated'.

Of note, there isn't a config file setting for 'ifnotcurrent'
(it really feels like a CLI special-sauce option to me), and
there isn't yet a CLI argument for 'jobs-wait' (the setting
that decides how long report-results will wait for jobs to
complete).

Test Plan

Check that all commands still work and that the
defaults, config file override, and CLI override all work as
intended.

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 allow reading most config settings from file.Sep 2 2015, 9:25 PM
adamwill updated this object.
adamwill edited the test plan for this revision. (Show Details)
adamwill added reviewers: garretraziel, jskladan.
garretraziel accepted this revision.Sep 3 2015, 1:50 PM

This looks good (and seems to work OK :-)). Only nitpick is that when you have submit: false in your config file, fedora-openqa-schedule.py report XYZ doesn't report anything (that is logical behaviour, but perhaps a little bit unexpected :-)).

This revision is now accepted and ready to land.Sep 3 2015, 1:50 PM
adamwill added a comment.Sep 3 2015, 3:41 PM

It's always been possible to run the report command without submitting anything, and in fact before this commit it was the default mode for the report sub-command (and, before that, for the report-job-results.py script). One side effect of this commit is that 'submit to wiki' becomes the default for the report command, but I think that's OK, it doesn't seem too dangerous or anything. I'm guessing it used to default to false for testing and possibly to protect against dupes, before I had duplicate detection in wikitcms.

Closed by commit rOPENQAfc81dcab4931: allow reading most config settings from file (authored by adamwill). · Explain WhySep 3 2015, 8:09 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents

Diff 1445

View Options

fedora_openqa_schedule/cli.py

Show All 35 Lines
36try: 36​try:
37 import wikitcms.wiki 37​ import wikitcms.wiki
38except ImportError: 38​except ImportError:
39 wikitcms = None 39​ wikitcms = None
40 40​
41# Internal dependencies 41​# Internal dependencies
42import fedora_openqa_schedule.schedule as schedule 42​import fedora_openqa_schedule.schedule as schedule
43import fedora_openqa_schedule.report as report 43​import fedora_openqa_schedule.report as report
44​from fedora_openqa_schedule.config import CONFIG
44 45​
45logger = logging.getLogger(__name__) 46​logger = logging.getLogger(__name__)
46 47​
47### SUB-COMMAND METHODS 48​### SUB-COMMAND METHODS
48 49​
49def command_compose(args, wiki, client): 50​def command_compose(args, wiki, client):
50 """run OpenQA on a specified compose, optionally reporting 51​ """run OpenQA on a specified compose, optionally reporting
51 results if a matching wikitcms ValidationEvent is found by 52​ results if a matching wikitcms ValidationEvent is found by
▲ Show 20 Lines • Show All 64 Lines • ▼ Show 20 Line(s)
116 117​
117def command_report(args, wiki, client): 118​def command_report(args, wiki, client):
118 """Map a list of openQA job IDs to Wikitcms test results, and 119​ """Map a list of openQA job IDs to Wikitcms test results, and
119 either display the ResTups for inspection or report the 120​ either display the ResTups for inspection or report the
120 results to the wiki. 121​ results to the wiki.
121 """ 122​ """
122 try: 123​ try:
123 report.report_results( 124​ report.report_results(
124 args.jobs, client=client, wiki=wiki, report=args.report) 125​ args.jobs, client=client, wiki=wiki, report=args.submit)
125 except report.LoginError: 126​ except report.LoginError:
126 # Module logs for us, no need to dupe it. 127​ # Module logs for us, no need to dupe it.
127 sys.exit(1) 128​ sys.exit(1)
128 129​
129### ARGUMENT PARSING AND SUB-COMMAND INIT 130​### ARGUMENT PARSING AND SUB-COMMAND INIT
130 131​
131def run(): 132​def run():
132 """Read in args, set up logging, wikitcms and openQA client, and 133​ """Read in args, set up logging, wikitcms and openQA client, and
Show All 36 Lines169 parser_current = subparsers.add_parser(
169 'current', description="Run for the current event, if needed.") 170​ 'current', description="Run for the current event, if needed.")
170 parser_current.set_defaults(func=command_current) 171​ parser_current.set_defaults(func=command_current)
171 172​
172 parser_compose = subparsers.add_parser( 173​ parser_compose = subparsers.add_parser(
173 'compose', description="Run for a specific compose (TC/RC or nightly). If a matching " 174​ 'compose', description="Run for a specific compose (TC/RC or nightly). If a matching "
174 "release validation test event can be found and --submit-results is passed, results " 175​ "release validation test event can be found and --submit-results is passed, results "
175 "will be reported.") 176​ "will be reported.")
176 parser_compose.add_argument( 177​ parser_compose.add_argument(
177 '-r', '--release', type=int, required=False, choices=range(12, 100), metavar="12-99", 178​ '--release', '-r', type=int, choices=range(12, 100), metavar="12-99",
178 help="Release number of a specific compose to run against. Must be passed for " 179​ help="Release number of a specific compose to run against. Must be passed for "
179 "validation event discovery to succeed.") 180​ "validation event discovery to succeed.")
180 parser_compose.add_argument( 181​ parser_compose.add_argument(
181 '-m', '--milestone', help="The milestone to operate on (Alpha, Beta, Final, Branched, " 182​ '--milestone', '-m', help="The milestone to operate on (Alpha, Beta, Final, Branched, "
182 "Rawhide). Must be specified for a TC/RC; for a nightly, will be guessed if not " 183​ "Rawhide). Must be specified for a TC/RC; for a nightly, will be guessed if not "
183 "specified", required=False, choices=['Alpha', 'Beta', 'Final', 'Branched', 'Rawhide']) 184​ "specified", choices=['Alpha', 'Beta', 'Final', 'Branched', 'Rawhide'])
184 parser_compose.add_argument( 185​ parser_compose.add_argument(
185 '-c', '--compose', help="The version to run for; either the compose (for a TC/RC), or " 186​ '--compose', '-c', help="The version to run for; either the compose (for a TC/RC), or "
186 "the date (for a nightly build)", required=False, metavar="{T,R}C1-19 or YYYYMMDD") 187​ "the date (for a nightly build)", metavar="{T,R}C1-19 or YYYYMMDD")
187 parser_compose.add_argument( 188​ parser_compose.add_argument(
188 '-a', '--arch', help="The arch to run for", required=False, choices=('x86_64', 'i386')) 189​ '--arch', '-a', help="The arch to run for", choices=('x86_64', 'i386'))
189 parser_compose.add_argument( 190​ parser_compose.add_argument(
190 '-s', '--submit-results', help="Submit the results to the release validation event for " 191​ '--wait', '-w', help="Wait NNN minutes for the compose to appear, if it doesn't yet "
191 "this compose, if possible", required=False, action='store_true') 192​ "exist", default=CONFIG.getint('schedule', 'compose-wait'), type=int, metavar="NNN")
192 parser_compose.add_argument( 193​ parser_compose.add_argument(
193 '-w', '--wait', help="Wait NN minutes for the compose to appear, if it doesn't yet " 194​ '--ifnotcurrent', '-i', help="Only run if the compose is not the 'current' validation "
194 "exist", type=int, metavar="NN", default=0, required=False) ​
195 parser_compose.add_argument( ​
196 '-i', '--ifnotcurrent', help="Only run if the compose is not the 'current' validation " ​
197 "compose. Mainly intended for cron runs on nightly builds, to avoid duplicating jobs " 195​ "compose. Mainly intended for cron runs on nightly builds, to avoid duplicating jobs "
198 "run by a 'current' cron job. Requires wikitcms", action='store_true') 196​ "run by a 'current' cron job. Requires wikitcms", action='store_true')
199 parser_compose.set_defaults(func=command_compose) 197​ parser_compose.set_defaults(func=command_compose)
200 198​
201 parser_report = subparsers.add_parser( 199​ parser_report = subparsers.add_parser(
202 'report', description="Map openQA job results to Wikitcms test results and optionally " 200​ 'report', description="Map openQA job results to Wikitcms test results and optionally "
203 "submit them to the wiki") 201​ "submit them to the wiki")
204 parser_report.add_argument('jobs', type=int, nargs='+') 202​ parser_report.add_argument('jobs', type=int, nargs='+')
205 parser_report.add_argument('-r', '-s', '--report', '--submit-results', action='store_true', ​
206 help="Submit the results to the wiki (instead of simply displaying them)") ​
207 parser_report.set_defaults(func=command_report) 203​ parser_report.set_defaults(func=command_report)
208 204​
205​ submitgroup = parser.add_mutually_exclusive_group()
206​ submitgroup.add_argument('--submit', '-s', '--submit-results', action='store_true',
207​ dest="submit", help="Where appropriate, submit results to the wiki")
208​ submitgroup.add_argument('--no-submit', '-ns', '--no-submit-results', action='store_false',
209​ dest="submit", help="Do not submit results to the wiki")
210​ # This will result in getting the 'submit' value from config file
211​ # if not explicitly specified, overriding the implied defaults of
212​ # store_true and store_false
213​ parser.set_defaults(submit=None)
214​
209 parser.add_argument( 215​ parser.add_argument(
210 '-t', '--test', help=test_help, required=False, action='store_true') 216​ '--test', '-t', help=test_help, action='store_true')
211 parser.add_argument( 217​ parser.add_argument(
212 '-f', '--log-file', help="If given, log into specified file. When not provided, stdout" 218​ '--log-file', '-f', help="If given, log into specified file. When not provided, stdout"
213 " is used", required=False) 219​ " is used", default=CONFIG.get('cli', 'log-file'))
214 parser.add_argument( 220​ parser.add_argument(
215 '-l', '--log-level', help="Specify log level to be outputted", 221​ '--log-level', '-l', help="Specify log level to be outputted",
216 choices=('debug', 'info', 'warning', 'error', 'critical'), default='info') 222​ choices=('debug', 'info', 'warning', 'error', 'critical'),
223​ default=CONFIG.get('cli', 'log-level'))
217 224​
218 return parser.parse_args() 225​ return parser.parse_args()
219 226​
220def main(): 227​def main():
221 """Main loop.""" 228​ """Main loop."""
222 try: 229​ try:
223 run() 230​ run()
224 except KeyboardInterrupt: 231​ except KeyboardInterrupt:
225 sys.stderr.write("Interrupted, exiting...\n") 232​ sys.stderr.write("Interrupted, exiting...\n")
226 sys.exit(1) 233​ sys.exit(1)
227 234​
228if __name__ == '__main__': 235​if __name__ == '__main__':
229 main() 236​ main()
View Options

fedora_openqa_schedule/config.py

Show All 20 Lines
21 21​
22# Standard libraries 22​# Standard libraries
23import os.path 23​import os.path
24 24​
25# External dependencies 25​# External dependencies
26from six.moves import configparser 26​from six.moves import configparser
27 27​
28# Read in config from /etc/fedora-openqa/schedule.conf or 28​# Read in config from /etc/fedora-openqa/schedule.conf or
29# ~/.config/fedora-openqa/schedule.conf after setting a default value 29​# ~/.config/fedora-openqa/schedule.conf after setting some default
30# for iso_path. 30​# values.
31CONFIG = configparser.ConfigParser() 31​CONFIG = configparser.ConfigParser()
32​CONFIG.add_section('cli')
33​CONFIG.add_section('report')
32CONFIG.add_section('schedule') 34​CONFIG.add_section('schedule')
33CONFIG.set('schedule', 'iso_path', '/var/lib/openqa/factory/iso/') 35​CONFIG.set('cli', 'log-file', '')
36​CONFIG.set('cli', 'log-level', 'info')
37​CONFIG.set('report', 'submit', 'true')
38​CONFIG.set('report', 'jobs-wait', '360')
39​CONFIG.set('schedule', 'iso-path', '/var/lib/openqa/factory/iso/')
40​CONFIG.set('schedule', 'compose-wait', '480')
34CONFIG.read('/etc/fedora-openqa/schedule.conf') 41​CONFIG.read('/etc/fedora-openqa/schedule.conf')
35CONFIG.read('{0}/.config/fedora-openqa/schedule.conf'.format(os.path.expanduser('~'))) 42​CONFIG.read('{0}/.config/fedora-openqa/schedule.conf'.format(os.path.expanduser('~')))
View Options

fedora_openqa_schedule/report.py

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

fedora_openqa_schedule/schedule.py

Show All 35 Lines
36# Internal dependencies 36​# Internal dependencies
37from fedora_openqa_schedule.config import CONFIG 37​from fedora_openqa_schedule.config import CONFIG
38 38​
39logger = logging.getLogger(__name__) 39​logger = logging.getLogger(__name__)
40 40​
41PERSISTENT = "/var/tmp/openqa_watcher.json" 41​PERSISTENT = "/var/tmp/openqa_watcher.json"
42ARCHES = ['x86_64', 'i386'] 42​ARCHES = ['x86_64', 'i386']
43# Default value is '/var/lib/openqa/factory/iso/' 43​# Default value is '/var/lib/openqa/factory/iso/'
44ISO_PATH = CONFIG.get('schedule', 'iso_path') 44​ISO_PATH = CONFIG.get('schedule', 'iso-path')
45 45​
46class TriggerException(Exception): 46​class TriggerException(Exception):
47 pass 47​ pass
48 48​
49def read_last(): 49​def read_last():
50 """Read last tested version from file.""" 50​ """Read last tested version from file."""
51 logger.debug("reading latest checked version from %s", PERSISTENT) 51​ logger.debug("reading latest checked version from %s", PERSISTENT)
52 result = {} 52​ result = {}
▲ Show 20 Lines • Show All 168 Lines • Show Last 20 Lines
View Options

schedule.conf.sample

  • This file was added.
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
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
5​# config indicate the defaults.
6​
7​[cli]
8​# File to log to (if not set, will log to stdout)
9​log-file:
10​
11​# Logging level (debug, info, warning, error, critical)
12​log-level: info
13​
14​[report]
15​# Whether to submit results to the Wiki (if false, just log them)
16​submit: true
17​
18​# Minutes to wait for openQA jobs to be complete (0 means 'do not wait')
19​wait-jobs: 360
20​
21​[schedule]
22​# Where to download ISOs (should be the directory openQA will look in)
23​iso-path: /var/lib/openqa/factory/iso/
24​
25​# Minutes to wait for the compose to be complete, when scheduling jobs for a
26​# specific compose. 'current' never waits.
27​compose-wait: 480