piecrust2: tests/conftest.py comparison

comparison tests/conftest.py @ 673:d6403c21bdea

tests: Improve failure reporting.

author	Ludovic Chabant <ludovic@chabant.com>
date	Sun, 06 Mar 2016 23:41:35 -0800
parents	81d9c3a3a0b5
children	f987b29d6fab

comparison

equal deleted inserted replaced

-:783ff8bc4e03
+:d6403c21bdea
 def pytest_addoption(parser):
 parser.addoption(
 '--log-debug',
 action='store_true',
 help="Sets the PieCrust logger to output debug info to stdout.")
+parser.addoption(
+'--mock-debug',
+action='store_true',
+help="Prints contents of the mock file-system.")
 def pytest_configure(config):
 if config.getoption('--log-debug'):
 hdl = logging.StreamHandler(stream=sys.stdout)
 return ChefTestFile(path, parent)
 elif category == 'servings':
 return ServeTestFile(path, parent)
+def repr_nested_failure(excinfo):
+# PyTest sadly doesn't show nested exceptions so we have to do it
+# ourselves... it's not pretty, but at least it's more useful.
+if excinfo.value.__cause__:
+import traceback
+ex = excinfo.value
+return '\n'.join(
+traceback.format_exception(
+type(ex), ex, ex.__traceback__))
+return ''
 class YamlTestFileBase(pytest.File):
 def collect(self):
 spec = yaml.load_all(self.fspath.open(encoding='utf8'))
 for i, item in enumerate(spec):
 name = '%s_%d' % (self.fspath.basename, i)
 class YamlTestItemBase(pytest.Item):
 def __init__(self, name, parent, spec):
 super(YamlTestItemBase, self).__init__(name, parent)
 self.spec = spec
+@property
+def mock_debug(self):
+return bool(self.config.getoption('--mock-debug'))
 def _prepareMockFs(self):
 fs = mock_fs()
 # Website config.
 # Input file-system.
 input_files = self.spec.get('in')
 if input_files is not None:
 _add_mock_files(fs, '/kitchen', input_files)
+if self.mock_debug:
+res = '\nMock File-System:\n'
+res += 'At: %s\n' % fs.path('')
+res += '\n'.join(print_fs_tree(fs.path('')))
+res += '\n'
+print(res)
 return fs
+def repr_failure(self, excinfo):
+res = super(YamlTestItemBase, self).repr_failure(excinfo)
+nested_res = repr_nested_failure(excinfo)
+if nested_res:
+res = str(res) + '\n' + nested_res
+return res
 def check_expected_outputs(spec, fs, error_type):
 cctx = CompareContext()
 expected_output_files = spec.get('out')
 argv = argv.split(' ')
 expected_code = self.spec.get('code', 0)
 expected_out = self.spec.get('out', None)
-with mock_fs_scope(fs):
+with mock_fs_scope(fs, keep=self.mock_debug):
 memstream = io.StringIO()
 hdl = logging.StreamHandler(stream=memstream)
 logging.getLogger().addHandler(hdl)
 try:
 from piecrust.main import _pre_parse_chef_args, _run_chef
 class BakeTestItem(YamlTestItemBase):
 def runtest(self):
 fs = self._prepareMockFs()
 from piecrust.baking.baker import Baker
-with mock_fs_scope(fs):
+with mock_fs_scope(fs, keep=self.mock_debug):
 out_dir = fs.path('kitchen/_counter')
 app = fs.getApp()
 variant = self.spec.get('config_variant')
 values = self.spec.get('config_values')
 return ('\n'.join(
 ['Unexpected bake output. Left is expected output, '
 'right is actual output'] +
 excinfo.value.args[0]))
 elif isinstance(excinfo.value, BakeError):
-return ('\n'.join(
+res = ('\n'.join(
 ['Errors occured during bake:'] +
 excinfo.value.args[0]))
+res += repr_nested_failure(excinfo)
+return res
 return super(BakeTestItem, self).repr_failure(excinfo)
 class BakeError(Exception):
 pass
 class PipelineTestItem(YamlTestItemBase):
 def runtest(self):
 fs = self._prepareMockFs()
 from piecrust.processing.pipeline import ProcessorPipeline
-with mock_fs_scope(fs):
+with mock_fs_scope(fs, keep=self.mock_debug):
 out_dir = fs.path('kitchen/_counter')
 app = fs.getApp()
 pipeline = ProcessorPipeline(app, out_dir)
 proc_names = self.spec.get('processors')
 return ('\n'.join(
 ['Unexpected pipeline output. Left is expected output, '
 'right is actual output'] +
 excinfo.value.args[0]))
 elif isinstance(excinfo.value, PipelineError):
-return ('\n'.join(
+res = ('\n'.join(
 ['Errors occured during processing:'] +
 excinfo.value.args[0]))
+res += repr_nested_failure(excinfo)
+return res
 return super(PipelineTestItem, self).repr_failure(excinfo)
 class PipelineError(Exception):
 pass
 from werkzeug.test import Client
 from werkzeug.wrappers import BaseResponse
 from piecrust.app import PieCrustFactory
 from piecrust.serving.server import Server
-with mock_fs_scope(fs):
+with mock_fs_scope(fs, keep=self.mock_debug):
 appfactory = PieCrustFactory(fs.path('/kitchen'))
 server = Server(appfactory)
 test_app = self._TestApp(server)
 client = Client(test_app, BaseResponse)
 resp = client.get(url)
 return self.fspath, 0, "serve: %s" % self.name
 def repr_failure(self, excinfo):
 from piecrust.serving.server import MultipleNotFound
 if isinstance(excinfo.value, MultipleNotFound):
-return '\n'.join(
+res = '\n'.join(
 ["HTTP error 404 returned:",
 excinfo.value.description] +
 [e.description for e in excinfo.value._nfes])
+res += repr_nested_failure(excinfo)
+return res
 elif isinstance(excinfo.value, HTTPException):
-return '\n'.join(
+res = '\n'.join(
 ["HTTP error %s returned:" % excinfo.value.code,
 excinfo.value.description])
+res += repr_nested_failure(excinfo)
+return res
 return super(ServeTestItem, self).repr_failure(excinfo)
 class ServeTestFile(YamlTestFileBase):
 __item_class__ = ServeTestItem

Mercurial > piecrust2

comparison tests/conftest.py @ 673:d6403c21bdea