Merge lp:~thomir-deactivatedaccount/autopilot/add-version-option into lp:autopilot

[Thomi Richards]

Add a -v, --version command line option.

Add the -v, --version command for autopilot.

[Christopher Lee (veebers)]

Looks good

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'autopilot/__init__.py'
--- autopilot/__init__.py	2013-05-24 04:54:34 +0000
+++ autopilot/__init__.py	2013-05-27 22:01:28 +0000
@@ -18,6 +18,7 @@
 #
 
 from argparse import ArgumentParser, REMAINDER, Action
+import subprocess
 
 version = '1.3'
 
@@ -39,6 +40,9 @@
     object.
     """
     parser = ArgumentParser(description="Autopilot test tool.")
+    parser.add_argument('-v', '--version', action='version',
+                        version=get_version_string(),
+                        help="Display autopilot version and exit.")
     subparsers = parser.add_subparsers(help='Run modes', dest="mode")
 
     parser_run = subparsers.add_parser('run', help="Run autopilot tests")
@@ -126,3 +130,50 @@
         return True
     except ImportError:
         return False
+
+
+def get_version_string():
+    version_string = "Autopilot Source Version: " + _get_source_version()
+    pkg_version = _get_package_version()
+    if pkg_version:
+        version_string += "\nAutopilot Package Version: " + pkg_version
+    return version_string
+
+
+def _get_source_version():
+    return version
+
+
+def _get_package_version():
+    """Get the version of the currently installed package version, or None.
+
+    Only returns the package version if the package is installed, *and* we seem
+    to be running the system-wide installed code.
+    """
+    if _running_in_system():
+        return _get_package_installed_version()
+    return None
+
+
+def _running_in_system():
+    """Return True if we're running autopilot from the system installation dir."""
+    return __file__.startswith('/usr/')
+
+
+def _get_package_installed_version():
+    """Get the version string of the system-wide installed package, or None if it
+    is not installed.
+
+    """
+    try:
+        return subprocess.check_output(
+            [
+                "dpkg-query",
+                "--showformat",
+                "${Version}",
+                "--show",
+                "python-autopilot",
+                ]
+            ).strip()
+    except subprocess.CalledProcessError:
+        return None

=== added file 'autopilot/tests/unit/test_version_utility_fns.py'
--- autopilot/tests/unit/test_version_utility_fns.py	1970-01-01 00:00:00 +0000
+++ autopilot/tests/unit/test_version_utility_fns.py	2013-05-27 22:01:28 +0000
@@ -0,0 +1,76 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Autopilot Functional Test Tool
+# Copyright (C) 2012-2013 Canonical
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+from mock import patch
+import subprocess
+from testtools import TestCase
+from testtools.matchers import Equals
+
+from autopilot import (
+    _get_package_installed_version,
+    _get_package_version,
+    get_version_string,
+    )
+
+class VersionFnTests(TestCase):
+
+    def test_package_version_returns_none_when_running_from_source(self):
+        """_get_package_version must return None if we're not running in the
+        system.
+
+        """
+        with patch('autopilot._running_in_system', new=lambda: False):
+            self.assertThat(_get_package_version(), Equals(None))
+
+    def test_get_package_installed_version_returns_None_on_error(self):
+        """The _get_package_installed_version function must return None when
+        subprocess raises an error while calling dpkg-query.
+        """
+        def raise_error(*args):
+            raise subprocess.CalledProcessError(1, "dpkg-query")
+        with patch('subprocess.check_output', new=raise_error):
+            self.assertThat(_get_package_installed_version(), Equals(None))
+
+    def test_get_package_installed_version_strips_command_output(self):
+        """The _get_package_installed_version function must strip the output of
+        the dpkg-query function.
+
+        """
+        with patch('subprocess.check_output', new=lambda *a: "1.3daily13.05.22\n"):
+            self.assertThat(_get_package_installed_version(), Equals("1.3daily13.05.22"))
+
+    def test_get_version_string_shows_source_version(self):
+        """The get_version_string function must only show the source version if
+        the system version returns None.
+
+        """
+        with patch('autopilot._get_package_version', new=lambda: None):
+            with patch('autopilot._get_source_version', new=lambda: "1.3.1"):
+                version_string = get_version_string()
+        self.assertThat(version_string, Equals("Autopilot Source Version: 1.3.1"))
+
+    def test_get_version_string_shows_both_versions(self):
+        """The get_version_string function must show both source and package
+        versions, when the package version is avaialble.capitalize
+        """
+        with patch('autopilot._get_package_version', new=lambda: "1.3.1daily13.05.22"):
+            with patch('autopilot._get_source_version', new=lambda: "1.3.1"):
+                version_string = get_version_string()
+        self.assertThat(version_string,
+            Equals("Autopilot Source Version: 1.3.1\nAutopilot Package Version: 1.3.1daily13.05.22"))