Merge ppa-dev-tools:fix-lp2025484-missing-test-name into ppa-dev-tools:main

[Bryce Harrington]

This adds a fix requested by mwhudson today and bdrung earlier to address a change in autopkgtest log file format that was causing some corruption in results shown by ppa tests.

The fix is pretty trivial but I've taken this opportunity to also implement a corresponding test case with some snippets of example log files.

[Andreas Hasenack (ahasenack)]

review: Needs Information

[Bryce Harrington (bryce)]

Thanks for the quick review, response to the question below:

[Andreas Hasenack (ahasenack)]

review: Approve

[Bryce Harrington (bryce)]

Thanks Andreas, I decided you were right, and incorporated your suggestion and landed the branch:

stirling: ~/src/PpaDevTools/ppa-dev-tools-bugfix$ git merge --ff-only fix-lp2025484-missing-test-name
Updating 7bef7a0..c56a856
Fast-forward
 ppa/result.py | 3 +++
 tests/test_result.py | 80 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 83 insertions(+)
stirling: ~/src/PpaDevTools/ppa-dev-tools-bugfix$ git push
Total 0 (delta 0), reused 0 (delta 0), pack-reused 0
To git+ssh://git.launchpad.net/ppa-dev-tools
   7bef7a0..c56a856 main -> main

diff --git a/ppa/result.py b/ppa/result.py
index e33c61c..fe47621 100755
--- a/ppa/result.py
+++ b/ppa/result.py
@@ -181,6 +181,9 @@ class Result:
         subtests = []
         result_sum = result_split[1]
         for line in re.findall("(.*PASS|.*SKIP|.*FAIL|.*BAD)", result_sum):
+            if re.match(r"^[0-9]+s\s", line):
+                # Newer autopkgtest logs are prefixed with the timestamp.  Ignore it.
+                line = line.split(' ', 1)[1]
             if name and not line.startswith(name):
                 continue
             subtests.append(Subtest(line))
diff --git a/tests/test_result.py b/tests/test_result.py
index 33748c1..4063b83 100644
--- a/tests/test_result.py
+++ b/tests/test_result.py
@@ -69,6 +69,86 @@ def test_triggers():
     assert result.triggers == ['pygobject/3.42.2-2', 'six/1.16.0-4']
 
 
[e-mail]('log_text, subtest_name, expected', [
+    ('', None, {}),
+    (
+        (
+            "x: @@@@@@@@@@@@@@@@@@@@ summary\n"
+            "test-a          PASS\n"
+            "test-b          FAIL ignorable-note\n"
+            "test-c          NoTaVaLiDsTaTuS\n"
+        ),
+        None,
+        {'test-a': 'PASS', 'test-b': 'FAIL'}
+    ),
+    (
+        (
+            "autopkgtest [21:13:56]: starting date: 2022-11-18\n"
+            "The following packages have unmet dependencies:\n"
+            " builddeps:.../12-autopkgtest-satdep.dsc:i386 : Depends: gcc:i386 but it is not installable\n"
+            "E: Unable to correct problems, you have held broken packages.\n"
+            "chroot               FAIL badpkg\n"
+            "blame: apache2\n"
+            "badpkg: Test dependencies are unsatisfiable. A common reason is ...\n"
+            "autopkgtest [21:48:03]: @@@@@@@@@@@@@@@@@@@@ summary\n"
+            "run-test-suite       FAIL badpkg\n"
+            "blame: apache2\n"
+            "badpkg: Test dependencies are unsatisfiable. A common reason is...\n"
+            "duplicate-module-load PASS\n"
+            "default-mods         PASS\n"
+            "run-htcacheclean     PASS\n"
+            "ssl-passphrase       PASS\n"
+            "check-http2          PASS\n"
+            "run-chroot           FAIL badpkg\n"
+            "blame: apache2\n"
+        ),
+        'run-',
+        {
+            'run-test-suite': 'FAIL',
+            'run-htcacheclean': 'PASS',
+            'run-chroot': 'FAIL',
+        }
+    ),
+    (
+        (
+            "3657s rm: cannot remove '.../mountpoint': Device or resource busy\n"
+            "3661s autopkgtest [03:41:43]: test minimized: -----------------------]\n"
+            "3663s autopkgtest [03:41:45]: test minimized:  - - - - - - - - - - results - - - - - - - - - -\n"
+            "3663s minimized            FAIL non-zero exit status 1\n"
+            "3663s autopkgtest [03:41:45]: test minimized:  - - - - - - - - - - stderr - - - - - - - - - -\n"
+            "3663s rm: cannot remove '.../mountpoint': Device or resource busy\n"
+            "3664s autopkgtest [03:41:46]: @@@@@@@@@@@@@@@@@@@@ summary\n"
+            "3664s default-bootstraps   FAIL non-zero exit status 1\n"
+            "3664s minimized            FAIL non-zero exit status 1'\n"
+        ),
+        None,
+        {
+            'default-bootstraps': 'FAIL',
+            'minimized': 'FAIL'
+        }
+    ),
+])
+def test_get_subtests(tmp_path, log_text: str, subtest_name: str, expected: dict[str]):
+    """Checks retrieval of Subtest objects from autopkgtest results.
+
+    This test exercises the parser that extracts subtest information out
+    of autopkgtest logs of various formats.  It also verifies the
+    parameter to get_subtests() is handled correctly.
+
+    :param fixture tmp_path: Temp dir.
+    :param str log_text: Text to write into the log file.
+    :param str subtest_name: Only retrieve subtests starting with this text.
+    :param dict[str] expected: Dictionary of subtest names to pass/fail status.
+    """
+    f = tmp_path / "result.log.gz"
+    compressed_text = gzip.compress(bytes(log_text, 'utf-8'))
+    f.write_bytes(compressed_text)
+
+    result = Result(f"file://{f}", None, None, None, None)
+    subtests = result.get_subtests(subtest_name)
+    assert {s.desc: s.status for s in subtests} == expected
+
+
 @pytest.mark.parametrize('log_text, series, arch, source, expected_dict', [
     ('x', 'x', 'x', 'x', {})
 ])