stbt-lint

#!/usr/bin/env python

# Copyright 2014-2017 Stb-tester.com Ltd.
# Copyright 2013 YouView TV Ltd.
# License: LGPL v2.1 or (at your option) any later version (see
# https://github.com/stb-tester/stb-tester/blob/master/LICENSE for details).

"""Run static analysis over the specified stb-tester python scripts.

"stbt lint" runs "pylint" with the following additional checkers:

* E7001: The image path given to "stbt.match" (and similar functions)
  does not exist on disk.
* E7002: The return value from is_screen_black, match, match_text, ocr,
  or wait_until isn't used (perhaps you've forgotten to use "assert").
* E7003: The argument given to "wait_until" must be a callable (such as
  a function or lambda expression).
* E7004: FrameObject properties must always provide "self._frame" as the
  "frame" parameter to functions such as "stbt.match".
"""

import argparse
import os
import re
import subprocess
import sys
import threading


def main(argv):
    parser = argparse.ArgumentParser(
        prog="stbt lint",
        usage="stbt lint [--help] [pylint options] filename [filename...]",
        description=__doc__,
        epilog="Any other command-line arguments are passed through to pylint.",
        formatter_class=argparse.RawDescriptionHelpFormatter)
    _, pylint_args = parser.parse_known_args(argv[1:])

    if not pylint_args:
        parser.print_usage(sys.stderr)
        return 1

    try:
        with open("/dev/null", "w") as devnull:
            subprocess.check_call(["pylint", "--help"],
                                  stdout=devnull, stderr=devnull)
    except OSError as e:
        if e.errno == 2:
            sys.stderr.write(
                "stbt lint: error: Couldn't find 'pylint' executable\n")
            return 1

    env = os.environ
    env["PYTHONPATH"] = os.pathsep.join([
        os.path.dirname(__file__),
        env.get("PYTHONPATH", "")])

    pylint = subprocess.Popen(
        ["pylint", "--load-plugins=_stbt.pylint_plugin"] + pylint_args,
        env=env, stderr=subprocess.PIPE)

    t = threading.Thread(target=filter_warnings,
                         args=(pylint.stderr, sys.stderr))
    t.start()

    pylint.wait()
    t.join()
    return pylint.returncode


def filter_warnings(input_, output):
    while True:
        line = input_.readline()
        if not line:
            break
        if any(re.search(pattern, line) for pattern in WARNINGS):
            continue
        output.write(line)


WARNINGS = [
    # pylint:disable=line-too-long
    r"libdc1394 error: Failed to initialize libdc1394",
    r"pygobject_register_sinkfunc is deprecated",
    r"assertion .G_TYPE_IS_BOXED \(boxed_type\). failed",
    r"assertion .G_IS_PARAM_SPEC \(pspec\). failed",
    r"return isinstance\(object, \(type, types.ClassType\)\)",
    r"gsignal.c:.*: parameter 1 of type '<invalid>' for signal \".*\" is not a value type",
    r"astroid.* Use gi.require_version",
    r"^  __import__\(m\)$",
]


if __name__ == "__main__":
    sys.exit(main(sys.argv))