chore: improve api file references (#62)

Signed-off-by: Charles-Edouard Brétéché <[email protected]>
kyverno · Oct 14, 2023 · 275e69c · 275e69c
1 parent 9d01599
commit 275e69c
Show file tree

Hide file tree

Showing 18 changed files with 186 additions and 118 deletions.
diff --git a/config/crds/chainsaw.kyverno.io_tests.yaml b/config/crds/chainsaw.kyverno.io_tests.yaml
@@ -40,30 +40,32 @@ spec:
                   properties:
                     apply:
                       items:
+                        description: Apply represents a manifest to be applied.
                         properties:
                           file:
-                            description: File containing the manifest to be applied.
+                            description: File is the path to the referenced file.
                             type: string
                         required:
                         - file
                         type: object
                       type: array
                     assert:
                       items:
+                        description: Error represents an assertion expected to succeed.
                         properties:
                           file:
-                            description: File containing the assertion manifest.
+                            description: File is the path to the referenced file.
                             type: string
                         required:
                         - file
                         type: object
                       type: array
                     error:
                       items:
+                        description: Error represents an error condition.
                         properties:
                           file:
-                            description: File containing the assertion manifest. It
-                              is expected that the assertion fails.
+                            description: File is the path to the referenced file.
                             type: string
                         required:
                         - file

diff --git a/config/crds/chainsaw.kyverno.io_teststeps.yaml b/config/crds/chainsaw.kyverno.io_teststeps.yaml
@@ -37,30 +37,32 @@ spec:
             properties:
               apply:
                 items:
+                  description: Apply represents a manifest to be applied.
                   properties:
                     file:
-                      description: File containing the manifest to be applied.
+                      description: File is the path to the referenced file.
                       type: string
                   required:
                   - file
                   type: object
                 type: array
               assert:
                 items:
+                  description: Error represents an assertion expected to succeed.
                   properties:
                     file:
-                      description: File containing the assertion manifest.
+                      description: File is the path to the referenced file.
                       type: string
                   required:
                   - file
                   type: object
                 type: array
               error:
                 items:
+                  description: Error represents an error condition.
                   properties:
                     file:
-                      description: File containing the assertion manifest. It is expected
-                        that the assertion fails.
+                      description: File is the path to the referenced file.
                       type: string
                   required:
                   - file

diff --git a/pkg/apis/v1alpha1/apply.go b/pkg/apis/v1alpha1/apply.go
@@ -1,6 +1,7 @@
 package v1alpha1
 
+// Apply represents a manifest to be applied.
 type Apply struct {
-	// File containing the manifest to be applied.
-	File string `json:"file"`
+	// Manifest to be applied.
+	FileRef `json:",inline"`
 }
diff --git a/pkg/apis/v1alpha1/assert.go b/pkg/apis/v1alpha1/assert.go
@@ -1,6 +1,7 @@
 package v1alpha1
 
+// Error represents an assertion expected to succeed.
 type Assert struct {
-	// File containing the assertion manifest.
-	File string `json:"file"`
+	// Assertion manifest.
+	FileRef `json:",inline"`
 }
diff --git a/pkg/apis/v1alpha1/error.go b/pkg/apis/v1alpha1/error.go
@@ -1,7 +1,7 @@
 package v1alpha1
 
+// Error represents an error condition.
 type Error struct {
-	// File containing the assertion manifest.
-	// It is expected that the assertion fails.
-	File string `json:"file"`
+	// Error manifest.
+	FileRef `json:",inline"`
 }
diff --git a/pkg/apis/v1alpha1/file_ref.go b/pkg/apis/v1alpha1/file_ref.go
@@ -0,0 +1,7 @@
+package v1alpha1
+
+// FileRef represents a file reference.
+type FileRef struct {
+	// File is the path to the referenced file.
+	File string `json:"file"`
+}
diff --git a/pkg/apis/v1alpha1/zz_generated.deepcopy.go b/pkg/apis/v1alpha1/zz_generated.deepcopy.go
diff --git a/pkg/data/crds/chainsaw.kyverno.io_tests.yaml b/pkg/data/crds/chainsaw.kyverno.io_tests.yaml
@@ -40,30 +40,32 @@ spec:
                   properties:
                     apply:
                       items:
+                        description: Apply represents a manifest to be applied.
                         properties:
                           file:
-                            description: File containing the manifest to be applied.
+                            description: File is the path to the referenced file.
                             type: string
                         required:
                         - file
                         type: object
                       type: array
                     assert:
                       items:
+                        description: Error represents an assertion expected to succeed.
                         properties:
                           file:
-                            description: File containing the assertion manifest.
+                            description: File is the path to the referenced file.
                             type: string
                         required:
                         - file
                         type: object
                       type: array
                     error:
                       items:
+                        description: Error represents an error condition.
                         properties:
                           file:
-                            description: File containing the assertion manifest. It
-                              is expected that the assertion fails.
+                            description: File is the path to the referenced file.
                             type: string
                         required:
                         - file

diff --git a/pkg/data/crds/chainsaw.kyverno.io_teststeps.yaml b/pkg/data/crds/chainsaw.kyverno.io_teststeps.yaml
@@ -37,30 +37,32 @@ spec:
             properties:
               apply:
                 items:
+                  description: Apply represents a manifest to be applied.
                   properties:
                     file:
-                      description: File containing the manifest to be applied.
+                      description: File is the path to the referenced file.
                       type: string
                   required:
                   - file
                   type: object
                 type: array
               assert:
                 items:
+                  description: Error represents an assertion expected to succeed.
                   properties:
                     file:
-                      description: File containing the assertion manifest.
+                      description: File is the path to the referenced file.
                       type: string
                   required:
                   - file
                   type: object
                 type: array
               error:
                 items:
+                  description: Error represents an error condition.
                   properties:
                     file:
-                      description: File containing the assertion manifest. It is expected
-                        that the assertion fails.
+                      description: File is the path to the referenced file.
                       type: string
                   required:
                   - file

diff --git a/pkg/discovery/discovery_test.go b/pkg/discovery/discovery_test.go
@@ -16,11 +16,11 @@ func TestDiscoverTests(t *testing.T) {
 		want     []Test
 		wantErr  bool
 	}{{
-		name:     "ok",
+		name:     "quick start",
 		fileName: "chainsaw-test.yaml",
-		paths:    []string{"../../testdata/tests"},
+		paths:    []string{"../../testdata/tests/quick-start"},
 		want: []Test{{
-			BasePath: "../../testdata/tests",
+			BasePath: "../../testdata/tests/quick-start",
 			Test: &v1alpha1.Test{
 				TypeMeta: metav1.TypeMeta{
 					APIVersion: "chainsaw.kyverno.io/v1alpha1",
@@ -32,7 +32,15 @@ func TestDiscoverTests(t *testing.T) {
 				Spec: v1alpha1.TestSpec{
 					Steps: []v1alpha1.TestStepSpec{{
 						Apply: []v1alpha1.Apply{{
-							File: "configmap.yaml",
+							FileRef: v1alpha1.FileRef{
+								File: "configmap.yaml",
+							},
+						}},
+					}, {
+						Assert: []v1alpha1.Assert{{
+							FileRef: v1alpha1.FileRef{
+								File: "configmap.yaml",
+							},
 						}},
 					}},
 				},

diff --git a/pkg/step/load_test.go b/pkg/step/load_test.go
@@ -55,16 +55,16 @@ func TestLoad(t *testing.T) {
 						Name: "test-1",
 					},
 					Spec: v1alpha1.TestStepSpec{
-						Apply: []v1alpha1.Apply{
-							{
+						Apply: []v1alpha1.Apply{{
+							FileRef: v1alpha1.FileRef{
 								File: "foo.yaml",
 							},
-						},
-						Assert: []v1alpha1.Assert{
-							{
+						}},
+						Assert: []v1alpha1.Assert{{
+							FileRef: v1alpha1.FileRef{
 								File: "bar.yaml",
 							},
-						},
+						}},
 					},
 				},
 			},
@@ -82,16 +82,16 @@ func TestLoad(t *testing.T) {
 						Name: "test-1",
 					},
 					Spec: v1alpha1.TestStepSpec{
-						Apply: []v1alpha1.Apply{
-							{
+						Apply: []v1alpha1.Apply{{
+							FileRef: v1alpha1.FileRef{
 								File: "foo.yaml",
 							},
-						},
-						Assert: []v1alpha1.Assert{
-							{
+						}},
+						Assert: []v1alpha1.Assert{{
+							FileRef: v1alpha1.FileRef{
 								File: "bar.yaml",
 							},
-						},
+						}},
 					},
 				},
 				{
@@ -103,16 +103,16 @@ func TestLoad(t *testing.T) {
 						Name: "test-2",
 					},
 					Spec: v1alpha1.TestStepSpec{
-						Apply: []v1alpha1.Apply{
-							{
+						Apply: []v1alpha1.Apply{{
+							FileRef: v1alpha1.FileRef{
 								File: "bar.yaml",
 							},
-						},
-						Assert: []v1alpha1.Assert{
-							{
+						}},
+						Assert: []v1alpha1.Assert{{
+							FileRef: v1alpha1.FileRef{
 								File: "foo.yaml",
 							},
-						},
+						}},
 					},
 				},
 			},

diff --git a/pkg/test/load_test.go b/pkg/test/load_test.go
@@ -54,11 +54,15 @@ func TestLoad(t *testing.T) {
 			Spec: v1alpha1.TestSpec{
 				Steps: []v1alpha1.TestStepSpec{{
 					Apply: []v1alpha1.Apply{{
-						File: "foo.yaml",
+						FileRef: v1alpha1.FileRef{
+							File: "foo.yaml",
+						},
 					}},
 				}, {
 					Assert: []v1alpha1.Assert{{
-						File: "bar.yaml",
+						FileRef: v1alpha1.FileRef{
+							File: "bar.yaml",
+						},
 					}},
 				}},
 			},

diff --git a/testdata/tests/chainsaw-test.yaml → ...data/tests/quick-start/chainsaw-test.yaml b/testdata/tests/chainsaw-test.yaml → ...data/tests/quick-start/chainsaw-test.yaml
@@ -6,3 +6,5 @@ spec:
   steps:
   - apply:
     - file: configmap.yaml
+  - assert:
+    - file: configmap.yaml
diff --git a/testdata/tests/configmap.yaml → testdata/tests/quick-start/configmap.yaml b/testdata/tests/configmap.yaml → testdata/tests/quick-start/configmap.yaml
diff --git a/website/apis/markdown/members.tpl b/website/apis/markdown/members.tpl
@@ -34,7 +34,7 @@
       {{- $type := .GetType }}
       {{- $inline := .IsInline }}
       {{- $comment := .GetComment }}
-| `{{ $name }}` | {{ template "typ" $type }} | {{ if not $optional }}:white_check_mark:{{ end }} | {{ template "comment" .CommentLines }} |
+| `{{ $name }}` | {{ template "typ" $type }} | {{ if not $optional }}:white_check_mark:{{ end }} | {{ if $inline }}:white_check_mark:{{ end }} | {{ template "comment" .CommentLines }} |
     {{- end }}
   {{- end }}
 {{- end }}
diff --git a/website/apis/markdown/type.tpl b/website/apis/markdown/type.tpl
@@ -19,13 +19,13 @@
 {{- end }}
 {{- if .GetMembers }}
 
-| Field | Type | Required | Description |
-|---|---|---|---|
+| Field | Type | Required | Inline | Description |
+|---|---|---|---|---|
     {{- /* . is a apiType */}}
     {{- if .IsExported }}
         {{- /* Add apiVersion and kind rows if deemed necessary */}}
-| `apiVersion` | `string` | :white_check_mark: | `{{- .APIGroup -}}` |
-| `kind` | `string` | :white_check_mark: | `{{- .Name.Name -}}` |
+| `apiVersion` | `string` | :white_check_mark: | | `{{- .APIGroup -}}` |
+| `kind` | `string` | :white_check_mark: | | `{{- .Name.Name -}}` |
     {{- end }}
     {{- /* The actual list of members is in the following template */}}
     {{- template "members" . }}