Add subresults support for reportportal report plugin

docs/releases.rst

@@ -4,6 +4,13 @@
     Releases
 ======================
 
+
+A new ``upload-subresults`` key has been introduced for the
+:ref:`/plugins/report/reportportal` plugin, allowing the import of
+tmt subresults as child test items into ReportPortal. This
+behavior is optional and is disabled by default.
+
+
 tmt-1.42.0
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

tests/report/reportportal/data/beaker-phases-subresults.sh

@@ -0,0 +1,41 @@
+#!/bin/bash
+. /usr/share/beakerlib/beakerlib.sh || exit 1
+
+
+rlJournalStart
+    rlPhaseStartSetup "phase-setup"
+        rlRun "tmp=\$(mktemp -d)" 0 "Create tmp directory"
+        rlRun "pushd $tmp"
+    rlPhaseEnd
+
+    rlPhaseStartTest "phase-test pass"
+        rlRun -s "echo mytest-pass" 0 "Check output"
+        rlAssertGrep "mytest-pass" "$rlRun_LOG"
+    rlPhaseEnd
+
+    rlPhaseStartTest "phase-test fail"
+        rlRun -s "echo mytest-fail" 0 "Check output"
+        rlAssertGrep "this-will-intentionally-fail" "$rlRun_LOG"
+    rlPhaseEnd
+
+    rlPhaseStartTest "phase-test multiple tmt-report-result"
+        rlRun "echo bkr_good_log > bkr_good.log"
+        rlRun "echo bkr_bad_log > bkr_bad.log"
+        rlRun "echo bkr_weird_log > bkr_weird.log"
+        rlRun "echo bkr_skip_log > bkr_skip.log"
+        rlRun "echo bkr_good_rhts_log > bkr_good_rhts.log"
+
+        # This will create more subresults for each
+        # tmt-report-result/rhts-report-result call
+        rlRun "tmt-report-result -o bkr_good.log extra-tmt-report-result/good PASS"
+        rlRun "tmt-report-result -o bkr_bad.log extra-tmt-report-result/bad FAIL"
+        rlRun "tmt-report-result -o bkr_weird.log extra-tmt-report-result/weird WARN"
+        rlRun "tmt-report-result -o bkr_skip.log extra-tmt-report-result/skip SKIP"
+        rlRun "rhts-report-result extra-rhts-report-result/good PASS bkr_good_rhts.log"
+    rlPhaseEnd
+
+    rlPhaseStartCleanup "phase-cleanup"
+        rlRun "popd"
+        rlRun "rm -r $tmp" 0 "Remove tmp directory"
+    rlPhaseEnd
+rlJournalEnd

tests/report/reportportal/data/plan.fmf

@@ -3,12 +3,13 @@ summary: Testing the integration of tmt and Report Portal via its API
 discover:
     how: fmf
 provision:
-    how: local
+    how: container
 execute:
     how: tmt
 report:
     how: reportportal
     project: test_tmt
+    upload-subresults: true
 
 context:
     component: tmt

tests/report/reportportal/data/test.fmf

@@ -14,3 +14,23 @@
 /weird:
     summary: An error encountered
     test: this-is-a-weird-command
+
+/subresults:
+    summary: Test the tmt subresults (ReportPortal child items)
+    test: |
+        tmt-report-result /subtest/good PASS
+        tmt-report-result /subtest/fail FAIL
+        tmt-report-result /subtest/weird WARN
+
+/subresults-restraint:
+    result: restraint
+    test: |
+        tmt-report-result /subtest-restraint/good PASS
+        tmt-report-result /subtest-restraint/fail FAIL
+        tmt-report-result /subtest-restraint/weird WARN
+
+# TODO: Enable test of subresults for beakerlib phases
+#/subresults-beakerlib:
+#    summary: Test the Beakerlib phases are propagated as tmt subresults
+#    framework: beakerlib
+#    test: ./beaker-phases-subresults.sh

tmt/result.py

@@ -248,6 +248,11 @@ class SubResult(BaseResult):
             SubCheckResult.from_serialized(check) for check in serialized]
         )
 
+    @staticmethod
+    def failures(log: Optional[str], msg_type: str = 'FAIL') -> str:
+        """ Filter stdout and get only messages with certain type """
+        return Result.failures(log, msg_type)
+
 
 @dataclasses.dataclass
 class PhaseResult(BaseResult):

tmt/schemas/report/reportportal.yaml

@@ -77,6 +77,9 @@ properties:
   ssl-verify:
     type: boolean
 
+  upload-subresults:
+    type: boolean
+
   when:
     $ref: "/schemas/common#/definitions/when"