Differential D182

python_directive: add debug information about executed method
ClosedPublic
Actions

Authored by kparal on Jul 4 2014, 2:31 PM.

Details

Reviewers
tflink
mkrizek
jskladan
Commits
rLTRN122ba668d1c8: python_directive: add debug information about executed method
Summary

This helps users to identify what exactly just got executed with what
arguments. It also helps with long-running python scripts without output

  • at least you know what's happening.

New output in rpmlint:

[libtaskotron:runner.py:100] 2014-07-04 15:38:56 DEBUG   Executing directive: python
[libtaskotron:python_directive.py:154] 2014-07-04 15:38:56 INFO    Executing Python: run_rpmlint.run() with args {'workdir': '/var/tmp/taskotron/task-9opm90'}
[libtaskotron:runner.py:100] 2014-07-04 15:38:59 DEBUG   Executing directive: resultsdb
[libtaskotron:resultsdb_directive.py:167] 2014-07-04 15:38:59 INFO    TAP is OK.

in upgradepath:

[libtaskotron:runner.py:41] 2014-07-04 15:38:44 DEBUG   Current workdir: /var/tmp/taskotron/task-QVeRAO
[libtaskotron:runner.py:100] 2014-07-04 15:38:44 DEBUG   Executing directive: python
[libtaskotron:python_directive.py:154] 2014-07-04 15:38:44 INFO    Executing Python: upgradepath.main() with args {'custom_args': ['--debug', 'f20-updates']}

in depcheck:

[libtaskotron:runner.py:100] 2014-07-04 15:43:16 DEBUG   Executing directive: python
[libtaskotron:python_directive.py:154] 2014-07-04 15:43:16 INFO    Executing Python: run_depcheck.taskotron_run() with args {'workdir': '/var/tmp/taskotron/task-jSwItD', 'report_format': 'updates', 'rpms': ['/var/tmp/taskotron/task-jSwItD/downloaded_tag/'], 'arch': ['x86_64'], 'repos': [{'f19': 'http://download.fedoraproject.org/pub/fedora/linux/releases/19/Everything/x86_64/os', 'f19-updates': 'http://download.fedoraproject.org/pub/fedora/linux/updates/19/x86_64'}, {'workdir_repo': '/var/tmp/taskotron/task-jSwItD/downloaded_tag/'}]}
running depcheck for /var/tmp/taskotron/task-jSwItD/downloaded_tag/sylpheed-3.4.2-1.fc19.x86_64.rpm
running depcheck for /var/tmp/taskotron/task-jSwItD/downloaded_tag/pcre-8.32-9.fc19.i686.rpm

I wondered a bit whether I should use INFO or DEBUG level for it. In the end I assumed INFO is better, because it can potentially be long-running and without output (from the python script), so it falls into the category "inform user what's going on".

Test Plan

unit tests adjusted, manually ran our major checks

Diff Detail

Repository
rLTRN libtaskotron
Lint
Lint Skipped
Unit
Unit Tests Skipped
kparal retitled this revision from to python_directive: add debug information about executed method.Jul 4 2014, 2:31 PM
kparal updated this object.
kparal edited the test plan for this revision. (Show Details)
kparal added reviewers: tflink, jskladan, mkrizek.
This revision is now accepted and ready to land.Jul 8 2014, 12:53 PM
kparal closed this revision.Jul 8 2014, 12:59 PM
kparal updated this revision to Diff 537.

Closed by commit rLTRN122ba668d1c8 (authored by @kparal).

Revision Contents

Diff 537

View Options

libtaskotron/directives/python_directive.py

Show First 20 Lines • Show All 110 Lines • ▼ Show 20 Line(s)110 class EmbeddedCallClass(object):
111 def __call__(self, some, args): 111​ def __call__(self, some, args):
112 return "I'm a __call__ method in a class!" 112​ return "I'm a __call__ method in a class!"
113 113​
114 do_this_thing = EmbeddedCallClass() 114​ do_this_thing = EmbeddedCallClass()
115""" 115​"""
116 116​
117import imp 117​import imp
118import os 118​import os
119​import re
119 120​
120from libtaskotron.directives import BaseDirective 121​from libtaskotron.directives import BaseDirective
121from libtaskotron.exceptions import TaskotronDirectiveError 122​from libtaskotron.exceptions import TaskotronDirectiveError
123​from libtaskotron.logger import log
122 124​
123directive_class = 'PythonDirective' 125​directive_class = 'PythonDirective'
124 126​
125class PythonDirective(BaseDirective): 127​class PythonDirective(BaseDirective):
126 128​
127 def _do_getattr(self, module, name): 129​ def _do_getattr(self, module, name):
128 """Isolation of getattr to make the code more easily testable 130​ """Isolation of getattr to make the code more easily testable
129 131​
Show All 12 Lines139 def execute(self, task_module, method_name, kwargs):
142 :param dict kwargs: kwargs to pass as parameters into the callable 144​ :param dict kwargs: kwargs to pass as parameters into the callable
143 :returns: output from the executed method 145​ :returns: output from the executed method
144 :raise TaskotronDirectiveError: if the callable returns something else 146​ :raise TaskotronDirectiveError: if the callable returns something else
145 than ``None`` or ``basestring`` 147​ than ``None`` or ``basestring``
146 """ 148​ """
147 149​
148 task_method = self._do_getattr(task_module, method_name) 150​ task_method = self._do_getattr(task_module, method_name)
149 151​
152​ module = re.sub('.py[co]?$', '', os.path.basename(task_module.__file__))
153​ log.info("Executing Python: %s.%s() with args %s", module, method_name,
154​ kwargs)
150 output = task_method(**kwargs) 155​ output = task_method(**kwargs)
151 156​
152 if output is not None and not isinstance(output, basestring): 157​ if output is not None and not isinstance(output, basestring):
153 raise TaskotronDirectiveError( 158​ raise TaskotronDirectiveError(
154 "Callable task method must return string or None, actual " 159​ "Callable task method must return string or None, actual "
155 "returned type: %s" % type(output)) 160​ "returned type: %s" % type(output))
156 161​
157 return output 162​ return output
▲ Show 20 Lines • Show All 54 Lines • Show Last 20 Lines
View Options

testing/test_python_directive.py

Show First 20 Lines • Show All 51 Lines • ▼ Show 20 Line(s)
52class TestExecutePyfile(object): 52​class TestExecutePyfile(object):
53 53​
54 def test_task_method_is_found(self, monkeypatch): 54​ def test_task_method_is_found(self, monkeypatch):
55 ref_modulename = 'foo' 55​ ref_modulename = 'foo'
56 ref_methodname = 'bar' 56​ ref_methodname = 'bar'
57 ref_kwargs = {'baz': 'why', 'blah': 2} 57​ ref_kwargs = {'baz': 'why', 'blah': 2}
58 58​
59 stub_getattr = Dingus(return_value=lambda baz, blah: "str") 59​ stub_getattr = Dingus(return_value=lambda baz, blah: "str")
60​ stub_module = Dingus(__file__=ref_modulename)
60 61​
61 test_directive = python_directive.PythonDirective() 62​ test_directive = python_directive.PythonDirective()
62 monkeypatch.setattr(test_directive, '_do_getattr', stub_getattr) 63​ monkeypatch.setattr(test_directive, '_do_getattr', stub_getattr)
63 64​
64 test_directive.execute(ref_modulename, ref_methodname, ref_kwargs) 65​ test_directive.execute(stub_module, ref_methodname, ref_kwargs)
65 66​
66 assert (stub_getattr.calls()[0].name, stub_getattr.calls()[0].args) == ( 67​ assert (stub_getattr.calls()[0].name, stub_getattr.calls()[0].args) == (
67 '()', (ref_modulename, ref_methodname)) 68​ '()', (stub_module, ref_methodname))
68 69​
69 def test_task_method_is_executed(self, monkeypatch): 70​ def test_task_method_is_executed(self, monkeypatch):
70 ref_modulename = 'foo' 71​ ref_modulename = 'foo'
71 ref_methodname = 'bar' 72​ ref_methodname = 'bar'
72 ref_kwargs = {'baz': 'why', 'blah': 2} 73​ ref_kwargs = {'baz': 'why', 'blah': 2}
73 74​
74 stub_task = Dingus(return_value="str") 75​ stub_task = Dingus(return_value="str")
75 stub_getattr = Dingus(return_value=stub_task) 76​ stub_getattr = Dingus(return_value=stub_task)
77​ stub_module = Dingus(__file__=ref_modulename)
76 78​
77 test_directive = python_directive.PythonDirective() 79​ test_directive = python_directive.PythonDirective()
78 monkeypatch.setattr(test_directive, '_do_getattr', stub_getattr) 80​ monkeypatch.setattr(test_directive, '_do_getattr', stub_getattr)
79 81​
80 test_directive.execute(ref_modulename, ref_methodname, ref_kwargs) 82​ test_directive.execute(stub_module, ref_methodname, ref_kwargs)
81 83​
82 assert (stub_task.calls()[0].name, stub_task.calls()[0].args, 84​ assert (stub_task.calls()[0].name, stub_task.calls()[0].args,
83 stub_task.calls()[0].kwargs) == ('()', (), ref_kwargs) 85​ stub_task.calls()[0].kwargs) == ('()', (), ref_kwargs)
84 86​
85 87​
86class TestPyfileOutputException(object): 88​class TestPyfileOutputException(object):
87 89​
88 def test_task_doesnt_rise_on_unicode_str(self, monkeypatch): 90​ def test_task_doesnt_rise_on_unicode_str(self, monkeypatch):
89 ref_modulename = 'foo' 91​ ref_modulename = 'foo'
90 ref_methodname = 'bar' 92​ ref_methodname = 'bar'
91 ref_kwargs = {'baz': 'why', 'blah': 2} 93​ ref_kwargs = {'baz': 'why', 'blah': 2}
92 94​
93 stub_task = Dingus(return_value=u"unicode") 95​ stub_task = Dingus(return_value=u"unicode")
94 stub_getattr = Dingus(return_value=stub_task) 96​ stub_getattr = Dingus(return_value=stub_task)
97​ stub_module = Dingus(__file__=ref_modulename)
95 98​
96 test_directive = python_directive.PythonDirective() 99​ test_directive = python_directive.PythonDirective()
97 monkeypatch.setattr(test_directive, '_do_getattr', stub_getattr) 100​ monkeypatch.setattr(test_directive, '_do_getattr', stub_getattr)
98 101​
99 test_directive.execute(ref_modulename, ref_methodname, ref_kwargs) 102​ test_directive.execute(stub_module, ref_methodname, ref_kwargs)
100 103​
101 assert (stub_task.calls()[0].name, stub_task.calls()[0].args, 104​ assert (stub_task.calls()[0].name, stub_task.calls()[0].args,
102 stub_task.calls()[0].kwargs) == ('()', (), ref_kwargs) 105​ stub_task.calls()[0].kwargs) == ('()', (), ref_kwargs)
103 106​
104 def test_task_doesnt_rise_on_empty_str(self, monkeypatch): 107​ def test_task_doesnt_rise_on_empty_str(self, monkeypatch):
105 ref_modulename = 'foo' 108​ ref_modulename = 'foo'
106 ref_methodname = 'bar' 109​ ref_methodname = 'bar'
107 ref_kwargs = {'baz': 'why', 'blah': 2} 110​ ref_kwargs = {'baz': 'why', 'blah': 2}
108 111​
109 stub_task = Dingus(return_value="") 112​ stub_task = Dingus(return_value="")
110 stub_getattr = Dingus(return_value=stub_task) 113​ stub_getattr = Dingus(return_value=stub_task)
114​ stub_module = Dingus(__file__=ref_modulename)
111 115​
112 test_directive = python_directive.PythonDirective() 116​ test_directive = python_directive.PythonDirective()
113 monkeypatch.setattr(test_directive, '_do_getattr', stub_getattr) 117​ monkeypatch.setattr(test_directive, '_do_getattr', stub_getattr)
114 118​
115 test_directive.execute(ref_modulename, ref_methodname, ref_kwargs) 119​ test_directive.execute(stub_module, ref_methodname, ref_kwargs)
116 120​
117 assert (stub_task.calls()[0].name, stub_task.calls()[0].args, 121​ assert (stub_task.calls()[0].name, stub_task.calls()[0].args,
118 stub_task.calls()[0].kwargs) == ('()', (), ref_kwargs) 122​ stub_task.calls()[0].kwargs) == ('()', (), ref_kwargs)
119 123​
120 def test_task_doesnt_rise_on_none(self, monkeypatch): 124​ def test_task_doesnt_rise_on_none(self, monkeypatch):
121 ref_modulename = 'foo' 125​ ref_modulename = 'foo'
122 ref_methodname = 'bar' 126​ ref_methodname = 'bar'
123 ref_kwargs = {'baz': 'why', 'blah': 2} 127​ ref_kwargs = {'baz': 'why', 'blah': 2}
124 128​
125 stub_task = Dingus(return_value=None) 129​ stub_task = Dingus(return_value=None)
126 stub_getattr = Dingus(return_value=stub_task) 130​ stub_getattr = Dingus(return_value=stub_task)
131​ stub_module = Dingus(__file__=ref_modulename)
127 132​
128 test_directive = python_directive.PythonDirective() 133​ test_directive = python_directive.PythonDirective()
129 monkeypatch.setattr(test_directive, '_do_getattr', stub_getattr) 134​ monkeypatch.setattr(test_directive, '_do_getattr', stub_getattr)
130 135​
131 test_directive.execute(ref_modulename, ref_methodname, ref_kwargs) 136​ test_directive.execute(stub_module, ref_methodname, ref_kwargs)
132 137​
133 assert (stub_task.calls()[0].name, stub_task.calls()[0].args, 138​ assert (stub_task.calls()[0].name, stub_task.calls()[0].args,
134 stub_task.calls()[0].kwargs) == ('()', (), ref_kwargs) 139​ stub_task.calls()[0].kwargs) == ('()', (), ref_kwargs)
135 140​
136 def test_task_rises_on_empty_list(self, monkeypatch): 141​ def test_task_rises_on_empty_list(self, monkeypatch):
137 ref_modulename = 'foo' 142​ ref_modulename = 'foo'
138 ref_methodname = 'bar' 143​ ref_methodname = 'bar'
139 ref_kwargs = {'baz': 'why', 'blah': 2} 144​ ref_kwargs = {'baz': 'why', 'blah': 2}
140 145​
141 stub_task = Dingus(return_value=[]) 146​ stub_task = Dingus(return_value=[])
142 stub_getattr = Dingus(return_value=stub_task) 147​ stub_getattr = Dingus(return_value=stub_task)
148​ stub_module = Dingus(__file__=ref_modulename)
143 149​
144 test_directive = python_directive.PythonDirective() 150​ test_directive = python_directive.PythonDirective()
145 monkeypatch.setattr(test_directive, '_do_getattr', stub_getattr) 151​ monkeypatch.setattr(test_directive, '_do_getattr', stub_getattr)
146 152​
147 with pytest.raises(TaskotronDirectiveError): 153​ with pytest.raises(TaskotronDirectiveError):
148 test_directive.execute(ref_modulename, ref_methodname, ref_kwargs) 154​ test_directive.execute(stub_module, ref_methodname, ref_kwargs)
149 155​
150 def test_task_rises_on_wrong_type(self, monkeypatch): 156​ def test_task_rises_on_wrong_type(self, monkeypatch):
151 ref_modulename = 'foo' 157​ ref_modulename = 'foo'
152 ref_methodname = 'bar' 158​ ref_methodname = 'bar'
153 ref_kwargs = {'baz': 'why', 'blah': 2} 159​ ref_kwargs = {'baz': 'why', 'blah': 2}
154 160​
155 stub_task = Dingus(return_value={'han': 'shot', 'first': True}) 161​ stub_task = Dingus(return_value={'han': 'shot', 'first': True})
156 stub_getattr = Dingus(return_value=stub_task) 162​ stub_getattr = Dingus(return_value=stub_task)
163​ stub_module = Dingus(__file__=ref_modulename)
157 164​
158 test_directive = python_directive.PythonDirective() 165​ test_directive = python_directive.PythonDirective()
159 monkeypatch.setattr(test_directive, '_do_getattr', stub_getattr) 166​ monkeypatch.setattr(test_directive, '_do_getattr', stub_getattr)
160 167​
161 with pytest.raises(TaskotronDirectiveError): 168​ with pytest.raises(TaskotronDirectiveError):
162 test_directive.execute(ref_modulename, ref_methodname, ref_kwargs) 169​ test_directive.execute(stub_module, ref_methodname, ref_kwargs)
163 170​
164 171​
165class TestProcess(object): 172​class TestProcess(object):
166 173​
167 def setup_method(self, method): 174​ def setup_method(self, method):
168 175​
169 self.ref_taskyaml = '/path/to/foo/footask.yml' 176​ self.ref_taskyaml = '/path/to/foo/footask.yml'
170 self.ref_input = {'file': 'foo.py', 'callable': 'bar', 'kwarg1': 'baz'} 177​ self.ref_input = {'file': 'foo.py', 'callable': 'bar', 'kwarg1': 'baz'}
▲ Show 20 Lines • Show All 60 Lines • Show Last 20 Lines