feat: add describe collector (#826)

* feat: add describe collector Signed-off-by: Charles-Edouard Brétéché <[email protected]> * validation Signed-off-by: Charles-Edouard Brétéché <[email protected]> --------- Signed-off-by: Charles-Edouard Brétéché <[email protected]>
kyverno · Feb 9, 2024 · b01fe35 · b01fe35
1 parent 043a1e4
commit b01fe35
Show file tree

Hide file tree

Showing 25 changed files with 762 additions and 34 deletions.
diff --git a/.crds/chainsaw.kyverno.io_tests.yaml b/.crds/chainsaw.kyverno.io_tests.yaml
@@ -101,6 +101,30 @@ spec:
  required:
  - entrypoint
  type: object
+ describe:
+ description: Describe determines the resource describe
+ collector to execute.
+ properties:
+ name:
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ type: string
+ namespace:
+ description: 'Namespace of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
+ type: string
+ resource:
+ description: Resource type.
+ type: string
+ selector:
+ description: Selector defines labels selector.
+ type: string
+ timeout:
+ description: Timeout for the operation. Overrides
+ the global timeout set in the Configuration.
+ type: string
+ required:
+ - resource
+ type: object
  description:
  description: Description contains a description of the
  operation.
@@ -227,6 +251,30 @@ spec:
  required:
  - entrypoint
  type: object
+ describe:
+ description: Describe determines the resource describe
+ collector to execute.
+ properties:
+ name:
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ type: string
+ namespace:
+ description: 'Namespace of the referent. More info:
+ https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
+ type: string
+ resource:
+ description: Resource type.
+ type: string
+ selector:
+ description: Selector defines labels selector.
+ type: string
+ timeout:
+ description: Timeout for the operation. Overrides
+ the global timeout set in the Configuration.
+ type: string
+ required:
+ - resource
+ type: object
  description:
  description: Description contains a description of the
  operation.

diff --git a/.crds/chainsaw.kyverno.io_teststeps.yaml b/.crds/chainsaw.kyverno.io_teststeps.yaml
@@ -68,6 +68,29 @@ spec:
  required:
  - entrypoint
  type: object
+ describe:
+ description: Describe determines the resource describe collector
+ to execute.
+ properties:
+ name:
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ type: string
+ namespace:
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
+ type: string
+ resource:
+ description: Resource type.
+ type: string
+ selector:
+ description: Selector defines labels selector.
+ type: string
+ timeout:
+ description: Timeout for the operation. Overrides the global
+ timeout set in the Configuration.
+ type: string
+ required:
+ - resource
+ type: object
  description:
  description: Description contains a description of the operation.
  type: string
@@ -184,6 +207,29 @@ spec:
  required:
  - entrypoint
  type: object
+ describe:
+ description: Describe determines the resource describe collector
+ to execute.
+ properties:
+ name:
+ description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
+ type: string
+ namespace:
+ description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
+ type: string
+ resource:
+ description: Resource type.
+ type: string
+ selector:
+ description: Selector defines labels selector.
+ type: string
+ timeout:
+ description: Timeout for the operation. Overrides the global
+ timeout set in the Configuration.
+ type: string
+ required:
+ - resource
+ type: object
  description:
  description: Description contains a description of the operation.
  type: string

diff --git a/.release-notes/main.md b/.release-notes/main.md
@@ -22,6 +22,7 @@ Release notes for `TODO`.
 
 - Allowed passing test folders by args (`chainsaw test ./folder` instead of `chainsaw test --test-dir ./folder`)
 - Added new binding `$namespace` containing the test namespace name
+- Added new `describe` collector to invoke `kubectl describe ...`
 
 ## 🔧 Fixes 🔧
 

diff --git a/.schemas/json/test-chainsaw-v1alpha1.json b/.schemas/json/test-chainsaw-v1alpha1.json
@@ -401,6 +401,50 @@
  }
  }
  },
+ "describe": {
+ "description": "Describe determines the resource describe collector to execute.",
+ "type": [
+ "object",
+ "null"
+ ],
+ "required": [
+ "resource"
+ ],
+ "properties": {
+ "name": {
+ "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "namespace": {
+ "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "resource": {
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "selector": {
+ "description": "Selector defines labels selector.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "timeout": {
+ "description": "Timeout for the operation. Overrides the global timeout set in the Configuration.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ }
+ },
  "description": {
  "description": "Description contains a description of the operation.",
  "type": [
@@ -616,6 +660,50 @@
  }
  }
  },
+ "describe": {
+ "description": "Describe determines the resource describe collector to execute.",
+ "type": [
+ "object",
+ "null"
+ ],
+ "required": [
+ "resource"
+ ],
+ "properties": {
+ "name": {
+ "description": "Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "namespace": {
+ "description": "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "resource": {
+ "description": "Resource type.",
+ "type": "string"
+ },
+ "selector": {
+ "description": "Selector defines labels selector.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "timeout": {
+ "description": "Timeout for the operation. Overrides the global timeout set in the Configuration.",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ }
+ },
  "description": {
  "description": "Description contains a description of the operation.",
  "type": [

diff --git a/pkg/apis/v1alpha1/catch.go b/pkg/apis/v1alpha1/catch.go
@@ -14,6 +14,10 @@ type Catch struct {
  // +optional
  Events *Events `json:"events,omitempty"`
 
+ // Describe determines the resource describe collector to execute.
+ // +optional
+ Describe *Describe `json:"describe,omitempty"`
+
  // Command defines a command to run.
  // +optional
  Command *Command `json:"command,omitempty"`

diff --git a/pkg/apis/v1alpha1/describe.go b/pkg/apis/v1alpha1/describe.go
@@ -0,0 +1,29 @@
+package v1alpha1
+
+import (
+ metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+)
+
+// Describe defines how to describe resources.
+type Describe struct {
+ // Timeout for the operation. Overrides the global timeout set in the Configuration.
+ // +optional
+ Timeout *metav1.Duration `json:"timeout,omitempty"`
+
+ // Resource type.
+ Resource string `json:"resource"`
+
+ // Namespace of the referent.
+ // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
+ // +optional
+ Namespace string `json:"namespace,omitempty"`
+
+ // Name of the referent.
+ // More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
+ // +optional
+ Name string `json:"name,omitempty"`
+
+ // Selector defines labels selector.
+ // +optional
+ Selector string `json:"selector,omitempty"`
+}
diff --git a/pkg/apis/v1alpha1/finally.go b/pkg/apis/v1alpha1/finally.go
@@ -14,6 +14,10 @@ type Finally struct {
  // +optional
  Events *Events `json:"events,omitempty"`
 
+ // Describe determines the resource describe collector to execute.
+ // +optional
+ Describe *Describe `json:"describe,omitempty"`
+
  // Command defines a command to run.
  // +optional
  Command *Command `json:"command,omitempty"`

diff --git a/pkg/apis/v1alpha1/zz_generated.deepcopy.go b/pkg/apis/v1alpha1/zz_generated.deepcopy.go
diff --git a/pkg/commands/build/docs/docs.tmpl b/pkg/commands/build/docs/docs.tmpl
@@ -25,6 +25,8 @@ command
 events
 {{- else if .PodLogs -}}
 pod logs
+{{- else if .Describe -}}
+describe
 {{- else if .Script -}}
 script
 {{- else if .Sleep -}}
@@ -39,6 +41,8 @@ command
 events
 {{- else if .PodLogs -}}
 pod logs
+{{- else if .Describe -}}
+describe
 {{- else if .Script -}}
 script
 {{- else if .Sleep -}}