feat(testworkflows): add support for accompanying services (#257)

* feat(testworkflows): add syntax for running accompanying services
* feat(testworkflows): add `use` for services
* feat(testworkflows): add `logs` for services
* chore(testworkflows): make the resulting YAML smaller

api/testworkflows/v1/service_types.go

@@ -0,0 +1,45 @@
+package v1
+
+import corev1 "k8s.io/api/core/v1"
+
+type ServiceRestartPolicy string
+
+const (
+	ServiceRestartPolicyOnFailure ServiceRestartPolicy = "OnFailure"
+	ServiceRestartPolicyNever     ServiceRestartPolicy = "Never"
+)
+
+type IndependentServiceSpec struct {
+	StepExecuteStrategy `json:",inline" expr:"include"`
+
+	// should it fetch logs for that service
+	Logs bool `json:"logs,omitempty"`
+
+	// maximum time until reaching readiness
+	// +kubebuilder:validation:Pattern=^((0|[1-9][0-9]*)h)?((0|[1-9][0-9]*)m)?((0|[1-9][0-9]*)s)?((0|[1-9][0-9]*)ms)?$
+	Timeout string `json:"timeout,omitempty"`
+
+	// instructions for transferring files
+	Transfer []StepParallelTransfer `json:"transfer,omitempty" expr:"include"`
+
+	// global content that should be fetched into all containers
+	Content *Content `json:"content,omitempty" expr:"include"`
+
+	// configuration for the scheduled pod
+	Pod *PodConfig `json:"pod,omitempty" expr:"include"`
+
+	StepRun `json:",inline" expr:"include"`
+
+	// Restart policy for the main container in the pod. One of OnFailure or Never.
+	RestartPolicy ServiceRestartPolicy `json:"restartPolicy,omitempty" expr:"template"`
+
+	// Probe to check if the service has started correctly
+	ReadinessProbe *corev1.Probe `json:"readinessProbe,omitempty" expr:"force"`
+}
+
+type ServiceSpec struct {
+	// multiple templates to include in this step
+	Use []TemplateRef `json:"use,omitempty" expr:"include"`
+
+	IndependentServiceSpec `json:",inline" expr:"include"`
+}

api/testworkflows/v1/step_types.go

@@ -76,9 +76,13 @@ type StepOperations struct {
 }
 
 type IndependentStep struct {
-	StepMeta     `json:",inline" expr:"include"`
-	StepControl  `json:",inline" expr:"include"`
-	StepSource   `json:",inline" expr:"include"`
+	StepMeta    `json:",inline" expr:"include"`
+	StepControl `json:",inline" expr:"include"`
+	StepSource  `json:",inline" expr:"include"`
+
+	// list of accompanying services to start
+	Services map[string]IndependentServiceSpec `json:"services,omitempty" expr:"template,include"`
+
 	StepDefaults `json:",inline" expr:"include"`
 
 	// steps to run before other operations in this step
@@ -106,6 +110,9 @@ type Step struct {
 
 	StepSource `json:",inline" expr:"include"`
 
+	// list of accompanying services to start
+	Services map[string]ServiceSpec `json:"services,omitempty" expr:"template,include"`
+
 	StepDefaults `json:",inline" expr:"include"`
 
 	// steps to run before other operations in this step

api/testworkflows/v1/testworkflow_types.go

@@ -27,6 +27,9 @@ type TestWorkflowSpec struct {
 
 	TestWorkflowSpecBase `json:",inline" expr:"include"`
 
+	// list of accompanying services to start
+	Services map[string]ServiceSpec `json:"services,omitempty" expr:"template,include"`
+
 	// steps for setting up the workflow
 	Setup []Step `json:"setup,omitempty" expr:"include"`
 

api/testworkflows/v1/testworkflowtemplate_types.go

@@ -23,6 +23,9 @@ type TestWorkflowTemplateSpec struct {
 
 	TestWorkflowSpecBase `json:",inline" expr:"include"`
 
+	// list of accompanying services to start
+	Services map[string]IndependentServiceSpec `json:"services,omitempty" expr:"template,include"`
+
 	// steps for setting up the workflow
 	Setup []IndependentStep `json:"setup,omitempty" expr:"include"`
 

api/testworkflows/v1/types.go

@@ -78,6 +78,8 @@ type PodConfig struct {
 	Annotations map[string]string `json:"annotations,omitempty" expr:"template,template"`
 
 	// volumes to include in the pod
+	// +kubebuilder:pruning:PreserveUnknownFields
+	// +kubebuilder:validation:Schemaless
 	Volumes []corev1.Volume `json:"volumes,omitempty" expr:"force"`
 
 	// duration in seconds the pod may be active on the node
@@ -99,6 +101,8 @@ type PodConfig struct {
 	Subdomain string `json:"subdomain,omitempty" expr:"template"`
 
 	// If specified, the pod's scheduling constraints
+	// +kubebuilder:pruning:PreserveUnknownFields
+	// +kubebuilder:validation:Schemaless
 	Affinity *corev1.Affinity `json:"affinity,omitempty" expr:"force"`
 
 	// If specified, the pod's tolerations.
@@ -120,6 +124,8 @@ type PodConfig struct {
 	PreemptionPolicy *corev1.PreemptionPolicy `json:"preemptionPolicy,omitempty" expr:"template"`
 
 	// TopologySpreadConstraints describes how a group of pods ought to spread across topology domains.
+	// +kubebuilder:pruning:PreserveUnknownFields
+	// +kubebuilder:validation:Schemaless
 	TopologySpreadConstraints []corev1.TopologySpreadConstraint `json:"topologySpreadConstraints,omitempty" expr:"force"`
 
 	// SchedulingGates is an opaque list of values that if specified will block scheduling the pod.