-
Notifications
You must be signed in to change notification settings - Fork 122
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Save the subresults for tmt-report-result #3200
Draft
seberm
wants to merge
1
commit into
main
Choose a base branch
from
feature/save-subresults
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
#!/bin/bash | ||
# vim: dict+=/usr/share/beakerlib/dictionary.vim cpt=.,w,b,u,t,i,k | ||
. /usr/share/beakerlib/beakerlib.sh || exit 1 | ||
|
||
|
||
rlJournalStart | ||
rlPhaseStartSetup | ||
rlRun "run_dir=\$(mktemp -d)" 0 "Create run directory" | ||
rlRun "pushd subresults" | ||
rlRun "set -o pipefail" | ||
rlPhaseEnd | ||
|
||
rlPhaseStartTest "Test the subresults were generated into results.yaml" | ||
rlRun "tmt run --id $run_dir --scratch -v 2>&1 >/dev/null | tee output" 1 | ||
|
||
# Check the parent test outcomes | ||
rlAssertGrep "fail /test/beakerlib (on default-0)" "output" | ||
rlAssertGrep "fail /test/fail (on default-0)" "output" | ||
rlAssertGrep "pass /test/pass (on default-0)" "output" | ||
rlAssertGrep "total: 1 test passed and 2 tests failed" "output" | ||
|
||
# Check subtests outcomes | ||
|
||
## The internal tests which is checking the TESTID and | ||
## BEAKERLIB_COMMAND_REPORT_RESULT variables must pass | ||
rlAssertGrep "pass /test/beakerlib/Internal-test-of-environment-variable-values" "output" | ||
|
||
rlAssertGrep "pass /test/beakerlib/phase-setup" "output" | ||
rlAssertGrep "pass /test/beakerlib/phase-test-pass" "output" | ||
rlAssertGrep "fail /test/beakerlib/phase-test-fail" "output" | ||
rlAssertGrep "pass /test/beakerlib/phase-cleanup" "output" | ||
|
||
rlAssertGrep "warn /test/fail/subtest/weird" "output" | ||
rlAssertGrep "pass /test/pass/subtest/good2" "output" | ||
|
||
# Check the subresults get correctly saved in results.yaml | ||
rlRun "results_file=${run_dir}/plan/execute/results.yaml" | ||
|
||
rlRun "yq -ey '.[] | select(.name == \"/test/beakerlib\") | .subresult' ${results_file} > subresults_beakerlib.yaml" | ||
rlAssertGrep "name: /test/beakerlib/phase-setup" "subresults_beakerlib.yaml" | ||
rlAssertGrep "name: /test/beakerlib/phase-test-pass" "subresults_beakerlib.yaml" | ||
rlAssertGrep "name: /test/beakerlib/phase-test-fail" "subresults_beakerlib.yaml" | ||
rlAssertGrep "name: /test/beakerlib/phase-cleanup" "subresults_beakerlib.yaml" | ||
|
||
rlRun "yq -ey '.[] | select(.name == \"/test/fail\") | .subresult' ${results_file} > subresults_fail.yaml" | ||
rlAssertGrep "name: /test/fail/subtest/good" "subresults_fail.yaml" | ||
rlAssertGrep "name: /test/fail/subtest/fail" "subresults_fail.yaml" | ||
rlAssertGrep "name: /test/fail/subtest/weird" "subresults_fail.yaml" | ||
|
||
rlRun "yq -ey '.[] | select(.name == \"/test/pass\") | .subresult' ${results_file} > subresults_pass.yaml" | ||
rlAssertGrep "name: /test/pass/subtest/good0" "subresults_pass.yaml" | ||
rlAssertGrep "name: /test/pass/subtest/good1" "subresults_pass.yaml" | ||
rlAssertGrep "name: /test/pass/subtest/good2" "subresults_pass.yaml" | ||
rlPhaseEnd | ||
|
||
rlPhaseStartCleanup | ||
rlRun "rm output" | ||
rlRun "rm subresults_{beakerlib,fail,pass}.yaml" | ||
rlRun "popd" | ||
rlRun "rm -rf $run_dir" 0 "Remove run directory" | ||
rlPhaseEnd | ||
|
||
rlJournalEnd |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
1 |
33 changes: 33 additions & 0 deletions
33
tests/execute/result/subresults/beaker-phases-subresults.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
#!/bin/bash | ||
. /usr/share/beakerlib/beakerlib.sh || exit 1 | ||
|
||
|
||
rlJournalStart | ||
rlPhaseStartSetup "phase-setup" | ||
rlRun "tmp=\$(mktemp -d)" 0 "Create tmp directory" | ||
rlRun "pushd $tmp" | ||
rlRun "set -o pipefail" | ||
rlPhaseEnd | ||
|
||
rlPhaseStartTest "Internal test of environment variable values" | ||
rlRun "test -n \"\$TMT_TEST_SERIAL_NUMBER\" -o -n \"\$TESTID\"" 0 "Check the variables are not empty" | ||
rlAssertEquals "TESTID must be set to TMT_TEST_SERIAL_NUMBER" "$TESTID" "$TMT_TEST_SERIAL_NUMBER" | ||
|
||
rlRun "[[ \$BEAKERLIB_COMMAND_REPORT_RESULT =~ tmt-report-result$ ]]" 0 "Check the variable contains path to a tmt-report-result script" | ||
rlPhaseEnd | ||
|
||
rlPhaseStartTest "phase-test pass" | ||
rlRun "echo mytest-pass | tee output" 0 "Check output" | ||
rlAssertGrep "mytest-pass" "output" | ||
rlPhaseEnd | ||
|
||
rlPhaseStartTest "phase-test fail" | ||
rlRun "echo mytest-fail | tee output" 0 "Check output" | ||
rlAssertGrep "asdf-asdf" "output" | ||
rlPhaseEnd | ||
|
||
rlPhaseStartCleanup "phase-cleanup" | ||
rlRun "popd" | ||
rlRun "rm -r $tmp" 0 "Remove tmp directory" | ||
rlPhaseEnd | ||
rlJournalEnd |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
/plan: | ||
discover: | ||
how: fmf | ||
provision: | ||
how: container | ||
execute: | ||
how: tmt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
/pass: | ||
summary: Basic test of subresults | ||
test: | | ||
tmt-report-result /subtest/good0 PASS | ||
tmt-report-result /subtest/good1 PASS | ||
tmt-report-result /subtest/good2 PASS | ||
|
||
/fail: | ||
summary: Reduced outcome of subresults must be fail | ||
test: | | ||
tmt-report-result /subtest/good PASS | ||
tmt-report-result /subtest/fail FAIL | ||
tmt-report-result /subtest/weird WARN | ||
|
||
/beakerlib: | ||
summary: Beakerlib rlPhaseEnd as tmt subresult | ||
|
||
# Also, explicitly set the framework | ||
framework: beakerlib | ||
|
||
test: ./beaker-phases-subresults.sh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@happz Aren't we missing the
data-path
in theresult
andsubresult
schemas? Otherwise, I'm still getting the "result format violation" errors.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Result schema is definitely missing
data-path
key, subresults shouldn't have one, IIUIC, data path is a path in which tmt stores test data and info and stuff, so there is no dedicated subpath for a subresult.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are you sure about the
data-path
in the subresult? I do not have much insight, but it seems the subresults generated bytmt-report-result
are using this field when thetmt-report-results.yaml
gets created:tmt/tmt/steps/execute/scripts/tmt-report-result
Line 20 in 7b16db6
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmmm, that does not look right.
TMT_TEST_EXE
is${TMT_TREE/tree/execute}
,TMT_TEST_DATA
is said to be "Path to the directory where test can store logs and other artifacts generated during its execution." and I can't imagine that${TMT_TEST_DATA/$TMT_TREE/tree/execute}
could be anything sane.@psss WDYT? There is "test data" for the test,
TMT_TEST_DATA
points to it, but data paths for Beakerlib phases? tmt does not manage those, in custom results we do not even have any idea whether the test used any subresult data paths, so we don't touch them, this seems like a mistake to me.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, do you think we should somehow limit the
data-path
using apattern
in the schema?For a parent result, the value is always a relative path (
data/guest/default-0/tests/example-1/data
). For subresults, thedata-path
seems to always start withpattern: "^/"
- it's not relative, but absolute where root starts at 'execute' directory, e.g./data/guest/default-0/tests/example-1/data
.Isn't it a bug? Also, the subresult's
data-path
seems to be always the same as the parentdata-path
(without/
prefix).