Merge lp:~sil2100/ubuntu-cdimage/uc-series-and-more-rebuild into lp:ubuntu-cdimage

[Łukasz Zemczak]

Add proper core series handling to the config. Convert the UC milestone series to Ubuntu series.

Add proper core series handling to the config. Convert the UC milestone series to Ubuntu series.

So the previous change wasn't entirely complete. Generally the ISO Tracker milestones result in the DIST being the core series (so like '22'), which doesn't really currently easily translate to anything in cdimage.

It's about time we actually started treating core series a bit more 'serious'. So I'm adding some code to the config.py Series and Config items to properly handle UC series. There were a few different ways to do it - originally I wanted to do a separate entry for Ubuntu Core items (with those having distribution="ubuntu-core"), but then I think that it's enough to re-use existing series. Since UC series and Ubuntu series are basically part of the same thing. This is why I think this way seems a bit better.

Controversial might be the fact of hard-coding that devel == UCXX+2, but I think this is the logical choice. We *anyway* always handle it this way, just implicitly. We always assumed > than latest core to be the devel core series. I think this is the way to go here.

[Łukasz Zemczak (sil2100)]

Since I added some unit tests, those can be ran by using `PYTHONPATH=lib python3 -m unittest cdimage.tests.test_config` (since the test suite is still not clean due to my simplestream fixing branch not yet finished).

[Łukasz Zemczak (sil2100)]

Thank you for your swift review Steve! I answered your inline question inline :)

[Steve Langasek (vorlon)]

Thanks, lgtm then

review: Approve

=== modified file 'bin/rebuild-requests'
--- bin/rebuild-requests	2022-06-09 08:31:08 +0000
+++ bin/rebuild-requests	2022-06-09 12:23:48 +0000
@@ -201,6 +201,9 @@
                 # Due to the different structure, IMAGE_TYPE is the channel
                 # here
                 env['CHANNEL'] = entry[2]
+                # And cdimage still uses distro series for the core series
+                # builds
+                env['DIST'] = Series.find_by_core_series(env['DIST']).name
                 image_type = "daily-live"
 
             cmd = ["for-project", project, "cron.%s" % image_type]
 
=== modified file 'lib/cdimage/config.py'
--- lib/cdimage/config.py	2022-05-02 18:54:08 +0000
+++ lib/cdimage/config.py	2022-06-09 12:23:48 +0000
@@ -85,6 +85,21 @@
                 return series
         raise ValueError("No series with distribution %s" % distribution)
 
+    @classmethod
+    def find_by_core_series(self, core_series):
+        for series in all_series:
+            if series.core_series == core_series:
+                return series
+        else:
+            raise ValueError(
+                "No Ubuntu Core series %s" % core_series)
+
+    @classmethod
+    def latest_core(self):
+        for series in reversed(all_series):
+            if getattr(series, "_core_series", None):
+                return series
+
     def __str__(self):
         return self.name
 
@@ -148,6 +163,17 @@
     def realversion(self):
         return getattr(self, "pointversion", self.version)
 
+    @property
+    def core_series(self):
+        core_version = getattr(self, "_core_series", None)
+        if not core_version and self.is_latest:
+            # Automatically handle the devel series being 'XX+2', without
+            # having to manually bump it everytime we prepare for the next
+            # core series
+            latest_core = Series.latest_core()
+            core_version = str(int(latest_core.core_series) + 2)
+        return core_version
+
 
 # TODO: This should probably come from a configuration file.
 all_series.extend([
@@ -194,14 +220,16 @@
     Series(
         "xenial", "16.04", "Xenial Xerus",
         pointversion="16.04.7",
-        all_lts_projects=True),
+        all_lts_projects=True,
+        _core_series="16"),
     Series("yakkety", "16.10", "Yakkety Yak"),
     Series("zesty", "17.04", "Zesty Zapus"),
     Series("artful", "17.10", "Artful Aardvark"),
     Series(
         "bionic", "18.04", "Bionic Beaver",
         pointversion="18.04.6",
-        all_lts_projects=True),
+        all_lts_projects=True,
+        _core_series="18"),
     Series("cosmic", "18.10", "Cosmic Cuttlefish"),
     Series("disco", "19.04", "Disco Dingo"),
     Series(
@@ -210,13 +238,15 @@
     Series(
         "focal", "20.04", "Focal Fossa",
         pointversion="20.04.4",
-        all_lts_projects=True),
+        all_lts_projects=True,
+        _core_series="20"),
     Series("groovy", "20.10", "Groovy Gorilla"),
     Series("hirsute", "21.04", "Hirsute Hippo"),
     Series("impish", "21.10", "Impish Indri"),
     Series(
         "jammy", "22.04", "Jammy Jellyfish",
-        all_lts_projects=True),
+        all_lts_projects=True,
+        _core_series="22"),
     Series("kinetic", "22.10", "Kinetic Kudu"),
 
     Series("14.09", "14.09", "RTM 14.09", distribution="ubuntu-rtm"),
@@ -516,15 +546,7 @@
 
     @property
     def core_series(self):
-        if self["DIST"] >= "xenial" and self["DIST"] <= "artful":
-            return '16'
-        if self["DIST"] >= "bionic" and self["DIST"] <= "eoan":
-            return '18'
-        if self["DIST"] == "focal":
-            return '20'
-        if self["DIST"] >= "groovy":
-            return '22'
-        return None
+        return self["DIST"].core_series
 
     def livefs_project_for_arch(self, arch):
         if arch not in self.livefs_arch_mapping:
 
=== modified file 'lib/cdimage/tests/test_config.py'
--- lib/cdimage/tests/test_config.py	2022-02-14 19:13:02 +0000
+++ lib/cdimage/tests/test_config.py	2022-06-09 12:23:48 +0000
@@ -22,6 +22,11 @@
 import os
 from textwrap import dedent
 
+try:
+    from unittest import mock
+except ImportError:
+    import mock
+
 from cdimage.config import Config, Series, all_series
 from cdimage.tests.helpers import TestCase, mkfile
 
@@ -47,6 +52,34 @@
         self.assertRaises(
             ValueError, Series.latest, distribution="nonexistent")
 
+    def test_find_by_core_series(self):
+        series = Series.find_by_core_series("20")
+        self.assertEqual(("focal", "20.04", "Focal Fossa"), tuple(series))
+        self.assertRaises(
+            ValueError, Series.find_by_core_series, core_series="21")
+
+    def test_latest_core(self):
+        series = Series.latest_core()
+        self.assertEqual("ubuntu", series.distribution)
+        self.assertTrue(getattr(series, "_core_series"))
+
+    @mock.patch("lib.cdimage.config.all_series")
+    def test_core_series(self, all_series):
+        impish = Series("impish", "21.10", "Impish Indri")
+        jammy = Series(
+            "jammy", "22.04", "Jammy Jellyfish",
+            all_lts_projects=True,
+            _core_series="22")
+        kinetic = Series("kinetic", "22.10", "Kinetic Kudu")
+        all_series = [
+            impish,
+            jammy,
+            kinetic
+        ]
+        self.assertEqual("22", jammy.core_series)
+        self.assertEqual("24", kinetic.core_series)
+        self.assertEqual(None, impish.core_series)
+
     def test_str(self):
         series = Series.find_by_name("warty")
         self.assertEqual("warty", str(series))
@@ -384,15 +417,9 @@
         self.assertEqual("16", config.core_series)
         config["DIST"] = "bionic"
         self.assertEqual("18", config.core_series)
-        config["DIST"] = "cosmic"
-        self.assertEqual("18", config.core_series)
-        config["DIST"] = "disco"
-        self.assertEqual("18", config.core_series)
-        config["DIST"] = "eoan"
-        self.assertEqual("18", config.core_series)
         config["DIST"] = "focal"
         self.assertEqual("20", config.core_series)
-        config["DIST"] = "hirsute"
+        config["DIST"] = "jammy"
         self.assertEqual("22", config.core_series)
 
     def test_arches(self):