Source Code for Module rosunit.rosunit_main

  1  # Software License Agreement (BSD License) 
  2  # 
  3  # Copyright (c) 2008, Willow Garage, Inc. 
  4  # All rights reserved. 
  5  # 
  6  # Redistribution and use in source and binary forms, with or without 
  7  # modification, are permitted provided that the following conditions 
  8  # are met: 
  9  # 
 10  #  * Redistributions of source code must retain the above copyright 
 11  #    notice, this list of conditions and the following disclaimer. 
 12  #  * Redistributions in binary form must reproduce the above 
 13  #    copyright notice, this list of conditions and the following 
 14  #    disclaimer in the documentation and/or other materials provided 
 15  #    with the distribution. 
 16  #  * Neither the name of Willow Garage, Inc. nor the names of its 
 17  #    contributors may be used to endorse or promote products derived 
 18  #    from this software without specific prior written permission. 
 19  # 
 20  # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 21  # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 22  # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
 23  # FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
 24  # COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
 25  # INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 26  # BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 27  # LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
 28  # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
 29  # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
 30  # ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 31  # POSSIBILITY OF SUCH DAMAGE. 
 32  # 
 33  # Revision $Id$ 
 34   
 35  from __future__ import print_function 
 36  from __future__ import with_statement 
 37   
 38  import os 
 39  import sys 
 40  import unittest 
 41   
 42  import rospkg 
 43   
 44  from . import pmon 
 45  from .baretest import BareTestCase 
 46  from .baretest import print_runner_summary 
 47  from . core import create_xml_runner 
 48  from . core import xml_results_file 
 49  from .junitxml import Result 
 50  from .junitxml import print_summary  # noqa: F401 
 51   
 52  _NAME = 'rosunit' 
 53   
 54   
 55 -def rosunitmain(): 
 56      from optparse import OptionParser 
 57      parser = OptionParser(usage='usage: %prog [options] <file> [test args...]', prog=_NAME) 
 58      parser.add_option('-t', '--text', 
 59                        action='store_true', dest='text_mode', default=False, 
 60                        help='Run with stdout output instead of XML output') 
 61      parser.add_option('--time-limit', metavar='TIME_LIMIT', 
 62                        dest='time_limit', default=60, 
 63                        help='Set time limit for test') 
 64      parser.add_option('--name', metavar='TEST_NAME', 
 65                        dest='test_name', default=None, 
 66                        help='Test name') 
 67      parser.add_option('--package', metavar='PACKAGE_NAME', 
 68                        dest='pkg', default=None, 
 69                        help='Package name (optional)') 
 70      (options, args) = parser.parse_args() 
 71   
 72      if len(args) < 1: 
 73          parser.error('You must supply a test file.') 
 74   
 75      test_file = args[0] 
 76   
 77      if options.test_name: 
 78          test_name = options.test_name 
 79      else: 
 80          test_name = os.path.basename(test_file) 
 81          if '.' in test_name: 
 82              test_name = test_name[:test_name.rfind('.')] 
 83      time_limit = float(options.time_limit) if options.time_limit else None 
 84   
 85      # If the caller didn't tell us the package name, we'll try to infer it. 
 86      # compute some common names we'll be using to generate test names and files 
 87      pkg = options.pkg 
 88      if not pkg: 
 89          pkg = rospkg.get_package_name(test_file) 
 90      if not pkg: 
 91          print("Error: failed to determine package name for file '%s'; maybe you should supply the --package argument to rosunit?" % (test_file)) 
 92          sys.exit(1) 
 93   
 94      try: 
 95          runner_result = None 
 96          results = Result('rosunit', 0, 0, 0) 
 97   
 98          test_case = BareTestCase(test_file, args[1:], 
 99                                   retry=0, time_limit=time_limit, 
100                                   test_name=test_name, text_mode=options.text_mode, package_name=pkg) 
101          suite = unittest.TestSuite() 
102          suite.addTest(test_case) 
103   
104          if options.text_mode: 
105              result = unittest.TextTestRunner(stream=sys.stdout, verbosity=2).run(suite) 
106          else: 
107              results_file = xml_results_file(pkg, test_name, True) 
108              # the is_rostest really just means "wrapper" 
109              xml_runner = create_xml_runner(pkg, test_name, 
110                                             results_file=results_file, 
111                                             is_rostest=True) 
112              runner_result = xml_runner.run(suite) 
113      finally: 
114          pmon.pmon_shutdown() 
115   
116      # summary is worthless if textMode is on as we cannot scrape .xml results 
117      results = test_case.results 
118      if not options.text_mode: 
119          print_runner_summary(runner_result, results) 
120      else: 
121          print('WARNING: overall test result is not accurate when --text is enabled') 
122   
123      if runner_result is not None and not runner_result.wasSuccessful(): 
124          sys.exit(1) 
125      elif results.num_errors or results.num_failures: 
126          sys.exit(2) 
127   
128   
129  if __name__ == '__main__': 
130      rosunitmain() 
131