Merge ppa-dev-tools:command-tests into ppa-dev-tools:main

[Bryce Harrington]

Adds the command 'ppa tests' which for now just reports the running and waiting tests. (Later, Results will be added as well.)

Since running and waiting info is only available while a PPA's tests are in process, to check the functionality you'll need to queue up some fresh tests for your favorite PPA; e.g.:

    $ lp-test-ppa ppa:bryce/dovecot-merge-v1e2.3.19.1adfsg1-2 -r kinetic --showurl

Trigger several, then wait a few minutes and they should start appearing in output:

    $ ./scripts/ppa tests ppa:bryce/dovecot-merge-v1e2.3.19.1adfsg1-2
Running:
    time pkg release arch ppa trigger
    10 dovecot kinetic armhf bryce/dovecot-merge-v1e2.3.19.1adfsg1-2 dovecot/1:2.3.19.1+dfsg1-2ubuntu2~kinetic1
    120 dovecot kinetic armhf bryce/dovecot-merge-v1e2.3.19.1adfsg1-2 dovecot/1:2.3.19.1+dfsg1-2ubuntu2~kinetic1
    270 dovecot kinetic amd64 bryce/dovecot-merge-v1e2.3.19.1adfsg1-2 dovecot/1:2.3.19.1+dfsg1-2ubuntu2~kinetic1
    30 dovecot kinetic arm64 bryce/dovecot-merge-v1e2.3.19.1adfsg1-2 dovecot/1:2.3.19.1+dfsg1-2ubuntu2~kinetic1
    30 dovecot kinetic ppc64el bryce/dovecot-merge-v1e2.3.19.1adfsg1-2 dovecot/1:2.3.19.1+dfsg1-2ubuntu2~kinetic1
Waiting:
    Q-num pkg release arch ppa trigger
    1 dovecot kinetic s390x bryce/dovecot-merge-v1e2.3.19.1adfsg1-2 dovecot/1:2.3.19.1+dfsg1-2ubuntu2~kinetic1
    1 dovecot kinetic armhf bryce/dovecot-merge-v1e2.3.19.1adfsg1-2 dovecot/1:2.3.19.1+dfsg1-2ubuntu2~kinetic1
    1 dovecot kinetic amd64 bryce/dovecot-merge-v1e2.3.19.1adfsg1-2 dovecot/1:2.3.19.1+dfsg1-2ubuntu2~kinetic1

[Athos Ribeiro (athos-ribeiro)]

LGTM! Thanks, Bryce.

I included a couple inline nitpicks. As usual, feel free to ignore some or all of them. This looks good as is :)

review: Approve

[Bryce Harrington (bryce)]

Thanks for the review. Updated, merged and landed:

$ git push origin main
Total 0 (delta 0), reused 0 (delta 0)
To git+ssh://git.launchpad.net/ppa-dev-tools
   8fcdc4f..84609b3 main -> main

diff --git a/AUTHORS.md b/AUTHORS.md
index 9712ae3..6138e91 100644
--- a/AUTHORS.md
+++ b/AUTHORS.md
@@ -1 +1,2 @@
 Bryce Harrington <[e-mail]>
+Athos Ribeiro <[e-mail]>
diff --git a/ppa/constants.py b/ppa/constants.py
new file mode 100644
index 0000000..f6e7b01
--- /dev/null
+++ b/ppa/constants.py
@@ -0,0 +1,20 @@
+#!/usr/bin/env python3
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+
+# Copyright (C) 2022 Authors
+#
+# Released under GNU GPLv2 or later, read the file 'LICENSE.GPLv2+' for
+# more information.
+#
+# Authors:
+#   Bryce Harrington <[e-mail]>
+
+"""Global constants"""
+
+ARCHES_ALL = ["amd64", "arm64", "armhf", "armel", "i386", "powerpc", "ppc64el", "s390x", "riscv64"]
+ARCHES_PPA = ["amd64", "arm64", "armhf", "i386", "powerpc", "ppc64el", "s390x"]
+ARCHES_PPA_EXTRA = ["riscv64"]
+ARCHES_AUTOPKGTEST = ["amd64", "arm64", "armhf", "i386", "ppc64el", "s390x"]
+
+URL_LPAPI = "https://api.launchpad.net/devel"
+URL_AUTOPKGTEST = "https://autopkgtest.ubuntu.com"
diff --git a/ppa/io.py b/ppa/io.py
new file mode 100644
index 0000000..bef1fa0
--- /dev/null
+++ b/ppa/io.py
@@ -0,0 +1,33 @@
+#!/usr/bin/env python3
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+
+# Copyright (C) 2022 Authors
+#
+# Released under GNU GPLv2 or later, read the file 'LICENSE.GPLv2+' for
+# more information.
+#
+# Authors:
+#   Bryce Harrington <[e-mail]>
+
+"""Utilities for reading input and writing output to external locations."""
+
+import sys
+import urllib.request
+
+
+def open_url(url, desc="data"):
+    """Opens a remote URL for reading.
+
+    :rtype: urllib.request.Request
+    :returns: A request object for the stream to read from, or None on error.
+    """
+    request = urllib.request.Request(url)
+    request.add_header('Cache-Control', 'max-age=0')
+    try:
+        return urllib.request.urlopen(request)
+    except urllib.error.HTTPError as e:
+        # 401 here means nothing is published or ran yet.
+        # This is a rather common case, so skip mention of it
+        if e.code != 401:
+            sys.stderr.write(f"Error: Could not retrieve {desc} from {url}: {e}")
+        return None
diff --git a/ppa/job.py b/ppa/job.py
index 61d6fb2..2ae06ba 100755
--- a/ppa/job.py
+++ b/ppa/job.py
@@ -14,10 +14,7 @@
 from typing import Iterator
 import json
 
-# Global constants
-ARCHES = ["amd64", "s390x", "ppc64el", "arm64", "armhf", "riscv64"]
-URL_LPAPI = "https://api.launchpad.net/devel"
-URL_AUTOPKGTEST = "https://autopkgtest.ubuntu.com"
+from .constants import URL_AUTOPKGTEST
 
 
 class Job:
@@ -142,6 +139,36 @@ def get_waiting(response, series=None, ppa=None) -> Iterator[Job]:
                     yield job
 
 
+def show_running(jobs):
+    """Prints the active (running and waiting) tests"""
+    rformat = "    %-8s %-40s %-8s %-8s %-40s %s"
+
+    n = 0
+    for n, e in enumerate(jobs, start=1):
+        if n == 1:
+            print("Running:")
+            ppa_str = ','.join(e.ppas)
+            trigger_str = ','.join(e.triggers)
+            print(rformat % ("time", "pkg", "release", "arch", "ppa", "trigger"))
+        print(rformat % (str(e.submit_time), e.source_package, e.series, e.arch, ppa_str, trigger_str))
+    if n == 0:
+        print("Running: (none)")
+
+
+def show_waiting(jobs):
+    """Prints the active (running and waiting) tests"""
+    rformat = "    %-8s %-40s %-8s %-8s %-40s %s"
+
+    n = 0
+    for n, e in enumerate(jobs, start=1):
+        if n == 1:
+            print("Waiting:")
+            print(rformat % ("Q-num", "pkg", "release", "arch", "ppa", "trigger"))
+        print(rformat % (e.number, e.source_package, e.series, e.arch, ','.join(e.ppas), ','.join(e.triggers)))
+    if n == 0:
+        print("Waiting: (none)")
+
+
 if __name__ == "__main__":
     import os
     from urllib.request import urlopen
@@ -180,4 +207,3 @@ if __name__ == "__main__":
     response = urlopen(f"file://{root_dir}/tests/data/queues-20220822.json")
     for job in get_waiting(response, 'kinetic', ppa):
         print(job)
-
diff --git a/ppa/ppa.py b/ppa/ppa.py
index 62e0d58..0b90fd6 100755
--- a/ppa/ppa.py
+++ b/ppa/ppa.py
@@ -12,6 +12,8 @@ from textwrap import indent
 from functools import lru_cache
 from lazr.restfulclient.errors import BadRequest, NotFound
 
+from .constants import ARCHES_PPA
+
 def ppa_address_split(ppa_address, default_team='me'):
     """Parse an address for a ppa into its team and name components
     """
@@ -52,8 +54,6 @@ class Ppa:
     This object proxies a PPA, allowing lazy initialization and caching
     of data from the remote.
     """
-    # TODO: May need to load this from a (cached?) query
-    ALL_ARCHITECTURES = [ 'amd64', 'arm64', 'armel', 'armhf', 'i386', 'powerpc', 'ppc64el', 's390x']
     def __init__(self, ppa_name, team_name, ppa_description=None, service=None):
         """Initializes a new Ppa object for a given PPA
 
@@ -145,7 +145,7 @@ class Ppa:
     def architectures(self):
         return [ proc.name for proc in self.archive.processors ]
 
-    def set_architectures(self, architectures=ALL_ARCHITECTURES):
+    def set_architectures(self, architectures=ARCHES_PPA):
         assert self._service
         uri_base = "https://api.launchpad.net/devel/+processors/{}"
         procs = [ uri_base.format(arch) for arch in architectures ]
diff --git a/scripts/ppa b/scripts/ppa
index 1697999..56ff827 100755
--- a/scripts/ppa
+++ b/scripts/ppa
@@ -62,6 +62,15 @@ if '__file__' in globals():
         os.path.join(os.path.dirname(os.path.realpath(__file__)), "..")))
 
 from ppa._version import __version__
+from ppa.constants import URL_AUTOPKGTEST
+from ppa.io import open_url
+from ppa.job import (
+    Job,
+    get_waiting,
+    show_waiting,
+    get_running,
+    show_running
+)
 from ppa.lp import Lp
 from ppa.ppa import Ppa
 from ppa.ppa_group import PpaGroup, PpaAlreadyExists
@@ -440,6 +449,40 @@ def command_wait(lp, config):
     return 1
 
 
+def command_tests(lp, config):
+    """Displays testing status for the PPA.
+
+    :param Lp lp: The Launchpad wrapper object.
+    :param dict config: Configuration param:value map.
+    :rtype: Int
+    :returns: Status code 0 on success, non-zero on error.
+    """
+    if not lp:
+        return 1
+
+    try:
+        ppa = get_ppa(lp, config)
+        target = "%s/%s" % (ppa.team_name, ppa.name)
+        release = 'kinetic'
+
+        # 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),
+                               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))
+
+        return 0
+    except KeyboardInterrupt:
+        return 2
+    print("Unhandled error")
+    return 1
+
+
 COMMANDS = {
     'create':     (command_create, None),
     'desc':       (command_desc, None),
@@ -447,6 +490,7 @@ COMMANDS = {
     'list':       (command_list, None),
     'show':       (command_show, None),
     'status':     (command_status, None),
+    'tests':      (command_tests, None),
     'wait':       (command_wait, None),
     }
 
diff --git a/tests/test_io.py b/tests/test_io.py
new file mode 100644
index 0000000..fce6611
--- /dev/null
+++ b/tests/test_io.py
@@ -0,0 +1,32 @@
+#!/usr/bin/env python3
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+
+# Author:  Bryce Harrington <[e-mail]>
+#
+# Copyright (C) 2022 Bryce W. Harrington
+#
+# Released under GNU GPLv2 or later, read the file 'LICENSE.GPLv2+' for
+# more information.
+
+"""Tests for utilities used to read and write data externally."""
+
+import os
+import sys
+import urllib
+import pytest
+
+sys.path.insert(0, os.path.realpath(
+        os.path.join(os.path.dirname(__file__), "..")))
+
+from ppa.io import open_url
+
+
+def test_open_url(tmp_path):
+    """Checks that the open_url() object reads from a valid URL."""
+    f = tmp_path / "open_url.txt"
+    f.write_text("abcde")
+
+    request = open_url(f"file://{f}")
+    assert request
+    assert type(request) == urllib.response.addinfourl
+    assert request.read().decode() == 'abcde'