Step bundle validation (#1034)

* Validate step bundle and with group's step list items' type * Test YAML step bundle and with group's step list validation * Test StepListValidation * Cleanup duplicated tests
bitrise-io · Jan 16, 2025 · 0bf9736 · 0bf9736
1 parent 30a149a
commit 0bf9736
Show file tree

Hide file tree

Showing 2 changed files with 237 additions and 0 deletions.
diff --git a/bitrise/util_test.go b/bitrise/util_test.go
@@ -305,3 +305,199 @@ workflows:
 	require.Error(t, err)
 	require.Equal(t, 0, len(warnings))
 }
+
+func TestConfigModelFromYAMLFileContent_StepListValidation(t *testing.T) {
+	tests := []struct {
+		name    string
+		config  string
+		wantErr string
+	}{
+		{
+			name: "Invalid bitrise.yml: step bundle in a step bundle's steps list",
+			config: `
+format_version: '11'
+default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
+step_bundles:
+  build: {}
+  test:
+    steps:
+    - bundle::build: {}`,
+			wantErr: "step bundle is not allowed in a step list",
+		},
+		{
+			name: "Invalid bitrise.yml: with group in a step bundle's steps list",
+			config: `
+format_version: '11'
+default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
+step_bundles:
+  test:
+    steps:
+    - with: {}`,
+			wantErr: "'with' group is not allowed in a step list",
+		},
+		{
+			name: "Invalid bitrise.yml: step bundle in a 'with' group's steps list",
+			config: `
+format_version: '11'
+default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
+services:
+  postgres:
+    image: postgres:13
+workflows:
+  primary:
+    steps:
+    - with:
+        services:
+        - postgres
+        steps:
+        - bundle::test: {}`,
+			wantErr: "step bundle is not allowed in a step list",
+		},
+		{
+			name: "Invalid bitrise.yml: with group in a 'with' group's steps list",
+			config: `
+format_version: '11'
+default_step_lib_source: https://github.com/bitrise-io/bitrise-steplib.git
+services:
+  postgres:
+    image: postgres:13
+workflows:
+  primary:
+    steps:
+    - with:
+        services:
+        - postgres
+        steps:
+        - with: {}`,
+			wantErr: "'with' group is not allowed in a step list",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			_, warns, err := ConfigModelFromFileContent([]byte(tt.config), false)
+			require.Equal(t, []string(nil), warns)
+			if tt.wantErr != "" {
+				require.EqualError(t, err, tt.wantErr)
+			} else {
+				require.NoError(t, err)
+			}
+		})
+	}
+}
+
+func TestConfigModelFromJSONFileContent_StepListValidation(t *testing.T) {
+	tests := []struct {
+		name    string
+		config  string
+		wantErr string
+	}{
+		{
+			name: "Invalid bitrise.yml: step bundle in a step bundle's steps list",
+			config: `{
+  "format_version": "11",
+  "default_step_lib_source": "https://github.com/bitrise-io/bitrise-steplib.git",
+  "step_bundles": {
+    "build": {},
+    "test": {
+      "steps": [
+        {
+          "bundle::build": {}
+        }
+      ]
+    }
+  }
+}`,
+			wantErr: "step bundle is not allowed in a step list",
+		},
+		{
+			name: "Invalid bitrise.yml: with group in a step bundle's steps list",
+			config: `{
+  "format_version": "11",
+  "default_step_lib_source": "https://github.com/bitrise-io/bitrise-steplib.git",
+  "step_bundles": {
+    "test": {
+      "steps": [
+        {
+          "with": {}
+        }
+      ]
+    }
+  }
+}`,
+			wantErr: "'with' group is not allowed in a step list",
+		},
+		{
+			name: "Invalid bitrise.yml: step bundle in a 'with' group's steps list",
+			config: `{
+  "format_version": "11",
+  "default_step_lib_source": "https://github.com/bitrise-io/bitrise-steplib.git",
+  "services": {
+    "postgres": {
+      "image": "postgres:13"
+    }
+  },
+  "workflows": {
+    "primary": {
+      "steps": [
+        {
+          "with": {
+            "services": [
+              "postgres"
+            ],
+            "steps": [
+              {
+                "bundle::test": {}
+              }
+            ]
+          }
+        }
+      ]
+    }
+  }
+}`,
+			wantErr: "step bundle is not allowed in a step list",
+		},
+		{
+			name: "Invalid bitrise.yml: with group in a 'with' group's steps list",
+			config: `{
+  "format_version": "11",
+  "default_step_lib_source": "https://github.com/bitrise-io/bitrise-steplib.git",
+  "services": {
+    "postgres": {
+      "image": "postgres:13"
+    }
+  },
+  "workflows": {
+    "primary": {
+      "steps": [
+        {
+          "with": {
+            "services": [
+              "postgres"
+            ],
+            "steps": [
+              {
+                "with": {}
+              }
+            ]
+          }
+        }
+      ]
+    }
+  }
+}`,
+			wantErr: "'with' group is not allowed in a step list",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			_, warns, err := ConfigModelFromFileContent([]byte(tt.config), true)
+			require.Equal(t, []string(nil), warns)
+			if tt.wantErr != "" {
+				require.EqualError(t, err, tt.wantErr)
+			} else {
+				require.NoError(t, err)
+			}
+		})
+	}
+}
diff --git a/models/models_methods.go b/models/models_methods.go
@@ -1306,6 +1306,47 @@ func (stepListItem *StepListItemModel) UnmarshalYAML(unmarshal func(interface{})
 	return nil
 }
 
+func (stepListStepItem *StepListStepItemModel) UnmarshalJSON(b []byte) error {
+	var raw map[string]stepmanModels.StepModel
+	if err := json.Unmarshal(b, &raw); err != nil {
+		return err
+	}
+
+	return stepListStepItem.fromRawStepListStepItem(raw)
+}
+
+func (stepListStepItem *StepListStepItemModel) UnmarshalYAML(unmarshal func(interface{}) error) error {
+	var raw map[string]stepmanModels.StepModel
+	if err := unmarshal(&raw); err != nil {
+		return err
+	}
+
+	return stepListStepItem.fromRawStepListStepItem(raw)
+}
+
+func (stepListStepItem *StepListStepItemModel) fromRawStepListStepItem(raw map[string]stepmanModels.StepModel) error {
+	var key string
+	for k := range raw {
+		key = k
+		break
+	}
+
+	// Only Steps are allowed
+	if key == StepListItemWithKey {
+		return errors.New("'with' group is not allowed in a step list")
+	}
+	if strings.HasPrefix(key, StepListItemStepBundleKeyPrefix) {
+		return errors.New("step bundle is not allowed in a step list")
+	}
+
+	*stepListStepItem = map[string]stepmanModels.StepModel{}
+	for k, v := range raw {
+		(*stepListStepItem)[k] = v
+	}
+
+	return nil
+}
+
 func (stepListStepItem *StepListStepItemModel) GetStepIDAndStep() (string, stepmanModels.StepModel, error) {
 	if stepListStepItem == nil {
 		return "", stepmanModels.StepModel{}, nil