Merge lp:~javier.collado/utah/bug1152216 into lp:utah

[Javier Collado]

This branch writes to log the utah version number as soon as logging is
configured. Besides this, two new attributes have been created for the utah
module: __revno__ and __version__.

The idea is to reproduce the same version number as the one for the packages in
the launchpad PPA in a way that doesn't need to check the apt cache and with a
fallback version number when running the code from the branch:

$ python -c "import utah; print utah.__version__"
dev-r865~quantal

$ python -c "import utah; print utah.__version__"
0.10ubuntu1-r865~quantal

The new logging statement has only been added to run_utah_test.py, since the
other scripts are now considered to be deprecated.

[lp:~javier.collado/utah/bug1152216]

861. By Max Brustkern on 2013-04-11

Fixing call to sshcheck that doesn't match function signature

[Javier Collado (javier.collado)]

There's a problem with `bzr revno` when building the package with pbuilder. I'm
looking into it, so that the version number is correctly generated when
building in a PPA.

review: Needs Fixing

[Javier Collado (javier.collado)]

I've verified that the problem found with pbuilder is fixed and also used a
recipe to create a package in my ppa:
https://code.launchpad.net/~javier.collado/+archive/ppa

with the same format as the recipe being used for lp:utah.

After that, the version number using the code from the branch and the code in
the package version match the values in the original description of the merge
request.

Note that for a package that is built locally, the version number won't be the
same as if the package is built in the PPA because debian/changelog isn't
updated in the same way.

review: Needs Resubmitting

[Max Brustkern (nuclearbob)]

If I export the utah directory outside of a branch and try to import anything from the utah module, bzr revno fails, giving something like:
>>> import utah
bzr: ERROR: Not a branch: "/home/max/bzr/merges/utah/".
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "utah/__init__.py", line 22, in <module>
    __revno__ = check_output(['bzr', 'revno'], cwd=dirname(__file__)).rstrip()
  File "/usr/lib/python2.7/subprocess.py", line 544, in check_output
    raise CalledProcessError(retcode, cmd, output=output)
subprocess.CalledProcessError: Command '['bzr', 'revno']' returned non-zero exit status 3

Maybe a try that catches CalledProcessError and sets __revno__ to None or 'unknown' in case of an exception would be good.

review: Needs Fixing

[Javier Collado (javier.collado)]

@Max

Thanks for your feedback. I've added a try/except block as you suggested using
'unknown' as a default value and now the implementation covers also the case in
which the branch isn't available.

review: Needs Resubmitting

[lp:~javier.collado/utah/bug1152216]

862. By Max Brustkern on 2013-04-16

Merged iso squashfs validation update

863. By Javier Collado on 2013-04-17

Merged documentation string fixes

Source branch: lp:~javier.collado/utah/documentation_fixes

864. By Javier Collado on 2013-04-17

Merged changes to validate master runlist before provisioning (LP: #1082087)

Source branch: lp:~javier.collado/utah/bug1082087

865. By Javier Collado on 2013-04-18

Fix broken build

The package build is broken because a weird exception:
RuntimeError: sys.path must be a list of directory names

Looking in python source code I see this change:
http://hg.python.org/cpython/rev/c9bb16b7d148

that indeed changes what it was an ImportError to a RuntimeError. However, it's
not clear why PyList_Check(path) is failing because I'm pretty sure that
sys.path is a list (I even tried to filter it with os.path.isdir). Hence, I
guess that path in that code isn't really sys.path under some circumstances.

Anyway, catching that exception and handling it the same way as ImportError
works fine.

866. By Javier Collado on 2013-04-19

Merged changes to use socket timeout in SSH commands instead of SIGALRM (LP: #1169510)

Source branch: lp:~javier.collado/utah/bug1169510

[Max Brustkern (nuclearbob)]

I still get
bzr: ERROR: Not a branch: "/home/max/bzr/build/utah/".
but the imports work now. I'm not sure if we want to be passing that error through. If I set stderr to open('/dev/null', 'w') in the check_output call, it suppresses the output. If you think it makes sense to have that output, I'm fine either way.

review: Approve

[Javier Collado (javier.collado)]

Thanks for your feedback.

I didn't consider that important; but, given that the exception is caught, it
makes sense to discard the error using `os.devnull` to avoid confusion. I'll
update that and merge.

[lp:~javier.collado/utah/bug1152216]

867. By Javier Collado on 2013-04-19

Merged changes to make rsyslog timeout error message clearer (LP: #1169846)

Source branch: lp:~javier.collado/utah/bug1169846

868. By Javier Collado on 2013-04-19

Merged changes to choose battery implementation for a test run

Source branch: lp:~doanac/utah/pluggable-battery

874. By Javier Collado on 2013-04-12

Avoid using `bzr revno` when getting the version number from the package

The branch is might not be available when building the package, so calling
`bzr` will fail in such a case. However, given that the revision number is
already added to the changelog by the recipe, it's not really needed.

875. By Javier Collado on 2013-04-12

Added missing build dependency

876. By Javier Collado on 2013-04-12

Make sure __init__ is updated before make is executed

877. By Javier Collado on 2013-04-12

Removed distro from version in package since it's added by the PPA

878. By Javier Collado on 2013-04-12

Remove all imports in the packaged utah.__init__.py file

Since both revision number and distro are already in the changelog when the
package is built in the PPA, none of the imports is used.

879. By Javier Collado on 2013-04-12

Use fallback value if now bzr branch is available

As pointed out by Max, it might happen that no bzr branch is available when
getting the version information from the source.

880. By Javier Collado on 2013-04-12

Fixed escape dollar sign

881. By Javier Collado on 2013-04-12

Fixed regular expression

882. By Javier Collado on 2013-04-19

Discard bzr error when branch is not found

[Javier Collado (javier.collado)]

Rebased changes to fix conflict in debian/changelog

[Javier Collado (javier.collado)]

I successfully tested locally and with a package build in a PPA.

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2013-04-19 15:39:55 +0000
+++ debian/changelog	2013-04-19 16:14:26 +0000
@@ -7,6 +7,7 @@
   [ Javier Collado ]
   * Use socket timeout in SSH commands instead of SIGALRM (LP: #1169510)
   * Make rsyslog timeout error message clearer (LP: #1169846)
+  * Write to log UTAH version as soon as possible (LP: #1152216)
 
  -- Max Brustkern <[e-mail]>  Tue, 16 Apr 2013 09:21:19 -0400
 

=== modified file 'debian/control'
--- debian/control	2013-04-01 11:19:35 +0000
+++ debian/control	2013-04-19 16:14:26 +0000
@@ -3,7 +3,7 @@
 X-Python-Version: >= 2.5
 Priority: optional
 Maintainer: Max Brustkern <[e-mail]>
-Build-Depends: debhelper (>= 7.0.50~), devscripts,
+Build-Depends: debhelper (>= 7.0.50~), devscripts, gawk,
                python-all, python-bzrlib, python-netifaces, python-psutil,
                python-sphinx, python-jsonschema (>= 0.5~)
 Standards-Version: 3.9.3

=== modified file 'debian/rules'
--- debian/rules	2012-12-12 22:34:14 +0000
+++ debian/rules	2013-04-19 16:14:26 +0000
@@ -12,6 +12,13 @@
 	dh_auto_clean
 
 override_dh_auto_build:
+	# Set __version__ in utah package to version number in debian/changelog
+	sed -i -r "\
+	s/^(__version__ =) .*/\1 \
+	'$(shell dpkg-parsechangelog | gawk '/^Version:/ {print $$2}')'/;\
+	/^import/,/__revno__ = 'unknown'$$/d;\
+	" \
+	utah/__init__.py
 	make
 	set -e && for pyvers in $(PYVERS); do python$$pyvers setup.py build; done
 	dh_auto_build

=== modified file 'examples/run_utah_tests.py'
--- examples/run_utah_tests.py	2013-04-19 11:42:45 +0000
+++ examples/run_utah_tests.py	2013-04-19 16:14:26 +0000
@@ -22,6 +22,7 @@
 import sys
 from traceback import format_exception
 
+import utah
 from utah import config
 from utah.cleanup import cleanup
 from utah.group import check_user_group, print_group_error_message
@@ -84,6 +85,7 @@
         machinetype = args.machinetype
 
     configure_logging(args.debug)
+    logging.info('UTAH version: %s', utah.__version__)
 
     # Default is now CustomVM
     function = run_install_test

=== modified file 'utah/__init__.py'
--- utah/__init__.py	2013-04-04 13:42:40 +0000
+++ utah/__init__.py	2013-04-19 16:14:26 +0000
@@ -14,3 +14,21 @@
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 """utah"""
+
+import os
+import os.path
+from platform import linux_distribution as distro
+from subprocess import (
+    CalledProcessError,
+    check_output,
+)
+
+try:
+    with open(os.devnull, 'w') as devnull:
+        __revno__ = check_output(['bzr', 'revno'],
+                                 cwd=os.path.dirname(__file__),
+                                 stderr=devnull).rstrip()
+except CalledProcessError:
+    __revno__ = 'unknown'
+
+__version__ = 'dev-r{}~{}'.format(__revno__, distro()[-1])