testing/mozbase/docs/_static/structured_example.py

   1 # This Source Code Form is subject to the terms of the Mozilla Public
   2 # License, v. 2.0. If a copy of the MPL was not distributed with this
   3 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   4
   5 import argparse
   6 import sys
   7 import traceback
   8 import types
   9
  10 import six
  11 from mozlog import commandline, get_default_logger
  12
  13
  14 class TestAssertion(Exception):
  15     pass
  16
  17
  18 def assert_equals(a, b):
  19     if a != b:
  20         raise TestAssertion("%r not equal to %r" % (a, b))
  21
  22
  23 def expected(status):
  24     def inner(f):
  25         def test_func():
  26             f()
  27
  28         test_func.__name__ = f.__name__
  29         test_func._expected = status
  30         return test_func
  31
  32     return inner
  33
  34
  35 def test_that_passes():
  36     assert_equals(1, int("1"))
  37
  38
  39 def test_that_fails():
  40     assert_equals(1, int("2"))
  41
  42
  43 def test_that_has_an_error():
  44     assert_equals(2, 1 + "1")
  45
  46
  47 @expected("FAIL")
  48 def test_expected_fail():
  49     assert_equals(2 + 2, 5)
  50
  51
  52 class TestRunner(object):
  53     def __init__(self):
  54         self.logger = get_default_logger(component="TestRunner")
  55
  56     def gather_tests(self):
  57         for item in six.itervalues(globals()):
  58             if isinstance(item, types.FunctionType) and item.__name__.startswith(
  59                 "test_"
  60             ):
  61                 yield item.__name__, item
  62
  63     def run(self):
  64         tests = list(self.gather_tests())
  65
  66         self.logger.suite_start(tests=[name for name, func in tests])
  67         self.logger.info("Running tests")
  68         for name, func in tests:
  69             self.run_test(name, func)
  70         self.logger.suite_end()
  71
  72     def run_test(self, name, func):
  73         self.logger.test_start(name)
  74         status = None
  75         message = None
  76         expected = func._expected if hasattr(func, "_expected") else "PASS"
  77         try:
  78             func()
  79         except TestAssertion as e:
  80             status = "FAIL"
  81             message = str(e)
  82         except Exception:
  83             status = "ERROR"
  84             message = traceback.format_exc()
  85         else:
  86             status = "PASS"
  87         self.logger.test_end(name, status=status, expected=expected, message=message)
  88
  89
  90 def get_parser():
  91     parser = argparse.ArgumentParser()
  92     return parser
  93
  94
  95 def main():
  96     parser = get_parser()
  97     commandline.add_logging_group(parser)
  98
  99     args = parser.parse_args()
 100
 101     logger = commandline.setup_logging("structured-example", args, {"raw": sys.stdout})
 102
 103     runner = TestRunner()
 104     try:
 105         runner.run()
 106     except Exception:
 107         logger.critical("Error during test run:\n%s" % traceback.format_exc())
 108
 109
 110 if __name__ == "__main__":
 111     main()