/usr/lib/python2.7/dist-packages/gabbi/runner.py is in python-gabbi 1.40.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 | #
# 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.
"""Implementation of a command-line runner for gabbi files (AKA suites)."""
from __future__ import print_function
import argparse
from importlib import import_module
import os
import sys
import unittest
from gabbi import handlers
from gabbi.reporter import ConciseTestRunner
from gabbi import suitemaker
from gabbi import utils
def run():
"""Run simple tests from STDIN.
This command provides a way to run a set of tests encoded in YAML that
is provided on STDIN. No fixtures are supported, so this is primarily
designed for use with real running services.
Host and port information may be provided in three different ways:
* In the URL value of the tests.
* In a `host` or `host:port` argument on the command line.
* In a URL on the command line.
An example run might looks like this::
gabbi-run example.com:9999 < mytest.yaml
or::
gabbi-run http://example.com:999 < mytest.yaml
It is also possible to provide a URL prefix which can be useful if the
target application might be mounted in different locations. An example::
gabbi-run example.com:9999 /mountpoint < mytest.yaml
or::
gabbi-run http://example.com:9999/mountpoint < mytest.yaml
Use `-x` or `--failfast` to abort after the first error or failure::
gabbi-run -x example.com:9999 /mountpoint < mytest.yaml
Use `-v` or `--verbose` with a value of `all`, `headers` or `body` to
turn on verbosity for all tests being run.
Multiple files may be named as arguments, separated from other arguments
by a ``--``. Each file will be run as a separate test suite::
gabbi-run http://example.com -- /path/to/x.yaml /path/to/y.yaml
Output is formatted as unittest summary information.
"""
parser = _make_argparser()
argv, input_files = extract_file_paths(sys.argv)
args = parser.parse_args(argv[1:])
host, port, prefix, force_ssl = utils.host_info_from_target(
args.target, args.prefix)
handler_objects = initialize_handlers(args.response_handlers)
verbosity = args.verbosity
failfast = args.failfast
failure = False
# Keep track of file names that have failures.
failures = []
if not input_files:
success = run_suite(sys.stdin, handler_objects, host, port,
prefix, force_ssl, failfast,
verbosity=verbosity,
safe_yaml=args.safe_yaml)
failure = not success
else:
for input_file in input_files:
name = os.path.splitext(os.path.basename(input_file))[0]
with open(input_file, 'r') as fh:
data_dir = os.path.dirname(input_file)
success = run_suite(fh, handler_objects, host, port,
prefix, force_ssl, failfast,
data_dir=data_dir,
verbosity=verbosity, name=name,
safe_yaml=args.safe_yaml)
if not success:
failures.append(input_file)
if not failure: # once failed, this is considered immutable
failure = not success
if failure and failfast:
break
if failures:
print("There were failures in the following files:", file=sys.stderr)
print('\n'.join(failures), file=sys.stderr)
sys.exit(failure)
def run_suite(handle, handler_objects, host, port, prefix, force_ssl=False,
failfast=False, data_dir='.', verbosity=False, name='input',
safe_yaml=True):
"""Run the tests from the YAML in handle."""
data = utils.load_yaml(handle, safe=safe_yaml)
if force_ssl:
if 'defaults' in data:
data['defaults']['ssl'] = True
else:
data['defaults'] = {'ssl': True}
if verbosity:
if 'defaults' in data:
data['defaults']['verbose'] = verbosity
else:
data['defaults'] = {'verbose': verbosity}
loader = unittest.defaultTestLoader
test_suite = suitemaker.test_suite_from_dict(
loader, name, data, data_dir, host, port, None, None, prefix=prefix,
handlers=handler_objects, test_loader_name='gabbi-runner')
result = ConciseTestRunner(
verbosity=2, failfast=failfast).run(test_suite)
return result.wasSuccessful()
def initialize_handlers(response_handlers):
custom_response_handlers = []
handler_objects = []
for import_path in response_handlers or []:
for handler in load_response_handlers(import_path):
custom_response_handlers.append(handler)
for handler in handlers.RESPONSE_HANDLERS + custom_response_handlers:
handler_objects.append(handler())
return handler_objects
def load_response_handlers(import_path):
"""Load and return custom response handlers from the given Python package
or module.
The import path references either a specific response handler class
("package.module:class") or a module that contains one or more response
handler classes ("package.module").
For the latter, the module is expected to contain a
``gabbi_response_handlers`` object, which is either a list of response
handler classes or a function returning such a list.
"""
if ":" in import_path: # package.module:class
module_name, handler_name = import_path.rsplit(":", 1)
module = import_module(module_name)
handler = getattr(module, handler_name)
custom_handlers = [handler]
else: # package.module shorthand, expecting gabbi_response_handlers
module = import_module(import_path)
custom_handlers = module.gabbi_response_handlers
if callable(custom_handlers):
custom_handlers = custom_handlers()
return custom_handlers
def extract_file_paths(argv):
"""Extract command-line arguments following the `--` end-of-options
delimiter, if any.
"""
try: # extract file paths, separated by `--`
i = argv.index("--")
input_files = argv[i + 1:]
argv = argv[:i]
except ValueError:
input_files = None
return argv, input_files
def _make_argparser():
"""Set up the argparse.ArgumentParser."""
parser = argparse.ArgumentParser(description='Run gabbi tests from STDIN')
parser.add_argument(
'target',
nargs='?', default='stub',
help='A fully qualified URL (with optional path as prefix) '
'to the primary target or a host and port, : separated. '
'If using an IPV6 address for the host in either form, '
'wrap it in \'[\' and \']\'.'
)
parser.add_argument(
'prefix',
nargs='?', default=None,
help='Path prefix where target app is mounted. Only used when '
'target is of the form host[:port]'
)
parser.add_argument(
'-x', '--failfast',
action='store_true',
help='Exit on first failure'
)
parser.add_argument(
'-r', '--response-handler',
nargs='?', default=None,
dest='response_handlers',
action='append',
help='Custom response handler. Should be an import path of the '
'form package.module or package.module:class.'
)
parser.add_argument(
'-v', '--verbose',
dest='verbosity',
choices=['all', 'body', 'headers'],
help='Turn on test verbosity for all tests run in this session.'
)
parser.add_argument(
'--unsafe-yaml',
dest='safe_yaml',
action='store_false',
default=True,
help='Turn on recognition of Python objects in addition to '
'standard YAML tags.'
)
return parser
if __name__ == '__main__':
run()
|