import FIREFOX_52_6_0esr_RELEASE from mozilla-esr52 hg repo

testing/mozbase/mozlog/mozlog/__init__.py

@@ -0,0 +1,30 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+"""
+Mozlog aims to standardize log handling and formatting within Mozilla.
+
+It implements a JSON-based structured logging protocol with convenience
+facilities for recording test results.
+
+The old unstructured module is deprecated. It simply wraps Python's
+logging_ module and adds a few convenience methods for logging test
+results and events.
+"""
+
+import sys
+
+from . import commandline
+from . import structuredlog
+from . import unstructured
+from .structuredlog import get_default_logger, set_default_logger
+from .proxy import get_proxy_logger
+
+# Backwards compatibility shim for consumers that use mozlog.structured
+structured = sys.modules[__name__]
+sys.modules['{}.structured'.format(__name__)] = structured
+
+__all__ = ['commandline', 'structuredlog', 'unstructured',
+           'get_default_logger', 'set_default_logger', 'get_proxy_logger',
+           'structured']

testing/mozbase/mozlog/mozlog/commandline.py

@@ -0,0 +1,282 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import argparse
+import optparse
+import os
+import sys
+from collections import defaultdict
+
+from . import handlers
+from . import formatters
+from .structuredlog import StructuredLogger, set_default_logger
+
+log_formatters = {
+    'raw': (formatters.JSONFormatter, "Raw structured log messages"),
+    'unittest': (formatters.UnittestFormatter, "Unittest style output"),
+    'xunit': (formatters.XUnitFormatter, "xUnit compatible XML"),
+    'html': (formatters.HTMLFormatter, "HTML report"),
+    'mach': (formatters.MachFormatter, "Human-readable output"),
+    'tbpl': (formatters.TbplFormatter, "TBPL style log format"),
+    'errorsummary': (formatters.ErrorSummaryFormatter, argparse.SUPPRESS),
+}
+
+TEXT_FORMATTERS = ('raw', 'mach')
+"""a subset of formatters for non test harnesses related applications"""
+
+
+def level_filter_wrapper(formatter, level):
+    return handlers.LogLevelFilter(formatter, level)
+
+
+def verbose_wrapper(formatter, verbose):
+    formatter.verbose = verbose
+    return formatter
+
+
+def compact_wrapper(formatter, compact):
+    formatter.compact = compact
+    return formatter
+
+
+def buffer_handler_wrapper(handler, buffer_limit):
+    if buffer_limit == "UNLIMITED":
+        buffer_limit = None
+    else:
+        buffer_limit = int(buffer_limit)
+    return handlers.BufferHandler(handler, buffer_limit)
+
+
+def valgrind_handler_wrapper(handler):
+    return handlers.ValgrindHandler(handler)
+
+
+def default_formatter_options(log_type, overrides):
+    formatter_option_defaults = {
+        "raw": {
+            "level": "debug"
+        }
+    }
+    rv = {"verbose": False,
+          "level": "info"}
+    rv.update(formatter_option_defaults.get(log_type, {}))
+
+    if overrides is not None:
+        rv.update(overrides)
+
+    return rv
+
+fmt_options = {
+    # <option name>: (<wrapper function>, description, <applicable formatters>, action)
+    # "action" is used by the commandline parser in use.
+    'verbose': (verbose_wrapper,
+                "Enables verbose mode for the given formatter.",
+                ["mach"], "store_true"),
+    'compact': (compact_wrapper,
+                "Enables compact mode for the given formatter.",
+                ["tbpl"], "store_true"),
+    'level': (level_filter_wrapper,
+              "A least log level to subscribe to for the given formatter "
+              "(debug, info, error, etc.)",
+              ["mach", "raw", "tbpl"], "store"),
+    'buffer': (buffer_handler_wrapper,
+               "If specified, enables message buffering at the given buffer size limit.",
+               ["mach", "tbpl"], "store"),
+}
+
+
+def log_file(name):
+    if name == "-":
+        return sys.stdout
+    # ensure we have a correct dirpath by using realpath
+    dirpath = os.path.dirname(os.path.realpath(name))
+    if not os.path.exists(dirpath):
+        os.makedirs(dirpath)
+    return open(name, "w")
+
+
+def add_logging_group(parser, include_formatters=None):
+    """
+    Add logging options to an argparse ArgumentParser or
+    optparse OptionParser.
+
+    Each formatter has a corresponding option of the form --log-{name}
+    where {name} is the name of the formatter. The option takes a value
+    which is either a filename or "-" to indicate stdout.
+
+    :param parser: The ArgumentParser or OptionParser object that should have
+                   logging options added.
+    :param include_formatters: List of formatter names that should be included
+                               in the option group. Default to None, meaning
+                               all the formatters are included. A common use
+                               of this option is to specify
+                               :data:`TEXT_FORMATTERS` to include only the
+                               most useful formatters for a command line tool
+                               that is not related to test harnesses.
+    """
+    group_name = "Output Logging"
+    group_description = ("Each option represents a possible logging format "
+                         "and takes a filename to write that format to, "
+                         "or '-' to write to stdout.")
+
+    if include_formatters is None:
+        include_formatters = log_formatters.keys()
+
+    if isinstance(parser, optparse.OptionParser):
+        group = optparse.OptionGroup(parser,
+                                     group_name,
+                                     group_description)
+        parser.add_option_group(group)
+        opt_log_type = 'str'
+        group_add = group.add_option
+    else:
+        group = parser.add_argument_group(group_name,
+                                          group_description)
+        opt_log_type = log_file
+        group_add = group.add_argument
+
+    for name, (cls, help_str) in log_formatters.iteritems():
+        if name in include_formatters:
+            group_add("--log-" + name, action="append", type=opt_log_type,
+                      help=help_str)
+
+    for optname, (cls, help_str, formatters_, action) in fmt_options.iteritems():
+        for fmt in formatters_:
+            # make sure fmt is in log_formatters and is accepted
+            if fmt in log_formatters and fmt in include_formatters:
+                group_add("--log-%s-%s" % (fmt, optname), action=action,
+                          help=help_str, default=None)
+
+
+def setup_handlers(logger, formatters, formatter_options, allow_unused_options=False):
+    """
+    Add handlers to the given logger according to the formatters and
+    options provided.
+
+    :param logger: The logger configured by this function.
+    :param formatters: A dict of {formatter, [streams]} to use in handlers.
+    :param formatter_options: a dict of {formatter: {option: value}} to
+                              to use when configuring formatters.
+    """
+    unused_options = set(formatter_options.keys()) - set(formatters.keys())
+    if unused_options and not allow_unused_options:
+        msg = ("Options specified for unused formatter(s) (%s) have no effect" %
+               list(unused_options))
+        raise ValueError(msg)
+
+    for fmt, streams in formatters.iteritems():
+        formatter_cls = log_formatters[fmt][0]
+        formatter = formatter_cls()
+        handler_wrappers_and_options = []
+
+        for option, value in formatter_options[fmt].iteritems():
+            wrapper, wrapper_args = None, ()
+            if option == "valgrind":
+                wrapper = valgrind_handler_wrapper
+            elif option == "buffer":
+                wrapper, wrapper_args = fmt_options[option][0], (value,)
+            else:
+                formatter = fmt_options[option][0](formatter, value)
+
+            if wrapper is not None:
+                handler_wrappers_and_options.append((wrapper, wrapper_args))
+
+        for value in streams:
+            handler = handlers.StreamHandler(stream=value, formatter=formatter)
+            for wrapper, wrapper_args in handler_wrappers_and_options:
+                handler = wrapper(handler, *wrapper_args)
+            logger.add_handler(handler)
+
+
+def setup_logging(logger, args, defaults=None, formatter_defaults=None,
+                  allow_unused_options=False):
+    """
+    Configure a structuredlogger based on command line arguments.
+
+    The created structuredlogger will also be set as the default logger, and
+    can be retrieved with :py:func:`~mozlog.get_default_logger`.
+
+    :param logger: A StructuredLogger instance or string name. If a string, a
+                   new StructuredLogger instance will be created using
+                   `logger` as the name.
+    :param args: A dictionary of {argument_name:value} produced from
+                 parsing the command line arguments for the application
+    :param defaults: A dictionary of {formatter name: output stream} to apply
+                     when there is no logging supplied on the command line. If
+                     this isn't supplied, reasonable defaults are chosen
+                     (coloured mach formatting if stdout is a terminal, or raw
+                     logs otherwise).
+    :param formatter_defaults: A dictionary of {option_name: default_value} to provide
+                               to the formatters in the absence of command line overrides.
+    :rtype: StructuredLogger
+    """
+
+    if not isinstance(logger, StructuredLogger):
+        logger = StructuredLogger(logger)
+
+    # Keep track of any options passed for formatters.
+    formatter_options = {}
+    # Keep track of formatters and list of streams specified.
+    formatters = defaultdict(list)
+    found = False
+    found_stdout_logger = False
+    if args is None:
+        args = {}
+    if not hasattr(args, 'iteritems'):
+        args = vars(args)
+
+    if defaults is None:
+        if sys.__stdout__.isatty():
+            defaults = {"mach": sys.stdout}
+        else:
+            defaults = {"raw": sys.stdout}
+
+    for name, values in args.iteritems():
+        parts = name.split('_')
+        if len(parts) > 3:
+            continue
+        # Our args will be ['log', <formatter>]
+        #               or ['log', <formatter>, <option>]
+        #               or ['valgrind']
+        if parts[0] == 'log' and values is not None:
+            if len(parts) == 1 or parts[1] not in log_formatters:
+                continue
+            if len(parts) == 2:
+                _, formatter = parts
+                for value in values:
+                    found = True
+                    if isinstance(value, basestring):
+                        value = log_file(value)
+                    if value == sys.stdout:
+                        found_stdout_logger = True
+                    formatters[formatter].append(value)
+            if len(parts) == 3:
+                _, formatter, opt = parts
+                if formatter not in formatter_options:
+                    formatter_options[formatter] = default_formatter_options(formatter,
+                                                                             formatter_defaults)
+                formatter_options[formatter][opt] = values
+
+    # If there is no user-specified logging, go with the default options
+    if not found:
+        for name, value in defaults.iteritems():
+            formatters[name].append(value)
+
+    elif not found_stdout_logger and sys.stdout in defaults.values():
+        for name, value in defaults.iteritems():
+            if value == sys.stdout:
+                formatters[name].append(value)
+
+    for name in formatters:
+        if name not in formatter_options:
+            formatter_options[name] = default_formatter_options(name, formatter_defaults)
+
+    # If the user specified --valgrind, add it as an option for all formatters
+    if args.get('valgrind', None) is not None:
+        for name in formatters:
+            formatter_options[name]['valgrind'] = True
+    setup_handlers(logger, formatters, formatter_options, allow_unused_options)
+    set_default_logger(logger)
+
+    return logger

testing/mozbase/mozlog/mozlog/formatters/__init__.py

@@ -0,0 +1,23 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from unittest import UnittestFormatter
+from xunit import XUnitFormatter
+from html import HTMLFormatter
+from machformatter import MachFormatter
+from tbplformatter import TbplFormatter
+from errorsummary import ErrorSummaryFormatter
+
+try:
+    import ujson as json
+except ImportError:
+    import json
+
+
+def JSONFormatter():
+    return lambda x: json.dumps(x) + "\n"
+
+__all__ = ['UnittestFormatter', 'XUnitFormatter', 'HTMLFormatter',
+           'MachFormatter', 'TbplFormatter', 'ErrorSummaryFormatter',
+           'JSONFormatter']

testing/mozbase/mozlog/mozlog/formatters/base.py

@@ -0,0 +1,20 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from ..reader import LogHandler
+
+
+class BaseFormatter(LogHandler):
+    """Base class for implementing non-trivial formatters.
+
+    Subclasses are expected to provide a method for each action type they
+    wish to handle, each taking a single argument for the test data.
+    For example a trivial subclass that just produces the id of each test as
+    it starts might be::
+
+      class StartIdFormatter(BaseFormatter);
+          def test_start(data):
+              #For simplicity in the example pretend the id is always a string
+              return data["test"]
+    """

testing/mozbase/mozlog/mozlog/formatters/errorsummary.py

@@ -0,0 +1,69 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import json
+
+from base import BaseFormatter
+
+
+class ErrorSummaryFormatter(BaseFormatter):
+
+    def __init__(self):
+        self.line_count = 0
+
+    def __call__(self, data):
+        rv = BaseFormatter.__call__(self, data)
+        self.line_count += 1
+        return rv
+
+    def _output(self, data_type, data):
+        data["action"] = data_type
+        data["line"] = self.line_count
+        return "%s\n" % json.dumps(data)
+
+    def _output_test(self, test, subtest, item):
+        data = {"test": test,
+                "subtest": subtest,
+                "status": item["status"],
+                "expected": item["expected"],
+                "message": item.get("message"),
+                "stack": item.get("stack")}
+        return self._output("test_result", data)
+
+    def test_status(self, item):
+        if "expected" not in item:
+            return
+        return self._output_test(item["test"], item["subtest"], item)
+
+    def test_end(self, item):
+        if "expected" not in item:
+            return
+        return self._output_test(item["test"], None, item)
+
+    def log(self, item):
+        if item["level"] not in ("ERROR", "CRITICAL"):
+            return
+
+        data = {"level": item["level"],
+                "message": item["message"]}
+        return self._output("log", data)
+
+    def crash(self, item):
+        data = {"test": item.get("test"),
+                "signature": item["signature"],
+                "stackwalk_stdout": item.get("stackwalk_stdout"),
+                "stackwalk_stderr": item.get("stackwalk_stderr")}
+        return self._output("crash", data)
+
+    def lint(self, item):
+        data = {
+            "level": item["level"],
+            "path": item["path"],
+            "message": item["message"],
+            "lineno": item["lineno"],
+            "column": item.get("column"),
+            "rule": item.get("rule"),
+            "linter": item.get("linter")
+        }
+        self._output("lint", data)

testing/mozbase/mozlog/mozlog/formatters/html/__init__.py

@@ -0,0 +1,3 @@
+from html import HTMLFormatter
+
+__all__ = ['HTMLFormatter']

testing/mozbase/mozlog/mozlog/formatters/html/html.py

@@ -0,0 +1,236 @@
+#!/usr/bin/env python
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import base64
+import cgi
+from datetime import datetime
+import os
+
+from .. import base
+
+from collections import defaultdict
+
+html = None
+raw = None
+
+base_path = os.path.split(__file__)[0]
+
+
+def do_defered_imports():
+    global html
+    global raw
+
+    from .xmlgen import html, raw
+
+
+class HTMLFormatter(base.BaseFormatter):
+    """Formatter that produces a simple HTML-formatted report."""
+
+    def __init__(self):
+        do_defered_imports()
+        self.suite_name = None
+        self.result_rows = []
+        self.test_count = defaultdict(int)
+        self.start_times = {}
+        self.suite_times = {"start": None,
+                            "end": None}
+        self.head = None
+        self.env = {}
+
+    def suite_start(self, data):
+        self.suite_times["start"] = data["time"]
+        self.suite_name = data["source"]
+        with open(os.path.join(base_path, "style.css")) as f:
+            self.head = html.head(
+                html.meta(charset="utf-8"),
+                html.title(data["source"]),
+                html.style(raw(f.read())))
+
+        date_format = "%d %b %Y %H:%M:%S"
+        version_info = data.get("version_info")
+        if version_info:
+            self.env["Device identifier"] = version_info.get("device_id")
+            self.env["Device firmware (base)"] = version_info.get("device_firmware_version_base")
+            self.env["Device firmware (date)"] = (
+                datetime.utcfromtimestamp(int(version_info.get("device_firmware_date")))
+                .strftime(date_format) if
+                "device_firmware_date" in version_info else None)
+            self.env["Device firmware (incremental)"] = version_info.get(
+                "device_firmware_version_incremental")
+            self.env["Device firmware (release)"] = version_info.get(
+                "device_firmware_version_release")
+            self.env["Gaia date"] = (
+                datetime.utcfromtimestamp(int(version_info.get("gaia_date")))
+                .strftime(date_format) if
+                "gaia_date" in version_info else None)
+            self.env["Gecko version"] = version_info.get("application_version")
+            self.env["Gecko build"] = version_info.get("application_buildid")
+
+            if version_info.get("application_changeset"):
+                self.env["Gecko revision"] = version_info.get("application_changeset")
+                if version_info.get("application_repository"):
+                    self.env["Gecko revision"] = html.a(
+                        version_info.get("application_changeset"),
+                        href="/".join([version_info.get("application_repository"),
+                                       version_info.get("application_changeset")]),
+                        target="_blank")
+
+            if version_info.get("gaia_changeset"):
+                self.env["Gaia revision"] = html.a(
+                    version_info.get("gaia_changeset")[:12],
+                    href="https://github.com/mozilla-b2g/gaia/commit/%s" % version_info.get(
+                        "gaia_changeset"),
+                    target="_blank")
+
+        device_info = data.get("device_info")
+        if device_info:
+            self.env["Device uptime"] = device_info.get("uptime")
+            self.env["Device memory"] = device_info.get("memtotal")
+            self.env["Device serial"] = device_info.get("id")
+
+    def suite_end(self, data):
+        self.suite_times["end"] = data["time"]
+        return self.generate_html()
+
+    def test_start(self, data):
+        self.start_times[data["test"]] = data["time"]
+
+    def test_end(self, data):
+        self.make_result_html(data)
+
+    def make_result_html(self, data):
+        tc_time = (data["time"] - self.start_times.pop(data["test"])) / 1000.
+        additional_html = []
+        debug = data.get("extra", {})
+        # Add support for log exported from wptrunner. The structure of
+        # reftest_screenshots is listed in wptrunner/executors/base.py.
+        if debug.get('reftest_screenshots'):
+            log_data = debug.get("reftest_screenshots", {})
+            debug = {
+                'image1': 'data:image/png;base64,' + log_data[0].get("screenshot", {}),
+                'image2': 'data:image/png;base64,' + log_data[2].get("screenshot", {}),
+                'differences': "Not Implemented",
+            }
+
+        links_html = []
+
+        status = status_name = data["status"]
+        expected = data.get("expected", status)
+
+        if status != expected:
+            status_name = "UNEXPECTED_" + status
+        elif status not in ("PASS", "SKIP"):
+            status_name = "EXPECTED_" + status
+
+        self.test_count[status_name] += 1
+
+        if status in ['SKIP', 'FAIL', 'ERROR']:
+            if debug.get('differences'):
+                images = [
+                    ('image1', 'Image 1 (test)'),
+                    ('image2', 'Image 2 (reference)')
+                ]
+                for title, description in images:
+                    screenshot = '%s' % debug[title]
+                    additional_html.append(html.div(
+                        html.a(html.img(src=screenshot), href="#"),
+                        html.br(),
+                        html.a(description),
+                        class_='screenshot'))
+
+            if debug.get('screenshot'):
+                screenshot = '%s' % debug['screenshot']
+                screenshot = 'data:image/png;base64,' + screenshot
+
+                additional_html.append(html.div(
+                    html.a(html.img(src=screenshot), href="#"),
+                    class_='screenshot'))
+
+            for name, content in debug.items():
+                if name in ['screenshot', 'image1', 'image2']:
+                    if not content.startswith('data:image/png;base64,'):
+                        href = 'data:image/png;base64,%s' % content
+                    else:
+                        href = content
+                else:
+                    # Encode base64 to avoid that some browsers (such as Firefox, Opera)
+                    # treats '#' as the start of another link if it is contained in the data URL.
+                    # Use 'charset=utf-8' to show special characters like Chinese.
+                    utf_encoded = unicode(content).encode('utf-8', 'xmlcharrefreplace')
+                    href = 'data:text/html;charset=utf-8;base64,%s' % base64.b64encode(utf_encoded)
+
+                links_html.append(html.a(
+                    name.title(),
+                    class_=name,
+                    href=href,
+                    target='_blank'))
+                links_html.append(' ')
+
+            log = html.div(class_='log')
+            output = data.get('stack', '').splitlines()
+            output.extend(data.get('message', '').splitlines())
+            for line in output:
+                separator = line.startswith(' ' * 10)
+                if separator:
+                    log.append(line[:80])
+                else:
+                    if line.lower().find("error") != -1 or line.lower().find("exception") != -1:
+                        log.append(html.span(raw(cgi.escape(line)), class_='error'))
+                    else:
+                        log.append(raw(cgi.escape(line)))
+                log.append(html.br())
+            additional_html.append(log)
+
+        self.result_rows.append(
+            html.tr([html.td(status_name, class_='col-result'),
+                     html.td(data['test'], class_='col-name'),
+                     html.td('%.2f' % tc_time, class_='col-duration'),
+                     html.td(links_html, class_='col-links'),
+                     html.td(additional_html, class_='debug')],
+                    class_=status_name.lower() + ' results-table-row'))
+
+    def generate_html(self):
+        generated = datetime.utcnow()
+        with open(os.path.join(base_path, "main.js")) as main_f:
+            doc = html.html(
+                self.head,
+                html.body(
+                    html.script(raw(main_f.read())),
+                    html.p('Report generated on %s at %s' % (
+                        generated.strftime('%d-%b-%Y'),
+                        generated.strftime('%H:%M:%S'))),
+                    html.h2('Environment'),
+                    html.table(
+                        [html.tr(html.td(k), html.td(v))
+                         for k, v in sorted(self.env.items()) if v],
+                        id='environment'),
+
+                    html.h2('Summary'),
+                    html.p('%i tests ran in %.1f seconds.' % (sum(self.test_count.itervalues()),
+                                                              (self.suite_times["end"] -
+                                                               self.suite_times["start"]) / 1000.),
+                           html.br(),
+                           html.span('%i passed' % self.test_count["PASS"], class_='pass'), ', ',
+                           html.span('%i skipped' % self.test_count["SKIP"], class_='skip'), ', ',
+                           html.span('%i failed' % self.test_count[
+                                     "UNEXPECTED_FAIL"], class_='fail'), ', ',
+                           html.span('%i errors' % self.test_count[
+                                     "UNEXPECTED_ERROR"], class_='error'), '.',
+                           html.br(),
+                           html.span('%i expected failures' % self.test_count["EXPECTED_FAIL"],
+                                     class_='expected_fail'), ', ',
+                           html.span('%i unexpected passes' % self.test_count["UNEXPECTED_PASS"],
+                                     class_='unexpected_pass'), '.'),
+                    html.h2('Results'),
+                    html.table([html.thead(
+                        html.tr([
+                            html.th('Result', class_='sortable', col='result'),
+                            html.th('Test', class_='sortable', col='name'),
+                            html.th('Duration', class_='sortable numeric', col='duration'),
+                            html.th('Links')]), id='results-table-head'),
+                        html.tbody(self.result_rows,
+                                   id='results-table-body')], id='results-table')))
+
+        return u"<!DOCTYPE html>\n" + doc.unicode(indent=2)

testing/mozbase/mozlog/mozlog/formatters/html/main.js

@@ -0,0 +1,172 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+function toArray(iter) {
+    if (iter === null) {
+        return null;
+    }
+    return Array.prototype.slice.call(iter);
+}
+
+function find(selector, elem) {
+    if (!elem) {
+        elem = document;
+    }
+    return elem.querySelector(selector);
+}
+
+function find_all(selector, elem) {
+    if (!elem) {
+        elem = document;
+    }
+    return toArray(elem.querySelectorAll(selector));
+}
+
+addEventListener("DOMContentLoaded", function() {
+    reset_sort_headers();
+
+    split_debug_onto_two_rows();
+
+    find_all('.col-links a.screenshot').forEach(function(elem) {
+        elem.addEventListener("click",
+                              function(event) {
+                                  var node = elem;
+                                  while (node && !node.classList.contains('results-table-row')) {
+                                      node = node.parentNode;
+                                  }
+                                  if (node != null) {
+                                      if (node.nextSibling &&
+                                          node.nextSibling.classList.contains("debug")) {
+                                          var href = find('.screenshot img', node.nextSibling).src;
+                                          window.open(href);
+                                      }
+                                  }
+                                  event.preventDefault();
+                              }, false)
+    });
+
+    find_all('.screenshot a').forEach(function(elem) {
+        elem.addEventListener("click",
+                              function(event) {
+                                  window.open(find('img', elem).getAttribute('src'));
+                                  event.preventDefault();
+                              }, false)
+    });
+
+    find_all('.sortable').forEach(function(elem) {
+        elem.addEventListener("click",
+                              function(event) {
+                                  toggle_sort_states(elem);
+                                  var colIndex = toArray(elem.parentNode.childNodes).indexOf(elem);
+                                  var key = elem.classList.contains('numeric') ? key_num : key_alpha;
+                                  sort_table(elem, key(colIndex));
+                              }, false)
+    });
+
+});
+
+function sort_table(clicked, key_func) {
+    one_row_for_data();
+    var rows = find_all('.results-table-row');
+    var reversed = !clicked.classList.contains('asc');
+
+    var sorted_rows = sort(rows, key_func, reversed);
+
+    var parent = document.getElementById('results-table-body');
+    sorted_rows.forEach(function(elem) {
+        parent.appendChild(elem);
+    });
+
+    split_debug_onto_two_rows();
+}
+
+function sort(items, key_func, reversed) {
+    var sort_array = items.map(function(item, i) {
+        return [key_func(item), i];
+    });
+    var multiplier = reversed ? -1 : 1;
+
+    sort_array.sort(function(a, b) {
+        var key_a = a[0];
+        var key_b = b[0];
+        return multiplier * (key_a >= key_b ? 1 : -1);
+    });
+
+    return sort_array.map(function(item) {
+        var index = item[1];
+        return items[index];
+    });
+}
+
+function key_alpha(col_index) {
+    return function(elem) {
+        return elem.childNodes[col_index].firstChild.data.toLowerCase();
+    };
+}
+
+function key_num(col_index) {
+    return function(elem) {
+        return parseFloat(elem.childNodes[col_index].firstChild.data);
+    };
+}
+
+function reset_sort_headers() {
+    find_all('.sort-icon').forEach(function(elem) {
+        elem.parentNode.removeChild(elem);
+    });
+    find_all('.sortable').forEach(function(elem) {
+        var icon = document.createElement("div");
+        icon.className = "sort-icon";
+        icon.textContent = "vvv";
+        elem.insertBefore(icon, elem.firstChild);
+        elem.classList.remove("desc", "active");
+        elem.classList.add("asc", "inactive");
+    });
+}
+
+function toggle_sort_states(elem) {
+    //if active, toggle between asc and desc
+    if (elem.classList.contains('active')) {
+        elem.classList.toggle('asc');
+        elem.classList.toggle('desc');
+    }
+
+    //if inactive, reset all other functions and add ascending active
+    if (elem.classList.contains('inactive')) {
+        reset_sort_headers();
+        elem.classList.remove('inactive');
+        elem.classList.add('active');
+    }
+}
+
+function split_debug_onto_two_rows() {
+    find_all('tr.results-table-row').forEach(function(elem) {
+        var new_row = document.createElement("tr")
+        new_row.className = "debug";
+        elem.parentNode.insertBefore(new_row, elem.nextSibling);
+        find_all(".debug", elem).forEach(function (td_elem) {
+            if (find(".log", td_elem)) {
+                new_row.appendChild(td_elem);
+                td_elem.colSpan=5;
+            } else {
+                td_elem.parentNode.removeChild(td_elem);
+            }
+        });
+    });
+}
+
+function one_row_for_data() {
+    find_all('tr.results-table-row').forEach(function(elem) {
+        if (elem.nextSibling.classList.contains('debug')) {
+            toArray(elem.nextSibling.childNodes).forEach(
+                function (td_elem) {
+                    elem.appendChild(td_elem);
+                })
+        } else {
+            var new_td = document.createElement("td");
+            new_td.className = "debug";
+            elem.appendChild(new_td);
+        }
+    });
+}

testing/mozbase/mozlog/mozlog/formatters/html/style.css

@@ -0,0 +1,154 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+body {
+	font-family: Helvetica, Arial, sans-serif;
+	font-size: 12px;
+	min-width: 1200px;
+	color: #999;
+}
+h2 {
+	font-size: 16px;
+	color: black;
+}
+
+p {
+    color: black;
+}
+
+a {
+	color: #999;
+}
+
+table {
+	border-collapse: collapse;
+}
+
+/******************************
+ * SUMMARY INFORMATION
+ ******************************/
+
+#environment td {
+	padding: 5px;
+	border: 1px solid #E6E6E6;
+}
+
+#environment tr:nth-child(odd) {
+	background-color: #f6f6f6;
+}
+
+/******************************
+ * TEST RESULT COLORS
+ ******************************/
+span.pass, .pass .col-result {
+	color: green;
+}
+span.expected_fail, .expected_fail .col-result,
+span.expected_skip, .expected_skip .col-result,
+span.skip, .skip .col-result {
+	color: orange;
+}
+span.error, .error .col-result,
+span.fail, .fail .col-result,
+span.unexpected_error, .unexpected_error .col-result,
+span.unexpected_fail, .unexpected_fail .col-result,
+span.unexpected_pass, .unexpected_pass .col-result {
+	color: red;
+}
+
+/******************************
+ * RESULTS TABLE
+ * 
+ * 1. Table Layout
+ * 2. Debug
+ * 3. Sorting items
+ * 
+ ******************************/
+
+/*------------------
+ * 1. Table Layout
+ *------------------*/
+
+#results-table {
+	border: 1px solid #e6e6e6;
+	color: #999;
+	font-size: 12px;
+	width: 100%
+}
+
+#results-table th, #results-table td {
+	padding: 5px;
+	border: 1px solid #E6E6E6;
+	text-align: left
+}
+#results-table th {
+	font-weight: bold
+}
+
+/*------------------
+ * 2. Debug
+ *------------------*/
+
+.log:only-child {
+	height: inherit
+}
+.log {
+	background-color: #e6e6e6;
+	border: 1px solid #e6e6e6;
+	color: black;
+	display: block;
+	font-family: "Courier New", Courier, monospace;
+	height: 230px;
+	overflow-y: scroll;
+	padding: 5px;
+	white-space: pre-wrap
+}
+div.screenshot {
+	border: 1px solid #e6e6e6;
+	float: left;
+	margin-left: 5px;
+	height: 220px
+}
+div.screenshot img {
+	height: 220px
+}
+
+/*if the result is passed or xpassed don't show debug row*/
+.passed + .debug, .unexpected.pass + .debug {
+	display: none;
+}
+
+/*------------------
+ * 3. Sorting items
+ *------------------*/
+.sortable {
+	cursor: pointer;
+}
+
+.sort-icon {
+	font-size: 0px;
+	float: left;
+	margin-right: 5px;
+	margin-top: 5px;
+	/*triangle*/
+	width: 0;
+	height: 0;
+	border-left: 8px solid transparent;
+	border-right: 8px solid transparent;
+}
+
+.inactive .sort-icon {
+	/*finish triangle*/
+	border-top: 8px solid #E6E6E6;
+}
+
+.asc.active .sort-icon {
+	/*finish triangle*/
+	border-bottom: 8px solid #999;
+}
+
+.desc.active .sort-icon {
+	/*finish triangle*/
+	border-top: 8px solid #999;
+}

testing/mozbase/mozlog/mozlog/formatters/html/xmlgen.py

@@ -0,0 +1,283 @@
+"""
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+This file is originally from: https://bitbucket.org/hpk42/py, specifically:
+https://bitbucket.org/hpk42/py/src/980c8d526463958ee7cae678a7e4e9b054f36b94/py/_xmlgen.py?at=default
+by holger krekel, holger at merlinux eu. 2009
+"""
+import sys
+import re
+
+if sys.version_info >= (3, 0):
+    def u(s):
+        return s
+
+    def unicode(x):
+        if hasattr(x, '__unicode__'):
+            return x.__unicode__()
+        return str(x)
+else:
+    def u(s):
+        return unicode(s)
+    unicode = unicode
+
+
+class NamespaceMetaclass(type):
+
+    def __getattr__(self, name):
+        if name[:1] == '_':
+            raise AttributeError(name)
+        if self == Namespace:
+            raise ValueError("Namespace class is abstract")
+        tagspec = self.__tagspec__
+        if tagspec is not None and name not in tagspec:
+            raise AttributeError(name)
+        classattr = {}
+        if self.__stickyname__:
+            classattr['xmlname'] = name
+        cls = type(name, (self.__tagclass__,), classattr)
+        setattr(self, name, cls)
+        return cls
+
+
+class Tag(list):
+
+    class Attr(object):
+
+        def __init__(self, **kwargs):
+            self.__dict__.update(kwargs)
+
+    def __init__(self, *args, **kwargs):
+        super(Tag, self).__init__(args)
+        self.attr = self.Attr(**kwargs)
+
+    def __unicode__(self):
+        return self.unicode(indent=0)
+    __str__ = __unicode__
+
+    def unicode(self, indent=2):
+        l = []
+        SimpleUnicodeVisitor(l.append, indent).visit(self)
+        return u("").join(l)
+
+    def __repr__(self):
+        name = self.__class__.__name__
+        return "<%r tag object %d>" % (name, id(self))
+
+Namespace = NamespaceMetaclass('Namespace', (object, ), {
+    '__tagspec__': None,
+    '__tagclass__': Tag,
+    '__stickyname__': False,
+})
+
+
+class HtmlTag(Tag):
+
+    def unicode(self, indent=2):
+        l = []
+        HtmlVisitor(l.append, indent, shortempty=False).visit(self)
+        return u("").join(l)
+
+# exported plain html namespace
+
+
+class html(Namespace):
+    __tagclass__ = HtmlTag
+    __stickyname__ = True
+    __tagspec__ = dict([(x, 1) for x in (
+        'a,abbr,acronym,address,applet,area,b,bdo,big,blink,'
+        'blockquote,body,br,button,caption,center,cite,code,col,'
+        'colgroup,comment,dd,del,dfn,dir,div,dl,dt,em,embed,'
+        'fieldset,font,form,frameset,h1,h2,h3,h4,h5,h6,head,html,'
+        'i,iframe,img,input,ins,kbd,label,legend,li,link,listing,'
+        'map,marquee,menu,meta,multicol,nobr,noembed,noframes,'
+        'noscript,object,ol,optgroup,option,p,pre,q,s,script,'
+        'select,small,span,strike,strong,style,sub,sup,table,'
+        'tbody,td,textarea,tfoot,th,thead,title,tr,tt,u,ul,xmp,'
+        'base,basefont,frame,hr,isindex,param,samp,var'
+    ).split(',') if x])
+
+    class Style(object):
+
+        def __init__(self, **kw):
+            for x, y in kw.items():
+                x = x.replace('_', '-')
+                setattr(self, x, y)
+
+
+class raw(object):
+    """just a box that can contain a unicode string that will be
+    included directly in the output"""
+
+    def __init__(self, uniobj):
+        self.uniobj = uniobj
+
+
+class SimpleUnicodeVisitor(object):
+    """ recursive visitor to write unicode. """
+
+    def __init__(self, write, indent=0, curindent=0, shortempty=True):
+        self.write = write
+        self.cache = {}
+        self.visited = {}  # for detection of recursion
+        self.indent = indent
+        self.curindent = curindent
+        self.parents = []
+        self.shortempty = shortempty  # short empty tags or not
+
+    def visit(self, node):
+        """ dispatcher on node's class/bases name. """
+        cls = node.__class__
+        try:
+            visitmethod = self.cache[cls]
+        except KeyError:
+            for subclass in cls.__mro__:
+                visitmethod = getattr(self, subclass.__name__, None)
+                if visitmethod is not None:
+                    break
+            else:
+                visitmethod = self.__object
+            self.cache[cls] = visitmethod
+        visitmethod(node)
+
+    # the default fallback handler is marked private
+    # to avoid clashes with the tag name object
+    def __object(self, obj):
+        # self.write(obj)
+        self.write(escape(unicode(obj)))
+
+    def raw(self, obj):
+        self.write(obj.uniobj)
+
+    def list(self, obj):
+        assert id(obj) not in self.visited
+        self.visited[id(obj)] = 1
+        for elem in obj:
+            self.visit(elem)
+
+    def Tag(self, tag):
+        assert id(tag) not in self.visited
+        try:
+            tag.parent = self.parents[-1]
+        except IndexError:
+            tag.parent = None
+        self.visited[id(tag)] = 1
+        tagname = getattr(tag, 'xmlname', tag.__class__.__name__)
+        if self.curindent and not self._isinline(tagname):
+            self.write("\n" + u(' ') * self.curindent)
+        if tag:
+            self.curindent += self.indent
+            self.write(u('<%s%s>') % (tagname, self.attributes(tag)))
+            self.parents.append(tag)
+            for x in tag:
+                self.visit(x)
+            self.parents.pop()
+            self.write(u('</%s>') % tagname)
+            self.curindent -= self.indent
+        else:
+            nameattr = tagname + self.attributes(tag)
+            if self._issingleton(tagname):
+                self.write(u('<%s/>') % (nameattr,))
+            else:
+                self.write(u('<%s></%s>') % (nameattr, tagname))
+
+    def attributes(self, tag):
+        # serialize attributes
+        attrlist = dir(tag.attr)
+        attrlist.sort()
+        l = []
+        for name in attrlist:
+            res = self.repr_attribute(tag.attr, name)
+            if res is not None:
+                l.append(res)
+        l.extend(self.getstyle(tag))
+        return u("").join(l)
+
+    def repr_attribute(self, attrs, name):
+        if name[:2] != '__':
+            value = getattr(attrs, name)
+            if name.endswith('_'):
+                name = name[:-1]
+            if isinstance(value, raw):
+                insert = value.uniobj
+            else:
+                insert = escape(unicode(value))
+            return ' %s="%s"' % (name, insert)
+
+    def getstyle(self, tag):
+        """ return attribute list suitable for styling. """
+        try:
+            styledict = tag.style.__dict__
+        except AttributeError:
+            return []
+        else:
+            stylelist = [x + ': ' + y for x, y in styledict.items()]
+            return [u(' style="%s"') % u('; ').join(stylelist)]
+
+    def _issingleton(self, tagname):
+        """can (and will) be overridden in subclasses"""
+        return self.shortempty
+
+    def _isinline(self, tagname):
+        """can (and will) be overridden in subclasses"""
+        return False
+
+
+class HtmlVisitor(SimpleUnicodeVisitor):
+
+    single = dict([(x, 1) for x in
+                   ('br,img,area,param,col,hr,meta,link,base,'
+                    'input,frame').split(',')])
+    inline = dict([(x, 1) for x in
+                   ('a abbr acronym b basefont bdo big br cite code dfn em font '
+                    'i img input kbd label q s samp select small span strike '
+                    'strong sub sup textarea tt u var'.split(' '))])
+
+    def repr_attribute(self, attrs, name):
+        if name == 'class_':
+            value = getattr(attrs, name)
+            if value is None:
+                return
+        return super(HtmlVisitor, self).repr_attribute(attrs, name)
+
+    def _issingleton(self, tagname):
+        return tagname in self.single
+
+    def _isinline(self, tagname):
+        return tagname in self.inline
+
+
+class _escape:
+
+    def __init__(self):
+        self.escape = {
+            u('"'): u('&quot;'), u('<'): u('&lt;'), u('>'): u('&gt;'),
+            u('&'): u('&amp;'), u("'"): u('&apos;'),
+        }
+        self.charef_rex = re.compile(u("|").join(self.escape.keys()))
+
+    def _replacer(self, match):
+        return self.escape[match.group(0)]
+
+    def __call__(self, ustring):
+        """ xml-escape the given unicode string. """
+        ustring = unicode(ustring)
+        return self.charef_rex.sub(self._replacer, ustring)
+
+escape = _escape()

testing/mozbase/mozlog/mozlog/formatters/machformatter.py

@@ -0,0 +1,395 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import time
+from collections import defaultdict
+
+try:
+    import blessings
+except ImportError:
+    blessings = None
+
+import base
+from .process import strstatus
+
+
+def format_seconds(total):
+    """Format number of seconds to MM:SS.DD form."""
+    minutes, seconds = divmod(total, 60)
+    return '%2d:%05.2f' % (minutes, seconds)
+
+
+class NullTerminal(object):
+
+    def __getattr__(self, name):
+        return self._id
+
+    def _id(self, value):
+        return value
+
+
+class MachFormatter(base.BaseFormatter):
+
+    def __init__(self, start_time=None, write_interval=False, write_times=True,
+                 terminal=None, disable_colors=False):
+
+        if disable_colors:
+            terminal = None
+        elif terminal is None and blessings is not None:
+            terminal = blessings.Terminal()
+
+        if start_time is None:
+            start_time = time.time()
+        start_time = int(start_time * 1000)
+        self.start_time = start_time
+        self.write_interval = write_interval
+        self.write_times = write_times
+        self.status_buffer = {}
+        self.has_unexpected = {}
+        self.last_time = None
+        self.terminal = terminal
+        self.verbose = False
+        self._known_pids = set()
+
+        self.summary_values = {"tests": 0,
+                               "subtests": 0,
+                               "expected": 0,
+                               "unexpected": defaultdict(int),
+                               "skipped": 0}
+        self.summary_unexpected = []
+
+    def __call__(self, data):
+        s = base.BaseFormatter.__call__(self, data)
+        if s is None:
+            return
+
+        time = format_seconds(self._time(data))
+        action = data["action"].upper()
+        thread = data["thread"]
+
+        # Not using the NullTerminal here is a small optimisation to cut the number of
+        # function calls
+        if self.terminal is not None:
+            test = self._get_test_id(data)
+
+            time = self.terminal.blue(time)
+
+            color = None
+
+            if data["action"] == "test_end":
+                if "expected" not in data and not self.has_unexpected[test]:
+                    color = self.terminal.green
+                else:
+                    color = self.terminal.red
+            elif data["action"] in ("suite_start", "suite_end",
+                                    "test_start", "test_status"):
+                color = self.terminal.yellow
+            elif data["action"] == "crash":
+                color = self.terminal.red
+
+            if color is not None:
+                action = color(action)
+
+        return "%s %s: %s %s\n" % (time, action, thread, s)
+
+    def _get_test_id(self, data):
+        test_id = data.get("test")
+        if isinstance(test_id, list):
+            test_id = tuple(test_id)
+        return test_id
+
+    def _get_file_name(self, test_id):
+        if isinstance(test_id, (str, unicode)):
+            return test_id
+
+        if isinstance(test_id, tuple):
+            return "".join(test_id)
+
+        assert False, "unexpected test_id"
+
+    def suite_start(self, data):
+        self.summary_values = {"tests": 0,
+                               "subtests": 0,
+                               "expected": 0,
+                               "unexpected": defaultdict(int),
+                               "skipped": 0}
+        self.summary_unexpected = []
+        return "%i" % len(data["tests"])
+
+    def suite_end(self, data):
+        term = self.terminal if self.terminal is not None else NullTerminal()
+
+        heading = "Summary"
+        rv = ["", heading, "=" * len(heading), ""]
+
+        has_subtests = self.summary_values["subtests"] > 0
+
+        if has_subtests:
+            rv.append("Ran %i tests (%i parents, %i subtests)" %
+                      (self.summary_values["tests"] + self.summary_values["subtests"],
+                       self.summary_values["tests"],
+                       self.summary_values["subtests"]))
+        else:
+            rv.append("Ran %i tests" % self.summary_values["tests"])
+
+        rv.append("Expected results: %i" % self.summary_values["expected"])
+
+        unexpected_count = sum(self.summary_values["unexpected"].values())
+        if unexpected_count > 0:
+            unexpected_str = " (%s)" % ", ".join("%s: %i" % (key, value) for key, value in
+                                                 sorted(self.summary_values["unexpected"].items()))
+        else:
+            unexpected_str = ""
+
+        rv.append("Unexpected results: %i%s" % (unexpected_count, unexpected_str))
+
+        if self.summary_values["skipped"] > 0:
+            rv.append("Skipped: %i" % self.summary_values["skipped"])
+        rv.append("")
+
+        if not self.summary_values["unexpected"]:
+            rv.append(term.green("OK"))
+        else:
+            heading = "Unexpected Results"
+            rv.extend([heading, "=" * len(heading), ""])
+            if has_subtests:
+                for test_id, results in self.summary_unexpected:
+                    test = self._get_file_name(test_id)
+                    rv.extend([test, "-" * len(test)])
+                    for name, status, expected, message in results:
+                        if name is None:
+                            name = "[Parent]"
+                        rv.append("%s %s" % (self.format_expected(status, expected), name))
+            else:
+                for test_id, results in self.summary_unexpected:
+                    test = self._get_file_name(test_id)
+                    assert len(results) == 1
+                    name, status, expected, messge = results[0]
+                    assert name is None
+                    rv.append("%s %s" % (self.format_expected(status, expected), test))
+
+        return "\n".join(rv)
+
+    def format_expected(self, status, expected):
+        term = self.terminal if self.terminal is not None else NullTerminal()
+        if status == "ERROR":
+            color = term.red
+        else:
+            color = term.yellow
+
+        if expected in ("PASS", "OK"):
+            return color(status)
+
+        return color("%s expected %s" % (status, expected))
+
+    def test_start(self, data):
+        self.summary_values["tests"] += 1
+        return "%s" % (self._get_test_id(data),)
+
+    def test_end(self, data):
+        subtests = self._get_subtest_data(data)
+        unexpected = subtests["unexpected"]
+
+        message = data.get("message", "")
+        if "stack" in data:
+            stack = data["stack"]
+            if stack and stack[-1] != "\n":
+                stack += "\n"
+            message = stack + message
+
+        if "expected" in data:
+            parent_unexpected = True
+            expected_str = ", expected %s" % data["expected"]
+            unexpected.append((None, data["status"], data["expected"],
+                               message))
+        else:
+            parent_unexpected = False
+            expected_str = ""
+
+        test = self._get_test_id(data)
+
+        if unexpected:
+            self.summary_unexpected.append((test, unexpected))
+        self._update_summary(data)
+
+        # Reset the counts to 0
+        self.status_buffer[test] = {"count": 0, "unexpected": [], "pass": 0}
+        self.has_unexpected[test] = bool(unexpected)
+
+        if subtests["count"] != 0:
+            rv = "Harness %s%s. Subtests passed %i/%i. Unexpected %s" % (
+                data["status"], expected_str, subtests["pass"], subtests["count"],
+                len(unexpected))
+        else:
+            rv = "%s%s" % (data["status"], expected_str)
+
+        if unexpected:
+            rv += "\n"
+            if len(unexpected) == 1 and parent_unexpected:
+                rv += "%s" % unexpected[0][-1]
+            else:
+                for name, status, expected, message in unexpected:
+                    if name is None:
+                        name = "[Parent]"
+                    expected_str = "Expected %s, got %s" % (expected, status)
+                    rv += "%s\n" % ("\n".join([name, "-" * len(name), expected_str, message]))
+                rv = rv[:-1]
+        return rv
+
+    def valgrind_error(self, data):
+        rv = " " + data['primary'] + "\n"
+        for line in data['secondary']:
+            rv = rv + line + "\n"
+
+        return rv
+
+    def test_status(self, data):
+        self.summary_values["subtests"] += 1
+
+        test = self._get_test_id(data)
+        if test not in self.status_buffer:
+            self.status_buffer[test] = {"count": 0, "unexpected": [], "pass": 0}
+        self.status_buffer[test]["count"] += 1
+
+        message = data.get("message", "")
+        if "stack" in data:
+            if message:
+                message += "\n"
+            message += data["stack"]
+
+        if data["status"] == "PASS":
+            self.status_buffer[test]["pass"] += 1
+
+        self._update_summary(data)
+
+        rv = None
+        status, subtest = data["status"], data["subtest"]
+        unexpected = "expected" in data
+        if self.verbose:
+            if self.terminal is not None:
+                status = (self.terminal.red if unexpected else self.terminal.green)(status)
+            rv = " ".join([subtest, status, message])
+        elif unexpected:
+            # We only append an unexpected summary if it was not logged
+            # directly by verbose mode.
+            self.status_buffer[test]["unexpected"].append((subtest,
+                                                           status,
+                                                           data["expected"],
+                                                           message))
+        return rv
+
+    def _update_summary(self, data):
+        if "expected" in data:
+            self.summary_values["unexpected"][data["status"]] += 1
+        elif data["status"] == "SKIP":
+            self.summary_values["skipped"] += 1
+        else:
+            self.summary_values["expected"] += 1
+
+    def process_output(self, data):
+        rv = []
+
+        if "command" in data and data["process"] not in self._known_pids:
+            self._known_pids.add(data["process"])
+            rv.append('(pid:%s) Full command: %s' % (data["process"], data["command"]))
+
+        rv.append('(pid:%s) "%s"' % (data["process"], data["data"]))
+        return "\n".join(rv)
+
+    def crash(self, data):
+        test = self._get_test_id(data)
+
+        if data.get("stackwalk_returncode", 0) != 0 and not data.get("stackwalk_stderr"):
+            success = True
+        else:
+            success = False
+
+        rv = ["pid:%s. Test:%s. Minidump anaylsed:%s. Signature:[%s]" %
+              (data.get("pid", None), test, success, data["signature"])]
+
+        if data.get("minidump_path"):
+            rv.append("Crash dump filename: %s" % data["minidump_path"])
+
+        if data.get("stackwalk_returncode", 0) != 0:
+            rv.append("minidump_stackwalk exited with return code %d" %
+                      data["stackwalk_returncode"])
+
+        if data.get("stackwalk_stderr"):
+            rv.append("stderr from minidump_stackwalk:")
+            rv.append(data["stackwalk_stderr"])
+        elif data.get("stackwalk_stdout"):
+            rv.append(data["stackwalk_stdout"])
+
+        if data.get("stackwalk_errors"):
+            rv.extend(data.get("stackwalk_errors"))
+
+        rv = "\n".join(rv)
+        if not rv[-1] == "\n":
+            rv += "\n"
+
+        return rv
+
+    def process_start(self, data):
+        rv = "Started process `%s`" % data['process']
+        desc = data.get('command')
+        if desc:
+            rv = '%s (%s)' % (rv, desc)
+        return rv
+
+    def process_exit(self, data):
+        return "%s: %s" % (data['process'], strstatus(data['exitcode']))
+
+    def log(self, data):
+        level = data.get("level").upper()
+
+        if self.terminal is not None:
+            if level in ("CRITICAL", "ERROR"):
+                level = self.terminal.red(level)
+            elif level == "WARNING":
+                level = self.terminal.yellow(level)
+            elif level == "INFO":
+                level = self.terminal.blue(level)
+
+        if data.get('component'):
+            rv = " ".join([data["component"], level, data["message"]])
+        else:
+            rv = "%s %s" % (level, data["message"])
+
+        if "stack" in data:
+            rv += "\n%s" % data["stack"]
+
+        return rv
+
+    def lint(self, data):
+        term = self.terminal if self.terminal is not None else NullTerminal()
+        fmt = "{path}  {c1}{lineno}{column}  {c2}{level}{normal}  {message}" \
+              "  {c1}{rule}({linter}){normal}"
+        message = fmt.format(
+            path=data["path"],
+            normal=term.normal,
+            c1=term.grey,
+            c2=term.red if data["level"] == 'error' else term.yellow,
+            lineno=str(data["lineno"]),
+            column=(":" + str(data["column"])) if data.get("column") else "",
+            level=data["level"],
+            message=data["message"],
+            rule='{} '.format(data["rule"]) if data.get("rule") else "",
+            linter=data["linter"].lower() if data.get("linter") else "",
+        )
+
+        return message
+
+    def _get_subtest_data(self, data):
+        test = self._get_test_id(data)
+        return self.status_buffer.get(test, {"count": 0, "unexpected": [], "pass": 0})
+
+    def _time(self, data):
+        entry_time = data["time"]
+        if self.write_interval and self.last_time is not None:
+            t = entry_time - self.last_time
+            self.last_time = entry_time
+        else:
+            t = entry_time - self.start_time
+
+        return t / 1000.

testing/mozbase/mozlog/mozlog/formatters/process.py

@@ -0,0 +1,55 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import os
+import signal
+
+# a dict cache of signal number -> signal name
+_SIG_NAME = None
+
+
+def strsig(n):
+    """
+    Translate a process signal identifier to a human readable string.
+    """
+    global _SIG_NAME
+
+    if _SIG_NAME is None:
+        # cache signal names
+        _SIG_NAME = {}
+        for k in dir(signal):
+            if (k.startswith("SIG")
+                and not k.startswith("SIG_")
+                    and k != "SIGCLD" and k != "SIGPOLL"):
+
+                _SIG_NAME[getattr(signal, k)] = k
+
+        # Realtime signals mostly have no names
+        if hasattr(signal, "SIGRTMIN") and hasattr(signal, "SIGRTMAX"):
+            for r in range(signal.SIGRTMIN + 1, signal.SIGRTMAX + 1):
+                _SIG_NAME[r] = "SIGRTMIN+" + str(r - signal.SIGRTMIN)
+
+    if n < 0 or n >= signal.NSIG:
+        return "out-of-range signal, number %s" % n
+    try:
+        return _SIG_NAME[n]
+    except KeyError:
+        return "unrecognized signal, number %s" % n
+
+
+def strstatus(status):
+    """
+    Returns a human readable string of a process exit code, as returned
+    by the subprocess module.
+    """
+    # 'status' is the exit status
+    if os.name != 'posix':
+        # Windows error codes are easier to look up if printed in hexadecimal
+        if status < 0:
+            status += 2**32
+        return "exit %x" % status
+    elif status >= 0:
+        return "exit %d" % status
+    else:
+        return "killed by %s" % strsig(-status)

testing/mozbase/mozlog/mozlog/formatters/tbplformatter.py

@@ -0,0 +1,244 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import functools
+from collections import deque
+
+from .base import BaseFormatter
+from .process import strstatus
+
+
+def output_subtests(func):
+    @functools.wraps(func)
+    def inner(self, data):
+        if self.subtests_count:
+            return self._format_subtests(data.get("component")) + func(self, data)
+        else:
+            return func(self, data)
+    return inner
+
+
+class TbplFormatter(BaseFormatter):
+    """Formatter that formats logs in the legacy formatting format used by TBPL
+    This is intended to be used to preserve backward compatibility with existing tools
+    hand-parsing this format.
+    """
+    def __init__(self, compact=False):
+        self.suite_start_time = None
+        self.test_start_times = {}
+        self.buffer = None
+        self.compact = compact
+        self.subtests_count = 0
+
+    @property
+    def compact(self):
+        return self._compact
+
+    @compact.setter
+    def compact(self, value):
+        self._compact = value
+        if value:
+            self.buffer = deque([], 10)
+        else:
+            self.buffer = None
+
+    def __call__(self, data):
+        return getattr(self, data["action"])(data)
+
+    def _format_subtests(self, component, subtract_context=False):
+        count = self.subtests_count
+        if subtract_context:
+            count -= len(self.buffer)
+        self.subtests_count = 0
+        return self._log({"level": "INFO",
+                          "message": "." * count,
+                          "component": component})
+
+    @output_subtests
+    def log(self, data):
+        return self._log(data)
+
+    def _log(self, data):
+        if data.get('component'):
+            message = "%s %s" % (data["component"], data["message"])
+        else:
+            message = data["message"]
+
+        if "stack" in data:
+            message += "\n%s" % data["stack"]
+
+        return "%s\n" % message
+
+    @output_subtests
+    def process_output(self, data):
+        return "PROCESS | %(process)s | %(data)s\n" % data
+
+    @output_subtests
+    def process_start(self, data):
+        msg = "TEST-INFO | started process %s" % data['process']
+        if 'command' in data:
+            msg = '%s (%s)' % (msg, data['command'])
+        return msg + '\n'
+
+    @output_subtests
+    def process_exit(self, data):
+        return "TEST-INFO | %s: %s\n" % (data['process'],
+                                         strstatus(data['exitcode']))
+
+    @output_subtests
+    def crash(self, data):
+        id = data["test"] if "test" in data else "pid: %s" % data["process"]
+
+        signature = data["signature"] if data["signature"] else "unknown top frame"
+        rv = ["PROCESS-CRASH | %s | application crashed [%s]" % (id, signature)]
+
+        if data.get("minidump_path"):
+            rv.append("Crash dump filename: %s" % data["minidump_path"])
+
+        if data.get("stackwalk_stderr"):
+            rv.append("stderr from minidump_stackwalk:")
+            rv.append(data["stackwalk_stderr"])
+        elif data.get("stackwalk_stdout"):
+            rv.append(data["stackwalk_stdout"])
+
+        if data.get("stackwalk_returncode", 0) != 0:
+            rv.append("minidump_stackwalk exited with return code %d" %
+                      data["stackwalk_returncode"])
+
+        if data.get("stackwalk_errors"):
+            rv.extend(data.get("stackwalk_errors"))
+
+        rv = "\n".join(rv)
+        if not rv[-1] == "\n":
+            rv += "\n"
+
+        return rv
+
+    def suite_start(self, data):
+        self.suite_start_time = data["time"]
+        return "SUITE-START | Running %i tests\n" % len(data["tests"])
+
+    def test_start(self, data):
+        self.test_start_times[self.test_id(data["test"])] = data["time"]
+
+        return "TEST-START | %s\n" % data["test"]
+
+    def test_status(self, data):
+        if self.compact:
+            if "expected" in data:
+                rv = []
+                rv.append(self._format_subtests(data.get("component"), subtract_context=True))
+                rv.extend(self._format_status(item) for item in self.buffer)
+                rv.append(self._format_status(data))
+                self.buffer.clear()
+                return "".join(rv)
+            else:
+                self.subtests_count += 1
+                self.buffer.append(data)
+        else:
+            return self._format_status(data)
+
+    def _format_status(self, data):
+        message = "- " + data["message"] if "message" in data else ""
+        if "stack" in data:
+            message += "\n%s" % data["stack"]
+        if message and message[-1] == "\n":
+            message = message[:-1]
+
+        if "expected" in data:
+            if not message:
+                message = "- expected %s" % data["expected"]
+            failure_line = "TEST-UNEXPECTED-%s | %s | %s %s\n" % (
+                data["status"], data["test"], data["subtest"],
+                message)
+            if data["expected"] != "PASS":
+                info_line = "TEST-INFO | expected %s\n" % data["expected"]
+                return failure_line + info_line
+            return failure_line
+
+        return "TEST-%s | %s | %s %s\n" % (
+            data["status"], data["test"], data["subtest"],
+            message)
+
+    def test_end(self, data):
+        rv = []
+        if self.compact and self.subtests_count:
+            print_context = "expected" in data
+            rv.append(self._format_subtests(data.get("component"),
+                                            subtract_context=print_context))
+            if print_context:
+                rv.extend(self._format_status(item) for item in self.buffer)
+            self.buffer.clear()
+
+        test_id = self.test_id(data["test"])
+        duration_msg = ""
+
+        if test_id in self.test_start_times:
+            start_time = self.test_start_times.pop(test_id)
+            time = data["time"] - start_time
+            duration_msg = "took %ims" % time
+
+        if "expected" in data:
+            message = data.get("message", "")
+            if not message:
+                message = "expected %s" % data["expected"]
+            if "stack" in data:
+                message += "\n%s" % data["stack"]
+            if message and message[-1] == "\n":
+                message = message[:-1]
+
+            extra = data.get("extra", {})
+            if "reftest_screenshots" in extra:
+                screenshots = extra["reftest_screenshots"]
+                if len(screenshots) == 3:
+                    message += ("\nREFTEST   IMAGE 1 (TEST): data:image/png;base64,%s\n"
+                                "REFTEST   IMAGE 2 (REFERENCE): data:image/png;base64,%s") % (
+                                    screenshots[0]["screenshot"],
+                                    screenshots[2]["screenshot"])
+                elif len(screenshots) == 1:
+                    message += "\nREFTEST   IMAGE: data:image/png;base64,%(image1)s" \
+                               % screenshots[0]["screenshot"]
+
+            failure_line = "TEST-UNEXPECTED-%s | %s | %s\n" % (
+                data["status"], test_id, message)
+
+            if data["expected"] not in ("PASS", "OK"):
+                expected_msg = "expected %s | " % data["expected"]
+            else:
+                expected_msg = ""
+            info_line = "TEST-INFO %s%s\n" % (expected_msg, duration_msg)
+
+            return failure_line + info_line
+
+        sections = ["TEST-%s" % data['status'], test_id]
+        if duration_msg:
+            sections.append(duration_msg)
+        rv.append(' | '.join(sections) + '\n')
+        return "".join(rv)
+
+    def suite_end(self, data):
+        start_time = self.suite_start_time
+        time = int((data["time"] - start_time) / 1000)
+
+        return "SUITE-END | took %is\n" % time
+
+    def test_id(self, test_id):
+        if isinstance(test_id, (str, unicode)):
+            return test_id
+        else:
+            return tuple(test_id)
+
+    @output_subtests
+    def valgrind_error(self, data):
+        rv = "TEST-UNEXPECTED-VALGRIND-ERROR | " + data['primary'] + "\n"
+        for line in data['secondary']:
+            rv = rv + line + "\n"
+
+        return rv
+
+    def lint(self, data):
+        fmt = "TEST-UNEXPECTED-{level} | {path}:{lineno}{column} | {message} ({rule})"
+        data["column"] = ":%s" % data["column"] if data["column"] else ""
+        data['rule'] = data['rule'] or data['linter'] or ""
+        return fmt.append(fmt.format(**data))

testing/mozbase/mozlog/mozlog/formatters/unittest.py

@@ -0,0 +1,60 @@
+#!/usr/bin/env python
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import base
+
+
+class UnittestFormatter(base.BaseFormatter):
+    """Formatter designed to produce output in a format like that used by
+    the ``unittest`` module in the standard library."""
+
+    def __init__(self):
+        self.fails = []
+        self.errors = []
+        self.tests_run = 0
+        self.start_time = None
+        self.end_time = None
+
+    def suite_start(self, data):
+        self.start_time = data["time"]
+
+    def test_start(self, data):
+        self.tests_run += 1
+
+    def test_end(self, data):
+        char = "."
+        if "expected" in data:
+            status = data["status"]
+            char = {"FAIL": "F",
+                    "ERROR": "E",
+                    "PASS": "X"}[status]
+
+            if status == "FAIL":
+                self.fails.append(data)
+            elif status == "ERROR":
+                self.errors.append(data)
+
+        elif data["status"] == "SKIP":
+            char = "S"
+        return char
+
+    def suite_end(self, data):
+        self.end_time = data["time"]
+        summary = "\n".join([self.output_fails(),
+                             self.output_errors(),
+                             self.output_summary()])
+        return "\n%s\n" % summary
+
+    def output_fails(self):
+        return "\n".join("FAIL %(test)s\n%(message)s\n" % data
+                         for data in self.fails)
+
+    def output_errors(self):
+        return "\n".join("ERROR %(test)s\n%(message)s" % data
+                         for data in self.errors)
+
+    def output_summary(self):
+        return ("Ran %i tests in %.1fs" % (self.tests_run,
+                                           (self.end_time - self.start_time) / 1000))

testing/mozbase/mozlog/mozlog/formatters/xunit.py

@@ -0,0 +1,101 @@
+import types
+from xml.etree import ElementTree
+
+import base
+
+
+def format_test_id(test_id):
+    """Take a test id and return something that looks a bit like
+    a class path"""
+    if type(test_id) not in types.StringTypes:
+        # Not sure how to deal with reftests yet
+        raise NotImplementedError
+
+    # Turn a path into something like a class heirachy
+    return test_id.replace('.', '_').replace('/', ".")
+
+
+class XUnitFormatter(base.BaseFormatter):
+    """Formatter that produces XUnit-style XML output.
+
+    The tree is created in-memory so this formatter may be problematic
+    with very large log files.
+
+    Note that the data model isn't a perfect match. In
+    particular XUnit assumes that each test has a unittest-style
+    class name and function name, which isn't the case for us. The
+    implementation currently replaces path names with something that
+    looks like class names, but this doesn't work for test types that
+    actually produce class names, or for test types that have multiple
+    components in their test id (e.g. reftests)."""
+
+    def __init__(self):
+        self.tree = ElementTree.ElementTree()
+        self.root = None
+        self.suite_start_time = None
+        self.test_start_time = None
+
+        self.tests_run = 0
+        self.errors = 0
+        self.failures = 0
+        self.skips = 0
+
+    def suite_start(self, data):
+        self.root = ElementTree.Element("testsuite")
+        self.tree.root = self.root
+        self.suite_start_time = data["time"]
+
+    def test_start(self, data):
+        self.tests_run += 1
+        self.test_start_time = data["time"]
+
+    def _create_result(self, data):
+        test = ElementTree.SubElement(self.root, "testcase")
+        name = format_test_id(data["test"])
+        extra = data.get('extra') or {}
+        test.attrib["classname"] = extra.get('class_name') or name
+
+        if "subtest" in data:
+            test.attrib["name"] = data["subtest"]
+            # We generally don't know how long subtests take
+            test.attrib["time"] = "0"
+        else:
+            if "." in name:
+                test_name = name.rsplit(".", 1)[1]
+            else:
+                test_name = name
+            test.attrib["name"] = extra.get('method_name') or test_name
+            test.attrib["time"] = "%.2f" % ((data["time"] - self.test_start_time) / 1000.0)
+
+        if ("expected" in data and data["expected"] != data["status"]):
+            if data["status"] in ("NOTRUN", "ASSERT", "ERROR"):
+                result = ElementTree.SubElement(test, "error")
+                self.errors += 1
+            else:
+                result = ElementTree.SubElement(test, "failure")
+                self.failures += 1
+
+            result.attrib["message"] = "Expected %s, got %s" % (data["expected"], data["status"])
+            result.text = '%s\n%s' % (data.get('stack', ''), data.get('message', ''))
+
+        elif data["status"] == "SKIP":
+            result = ElementTree.SubElement(test, "skipped")
+            self.skips += 1
+
+    def test_status(self, data):
+        self._create_result(data)
+
+    def test_end(self, data):
+        self._create_result(data)
+
+    def suite_end(self, data):
+        self.root.attrib.update({"tests": str(self.tests_run),
+                                 "errors": str(self.errors),
+                                 "failures": str(self.failures),
+                                 "skips": str(self.skips),
+                                 "time":   "%.2f" % (
+                                     (data["time"] - self.suite_start_time) / 1000.0)})
+        xml_string = ElementTree.tostring(self.root, encoding="utf8")
+        # pretty printing can not be done from xml.etree
+        from xml.dom import minidom
+        return minidom.parseString(xml_string).toprettyxml(encoding="utf8")

testing/mozbase/mozlog/mozlog/handlers/__init__.py

@@ -0,0 +1,11 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from .base import LogLevelFilter, StreamHandler, BaseHandler
+from .statushandler import StatusHandler
+from .bufferhandler import BufferHandler
+from .valgrindhandler import ValgrindHandler
+
+__all__ = ['LogLevelFilter', 'StreamHandler', 'BaseHandler',
+           'StatusHandler', 'BufferHandler', 'ValgrindHandler']

testing/mozbase/mozlog/mozlog/handlers/base.py

@@ -0,0 +1,105 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from threading import Lock
+import codecs
+
+from ..structuredlog import log_levels
+
+
+class BaseHandler(object):
+    """A base handler providing message handling facilities to
+    derived classes.
+
+    :param inner: A handler-like callable that may receive messages
+                  from a log user.
+    """
+
+    def __init__(self, inner):
+        self.wrapped = []
+        if hasattr(inner, "handle_message"):
+            self.wrapped.append(inner)
+        self.message_handlers = {}
+
+    def register_message_handlers(self, topic, handlers):
+        self.message_handlers[topic] = handlers
+
+    def handle_message(self, topic, cmd, *args):
+        """Handles a message for the given topic by calling a subclass-defined
+        callback for the command.
+
+        :param topic: The topic of the broadcasted message. Handlers opt-in to
+                      receiving messages by identifying a topic when calling
+                      register_message_handlers.
+        :param command: The command to issue. This is a string that corresponds
+                        to a callback provided by the target.
+        :param arg: Arguments to pass to the identified message callback, if any.
+        """
+        rv = []
+        if topic in self.message_handlers and cmd in self.message_handlers[topic]:
+            rv.append(self.message_handlers[topic][cmd](*args))
+        for inner in self.wrapped:
+            rv.extend(inner.handle_message(topic, cmd, *args))
+        return rv
+
+
+class LogLevelFilter(BaseHandler):
+    """Handler that filters out messages with action of log and a level
+    lower than some specified level.
+
+    :param inner: Handler to use for messages that pass this filter
+    :param level: Minimum log level to process
+    """
+
+    def __init__(self, inner, level):
+        BaseHandler.__init__(self, inner)
+        self.inner = inner
+        self.level = log_levels[level.upper()]
+
+    def __call__(self, item):
+        if (item["action"] != "log" or
+                log_levels[item["level"].upper()] <= self.level):
+            return self.inner(item)
+
+
+class StreamHandler(BaseHandler):
+    """Handler for writing to a file-like object
+
+    :param stream: File-like object to write log messages to
+    :param formatter: formatter to convert messages to string format
+    """
+
+    _lock = Lock()
+
+    def __init__(self, stream, formatter):
+        BaseHandler.__init__(self, formatter)
+        assert stream is not None
+        # This is a hack to deal with the case where we are passed a
+        # StreamWriter (e.g. by mach for stdout). A StreamWriter requires
+        # the code to handle unicode in exactly the opposite way compared
+        # to a normal stream i.e. you always have to pass in a Unicode
+        # object rather than a string object. Cope with that by extracting
+        # the underlying raw stream.
+        if isinstance(stream, codecs.StreamWriter):
+            stream = stream.stream
+
+        self.formatter = formatter
+        self.stream = stream
+
+    def __call__(self, data):
+        """Write a log message.
+
+        :param data: Structured log message dictionary."""
+        formatted = self.formatter(data)
+        if not formatted:
+            return
+        with self._lock:
+            if isinstance(formatted, unicode):
+                self.stream.write(formatted.encode("utf-8", "replace"))
+            elif isinstance(formatted, str):
+                self.stream.write(formatted)
+            else:
+                assert False, "Got output from the formatter of an unexpected type"
+
+            self.stream.flush()

testing/mozbase/mozlog/mozlog/handlers/bufferhandler.py

@@ -0,0 +1,83 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from .base import BaseHandler
+
+
+class BufferHandler(BaseHandler):
+    """Handler that maintains a circular buffer of messages based on the
+    size and actions specified by a user.
+
+    :param inner: The underlying handler used to emit messages.
+    :param message_limit: The maximum number of messages to retain for
+                          context. If None, the buffer will grow without limit.
+    :param buffered_actions: The set of actions to include in the buffer
+                             rather than log directly.
+    """
+
+    def __init__(self, inner, message_limit=100, buffered_actions=None):
+        BaseHandler.__init__(self, inner)
+        self.inner = inner
+        self.message_limit = message_limit
+        if buffered_actions is None:
+            buffered_actions = ['log', 'test_status']
+        self.buffered_actions = set(buffered_actions)
+        self._buffering = True
+
+        if self.message_limit is not None:
+            self._buffer = [None] * self.message_limit
+            self._buffer_pos = 0
+        else:
+            self._buffer = []
+
+        self.register_message_handlers("buffer", {
+            "on": self._enable_buffering,
+            "off": self._disable_buffering,
+            "flush": self._flush_buffered,
+            "clear": self._clear_buffer,
+        })
+
+    def __call__(self, data):
+        action = data['action']
+        if 'bypass_mozlog_buffer' in data:
+            data.pop('bypass_mozlog_buffer')
+            self.inner(data)
+            return
+        if not self._buffering or action not in self.buffered_actions:
+            self.inner(data)
+            return
+
+        self._add_message(data)
+
+    def _add_message(self, data):
+        if self.message_limit is None:
+            self._buffer.append(data)
+        else:
+            self._buffer[self._buffer_pos] = data
+            self._buffer_pos = (self._buffer_pos + 1) % self.message_limit
+
+    def _enable_buffering(self):
+        self._buffering = True
+
+    def _disable_buffering(self):
+        self._buffering = False
+
+    def _clear_buffer(self):
+        """Clear the buffer of unwanted messages."""
+        current_size = len([m for m in self._buffer if m is not None])
+        if self.message_limit is not None:
+            self._buffer = [None] * self.message_limit
+        else:
+            self._buffer = []
+        return current_size
+
+    def _flush_buffered(self):
+        """Logs the contents of the current buffer"""
+        for msg in self._buffer[self._buffer_pos:]:
+            if msg is not None:
+                self.inner(msg)
+        for msg in self._buffer[:self._buffer_pos]:
+            if msg is not None:
+                self.inner(msg)
+        return self._clear_buffer()

testing/mozbase/mozlog/mozlog/handlers/statushandler.py

@@ -0,0 +1,52 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from collections import (
+    defaultdict,
+    namedtuple,
+)
+
+
+RunSummary = namedtuple("RunSummary",
+                        ("unexpected_statuses",
+                         "expected_statuses",
+                         "log_level_counts",
+                         "action_counts"))
+
+
+class StatusHandler(object):
+    """A handler used to determine an overall status for a test run according
+    to a sequence of log messages."""
+
+    def __init__(self):
+        # The count of each type of unexpected result status (includes tests and subtests)
+        self.unexpected_statuses = defaultdict(int)
+        # The count of each type of expected result status (includes tests and subtests)
+        self.expected_statuses = defaultdict(int)
+        # The count of actions logged
+        self.action_counts = defaultdict(int)
+        # The count of messages logged at each log level
+        self.log_level_counts = defaultdict(int)
+
+    def __call__(self, data):
+        action = data['action']
+        self.action_counts[action] += 1
+
+        if action == 'log':
+            self.log_level_counts[data['level']] += 1
+
+        if action in ('test_status', 'test_end'):
+            status = data['status']
+            if 'expected' in data:
+                self.unexpected_statuses[status] += 1
+            else:
+                self.expected_statuses[status] += 1
+
+    def summarize(self):
+        return RunSummary(
+            dict(self.unexpected_statuses),
+            dict(self.expected_statuses),
+            dict(self.log_level_counts),
+            dict(self.action_counts),
+        )

testing/mozbase/mozlog/mozlog/handlers/valgrindhandler.py

@@ -0,0 +1,140 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from .base import BaseHandler
+import re
+
+
+class ValgrindHandler(BaseHandler):
+
+    def __init__(self, inner):
+        BaseHandler.__init__(self, inner)
+        self.inner = inner
+        self.vFilter = ValgrindFilter()
+
+    def __call__(self, data):
+        tmp = self.vFilter(data)
+        if tmp is not None:
+            self.inner(tmp)
+
+
+class ValgrindFilter(object):
+    '''
+    A class for handling Valgrind output.
+
+    Valgrind errors look like this:
+
+    ==60741== 40 (24 direct, 16 indirect) bytes in 1 blocks are definitely lost in loss
+                  record 2,746 of 5,235
+    ==60741==    at 0x4C26B43: calloc (vg_replace_malloc.c:593)
+    ==60741==    by 0x63AEF65: PR_Calloc (prmem.c:443)
+    ==60741==    by 0x69F236E: PORT_ZAlloc_Util (secport.c:117)
+    ==60741==    by 0x69F1336: SECITEM_AllocItem_Util (secitem.c:28)
+    ==60741==    by 0xA04280B: ffi_call_unix64 (in /builds/slave/m-in-l64-valgrind-000000000000/objdir/toolkit/library/libxul.so) # noqa
+    ==60741==    by 0xA042443: ffi_call (ffi64.c:485)
+
+    For each such error, this class extracts most or all of the first (error
+    kind) line, plus the function name in each of the first few stack entries.
+    With this data it constructs and prints a TEST-UNEXPECTED-FAIL message that
+    TBPL will highlight.
+
+    It buffers these lines from which text is extracted so that the
+    TEST-UNEXPECTED-FAIL message can be printed before the full error.
+
+    Parsing the Valgrind output isn't ideal, and it may break in the future if
+    Valgrind changes the format of the messages, or introduces new error kinds.
+    To protect against this, we also count how many lines containing
+    "<insert_a_suppression_name_here>" are seen. Thanks to the use of
+    --gen-suppressions=yes, exactly one of these lines is present per error. If
+    the count of these lines doesn't match the error count found during
+    parsing, then the parsing has missed one or more errors and we can fail
+    appropriately.
+    '''
+
+    def __init__(self):
+        # The regexps in this list match all of Valgrind's errors. Note that
+        # Valgrind is English-only, so we don't have to worry about
+        # localization.
+        self.re_error = \
+            re.compile(
+                r'==\d+== (' +
+                r'(Use of uninitialised value of size \d+)|' +
+                r'(Conditional jump or move depends on uninitialised value\(s\))|' +
+                r'(Syscall param .* contains uninitialised byte\(s\))|' +
+                r'(Syscall param .* points to (unaddressable|uninitialised) byte\(s\))|' +
+                r'((Unaddressable|Uninitialised) byte\(s\) found during client check request)|' +
+                r'(Invalid free\(\) / delete / delete\[\] / realloc\(\))|' +
+                r'(Mismatched free\(\) / delete / delete \[\])|' +
+                r'(Invalid (read|write) of size \d+)|' +
+                r'(Jump to the invalid address stated on the next line)|' +
+                r'(Source and destination overlap in .*)|' +
+                r'(.* bytes in .* blocks are .* lost)' +
+                r')'
+            )
+        # Match identifer chars, plus ':' for namespaces, and '\?' in order to
+        # match "???" which Valgrind sometimes produces.
+        self.re_stack_entry = \
+            re.compile(r'^==\d+==.*0x[A-Z0-9]+: ([A-Za-z0-9_:\?]+)')
+        self.re_suppression = \
+            re.compile(r' *<insert_a_suppression_name_here>')
+        self.error_count = 0
+        self.suppression_count = 0
+        self.number_of_stack_entries_to_get = 0
+        self.curr_failure_msg = ""
+        self.buffered_lines = []
+
+    # Takes a message and returns a message
+    def __call__(self, msg):
+        # Pass through everything that isn't plain text
+        if msg['action'] != 'log':
+            return msg
+
+        line = msg['message']
+        output_message = None
+        if self.number_of_stack_entries_to_get == 0:
+            # Look for the start of a Valgrind error.
+            m = re.search(self.re_error, line)
+            if m:
+                self.error_count += 1
+                self.number_of_stack_entries_to_get = 4
+                self.curr_failure_msg = m.group(1) + " at "
+                self.buffered_lines = [line]
+            else:
+                output_message = msg
+
+        else:
+            # We've recently found a Valgrind error, and are now extracting
+            # details from the first few stack entries.
+            self.buffered_lines.append(line)
+            m = re.match(self.re_stack_entry, line)
+            if m:
+                self.curr_failure_msg += m.group(1)
+            else:
+                self.curr_failure_msg += '?!?'
+
+            self.number_of_stack_entries_to_get -= 1
+            if self.number_of_stack_entries_to_get != 0:
+                self.curr_failure_msg += ' / '
+            else:
+                # We've finished getting the first few stack entries.  Emit
+                # the failure action, comprising the primary message and the
+                # buffered lines, and then reset state.  Copy the mandatory
+                # fields from the incoming message, since there's nowhere
+                # else to get them from.
+                output_message = {  # Mandatory fields
+                    u"action": "valgrind_error",
+                    u"time":   msg["time"],
+                    u"thread": msg["thread"],
+                    u"pid":    msg["pid"],
+                    u"source": msg["source"],
+                    # valgrind_error specific fields
+                    u"primary":   self.curr_failure_msg,
+                    u"secondary": self.buffered_lines}
+                self.curr_failure_msg = ""
+                self.buffered_lines = []
+
+        if re.match(self.re_suppression, line):
+            self.suppression_count += 1
+
+        return output_message

testing/mozbase/mozlog/mozlog/logtypes.py

@@ -0,0 +1,204 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+convertor_registry = {}
+missing = object()
+no_default = object()
+
+
+class log_action(object):
+
+    def __init__(self, *args):
+        self.args = {}
+
+        self.args_no_default = []
+        self.args_with_default = []
+
+        # These are the required fields in a log message that usually aren't
+        # supplied by the caller, but can be in the case of log_raw
+        self.default_args = [
+            Unicode("action"),
+            Int("time"),
+            Unicode("thread"),
+            Int("pid", default=None),
+            Unicode("source"),
+            Unicode("component")]
+
+        for arg in args:
+            if arg.default is no_default:
+                self.args_no_default.append(arg.name)
+            else:
+                self.args_with_default.append(arg.name)
+
+            if arg.name in self.args:
+                raise ValueError("Repeated argument name %s" % arg.name)
+
+            self.args[arg.name] = arg
+
+        for extra in self.default_args:
+            self.args[extra.name] = extra
+
+    def __call__(self, f):
+        convertor_registry[f.__name__] = self
+        converter = self
+
+        def inner(self, *args, **kwargs):
+            data = converter.convert(*args, **kwargs)
+            return f(self, data)
+
+        if hasattr(f, '__doc__'):
+            setattr(inner, '__doc__', f.__doc__)
+
+        return inner
+
+    def convert(self, *args, **kwargs):
+        data = {}
+        values = {}
+        values.update(kwargs)
+
+        positional_no_default = [item for item in self.args_no_default if item not in values]
+
+        num_no_default = len(positional_no_default)
+
+        if len(args) < num_no_default:
+            raise TypeError("Too few arguments")
+
+        if len(args) > num_no_default + len(self.args_with_default):
+            raise TypeError("Too many arguments")
+
+        for i, name in enumerate(positional_no_default):
+            values[name] = args[i]
+
+        positional_with_default = [self.args_with_default[i]
+                                   for i in range(len(args) - num_no_default)]
+
+        for i, name in enumerate(positional_with_default):
+            if name in values:
+                raise TypeError("Argument %s specified twice" % name)
+            values[name] = args[i + num_no_default]
+
+        # Fill in missing arguments
+        for name in self.args_with_default:
+            if name not in values:
+                values[name] = self.args[name].default
+
+        for key, value in values.iteritems():
+            if key in self.args:
+                out_value = self.args[key](value)
+                if out_value is not missing:
+                    data[key] = out_value
+            else:
+                raise TypeError("Unrecognised argument %s" % key)
+
+        return data
+
+    def convert_known(self, **kwargs):
+        known_kwargs = {name: value for name, value in kwargs.iteritems()
+                        if name in self.args}
+        return self.convert(**known_kwargs)
+
+
+class DataType(object):
+
+    def __init__(self, name, default=no_default, optional=False):
+        self.name = name
+        self.default = default
+
+        if default is no_default and optional is not False:
+            raise ValueError("optional arguments require a default value")
+
+        self.optional = optional
+
+    def __call__(self, value):
+        if value == self.default:
+            if self.optional:
+                return missing
+            return self.default
+
+        try:
+            return self.convert(value)
+        except:
+            raise ValueError("Failed to convert value %s of type %s for field %s to type %s" %
+                             (value, type(value).__name__, self.name, self.__class__.__name__))
+
+
+class Unicode(DataType):
+
+    def convert(self, data):
+        if isinstance(data, unicode):
+            return data
+        if isinstance(data, str):
+            return data.decode("utf8", "replace")
+        return unicode(data)
+
+
+class TestId(DataType):
+
+    def convert(self, data):
+        if isinstance(data, unicode):
+            return data
+        elif isinstance(data, bytes):
+            return data.decode("utf-8", "replace")
+        elif isinstance(data, (tuple, list)):
+            # This is really a bit of a hack; should really split out convertors from the
+            # fields they operate on
+            func = Unicode(None).convert
+            return tuple(func(item) for item in data)
+        else:
+            raise ValueError
+
+
+class Status(DataType):
+    allowed = ["PASS", "FAIL", "OK", "ERROR", "TIMEOUT", "CRASH", "ASSERT", "SKIP"]
+
+    def convert(self, data):
+        value = data.upper()
+        if value not in self.allowed:
+            raise ValueError
+        return value
+
+
+class SubStatus(Status):
+    allowed = ["PASS", "FAIL", "ERROR", "TIMEOUT", "ASSERT", "NOTRUN", "SKIP"]
+
+
+class Dict(DataType):
+
+    def convert(self, data):
+        return dict(data)
+
+
+class List(DataType):
+
+    def __init__(self, name, item_type, default=no_default, optional=False):
+        DataType.__init__(self, name, default, optional)
+        self.item_type = item_type(None)
+
+    def convert(self, data):
+        return [self.item_type.convert(item) for item in data]
+
+
+class Int(DataType):
+
+    def convert(self, data):
+        return int(data)
+
+
+class Any(DataType):
+
+    def convert(self, data):
+        return data
+
+
+class Tuple(DataType):
+
+    def __init__(self, name, item_types, default=no_default, optional=False):
+        DataType.__init__(self, name, default, optional)
+        self.item_types = item_types
+
+    def convert(self, data):
+        if len(data) != len(self.item_types):
+            raise ValueError("Expected %i items got %i" % (len(self.item_types), len(data)))
+        return tuple(item_type.convert(value)
+                     for item_type, value in zip(self.item_types, data))

testing/mozbase/mozlog/mozlog/proxy.py

@@ -0,0 +1,35 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from .structuredlog import get_default_logger
+
+
+class ProxyLogger(object):
+    """
+    A ProxyLogger behaves like a
+    :class:`mozlog.structuredlog.StructuredLogger`.
+
+    Each method and attribute access will be forwarded to the underlying
+    StructuredLogger.
+
+    RuntimeError will be raised when the default logger is not yet initialized.
+    """
+
+    def __init__(self, component=None):
+        self.logger = None
+        self._component = component
+
+    def __getattr__(self, name):
+        if self.logger is None:
+            self.logger = get_default_logger(component=self._component)
+            if self.logger is None:
+                raise RuntimeError("Default logger is not initialized!")
+        return getattr(self.logger, name)
+
+
+def get_proxy_logger(component=None):
+    """
+    Returns a :class:`ProxyLogger` for the given component.
+    """
+    return ProxyLogger(component)

testing/mozbase/mozlog/mozlog/pytest_mozlog/plugin.py

@@ -0,0 +1,94 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import mozlog
+import os
+import time
+
+
+def pytest_addoption(parser):
+    # We can't simply use mozlog.commandline.add_logging_group(parser) here because
+    # Pytest's parser doesn't have the add_argument_group method Mozlog expects.
+    group = parser.getgroup('mozlog')
+
+    for name, (_class, _help) in mozlog.commandline.log_formatters.iteritems():
+        group.addoption('--log-{0}'.format(name), action='append', help=_help)
+
+    formatter_options = mozlog.commandline.fmt_options.iteritems()
+    for name, (_class, _help, formatters, action) in formatter_options:
+        for formatter in formatters:
+            if formatter in mozlog.commandline.log_formatters:
+                group.addoption(
+                    '--log-{0}-{1}'.format(formatter, name),
+                    action=action,
+                    help=_help)
+
+
+def pytest_configure(config):
+    # If using pytest-xdist for parallelization, only register plugin on master process
+    if not hasattr(config, 'slaveinput'):
+        config.pluginmanager.register(MozLog())
+
+
+class MozLog(object):
+
+    def __init__(self):
+        self.results = {}
+        self.start_time = int(time.time() * 1000)  # in ms for Mozlog compatibility
+
+    def format_nodeid(self, nodeid):
+        '''Helper to Reformat/shorten a "::"-separated pytest test nodeid'''
+        testfile, testname = nodeid.split("::")
+        return " ".join([os.path.basename(testfile), testname])
+
+    def pytest_configure(self, config):
+        mozlog.commandline.setup_logging('pytest', config.known_args_namespace,
+                                         defaults={}, allow_unused_options=True)
+        self.logger = mozlog.get_default_logger(component='pytest')
+
+    def pytest_sessionstart(self, session):
+        '''Called before test collection; records suite start time to log later'''
+        self.start_time = int(time.time() * 1000)  # in ms for Mozlog compatibility
+
+    def pytest_collection_modifyitems(self, items):
+        '''Called after test collection is completed, just before tests are run (suite start)'''
+        self.logger.suite_start(tests=items, time=self.start_time)
+
+    def pytest_sessionfinish(self, session, exitstatus):
+        self.logger.suite_end()
+
+    def pytest_runtest_logstart(self, nodeid, location):
+        self.logger.test_start(test=self.format_nodeid(nodeid))
+
+    def pytest_runtest_logreport(self, report):
+        '''Called 3 times per test (setup, call, teardown), indicated by report.when'''
+        test = report.nodeid
+        status = expected = 'PASS'
+        message = stack = None
+        if hasattr(report, 'wasxfail'):
+            # Pytest reporting for xfail tests is somewhat counterinutitive:
+            # If an xfail test fails as expected, its 'call' report has .skipped,
+            # so we record status FAIL (== expected) and log an expected result.
+            # If an xfail unexpectedly passes, the 'call' report has .failed (Pytest 2)
+            # or .passed (Pytest 3), so we leave status as PASS (!= expected)
+            # to log an unexpected result.
+            expected = 'FAIL'
+            if report.skipped:  # indicates expected failure (passing test)
+                status = 'FAIL'
+        elif report.failed:
+            status = 'FAIL' if report.when == 'call' else 'ERROR'
+            crash = report.longrepr.reprcrash  # here longrepr is a ReprExceptionInfo
+            message = "{0} (line {1})".format(crash.message, crash.lineno)
+            stack = report.longrepr.reprtraceback
+        elif report.skipped:  # indicates true skip
+            status = expected = 'SKIP'
+            message = report.longrepr[-1]  # here longrepr is a tuple (file, lineno, reason)
+        if status != expected or expected != 'PASS':
+            self.results[test] = (status, expected, message, stack)
+        if report.when == 'teardown':
+            defaults = ('PASS', 'PASS', None, None)
+            status, expected, message, stack = self.results.get(test, defaults)
+            self.logger.test_end(test=self.format_nodeid(test),
+                                 status=status, expected=expected,
+                                 message=message, stack=stack)

testing/mozbase/mozlog/mozlog/reader.py

@@ -0,0 +1,77 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+import json
+
+
+def read(log_f, raise_on_error=False):
+    """Return a generator that will return the entries in a structured log file.
+    Note that the caller must not close the file whilst the generator is still
+    in use.
+
+    :param log_f: file-like object containing the raw log entries, one per line
+    :param raise_on_error: boolean indicating whether ValueError should be raised
+                           for lines that cannot be decoded."""
+    while True:
+        line = log_f.readline()
+        if not line:
+            # This allows log_f to be a stream like stdout
+            break
+        try:
+            yield json.loads(line)
+        except ValueError:
+            if raise_on_error:
+                raise
+
+
+def imap_log(log_iter, action_map):
+    """Create an iterator that will invoke a callback per action for each item in a
+    iterable containing structured log entries
+
+    :param log_iter: Iterator returning structured log entries
+    :param action_map: Dictionary mapping action name to callback function. Log items
+                       with actions not in this dictionary will be skipped.
+    """
+    for item in log_iter:
+        if item["action"] in action_map:
+            yield action_map[item["action"]](item)
+
+
+def each_log(log_iter, action_map):
+    """Call a callback for each item in an iterable containing structured
+    log entries
+
+    :param log_iter: Iterator returning structured log entries
+    :param action_map: Dictionary mapping action name to callback function. Log items
+                       with actions not in this dictionary will be skipped.
+    """
+    for item in log_iter:
+        if item["action"] in action_map:
+            action_map[item["action"]](item)
+
+
+class LogHandler(object):
+    """Base class for objects that act as log handlers. A handler is a callable
+    that takes a log entry as the only argument.
+
+    Subclasses are expected to provide a method for each action type they
+    wish to handle, each taking a single argument for the test data.
+    For example a trivial subclass that just produces the id of each test as
+    it starts might be::
+
+      class StartIdHandler(LogHandler):
+          def test_start(data):
+              #For simplicity in the example pretend the id is always a string
+              return data["test"]
+    """
+
+    def __call__(self, data):
+        if hasattr(self, data["action"]):
+            handler = getattr(self, data["action"])
+            return handler(data)
+
+
+def handle_log(log_iter, handler):
+    """Call a handler for each item in a log, discarding the return value"""
+    for item in log_iter:
+        handler(item)

testing/mozbase/mozlog/mozlog/scripts/__init__.py

@@ -0,0 +1,32 @@
+#!/usr/bin/env python
+
+import argparse
+import unstable
+import format as formatlog
+import logmerge
+
+
+def get_parser():
+    parser = argparse.ArgumentParser("structlog",
+                                     description="Tools for dealing with structured logs")
+
+    commands = {"unstable": (unstable.get_parser, unstable.main),
+                "format": (formatlog.get_parser, formatlog.main),
+                "logmerge": (logmerge.get_parser, logmerge.main)}
+
+    sub_parser = parser.add_subparsers(title='Subcommands')
+
+    for command, (parser_func, main_func) in commands.iteritems():
+        parent = parser_func(False)
+        command_parser = sub_parser.add_parser(command,
+                                               description=parent.description,
+                                               parents=[parent])
+        command_parser.set_defaults(func=main_func)
+
+    return parser
+
+
+def main():
+    parser = get_parser()
+    args = parser.parse_args()
+    args.func(**vars(args))

testing/mozbase/mozlog/mozlog/scripts/format.py

@@ -0,0 +1,42 @@
+import argparse
+import sys
+
+from .. import handlers, commandline, reader
+
+
+def get_parser(add_help=True):
+    parser = argparse.ArgumentParser("format",
+                                     description="Format a structured log stream",
+                                     add_help=add_help)
+    parser.add_argument("--input", action="store", default=None,
+                        help="Filename to read from, defaults to stdin")
+    parser.add_argument("--output", action="store", default=None,
+                        help="Filename to write to, defaults to stdout")
+    parser.add_argument("format", choices=commandline.log_formatters.keys(),
+                        help="Format to use")
+    return parser
+
+
+def main(**kwargs):
+    if kwargs["input"] is None:
+        input_file = sys.stdin
+    else:
+        input_file = open(kwargs["input"])
+    if kwargs["output"] is None:
+        output_file = sys.stdout
+    else:
+        output_file = open(kwargs["output"], "w")
+
+    formatter = commandline.log_formatters[kwargs["format"]][0]()
+
+    handler = handlers.StreamHandler(stream=output_file,
+                                     formatter=formatter)
+
+    for data in reader.read(input_file):
+        handler(data)
+
+if __name__ == "__main__":
+    parser = get_parser()
+    args = parser.parse_args()
+    kwargs = vars(args)
+    main(**kwargs)

testing/mozbase/mozlog/mozlog/scripts/logmerge.py

@@ -0,0 +1,82 @@
+from __future__ import print_function
+import argparse
+import json
+import os
+import sys
+from threading import current_thread
+import time
+from mozlog.reader import read
+
+
+def dump_entry(entry, output):
+    json.dump(entry, output)
+    output.write("\n")
+
+
+def fill_process_info(event):
+    event["time"] = int(round(time.time() * 1000))
+    event["thread"] = current_thread().name
+    event["pid"] = os.getpid()
+    return event
+
+
+def process_until(reader, output, action):
+    for entry in reader:
+        if entry['action'] == action:
+            return entry
+        dump_entry(entry, output)
+
+
+def process_until_suite_start(reader, output):
+    return process_until(reader, output, "suite_start")
+
+
+def process_until_suite_end(reader, output):
+    return process_until(reader, output, "suite_end")
+
+
+def validate_start_events(events):
+    for start in events:
+        if not start['run_info'] == events[0]['run_info']:
+            print("Error: different run_info entries", file=sys.stderr)
+            sys.exit(1)
+
+
+def merge_start_events(events):
+    for start in events[1:]:
+        events[0]["tests"].extend(start["tests"])
+    return events[0]
+
+
+def get_parser(add_help=True):
+    parser = argparse.ArgumentParser(
+        "logmerge", description='Merge multiple log files.', add_help=add_help)
+    parser.add_argument('-o', dest='output', help='output file, defaults to stdout')
+    parser.add_argument('files', metavar='File', type=str, nargs='+', help='file to be merged')
+    return parser
+
+
+def main(**kwargs):
+    if kwargs["output"] is None:
+        output = sys.stdout
+    else:
+        output = open(kwargs["output"], "w")
+    readers = [read(open(filename, 'r')) for filename in kwargs["files"]]
+    start_events = [process_until_suite_start(reader, output) for reader in readers]
+    validate_start_events(start_events)
+    merged_start_event = merge_start_events(start_events)
+    dump_entry(fill_process_info(merged_start_event), output)
+
+    end_events = [process_until_suite_end(reader, output) for reader in readers]
+    dump_entry(fill_process_info(end_events[0]), output)
+
+    for reader in readers:
+        for entry in reader:
+            dump_entry(entry, output)
+
+
+if __name__ == "__main__":
+    parser = get_parser()
+    args = parser.parse_args()
+    kwargs = vars(args)
+    main(**kwargs)

testing/mozbase/mozlog/mozlog/scripts/unstable.py

@@ -0,0 +1,120 @@
+import argparse
+from collections import defaultdict
+import json
+
+from mozlog import reader
+
+
+class StatusHandler(reader.LogHandler):
+
+    def __init__(self):
+        self.run_info = None
+        self.statuses = defaultdict(lambda: defaultdict(
+            lambda: defaultdict(lambda: defaultdict(int))))
+
+    def test_id(self, test):
+        if type(test) in (str, unicode):
+            return test
+        else:
+            return tuple(test)
+
+    def suite_start(self, item):
+        self.run_info = tuple(sorted(item.get("run_info", {}).items()))
+
+    def test_status(self, item):
+        self.statuses[self.run_info][self.test_id(item["test"])][item["subtest"]][
+            item["status"]] += 1
+
+    def test_end(self, item):
+        self.statuses[self.run_info][self.test_id(item["test"])][None][item["status"]] += 1
+
+    def suite_end(self, item):
+        self.run_info = None
+
+
+def get_statuses(filenames):
+    handler = StatusHandler()
+
+    for filename in filenames:
+        with open(filename) as f:
+            reader.handle_log(reader.read(f), handler)
+
+    return handler.statuses
+
+
+def _filter(results_cmp):
+    def inner(statuses):
+        rv = defaultdict(lambda: defaultdict(dict))
+
+        for run_info, tests in statuses.iteritems():
+            for test, subtests in tests.iteritems():
+                for name, results in subtests.iteritems():
+                    if results_cmp(results):
+                        rv[run_info][test][name] = results
+
+        return rv
+    return inner
+
+filter_unstable = _filter(lambda x: len(x) > 1)
+filter_stable = _filter(lambda x: len(x) == 1)
+
+
+def group_results(data):
+    rv = defaultdict(lambda: defaultdict(lambda: defaultdict(int)))
+
+    for run_info, tests in data.iteritems():
+        for test, subtests in tests.iteritems():
+            for name, results in subtests.iteritems():
+                for status, number in results.iteritems():
+                    rv[test][name][status] += number
+    return rv
+
+
+def print_results(data):
+    for run_info, tests in data.iteritems():
+        run_str = " ".join("%s:%s" % (k, v) for k, v in run_info) if run_info else "No Run Info"
+        print run_str
+        print "=" * len(run_str)
+        print_run(tests)
+
+
+def print_run(tests):
+    for test, subtests in sorted(tests.items()):
+        print "\n" + str(test)
+        print "-" * len(test)
+        for name, results in subtests.iteritems():
+            print "[%s]: %s" % (name if name is not None else "",
+                                " ".join("%s (%i)" % (k, v) for k, v in results.iteritems()))
+
+
+def get_parser(add_help=True):
+    parser = argparse.ArgumentParser("unstable",
+                                     description="List tests that don't give consistent "
+                                     "results from one or more runs.", add_help=add_help)
+    parser.add_argument("--json", action="store_true", default=False,
+                        help="Output in JSON format")
+    parser.add_argument("--group", action="store_true", default=False,
+                        help="Group results from different run types")
+    parser.add_argument("log_file", nargs="+",
+                        help="Log files to read")
+    return parser
+
+
+def main(**kwargs):
+    unstable = filter_unstable(get_statuses(kwargs["log_file"]))
+    if kwargs["group"]:
+        unstable = group_results(unstable)
+
+    if kwargs["json"]:
+        print json.dumps(unstable)
+    else:
+        if not kwargs["group"]:
+            print_results(unstable)
+        else:
+            print_run(unstable)
+
+if __name__ == "__main__":
+    parser = get_parser()
+    args = parser.parse_args()
+    kwargs = vars(args)
+    main(**kwargs)

testing/mozbase/mozlog/mozlog/stdadapter.py

@@ -0,0 +1,45 @@
+import logging
+
+from structuredlog import StructuredLogger, log_levels
+
+
+class UnstructuredHandler(logging.Handler):
+
+    def __init__(self, name=None, level=logging.NOTSET):
+        self.structured = StructuredLogger(name)
+        logging.Handler.__init__(self, level=level)
+
+    def emit(self, record):
+        if record.levelname in log_levels:
+            log_func = getattr(self.structured, record.levelname.lower())
+        else:
+            log_func = self.logger.debug
+        log_func(record.msg)
+
+    def handle(self, record):
+        self.emit(record)
+
+
+class LoggingWrapper(object):
+
+    def __init__(self, wrapped):
+        self.wrapped = wrapped
+        self.wrapped.addHandler(UnstructuredHandler(self.wrapped.name,
+                                                    logging.getLevelName(self.wrapped.level)))
+
+    def add_handler(self, handler):
+        self.addHandler(handler)
+
+    def remove_handler(self, handler):
+        self.removeHandler(handler)
+
+    def __getattr__(self, name):
+        return getattr(self.wrapped, name)
+
+
+def std_logging_adapter(logger):
+    """Adapter for stdlib logging so that it produces structured
+    messages rather than standard logging messages
+
+    :param logger: logging.Logger to wrap"""
+    return LoggingWrapper(logger)

testing/mozbase/mozlog/mozlog/structuredlog.py

@@ -0,0 +1,521 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from __future__ import unicode_literals
+
+from multiprocessing import current_process
+from threading import current_thread, Lock
+import json
+import sys
+import time
+import traceback
+
+from logtypes import Unicode, TestId, Status, SubStatus, Dict, List, Int, Any, Tuple
+from logtypes import log_action, convertor_registry
+
+"""Structured Logging for recording test results.
+
+Allowed actions, and subfields:
+  suite_start
+      tests  - List of test names
+
+  suite_end
+
+  test_start
+      test - ID for the test
+      path - Relative path to test (optional)
+
+  test_end
+      test - ID for the test
+      status [PASS | FAIL | OK | ERROR |
+              TIMEOUT | CRASH | ASSERT | SKIP] - test status
+      expected [As for status] - Status that the test was expected to get,
+                                 or absent if the test got the expected status
+      extra - Dictionary of harness-specific extra information e.g. debug info
+
+  test_status
+      test - ID for the test
+      subtest - Name of the subtest
+      status [PASS | FAIL | TIMEOUT | NOTRUN | SKIP] - test status
+      expected [As for status] - Status that the subtest was expected to get,
+                                 or absent if the subtest got the expected status
+
+  process_output
+      process - PID of the process
+      command - Command line of the process
+      data - Output data from the process
+
+  log
+      level [CRITICAL | ERROR | WARNING |
+             INFO | DEBUG] - level of the logging message
+      message - Message to log
+
+Subfields for all messages:
+      action - the action type of the current message
+      time - the timestamp in ms since the epoch of the log message
+      thread - name for the thread emitting the message
+      pid - id of the python process in which the logger is running
+      source - name for the source emitting the message
+      component - name of the subcomponent emitting the message
+"""
+
+_default_logger_name = None
+
+
+def get_default_logger(component=None):
+    """Gets the default logger if available, optionally tagged with component
+    name. Will return None if not yet set
+
+    :param component: The component name to tag log messages with
+    """
+    global _default_logger_name
+
+    if not _default_logger_name:
+        return None
+
+    return StructuredLogger(_default_logger_name, component=component)
+
+
+def set_default_logger(default_logger):
+    """Sets the default logger to logger.
+
+    It can then be retrieved with :py:func:`get_default_logger`
+
+    Note that :py:func:`~mozlog.commandline.setup_logging` will
+    set a default logger for you, so there should be no need to call this
+    function if you're using setting up logging that way (recommended).
+
+    :param default_logger: The logger to set to default.
+    """
+    global _default_logger_name
+
+    _default_logger_name = default_logger.name
+
+log_levels = dict((k.upper(), v) for v, k in
+                  enumerate(["critical", "error", "warning", "info", "debug"]))
+
+lint_levels = ["ERROR", "WARNING"]
+
+
+def log_actions():
+    """Returns the set of actions implemented by mozlog."""
+    return set(convertor_registry.keys())
+
+
+class LoggerState(object):
+
+    def __init__(self):
+        self.handlers = []
+        self.running_tests = set()
+        self.suite_started = False
+        self.component_states = {}
+
+
+class ComponentState(object):
+
+    def __init__(self):
+        self.filter_ = None
+
+
+class StructuredLogger(object):
+    _lock = Lock()
+    _logger_states = {}
+    """Create a structured logger with the given name
+
+    :param name: The name of the logger.
+    :param component: A subcomponent that the logger belongs to (typically a library name)
+    """
+
+    def __init__(self, name, component=None):
+        self.name = name
+        self.component = component
+
+        with self._lock:
+            if name not in self._logger_states:
+                self._logger_states[name] = LoggerState()
+
+            if component not in self._logger_states[name].component_states:
+                self._logger_states[name].component_states[component] = ComponentState()
+
+        self._state = self._logger_states[name]
+        self._component_state = self._state.component_states[component]
+
+    def add_handler(self, handler):
+        """Add a handler to the current logger"""
+        self._state.handlers.append(handler)
+
+    def remove_handler(self, handler):
+        """Remove a handler from the current logger"""
+        self._state.handlers.remove(handler)
+
+    def send_message(self, topic, command, *args):
+        """Send a message to each handler configured for this logger. This
+        part of the api is useful to those users requiring dynamic control
+        of a handler's behavior.
+
+        :param topic: The name used by handlers to subscribe to a message.
+        :param command: The name of the command to issue.
+        :param args: Any arguments known to the target for specialized
+                     behavior.
+        """
+        rv = []
+        for handler in self._state.handlers:
+            if hasattr(handler, "handle_message"):
+                rv += handler.handle_message(topic, command, *args)
+        return rv
+
+    @property
+    def handlers(self):
+        """A list of handlers that will be called when a
+        message is logged from this logger"""
+        return self._state.handlers
+
+    @property
+    def component_filter(self):
+        return self._component_state.filter_
+
+    @component_filter.setter
+    def component_filter(self, value):
+        self._component_state.filter_ = value
+
+    def log_raw(self, raw_data):
+        if "action" not in raw_data:
+            raise ValueError
+
+        action = raw_data["action"]
+        converted_data = convertor_registry[action].convert_known(**raw_data)
+        for k, v in raw_data.iteritems():
+            if k not in converted_data:
+                converted_data[k] = v
+
+        data = self._make_log_data(action, converted_data)
+
+        if action in ("test_status", "test_end"):
+            if (data["expected"] == data["status"] or
+                data["status"] == "SKIP" or
+                    "expected" not in raw_data):
+                del data["expected"]
+
+        if not self._ensure_suite_state(action, data):
+            return
+
+        self._handle_log(data)
+
+    def _log_data(self, action, data=None):
+        if data is None:
+            data = {}
+
+        log_data = self._make_log_data(action, data)
+        self._handle_log(log_data)
+
+    def _handle_log(self, data):
+        with self._lock:
+            if self.component_filter:
+                data = self.component_filter(data)
+                if data is None:
+                    return
+
+            for handler in self.handlers:
+                try:
+                    handler(data)
+                except Exception:
+                    # Write the exception details directly to stderr because
+                    # log() would call this method again which is currently locked.
+                    print >> sys.__stderr__, '%s: Failure calling log handler:' % __name__
+                    print >> sys.__stderr__, traceback.format_exc()
+
+    def _make_log_data(self, action, data):
+        all_data = {"action": action,
+                    "time": int(time.time() * 1000),
+                    "thread": current_thread().name,
+                    "pid": current_process().pid,
+                    "source": self.name}
+        if self.component:
+            all_data['component'] = self.component
+        all_data.update(data)
+        return all_data
+
+    def _ensure_suite_state(self, action, data):
+        if action == 'suite_start':
+            if self._state.suite_started:
+                self.error("Got second suite_start message before suite_end. " +
+                           "Logged with data: {}".format(json.dumps(data)))
+                return False
+            self._state.suite_started = True
+        elif action == 'suite_end':
+            if not self._state.suite_started:
+                self.error("Got suite_end message before suite_start. " +
+                           "Logged with data: {}".format(json.dumps(data)))
+                return False
+            self._state.suite_started = False
+        return True
+
+    @log_action(List("tests", Unicode),
+                Dict("run_info", default=None, optional=True),
+                Dict("version_info", default=None, optional=True),
+                Dict("device_info", default=None, optional=True),
+                Dict("extra", default=None, optional=True))
+    def suite_start(self, data):
+        """Log a suite_start message
+
+        :param list tests: Test identifiers that will be run in the suite.
+        :param dict run_info: Optional information typically provided by mozinfo.
+        :param dict version_info: Optional target application version information provided
+          by mozversion.
+        :param dict device_info: Optional target device information provided by mozdevice.
+        """
+        if not self._ensure_suite_state('suite_start', data):
+            return
+
+        self._log_data("suite_start", data)
+
+    @log_action(Dict("extra", default=None, optional=True))
+    def suite_end(self, data):
+        """Log a suite_end message"""
+        if not self._ensure_suite_state('suite_end', data):
+            return
+
+        self._log_data("suite_end")
+
+    @log_action(TestId("test"),
+                Unicode("path", default=None, optional=True))
+    def test_start(self, data):
+        """Log a test_start message
+
+        :param test: Identifier of the test that will run.
+        :param path: Path to test relative to some base (typically the root of
+                     the source tree).
+        """
+        if not self._state.suite_started:
+            self.error("Got test_start message before suite_start for test %s" %
+                       data["test"])
+            return
+        if data["test"] in self._state.running_tests:
+            self.error("test_start for %s logged while in progress." %
+                       data["test"])
+            return
+        self._state.running_tests.add(data["test"])
+        self._log_data("test_start", data)
+
+    @log_action(TestId("test"),
+                Unicode("subtest"),
+                SubStatus("status"),
+                SubStatus("expected", default="PASS"),
+                Unicode("message", default=None, optional=True),
+                Unicode("stack", default=None, optional=True),
+                Dict("extra", default=None, optional=True))
+    def test_status(self, data):
+        """
+        Log a test_status message indicating a subtest result. Tests that
+        do not have subtests are not expected to produce test_status messages.
+
+        :param test: Identifier of the test that produced the result.
+        :param subtest: Name of the subtest.
+        :param status: Status string indicating the subtest result
+        :param expected: Status string indicating the expected subtest result.
+        :param message: String containing a message associated with the result.
+        :param stack: a stack trace encountered during test execution.
+        :param extra: suite-specific data associated with the test result.
+        """
+
+        if (data["expected"] == data["status"] or
+                data["status"] == "SKIP"):
+            del data["expected"]
+
+        if data["test"] not in self._state.running_tests:
+            self.error("test_status for %s logged while not in progress. "
+                       "Logged with data: %s" % (data["test"], json.dumps(data)))
+            return
+
+        self._log_data("test_status", data)
+
+    @log_action(TestId("test"),
+                Status("status"),
+                Status("expected", default="OK"),
+                Unicode("message", default=None, optional=True),
+                Unicode("stack", default=None, optional=True),
+                Dict("extra", default=None, optional=True))
+    def test_end(self, data):
+        """
+        Log a test_end message indicating that a test completed. For tests
+        with subtests this indicates whether the overall test completed without
+        errors. For tests without subtests this indicates the test result
+        directly.
+
+        :param test: Identifier of the test that produced the result.
+        :param status: Status string indicating the test result
+        :param expected: Status string indicating the expected test result.
+        :param message: String containing a message associated with the result.
+        :param stack: a stack trace encountered during test execution.
+        :param extra: suite-specific data associated with the test result.
+        """
+
+        if (data["expected"] == data["status"] or
+                data["status"] == "SKIP"):
+            del data["expected"]
+
+        if data["test"] not in self._state.running_tests:
+            self.error("test_end for %s logged while not in progress. "
+                       "Logged with data: %s" % (data["test"], json.dumps(data)))
+        else:
+            self._state.running_tests.remove(data["test"])
+            self._log_data("test_end", data)
+
+    @log_action(Unicode("process"),
+                Unicode("data"),
+                Unicode("command", default=None, optional=True))
+    def process_output(self, data):
+        """Log output from a managed process.
+
+        :param process: A unique identifier for the process producing the output
+                        (typically the pid)
+        :param data: The output to log
+        :param command: A string representing the full command line used to start
+                        the process.
+        """
+        self._log_data("process_output", data)
+
+    @log_action(Unicode("process", default=None),
+                Unicode("signature", default="[Unknown]"),
+                TestId("test", default=None, optional=True),
+                Unicode("minidump_path", default=None, optional=True),
+                Unicode("minidump_extra", default=None, optional=True),
+                Int("stackwalk_retcode", default=None, optional=True),
+                Unicode("stackwalk_stdout", default=None, optional=True),
+                Unicode("stackwalk_stderr", default=None, optional=True),
+                List("stackwalk_errors", Unicode, default=None))
+    def crash(self, data):
+        if data["stackwalk_errors"] is None:
+            data["stackwalk_errors"] = []
+
+        self._log_data("crash", data)
+
+    @log_action(Unicode("primary", default=None),
+                List("secondary", Unicode, default=None))
+    def valgrind_error(self, data):
+        self._log_data("valgrind_error", data)
+
+    @log_action(Unicode("process"),
+                Unicode("command", default=None, optional=True))
+    def process_start(self, data):
+        """Log start event of a process.
+
+        :param process: A unique identifier for the process producing the
+                        output (typically the pid)
+        :param command: A string representing the full command line used to
+                        start the process.
+        """
+        self._log_data("process_start", data)
+
+    @log_action(Unicode("process"),
+                Int("exitcode"),
+                Unicode("command", default=None, optional=True))
+    def process_exit(self, data):
+        """Log exit event of a process.
+
+        :param process: A unique identifier for the process producing the
+                        output (typically the pid)
+        :param exitcode: the exit code
+        :param command: A string representing the full command line used to
+                        start the process.
+        """
+        self._log_data("process_exit", data)
+
+
+def _log_func(level_name):
+    @log_action(Unicode("message"),
+                Any("exc_info", default=False))
+    def log(self, data):
+        exc_info = data.pop("exc_info", None)
+        if exc_info:
+            if not isinstance(exc_info, tuple):
+                exc_info = sys.exc_info()
+            if exc_info != (None, None, None):
+                bt = traceback.format_exception(*exc_info)
+                data["stack"] = u"\n".join(bt)
+
+        data["level"] = level_name
+        self._log_data("log", data)
+
+    log.__doc__ = """Log a message with level %s
+
+:param message: The string message to log
+:param exc_info: Either a boolean indicating whether to include a traceback
+                 derived from sys.exc_info() or a three-item tuple in the
+                 same format as sys.exc_info() containing exception information
+                 to log.
+""" % level_name
+    log.__name__ = str(level_name).lower()
+    return log
+
+
+def _lint_func(level_name):
+    @log_action(Unicode("path"),
+                Unicode("message", default=""),
+                Int("lineno", default=0),
+                Int("column", default=None, optional=True),
+                Unicode("hint", default=None, optional=True),
+                Unicode("source", default=None, optional=True),
+                Unicode("rule", default=None, optional=True),
+                Tuple("lineoffset", (Int, Int), default=None, optional=True),
+                Unicode("linter", default=None, optional=True))
+    def lint(self, data):
+        data["level"] = level_name
+        self._log_data("lint", data)
+    lint.__doc__ = """Log an error resulting from a failed lint check
+
+        :param linter: name of the linter that flagged this error
+        :param path: path to the file containing the error
+        :param message: text describing the error
+        :param lineno: line number that contains the error
+        :param column: column containing the error
+        :param hint: suggestion for fixing the error (optional)
+        :param source: source code context of the error (optional)
+        :param rule: name of the rule that was violated (optional)
+        :param lineoffset: denotes an error spans multiple lines, of the form
+                           (<lineno offset>, <num lines>) (optional)
+        """
+    lint.__name__ = str("lint_%s" % level_name)
+    return lint
+
+
+# Create all the methods on StructuredLog for log/lint levels
+for level_name in log_levels:
+    setattr(StructuredLogger, level_name.lower(), _log_func(level_name))
+
+for level_name in lint_levels:
+    level_name = level_name.lower()
+    name = "lint_%s" % level_name
+    setattr(StructuredLogger, name, _lint_func(level_name))
+
+
+class StructuredLogFileLike(object):
+    """Wrapper for file-like objects to redirect writes to logger
+    instead. Each call to `write` becomes a single log entry of type `log`.
+
+    When using this it is important that the callees i.e. the logging
+    handlers do not themselves try to write to the wrapped file as this
+    will cause infinite recursion.
+
+    :param logger: `StructuredLogger` to which to redirect the file write operations.
+    :param level: log level to use for each write.
+    :param prefix: String prefix to prepend to each log entry.
+    """
+
+    def __init__(self, logger, level="info", prefix=None):
+        self.logger = logger
+        self.log_func = getattr(self.logger, level)
+        self.prefix = prefix
+
+    def write(self, data):
+        if data.endswith("\n"):
+            data = data[:-1]
+        if data.endswith("\r"):
+            data = data[:-1]
+        if self.prefix is not None:
+            data = "%s: %s" % (self.prefix, data)
+        self.log_func(data)
+
+    def flush(self):
+        pass

testing/mozbase/mozlog/mozlog/unstructured/__init__.py

@@ -0,0 +1,8 @@
+# flake8: noqa
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from .logger import *
+from .loglistener import LogMessageServer
+from .loggingmixin import LoggingMixin

testing/mozbase/mozlog/mozlog/unstructured/logger.py

@@ -0,0 +1,185 @@
+# flake8: noqa
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this file,
+# You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from logging import getLogger as getSysLogger
+from logging import *
+# Some of the build slave environments don't see the following when doing
+# 'from logging import *'
+# see https://bugzilla.mozilla.org/show_bug.cgi?id=700415#c35
+from logging import getLoggerClass, addLevelName, setLoggerClass, shutdown, debug, info, basicConfig
+import json
+
+_default_level = INFO
+_LoggerClass = getLoggerClass()
+
+# Define mozlog specific log levels
+START = _default_level + 1
+END = _default_level + 2
+PASS = _default_level + 3
+KNOWN_FAIL = _default_level + 4
+FAIL = _default_level + 5
+CRASH = _default_level + 6
+# Define associated text of log levels
+addLevelName(START, 'TEST-START')
+addLevelName(END, 'TEST-END')
+addLevelName(PASS, 'TEST-PASS')
+addLevelName(KNOWN_FAIL, 'TEST-KNOWN-FAIL')
+addLevelName(FAIL, 'TEST-UNEXPECTED-FAIL')
+addLevelName(CRASH, 'PROCESS-CRASH')
+
+
+class MozLogger(_LoggerClass):
+    """
+    MozLogger class which adds some convenience log levels
+    related to automated testing in Mozilla and ability to
+    output structured log messages.
+    """
+
+    def testStart(self, message, *args, **kwargs):
+        """Logs a test start message"""
+        self.log(START, message, *args, **kwargs)
+
+    def testEnd(self, message, *args, **kwargs):
+        """Logs a test end message"""
+        self.log(END, message, *args, **kwargs)
+
+    def testPass(self, message, *args, **kwargs):
+        """Logs a test pass message"""
+        self.log(PASS, message, *args, **kwargs)
+
+    def testFail(self, message, *args, **kwargs):
+        """Logs a test fail message"""
+        self.log(FAIL, message, *args, **kwargs)
+
+    def testKnownFail(self, message, *args, **kwargs):
+        """Logs a test known fail message"""
+        self.log(KNOWN_FAIL, message, *args, **kwargs)
+
+    def processCrash(self, message, *args, **kwargs):
+        """Logs a process crash message"""
+        self.log(CRASH, message, *args, **kwargs)
+
+    def log_structured(self, action, params=None):
+        """Logs a structured message object."""
+        if params is None:
+            params = {}
+
+        level = params.get('_level', _default_level)
+        if isinstance(level, int):
+            params['_level'] = getLevelName(level)
+        else:
+            params['_level'] = level
+            level = getLevelName(level.upper())
+
+            # If the logger is fed a level number unknown to the logging
+            # module, getLevelName will return a string. Unfortunately,
+            # the logging module will raise a type error elsewhere if
+            # the level is not an integer.
+            if not isinstance(level, int):
+                level = _default_level
+
+        params['action'] = action
+
+        # The can message be None. This is expected, and shouldn't cause
+        # unstructured formatters to fail.
+        message = params.get('_message')
+
+        self.log(level, message, extra={'params': params})
+
+
+class JSONFormatter(Formatter):
+    """Log formatter for emitting structured JSON entries."""
+
+    def format(self, record):
+        # Default values determined by logger metadata
+        output = {
+            '_time': int(round(record.created * 1000, 0)),
+            '_namespace': record.name,
+            '_level': getLevelName(record.levelno),
+        }
+
+        # If this message was created by a call to log_structured,
+        # anything specified by the caller's params should act as
+        # an override.
+        output.update(getattr(record, 'params', {}))
+
+        if record.msg and output.get('_message') is None:
+            # For compatibility with callers using the printf like
+            # API exposed by python logging, call the default formatter.
+            output['_message'] = Formatter.format(self, record)
+
+        return json.dumps(output, indent=output.get('indent'))
+
+
+class MozFormatter(Formatter):
+    """
+    MozFormatter class used to standardize formatting
+    If a different format is desired, this can be explicitly
+    overriden with the log handler's setFormatter() method
+    """
+    level_length = 0
+    max_level_length = len('TEST-START')
+
+    def __init__(self, include_timestamp=False):
+        """
+        Formatter.__init__ has fmt and datefmt parameters that won't have
+        any affect on a MozFormatter instance.
+
+        :param include_timestamp: if True, include formatted time at the
+                                  beginning of the message
+        """
+        self.include_timestamp = include_timestamp
+        Formatter.__init__(self)
+
+    def format(self, record):
+        # Handles padding so record levels align nicely
+        if len(record.levelname) > self.level_length:
+            pad = 0
+            if len(record.levelname) <= self.max_level_length:
+                self.level_length = len(record.levelname)
+        else:
+            pad = self.level_length - len(record.levelname) + 1
+        sep = '|'.rjust(pad)
+        fmt = '%(name)s %(levelname)s ' + sep + ' %(message)s'
+        if self.include_timestamp:
+            fmt = '%(asctime)s ' + fmt
+        # this protected member is used to define the format
+        # used by the base Formatter's method
+        self._fmt = fmt
+        return Formatter.format(self, record)
+
+
+def getLogger(name, handler=None):
+    """
+    Returns the logger with the specified name.
+    If the logger doesn't exist, it is created.
+    If handler is specified, adds it to the logger. Otherwise a default handler
+    that logs to standard output will be used.
+
+    :param name: The name of the logger to retrieve
+    :param handler: A handler to add to the logger. If the logger already exists,
+                    and a handler is specified, an exception will be raised. To
+                    add a handler to an existing logger, call that logger's
+                    addHandler method.
+    """
+    setLoggerClass(MozLogger)
+
+    if name in Logger.manager.loggerDict:
+        if handler:
+            raise ValueError('The handler parameter requires ' +
+                             'that a logger by this name does ' +
+                             'not already exist')
+        return Logger.manager.loggerDict[name]
+
+    logger = getSysLogger(name)
+    logger.setLevel(_default_level)
+
+    if handler is None:
+        handler = StreamHandler()
+        handler.setFormatter(MozFormatter())
+
+    logger.addHandler(handler)
+    logger.propagate = False
+    return logger

testing/mozbase/mozlog/mozlog/unstructured/loggingmixin.py

@@ -0,0 +1,44 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from .logger import (
+    Logger,
+    getLogger,
+)
+
+
+class LoggingMixin(object):
+    """Expose a subset of logging functions to an inheriting class."""
+
+    def set_logger(self, logger_instance=None, name=None):
+        """Method for setting the underlying logger instance to be used."""
+
+        if logger_instance and not isinstance(logger_instance, Logger):
+            raise ValueError("logger_instance must be an instance of Logger")
+
+        if name is None:
+            name = ".".join([self.__module__, self.__class__.__name__])
+
+        self._logger = logger_instance or getLogger(name)
+
+    def _log_msg(self, cmd, *args, **kwargs):
+        if not hasattr(self, "_logger"):
+            self._logger = getLogger(".".join([self.__module__,
+                                               self.__class__.__name__]))
+        getattr(self._logger, cmd)(*args, **kwargs)
+
+    def log(self, *args, **kwargs):
+        self._log_msg("log", *args, **kwargs)
+
+    def info(self, *args, **kwargs):
+        self._log_msg("info", *args, **kwargs)
+
+    def error(self, *args, **kwargs):
+        self._log_msg("error", *args, **kwargs)
+
+    def warn(self, *args, **kwargs):
+        self._log_msg("warn", *args, **kwargs)
+
+    def log_structured(self, *args, **kwargs):
+        self._log_msg("log_structured", *args, **kwargs)

testing/mozbase/mozlog/mozlog/unstructured/loglistener.py

@@ -0,0 +1,50 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this file,
+# You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import SocketServer
+import socket
+import json
+
+
+class LogMessageServer(SocketServer.TCPServer):
+
+    def __init__(self, server_address, logger, message_callback=None, timeout=3):
+        SocketServer.TCPServer.__init__(self, server_address, LogMessageHandler)
+        self._logger = logger
+        self._message_callback = message_callback
+        self.timeout = timeout
+
+
+class LogMessageHandler(SocketServer.BaseRequestHandler):
+    """Processes output from a connected log source, logging to an
+    existing logger upon receipt of a well-formed log messsage."""
+
+    def handle(self):
+        """Continually listens for log messages."""
+        self._partial_message = ''
+        self.request.settimeout(self.server.timeout)
+
+        while True:
+            try:
+                data = self.request.recv(1024)
+                if not data:
+                    return
+                self.process_message(data)
+            except socket.timeout:
+                return
+
+    def process_message(self, data):
+        """Processes data from a connected log source. Messages are assumed
+        to be newline delimited, and generally well-formed JSON."""
+        for part in data.split('\n'):
+            msg_string = self._partial_message + part
+            try:
+                msg = json.loads(msg_string)
+                self._partial_message = ''
+                self.server._logger.log_structured(msg.get('action', 'UNKNOWN'), msg)
+                if self.server._message_callback:
+                    self.server._message_callback()
+
+            except ValueError:
+                self._partial_message = msg_string

testing/mozbase/mozlog/setup.py

@@ -0,0 +1,39 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this file,
+# You can obtain one at http://mozilla.org/MPL/2.0/.
+
+from setuptools import setup, find_packages
+
+PACKAGE_NAME = 'mozlog'
+PACKAGE_VERSION = '3.4'
+
+setup(name=PACKAGE_NAME,
+      version=PACKAGE_VERSION,
+      description="Robust log handling specialized for logging in the Mozilla universe",
+      long_description="see http://mozbase.readthedocs.org/",
+      author='Mozilla Automation and Testing Team',
+      author_email='tools@lists.mozilla.org',
+      url='https://wiki.mozilla.org/Auto-tools/Projects/Mozbase',
+      license='MPL 1.1/GPL 2.0/LGPL 2.1',
+      packages=find_packages(),
+      zip_safe=False,
+      install_requires=["blessings>=1.3"],
+      tests_require=['mozfile'],
+      platforms=['Any'],
+      classifiers=['Development Status :: 4 - Beta',
+                   'Environment :: Console',
+                   'Intended Audience :: Developers',
+                   'License :: OSI Approved :: Mozilla Public License 1.1 (MPL 1.1)',
+                   'Operating System :: OS Independent',
+                   'Topic :: Software Development :: Libraries :: Python Modules',
+                   ],
+      package_data={"mozlog": ["formatters/html/main.js",
+                               "formatters/html/style.css"]},
+      entry_points={
+          "console_scripts": [
+              "structlog = mozlog.scripts:main"
+          ],
+          'pytest11': [
+              'mozlog = mozlog.pytest_mozlog.plugin',
+          ]}
+      )

testing/mozbase/mozlog/tests/manifest.ini

@@ -0,0 +1,2 @@
+[test_logger.py]
+[test_structured.py]

testing/mozbase/mozlog/tests/test_logger.py

@@ -0,0 +1,264 @@
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this file,
+# You can obtain one at http://mozilla.org/MPL/2.0/.
+
+import datetime
+import json
+import socket
+import threading
+import time
+import unittest
+
+import mozfile
+
+import mozlog.unstructured as mozlog
+
+
+class ListHandler(mozlog.Handler):
+    """Mock handler appends messages to a list for later inspection."""
+
+    def __init__(self):
+        mozlog.Handler.__init__(self)
+        self.messages = []
+
+    def emit(self, record):
+        self.messages.append(self.format(record))
+
+
+class TestLogging(unittest.TestCase):
+    """Tests behavior of basic mozlog api."""
+
+    def test_logger_defaults(self):
+        """Tests the default logging format and behavior."""
+
+        default_logger = mozlog.getLogger('default.logger')
+        self.assertEqual(default_logger.name, 'default.logger')
+        self.assertEqual(len(default_logger.handlers), 1)
+        self.assertTrue(isinstance(default_logger.handlers[0],
+                                   mozlog.StreamHandler))
+
+        f = mozfile.NamedTemporaryFile()
+        list_logger = mozlog.getLogger('file.logger',
+                                       handler=mozlog.FileHandler(f.name))
+        self.assertEqual(len(list_logger.handlers), 1)
+        self.assertTrue(isinstance(list_logger.handlers[0],
+                                   mozlog.FileHandler))
+        f.close()
+
+        self.assertRaises(ValueError, mozlog.getLogger,
+                          'file.logger', handler=ListHandler())
+
+    def test_timestamps(self):
+        """Verifies that timestamps are included when asked for."""
+        log_name = 'test'
+        handler = ListHandler()
+        handler.setFormatter(mozlog.MozFormatter())
+        log = mozlog.getLogger(log_name, handler=handler)
+        log.info('no timestamp')
+        self.assertTrue(handler.messages[-1].startswith('%s ' % log_name))
+        handler.setFormatter(mozlog.MozFormatter(include_timestamp=True))
+        log.info('timestamp')
+        # Just verify that this raises no exceptions.
+        datetime.datetime.strptime(handler.messages[-1][:23],
+                                   '%Y-%m-%d %H:%M:%S,%f')
+
+
+class TestStructuredLogging(unittest.TestCase):
+    """Tests structured output in mozlog."""
+
+    def setUp(self):
+        self.handler = ListHandler()
+        self.handler.setFormatter(mozlog.JSONFormatter())
+        self.logger = mozlog.MozLogger('test.Logger')
+        self.logger.addHandler(self.handler)
+        self.logger.setLevel(mozlog.DEBUG)
+
+    def check_messages(self, expected, actual):
+        """Checks actual for equality with corresponding fields in actual.
+        The actual message should contain all fields in expected, and
+        should be identical, with the exception of the timestamp field.
+        The actual message should contain no fields other than the timestamp
+        field and those present in expected."""
+
+        self.assertTrue(isinstance(actual['_time'], (int, long)))
+
+        for k, v in expected.items():
+            self.assertEqual(v, actual[k])
+
+        for k in actual.keys():
+            if k != '_time':
+                self.assertTrue(expected.get(k) is not None)
+
+    def test_structured_output(self):
+        self.logger.log_structured('test_message',
+                                   {'_level': mozlog.INFO,
+                                    '_message': 'message one'})
+        self.logger.log_structured('test_message',
+                                   {'_level': mozlog.INFO,
+                                    '_message': 'message two'})
+        self.logger.log_structured('error_message',
+                                   {'_level': mozlog.ERROR,
+                                    'diagnostic': 'unexpected error'})
+
+        message_one_expected = {'_namespace': 'test.Logger',
+                                '_level': 'INFO',
+                                '_message': 'message one',
+                                'action': 'test_message'}
+        message_two_expected = {'_namespace': 'test.Logger',
+                                '_level': 'INFO',
+                                '_message': 'message two',
+                                'action': 'test_message'}
+        message_three_expected = {'_namespace': 'test.Logger',
+                                  '_level': 'ERROR',
+                                  'diagnostic': 'unexpected error',
+                                  'action': 'error_message'}
+
+        message_one_actual = json.loads(self.handler.messages[0])
+        message_two_actual = json.loads(self.handler.messages[1])
+        message_three_actual = json.loads(self.handler.messages[2])
+
+        self.check_messages(message_one_expected, message_one_actual)
+        self.check_messages(message_two_expected, message_two_actual)
+        self.check_messages(message_three_expected, message_three_actual)
+
+    def test_unstructured_conversion(self):
+        """ Tests that logging to a logger with a structured formatter
+        via the traditional logging interface works as expected. """
+        self.logger.info('%s %s %d', 'Message', 'number', 1)
+        self.logger.error('Message number 2')
+        self.logger.debug('Message with %s', 'some extras',
+                          extra={'params': {'action': 'mozlog_test_output',
+                                            'is_failure': False}})
+        message_one_expected = {'_namespace': 'test.Logger',
+                                '_level': 'INFO',
+                                '_message': 'Message number 1'}
+        message_two_expected = {'_namespace': 'test.Logger',
+                                '_level': 'ERROR',
+                                '_message': 'Message number 2'}
+        message_three_expected = {'_namespace': 'test.Logger',
+                                  '_level': 'DEBUG',
+                                  '_message': 'Message with some extras',
+                                  'action': 'mozlog_test_output',
+                                  'is_failure': False}
+
+        message_one_actual = json.loads(self.handler.messages[0])
+        message_two_actual = json.loads(self.handler.messages[1])
+        message_three_actual = json.loads(self.handler.messages[2])
+
+        self.check_messages(message_one_expected, message_one_actual)
+        self.check_messages(message_two_expected, message_two_actual)
+        self.check_messages(message_three_expected, message_three_actual)
+
+    def message_callback(self):
+        if len(self.handler.messages) == 3:
+            message_one_expected = {'_namespace': 'test.Logger',
+                                    '_level': 'DEBUG',
+                                    '_message': 'socket message one',
+                                    'action': 'test_message'}
+            message_two_expected = {'_namespace': 'test.Logger',
+                                    '_level': 'DEBUG',
+                                    '_message': 'socket message two',
+                                    'action': 'test_message'}
+            message_three_expected = {'_namespace': 'test.Logger',
+                                      '_level': 'DEBUG',
+                                      '_message': 'socket message three',
+                                      'action': 'test_message'}
+
+            message_one_actual = json.loads(self.handler.messages[0])
+
+            message_two_actual = json.loads(self.handler.messages[1])
+
+            message_three_actual = json.loads(self.handler.messages[2])
+
+            self.check_messages(message_one_expected, message_one_actual)
+            self.check_messages(message_two_expected, message_two_actual)
+            self.check_messages(message_three_expected, message_three_actual)
+
+    def test_log_listener(self):
+        connection = '127.0.0.1', 0
+        self.log_server = mozlog.LogMessageServer(connection,
+                                                  self.logger,
+                                                  message_callback=self.message_callback,
+                                                  timeout=0.5)
+
+        message_string_one = json.dumps({'_message': 'socket message one',
+                                         'action': 'test_message',
+                                         '_level': 'DEBUG'})
+        message_string_two = json.dumps({'_message': 'socket message two',
+                                         'action': 'test_message',
+                                         '_level': 'DEBUG'})
+
+        message_string_three = json.dumps({'_message': 'socket message three',
+                                           'action': 'test_message',
+                                           '_level': 'DEBUG'})
+
+        message_string = message_string_one + '\n' + \
+            message_string_two + '\n' + \
+            message_string_three + '\n'
+
+        server_thread = threading.Thread(target=self.log_server.handle_request)
+        server_thread.start()
+
+        host, port = self.log_server.server_address
+
+        sock = socket.socket()
+        sock.connect((host, port))
+
+        # Sleeps prevent listener from receiving entire message in a single call
+        # to recv in order to test reconstruction of partial messages.
+        sock.sendall(message_string[:8])
+        time.sleep(.01)
+        sock.sendall(message_string[8:32])
+        time.sleep(.01)
+        sock.sendall(message_string[32:64])
+        time.sleep(.01)
+        sock.sendall(message_string[64:128])
+        time.sleep(.01)
+        sock.sendall(message_string[128:])
+
+        server_thread.join()
+
+
+class Loggable(mozlog.LoggingMixin):
+    """Trivial class inheriting from LoggingMixin"""
+    pass
+
+
+class TestLoggingMixin(unittest.TestCase):
+    """Tests basic use of LoggingMixin"""
+
+    def test_mixin(self):
+        loggable = Loggable()
+        self.assertTrue(not hasattr(loggable, "_logger"))
+        loggable.log(mozlog.INFO, "This will instantiate the logger")
+        self.assertTrue(hasattr(loggable, "_logger"))
+        self.assertEqual(loggable._logger.name, "test_logger.Loggable")
+
+        self.assertRaises(ValueError, loggable.set_logger,
+                          "not a logger")
+
+        logger = mozlog.MozLogger('test.mixin')
+        handler = ListHandler()
+        logger.addHandler(handler)
+        loggable.set_logger(logger)
+        self.assertTrue(isinstance(loggable._logger.handlers[0],
+                                   ListHandler))
+        self.assertEqual(loggable._logger.name, "test.mixin")
+
+        loggable.log(mozlog.WARN, 'message for "log" method')
+        loggable.info('message for "info" method')
+        loggable.error('message for "error" method')
+        loggable.log_structured('test_message',
+                                params={'_message': 'message for ' +
+                                        '"log_structured" method'})
+
+        expected_messages = ['message for "log" method',
+                             'message for "info" method',
+                             'message for "error" method',
+                             'message for "log_structured" method']
+
+        actual_messages = loggable._logger.handlers[0].messages
+        self.assertEqual(expected_messages, actual_messages)
+
+if __name__ == '__main__':
+    unittest.main()