Merge lp:~rvb/maas/expose-version-api-1.7 into lp:maas/1.7

[Raphaël Badin]

Backport 3794: Expose the version and the subversion of the running MAAS on the API.

[Raphaël Badin (rvb)]

Simple backport, self-approving.

review: Approve

=== modified file 'src/maasserver/api/tests/test_version.py'
--- src/maasserver/api/tests/test_version.py	2014-08-18 13:23:21 +0000
+++ src/maasserver/api/tests/test_version.py	2015-04-08 15:34:24 +0000
@@ -21,6 +21,7 @@
 from django.core.urlresolvers import reverse
 from maasserver.api.version import API_CAPABILITIES_LIST
 from maasserver.testing.testcase import MAASServerTestCase
+from maasserver.utils import version as version_module
 
 
 class TestFindingResources(MAASServerTestCase):
@@ -31,6 +32,10 @@
             '/api/1.0/version/', reverse('version'))
 
     def test_GET_returns_details(self):
+        mock_apt = self.patch(version_module, "get_version_from_apt")
+        mock_apt.return_value = "1.8.0~alpha4+bzr356-0ubuntu1"
+        self.patch(version_module, "_cache", {})
+
         response = self.client.get(reverse('version'))
         self.assertEqual(httplib.OK, response.status_code)
 
@@ -38,5 +43,7 @@
         self.assertEqual(
             {
                 'capabilities': API_CAPABILITIES_LIST,
+                'version': '1.8.0',
+                'subversion': 'alpha4+bzr356',
             },
             parsed_result)

=== modified file 'src/maasserver/api/version.py'
--- src/maasserver/api/version.py	2014-09-17 02:17:35 +0000
+++ src/maasserver/api/version.py	2015-04-08 15:34:24 +0000
@@ -20,6 +20,7 @@
 
 from django.http import HttpResponse
 from maasserver.api.support import AnonymousOperationsHandler
+from maasserver.utils.version import get_maas_version_subversion
 
 # MAAS capabilities. See docs/capabilities.rst for documentation.
 CAP_NETWORKS_MANAGEMENT = 'networks-management'
@@ -39,6 +40,8 @@
     This returns a JSON dictionary with information about this
     MAAS instance.
     {
+        'version': '1.8.0',
+        'subversion': 'alpha10+bzr3750',
         'capabilities': ['capability1', 'capability2', ...]
     }
     """
@@ -46,8 +49,12 @@
     create = update = delete = None
 
     def read(self, request):
+        version, subversion = get_maas_version_subversion()
         version_info = {
             'capabilities': API_CAPABILITIES_LIST,
+            'version': version,
+            'subversion': subversion,
+
         }
         return HttpResponse(
             version_info, mimetype='application/json; charset=utf-8',

=== added file 'src/maasserver/utils/tests/test_version.py'
--- src/maasserver/utils/tests/test_version.py	1970-01-01 00:00:00 +0000
+++ src/maasserver/utils/tests/test_version.py	2015-04-08 15:34:24 +0000
@@ -0,0 +1,217 @@
+# Copyright 2015 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Test version utilities."""
+
+from __future__ import (
+    absolute_import,
+    print_function,
+    unicode_literals,
+    )
+
+str = None
+
+__metaclass__ = type
+__all__ = []
+
+import random
+
+from bzrlib.errors import NotBranchError
+from maasserver.utils import version
+from maastesting.matchers import MockCalledOnceWith
+from maastesting.testcase import MAASTestCase
+from mock import (
+    MagicMock,
+    sentinel,
+    )
+from testtools.matchers import Is
+
+
+class TestGetVersionFromAPT(MAASTestCase):
+
+    def test__creates_cache_with_None_progress(self):
+        mock_Cache = self.patch(version.apt_pkg, "Cache")
+        version.get_version_from_apt(version.REGION_PACKAGE_NAME)
+        self.assertThat(mock_Cache, MockCalledOnceWith(None))
+
+    def test__returns_empty_string_if_package_not_in_cache(self):
+        self.patch(version.apt_pkg, "Cache")
+        self.assertEquals(
+            "",
+            version.get_version_from_apt(version.REGION_PACKAGE_NAME))
+
+    def test__returns_empty_string_if_not_current_ver_from_package(self):
+        package = MagicMock()
+        package.current_ver = None
+        mock_cache = {
+            version.REGION_PACKAGE_NAME: package,
+            }
+        self.patch(version.apt_pkg, "Cache").return_value = mock_cache
+        self.assertEquals(
+            "",
+            version.get_version_from_apt(version.REGION_PACKAGE_NAME))
+
+    def test__returns_ver_str_from_package(self):
+        package = MagicMock()
+        package.current_ver.ver_str = sentinel.ver_str
+        mock_cache = {
+            version.REGION_PACKAGE_NAME: package,
+            }
+        self.patch(version.apt_pkg, "Cache").return_value = mock_cache
+        self.assertIs(
+            sentinel.ver_str,
+            version.get_version_from_apt(version.REGION_PACKAGE_NAME))
+
+
+class TestGetMAASBranch(MAASTestCase):
+
+    def test__returns_None_if_Branch_is_None(self):
+        self.patch(version, "Branch", None)
+        self.assertIsNone(version.get_maas_branch())
+
+    def test__calls_Branch_open_with_current_dir(self):
+        mock_open = self.patch(version.Branch, "open")
+        mock_open.return_value = sentinel.branch
+        self.expectThat(version.get_maas_branch(), Is(sentinel.branch))
+        self.expectThat(mock_open, MockCalledOnceWith("."))
+
+    def test__returns_None_on_NotBranchError(self):
+        mock_open = self.patch(version.Branch, "open")
+        mock_open.side_effect = NotBranchError("")
+        self.assertIsNone(version.get_maas_branch())
+
+
+class TestExtractVersionSubversion(MAASTestCase):
+
+    scenarios = [
+        ("with ~", {
+            "version": "1.8.0~alpha4+bzr356-0ubuntu1",
+            "output": ("1.8.0", "alpha4+bzr356"),
+            }),
+        ("without ~", {
+            "version": "1.8.0+bzr356-0ubuntu1",
+            "output": ("1.8.0", "+bzr356"),
+            }),
+        ("without ~ or +", {
+            "version": "1.8.0-0ubuntu1",
+            "output": ("1.8.0", ""),
+            }),
+    ]
+
+    def test__returns_version_subversion(self):
+        self.assertEquals(
+            self.output, version.extract_version_subversion(self.version))
+
+
+class TestVersionTestCase(MAASTestCase):
+    """MAASTestCase that resets the cache used by utility methods."""
+
+    def setUp(self):
+        super(TestVersionTestCase, self).setUp()
+        self.patch(version, "_cache", {})
+
+
+class TestGetMAASPackageVersion(TestVersionTestCase):
+
+    def test__calls_get_version_from_apt(self):
+        mock_apt = self.patch(version, "get_version_from_apt")
+        mock_apt.return_value = sentinel.version
+        self.expectThat(
+            version.get_maas_package_version(), Is(sentinel.version))
+        self.expectThat(
+            mock_apt, MockCalledOnceWith(version.REGION_PACKAGE_NAME))
+
+
+class TestGetMAASVersionSubversion(TestVersionTestCase):
+
+    def test__returns_package_version(self):
+        mock_apt = self.patch(version, "get_version_from_apt")
+        mock_apt.return_value = "1.8.0~alpha4+bzr356-0ubuntu1"
+        self.assertEquals(
+            ("1.8.0", "alpha4+bzr356"), version.get_maas_version_subversion())
+
+    def test__returns_unknown_if_version_is_empty_and_not_bzr_branch(self):
+        mock_version = self.patch(version, "get_version_from_apt")
+        mock_version.return_value = ""
+        mock_branch = self.patch(version, "get_maas_branch")
+        mock_branch.return_value = None
+        self.assertEquals(
+            ("unknown", ""), version.get_maas_version_subversion())
+
+    def test__returns_from_source_and_revno_from_branch(self):
+        mock_version = self.patch(version, "get_version_from_apt")
+        mock_version.return_value = ""
+        revno = random.randint(1, 5000)
+        mock_branch = self.patch(version, "get_maas_branch")
+        mock_branch.return_value.revno.return_value = revno
+        self.assertEquals(
+            ("from source (+bzr%s)" % revno, ""),
+            version.get_maas_version_subversion())
+
+
+class TestGetMAASVersionUI(TestVersionTestCase):
+
+    def test__returns_package_version(self):
+        mock_apt = self.patch(version, "get_version_from_apt")
+        mock_apt.return_value = "1.8.0~alpha4+bzr356-0ubuntu1"
+        self.assertEquals(
+            "1.8.0 (alpha4+bzr356)", version.get_maas_version_ui())
+
+    def test__returns_unknown_if_version_is_empty_and_not_bzr_branch(self):
+        mock_version = self.patch(version, "get_version_from_apt")
+        mock_version.return_value = ""
+        mock_branch = self.patch(version, "get_maas_branch")
+        mock_branch.return_value = None
+        self.assertEquals("unknown", version.get_maas_version_ui())
+
+    def test__returns_from_source_and_revno_from_branch(self):
+        mock_version = self.patch(version, "get_version_from_apt")
+        mock_version.return_value = ""
+        revno = random.randint(1, 5000)
+        mock_branch = self.patch(version, "get_maas_branch")
+        mock_branch.return_value.revno.return_value = revno
+        self.assertEquals(
+            "from source (+bzr%s)" % revno, version.get_maas_version_ui())
+
+
+class TestGetMAASDocVersion(TestVersionTestCase):
+
+    def test__returns_doc_version_with_greater_than_1_decimals(self):
+        mock_apt = self.patch(version, "get_version_from_apt")
+        mock_apt.return_value = "1.8.0~alpha4+bzr356-0ubuntu1"
+        self.assertEquals("docs1.8", version.get_maas_doc_version())
+
+    def test__returns_doc_version_with_equal_to_1_decimals(self):
+        mock_apt = self.patch(version, "get_version_from_apt")
+        mock_apt.return_value = "1.8~alpha4+bzr356-0ubuntu1"
+        self.assertEquals("docs1.8", version.get_maas_doc_version())
+
+    def test__returns_just_doc_if_version_is_empty(self):
+        mock_apt = self.patch(version, "get_version_from_apt")
+        mock_apt.return_value = ""
+        self.assertEquals("docs", version.get_maas_doc_version())
+
+
+class TestVersionMethodsCached(TestVersionTestCase):
+
+    scenarios = [
+        ("get_maas_package_version", dict(method="get_maas_package_version")),
+        ("get_maas_version_subversion", dict(
+            method="get_maas_version_subversion")),
+        ("get_maas_version_ui", dict(method="get_maas_version_ui")),
+        ("get_maas_doc_version", dict(method="get_maas_doc_version")),
+        ]
+
+    def test_method_is_cached(self):
+        mock_apt = self.patch(version, "get_version_from_apt")
+        mock_apt.return_value = "1.8.0~alpha4+bzr356-0ubuntu1"
+        cached_method = getattr(version, self.method)
+        first_return_value = cached_method()
+        second_return_value = cached_method()
+        # The return value is not empty (full unit tests have been performed
+        # earlier).
+        self.assertNotIn(first_return_value, [b'', u'', None])
+        self.assertEqual(first_return_value, second_return_value)
+        # Apt has only been called once.
+        self.expectThat(
+            mock_apt, MockCalledOnceWith(version.REGION_PACKAGE_NAME))

=== added file 'src/maasserver/utils/version.py'
--- src/maasserver/utils/version.py	1970-01-01 00:00:00 +0000
+++ src/maasserver/utils/version.py	2015-04-08 15:34:24 +0000
@@ -0,0 +1,131 @@
+# Copyright 2015 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Version utilities."""
+
+from __future__ import (
+    absolute_import,
+    print_function,
+    unicode_literals,
+    )
+
+str = None
+
+__metaclass__ = type
+__all__ = [
+    "get_maas_doc_version",
+    "get_maas_version_subversion",
+    "get_maas_version_ui",
+    ]
+
+import apt_pkg
+
+
+try:
+    from bzrlib.branch import Branch
+    from bzrlib.errors import NotBranchError
+except ImportError:
+    Branch = None
+
+# Initialize apt_pkg.
+apt_pkg.init()
+
+# Name of maas package to get version from.
+REGION_PACKAGE_NAME = "maas-region-controller-min"
+
+
+def get_version_from_apt(package):
+    """Return the version output from `apt_pkg.Cache` for the given package."""
+    cache = apt_pkg.Cache(None)
+    version = None
+    if package in cache:
+        apt_package = cache[package]
+        version = apt_package.current_ver
+
+    if version is not None:
+        return version.ver_str
+    else:
+        return ""
+
+
+def extract_version_subversion(version):
+    """Return a tuple (version, subversion) from the given apt version."""
+    if "~" in version:
+        main_version, extra = version.split("~", 1)
+        return main_version, extra.split("-", 1)[0]
+    elif "+" in version:
+        main_version, extra = version.split("+", 1)
+        return main_version, "+" + extra.split("-", 1)[0]
+    else:
+        return version.split("-", 1)[0], ''
+
+
+def get_maas_branch():
+    """Return the `bzrlib.branch.Branch` for this running MAAS."""
+    if Branch is None:
+        return None
+    try:
+        return Branch.open(".")
+    except NotBranchError:
+        return None
+
+
+_cache = {}
+
+
+# A very simply memoize function: when we switch to Django 1.7 we should use
+# Django's lru_cache method.
+def simple_cache(fun):
+    def wrapped(*args, **kwargs):
+        key = hash(repr(fun) + repr(args) + repr(kwargs))
+        if not key in _cache:
+            _cache[key] = fun(*args, **kwargs)
+        return _cache[key]
+
+    wrapped.__doc__ = "%s %s" % (fun.__doc__, "(cached)")
+    return wrapped
+
+
+@simple_cache
+def get_maas_package_version():
+    """Return the apt version for the main MAAS package."""
+    return get_version_from_apt(REGION_PACKAGE_NAME)
+
+
+@simple_cache
+def get_maas_version_subversion():
+    """Return a tuple with the MAAS version and the MAAS subversion."""
+    apt_version = get_maas_package_version()
+    if apt_version:
+        return extract_version_subversion(apt_version)
+    else:
+        # Get the branch information
+        branch = get_maas_branch()
+        if branch is None:
+            # Not installed not in branch, then no way to identify. This should
+            # not happen, but just in case.
+            return "unknown", ''
+        else:
+            return "from source (+bzr%s)" % branch.revno(), ''
+
+
+@simple_cache
+def get_maas_version_ui():
+    """Return the version string for the running MAAS region.
+
+    The returned string is suitable to display in the UI.
+    """
+    version, subversion = get_maas_version_subversion()
+    return "%s (%s)" % (version, subversion) if subversion else version
+
+
+@simple_cache
+def get_maas_doc_version():
+    """Return the doc version for the running MAAS region."""
+    doc_prefix = 'docs'
+    apt_version = get_maas_package_version()
+    if apt_version:
+        version, _ = extract_version_subversion(apt_version)
+        return doc_prefix + '.'.join(version.split('.')[:2])
+    else:
+        return doc_prefix