-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
86 additions
and
17 deletions.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
--- | ||
menu: | ||
learn: | ||
parent: Workflow | ||
title: Testing Artefacts | ||
weight: 50 | ||
aliases: /requirements/tested/ | ||
--- | ||
|
||
:toc: | ||
|
||
= Testing Artefacts | ||
|
||
In order to be represented in the CI dashboard, testers can create a publically available JSON file (eg. in an AWS bucket) that records the result of the latest test for each combination of pattern, platform, and OpenShift version. | ||
|
||
== File Naming | ||
|
||
`{pattern}-{platform}-{openshift version}-stable-badge.json` | ||
|
||
Example: `medicaldiag-nutanix-4.13-stable-badge.json` | ||
|
||
Note: OpenShift verion should be `major.minor` only | ||
|
||
== File Contents | ||
|
||
[source,json] | ||
---- | ||
{ | ||
"schemaVersion":1, | ||
"label":"{text}", | ||
/* For now we assume `message` is the same as patternBranch */ | ||
"message":"{text}", | ||
/* passed => green, test failed => red, test setup failed => yellow */ | ||
"color":"{test result color}", | ||
/* eg. x.y.z */ | ||
"openshiftVersion":"{full openshift version}", | ||
/* eg. AWS, GCP, Nutanix, ... */ | ||
"infraProvider":"{platform}", | ||
/* Official repo of the pattern, eg. https://github.com/validatedpatterns/multicloud-gitops */ | ||
"patternRepo": "{text}", | ||
/* eg. main, stable-N.M */ | ||
"patternBranch": "{text}", | ||
"date":"{YYYY-MM-DD}", | ||
/* Who ran the test eg. Red Hat */ | ||
"testSource": "{company name}", | ||
/* eg. Job number */ | ||
"testID": "{unique id}", | ||
/* if publically available */ | ||
"jenkinsURL":"{path to job}", | ||
"debugInfo":"{location of must-gather tarball}", | ||
} | ||
---- | ||
|
||
=== Example | ||
|
||
[source,json] | ||
---- | ||
{ | ||
"schemaVersion":1, | ||
"label":"MCG on Nutanix", | ||
"message":"main", | ||
"color":"green", | ||
"openshiftVersion":"4.13.14", | ||
"infraProvider":"Nutanix", | ||
"patternRepo": "https://github.com/validatedpatterns/multicloud-gitops", | ||
"patternBranch": "main", | ||
"date":"2023-10-23", | ||
"testSource": "Red Hat" | ||
"testID": "13602", | ||
"jenkinsURL":"https://jenkins/job/ValidatedPatterns/job/MedicalDiagnosis/job/medicaldiag-gcp-ocp4.13/37/", | ||
"debugInfo":"https://storage.cloud.google.com/.../medicaldiag-gcp-ocp4.13.15-13602.tgz", | ||
} | ||
---- |
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