Skip to content

Commit cb5693a

Browse files
committed
docs(STONEINTG-900): Document the standardized test result outputs for end users
Signed-off-by: Jiri Sztuka <[email protected]>
1 parent ceb04b9 commit cb5693a

File tree

4 files changed

+37
-0
lines changed

4 files changed

+37
-0
lines changed
6.95 KB
Loading

modules/testing/nav.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
**** xref:integration/choosing-contexts.adoc[Choosing when to run certain Integration Tests]
1111
**** xref:integration/accessing-private-repositories.adoc[Accessing Pipelines and Tasks in Private Repositories]
1212
**** xref:integration/periodic-integration-tests.adoc[Triggering Periodic Integration Tests]
13+
**** xref:integration/standardized-outputs.adoc[Standardized outputs]
1314
**** Snapshots
1415
***** xref:integration/snapshots/working-with-snapshots.adoc[Working with Snapshots]
1516
***** xref:integration/snapshots/override-snapshots.adoc[Creating an override snapshot]

modules/testing/pages/integration/creating.adoc

+13
Original file line numberDiff line numberDiff line change
@@ -219,3 +219,16 @@ When the new build is finished, complete the following steps in the {ProductName
219219
. On the *Details* page, see if the test succeeded for that component. Select the other tabs to view more details.
220220

221221
.. If you used our example script, switch to the *Logs* tab and verify that the test printed “Hello world!”.
222+
223+
== Standardized test result
224+
225+
In examples above, you can see TEST_OUTPUT result being used as standardized output. This is a tekton result test outcome in json format.
226+
TEST_OUTPUT example:
227+
----
228+
{"result":"SUCCESS","timestamp":"2025-04-02T01:45:00+00:00","note":"Task clair-scan completed: Refer to Tekton task result SCAN_OUTPUT for vulnerabilities scanned by Clair.","namespace":"default","successes":1,"failures":0,"warnings":0}
229+
----
230+
231+
For more information about standardized tekton results in konflux, please visit
232+
link: https://konflux-ci.dev/architecture/ADR/0030-tekton-results-naming-convention.html[Tekton Results Naming Convention]
233+
or
234+
xref:testing:integration/standardized-outputs.adoc[Standardized outputs]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
= Standardized outputs
2+
3+
Konflux is using standardized outputs in various places, this part of docs will provide more detail information about it.
4+
Each one of the results described below is rendered in the UI, you simply click on task name and panel with details is showed
5+
containing all results from the task.
6+
7+
== TEST_OUTPUT
8+
9+
Each tekton task in build pipelinerun provides TEST_OUTPUT result [json] that sumarizes its outcome. It's then being evaluated by Conforma team whether the product can be released or not.
10+
11+
This result type can be also used in integration test pipelines and tasks where it can be parsed by the integration service when deciding the outcome of the integration test. This means you can use it to fail individual test tasks by emitting this result instead of failing the task and stopping the entire pipeline. With this approach it is possible to run multiple tests within the same pipeline and pass or fail them individually.
12+
13+
== SCAN_OUTPUT
14+
15+
This one is located within build definition task clair scan. SCAN_OUTPUT result[json] is displayed in different manner than TEST_OUTPUT, but it serves the same purpose.
16+
It additionaly displays found vulnerabilities, patched(RHSA fix) and unpatched ones.
17+
18+
image::vulnerabilities.png[role="border" alt="Vulnerabilities"]
19+
20+
== IMAGES_PROCESSED
21+
22+
Result[json] for multiple images (i.e. multi-arch images), primary function to disambiguate the image references corresponding to the other Tekton results.
23+

0 commit comments

Comments
 (0)