mirror of
https://github.com/galaxyproject/galaxy.git
synced 2026-09-24 16:30:27 +08:00
John Chilton
887bc44a41
Rather than relying solely on exceptions back to nose/test framework - add option (--structured_data_report_file) to run_tests.sh that causes a bunch of detailed data to be dumped to the specified file in a very structured way. Includes full to_dict of the job from the API which in turn includes job metrics, command-line, job's standard error and outputs (instead of the test frameworks), as well as the tool inputs, and exceptions broken out for tool execution versus output checking. Its all indexed in the file by the test id (without the actual test toolbox depending on knowing the test id) - so one could pair this information with the XUnit output to produce much more detailed breakdowns of the tests.
90 lines
2.4 KiB
Python
90 lines
2.4 KiB
Python
""" Utilities to help instrument tool tests.
|
|
|
|
Including structed data nose plugin that allows storing arbitrary structured
|
|
data on a per test case basis - used by tool test to store inputs,
|
|
output problems, job tests, etc... but could easily by used by other test
|
|
types in a different way.
|
|
"""
|
|
|
|
import json
|
|
import threading
|
|
|
|
try:
|
|
from galaxy import eggs
|
|
eggs.require( "nose" )
|
|
except ImportError:
|
|
pass
|
|
|
|
|
|
from nose.plugins import Plugin
|
|
|
|
NO_JOB_DATA = object()
|
|
JOB_DATA = threading.local()
|
|
JOB_DATA.new = True
|
|
JOB_DATA.data = NO_JOB_DATA
|
|
|
|
|
|
def register_job_data(data):
|
|
if not JOB_DATA.new:
|
|
return
|
|
JOB_DATA.data = data
|
|
JOB_DATA.new = False
|
|
|
|
|
|
def fetch_job_data():
|
|
try:
|
|
if JOB_DATA.new:
|
|
return NO_JOB_DATA
|
|
else:
|
|
return JOB_DATA.data
|
|
finally:
|
|
JOB_DATA.new = True
|
|
|
|
|
|
class StructuredTestDataPlugin( Plugin ):
|
|
name = 'structureddata'
|
|
|
|
def options(self, parser, env):
|
|
super(StructuredTestDataPlugin, self).options(parser, env=env)
|
|
parser.add_option(
|
|
'--structured-data-file', action='store',
|
|
dest='structured_data_file', metavar="FILE",
|
|
default=env.get('NOSE_STRUCTURED_DATA', 'structured_test_data.json'),
|
|
help=("Path to JSON file to store the Galaxy structured data report in."
|
|
"Default is structured_test_data.json in the working directory "
|
|
"[NOSE_STRUCTURED_DATA]"))
|
|
|
|
def configure(self, options, conf):
|
|
super(StructuredTestDataPlugin, self).configure(options, conf)
|
|
self.conf = conf
|
|
if not self.enabled:
|
|
return
|
|
self.tests = []
|
|
self.structured_data_report_file = open(options.structured_data_file, 'w')
|
|
|
|
def finalize(self, result):
|
|
pass
|
|
|
|
def _handle_result(self, test, *args, **kwds):
|
|
job_data = fetch_job_data()
|
|
id = test.id()
|
|
has_data = job_data is not NO_JOB_DATA
|
|
entry = {
|
|
'id': id,
|
|
'has_data': has_data,
|
|
'data': job_data if has_data else None,
|
|
}
|
|
self.tests.append(entry)
|
|
|
|
addError = _handle_result
|
|
addFailure = _handle_result
|
|
addSuccess = _handle_result
|
|
|
|
def report(self, stream):
|
|
report_obj = {
|
|
'version': '0.1',
|
|
'tests': self.tests,
|
|
}
|
|
json.dump(report_obj, self.structured_data_report_file)
|
|
self.structured_data_report_file.close()
|