Fix Functional Tests to accomodate dyanmic sample config JSON generation

gmfrasca · gmfrasca · commit 28b1a5b4872d · 2025-02-14T13:27:06.000-05:00
Signed-off-by: Giulio Frasca &lt;gfrasca@redhat.com&gt;
diff --git a/api/v1/dspipeline_types.go b/api/v1/dspipeline_types.go
@@ -62,7 +62,7 @@ type ManagedPipelineOptions struct {
 	// Set to one of the following values:
 	//
 	// - "Managed" : This pipeline is automatically imported.
-	// - "Removed" : This pipeline is not automatically imported when a new pipeline server or DSPA is created. If previously set to "Managed", setting to "Removed" does not remove existing preloaded pipelines but does prevent future updates from being imported.
+	// - "Removed" : This pipeline is not automatically imported. If previously set to "Managed", setting to "Removed" does not remove existing managed pipelines but does prevent future updates from being imported.
 	//
 	// +kubebuilder:validation:Enum=Managed;Removed
 	// +kubebuilder:default=Removed
@@ -90,7 +90,6 @@ type APIServer struct {
 	EnableRoute bool `json:"enableOauth"`
 	// Include the Iris sample pipeline with the deployment of this DSP API Server. Default: true
 	// +kubebuilder:default:=false
-	// +Deprecated
 	// +kubebuilder:validation:Optional
 	EnableSamplePipeline bool `json:"enableSamplePipeline"`
 	// Launcher/Executor image used during pipeline execution.
diff --git a/api/v1alpha1/dspipeline_types.go b/api/v1alpha1/dspipeline_types.go
@@ -62,8 +62,7 @@ type ManagedPipelineOptions struct {
 	// Set to one of the following values:
 	//
 	// - "Managed" : This pipeline is automatically imported.
-	// - "Removed" : This pipeline is not automatically imported when a new pipeline server or DSPA is created. If previously set to "Managed", setting to "Removed" does not remove existing preloaded pipelines but does prevent future updates from being imported.
-	//
+	// - "Removed" : This pipeline is not automatically imported. If previously set to "Managed", setting to "Removed" does not remove existing managed pipelines but does prevent future updates from being imported.	//
 	// +kubebuilder:validation:Enum=Managed;Removed
 	// +kubebuilder:default=Removed
 	// +kubebuilder:validation:Optional
@@ -90,7 +89,6 @@ type APIServer struct {
 	EnableRoute bool `json:"enableOauth"`
 	// Include the Iris sample pipeline with the deployment of this DSP API Server. Default: true
 	// +kubebuilder:default:=false
-	// +Deprecated
 	// +kubebuilder:validation:Optional
 	EnableSamplePipeline bool `json:"enableSamplePipeline"`
 	// Launcher/Executor image used during pipeline execution.
diff --git a/config/configmaps/files/config.yaml b/config/configmaps/files/config.yaml
@@ -15,17 +15,15 @@ Images:
   RHELAI: $(IMAGES_RHELAI)
 ManagedPipelinesMetadata:
   Instructlab:
-    Name: "[InstructLab] LLM Training Pipeline"
-    Description:
+    Name: Instructlab
+    Description: InstructLab fine-tunes models using synthetic data generation (SDG) techniques and a structured taxonomy to create diverse, high-quality training datasets.
     Filepath: /pipelines/instructlab.yaml
-    VersionName: "[InstructLab] LLM Training Pipeline"
-    # VersionDescription: "TODO - Add a Version Description"
+    VersionName: Instructlab
   Iris:
     Name: "[Demo] iris-training"
     Description: "[source code](https://github.com/opendatahub-io/data-science-pipelines/tree/master/samples/iris-sklearn) A simple pipeline to demonstrate a basic ML Training workflow"
     Filepath: /samples/iris-pipeline-compiled.yaml
     VersionName: "[Demo] iris-training"
-    # VersionDescription: "TODO - Add a Version Description"
 DSPO:
   HealthCheck:
     Database:
diff --git a/config/crd/bases/datasciencepipelinesapplications.opendatahub.io_datasciencepipelinesapplications.yaml b/config/crd/bases/datasciencepipelinesapplications.opendatahub.io_datasciencepipelinesapplications.yaml
@@ -169,11 +169,10 @@ spec:
                             default: Removed
                             description: "Set to one of the following values: \n -
                               \"Managed\" : This pipeline is automatically imported.
-                              - \"Removed\" : This pipeline is not automatically imported
-                              when a new pipeline server or DSPA is created. If previously
-                              set to \"Managed\", setting to \"Removed\" does not
-                              remove existing preloaded pipelines but does prevent
-                              future updates from being imported."
+                              - \"Removed\" : This pipeline is not automatically imported.
+                              If previously set to \"Managed\", setting to \"Removed\"
+                              does not remove existing managed pipelines but does
+                              prevent future updates from being imported."
                             enum:
                             - Managed
                             - Removed
@@ -1133,11 +1132,10 @@ spec:
                             default: Removed
                             description: "Set to one of the following values: \n -
                               \"Managed\" : This pipeline is automatically imported.
-                              - \"Removed\" : This pipeline is not automatically imported
-                              when a new pipeline server or DSPA is created. If previously
-                              set to \"Managed\", setting to \"Removed\" does not
-                              remove existing preloaded pipelines but does prevent
-                              future updates from being imported."
+                              - \"Removed\" : This pipeline is not automatically imported.
+                              If previously set to \"Managed\", setting to \"Removed\"
+                              does not remove existing managed pipelines but does
+                              prevent future updates from being imported.\t//"
                             enum:
                             - Managed
                             - Removed
diff --git a/config/overlays/make-deploy/kustomization.yaml b/config/overlays/make-deploy/kustomization.yaml
@@ -9,4 +9,4 @@ patchesStrategicMerge:
 images:
 - name: controller
   newName: quay.io/gmfrasca/dspo
-  newTag: managed-pipelines-v0.0.3
+  newTag: managed-pipelines-v0.0.5
diff --git a/controllers/apiserver.go b/controllers/apiserver.go
@@ -18,7 +18,6 @@ package controllers
 import (
 	"context"
 	"crypto/sha256"
-	"encoding/hex"
 	"encoding/json"
 	"fmt"
 	"strings"
@@ -50,19 +49,19 @@ func (r *DSPAReconciler) GenerateSamplePipelineMetadataBlock(pipeline string) (m
 	item := make(map[string]string)
 
 	// Get Required Fields
-	pName, err := config.GetStringConfigOrError(fmt.Sprintf("ManagedPipelinesMetadata.%s.Name", pipeline))
+	pName, err := config.GetStringConfig(fmt.Sprintf("ManagedPipelinesMetadata.%s.Name", pipeline))
 	if err != nil {
 		return nil, err
 	}
-	pFile, err := config.GetStringConfigOrError(fmt.Sprintf("ManagedPipelinesMetadata.%s.Filepath", pipeline))
+	pFile, err := config.GetStringConfig(fmt.Sprintf("ManagedPipelinesMetadata.%s.Filepath", pipeline))
 	if err != nil {
 		return nil, err
 	}
-	platformVersion := config.GetStringConfigWithDefault("PlatformVersion", config.DefaultPlatformVersion)
+	platformVersion := config.GetStringConfigWithDefault("DSPO.PlatformVersion", config.DefaultPlatformVersion)
 
 	// Get optional fields
 	pDesc := config.GetStringConfigWithDefault(fmt.Sprintf("ManagedPipelinesMetadata.%s.Description", pipeline), "")
-	pVerName := config.GetStringConfigWithDefault(fmt.Sprintf("ManagedPipelinesMetadata.%s.VersionName", pipeline), "")
+	pVerName := config.GetStringConfigWithDefault(fmt.Sprintf("ManagedPipelinesMetadata.%s.VersionName", pipeline), pName)
 	pVerDesc := config.GetStringConfigWithDefault(fmt.Sprintf("ManagedPipelinesMetadata.%s.VersionDescription", pipeline), "")
 
 	// Create Sample Config item
@@ -76,7 +75,7 @@ func (r *DSPAReconciler) GenerateSamplePipelineMetadataBlock(pipeline string) (m
 
 }
 
-func (r *DSPAReconciler) GetSampleConfig(ctx context.Context, dsp *dspa.DataSciencePipelinesApplication, params *DSPAParams) (string, error) {
+func (r *DSPAReconciler) GetSampleConfig(dsp *dspa.DataSciencePipelinesApplication) (string, error) {
 	// Check if InstructLab Pipeline enabled in this DSPA
 	enableInstructLabPipeline := false
 	if dsp.Spec.APIServer.ManagedPipelines != nil && dsp.Spec.APIServer.ManagedPipelines.InstructLab != nil {
@@ -86,10 +85,10 @@ func (r *DSPAReconciler) GetSampleConfig(ctx context.Context, dsp *dspa.DataScie
 		}
 	}
 
-	return r.GenerateSampleConfigJSON(enableInstructLabPipeline, dsp.Spec.APIServer.EnableSamplePipeline)
+	return r.generateSampleConfigJSON(enableInstructLabPipeline, dsp.Spec.APIServer.EnableSamplePipeline)
 }
 
-func (r *DSPAReconciler) GenerateSampleConfigJSON(enableInstructLabPipeline, enableIrisPipeline bool) (string, error) {
+func (r *DSPAReconciler) generateSampleConfigJSON(enableInstructLabPipeline, enableIrisPipeline bool) (string, error) {
 
 	// Now generate a sample config
 	var pipelineConfig = make([]map[string]string, 0)
@@ -130,17 +129,14 @@ func (r *DSPAReconciler) ReconcileAPIServer(ctx context.Context, dsp *dspav1.Dat
 	}
 
 	log.Info("Generating Sample Config")
-	sampleConfigJSON, err := r.GetSampleConfig(ctx, dsp, params)
+	sampleConfigJSON, err := r.GetSampleConfig(dsp)
 	if err != nil {
 		return err
 	}
 	params.SampleConfigJSON = sampleConfigJSON
 
 	// Generate configuration hash for rebooting on sample changes
-	hasher := sha256.New()
-	hasher.Write([]byte(sampleConfigJSON))
-	configHash := hex.EncodeToString(hasher.Sum(nil))
-	params.APIServerConfigHash = configHash
+	params.APIServerConfigHash = fmt.Sprintf("%x", sha256.Sum256([]byte(sampleConfigJSON)))
 
 	log.Info("Applying APIServer Resources")
 	err = r.ApplyDir(dsp, params, apiServerTemplatesDir)
diff --git a/controllers/config/defaults.go b/controllers/config/defaults.go
@@ -195,7 +195,7 @@ func createResourceRequirement(RequestsCPU resource.Quantity, RequestsMemory res
 	}
 }
 
-func GetStringConfigOrError(configName string) (string, error) {
+func GetStringConfig(configName string) (string, error) {
 	if !viper.IsSet(configName) {
 		return "", fmt.Errorf("value not set in config for configname %s", configName)
 	}
diff --git a/controllers/testdata/declarative/case_0/config.yaml b/controllers/testdata/declarative/case_0/config.yaml
@@ -16,6 +16,18 @@ Images:
   RuntimeGeneric: runtimegeneric:test0
   Toolbox: toolbox:test0
   RHELAI: rhelai:test0
+ManagedPipelinesMetadata:
+  Instructlab:
+    Name: "[InstructLab] LLM Training Pipeline"
+    Description:
+    Filepath: /pipelines/instructlab.yaml
+    VersionName: "[InstructLab] LLM Training Pipeline"
+  Iris:
+    Name: "[Demo] iris-training"
+    Description: "[source code](https://github.com/opendatahub-io/data-science-pipelines/tree/master/samples/iris-sklearn) A simple pipeline to demonstrate a basic ML Training workflow"
+    Filepath: /samples/iris-pipeline-compiled.yaml
+    VersionName: "[Demo] iris-training"
 DSPO:
+  PlatformVersion: v0.0.0
   ApiServer:
     IncludeOwnerReference: false
diff --git a/controllers/testdata/declarative/case_0/expected/created/apiserver_deployment.yaml b/controllers/testdata/declarative/case_0/expected/created/apiserver_deployment.yaml
@@ -16,6 +16,8 @@ spec:
       dspa: testdsp0
   template:
     metadata:
+      annotations:
+        configHash: 33ff9677391ad5d02376e8a13b5dc6a207c37120c38011f7a3bba17d63b4cfbb
       labels:
         dsp-version: v2
         app: ds-pipeline-testdsp0
diff --git a/controllers/testdata/declarative/case_1/config.yaml b/controllers/testdata/declarative/case_1/config.yaml
@@ -15,3 +15,16 @@ Images:
   RuntimeGeneric: runtimegeneric:test1
   Toolbox: toolbox:test1
   RHELAI: rhelai:test1
+ManagedPipelinesMetadata:
+  Instructlab:
+    Name: "[InstructLab] LLM Training Pipeline"
+    Description:
+    Filepath: /pipelines/instructlab.yaml
+    VersionName: "[InstructLab] LLM Training Pipeline"
+  Iris:
+    Name: "[Demo] iris-training"
+    Description: "[source code](https://github.com/opendatahub-io/data-science-pipelines/tree/master/samples/iris-sklearn) A simple pipeline to demonstrate a basic ML Training workflow"
+    Filepath: /samples/iris-pipeline-compiled.yaml
+    VersionName: "[Demo] iris-training"
+DSPO:
+  PlatformVersion: v0.0.0
diff --git a/controllers/testdata/declarative/case_2/config.yaml b/controllers/testdata/declarative/case_2/config.yaml
@@ -15,6 +15,19 @@ Images:
   RuntimeGeneric: runtimegeneric:test2
   Toolbox: toolbox:test2
   RHELAI: rhelai:test2
+ManagedPipelinesMetadata:
+  InstructLab:
+    Name: InstructLabName
+    Description: InstructLabDescription
+    Filepath: InstructLabFilepath
+    VersionName: InstructLabVersionName
+    VersionDescription: InstructLabVersionDescription
+  Iris:
+    Name: "[Demo] iris-training"
+    Description: "[source code](https://github.com/opendatahub-io/data-science-pipelines/tree/master/samples/iris-sklearn) A simple pipeline to demonstrate a basic ML Training workflow"
+    Filepath: /samples/iris-pipeline-compiled.yaml
+    VersionName: "[Demo] iris-training"
 DSPO:
+  PlatformVersion: v1.2.3
   ApiServer:
     IncludeOwnerReference: false
diff --git a/controllers/testdata/declarative/case_2/deploy/cr.yaml b/controllers/testdata/declarative/case_2/deploy/cr.yaml
@@ -13,6 +13,9 @@ spec:
     argoDriverImage: argodriverimage:test2
     enableOauth: true
     enableSamplePipeline: true
+    managedPipelines:
+      instructLab:
+        state: Managed
     customServerConfigMap:
       name: testserverconfigmapdspa2
       key: testserverconfigmapkeydspa2
diff --git a/controllers/testdata/declarative/case_2/expected/created/apiserver_deployment.yaml b/controllers/testdata/declarative/case_2/expected/created/apiserver_deployment.yaml
@@ -16,6 +16,8 @@ spec:
       dspa: testdsp2
   template:
     metadata:
+      annotations:
+        configHash: 0a9567df0bc820e0007b6c626b514f8b6ec5cef0c7badd566e6d063e049a5394
       labels:
         dsp-version: v2
         app: ds-pipeline-testdsp2
diff --git a/controllers/testdata/declarative/case_2/expected/created/sample-config.yaml.tmpl b/controllers/testdata/declarative/case_2/expected/created/sample-config.yaml.tmpl
@@ -9,10 +9,4 @@ metadata:
         component: data-science-pipelines
 data:
     sample_config.json: |-
-        [
-          {
-            "name": "[Demo] iris-training",
-            "description": "[source code](https://github.com/opendatahub-io/data-science-pipelines/tree/master/samples/iris-sklearn) A simple pipeline to demonstrate a basic ML Training workflow",
-            "file": "/samples/iris-pipeline-compiled.yaml"
-          }
-        ]
+        {"loadSamplesOnRestart":true,"pipelines":[{"description":"InstructLabDescription","file":"InstructLabFilepath","name":"InstructLabName","versionDescription":"InstructLabVersionDescription","versionName":"InstructLabVersionName - v1.2.3"},{"description":"[source code](https://github.com/opendatahub-io/data-science-pipelines/tree/master/samples/iris-sklearn) A simple pipeline to demonstrate a basic ML Training workflow","file":"/samples/iris-pipeline-compiled.yaml","name":"[Demo] iris-training","versionDescription":"","versionName":"[Demo] iris-training - v1.2.3"}]}
diff --git a/controllers/testdata/declarative/case_3/config.yaml b/controllers/testdata/declarative/case_3/config.yaml
@@ -15,6 +15,18 @@ Images:
   RuntimeGeneric: runtimegeneric:test3
   Toolbox: toolbox:test3
   RHELAI: rhelai:test3
+ManagedPipelinesMetadata:
+  Instructlab:
+    Name: "[InstructLab] LLM Training Pipeline"
+    Description:
+    Filepath: /pipelines/instructlab.yaml
+    VersionName: "[InstructLab] LLM Training Pipeline"
+  Iris:
+    Name: "[Demo] iris-training"
+    Description: "[source code](https://github.com/opendatahub-io/data-science-pipelines/tree/master/samples/iris-sklearn) A simple pipeline to demonstrate a basic ML Training workflow"
+    Filepath: /samples/iris-pipeline-compiled.yaml
+    VersionName: "[Demo] iris-training"
 DSPO:
+  PlatformVersion: v0.0.0
   ApiServer:
     IncludeOwnerReference: false
diff --git a/controllers/testdata/declarative/case_3/expected/created/apiserver_deployment.yaml b/controllers/testdata/declarative/case_3/expected/created/apiserver_deployment.yaml
@@ -16,6 +16,8 @@ spec:
       dspa: testdsp3
   template:
     metadata:
+      annotations:
+        configHash: 9a8b56f5098a0d91d9db76d9c8b48e9872c0dbe71bcdc7f08f2c05bfe26c787f
       labels:
         dsp-version: v2
         app: ds-pipeline-testdsp3
@@ -133,6 +135,7 @@ spec:
           args:
             - --config=/config
             - -logtostderr=true
+            - --sampleconfig=/config/sample_config.json
           ports:
             - containerPort: 8888
               name: http
@@ -170,6 +173,11 @@ spec:
               subPath: config.json
             - mountPath: /config/managed-pipelines
               name: managed-pipelines
+            - mountPath: /config/sample_config.json
+              name: sample-config
+              subPath: sample_config.json
+            - mountPath: /samples/
+              name: sample-pipeline
           resources:
             requests:
               cpu: 250m
@@ -236,4 +244,12 @@ spec:
         - name: managed-pipelines
           emptyDir:
             sizeLimit: 10Mi
+        - configMap:
+            defaultMode: 420
+            name: sample-config-testdsp3
+          name: sample-config
+        - configMap:
+            defaultMode: 420
+            name: sample-pipeline-testdsp3
+          name: sample-pipeline
       serviceAccountName: ds-pipeline-testdsp3
diff --git a/controllers/testdata/declarative/case_4/config.yaml b/controllers/testdata/declarative/case_4/config.yaml
@@ -15,6 +15,18 @@ Images:
   RuntimeGeneric: runtimegeneric:test4
   Toolbox: toolbox:test4
   RHELAI: rhelai:test4
+ManagedPipelinesMetadata:
+  Instructlab:
+    Name: "[InstructLab] LLM Training Pipeline"
+    Description:
+    Filepath: /pipelines/instructlab.yaml
+    VersionName: "[InstructLab] LLM Training Pipeline"
+  Iris:
+    Name: "[Demo] iris-training"
+    Description: "[source code](https://github.com/opendatahub-io/data-science-pipelines/tree/master/samples/iris-sklearn) A simple pipeline to demonstrate a basic ML Training workflow"
+    Filepath: /samples/iris-pipeline-compiled.yaml
+    VersionName: "[Demo] iris-training"
 DSPO:
+  PlatformVersion: v0.0.0
   ApiServer:
     IncludeOwnerReference: false
diff --git a/controllers/testdata/declarative/case_4/expected/created/apiserver_deployment.yaml b/controllers/testdata/declarative/case_4/expected/created/apiserver_deployment.yaml
@@ -16,6 +16,8 @@ spec:
       dspa: testdsp4
   template:
     metadata:
+      annotations:
+        configHash: 9a8b56f5098a0d91d9db76d9c8b48e9872c0dbe71bcdc7f08f2c05bfe26c787f
       labels:
         dsp-version: v2
         app: ds-pipeline-testdsp4
@@ -133,6 +135,7 @@ spec:
           args:
             - --config=/config
             - -logtostderr=true
+            - --sampleconfig=/config/sample_config.json
           ports:
             - containerPort: 8888
               name: http
@@ -177,6 +180,11 @@ spec:
               subPath: config.json
             - mountPath: /config/managed-pipelines
               name: managed-pipelines
+            - mountPath: /config/sample_config.json
+              name: sample-config
+              subPath: sample_config.json
+            - mountPath: /samples/
+              name: sample-pipeline
         - name: oauth-proxy
           args:
             - --https-address=:8443
@@ -236,4 +244,12 @@ spec:
         - name: managed-pipelines
           emptyDir:
             sizeLimit: 10Mi
+        - configMap:
+            defaultMode: 420
+            name: sample-config-testdsp4
+          name: sample-config
+        - configMap:
+            defaultMode: 420
+            name: sample-pipeline-testdsp4
+          name: sample-pipeline
       serviceAccountName: ds-pipeline-testdsp4
diff --git a/controllers/testdata/declarative/case_5/config.yaml b/controllers/testdata/declarative/case_5/config.yaml
diff --git a/controllers/testdata/declarative/case_5/expected/created/apiserver_deployment.yaml b/controllers/testdata/declarative/case_5/expected/created/apiserver_deployment.yaml
diff --git a/controllers/testdata/declarative/case_6/config.yaml b/controllers/testdata/declarative/case_6/config.yaml
diff --git a/controllers/testdata/declarative/case_6/expected/created/apiserver_deployment.yaml b/controllers/testdata/declarative/case_6/expected/created/apiserver_deployment.yaml

Original file line number	Diff line number	Diff line change
`@@ -195,7 +195,7 @@ func createResourceRequirement(RequestsCPU resource.Quantity, RequestsMemory res`
`195`	`195`	`}`
`196`	`196`	`}`
`197`	`197`
`198`		`-func GetStringConfigOrError(configName string) (string, error) {`
	`198`	`+func GetStringConfig(configName string) (string, error) {`
`199`	`199`	`if !viper.IsSet(configName) {`
`200`	`200`	`return "", fmt.Errorf("value not set in config for configname %s", configName)`
`201`	`201`	`}`