Merge lp:~allenap/maas/operating-system-get-release-title into lp:~maas-committers/maas/trunk

[Gavin Panella]

New method OperatingSystem.get_release_title().

Reimplements format_release_choices() to use this new method, in preparation for moving it out.

[Blake Rouse (blake-rouse)]

2 tests fail in maasserver.

======================================================================
FAIL: maasserver.utils.tests.test_osystems.TestReleases.test_list_release_choices_formats_releases
----------------------------------------------------------------------
_StringException: Traceback (most recent call last):
  File "/home/blake/Code/operating-system-get-release-title/src/maasserver/utils/tests/test_osystems.py", line 308, in test_list_release_choices_formats_releases
    mapping, include_default=False, include_latest=False))
  File "/home/blake/.buildout/eggs/testtools-0.9.34-py2.7.egg/testtools/testcase.py", line 324, in assertEqual
    self.assertThat(observed, matcher, message)
  File "/home/blake/.buildout/eggs/testtools-0.9.34-py2.7.egg/testtools/testcase.py", line 414, in assertThat
    raise MismatchError(matchee, matcher, mismatch, verbose)
MismatchError: !=:
reference = [(u'os-hc2h6v/release-gOwSRW', u'release-gOwSRW'),
 (u'os-hc2h6v/release-wbRO5L', u'release-wbRO5L'),
 (u'os-hc2h6v/release-hc0SVU', u'release-hc0SVU')]
actual = [(u'os-hc2h6v/release-wbRO5L', u'release-wbRO5L'),
 (u'os-hc2h6v/release-hc0SVU', u'release-hc0SVU'),
 (u'os-hc2h6v/release-gOwSRW', u'release-gOwSRW')]

======================================================================
FAIL: maasserver.utils.tests.test_osystems.TestReleases.test_list_release_choices_includes_requires_key_astrisk
----------------------------------------------------------------------
_StringException: Traceback (most recent call last):
  File "/home/blake/Code/operating-system-get-release-title/src/maasserver/utils/tests/test_osystems.py", line 327, in test_list_release_choices_includes_requires_key_astrisk
    mapping, include_default=False, include_latest=True))
  File "/home/blake/.buildout/eggs/testtools-0.9.34-py2.7.egg/testtools/testcase.py", line 324, in assertEqual
    self.assertThat(observed, matcher, message)
  File "/home/blake/.buildout/eggs/testtools-0.9.34-py2.7.egg/testtools/testcase.py", line 414, in assertThat
    raise MismatchError(matchee, matcher, mismatch, verbose)
MismatchError: !=:
reference = [(u'os-dqnHl8/*', u'Latest os-dqnHl8 Release'),
 (u'os-dqnHl8/release-HemEQv*', u'release-HemEQv'),
 (u'os-dqnHl8/release-HyIaTO*', u'release-HyIaTO'),
 (u'os-dqnHl8/release-Dt1AdB*', u'release-Dt1AdB')]
actual = [(u'os-dqnHl8/*', u'Latest os-dqnHl8 Release'),
 (u'os-dqnHl8/release-HyIaTO*', u'release-HyIaTO'),
 (u'os-dqnHl8/release-HemEQv*', u'release-HemEQv'),
 (u'os-dqnHl8/release-Dt1AdB*', u'release-Dt1AdB')]

review: Needs Fixing

[Gavin Panella (allenap)]

> 2 tests fail in maasserver.

Dang! Fixed; it was an ordering problem. I'm not sure exactly why these
suddenly decided to fail and not before, but I think I've done the right
thing.

Thanks for the review!

[Blake Rouse (blake-rouse)]

Looks good!

review: Approve

=== modified file 'src/maasserver/utils/tests/test_osystems.py'
--- src/maasserver/utils/tests/test_osystems.py	2014-07-07 15:48:58 +0000
+++ src/maasserver/utils/tests/test_osystems.py	2014-07-11 10:02:02 +0000
@@ -300,7 +300,7 @@
             }
         expected = [
             ('%s/%s' % (os_name, release), release)
-            for release in releases
+            for release in sorted(releases, reverse=True)
             ]
         self.assertEqual(
             expected,
@@ -319,7 +319,7 @@
         expected = [('%s/*' % os_name, 'Latest %s Release' % os_name)]
         expected.extend(
             ('%s/%s*' % (os_name, release), release)
-            for release in releases
+            for release in sorted(releases, reverse=True)
             )
         self.assertEqual(
             expected,

=== modified file 'src/provisioningserver/drivers/osystem/__init__.py'
--- src/provisioningserver/drivers/osystem/__init__.py	2014-06-24 18:28:28 +0000
+++ src/provisioningserver/drivers/osystem/__init__.py	2014-07-11 10:02:02 +0000
@@ -65,12 +65,26 @@
         """
 
     @abstractmethod
+    def get_release_title(self, release):
+        """Returns the title for the given release.
+
+        :type release: unicode
+        :returns: unicode
+        """
+
     def format_release_choices(self, releases):
         """Formats the release choices that are presented to the user.
 
         :param releases: list of installed boot image releases
         :returns: Return Django "choices" list
         """
+        choices = []
+        releases = sorted(releases, reverse=True)
+        for release in releases:
+            title = self.get_release_title(release)
+            if title is not None:
+                choices.append((release, title))
+        return choices
 
     @abstractmethod
     def get_boot_image_purposes(self, arch, subarch, release, label):

=== modified file 'src/provisioningserver/drivers/osystem/centos.py'
--- src/provisioningserver/drivers/osystem/centos.py	2014-06-13 20:39:27 +0000
+++ src/provisioningserver/drivers/osystem/centos.py	2014-07-11 10:02:02 +0000
@@ -54,12 +54,6 @@
         explicit."""
         return DISTRO_SERIES_DEFAULT
 
-    def format_release_choices(self, releases):
-        """Formats the release choices that are presented to the user."""
-        choices = []
-        releases = sorted(releases, reverse=True)
-        for release in releases:
-            title = DISTRO_SERIES_CHOICES.get(release)
-            if title is not None:
-                choices.append((release, title))
-        return choices
+    def get_release_title(self, release):
+        """Return the title for the given release."""
+        return DISTRO_SERIES_CHOICES.get(release)

=== modified file 'src/provisioningserver/drivers/osystem/suse.py'
--- src/provisioningserver/drivers/osystem/suse.py	2014-06-24 18:26:42 +0000
+++ src/provisioningserver/drivers/osystem/suse.py	2014-07-11 10:02:02 +0000
@@ -51,12 +51,6 @@
         explicit."""
         return DISTRO_SERIES_DEFAULT
 
-    def format_release_choices(self, releases):
-        """Formats the release choices that are presented to the user."""
-        choices = []
-        releases = sorted(releases, reverse=True)
-        for release in releases:
-            title = DISTRO_SERIES_CHOICES.get(release)
-            if title is not None:
-                choices.append((release, title))
-        return choices
+    def get_release_title(self, release):
+        """Return the title for the given release."""
+        return DISTRO_SERIES_CHOICES.get(release)

=== modified file 'src/provisioningserver/drivers/osystem/tests/test_centos.py'
--- src/provisioningserver/drivers/osystem/tests/test_centos.py	2014-06-16 14:25:56 +0000
+++ src/provisioningserver/drivers/osystem/tests/test_centos.py	2014-07-11 10:02:02 +0000
@@ -54,6 +54,13 @@
         expected = osystem.get_default_release()
         self.assertEqual(expected, DISTRO_SERIES_DEFAULT)
 
+    def test_get_release_title(self):
+        osystem = CentOS()
+        self.assertEqual(
+            {release: osystem.get_release_title(release)
+             for release in osystem.get_supported_releases()},
+            DISTRO_SERIES_CHOICES)
+
     def test_format_release_choices(self):
         osystem = CentOS()
         releases = osystem.get_supported_releases()

=== modified file 'src/provisioningserver/drivers/osystem/tests/test_suse.py'
--- src/provisioningserver/drivers/osystem/tests/test_suse.py	2014-06-18 13:37:28 +0000
+++ src/provisioningserver/drivers/osystem/tests/test_suse.py	2014-07-11 10:02:02 +0000
@@ -54,6 +54,13 @@
         expected = osystem.get_default_release()
         self.assertEqual(expected, DISTRO_SERIES_DEFAULT)
 
+    def test_get_release_title(self):
+        osystem = SUSEOS()
+        self.assertEqual(
+            {release: osystem.get_release_title(release)
+             for release in osystem.get_supported_releases()},
+            DISTRO_SERIES_CHOICES)
+
     def test_format_release_choices(self):
         osystem = SUSEOS()
         releases = osystem.get_supported_releases()

=== modified file 'src/provisioningserver/drivers/osystem/tests/test_ubuntu.py'
--- src/provisioningserver/drivers/osystem/tests/test_ubuntu.py	2014-06-10 14:45:14 +0000
+++ src/provisioningserver/drivers/osystem/tests/test_ubuntu.py	2014-07-11 10:02:02 +0000
@@ -69,6 +69,13 @@
         expected = osystem.get_default_commissioning_release()
         self.assertEqual(expected, COMMISIONING_DISTRO_SERIES_DEFAULT)
 
+    def test_get_release_title(self):
+        osystem = UbuntuOS()
+        self.assertEqual(
+            {release: osystem.get_release_title(release)
+             for release in osystem.get_supported_releases()},
+            DISTRO_SERIES_CHOICES)
+
     def test_format_release_choices(self):
         osystem = UbuntuOS()
         releases = osystem.get_supported_releases()

=== modified file 'src/provisioningserver/drivers/osystem/tests/test_windows.py'
--- src/provisioningserver/drivers/osystem/tests/test_windows.py	2014-06-25 16:29:11 +0000
+++ src/provisioningserver/drivers/osystem/tests/test_windows.py	2014-07-11 10:02:02 +0000
@@ -91,6 +91,13 @@
         expected = osystem.get_default_release()
         self.assertEqual(expected, WINDOWS_DEFAULT)
 
+    def test_get_release_title(self):
+        osystem = WindowsOS()
+        self.assertEqual(
+            {release: osystem.get_release_title(release)
+             for release in osystem.get_supported_releases()},
+            WINDOWS_CHOICES)
+
     def test_format_release_choices(self):
         osystem = WindowsOS()
         releases = osystem.get_supported_releases()

=== modified file 'src/provisioningserver/drivers/osystem/ubuntu.py'
--- src/provisioningserver/drivers/osystem/ubuntu.py	2014-06-10 14:45:14 +0000
+++ src/provisioningserver/drivers/osystem/ubuntu.py	2014-07-11 10:02:02 +0000
@@ -78,12 +78,6 @@
         """
         return COMMISIONING_DISTRO_SERIES_DEFAULT
 
-    def format_release_choices(self, releases):
-        """Formats the release choices that are presented to the user."""
-        choices = []
-        releases = sorted(releases, reverse=True)
-        for release in releases:
-            title = DISTRO_SERIES_CHOICES.get(release)
-            if title is not None:
-                choices.append((release, title))
-        return choices
+    def get_release_title(self, release):
+        """Return the title for the given release."""
+        return DISTRO_SERIES_CHOICES.get(release)

=== modified file 'src/provisioningserver/drivers/osystem/windows.py'
--- src/provisioningserver/drivers/osystem/windows.py	2014-06-25 16:29:11 +0000
+++ src/provisioningserver/drivers/osystem/windows.py	2014-07-11 10:02:02 +0000
@@ -69,15 +69,9 @@
         explicit."""
         return WINDOWS_DEFAULT
 
-    def format_release_choices(self, releases):
-        """Formats the release choices that are presented to the user."""
-        choices = []
-        releases = sorted(releases, reverse=True)
-        for release in releases:
-            title = WINDOWS_CHOICES.get(release)
-            if title is not None:
-                choices.append((release, title))
-        return choices
+    def get_release_title(self, release):
+        """Return the title for the given release."""
+        return WINDOWS_CHOICES.get(release)
 
     def requires_license_key(self, release):
         return release in REQUIRE_LICENSE_KEY

=== modified file 'src/provisioningserver/testing/os.py'
--- src/provisioningserver/testing/os.py	2014-06-09 14:50:48 +0000
+++ src/provisioningserver/testing/os.py	2014-07-11 10:02:02 +0000
@@ -46,9 +46,5 @@
     def get_default_release(self):
         return self.fake_list[0]
 
-    def format_release_choices(self, releases):
-        return [
-            (release, release)
-            for release in releases
-            if release in self.fake_list
-            ]
+    def get_release_title(self, release):
+        return release