1# This Source Code Form is subject to the terms of the Mozilla Public
2# License, v. 2.0. If a copy of the MPL was not distributed with this
3# file, You can obtain one at http://mozilla.org/MPL/2.0/.
4
5import sys
6
7import mozlog
8
9from marionette_driver import __version__ as driver_version
10
11from marionette_harness import (
12    __version__,
13    BaseMarionetteTestRunner,
14    BaseMarionetteArguments,
15    BrowserMobProxyArguments,
16    MarionetteTestCase,
17)
18
19
20class MarionetteTestRunner(BaseMarionetteTestRunner):
21    def __init__(self, **kwargs):
22        BaseMarionetteTestRunner.__init__(self, **kwargs)
23        self.test_handlers = [MarionetteTestCase]
24
25
26class MarionetteArguments(BaseMarionetteArguments):
27    def __init__(self, **kwargs):
28        BaseMarionetteArguments.__init__(self, **kwargs)
29        self.register_argument_container(BrowserMobProxyArguments())
30
31
32class MarionetteHarness(object):
33    def __init__(self,
34                 runner_class=MarionetteTestRunner,
35                 parser_class=MarionetteArguments,
36                 testcase_class=MarionetteTestCase,
37                 args=None):
38        self._runner_class = runner_class
39        self._parser_class = parser_class
40        self._testcase_class = testcase_class
41        self.args = args or self.parse_args()
42
43    def parse_args(self, logger_defaults=None):
44        parser = self._parser_class(
45            usage='%(prog)s [options] test_file_or_dir <test_file_or_dir> ...')
46        parser.add_argument('--version', action='version',
47                            help="Show version information.",
48                            version="%(prog)s {version}"
49                            " (using marionette-driver: {driver_version}, ".format(
50                                version=__version__,
51                                driver_version=driver_version
52                            ))
53        mozlog.commandline.add_logging_group(parser)
54        args = parser.parse_args()
55        parser.verify_usage(args)
56
57        logger = mozlog.commandline.setup_logging(
58            args.logger_name, args, logger_defaults or {"tbpl": sys.stdout})
59
60        args.logger = logger
61        return vars(args)
62
63    def process_args(self):
64        if self.args.get('pydebugger'):
65            self._testcase_class.pydebugger = __import__(self.args['pydebugger'])
66
67    def run(self):
68        self.process_args()
69        tests = self.args.pop('tests')
70        runner = self._runner_class(**self.args)
71        runner.run_tests(tests)
72        return runner.failed + runner.crashed
73
74
75def cli(runner_class=MarionetteTestRunner, parser_class=MarionetteArguments,
76        harness_class=MarionetteHarness, testcase_class=MarionetteTestCase, args=None):
77    """
78    Call the harness to parse args and run tests.
79
80    The following exit codes are expected:
81    - Test failures: 10
82    - Harness/other failures: 1
83    - Success: 0
84    """
85    logger = mozlog.commandline.setup_logging('Marionette test runner', {})
86    try:
87        harness_instance = harness_class(runner_class, parser_class, testcase_class,
88                                         args=args)
89        failed = harness_instance.run()
90        if failed > 0:
91            sys.exit(10)
92    except Exception:
93        logger.error('Failure during harness execution', exc_info=True)
94        sys.exit(1)
95    sys.exit(0)
96
97if __name__ == "__main__":
98    cli()
99