Merge lp:~mvo/ubuntu-release-upgrader/fix-component-ordering into lp:ubuntu-release-upgrader

[Michael Vogt]

Fix the compoent ordering stuff once and for all!

[lp:~mvo/ubuntu-release-upgrader/fix-component-ordering]

2601. By Michael Vogt on 2012-12-14

DistUpgrade/DistUpgradeController.py: remove unneeded functools, thanks to jtaylor

2602. By Michael Vogt on 2012-12-14

add comment that sort order for non "official" components is not stable

[Martin Pitt (pitti)]

Looks good to me now, thanks Michael!

review: Approve

=== modified file 'DistUpgrade/DistUpgradeController.py'
--- DistUpgrade/DistUpgradeController.py	2012-12-13 16:42:43 +0000
+++ DistUpgrade/DistUpgradeController.py	2012-12-14 10:59:23 +0000
@@ -88,6 +88,18 @@
 
 REBOOT_REQUIRED_FILE = "/var/run/reboot-required"
 
+
+def component_ordering_key(a):
+    """ key() function for sorted to ensure "correct" component ordering """
+    ordering = ["main", "restricted", "universe", "multiverse"]
+    try:
+        return ordering.index(a)
+    except ValueError:
+        # ensure to sort behind the "official" components, order is not
+        # really important for those
+        return len(ordering)+1
+
+
 class NoBackportsFoundException(Exception):
     pass
 
@@ -725,7 +737,9 @@
                 component_diff = self.found_components[self.toDist]-self.found_components[entry.dist]
                 if component_diff:
                     logging.info("fixing components inconsistency from '%s'" % get_string_with_no_auth_from_source_entry(entry))
-                    entry.comps.extend(list(component_diff))
+                    # extend and make sure to keep order
+                    entry.comps.extend(
+                        sorted(component_diff, key=component_ordering_key))
                     logging.info("to new entry '%s'" % get_string_with_no_auth_from_source_entry(entry))
                     del self.found_components[entry.dist]
         return foundToDist

=== modified file 'tests/test_sources_list.py'
--- tests/test_sources_list.py	2012-11-06 21:31:47 +0000
+++ tests/test_sources_list.py	2012-12-14 10:59:23 +0000
@@ -9,7 +9,10 @@
 import subprocess
 import apt_pkg
 import unittest
-from DistUpgrade.DistUpgradeController import DistUpgradeController
+from DistUpgrade.DistUpgradeController import (
+    DistUpgradeController,
+    component_ordering_key,
+)
 from DistUpgrade.DistUpgradeViewNonInteractive import DistUpgradeViewNonInteractive
 from DistUpgrade import DistUpgradeConfigParser
 from DistUpgrade.utils import url_downloadable
@@ -20,6 +23,36 @@
 CURDIR = os.path.dirname(os.path.abspath(__file__))
 
 
+class TestComponentOrdering(unittest.TestCase):
+    
+    def test_component_ordering_key_from_set(self):
+        self.assertEqual(
+            sorted(set(["x", "restricted", "main"]),
+                   key=component_ordering_key),
+            ["main", "restricted", "x"])
+
+    def test_component_ordering_key_from_list(self):
+        self.assertEqual(
+            sorted(["x", "main"], key=component_ordering_key),
+            ["main", "x"])
+        self.assertEqual(
+            sorted(["restricted", "main"],
+                   key=component_ordering_key),
+            ["main", "restricted"])
+        self.assertEqual(
+            sorted(["main", "restricted"],
+                   key=component_ordering_key),
+            ["main", "restricted"])
+        self.assertEqual(
+            sorted(["main", "multiverse", "restricted", "universe"],
+                   key=component_ordering_key),
+            ["main", "restricted", "universe", "multiverse"])
+        self.assertEqual(
+            sorted(["a", "main", "multiverse", "restricted", "universe"],
+                   key=component_ordering_key),
+            ["main", "restricted", "universe", "multiverse", "a"])
+
+
 class TestSourcesListUpdate(unittest.TestCase):
 
     testdir = os.path.abspath(CURDIR + "/data-sources-list-test/")
@@ -378,6 +411,7 @@
                 "expected entry '%s' in sources.list missing. got:\n'''%s'''" %
                     (l, sources_list))
 
+
 if __name__ == "__main__":
     import sys
     for e in sys.argv: