Differential D879

taskotron_result tool added
ClosedPublic
Actions

Authored by lbrabec on Jun 2 2016, 12:14 PM.

Details

Reviewers
kparal
tflink
mkrizek
jskladan
Maniphest Tasks
T754: Find a Test Runner for Docker Images
Commits
rLTRN7a998b0049ab: taskotron_result tool added
Summary

Based on D842 + tests + specfile fix

Test Plan

py.test -F testing

Diff Detail

Repository
rLTRN libtaskotron
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
lbrabec retitled this revision from to taskotron_result tool added.Jun 2 2016, 12:14 PM
lbrabec updated this object.
lbrabec edited the test plan for this revision. (Show Details)
lbrabec added reviewers: tflink, jskladan, mkrizek, kparal.
jskladan accepted this revision.Jun 27 2016, 1:53 PM
This revision is now accepted and ready to land.Jun 27 2016, 1:53 PM
Closed by commit rLTRN7a998b0049ab: taskotron_result tool added (authored by Lukas Brabec <lbrabec@redhat.com>). · Explain WhyJun 29 2016, 10:54 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathPackages
Mlibtaskotron.spec (4 lines)
AMlibtaskotron/taskotron_result.py (66 lines)
Msetup.py (3 lines)
AMtesting/test_taskotron_result.py (78 lines)

Diff 2322

View Options

libtaskotron.spec

Show All 23 Lines
24 24​
25Requires: libtaskotron-config = %{version}-%{release} 25​Requires: libtaskotron-config = %{version}-%{release}
26Requires: python-configparser >= 3.5.0b2 26​Requires: python-configparser >= 3.5.0b2
27Requires: python-jinja2 >= 2.8 27​Requires: python-jinja2 >= 2.8
28Requires: python-progressbar >= 2.3 28​Requires: python-progressbar >= 2.3
29Requires: python-resultsdb_api >= 1.2.1 29​Requires: python-resultsdb_api >= 1.2.1
30Requires: python-requests >= 2.7.0 30​Requires: python-requests >= 2.7.0
31Requires: python-setuptools 31​Requires: python-setuptools
32Requires: python2-xunitparser >= 1.3.3 32​Requires: python-xunitparser >= 1.3.3
33Requires: PyYAML >= 3.11 33​Requires: PyYAML >= 3.11
34BuildRequires: pytest >= 2.7.3 34​BuildRequires: pytest >= 2.7.3
35BuildRequires: python2-devel 35​BuildRequires: python2-devel
36BuildRequires: python-configparser >= 3.5.0b2 36​BuildRequires: python-configparser >= 3.5.0b2
37BuildRequires: python-dingus >= 0.3.4 37​BuildRequires: python-dingus >= 0.3.4
38BuildRequires: python-mock >= 1.0.1 38​BuildRequires: python-mock >= 1.0.1
39BuildRequires: python-progressbar >= 2.3 39​BuildRequires: python-progressbar >= 2.3
40BuildRequires: python-resultsdb_api >= 1.2.1 40​BuildRequires: python-resultsdb_api >= 1.2.1
41BuildRequires: python-requests >= 2.7.0 41​BuildRequires: python-requests >= 2.7.0
42BuildRequires: python-setuptools 42​BuildRequires: python-setuptools
43​BuildRequires: python-xunitparser >= 1.3.3
43BuildRequires: PyYAML >= 3.11 44​BuildRequires: PyYAML >= 3.11
44 45​
45%description -n libtaskotron-core 46​%description -n libtaskotron-core
46The minimal, core parts of libtaskotron that are needed to run tasks 47​The minimal, core parts of libtaskotron that are needed to run tasks
47 48​
48%package -n libtaskotron-config 49​%package -n libtaskotron-config
49Summary: Configuration files needed for using libtaskotron 50​Summary: Configuration files needed for using libtaskotron
50 51​
▲ Show 20 Lines • Show All 84 Lines • ▼ Show 20 Line(s)
135%{python2_sitelib}/*.egg-info 136​%{python2_sitelib}/*.egg-info
136 137​
137%dir %{python2_sitelib}/libtaskotron/ext/fedora 138​%dir %{python2_sitelib}/libtaskotron/ext/fedora
138%dir %{python2_sitelib}/libtaskotron/ext 139​%dir %{python2_sitelib}/libtaskotron/ext
139%dir %{python2_sitelib}/libtaskotron/directives 140​%dir %{python2_sitelib}/libtaskotron/directives
140%dir %{python2_sitelib}/libtaskotron/report_templates 141​%dir %{python2_sitelib}/libtaskotron/report_templates
141 142​
142%attr(755, root, root) %{_bindir}/runtask 143​%attr(755, root, root) %{_bindir}/runtask
144​%attr(755, root, root) %{_bindir}/taskotron_result
143 145​
144%dir %attr(2775, root, taskotron) %{_tmppath}/taskotron 146​%dir %attr(2775, root, taskotron) %{_tmppath}/taskotron
145%dir %attr(2775, root, taskotron) %{_localstatedir}/log/taskotron 147​%dir %attr(2775, root, taskotron) %{_localstatedir}/log/taskotron
146%dir %attr(2775, root, taskotron) %{_localstatedir}/cache/taskotron 148​%dir %attr(2775, root, taskotron) %{_localstatedir}/cache/taskotron
147%dir %attr(2775, root, taskotron) %{_sharedstatedir}/taskotron 149​%dir %attr(2775, root, taskotron) %{_sharedstatedir}/taskotron
148%dir %attr(2775, root, taskotron) %{_sharedstatedir}/taskotron/artifacts 150​%dir %attr(2775, root, taskotron) %{_sharedstatedir}/taskotron/artifacts
149%dir %attr(2775, root, taskotron) %{_sharedstatedir}/taskotron/images 151​%dir %attr(2775, root, taskotron) %{_sharedstatedir}/taskotron/images
150 152​
▲ Show 20 Lines • Show All 233 Lines • Show Last 20 Lines
View Options

libtaskotron/taskotron_result.py

  • This file was added.
1​#!/usr/bin/env python
2​
3​from libtaskotron.check import CheckDetail, export_YAML, import_YAML
4​import argparse
5​import os
6​
7​
8​def get_argparser():
9​ parser = argparse.ArgumentParser(description="This tool serves a purpose of generating "
10​ "results from within a bash script. Results are "
11​ "stored into output file in ResultsYAML format. "
12​ "Each consecutive run of this tool will append "
13​ "new results to specified file.")
14​
15​ parser.add_argument("-f", "--file", help="output file", required=True)
16​ parser.add_argument("-i", "--item", help="item to be checked", required=True)
17​ parser.add_argument("-t", "--report_type", help="type of --item", required=True)
18​ parser.add_argument("-o", "--outcome", help="final outcome of check", required=True)
19​ parser.add_argument("-n", "--note", help="a few words or one-sentence note about the result",
20​ default="")
21​ parser.add_argument("-k", "--keyval", action="append", default=[], metavar='KEY=VALUE',
22​ help="all key-value pairs in this dictionary are stored "
23​ "in ResultsDB as 'extra data'")
24​ parser.add_argument("-c", "--checkname", help="name of the check", default=None)
25​ parser.add_argument("-a", "--artifact", help="file or directory placed in the artifacts dir",
26​ default=None)
27​
28​ return parser
29​
30​
31​def main():
32​
33​ parser = get_argparser()
34​
35​ args = vars(parser.parse_args())
36​
37​ output_file = args.pop('file')
38​
39​ # parse additional key=value pairs
40​ keyvals = {}
41​ for var in args['keyval']:
42​ key, value = var.split('=', 1)
43​ keyvals[key] = value
44​ args['keyvals'] = keyvals
45​ args.pop('keyval')
46​
47​ detail = CheckDetail(**args)
48​
49​ if os.path.isfile(output_file):
50​ # if output file exists, parse its content and append new detail to it
51​ f = open(output_file, 'r+')
52​ yaml = f.read()
53​ details = import_YAML(yaml) if yaml else []
54​ details.append(detail)
55​ f.seek(0)
56​ f.write(export_YAML(details))
57​ f.close()
58​ else:
59​ # if output file doesn't exist, create it
60​ f = open(output_file, 'w')
61​ f.write(export_YAML([detail]))
62​ f.close()
63​
64​
65​if __name__ == "__main__":
66​ main()
View Options

setup.py

Show All 37 Lines33setup(name='libtaskotron',
38 license='GPLv2+', 38​ license='GPLv2+',
39 url='https://bitbucket.org/fedoraqa/libtaskotron', 39​ url='https://bitbucket.org/fedoraqa/libtaskotron',
40 packages=['libtaskotron', 'libtaskotron.directives', 'libtaskotron.ext', 40​ packages=['libtaskotron', 'libtaskotron.directives', 'libtaskotron.ext',
41 'libtaskotron.ext.fedora', 'libtaskotron.ext.disposable'], 41​ 'libtaskotron.ext.fedora', 'libtaskotron.ext.disposable'],
42 package_data={'libtaskotron': ['report_templates/*.j2']}, 42​ package_data={'libtaskotron': ['report_templates/*.j2']},
43 package_dir={'libtaskotron':'libtaskotron'}, 43​ package_dir={'libtaskotron':'libtaskotron'},
44 include_package_data=True, 44​ include_package_data=True,
45 cmdclass={'test': PyTest}, 45​ cmdclass={'test': PyTest},
46 entry_points=dict(console_scripts=['runtask=libtaskotron.main:main']), 46​ entry_points=dict(console_scripts=['runtask=libtaskotron.main:main',
47​ 'taskotron_result=libtaskotron.taskotron_result:main']),
47 install_requires = [ 48​ install_requires = [
48 'PyYAML', 49​ 'PyYAML',
49 ] 50​ ]
50) 51​)
View Options

testing/test_taskotron_result.py

  • This file was added.
1​# -*- coding: utf-8 -*-
2​# Copyright 2009-2014, Red Hat, Inc.
3​# License: GPL-2.0+ <http://spdx.org/licenses/GPL-2.0+>
4​# See the LICENSE file for more details on Licensing
5​
6​from libtaskotron import taskotron_result
7​from libtaskotron.check import CheckDetail, export_YAML, import_YAML
8​import mock
9​import os
10​
11​OUTPUT = ""
12​
13​FILE = """results:
14​- item: punkipa
15​ outcome: PASSED
16​ type: beer
17​"""
18​
19​
20​def save_output(str):
21​ global OUTPUT
22​ OUTPUT = str
23​
24​
25​class TestTaskotronResult(object):
26​ def test_empty_run(self, monkeypatch):
27​ test_args = mock.MagicMock()
28​ test_args.__dict__ = {'file': 'somefile', 'report_type': 'beer', 'item': 'punkipa',
29​ 'keyval': [], 'outcome': 'PASSED'}
30​ stub_parser = mock.MagicMock()
31​ stub_parser.parse_args = mock.MagicMock(return_value=test_args)
32​ stub_get_argparser = mock.MagicMock(return_value=stub_parser)
33​ monkeypatch.setattr(taskotron_result, 'get_argparser', stub_get_argparser)
34​
35​ stub_file = mock.MagicMock()
36​ stub_file.write = save_output
37​
38​ with mock.patch('__builtin__.open', mock.MagicMock(return_value=stub_file), create=True):
39​ taskotron_result.main()
40​
41​ assert OUTPUT == export_YAML(CheckDetail(**vars(test_args)))
42​
43​ def test_nonempty_run(self, monkeypatch):
44​ test_args = mock.MagicMock()
45​ test_args.__dict__ = {'file': 'somefile', 'report_type': 'beer', 'item': 'punkipa',
46​ 'keyval': [], 'outcome': 'PASSED'}
47​ stub_parser = mock.MagicMock()
48​ stub_parser.parse_args = mock.MagicMock(return_value=test_args)
49​ stub_get_argparser = mock.MagicMock(return_value=stub_parser)
50​ monkeypatch.setattr(taskotron_result, 'get_argparser', stub_get_argparser)
51​
52​ stub_file = mock.MagicMock()
53​ stub_file.write = save_output
54​ stub_file.read = lambda: FILE
55​
56​ monkeypatch.setattr(os.path, 'isfile', mock.MagicMock(return_value=True))
57​
58​ with mock.patch('__builtin__.open', mock.MagicMock(return_value=stub_file), create=True):
59​ taskotron_result.main()
60​
61​ assert OUTPUT == export_YAML(import_YAML(FILE)+[CheckDetail(**vars(test_args))])
62​
63​ def test_keyval_parse(self, monkeypatch):
64​ test_args = mock.MagicMock()
65​ test_args.__dict__ = {'file': 'somefile', 'report_type': 'beer', 'item': 'punkipa',
66​ 'keyval': ['hop=Simcoe'], 'outcome': 'PASSED'}
67​ stub_parser = mock.MagicMock()
68​ stub_parser.parse_args = mock.MagicMock(return_value=test_args)
69​ stub_get_argparser = mock.MagicMock(return_value=stub_parser)
70​ monkeypatch.setattr(taskotron_result, 'get_argparser', stub_get_argparser)
71​
72​ stub_file = mock.MagicMock()
73​ stub_file.write = save_output
74​
75​ with mock.patch('__builtin__.open', mock.MagicMock(return_value=stub_file), create=True):
76​ taskotron_result.main()
77​
78​ assert OUTPUT == export_YAML(CheckDetail(**vars(test_args)))