deb-python-gabbi/gabbi/suite.py
Chris Dent 1b31ef02e4 Extract suitemaking out of driver
This creates a new module, suitemaker.py, which contains the
code used to create a suite.GabbiSuite, which contains
case.HTTPTestCase tests.

This limits driver.py to being mostly code that is necessary to
assemble the necessary information to create tests that are runnable
by python test harnesses. This is distinguished from runner.py
which assembles the necessary information to both create and _run_
tests itself.

The idea here is that if the interface presented by test_suite_from_dict
(both signature and that it returns a GabbiSuite) is preserved, then
anything in suitemaker.py is welcome to change. The signature on
test_suite_from_dict is the definition of what a caller (driver or runner
or whatever else) needs to have learned:

loader: the unittest.TestLoader which we might be able to default
        out of existence
test_base_name: names help with test grouping so useful
suite_dict: the main piece of the pie, the dict
test_directory: the place where `data` can load files from
host: the host any unqualified test goes to
port: the port any unqualified test goes to
fixture_module: the sole module from which fixtures come
intercept: the wsgi app to intercept if any
prefix: the url prefix

host and intercept are mutually exclusive

One can image it might be possible to replace host, port, prefix
with a URL instead. If that were done than host and url would be mutually
exclusive.

If the signature of test_suite_from_dict changes then stuff in both driver
and runner, in how they assemble the required info, would need to change.

Note: For reasons unclear these changes have exposed some state management
issues in test_runner, noted in a NOTE.
2016-06-03 15:07:57 +01:00

124 lines
4.1 KiB
Python

#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
"""A TestSuite for containing gabbi tests.
This suite has two features: the contained tests are ordered and there
are suite-level fixtures that operate as context managers.
"""
import unittest
from wsgi_intercept import interceptor
from gabbi import fixture
def noop(*args):
"""A noop method used to disable collected tests."""
pass
class GabbiSuite(unittest.TestSuite):
"""A TestSuite with fixtures.
The suite wraps the tests with a set of nested context managers that
operate as fixtures.
If a fixture raises unittest.case.SkipTest during setup, all the
tests in this suite will be skipped.
"""
def run(self, result, debug=False):
"""Override TestSuite run to start suite-level fixtures.
To avoid exception confusion, use a null Fixture when there
are no fixtures.
"""
fixtures, intercept, host, port, prefix = self._get_intercept()
try:
with fixture.nest([fix() for fix in fixtures]):
if intercept:
with interceptor.Urllib3Interceptor(
intercept, host, port, prefix):
result = super(GabbiSuite, self).run(result, debug)
else:
result = super(GabbiSuite, self).run(result, debug)
except unittest.SkipTest as exc:
for test in self._tests:
result.addSkip(test, str(exc))
return result
def start(self, result):
"""Start fixtures when using pytest."""
fixtures, intercept, host, port, prefix = self._get_intercept()
self.used_fixtures = []
try:
for fix in fixtures:
fix_object = fix()
fix_object.__enter__()
self.used_fixtures.append(fix_object)
except unittest.SkipTest as exc:
# Disable the already collected tests that we now wish
# to skip.
for test in self:
test.run = noop
result.addSkip(test, str(exc))
result.addSkip(self, str(exc))
if intercept:
intercept_fixture = interceptor.Urllib3Interceptor(
intercept, host, port, prefix)
intercept_fixture.__enter__()
self.used_fixtures.append(intercept_fixture)
def stop(self):
"""Stop fixtures when using pytest."""
for fix in reversed(self.used_fixtures):
fix.__exit__(None, None, None)
def _get_intercept(self):
fixtures = [fixture.GabbiFixture]
intercept = host = port = prefix = None
try:
first_test = self._find_first_full_test()
fixtures = first_test.fixtures
host = first_test.host
port = first_test.port
prefix = first_test.prefix
intercept = first_test.intercept
# Unbind a passed in WSGI application. During the
# metaclass building process intercept becomes bound.
try:
intercept = intercept.__func__
except AttributeError:
pass
except AttributeError:
pass
return fixtures, intercept, host, port, prefix
def _find_first_full_test(self):
"""Traverse a sparse test suite to find the first HTTPTestCase.
When only some tests are requested empty TestSuites replace the
unrequested tests.
"""
for test in self._tests:
if hasattr(test, 'fixtures'):
return test
raise AttributeError('no fixtures found')