Merge lp:~vds/desktopcouch/add_test_coverage into lp:desktopcouch

[Vincenzo Di Somma]

Add script runtest.sh that now runs both lint and coverage check.

Add script runtest.sh that now runs both lint and coverage check.

[Chad Miller (cmiller)]

I don't especially like the new "runtests.sh". I think all its contents should be in "runtests.py" instead.

subprocess.call() for all the lines except "pyfiles=".

find is

source_files = list()
for dir, filenames in os.walk:
   for filename in filenames:
       if filename.endswith(".py") and "test_" not in filename:
            source_files.append(os.join(dir, filename))

or something like that.

then subprocess.call(['python-coverage', '-r'] + source_files)

review: Needs Fixing

[Vincenzo Di Somma (vds)]

Moved everything to the runtests.py.

[lp:~vds/desktopcouch/add_test_coverage]

204. By Vincenzo Di Somma on 2010-11-12

removed shell script and moved averything into runtests.py

[Chad Miller (cmiller)]

Nice!

review: Approve

[Eric Casteleijn (thisfred)]

Awesome!

review: Approve

=== modified file 'desktopcouch/records/tests/test_field_registry.py'
--- desktopcouch/records/tests/test_field_registry.py	2010-04-05 17:46:53 +0000
+++ desktopcouch/records/tests/test_field_registry.py	2010-11-12 11:59:09 +0000
@@ -17,8 +17,10 @@
 
 """Test cases for field mapping"""
 
-import copy, doctest
+import copy, doctest, os
 from testtools import TestCase
+
+import desktopcouch
 from desktopcouch.records.field_registry import (
     SimpleFieldMapping, MergeableListFieldMapping, Transformer)
 from desktopcouch.records.record import Record
@@ -40,7 +42,7 @@
     'simpleField': 23,
     'strawberryField': 'the value',}
 
-field_registry = {
+FIELD_REGISTRY = {
     'simpleField': SimpleFieldMapping('simple_field'),
     'strawberryField': MergeableListFieldMapping(
         'Test App', 'test_field', 'test_fields', 'the_field'),}
@@ -50,7 +52,7 @@
     """A test transformer class."""
 
     def __init__(self):
-        super(AppTransformer, self).__init__('Test App', field_registry)
+        super(AppTransformer, self).__init__('Test App', FIELD_REGISTRY)
 
 
 class TestFieldMapping(TestCase):
@@ -81,6 +83,7 @@
 
     def test_mergeable_list_field_mapping1(self):
         """Test the MergeableListFieldMapping object."""
+        # pylint: disable-msg=W0212
         record = Record(self.test_record)
         mapping = MergeableListFieldMapping(
             'Test App', 'test_field', 'test_fields', 'the_field')
@@ -89,6 +92,7 @@
             'e47455fb-da05-481e-a2c7-88f14d5cc163']
         mapping.deleteValue(record)
         self.assertEqual(None, mapping.getValue(record))
+        # pylint: enable-msg=W0212
 
     def test_mergeable_list_field_mapping_empty_field(self):
         """Test setting empty values in the MergeableListFieldMapping object."""
@@ -109,6 +113,7 @@
 
     def test_from_app(self):
         """Test transformation from app to Ubuntu One."""
+        # pylint: disable-msg=W0212
         record = Record(record_type="http://example.com/test")
         self.transformer.from_app(APP_RECORD, record)
         underlying = record._data
@@ -118,6 +123,7 @@
         self.assertEqual(
             {'the_field': 'the value'},
             underlying['test_fields'][the_uuid])
+        # pylint: enable-msg=W0212
 
     def test_to_app(self):
         """Test transformation to app from Ubuntu One."""
@@ -128,5 +134,16 @@
             {'simpleField': 23, 'strawberryField': 'the value'}, data)
 
     def test_run_doctests(self):
-        results = doctest.testfile('../doc/field_registry.txt')
+        """We run doctests from here to give some context"""
+        field_registry_tests_path = os.path.dirname(
+            desktopcouch.__file__) + '/records/doc/field_registry.txt'
+        try:
+            results = doctest.testfile(field_registry_tests_path,
+                                       module_relative=False)
+        except IOError:
+            field_registry_tests_path = \
+                '../desktopcouch/records/doc/field_registry.txt'
+            results = doctest.testfile(field_registry_tests_path,
+                                       module_relative=False)
+            
         self.assertEqual(0, results.failed)

=== modified file 'desktopcouch/records/tests/test_record.py'
--- desktopcouch/records/tests/test_record.py	2010-11-03 23:50:38 +0000
+++ desktopcouch/records/tests/test_record.py	2010-11-12 11:59:09 +0000
@@ -19,11 +19,12 @@
 
 """Tests for the RecordDict object on which the Contacts API is built."""
 
+import doctest, os
 from testtools import TestCase
-import doctest
 
 # pylint does not like relative imports from containing packages
 # pylint: disable-msg=F0401
+import desktopcouch
 from desktopcouch.records.server import CouchDatabase
 from desktopcouch.records.record import (Record, RecordDict, MergeableList,
     record_factory, IllegalKeyException, validate, NoRecordTypeSpecified)
@@ -313,8 +314,26 @@
         """Run all doc tests from here to set the proper context (ctx)"""
         ctx = test_environment.test_context
         globs = { "db": CouchDatabase('testing', create=True, ctx=ctx) }
-        results = doctest.testfile('../doc/records.txt', globs=globs)
-        results = doctest.testfile('../doc/an_example_application.txt')
+
+        records_tests_path = os.path.dirname(
+            desktopcouch.__file__) + '/records/doc/records.txt'
+
+        app_tests_path = os.path.dirname(
+            desktopcouch.__file__) + '/records/doc/an_example_application.txt'
+        try:
+            results = doctest.testfile(records_tests_path,
+                                       globs=globs,
+                                       module_relative=False)
+            results = doctest.testfile(app_tests_path, module_relative=False)
+        except IOError:
+            results = doctest.testfile(
+                '../desktopcouch/records/doc/records.txt',
+                globs=globs,
+                module_relative=False)
+            results = doctest.testfile(
+                '../desktopcouch/records/doc/an_example_application.txt',
+                module_relative=False)
+            
         self.assertEqual(0, results.failed)
 
     def test_record_id(self):

=== modified file 'runtests.py'
--- runtests.py	2010-11-02 18:59:50 +0000
+++ runtests.py	2010-11-12 11:59:09 +0000
@@ -2,11 +2,24 @@
 
 """Run all tests of the module"""
 
-import os, sys 
-from twisted.trial import runner, itrial, reporter
-
-dir, filename = os.path.split(__file__)
-sys.path.insert(0, os.path.realpath(dir))
+import os, subprocess, sys
+import coverage
+from twisted.trial import runner, reporter
+
+def ffind(path):
+    """find files in a subtree"""
+
+    def filter_code_files(file_name):
+        """Filters files we want to check for test coverage"""
+        if file_name.endswith(".py") and "test_" not in file_name:
+            return True
+        return False
+
+    file_list = []
+    for directories, _subdirs, files in os.walk(path):
+        file_list.extend('%s%s%s' % (directories, os.sep, f) for f in files)
+    file_list = [x for x in file_list if filter_code_files(x)]
+    return (file_list)
 
 def get_test_suite():
     """Load the test suite"""
@@ -20,10 +33,15 @@
     return test_result.wasSuccessful()
 
 if __name__ == '__main__':
-    import subprocess
     from desktopcouch.platform import set_application_name
-    
+    # pylint: disable-msg=C0103
+    coverage.erase()
+    coverage.start()
     set_application_name("desktopcouch test runner")
-    ret = run()
+    return_code = run()
+    coverage.stop()
     subprocess.call(["utilities/lint.sh", ""], shell=True)
-    sys.exit(not ret)
+    source_files = ffind('desktopcouch')
+    coverage.report(source_files, ignore_errors=1, show_missing=0)
+    sys.exit(not return_code)
+    # pylint: enable-msg=C0103

=== modified file 'utilities/lint.sh'
--- utilities/lint.sh	2010-11-03 23:50:38 +0000
+++ utilities/lint.sh	2010-11-12 11:59:09 +0000
@@ -20,8 +20,9 @@
     exit 1
 fi
 files=`bzr st --short $rev_option | sed '/^.[MN]/!d; s/.* //'`
+pyfiles=`echo "$files" | egrep '.py'`
 
-if [ -z "$files" ]; then
+if [ -z "$pyfiles" ]; then
     echo ""
     echo "No changed files detected."
     echo ""
@@ -29,20 +30,13 @@
 else
     echo ""
     echo "Linting changed files:"
-    for file in $files; do
+    for file in $pyfiles; do
         echo "  $file"
     done
     echo ""
 fi
 
-
-if [ -z "$files" ]; then
-    exit $EXIT
-fi
-
-
 export PYTHONPATH="/usr/share/pycentral/pylint/site-packages:desktopcouch:$PYTHONPATH"
-pyfiles=`echo "$files" | egrep '.py'`
 pylint="`which pylint` -r n -i y --variable-rgx=[a-z_][a-z0-9_]{0,30} --method-rgx=[a-z_][a-z0-9_]{2,} -d I0011,R0904,R0913"
 
 pylint_notices=`$pylint $pyfiles`