Merge lp:~coreygoldberg/autopilot/tox-and-packaging into lp:autopilot

[Corey Goldberg]

add tox config and packaging fixes

this branch adds tox support and fixes some packaging issues.
The result is that you can now build/sdist/test against supported Python versions (2.7/3.3) by running 'tox' in the root dir of the source.

changes:

=== modified file '.bzrignore'

added more files to ignore list

=== modified file 'MANIFEST.in'

added sources to MANIFEST.in so they are included in package build.
lttng_module extension and debian changelog are both referenced in setup.py, and therefore need to exist.

=== modified file 'bin/autopilot'

script was using a non-Py3 compatible sorted().
changed from using cmp to a sort key.

=== modified file 'docs/faq/contribute.rst'

FAQ was using wrong path for autopilot script when running from source branch.

=== added file 'tox.ini'

config for python-tox

[Martin Pitt (pitti)]

Thanks for the setup.py and the sorted() fixes!

18 +recursive-include debian changelog

Upstream releases generally shouldn't ship packaging information, so debian/ should not be included. But if you do it, why only debian/changelog? Most upstream projects these days don't ship a changelog as you can always get it from VCS, or they autogenerate it from "bzr log" or similar.

64 +commands =
65 + autopilot run autopilot.tests.unit

That runs only the unit tests; could we make this a bit more clever to run the full test suite if there's a $DISPLAY? When porting to py3 I found that a lot of issues only turn up with the integration tests.

review: Needs Fixing

[Corey Goldberg (coreygoldberg)]

>> 18 +recursive-include debian changelog

I included changelog here because it was already being referenced in setup.py:

try:
    from debian import changelog
    chl = changelog.Changelog(open('debian/changelog'))
    version = str(chl.get_version())
except ImportError:
    # If we don't have python-debian installed, guess a coarse-grained version
    # string
    version = '1.4.0'

so, it grabs version info from debian/changelog.

is there a better way to get version info in setup.py?

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:327
http://jenkins.qa.ubuntu.com/job/autopilot-ci/229/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-amd64-ci/157
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-armhf-ci/157
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-i386-ci/1

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-ci/229/rebuild

review: Approve (continuous-integration)

[Martin Pitt (pitti)]

debian/changelog also only has 1.4, so I think it's no worse to just stay at the "1.4.0" that's right in setup.py as a fallback.

[lp:~coreygoldberg/autopilot/tox-and-packaging]

328. By Corey Goldberg on 2013-09-17

removed debian changelog dependency from setup.py

[Corey Goldberg (coreygoldberg)]

I removed the changelog reference and hardcoded a constant in setup.py:

VERSION = '1.4.0'

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:328
http://jenkins.qa.ubuntu.com/job/autopilot-ci/231/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-amd64-ci/159
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-armhf-ci/159
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-i386-ci/3

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-ci/231/rebuild

review: Approve (continuous-integration)

[Thomi Richards (thomir-deactivatedaccount)]

LGTM

review: Approve

[Martin Pitt (pitti)]

LGTM2

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2012-10-14 22:33:09 +0000
+++ .bzrignore	2013-09-17 15:30:35 +0000
@@ -1,1 +1,4 @@
 build
+dist
+autopilot.egg-info
+.tox

=== modified file 'MANIFEST.in'
--- MANIFEST.in	2012-05-17 03:09:40 +0000
+++ MANIFEST.in	2013-09-17 15:30:35 +0000
@@ -1,2 +1,3 @@
 graft bin
-graft build/sphinx/html 
+graft build/sphinx/html
+recursive-include lttng_module *.c *.h

=== modified file 'bin/autopilot'
--- bin/autopilot	2013-09-08 17:25:37 +0000
+++ bin/autopilot	2013-09-17 15:30:35 +0000
@@ -56,10 +56,7 @@
     if args.run_order:
         test_list_fn = lambda: iterate_tests(test_suite)
     else:
-        test_list_fn = lambda: sorted(
-            iterate_tests(test_suite),
-            lambda a, b: cmp(a.id(), b.id())
-        )
+        test_list_fn = lambda: sorted(iterate_tests(test_suite), key=id)
 
     if args.suites:
         from collections import OrderedDict

=== modified file 'docs/faq/contribute.rst'
--- docs/faq/contribute.rst	2013-07-29 04:39:33 +0000
+++ docs/faq/contribute.rst	2013-09-17 15:30:35 +0000
@@ -65,7 +65,7 @@
 
     $ bzr branch lp:autopilot ~/src/autopilot/trunk
     $ cd ~/src/autopilot/trunk
-    $ autopilot list autopilot.tests
+    $ ./bin/autopilot list autopilot.tests
 
     Loading tests from: /home/example/src/autopilot/trunk
 

=== modified file 'setup.py'
--- setup.py	2013-08-20 05:43:12 +0000
+++ setup.py	2013-09-17 15:30:35 +0000
@@ -21,14 +21,9 @@
 
 from setuptools import find_packages, setup, Extension
 
-try:
-    from debian import changelog
-    chl = changelog.Changelog(open('debian/changelog'))
-    version = str(chl.get_version())
-except ImportError:
-    # If we don't have python-debian installed, guess a coarse-grained version
-    # string
-    version = '1.4.0'
+
+VERSION = '1.4.0'
+
 
 autopilot_tracepoint = Extension(
     'autopilot.tracepoint',
@@ -39,7 +34,7 @@
 
 setup(
     name='autopilot',
-    version=version,
+    version=VERSION,
     description='Functional testing tool for Ubuntu.',
     author='Thomi Richards',
     author_email='[e-mail]',

=== added file 'tox.ini'
--- tox.ini	1970-01-01 00:00:00 +0000
+++ tox.ini	2013-09-17 15:30:35 +0000
@@ -0,0 +1,13 @@
+# Tox (http://tox.testrun.org/) is a tool for running tests
+# in multiple virtualenvs. This configuration file will run the
+# test suite on all supported python versions. To use it, "pip install tox"
+# and then run "tox" from this directory.
+
+
+[tox]
+envlist = py27, py33
+
+[testenv]
+sitepackages = True
+commands =
+    autopilot run autopilot.tests.unit