Merge ppa-dev-tools:trigger-action-urls into ppa-dev-tools:main

[Bryce Harrington]

Starts integrating Trigger objects into the `ppa tests` command, and adds the action urls (the urls that actually cause autopkgtest to fire up the tests). Also adds the PPA element to the Triggers, which for now are required but later I think I could make that optional in order to make this code work for triggering directly against -proposed.

For now this just dumps the action urls to the output.

[Christian Ehrhardt  (paelzer)]

I'm generally +1 this is small and a good step forward.
One question on URL escaping and testing it below.
Feel free to add it here or putting it onto your known-todo-list.

review: Approve

[Bryce Harrington (bryce)]

Thanks, I'll get the encoding added for the urls, and accompanying tests, then will land.

[Bryce Harrington (bryce)]

I did a minor reimplementation of action_url() to use urlencode, updated test cases, and landed the branch. Thanks again!

diff --git a/ppa/ppa.py b/ppa/ppa.py
index 763ed7f..f26a1ea 100755
--- a/ppa/ppa.py
+++ b/ppa/ppa.py
@@ -108,13 +108,12 @@ class Ppa:
                 f'ppa_name={self.ppa_name!r}, team_name={self.team_name!r})')
 
     def __str__(self):
-        s = ''
-        s += "ppa:        {}\n".format(self.name)
-        s += "address:    {}\n".format(self.address)
-        s += "url:        {}\n".format(self.url)
-        s += "description:\n"
-        s += indent(self.description, 4)
-        return s
+        """Returns a displayable string identifying the PPA.
+
+        :rtype: str
+        :returns: Displayable representation of the PPA.
+        """
+        return f"{self.team_name}/{self.name}"
 
     @property
     def archive(self):
diff --git a/ppa/trigger.py b/ppa/trigger.py
index 79276da..42e4d00 100755
--- a/ppa/trigger.py
+++ b/ppa/trigger.py
@@ -26,18 +26,20 @@ class Trigger:
     package and/or architectures, but all such Triggers must be against
     the same series as the Job itself.
     """
-    def __init__(self, package, version, arch, series):
+    def __init__(self, package, version, arch, series, ppa):
         """Initializes a new Trigger for a given package and version.
 
         :param str package: The source package name.
         :param str version: The version of the source package to install.
         :param str arch: The architecture for the trigger.
         :param str series: The distro release series codename.
+        :param Ppa ppa: (Optional) PPA wrapper object to run tests against.
         """
         self.package = package
         self.version = version
         self.arch = arch
         self.series = series
+        self.ppa = ppa
 
     def __repr__(self) -> str:
         """Machine-parsable unique representation of object.
@@ -47,7 +49,7 @@ class Trigger:
         """
         return (f'{self.__class__.__name__}('
                 f'package={self.package!r}, version={self.version!r}, '
-                f'arch={self.arch!r}, series={self.series!r})')
+                f'arch={self.arch!r}, series={self.series!r}, ppa={self.ppa!r})')
 
     def __str__(self) -> str:
         """Human-readable summary of the object.
@@ -58,11 +60,11 @@ class Trigger:
         return f"{self.package}/{self.version}"
 
     @cached_property
-    def autopkgtest_url(self) -> str:
+    def history_url(self) -> str:
         """Renders the trigger as a URL to the job history.
 
         :rtype: str
-        :returns: tbd
+        :returns: Job history URL
         """
         if self.package.startswith('lib'):
             prefix = self.package[0:4]
@@ -71,10 +73,34 @@ class Trigger:
         pkg_str = f"{prefix}/{self.package}"
         return f"{URL_AUTOPKGTEST}/packages/{pkg_str}/{self.series}/{self.arch}"
 
+    @cached_property
+    def action_url(self) -> str:
+        """Renders the trigger as a URL to start running the test.
+
+        :rtype: str
+        :returns: Trigger action URL
+        """
+        elements = [
+            f"release={self.series}",
+            f"package={self.package}",
+            f"arch={self.arch}",
+        ]
+
+        # Trigger for the source package itself
+        elements.append(f"trigger={self.package}/{self.version}")
+
+        # TODO: Additional triggers...
+
+        # The PPA, if one is defined for this trigger
+        if self.ppa:
+            elements.append(f"ppa={self.ppa}")
+
+        return f"{URL_AUTOPKGTEST}/request.cgi?" + "&".join(elements)
+
 
 if __name__ == "__main__":
     print("### Trigger class smoke test ###")
 
     trigger = Trigger('my-package', '1.2.3', 'amd64', 'kinetic')
     print(trigger)
-    print(trigger.autopkgtest_url)
+    print(trigger.history_url)
diff --git a/scripts/ppa b/scripts/ppa
index 1607342..55a6211 100755
--- a/scripts/ppa
+++ b/scripts/ppa
@@ -83,6 +83,7 @@ from ppa.result import (
     get_results
 )
 from ppa.text import o2str
+from ppa.trigger import Trigger
 
 import ppa.debug
 from ppa.debug import dbg, die, warn
@@ -373,7 +374,12 @@ def command_show(lp, config):
     arch = None
     try:
         ppa = get_ppa(lp, config)
-        print(ppa)
+        print(f"ppa:        {self.name}")
+        print(f"address:    {self.address}")
+        print(f"url:        {self.url}")
+        print(f"description:")
+        print(indent(self.description, 4))
+
         print("sources:")
         for source in ppa.get_source_publications(distro, series, arch):
             print("   %s (%s) %s" % (
@@ -486,7 +492,16 @@ def command_tests(lp, config):
 
     try:
         ppa = get_ppa(lp, config)
-        target = "%s/%s" % (ppa.team_name, ppa.name)
+        for source_pub in ppa.get_source_publications():
+            # Triggers
+            for arch in ARCHES_AUTOPKGTEST:
+                trigger = Trigger(
+                    package=source_pub.source_package_name,
+                    version=source_pub.source_package_version,
+                    arch=arch,
+                    series=source_pub.distro_series.name,
+                    ppa=ppa)
+                print(trigger.action_url)
 
         # Results
         base_results_fmt = f"{URL_AUTOPKGTEST}/results/autopkgtest-%s-%s-%s/"
@@ -507,13 +522,13 @@ def command_tests(lp, config):
         # Running Queue
         response = open_url(f"{URL_AUTOPKGTEST}/static/running.json", "running autopkgtests")
         if response:
-            show_running(sorted(get_running(response, series=release, ppa=target),
+            show_running(sorted(get_running(response, series=release, ppa=str(ppa)),
                                key=lambda k: str(k.submit_time)))
 
         # Waiting Queue
         response = open_url(f"{URL_AUTOPKGTEST}/queues.json", "waiting autopkgtests")
         if response:
-            show_waiting(get_waiting(response, series=release, ppa=target))
+            show_waiting(get_waiting(response, series=release, ppa=str(ppa)))
 
         return os.EX_OK
     except KeyboardInterrupt:
diff --git a/tests/test_trigger.py b/tests/test_trigger.py
index c6b6a6b..318f034 100644
--- a/tests/test_trigger.py
+++ b/tests/test_trigger.py
@@ -21,35 +21,50 @@ from ppa.trigger import Trigger
 
 def test_object():
     """Checks that Trigger objects can be instantiated."""
-    trigger = Trigger('a', 'b', 'c', 'd')
+    trigger = Trigger('a', 'b', 'c', 'd', 'e')
     assert trigger
 
 
 def test_repr():
     """Checks Trigger object representation."""
-    trigger = Trigger('a', 'b', 'c', 'd')
-    assert repr(trigger) == "Trigger(package='a', version='b', arch='c', series='d')"
+    trigger = Trigger('a', 'b', 'c', 'd', 'e')
+    assert repr(trigger) == "Trigger(package='a', version='b', arch='c', series='d', ppa='e')"
 
 
 def test_str():
     """Checks Trigger object textual presentation."""
-    trigger = Trigger('a', 'b', 'c', 'd')
+    trigger = Trigger('a', 'b', 'c', 'd', 'e')
     assert f"{trigger}" == 'a/b'
 
-    trigger = Trigger('dovecot', '1:2.3.19.1+dfsg1-2ubuntu2', 'i386', 'kinetic')
+    trigger = Trigger('dovecot', '1:2.3.19.1+dfsg1-2ubuntu2', 'i386', 'kinetic', None)
     assert f"{trigger}" == 'dovecot/1:2.3.19.1+dfsg1-2ubuntu2'
 
 
-def test_autopkgtest_url():
-    """Checks that Trigger objects generate valid autopkgtest urls"""
-    trigger = Trigger('a', 'b', 'c', 'd')
+def test_history_url():
+    """Checks that Trigger objects generate valid autopkgtest history urls"""
+    trigger = Trigger('a', 'b', 'c', 'd', 'e')
     expected = "https://autopkgtest.ubuntu.com/packages/a/a/d/c"
-    assert trigger.autopkgtest_url == expected
+    assert trigger.history_url == expected
 
-    trigger = Trigger('apache2', '2.4', 'amd64', 'kinetic')
+    trigger = Trigger('apache2', '2.4', 'amd64', 'kinetic', None)
     expected = "https://autopkgtest.ubuntu.com/packages/a/apache2/kinetic/amd64"
-    assert trigger.autopkgtest_url == expected
+    assert trigger.history_url == expected
 
-    trigger = Trigger('libwebsockets', '4.1.6-3', 'armhf', 'jammy')
+    trigger = Trigger('libwebsockets', '4.1.6-3', 'armhf', 'jammy', None)
     expected = "https://autopkgtest.ubuntu.com/packages/libw/libwebsockets/jammy/armhf"
-    assert trigger.autopkgtest_url == expected
+    assert trigger.history_url == expected
+
+
+def test_action_url():
+    """Checks that Trigger objects generate valid autopkgtest action urls"""
+    trigger = Trigger('a', 'b', 'c', 'd', 'e')
+    expected = "https://autopkgtest.ubuntu.com/request.cgi?release=d&package=a&arch=c&trigger=a/b&ppa=e"
+    assert trigger.action_url == expected
+
+    trigger = Trigger('apache2', '2.4', 'amd64', 'kinetic', None)
+    expected = "https://autopkgtest.ubuntu.com/request.cgi?release=kinetic&package=apache2&arch=amd64&trigger=apache2/2.4"
+    assert trigger.action_url == expected
+
+    trigger = Trigger('libwebsockets', '4.1.6-3', 'armhf', 'jammy', None)
+    expected = "https://autopkgtest.ubuntu.com/request.cgi?release=jammy&package=libwebsockets&arch=armhf&trigger=libwebsockets/4.1.6-3"
+    assert trigger.action_url == expected