fix: add enums

Author: vsukhin

apis/executor/v1/webhook_types.go

@@ -31,13 +31,30 @@ type WebhookSpec struct {
 	// Uri is address where webhook should be made
 	Uri string `json:"uri,omitempty"`
 	// Events declare list if events on which webhook should be called
-	Events []string `json:"events,omitempty"`
+	Events []EventType `json:"events,omitempty"`
 	// Labels to filter for tests and test suites
 	Selector string `json:"selector,omitempty"`
 	// will load the generated payload for notification inside the object
 	PayloadObjectField string `json:"payloadObjectField,omitempty"`
 }
 
+// +kubebuilder:validation:Enum=start-test;end-test-success;end-test-failed;end-test-aborted;end-test-timeout;start-testsuite;end-testsuite-success;end-testsuite-failed;end-testsuite-aborted;end-testsuite-timeout
+type EventType string
+
+// List of EventType
+const (
+	START_TEST_EventType            EventType = "start-test"
+	END_TEST_SUCCESS_EventType      EventType = "end-test-success"
+	END_TEST_FAILED_EventType       EventType = "end-test-failed"
+	END_TEST_ABORTED_EventType      EventType = "end-test-aborted"
+	END_TEST_TIMEOUT_EventType      EventType = "end-test-timeout"
+	START_TESTSUITE_EventType       EventType = "start-testsuite"
+	END_TESTSUITE_SUCCESS_EventType EventType = "end-testsuite-success"
+	END_TESTSUITE_FAILED_EventType  EventType = "end-testsuite-failed"
+	END_TESTSUITE_ABORTED_EventType EventType = "end-testsuite-aborted"
+	END_TESTSUITE_TIMEOUT_EventType EventType = "end-testsuite-timeout"
+)
+
 // WebhookStatus defines the observed state of Webhook
 type WebhookStatus struct {
 	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster

apis/executor/v1/zz_generated.deepcopy.go

@@ -50,7 +50,7 @@ type Variable commonv1.Variable
 // TestContent defines test content
 type TestContent struct {
 	// test type
-	Type_ string `json:"type,omitempty"`
+	Type_ TestContentType `json:"type,omitempty"`
 	// repository of test content
 	Repository *Repository `json:"repository,omitempty"`
 	// test content body
@@ -59,6 +59,19 @@ type TestContent struct {
 	Uri string `json:"uri,omitempty"`
 }
 
+// +kubebuilder:validation:Enum=string;file-uri;git-file;git-dir;git
+type TestContentType string
+
+const (
+	TestContentTypeString  TestContentType = "string"
+	TestContentTypeFileURI TestContentType = "file-uri"
+	// Deprecated: use git instead
+	TestContentTypeGitFile TestContentType = "git-file"
+	// Deprecated: use git instead
+	TestContentTypeGitDir TestContentType = "git-dir"
+	TestContentTypeGit    TestContentType = "git"
+)
+
 // Testkube internal reference for secret storage in Kubernetes secrets
 type SecretRef struct {
 	// object kubernetes namespace
@@ -88,9 +101,20 @@ type Repository struct {
 	// if provided we checkout the whole repository and run test from this directory
 	WorkingDir string `json:"workingDir,omitempty"`
 	// auth type for git requests
-	AuthType string `json:"authType,omitempty"`
+	AuthType GitAuthType `json:"authType,omitempty"`
 }
 
+// GitAuthType defines git auth type
+// +kubebuilder:validation:Enum=basic;header
+type GitAuthType string
+
+const (
+	// GitAuthTypeBasic for git basic auth requests
+	GitAuthTypeBasic GitAuthType = "basic"
+	// GitAuthTypeHeader for git header auth requests
+	GitAuthTypeHeader GitAuthType = "header"
+)
+
 // artifact request body for container executors with test artifacts
 type ArtifactRequest struct {
 	// artifact storage class name
@@ -104,11 +128,22 @@ type ArtifactRequest struct {
 // running context for test or test suite execution
 type RunningContext struct {
 	// One of possible context types
-	Type_ string `json:"type"`
+	Type_ RunningContextType `json:"type"`
 	// Context value depending from its type
 	Context string `json:"context,omitempty"`
 }
 
+type RunningContextType string
+
+const (
+	RunningContextTypeUserCLI     RunningContextType = "user-cli"
+	RunningContextTypeUserUI      RunningContextType = "user-ui"
+	RunningContextTypeTestSuite   RunningContextType = "testsuite"
+	RunningContextTypeTestTrigger RunningContextType = "testtrigger"
+	RunningContextTypeScheduler   RunningContextType = "scheduler"
+	RunningContextTypeEmpty       RunningContextType = ""
+)
+
 // test execution request body
 type ExecutionRequest struct {
 	// test execution custom name
@@ -168,17 +203,6 @@ type ExecutionRequest struct {
 	RunningContext *RunningContext `json:"runningContext,omitempty"`
 }
 
-type RunningContextType string
-
-const (
-	RunningContextTypeUserCLI     RunningContextType = "user-cli"
-	RunningContextTypeUserUI      RunningContextType = "user-ui"
-	RunningContextTypeTestSuite   RunningContextType = "testsuite"
-	RunningContextTypeTestTrigger RunningContextType = "testtrigger"
-	RunningContextTypeScheduler   RunningContextType = "scheduler"
-	RunningContextTypeEmpty       RunningContextType = ""
-)
-
 // Reference to env resource
 type EnvReference struct {
 	v1.LocalObjectReference `json:"reference"`
@@ -190,6 +214,7 @@ type EnvReference struct {
 	MapToVariables bool `json:"mapToVariables,omitempty"`
 }
 
+// +kubebuilder:validation:Enum=queued;running;passed;failed;aborted;timeout
 type ExecutionStatus string
 
 // List of ExecutionStatus

apis/tests/v3/test_types.go

@@ -28,7 +28,7 @@ type TestSourceSpec struct {
 	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
 	// Important: Run "make" to regenerate code after modifying this file
 
-	Type_ string `json:"type,omitempty"`
+	Type_ TestSourceType `json:"type,omitempty"`
 	// repository of test content
 	Repository *Repository `json:"repository,omitempty"`
 	// test content body
@@ -37,6 +37,19 @@ type TestSourceSpec struct {
 	Uri string `json:"uri,omitempty"`
 }
 
+// +kubebuilder:validation:Enum=string;file-uri;git-file;git-dir;git
+type TestSourceType string
+
+const (
+	TestSourceTypeString  TestSourceType = "string"
+	TestSourceTypeFileURI TestSourceType = "file-uri"
+	// Deprecated: use git instead
+	TestSourceTypeGitFile TestSourceType = "git-file"
+	// Deprecated: use git instead
+	TestSourceTypeGitDir TestSourceType = "git-dir"
+	TestSourceTypeGit    TestSourceType = "git"
+)
+
 // Testkube internal reference for secret storage in Kubernetes secrets
 type SecretRef struct {
 	// object kubernetes namespace
@@ -66,9 +79,20 @@ type Repository struct {
 	// if provided we checkout the whole repository and run test from this directory
 	WorkingDir string `json:"workingDir,omitempty"`
 	// auth type for git requests
-	AuthType string `json:"authType,omitempty"`
+	AuthType GitAuthType `json:"authType,omitempty"`
 }
 
+// GitAuthType defines git auth type
+// +kubebuilder:validation:Enum=basic;header
+type GitAuthType string
+
+const (
+	// GitAuthTypeBasic for git basic auth requests
+	GitAuthTypeBasic GitAuthType = "basic"
+	// GitAuthTypeHeader for git header auth requests
+	GitAuthTypeHeader GitAuthType = "header"
+)
+
 // TestSourceStatus defines the observed state of TestSource
 type TestSourceStatus struct {
 	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster

apis/testsource/v1/testsource_types.go

@@ -47,12 +47,13 @@ type Variable commonv1.Variable
 
 // TestSuiteStepSpec for particular type will have config for possible step types
 type TestSuiteStepSpec struct {
-	Type    string                `json:"type,omitempty"`
+	Type    TestSuiteStepType     `json:"type,omitempty"`
 	Execute *TestSuiteStepExecute `json:"execute,omitempty"`
 	Delay   *TestSuiteStepDelay   `json:"delay,omitempty"`
 }
 
 // TestSuiteStepType deines different type of test suite steps
+// +kubebuilder:validation:Enum=execute;delay
 type TestSuiteStepType string
 
 const (
@@ -76,11 +77,22 @@ type TestSuiteStepDelay struct {
 // running context for test or test suite execution
 type RunningContext struct {
 	// One of possible context types
-	Type_ string `json:"type"`
+	Type_ RunningContextType `json:"type"`
 	// Context value depending from its type
 	Context string `json:"context,omitempty"`
 }
 
+type RunningContextType string
+
+const (
+	RunningContextTypeUserCLI     RunningContextType = "user-cli"
+	RunningContextTypeUserUI      RunningContextType = "user-ui"
+	RunningContextTypeTestSuite   RunningContextType = "testsuite"
+	RunningContextTypeTestTrigger RunningContextType = "testtrigger"
+	RunningContextTypeScheduler   RunningContextType = "scheduler"
+	RunningContextTypeEmpty       RunningContextType = ""
+)
+
 // test suite execution request body
 type TestSuiteExecutionRequest struct {
 	// test execution custom name
@@ -105,17 +117,7 @@ type TestSuiteExecutionRequest struct {
 	RunningContext *RunningContext `json:"runningContext,omitempty"`
 }
 
-type RunningContextType string
-
-const (
-	RunningContextTypeUserCLI     RunningContextType = "user-cli"
-	RunningContextTypeUserUI      RunningContextType = "user-ui"
-	RunningContextTypeTestSuite   RunningContextType = "testsuite"
-	RunningContextTypeTestTrigger RunningContextType = "testtrigger"
-	RunningContextTypeScheduler   RunningContextType = "scheduler"
-	RunningContextTypeEmpty       RunningContextType = ""
-)
-
+// +kubebuilder:validation:Enum=queued;running;passed;failed;aborting;aborted;timeout
 type TestSuiteExecutionStatus string
 
 // List of TestSuiteExecutionStatus

apis/testsuite/v2/testsuite_types.go

@@ -78,6 +78,7 @@ type TestTriggerStatus struct {
 }
 
 // TestTriggerConditionStatuses defines condition statuses for test triggers
+// +kubebuilder:validation:Enum=True;False;Unknown
 type TestTriggerConditionStatuses string
 
 // List of TestTriggerConditionStatuses

apis/testtriggers/v1/testtrigger_types.go

@@ -39,6 +39,17 @@ spec:
                 description: Events declare list if events on which webhook should
                   be called
                 items:
+                  enum:
+                  - start-test
+                  - end-test-success
+                  - end-test-failed
+                  - end-test-aborted
+                  - end-test-timeout
+                  - start-testsuite
+                  - end-testsuite-success
+                  - end-testsuite-failed
+                  - end-testsuite-aborted
+                  - end-testsuite-timeout
                   type: string
                 type: array
               payloadObjectField:

config/crd/bases/executor.testkube.io_webhooks.yaml

@@ -361,6 +361,9 @@ spec:
                     properties:
                       authType:
                         description: auth type for git requests
+                        enum:
+                        - basic
+                        - header
                         type: string
                       branch:
                         description: branch/tag name for checkout
@@ -422,6 +425,12 @@ spec:
                     type: object
                   type:
                     description: test type
+                    enum:
+                    - string
+                    - file-uri
+                    - git-file
+                    - git-dir
+                    - git
                     type: string
                   uri:
                     description: uri of test content
@@ -741,6 +750,13 @@ spec:
                     format: date-time
                     type: string
                   status:
+                    enum:
+                    - queued
+                    - running
+                    - passed
+                    - failed
+                    - aborted
+                    - timeout
                     type: string
                 type: object
             type: object

config/crd/bases/tests.testkube.io_tests.yaml

@@ -43,6 +43,9 @@ spec:
                 properties:
                   authType:
                     description: auth type for git requests
+                    enum:
+                    - basic
+                    - header
                     type: string
                   branch:
                     description: branch/tag name for checkout
@@ -106,6 +109,12 @@ spec:
                 - uri
                 type: object
               type:
+                enum:
+                - string
+                - file-uri
+                - git-file
+                - git-dir
+                - git
                 type: string
               uri:
                 description: uri of test content

config/crd/bases/tests.testkube.io_testsources.yaml

@@ -283,6 +283,11 @@ spec:
                           type: boolean
                       type: object
                     type:
+                      description: TestSuiteStepType deines different type of test
+                        suite steps
+                      enum:
+                      - execute
+                      - delay
                       type: string
                   type: object
                 type: array
@@ -312,6 +317,11 @@ spec:
                           type: boolean
                       type: object
                     type:
+                      description: TestSuiteStepType deines different type of test
+                        suite steps
+                      enum:
+                      - execute
+                      - delay
                       type: string
                   type: object
                 type: array
@@ -482,6 +492,11 @@ spec:
                           type: boolean
                       type: object
                     type:
+                      description: TestSuiteStepType deines different type of test
+                        suite steps
+                      enum:
+                      - execute
+                      - delay
                       type: string
                   type: object
                 type: array
@@ -504,6 +519,14 @@ spec:
                     format: date-time
                     type: string
                   status:
+                    enum:
+                    - queued
+                    - running
+                    - passed
+                    - failed
+                    - aborting
+                    - aborted
+                    - timeout
                     type: string
                 type: object
             type: object

config/crd/bases/tests.testkube.io_testsuites.yaml

@@ -67,6 +67,10 @@ spec:
                         status:
                           description: TestTriggerConditionStatuses defines condition
                             statuses for test triggers
+                          enum:
+                          - "True"
+                          - "False"
+                          - Unknown
                           type: string
                         type:
                           description: test trigger condition