Merge ~cjwatson/launchpad:canonicalize-python-name into launchpad:master

[Colin Watson]

Canonicalize Python package names for publishing

We'll need to deal with republishing the files that have been published to the wrong place, but we can probably deal with that manually.

[Jürgen Gmach (jugmac00)]

review: Approve

diff --git a/lib/lp/archivepublisher/artifactory.py b/lib/lp/archivepublisher/artifactory.py
index a2112f5..4bd7f0a 100644
--- a/lib/lp/archivepublisher/artifactory.py
+++ b/lib/lp/archivepublisher/artifactory.py
@@ -18,6 +18,7 @@ from urllib.parse import quote_plus
 import requests
 from artifactory import ArtifactoryPath
 from dohq_artifactory.auth import XJFrogArtApiAuth
+from packaging import utils as packaging_utils
 from zope.security.proxy import isinstance as zope_isinstance
 
 from lp.archivepublisher.diskpool import FileAddActionEnum, poolify
@@ -58,7 +59,11 @@ def _path_for(
         package_name = release.getUserDefinedField("package-name")
         if package_name is None:
             package_name = source_name
-        path = rootpath / package_name / source_version
+        path = (
+            rootpath
+            / packaging_utils.canonicalize_name(package_name)
+            / source_version
+        )
     elif repository_format == ArchiveRepositoryFormat.CONDA:
         subdir = release.getUserDefinedField("subdir")
         if subdir is None:
diff --git a/lib/lp/archivepublisher/tests/test_artifactory.py b/lib/lp/archivepublisher/tests/test_artifactory.py
index 86a7d8c..9aea55c 100644
--- a/lib/lp/archivepublisher/tests/test_artifactory.py
+++ b/lib/lp/archivepublisher/tests/test_artifactory.py
@@ -769,6 +769,81 @@ class TestArtifactoryPoolFromLibrarian(TestCaseWithFactory):
             path.properties,
         )
 
+    def test_updateProperties_python_sdist_canonicalizes_name(self):
+        pool = self.makePool(ArchiveRepositoryFormat.PYTHON)
+        dses = [
+            self.factory.makeDistroSeries(
+                distribution=pool.archive.distribution
+            )
+            for _ in range(2)
+        ]
+        das = self.factory.makeDistroArchSeries(distroseries=dses[0])
+        ci_build = self.factory.makeCIBuild(distro_arch_series=das)
+        spr = self.factory.makeSourcePackageRelease(
+            archive=pool.archive,
+            sourcepackagename="python-foo-bar",
+            version="1.0",
+            format=SourcePackageType.CI_BUILD,
+            ci_build=ci_build,
+            user_defined_fields=[("package-name", "foo_bar")],
+        )
+        spph = self.factory.makeSourcePackagePublishingHistory(
+            archive=pool.archive,
+            sourcepackagerelease=spr,
+            distroseries=dses[0],
+            pocket=PackagePublishingPocket.RELEASE,
+            component="main",
+            sourcepackagename="python-foo-bar",
+            version="1.0",
+            channel="edge",
+            format=SourcePackageType.CI_BUILD,
+        )
+        spr = spph.sourcepackagerelease
+        sprf = self.factory.makeSourcePackageReleaseFile(
+            sourcepackagerelease=spr,
+            library_file=self.factory.makeLibraryFileAlias(
+                filename="foo_bar-1.0.tar.gz"
+            ),
+            filetype=SourcePackageFileType.SDIST,
+        )
+        spphs = [spph]
+        spphs.append(
+            spph.copyTo(dses[1], PackagePublishingPocket.RELEASE, pool.archive)
+        )
+        transaction.commit()
+        pool.addFile(None, spr.name, spr.version, sprf)
+        path = pool.rootpath / "foo-bar" / "1.0" / "foo_bar-1.0.tar.gz"
+        self.assertTrue(path.exists())
+        self.assertFalse(path.is_symlink())
+        self.assertEqual(
+            {
+                "launchpad.release-id": ["source:%d" % spr.id],
+                "launchpad.source-name": ["python-foo-bar"],
+                "launchpad.source-version": ["1.0"],
+                "soss.source_url": [
+                    ci_build.git_repository.getCodebrowseUrl()
+                ],
+                "soss.commit_id": [ci_build.commit_sha1],
+            },
+            path.properties,
+        )
+        pool.updateProperties(spr.name, spr.version, [sprf], spphs)
+        self.assertEqual(
+            {
+                "launchpad.release-id": ["source:%d" % spr.id],
+                "launchpad.source-name": ["python-foo-bar"],
+                "launchpad.source-version": ["1.0"],
+                "launchpad.channel": list(
+                    sorted("%s:edge" % ds.name for ds in dses)
+                ),
+                "soss.source_url": [
+                    ci_build.git_repository.getCodebrowseUrl()
+                ],
+                "soss.commit_id": [ci_build.commit_sha1],
+            },
+            path.properties,
+        )
+
     def test_updateProperties_python_wheel(self):
         pool = self.makePool(ArchiveRepositoryFormat.PYTHON)
         dses = [
diff --git a/pyproject.toml b/pyproject.toml
index 351470d..e553c39 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -62,6 +62,10 @@ module = "lazr.*"
 ignore_missing_imports = true
 
 [[tool.mypy.overrides]]
+module = "packaging"
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
 module = "pymacaroons"
 ignore_missing_imports = true
 
diff --git a/setup.cfg b/setup.cfg
index 367bb34..e69cbc5 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -71,6 +71,7 @@ install_requires =
     oops_timeline
     oops_twisted
     oops_wsgi
+    packaging
     paramiko
     pkginfo
     psutil