Notify about dynamic plugin's file name constraints. (#381)

* fail recncilation if dynamic-plugins file name is not "dynamic-plugins.yaml" Signed-off-by: gazarenkov <gazarenkov@gmail.com> * fail recncilation if dynamic-plugins file name is not "dynamic-plugins.yaml" Signed-off-by: gazarenkov <gazarenkov@gmail.com> --------- Signed-off-by: gazarenkov <gazarenkov@gmail.com>
janus-idp · Jun 5, 2024 · 0d3ded3 · 0d3ded3
1 parent e1d4a99
commit 0d3ded3
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 4 deletions.
diff --git a/pkg/model/dynamic-plugins.go b/pkg/model/dynamic-plugins.go
@@ -55,10 +55,15 @@ func addDynamicPlugins(spec v1alpha1.BackstageSpec, deployment *appsv1.Deploymen
 	}
 
 	if _, ic := DynamicPluginsInitContainer(deployment.Spec.Template.Spec.InitContainers); ic == nil {
-		return fmt.Errorf("deployment validation failed, dynamic plugin name configured but no InitContainer %s defined", dynamicPluginInitContainerName)
+		return fmt.Errorf("validation failed, dynamic plugin name configured but no InitContainer %s defined", dynamicPluginInitContainerName)
 	}
 
 	dp := DynamicPlugins{ConfigMap: &model.ExternalConfig.DynamicPlugins}
+
+	if dp.ConfigMap.Data == nil || len(dp.ConfigMap.Data) != 1 || dp.ConfigMap.Data[DynamicPluginsFile] == "" {
+		return fmt.Errorf("dynamic plugin configMap expects exactly one key named '%s' ", DynamicPluginsFile)
+	}
+
 	dp.updatePod(deployment)
 	return nil
 

diff --git a/pkg/model/dynamic-plugins_test.go b/pkg/model/dynamic-plugins_test.go
@@ -56,7 +56,28 @@ func TestDynamicPluginsValidationFailed(t *testing.T) {
 
 }
 
-// Janus pecific test
+func TestDynamicPluginsInvalidKeyName(t *testing.T) {
+	bs := testDynamicPluginsBackstage.DeepCopy()
+
+	bs.Spec.Application.DynamicPluginsConfigMapName = "dplugin"
+
+	testObj := createBackstageTest(*bs).withDefaultConfig(true).
+		addToDefaultConfig("dynamic-plugins.yaml", "raw-dynamic-plugins.yaml").
+		addToDefaultConfig("deployment.yaml", "janus-deployment.yaml")
+
+	testObj.externalConfig.DynamicPlugins = corev1.ConfigMap{
+		ObjectMeta: metav1.ObjectMeta{Name: "dplugin"},
+		Data:       map[string]string{"WrongKeyName.yml": "tt"},
+	}
+
+	_, err := InitObjects(context.TODO(), *bs, testObj.externalConfig, true, false, testObj.scheme)
+
+	assert.Error(t, err)
+	assert.Contains(t, err.Error(), "expects exactly one key named 'dynamic-plugins.yaml'")
+
+}
+
+// Janus specific test
 func TestDefaultDynamicPlugins(t *testing.T) {
 
 	bs := testDynamicPluginsBackstage.DeepCopy()
@@ -92,7 +113,10 @@ func TestDefaultAndSpecifiedDynamicPlugins(t *testing.T) {
 		addToDefaultConfig("dynamic-plugins.yaml", "raw-dynamic-plugins.yaml").
 		addToDefaultConfig("deployment.yaml", "janus-deployment.yaml")
 
-	testObj.externalConfig.DynamicPlugins = corev1.ConfigMap{ObjectMeta: metav1.ObjectMeta{Name: "dplugin"}}
+	testObj.externalConfig.DynamicPlugins = corev1.ConfigMap{
+		ObjectMeta: metav1.ObjectMeta{Name: "dplugin"},
+		Data:       map[string]string{DynamicPluginsFile: "tt"},
+	}
 
 	model, err := InitObjects(context.TODO(), *bs, testObj.externalConfig, true, false, testObj.scheme)
 
@@ -106,7 +130,6 @@ func TestDefaultAndSpecifiedDynamicPlugins(t *testing.T) {
 	//vol-dplugin
 	assert.Equal(t, 3, len(ic.VolumeMounts))
 	assert.Equal(t, utils.GenerateVolumeNameFromCmOrSecret("dplugin"), ic.VolumeMounts[2].Name)
-	//t.Log(">>>>>>>>>>>>>>>>", ic.VolumeMounts)
 }
 
 func TestDynamicPluginsFailOnArbitraryDepl(t *testing.T) {