testing/marionette/mach_commands.py

   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
   5 import argparse
   6 import functools
   7 import logging
   8 import os
   9 import sys
  10
  11 from six import iteritems
  12
  13 from mach.decorators import (
  14     Command,
  15 )
  16
  17 from mozbuild.base import (
  18     MachCommandConditions as conditions,
  19     BinaryNotFoundException,
  20 )
  21
  22 SUPPORTED_APPS = ["firefox", "android", "thunderbird"]
  23
  24
  25 def create_parser_tests():
  26     from marionette_harness.runtests import MarionetteArguments
  27     from mozlog.structured import commandline
  28
  29     parser = MarionetteArguments()
  30     commandline.add_logging_group(parser)
  31     return parser
  32
  33
  34 def run_marionette(tests, binary=None, topsrcdir=None, **kwargs):
  35     from mozlog.structured import commandline
  36
  37     from marionette_harness.runtests import MarionetteTestRunner, MarionetteHarness
  38
  39     parser = create_parser_tests()
  40
  41     args = argparse.Namespace(tests=tests)
  42
  43     args.binary = binary
  44     args.logger = kwargs.pop("log", None)
  45
  46     for k, v in iteritems(kwargs):
  47         setattr(args, k, v)
  48
  49     parser.verify_usage(args)
  50
  51     # Causes Firefox to crash when using non-local connections.
  52     os.environ["MOZ_DISABLE_NONLOCAL_CONNECTIONS"] = "1"
  53
  54     if not args.logger:
  55         args.logger = commandline.setup_logging(
  56             "Marionette Unit Tests", args, {"mach": sys.stdout}
  57         )
  58     failed = MarionetteHarness(MarionetteTestRunner, args=vars(args)).run()
  59     if failed > 0:
  60         return 1
  61     else:
  62         return 0
  63
  64
  65 @Command(
  66     "marionette-test",
  67     category="testing",
  68     description="Remote control protocol to Gecko, used for browser automation.",
  69     conditions=[functools.partial(conditions.is_buildapp_in, apps=SUPPORTED_APPS)],
  70     parser=create_parser_tests,
  71 )
  72 def marionette_test(command_context, tests, **kwargs):
  73     if "test_objects" in kwargs:
  74         tests = []
  75         for obj in kwargs["test_objects"]:
  76             tests.append(obj["file_relpath"])
  77         del kwargs["test_objects"]
  78
  79     if not tests:
  80         if conditions.is_thunderbird(command_context):
  81             tests = [
  82                 os.path.join(
  83                     command_context.topsrcdir,
  84                     "comm/testing/marionette/unit-tests.ini",
  85                 )
  86             ]
  87         else:
  88             tests = [
  89                 os.path.join(
  90                     command_context.topsrcdir,
  91                     "testing/marionette/harness/marionette_harness/tests/unit-tests.toml",
  92                 )
  93             ]
  94
  95     if not kwargs.get("binary") and (
  96         conditions.is_firefox(command_context)
  97         or conditions.is_thunderbird(command_context)
  98     ):
  99         try:
 100             kwargs["binary"] = command_context.get_binary_path("app")
 101         except BinaryNotFoundException as e:
 102             command_context.log(
 103                 logging.ERROR,
 104                 "marionette-test",
 105                 {"error": str(e)},
 106                 "ERROR: {error}",
 107             )
 108             command_context.log(
 109                 logging.INFO, "marionette-test", {"help": e.help()}, "{help}"
 110             )
 111             return 1
 112
 113     return run_marionette(tests, topsrcdir=command_context.topsrcdir, **kwargs)