Merge ~cpete/ubuntu-dev-tools:update-python-launchpadlib into ubuntu-dev-tools:main

[Chris Peterson]

Replace the dependency on python3-launchpadlib with
python3-launchpadlib-desktop. This package is the same as python3-launchpadlib
except that it also includes python3-keyring, which is a requirement for
some of the desktop-centric code paths. In the case, requestsync has a
path for logging in via a web browser which also requires python3-keyring
to be installed. This had caused a ModuleNotFoundError when
python3-launchpadlib dropped python3-keyring from Recommends to Suggests
(LP: #2049217).

[Andreas Hasenack (ahasenack)]

review: Needs Information

[Chris Peterson (cpete)]

Thanks for your review! I think maybe I've made this confusing by linking to the upstream MP for the bug fix. Would it be more appropriate to handle the bug fix and upstream changes separately? i.e. produce a debdiff on the bug just for the packaging changes needed and then get things fixed here later?

[Lukas Märdian (slyon)]

How did you come to the conclusion we should be using AGPL here? Can't we just stick to the original license?

review: Needs Information

[Colin Watson (cjwatson)]

Indeed, this isn't server-side code so AGPL seems inappropriate (even by Canonical's conventions).

[Chris Peterson (cpete)]

>How did you come to the conclusion we should be using AGPL here? Can't we just stick to the original license?

As discussed out of band, I had misunderstood both the licensing and our requirements. I have updated the copyright to be GPLv3 where possible and to retain the original licensing otherwise (i.e. new files in ubuntutools/tests/* are ISC since this is how it was specified in debian/copyright).

Please let me know if this is acceptable or how I could improve it.

(Apologies if you get this twice, I thought I had hit send but on refresh my comment disappeared.)

[Lukas Märdian (slyon)]

Thanks for the discussion and corresponding updates! LGTM.

review: Approve

diff --git a/debian/copyright b/debian/copyright
index 5551b55..1bec868 100644
--- a/debian/copyright
+++ b/debian/copyright
@@ -85,10 +85,12 @@ Files: doc/bitesize.1
        merge-changelog
        pyproject.toml
        run-linters
+       running-autopkgtests
        setup-packaging-environment
        syncpackage
+       ubuntutools/running_autopkgtests.py
 Copyright: 2010,      Benjamin Drung <[e-mail]>
-           2007-2023, Canonical Ltd.
+           2007-2024, Canonical Ltd.
            2008,      Jonathan Patrick Davies <[e-mail]>
            2008-2010, Martin Pitt <[e-mail]>
            2009,      Siegfried-Angel Gevatter Pujals <[e-mail]>
@@ -182,6 +184,7 @@ Copyright: 2009-2023, Benjamin Drung <[e-mail]>
            2008,      Siegfried-Angel Gevatter Pujals <[e-mail]>
            2010-2011, Stefano Rivera <[e-mail]>
            2017-2021, Dan Streetman <[e-mail]>
+           2024,      Canonical Ltd.
 License: ISC
  Permission to use, copy, modify, and/or distribute this software for any
  purpose with or without fee is hereby granted, provided that the above
diff --git a/running-autopkgtests b/running-autopkgtests
index 8b7977d..14f52fe 100755
--- a/running-autopkgtests
+++ b/running-autopkgtests
@@ -4,7 +4,20 @@
 # Authors:
 #   Andy P. Whitcroft
 #   Christian Ehrhardt
-
+#   Chris Peterson <[e-mail]>
+#
+# Copyright (C) 2024 Canonical Ltd.
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.
+# See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
 """Dumps a list of currently running tests in Autopkgtest"""
 
 __example__ = """
diff --git a/ubuntutools/running_autopkgtests.py b/ubuntutools/running_autopkgtests.py
index f583544..54efd67 100644
--- a/ubuntutools/running_autopkgtests.py
+++ b/ubuntutools/running_autopkgtests.py
@@ -1,18 +1,19 @@
 # Copyright (C) 2024 Canonical Ltd.
 # Author: Chris Peterson <[e-mail]>
+# Author: Andy P. Whitcroft
+# Author: Christian Ehrhardt
 #
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as
-# published by the Free Software Foundation, either version 3 of the
-# License, or (at your option) any later version.
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
 #
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Affero General Public License for more details.
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR PURPOSE.
+# See the GNU General Public License for more details.
 #
-# You should have received a copy of the GNU Affero General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 import datetime
 import json
diff --git a/ubuntutools/test/test_requestsync.py b/ubuntutools/test/test_requestsync.py
new file mode 100644
index 0000000..a9cfc73
--- /dev/null
+++ b/ubuntutools/test/test_requestsync.py
@@ -0,0 +1,35 @@
+# Copyright (C) 2024 Canonical Ltd.
+# Author: Chris Peterson <[e-mail]>
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+# REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+# AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+# OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+# PERFORMANCE OF THIS SOFTWARE.
+
+import unittest
+
+
+# Binary Tests
+class BinaryTests(unittest.TestCase):
+
+    # The requestsync binary has the option of using the launchpad api
+    # to log in but requires python3-keyring in addition to
+    # python3-launchpadlib. Testing the integrated login functionality
+    # automatically isn't very feasbile, but we can at least write a smoke
+    # test to make sure the required packages are installed.
+    # See LP: #2049217
+    def test_keyring_installed(self):
+        """Smoke test for required lp api dependencies"""
+        try:
+            import keyring  # noqa: F401
+        except ModuleNotFoundError:
+            raise ModuleNotFoundError(
+                "package python3-keyring is not installed"
+            )
diff --git a/ubuntutools/test/test_running_autopkgtests.py b/ubuntutools/test/test_running_autopkgtests.py
index ec68acd..915ca68 100644
--- a/ubuntutools/test/test_running_autopkgtests.py
+++ b/ubuntutools/test/test_running_autopkgtests.py
@@ -1,18 +1,17 @@
 # Copyright (C) 2024 Canonical Ltd.
 # Author: Chris Peterson <[e-mail]>
 #
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as
-# published by the Free Software Foundation, either version 3 of the
-# License, or (at your option) any later version.
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
 #
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+# REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+# AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+# OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+# PERFORMANCE OF THIS SOFTWARE.
 """ Tests for running_autopkgtests
 Tests using cached data from autopkgtest servers.