Merge lp:~blake-rouse/maas/add-version-to-ui into lp:~maas-committers/maas/trunk

[Blake Rouse]

Show the installed version of MAAS on the WebUI.

This will show the installed version of the maas-region-controller package on the MAAS WebUI. If being ran from the developer environment it will show that it is from source and the revision number of the current branch.

[Christian Reis (kiko)]

On Tue, Mar 03, 2015 at 03:22:27PM -0000, Blake Rouse wrote:
> - <span class="version">MAAS</span> <a href="http://maas.ubuntu.com/docs1.7/changelog.html#id1">View release notes</a>|<a href="https://maas.ubuntu.com/documentation/">View documentation</a>
> + <span class="version">MAAS Version {{version}}</span> <a href="http://maas.ubuntu.com/docs1.7/changelog.html#id1">View release notes</a>|<a href="https://maas.ubuntu.com/documentation/">View documentation</a>

You may have considered this already but could we use the version string
to automatically select the right subdirectory in the URL?
--
Christian Robottom Reis | [+1] 612 888 4935 | http://launchpad.net/~kiko
Canonical VP Hyperscale | [+55 16] 9 9112 6430

[Raphaël Badin (rvb)]

Feel free to disagree but I feel the caching is done at the wrong level in this branch. The result is that apt will be called a lot when running from a branch.

review: Needs Fixing

[Blake Rouse (blake-rouse)]

Okay I made the required fixes and now have the documentation link working based on the version. More work then I wanted to do for this branch, but your welcome! :-)

[Gavin Panella (allenap)]

A few comments (not a review):

- Instead of searching for a particular package name, how about
  searching for the package that owns the current file? That's more
  likely to be correct *and* it reduces the coupling between upstream
  and the package. For example:

    import inspect
    from os.path import realpath

    import apt

    def find_package_of(cache, filename):
        # This is quicker than you might think.
        for pkg in cache:
            if pkg.is_installed:
                if filename in pkg.installed_files:
                    return pkg

    cache = apt.Cache()
    source = inspect.getsourcefile(find_package_of)
    package = find_package_of(cache, realpath(source))
    if package is None:
        pass # Check for branch info.
    else:
        installed = package.installed
        # Use the *source* package name and version.
        desc = "%s %s" % (installed.source_name, installed.source_version)

- When reporting the branch version, also include the branch's location,
  or its name. This is less important to the developer, but could be
  very useful in screen-grabs, for example.

[Blake Rouse (blake-rouse)]

Those are all great suggestions but I don't want to spend anymore time on this branch. There are many more important things that need to be completed and spending more time on this branch would be a waste of the time I have available to complete more important features.

I just did this quickly to fix a annoying bug, that will help the UI.

[Raphaël Badin (rvb)]

> Those are all great suggestions but I don't want to spend anymore time on this branch.

All right then… I would have liked to see the caching problem fixed but it isn't critical.

review: Approve

[Blake Rouse (blake-rouse)]

The caching problem is fixed. It will set the MAAS_VERSION to "", causing it not to be reloaded after the first call.

=== modified file 'required-packages/base'
--- required-packages/base	2015-01-20 15:56:10 +0000
+++ required-packages/base	2015-03-03 16:09:28 +0000
@@ -13,6 +13,7 @@
 libjs-angularjs
 libpq-dev
 postgresql
+python-apt
 python-bson
 python-bzrlib
 python-convoy

=== modified file 'src/maasserver/context_processors.py'
--- src/maasserver/context_processors.py	2015-02-26 18:34:40 +0000
+++ src/maasserver/context_processors.py	2015-03-03 16:09:28 +0000
@@ -23,6 +23,10 @@
 from maasserver.components import get_persistent_errors
 from maasserver.forms import get_node_edit_form
 from maasserver.models import Config
+from maasserver.utils.version import (
+    get_maas_doc_version,
+    get_maas_version,
+    )
 
 
 def yui(context):
@@ -86,4 +90,6 @@
             'site_name': Config.objects.get_config('maas_name'),
         },
         'debug': settings.DEBUG,
+        'version': get_maas_version(),
+        'doc_version': get_maas_doc_version(),
     }

=== modified file 'src/maasserver/templates/maasserver/base.html'
--- src/maasserver/templates/maasserver/base.html	2015-02-20 17:00:30 +0000
+++ src/maasserver/templates/maasserver/base.html	2015-03-03 16:09:28 +0000
@@ -123,7 +123,7 @@
                 <div class="legal-inner">
                     {% block footer-copyright %}
                     <p class="twelve-col">
-                        <span class="version">MAAS</span> <a href="http://maas.ubuntu.com/docs1.7/changelog.html#id1">View release notes</a>|<a href="https://maas.ubuntu.com/documentation/">View documentation</a>
+                        <span class="version">MAAS Version {{version}}</span> <a href="http://maas.ubuntu.com/{{doc_version}}/changelog.html#id1">View release notes</a>|<a href="https://maas.ubuntu.com/{{doc_version}}/">View documentation</a>
                     </p>
                     <p class="twelve-col copy">&copy; 2015 Canonical Ltd. Ubuntu and Canonical are registered trademarks of Canonical Ltd.</p>
                     {% endblock %}

=== modified file 'src/maasserver/templates/maasserver/index.html'
--- src/maasserver/templates/maasserver/index.html	2015-02-20 17:00:30 +0000
+++ src/maasserver/templates/maasserver/index.html	2015-03-03 16:09:28 +0000
@@ -102,7 +102,7 @@
             <div class="legal clearfix">
                 <div class="legal-inner">
                     <p class="twelve-col">
-                        <span class="version">MAAS</span> <a href="http://maas.ubuntu.com/docs1.7/changelog.html#id1">View release notes</a>|<a href="https://maas.ubuntu.com/documentation/">View documentation</a>
+                        <span class="version">MAAS Version {{version}}</span> <a href="http://maas.ubuntu.com/{{doc_version}}/changelog.html#id1">View release notes</a>|<a href="https://maas.ubuntu.com/{{doc_version}}/">View documentation</a>
                     </p>
                     <p class="twelve-col copy">&copy; 2015 Canonical Ltd. Ubuntu and Canonical are registered trademarks of Canonical Ltd.</p>
                 </div>

=== 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-03-03 16:09:28 +0000
@@ -0,0 +1,194 @@
+# 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__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 TestFormatVersion(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_formatted_version(self):
+        self.assertEquals(self.output, version.format_version(self.version))
+
+
+class TestGetMAASRegionPackageVersion(MAASTestCase):
+
+    def test__returns_value_from_global(self):
+        self.patch(version, "MAAS_VERSION", sentinel.maas_version)
+        self.assertIs(
+            sentinel.maas_version, version.get_maas_region_package_version())
+
+    def test__calls_get_version_from_apt_if_global_not_set(self):
+        self.patch(version, "MAAS_VERSION", None)
+        mock_apt = self.patch(version, "get_version_from_apt")
+        version.get_maas_region_package_version()
+        self.assertThat(
+            mock_apt, MockCalledOnceWith(version.REGION_PACKAGE_NAME))
+
+    def test__calls_format_version_with_version_from_apt(self):
+        self.patch(version, "MAAS_VERSION", None)
+        current_ver = "1.8.0~alpha4+bzr356-0ubuntu1"
+        mock_apt = self.patch(version, "get_version_from_apt")
+        mock_apt.return_value = current_ver
+        mock_format = self.patch(version, "format_version")
+        mock_format.return_value = sentinel.format
+        self.expectThat(
+            version.get_maas_region_package_version(), Is(sentinel.format))
+        self.expectThat(
+            mock_format, MockCalledOnceWith(current_ver))
+
+    def test__sets_global_value(self):
+        self.patch(version, "MAAS_VERSION", None)
+        current_ver = "1.8.0~alpha4+bzr356-0ubuntu1"
+        mock_apt = self.patch(version, "get_version_from_apt")
+        mock_apt.return_value = current_ver
+        mock_format = self.patch(version, "format_version")
+        mock_format.return_value = sentinel.format
+        version.get_maas_region_package_version()
+        self.assertIs(sentinel.format, version.MAAS_VERSION)
+
+
+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 TestGetMAASVersion(MAASTestCase):
+
+    def test__returns_version_from_get_maas_region_package_version(self):
+        mock_version = self.patch(version, "get_maas_region_package_version")
+        mock_version.return_value = sentinel.version
+        self.assertIs(sentinel.version, version.get_maas_version())
+
+    def test__returns_unknown_if_version_is_empty_and_not_bzr_branch(self):
+        mock_version = self.patch(version, "get_maas_region_package_version")
+        mock_version.return_value = ""
+        mock_branch = self.patch(version, "get_maas_branch")
+        mock_branch.return_value = None
+        self.assertEquals("unknown", version.get_maas_version())
+
+    def test__returns_from_source_and_revno_from_branch(self):
+        mock_version = self.patch(version, "get_maas_region_package_version")
+        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())
+
+
+class TestGetMAASMainVersion(MAASTestCase):
+
+    def test__returns_main_version_from_package_version_with_space(self):
+        mock_version = self.patch(version, "get_maas_region_package_version")
+        mock_version.return_value = "1.8.0 (alpha4+bzr356)"
+        self.assertEquals("1.8.0", version.get_maas_main_version())
+
+    def test__returns_main_version_from_package_version_without_space(self):
+        mock_version = self.patch(version, "get_maas_region_package_version")
+        mock_version.return_value = "1.8.0"
+        self.assertEquals("1.8.0", version.get_maas_main_version())
+
+    def test__returns_empty_if_version_is_empty(self):
+        mock_version = self.patch(version, "get_maas_region_package_version")
+        mock_version.return_value = ""
+        self.assertEquals("", version.get_maas_main_version())
+
+
+class TestGetMAASDocVersion(MAASTestCase):
+
+    def test__returns_doc_version_with_greater_than_1_decimals(self):
+        mock_version = self.patch(version, "get_maas_main_version")
+        mock_version.return_value = "1.8.0"
+        self.assertEquals("doc1.8", version.get_maas_doc_version())
+
+    def test__returns_doc_version_with_equal_to_1_decimals(self):
+        mock_version = self.patch(version, "get_maas_main_version")
+        mock_version.return_value = "1.8"
+        self.assertEquals("doc1.8", version.get_maas_doc_version())
+
+    def test__returns_just_doc_if_version_is_empty(self):
+        mock_version = self.patch(version, "get_maas_main_version")
+        mock_version.return_value = ""
+        self.assertEquals("doc", version.get_maas_doc_version())

=== 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-03-03 16:09:28 +0000
@@ -0,0 +1,129 @@
+# 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__ = [
+    ]
+
+import apt_pkg
+
+
+try:
+    from bzrlib.branch import Branch
+    from bzrlib.errors import NotBranchError
+except ImportError:
+    Branch = None
+
+# Initialize apt_pkg.
+apt_pkg.init()
+
+# Holds the version of maas.
+MAAS_VERSION = None
+
+# Name of maas package to get version from.
+REGION_PACKAGE_NAME = "maas-region-controller"
+
+
+def get_version_from_apt(package):
+    """Return the version output from `apt_pkg.Cache` for the given package."""
+    cache = apt_pkg.Cache()
+    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 format_version(version):
+    """Format `version` into a better looking string for the UI."""
+    if "~" in version:
+        main_version, extra = version.split("~", 1)
+        return "%s (%s)" % (main_version, extra.split("-", 1)[0])
+    elif "+" in version:
+        main_version, extra = version.split("+", 1)
+        return "%s (+%s)" % (main_version, extra.split("-", 1)[0])
+    else:
+        return version.split("-", 1)[0]
+
+
+def get_maas_region_package_version():
+    """Return the dpkg version for `REGION_PACKAGE_NAME`.
+
+    Lazy loads the version. Once loaded it will not be loaded again.
+    This is to speed up the call to this method and also to require the
+    region to be restarted to see the new version.
+    """
+    global MAAS_VERSION
+    if MAAS_VERSION is None:
+        MAAS_VERSION = get_version_from_apt(REGION_PACKAGE_NAME)
+        # Possible this returned an empty string, meaning its not installed
+        # and no need to call again.
+        if MAAS_VERSION:
+            # It is a valid version so set the correct format.
+            MAAS_VERSION = format_version(MAAS_VERSION)
+    return MAAS_VERSION
+
+
+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
+
+
+def get_maas_version():
+    """Return the version string for the running MAAS region."""
+    # MAAS is installed from package, return the version string.
+    version = get_maas_region_package_version()
+    if version:
+        return 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()
+
+
+def get_maas_main_version():
+    """Return the main version for the running MAAS region."""
+    # MAAS is installed from package, return the version string.
+    version = get_maas_region_package_version()
+    if version:
+        if " " in version:
+            return version.split(" ")[0]
+        else:
+            return version
+    else:
+        return ""
+
+
+def get_maas_doc_version():
+    """Return the doc version for the running MAAS region."""
+    main_version = get_maas_main_version()
+    if not main_version:
+        return "doc"
+    if main_version.count('.') > 1:
+        return "doc%s" % '.'.join(main_version.split('.')[:2])
+    else:
+        return "doc%s" % main_version