selftest/filter-subunit

   1 #!/usr/bin/env python
   2 # Filter a subunit stream
   3 # Copyright (C) 2009-2011 Jelmer Vernooij <jelmer@samba.org>
   4
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9
  10 # This program is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 # GNU General Public License for more details.
  14
  15 # You should have received a copy of the GNU General Public License
  16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 # NOTE: This script is a hack, meant as a placeholder until we can migrate
  19 # to upstream subunit's filtering tools.
  20
  21 import optparse
  22 import os
  23 import sys
  24 import signal
  25
  26 sys.path.insert(0, os.path.join(os.path.dirname(__file__), "../lib/subunit/python"))
  27 sys.path.insert(0, os.path.join(os.path.dirname(__file__), "../lib/testtools"))
  28
  29 import subunithelper
  30
  31 parser = optparse.OptionParser("filter-subunit [options] < instream > outstream")
  32 parser.add_option("--expected-failures", type="string",
  33         help="File containing list of regexes matching tests to consider known "
  34              "failures")
  35 parser.add_option("--flapping", type="string",
  36         help="File containing list of flapping tests, of which to ignore results.")
  37 parser.add_option("--strip-passed-output", action="store_true",
  38     help="Whether to strip output from tests that passed")
  39 parser.add_option("--fail-immediately", action="store_true",
  40     help="Whether to stop on the first error", default=False)
  41 parser.add_option("--prefix", type="string",
  42         help="Add prefix to all test names")
  43 parser.add_option("--suffix", type="string",
  44         help="Add suffix to all test names")
  45 parser.add_option("--fail-on-empty", default=False,
  46         action="store_true", help="Fail if there was no subunit output")
  47 parser.add_option("--list", default=False,
  48         action="store_true", help="Operate in list mode")
  49 opts, args = parser.parse_args()
  50
  51 if opts.list:
  52         prefix = opts.prefix
  53         suffix = opts.suffix
  54         if not prefix:
  55                 prefix = ""
  56         if not suffix:
  57                 suffix = ""
  58         for l in sys.stdin:
  59                 sys.stdout.write("%s%s%s\n" % (prefix, l.rstrip(), suffix))
  60         sys.exit(0)
  61
  62 if opts.expected_failures:
  63         expected_failures = subunithelper.read_test_regexes(opts.expected_failures)
  64 else:
  65         expected_failures = {}
  66
  67
  68 if opts.flapping:
  69         flapping = subunithelper.read_test_regexes(opts.flapping)
  70 else:
  71         flapping = {}
  72
  73 statistics = {
  74         'TESTS_UNEXPECTED_OK': 0,
  75         'TESTS_EXPECTED_OK': 0,
  76         'TESTS_UNEXPECTED_FAIL': 0,
  77         'TESTS_EXPECTED_FAIL': 0,
  78         'TESTS_ERROR': 0,
  79         'TESTS_SKIP': 0,
  80 }
  81
  82 def handle_sigint(sig, stack):
  83         sys.exit(0)
  84 signal.signal(signal.SIGINT, handle_sigint)
  85
  86 out = subunithelper.SubunitOps(sys.stdout)
  87 msg_ops = subunithelper.FilterOps(out, opts.prefix, opts.suffix, expected_failures,
  88                                   opts.strip_passed_output,
  89                                   fail_immediately=opts.fail_immediately,
  90                                   flapping=flapping)
  91
  92 try:
  93         ret = subunithelper.parse_results(msg_ops, statistics, sys.stdin)
  94 except subunithelper.ImmediateFail:
  95         sys.stdout.flush()
  96         sys.exit(1)
  97
  98 if opts.fail_on_empty and not msg_ops.seen_output:
  99         sys.exit(1)
 100 else:
 101         sys.exit(ret)