stbt_lint.py

#!/usr/bin/python3

# 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,
  press_and_wait, 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".
* E7005: The image path given to "stbt.match" (and similar functions)
  exists on disk, but isn't committed to git.
* E7006: FrameObject properties must use "self._frame", not
  "stbt.get_frame()".
* E7007: FrameObject properties must not have side-effects that change
  the state of the device-under-test by calling "stbt.press()" or
  "stbt.press_and_wait()".
* E7008: "assert True" has no effect; consider replacing it with a
  comment or a call to "logging.info()".
* E7009: FrameObjects are immutable, so \"refresh()\" doesn't modify the
  instance you call it on; it returns a new instance. For example,
  instead of "page.refresh()" you need to use "page = page.refresh()".

"""

import argparse
import subprocess
import sys


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

    executable_name = "pylint"

    try:
        subprocess.check_call([executable_name, "--help"],
                              stdout=subprocess.DEVNULL,
                              stderr=subprocess.DEVNULL)
    except OSError as e:
        if e.errno == 2:
            sys.stderr.write(
                "stbt lint: error: Couldn't find '%s' executable\n"
                % executable_name)
            return 1

    return subprocess.call(
        [executable_name, "--load-plugins=_stbt.pylint_plugin"] +
        pylint_args)


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