Skip to content

Commit 007d40e

Browse files
committed
Change note-quotes to admonitions
1 parent 1cb549b commit 007d40e

File tree

1 file changed

+29
-21
lines changed

1 file changed

+29
-21
lines changed

contributor-docs/development/tests/conformance-tests-sonobuoy.md

Lines changed: 29 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,19 @@ Hence this reduces the effort required to establish SCS conformity to a minimum.
66

77
In short this is achieved by storing all tests in a container image, which can then be called and launched on the clusters managed by sonoobuoy.
88

9-
> [!NOTE]
10-
> A more detailed description of why the SCS has decided to use sonobuoys can be found on the corresponding [Decsision Record][sonbouy-decision-record].
11-
> In addition, sonobuoy is also used as the toolset for executing Kubernetes very own [conformance tests][k8s-conformance].
9+
:::note
10+
A more detailed description of why the SCS has decided to use sonobuoys can be found on the corresponding [Decsision Record][sonbouy-decision-record].
11+
In addition, sonobuoy is also used as the toolset for executing Kubernetes very own [conformance tests][k8s-conformance].
12+
:::
1213

1314
This document is intended to assist conformance test authors to integrate their tests into the sonobuoy framework.
1415
This requires a user to write the conformance tests in Golang, as this is the language provided by the framework itself.
1516

1617
## Step-by-step instructions for the development of sonobuoy tests using `docker` and `kind`
1718

18-
> [!NOTE]
19-
> This guide refers to the brief instructions provided in the [standards repository][scs-sonobuoy-example-guide]
19+
:::note
20+
This guide refers to the brief instructions provided in the [standards repository][scs-sonobuoy-example-guide]
21+
:::
2022

2123
### Prerequisite
2224

@@ -70,9 +72,11 @@ In general, SCS tests for KaaS are derived from standards that define certain ex
7072
As an example for this step-by-step guide, let's assume a scenario in which there is a fictional standard called "scs-0299-v1-example-standard.md".
7173
Pretend that the fictitious standard here stipulates that at least one pod MUST run in the namespace "namespace-test-a".
7274

73-
> [!NOTE]
74-
> The functions and behaviors to be tested MUST be precisely defined in a standard.
75-
> If you as a developer want to test something that you think is best tested but is not yet part of any standard, you MUST update the standard accordingly.
75+
:::note
76+
The functions and behaviors to be tested MUST be precisely defined in a standard.
77+
If you as a developer want to test something that you think is best tested but is not yet part of any standard, you MUST update the standard accordingly.
78+
:::
79+
7680

7781
#### 1. Create example test
7882

@@ -87,9 +91,10 @@ First create a test file according to your standard and adhere to the naming con
8791
* The prefix MUST contain the name of the standard in lower case letters.
8892
* As a suffix, the file must end with "_test.go".
8993

90-
> [!NOTE]
91-
> The suffix requirement comes from the go test framework itself. All test files must end with `_test.go`.
92-
> Otherwise they will not be selected by the test environment.
94+
:::note
95+
The suffix requirement comes from the go test framework itself. All test files must end with `_test.go`.
96+
Otherwise they will not be selected by the test environment.
97+
:::
9398

9499
As an example, we will create a file for the fictitious standard "scs-0299-v1-example-standard.md" as follows:
95100

@@ -102,11 +107,12 @@ As an example, we test here whether there are more than zero pods in the namespa
102107
The execution of this test should fail by default as there should be no pods in the namespace and the namespace itself should not exist.
103108
The aim is to display the results of a failed test so that we can show their interpretation in a later step.
104109

105-
> [!NOTE]
106-
> Attention!!!: in order for the framework to select the functions for testing, their names must begin with "TEST_" in accordance with the naming convention of the golang test framework.
107-
> The framework in use is [kubernetes-sigs/e2e-framework][e2e-framework].
108-
> They also provide examples. Before you start implementing your own tests, you should check whether you can use one of the examples as a starting point for your own implementation.
109-
> Have a look at: [kubernetes-sigs/e2e-framework/examples][e2e-framework-examples]
110+
:::danger
111+
In order for the framework to select the functions for testing, their names must begin with "TEST_" in accordance with the naming convention of the golang test framework.
112+
The framework in use is [kubernetes-sigs/e2e-framework][e2e-framework].
113+
They also provide examples. Before you start implementing your own tests, you should check whether you can use one of the examples as a starting point for your own implementation.
114+
Have a look at: [kubernetes-sigs/e2e-framework/examples][e2e-framework-examples]
115+
:::
110116

111117
As an example of this step-by-step guide, copy the following text into the file `scs_0299_v1_example_standard_test.go`:
112118

@@ -183,8 +189,9 @@ cat results/plugins/scsconformance/sonobuoy_results.yaml | yq
183189
Once all tests have been executed successfully, you can read the results and receive feedback.
184190
You can call up the results as follows:
185191

186-
> [!NOTE]
187-
> TODO:!!! to be described in more detail
192+
:::todo
193+
to be described in more detail
194+
:::
188195

189196
### Clean up after
190197

@@ -195,7 +202,7 @@ make dev-clean
195202
make dev-purge
196203
```
197204

198-
### (optional) Run all at once:
205+
### (optional) Run all at once
199206

200207
In addition, you can trigger all processes from above with one command. There is a single target in the Makefile for this:
201208

@@ -213,8 +220,9 @@ export TESTFUNCTION_CODE="0299"
213220
make test-function
214221
```
215222

216-
> [!NOTE]
217-
> [e2e-framework-examples]
223+
:::note
224+
See also [e2e-framework-examples]
225+
:::
218226

219227
[sonobuoy]: https://sonobuoy.io/
220228
[sonbouy-decision-record]: https://github.com/SovereignCloudStack/standards/blob/main/Standards/scs-0200-v1-using-sonobuoy-for-kaas-conformance-tests.md

0 commit comments

Comments
 (0)