Merge ~bryanfraschetti/ubuntu/+source/landscape-client:lp2087852-focal into ubuntu/+source/landscape-client:ubuntu/focal-devel

[Bryan Fraschetti]

SRU: Include DEB822 sources when applying profiles

Include upstream commit that adds support for DEB822 sources files when
applying repository profiles. The bug report LP: #2087852 outlines that
in the current implementation only .list files are supported which
prevents customers from customizing their archive sources as intended

ae86177... by Bryan Fraschetti on 2025-04-02

Fix DEP-3 nit and Remove Upstream Cosmetic Changes

Per Ubuntu Sponsor team's advisory, I have removed some changes from the
upstream commit which redefined some variables such as "sources1" to
source1. This should make the SRU more palatable for the SRU team

[Lukas Märdian (slyon)]

Same as Jammy: https://code.launchpad.net/~bryanfraschetti/ubuntu/+source/landscape-client/+git/landscape-client/+merge/483095

I'll be fixing the nitpicks, especially the version string! (23.02-0ubuntu1~20.04.6).

LGTM.

review: Approve

[Mitch Burton (mitchburton)]

Can we reject this merge proposal this in favour of https://code.launchpad.net/~mitchburton/ubuntu/+source/landscape-client/+git/landscape-client/+merge/486233, please?

review: Disapprove

Unmerged commits

ae86177... by Bryan Fraschetti on 2025-04-02

Fix DEP-3 nit and Remove Upstream Cosmetic Changes

Per Ubuntu Sponsor team's advisory, I have removed some changes from the
upstream commit which redefined some variables such as "sources1" to
source1. This should make the SRU more palatable for the SRU team

6985afc... by Bryan Fraschetti on 2025-03-14

SRU: Include DEB822 sources when applying profiles

Include upstream commit that adds support for DEB822 sources files when
applying repository profiles. The bug report LP: #2087852 outlines that
in the current implementation only .list files are supported which
prevents customers from customizing their archive sources as intended

diff --git a/debian/changelog b/debian/changelog
index 86246ae..11d7aaf 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+landscape-client (23.02-0ubuntu1~20.04.5ubuntu1) focal; urgency=medium
+
+  * d/p/2087852-feat-manage-ubuntu-sources-glob.patch: include DEB822 formatted sources
+    when managing apt sources by regex matching .sources files (LP: #2087852)
+
+ -- Bryan Fraschetti <[e-mail]>  Fri, 14 Mar 2025 21:29:38 +0000
+
 landscape-client (23.02-0ubuntu1~20.04.5) focal; urgency=medium
 
   * d/p/0002-fix-locale-error.path: revert previous fix for #1827857, as
diff --git a/debian/patches/2087852-feat-manage-ubuntu-sources-glob.patch b/debian/patches/2087852-feat-manage-ubuntu-sources-glob.patch
new file mode 100644
index 0000000..9e4fbf8
--- /dev/null
+++ b/debian/patches/2087852-feat-manage-ubuntu-sources-glob.patch
@@ -0,0 +1,165 @@
+Subject: feat: add support for .sources when applying repository profiles
+
+ This is the backport of an upstream commit which added support to manage
+ ubuntu sources in DEB822 format (.sources files) alongside the one-liner
+ format (.list files). The bug reported is outlined in LP: #2087852.
+
+Origin: upstream, https://github.com/canonical/landscape-client/commit/556f87c2819b218029ba0a13e2b2ceddfbec3e6b
+Bug-Ubuntu: https://bugs.launchpad.net/landscape-client/+bug/2087852
+Last-Update: 2025-04-02
+Author: Jan Dhillon <[e-mail]>
+
+diff --git a/landscape/client/manager/aptsources.py b/landscape/client/manager/aptsources.py
+index 866c6ba..4aa9e26 100644
+--- a/landscape/client/manager/aptsources.py
++++ b/landscape/client/manager/aptsources.py
+@@ -25,6 +25,11 @@ class AptSources(ManagerPlugin):
+     SOURCES_LIST_D = "/etc/apt/sources.list.d"
+     TRUSTED_GPG_D = "/etc/apt/trusted.gpg.d"
+ 
++    """
++    Valid file patterns for one-line and Deb822-style sources, respectively.
++    """
++    SOURCES_LIST_D_FILE_PATTERNS = ["*.list", "*.sources"]
++
+     def register(self, registry):
+         super(AptSources, self).register(registry)
+         registry.register_message("apt-sources-replace",
+@@ -120,8 +125,12 @@ class AptSources(ManagerPlugin):
+             if os.path.isfile(saved_sources):
+                 shutil.move(saved_sources, self.SOURCES_LIST)
+ 
+-        for filename in glob.glob(os.path.join(self.SOURCES_LIST_D, "*.list")):
+-            shutil.move(filename, "%s.save" % filename)
++        for pattern in self.SOURCES_LIST_D_FILE_PATTERNS:
++            filenames = glob.glob(
++                os.path.join(self.SOURCES_LIST_D, pattern)
++            )
++            for filename in filenames:
++                shutil.move(filename, f"{filename}.save")
+ 
+         for source in sources:
+             filename = os.path.join(self.SOURCES_LIST_D,
+diff --git a/landscape/client/manager/tests/test_aptsources.py b/landscape/client/manager/tests/test_aptsources.py
+index a4d2cd8..4f872a6 100644
+--- a/landscape/client/manager/tests/test_aptsources.py
++++ b/landscape/client/manager/tests/test_aptsources.py
+@@ -212,15 +212,27 @@ class AptSourcesTests(LandscapeTest):
+ 
+     def test_rename_sources_list_d(self):
+         """
+-        The sources files in sources.list.d are renamed to .save when a message
+-        is received.
++        The sources files (.list, .sources) in sources.list.d
++        are renamed to .save when a message is received
++        if config says to manage them, which is the default.
+         """
+-        with open(os.path.join(self.sourceslist.SOURCES_LIST_D, "file1.list"),
+-                  "w") as sources1:
++        FILE_1_LIST = os.path.join(
++            self.sourceslist.SOURCES_LIST_D, "file1.list"
++        )
++
++        FILE_2_SOURCES = os.path.join(
++            self.sourceslist.SOURCES_LIST_D, "file2.sources"
++        )
++        with open(
++            FILE_1_LIST,
++            "w"
++        ) as sources1:
+             sources1.write("ok\n")
+ 
+-        with open(os.path.join(self.sourceslist.SOURCES_LIST_D,
+-                               "file2.list.save"), "w") as sources2:
++        with open(
++            FILE_2_SOURCES,
++            "w"
++        ) as sources2:
+             sources2.write("ok\n")
+ 
+         self.manager.dispatch_message(
+@@ -228,18 +240,18 @@ class AptSourcesTests(LandscapeTest):
+              "operation-id": 1})
+ 
+         self.assertFalse(
+-            os.path.exists(
+-                os.path.join(self.sourceslist.SOURCES_LIST_D, "file1.list")))
++            os.path.exists(FILE_1_LIST),
++        )
++
++        self.assertFalse(os.path.exists(FILE_2_SOURCES))
+ 
+         self.assertTrue(
+-            os.path.exists(
+-                os.path.join(self.sourceslist.SOURCES_LIST_D,
+-                             "file1.list.save")))
++            os.path.exists(f"{FILE_1_LIST}.save"),
++        )
+ 
+         self.assertTrue(
+-            os.path.exists(
+-                os.path.join(self.sourceslist.SOURCES_LIST_D,
+-                             "file2.list.save")))
++            os.path.exists(f"{FILE_2_SOURCES}.save"),
++        )
+ 
+     def test_create_landscape_sources(self):
+         """
+@@ -289,6 +301,57 @@ class AptSourcesTests(LandscapeTest):
+ 
+         self.assertCountEqual(keys, gpg_keys)
+ 
++    def test_does_not_rename_sources_list_d(self):
++        """
++        The sources files (.list, .sources) in sources.list.d
++        are not renamed to .save when a message is received
++        if config says not to manage them
++        """
++        FILE_3_LIST = os.path.join(
++            self.sourceslist.SOURCES_LIST_D, "file3.list"
++        )
++
++        FILE_4_SOURCES = os.path.join(
++            self.sourceslist.SOURCES_LIST_D, "file4.sources"
++        )
++        with open(
++            FILE_3_LIST,
++            "w",
++        ) as source3:
++            source3.write("ok\n")
++        with open(
++            FILE_4_SOURCES,
++            "w",
++        ) as source4:
++            source4.write("ok\n")
++
++        self.manager.config.manage_sources_list_d = False
++        self.manager.dispatch_message(
++            {
++                "type": "apt-sources-replace",
++                "sources": [],
++                "gpg-keys": [],
++                "operation-id": 1,
++            },
++        )
++
++        self.assertTrue(
++            os.path.exists(FILE_3_LIST),
++        )
++
++        self.assertTrue(
++            os.path.exists(FILE_4_SOURCES),
++        )
++
++        self.assertFalse(
++            os.path.exists(f"{FILE_3_LIST}.save"),
++        )
++
++        self.assertFalse(
++            os.path.exists(f"{FILE_4_SOURCES}.save"),
++        )
++
++
+     def test_run_reporter(self):
+         """
+         After receiving a message, L{AptSources} triggers a reporter run to
diff --git a/debian/patches/series b/debian/patches/series
index 1d2050f..118a765 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1,3 +1,4 @@
 0001-start-service-during-config.patch
 add-non-filtered-interfaces-to-the-api-response.patch
 0002-fix-locale-error.patch
+2087852-feat-manage-ubuntu-sources-glob.patch