Differential D150

T143 - Add possibility to set checkname on TAP export
ClosedPublic
Actions

Authored by tflink on Jun 23 2014, 12:58 PM.

Details

Reviewers
kparal
jskladan
Maniphest Tasks
T143: Use actual task/check name instead of $CHECKNAME in CheckDetail TAP output
Commits
rLTRN3859e975d3d4: T143 - Add possibility to set checkname on TAP export
Summary

Adds a parameter to export_TAP() method, which can override the default $CHECKNAME value.
Consider this a hotfix for T143.

Test Plan

Unittest included and working.

Diff Detail

Repository
rLTRN libtaskotron
Lint
Lint Skipped
Unit
Unit Tests Skipped
jskladan retitled this revision from to T143 - Add possibility to set checkname on TAP export.Jun 23 2014, 12:58 PM
jskladan updated this object.
jskladan edited the test plan for this revision. (Show Details)
jskladan added reviewers: tflink, kparal.
jskladan added a subscriber: mkrizek.
tflink accepted this revision.Jun 23 2014, 1:01 PM

This works for me as a temporary solution

This revision is now accepted and ready to land.Jun 23 2014, 1:01 PM
kparal accepted this revision.Jun 23 2014, 1:26 PM

Until we resolve D130, this is probably the best approach.

libtaskotron/check.py
250

I guess you wanted to put str inside the tag, to specify parameter type.

:param str checkname: the name of the executed check
tflink commandeered this revision.Jun 23 2014, 1:53 PM
tflink edited reviewers, added: jskladan; removed: tflink.

I want to get this pushed today, so I'm commandeering for the fix that @kparal mentioned

tflink updated this revision to Diff 443.Jun 23 2014, 1:53 PM
  • fixing sphinx comment from review
tflink updated this revision to Diff 444.Jun 23 2014, 1:56 PM
  • fixing description of checkname argument that was missed in last commit
tflink closed this revision.Jun 23 2014, 2:00 PM
tflink updated this revision to Diff 445.

Closed by commit rLTRN3859e975d3d4 (authored by @jskladan, committed by @tflink).

Revision Contents

PathPackages
Mlibtaskotron/check.py (5 lines)
Mtesting/test_check.py (10 lines)

Diff 445

View Options

libtaskotron/check.py

Show First 20 Lines • Show All 232 Lines • ▼ Show 20 Line(s)
233class ReportType(object): 233​class ReportType(object):
234 ''' Enum for different types of :attr:`CheckDetail.report_type`''' 234​ ''' Enum for different types of :attr:`CheckDetail.report_type`'''
235 # the values are used as identifiers in a TAP export 235​ # the values are used as identifiers in a TAP export
236 KOJI_BUILD = 'koji_build' #: 236​ KOJI_BUILD = 'koji_build' #:
237 BODHI_UPDATE = 'bodhi_update' #: 237​ BODHI_UPDATE = 'bodhi_update' #:
238 YUM_REPOSITORY = 'yum_repository' #: 238​ YUM_REPOSITORY = 'yum_repository' #:
239 239​
240 240​
241def export_TAP(check_details): 241​def export_TAP(check_details, checkname="$CHECKNAME"):
242 '''Generate TAP output used for reporting to ResultsDB. 242​ '''Generate TAP output used for reporting to ResultsDB.
243 243​
244 Note: You need to provide all your :class:`CheckDetail`s in a single pass 244​ Note: You need to provide all your :class:`CheckDetail`s in a single pass
245 in order to generate a valid TAP output. You can't call this method several 245​ in order to generate a valid TAP output. You can't call this method several
246 times and then simply join the outputs simply as strings. 246​ times and then simply join the outputs simply as strings.
247 247​
248 :param check_details: iterable of :class:`CheckDetail` instances or single 248​ :param check_details: iterable of :class:`CheckDetail` instances or single
249 instance of :class:`CheckDetail` 249​ instance of :class:`CheckDetail`
250​ :param str checkname: name of the executed check
kparalUnsubmitted
Not Done

I guess you wanted to put str inside the tag, to specify parameter type.

:param str checkname: the name of the executed check
250 :return: TAP output with results for every :class:`CheckDetail` instance 251​ :return: TAP output with results for every :class:`CheckDetail` instance
251 provided 252​ provided
252 :rtype: str 253​ :rtype: str
253 :raise TaskotronValueError: if :attr:`CheckDetail.item` is empty for any 254​ :raise TaskotronValueError: if :attr:`CheckDetail.item` is empty for any
254 parameter provided 255​ parameter provided
255 256​
256 Example output:: 257​ Example output::
257 258​
Show All 35 Lines
293 tapout = ['TAP version 13', '1..%d' % len(check_details)] 294​ tapout = ['TAP version 13', '1..%d' % len(check_details)]
294 295​
295 for detail in check_details: 296​ for detail in check_details:
296 # TAP test line 297​ # TAP test line
297 tap_outcome = tap.FAIL 298​ tap_outcome = tap.FAIL
298 if detail.outcome in ['PASSED', 'INFO']: 299​ if detail.outcome in ['PASSED', 'INFO']:
299 tap_outcome = tap.PASS 300​ tap_outcome = tap.PASS
300 301​
301 name = '$CHECKNAME for ' 302​ name = '%s for ' % checkname
302 if detail.report_type: 303​ if detail.report_type:
303 name += '%s ' % pretty_type_name.get(detail.report_type, 304​ name += '%s ' % pretty_type_name.get(detail.report_type,
304 detail.report_type) 305​ detail.report_type)
305 name += detail.item 306​ name += detail.item
306 307​
307 # TAP YAML block 308​ # TAP YAML block
308 data = {} 309​ data = {}
309 data['outcome'] = detail.outcome 310​ data['outcome'] = detail.outcome
▲ Show 20 Lines • Show All 62 Lines • Show Last 20 Lines
View Options

testing/test_check.py

Show First 20 Lines • Show All 337 Lines • ▼ Show 20 Line(s)337 def test_custom_report_type(self):
338 '''Test that user can specify a custom CheckDetail.report_type''' 338​ '''Test that user can specify a custom CheckDetail.report_type'''
339 self.cd.report_type = 'My Custom Type' 339​ self.cd.report_type = 'My Custom Type'
340 tap_output = check.export_TAP(self.cd) 340​ tap_output = check.export_TAP(self.cd)
341 yaml_block = self._tap_to_yaml(tap_output) 341​ yaml_block = self._tap_to_yaml(tap_output)
342 yaml_obj = yaml.safe_load(yaml_block) 342​ yaml_obj = yaml.safe_load(yaml_block)
343 343​
344 assert yaml_obj['type'] == self.cd.report_type 344​ assert yaml_obj['type'] == self.cd.report_type
345 345​
346​ def test_checkname(self):
347​ '''Test that replacing $CHECKNAME works'''
348​ # by default the outcome is PASSED
349​ output = check.export_TAP(self.cd)
350​ assert "ok - $CHECKNAME for" in output
351​
352​ output = check.export_TAP(self.cd, "my_beautifull_check_name")
353​ assert "ok - $CHECKNAME for" not in output
354​ assert "ok - my_beautifull_check_name for" in output
355​
346 356​
347class TestImportTAP(object): 357​class TestImportTAP(object):
348 '''Test @method import_TAP''' 358​ '''Test @method import_TAP'''
349 item = 'xchat-0.5-1.fc20' 359​ item = 'xchat-0.5-1.fc20'
350 outcome = 'PASSED' 360​ outcome = 'PASSED'
351 summary='5 ERRORS, 10 WARNINGS' 361​ summary='5 ERRORS, 10 WARNINGS'
352 report_type=check.ReportType.KOJI_BUILD 362​ report_type=check.ReportType.KOJI_BUILD
353 output = '''\ 363​ output = '''\
▲ Show 20 Lines • Show All 88 Lines • Show Last 20 Lines