Merge lp:~thomir-deactivatedaccount/pyruntest/fix-running into lp:pyruntest

[Thomi Richards]

Run tests from both within a python package and from outside it.

This branch merges a couple of martin's proposed branches, adds tests, and adds a few other bug-fixes.

The overall purpose is to ensure that we can run tests both within a package and from outside the package.

[jenkins (martin-mrazik+qa)]

PASSED: Continuous integration, rev:11
http://s-jenkins:8080/job/pyruntest-ci/3/
Executed test runs:
    SUCCESS: http://s-jenkins:8080/job/pyruntest-ci/./build=pbuilder,distribution=quantal,flavor=amd64/3/console

review: Approve (continuous-integration)

[Christopher Lee (veebers)]

Looks good.

review: Approve

[jenkins (martin-mrazik+qa)]

FAILED: Autolanding.
More details in the following jenkins job:
http://s-jenkins:8080/job/pyruntest-autolanding/1/

review: Needs Fixing (continuous-integration)

[jenkins (martin-mrazik+qa)]

FAILED: Autolanding.
More details in the following jenkins job:
http://s-jenkins:8080/job/pyruntest-autolanding/2/

review: Needs Fixing (continuous-integration)

[jenkins (martin-mrazik+qa)]

FAILED: Autolanding.
More details in the following jenkins job:
http://s-jenkins:8080/job/pyruntest-autolanding/3/

review: Needs Fixing (continuous-integration)

=== modified file 'pyruntest'
--- pyruntest	2012-09-12 21:17:03 +0000
+++ pyruntest	2012-09-14 02:26:23 +0000
@@ -13,15 +13,22 @@
 import argparse
 from argparse import ArgumentParser
 from contextlib import contextmanager
+import logging
 import sys
+from testtools import iterate_tests
 from unittest.loader import TestLoader
 from unittest import TestSuite
-from testtools import iterate_tests
+import os
+
+
+logger = logging.getLogger(__name__)
+_output_stream = None
 
 
 def main():
     args = parse_args()
 
+    logging.basicConfig(stream=get_output_stream(args))
     test_suite = load_test_suite_from_name(args.suite)
     runner = construct_test_runner(args)
     success = runner.run(test_suite).wasSuccessful()
@@ -29,8 +36,29 @@
         exit(1)
 
 
+def get_output_stream(args):
+    global _output_stream
+
+    if _output_stream is None:
+        if args.output:
+            _output_stream = open(args.output, 'w')
+        else:
+            _output_stream = sys.stdout
+    return _output_stream
+
+
+def patch_python_path():
+    """Prepend the current directory to sys.path to ensure that we can
+    load & run tests if the caller is in the parent directory.
+
+    """
+    if os.getcwd() not in sys.path:
+        sys.path.insert(0, os.getcwd())
+
+
 def load_test_suite_from_name(test_names):
     """Returns a test suite object given a dotted test names."""
+    patch_python_path()
     loader = TestLoader()
     if isinstance(test_names, basestring):
         test_names = list(test_names)
@@ -39,12 +67,30 @@
                         % (type(test_names)))
 
     tests = []
-
+    test_package_locations = []
     for test_name in test_names:
         top_level_pkg = test_name.split('.')[0]
-        tests.append(loader.discover(top_level_pkg))
+        package = __import__(top_level_pkg)
+        pkg_file = package.__file__
+        if os.path.basename(pkg_file).startswith('__init__'):
+            package_parent_path = os.path.abspath(
+                os.path.join(
+                    os.path.dirname(pkg_file),
+                    '..'
+                    )
+                )
+        else:
+            package_parent_path = os.path.abspath(os.path.dirname(pkg_file))
+        if package_parent_path not in test_package_locations:
+            test_package_locations.append(package_parent_path)
+
+        tests.append(loader.discover(top_level_pkg,
+                                     top_level_dir=package_parent_path))
     all_tests = TestSuite(tests)
 
+    test_dirs = ", ".join(sorted(test_package_locations))
+    logger.info("Loading tests from: %s\n", test_dirs)
+
     requested_tests = {}
     for test in iterate_tests(all_tests):
         # The test loader returns tests that start with 'unittest.loader' if for
@@ -64,9 +110,7 @@
 
 
 def construct_test_runner(args):
-    output_stream = sys.stdout
-    if args.output:
-        output_stream = open(args.output, 'w')
+    output_stream = get_output_stream(args)
 
     kwargs = dict(stdout=output_stream,
         output_format=args.format
@@ -96,8 +140,8 @@
         self.result_class = output_format
         self.coverage = coverage
         self.cover_format = cover_format
-        self.cover_output=cover_output
-        self.cover_exclude=cover_exclude.split(',')
+        self.cover_output = cover_output
+        self.cover_exclude = cover_exclude.split(',')
 
     def run(self, test):
         "Run the given test case or test suite."
@@ -135,7 +179,6 @@
         cov.report(file=open(filename, 'w'))
 
 
-
 class FormatAction(argparse.Action):
     """An Argparse action that stores the output format class object."""
 

=== modified file 'setup.py'
--- setup.py	2012-09-12 12:08:31 +0000
+++ setup.py	2012-09-14 02:26:23 +0000
@@ -1,3 +1,11 @@
+# Copyright 2012 Canonical
+# Author: Thomi Richards
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+
 from setuptools import setup
 
 setup(
@@ -6,7 +14,7 @@
     description='Python script for running python tests.',
     author='Thomi Richards',
     author_email='[e-mail]',
-    url='https://launchpad.net/pytestrunner',
+    url='https://launchpad.net/pyruntest',
     license='GPLv3',
     scripts=['pyruntest', ],
 )

=== modified file 'tests.py'
--- tests.py	2012-09-12 21:17:03 +0000
+++ tests.py	2012-09-14 02:26:23 +0000
@@ -13,6 +13,7 @@
 import os.path
 from shutil import rmtree
 import subprocess
+from tempfile import mkdtemp
 from testtools import TestCase
 from testtools.matchers import Equals, NotEquals, Contains, Not
 from textwrap import dedent
@@ -35,13 +36,37 @@
             '''))
         self.addCleanup(remove, 'test_empty.py')
 
-    def run_script(self, *args):
+    def create_test_package(self):
+        location = mkdtemp()
+        self.addCleanup(rmtree, location)
+        open(os.path.join(location, '__init__.py'), 'w').write('#')
+        os.mkdir(os.path.join(location, 'tests'))
+        open(os.path.join(location, 'tests', '__init__.py'), 'w').write('#')
+        open(os.path.join(location, 'tests', 'test_empty.py'), 'w').write(
+            dedent('''\
+
+            from testtools import TestCase
+
+
+            class SimpleTests(TestCase):
+
+                def test_simple(self):
+                    self.assertEqual(1,1)
+
+            '''))
+        return location
+
+    def run_script(self, *args, **kwargs):
         arguments = ['./pyruntest']
         arguments.extend(args)
 
+        if 'cwd' in kwargs:
+            arguments[0] = os.path.abspath('./pyruntest')
+
         process = subprocess.Popen(arguments,
             stdout=subprocess.PIPE,
-            stderr=subprocess.PIPE
+            stderr=subprocess.PIPE,
+            **kwargs
             )
         stdout, stderr = process.communicate()
         return (stdout, stderr, process.poll())
@@ -155,3 +180,21 @@
         remove('coverage.xml')
         out, err, code = self.run_script('-c', '-cf', 'xml', '-ce', '/usr*', 'test_empty')
         self.assertThat(open('coverage.xml').read(), Not(Contains('/usr/')))
+
+    def test_can_run_from_inside_package(self):
+        location = self.create_test_package()
+        out, err, code = self.run_script('tests', cwd=location)
+
+        self.assertThat(code, Equals(0))
+        self.assertThat(err, Equals(''))
+        self.assertThat(out, Contains('Ran 1 test in'))
+
+    def test_can_run_from_outside_package(self):
+        location = self.create_test_package()
+        pkg_name = location.split(os.path.sep)[-1]
+        parent_dir = os.path.sep.join(location.split(os.path.sep)[:-1])
+        out, err, code = self.run_script(pkg_name, cwd=parent_dir)
+
+        self.assertThat(code, Equals(0))
+        self.assertThat(err, Equals(''))
+        self.assertThat(out, Contains('Ran 1 test in'))