fix(3106): Allow shared.requires for pipeline template yaml (#565)

screwdriver-cd · May 31, 2024 · 0530a47 · 0530a47
1 parent cc3244b
commit 0530a47
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 2 deletions.
diff --git a/config/base.js b/config/base.js
@@ -74,7 +74,8 @@ const SCHEMA_CONFIG_PRE_TEMPLATE_MERGE = Joi.object()
             then: Joi.object().keys({
                 image: Job.image,
                 environment: Job.environment,
-                settings: Job.settings
+                settings: Job.settings,
+                requires: Job.requires
             }),
             otherwise: SCHEMA_SHARED
         }),

diff --git a/test/config/base.test.js b/test/config/base.test.js
@@ -50,12 +50,18 @@ describe('config base', () => {
             assert.isNull(validate('config.base.pipelineTemplate.yaml', config.base.configBeforeMergingTemplate).error);
         });
 
-        it('if template is provided then unsupported fields are foridden', () => {
+        it('if template is provided then unsupported fields are forbidden', () => {
             assert.isNotNull(
                 validate('config.base.pipelineTemplate-forbidden.yaml', config.base.configBeforeMergingTemplate).error
             );
         });
 
+        it('if template is provided then allow user yaml to customize image, settings, environment, and requires', () => {
+            assert.isNull(
+                validate('config.base.pipelineTemplate-customized.yaml', config.base.configBeforeMergingTemplate).error
+            );
+        });
+
         it('if template is not provided then job is required', () => {
             assert.isNotNull(
                 validate('config.base.pipelineTemplate-invalid.yaml', config.base.configBeforeMergingTemplate).error

diff --git a/test/data/config.base.pipelineTemplate-customized.yaml b/test/data/config.base.pipelineTemplate-customized.yaml
@@ -0,0 +1,8 @@
+template: foo/bar@1.0.0
+shared:
+    image: node:20
+    environment:
+        FOO: user overwrite
+    settings:
+        email: foo@example.com
+    requires: ~commit
diff --git a/test/data/config.base.pipelineTemplate.yaml b/test/data/config.base.pipelineTemplate.yaml
@@ -5,6 +5,7 @@ shared:
         FOO: user overwrite
     settings:
         email: foo@example.com
+    requires: ~commit
 cache:
     pipeline: ["node_modules/", "~/.sbt"]
     event: ["target/generated-intermediate-resouce/*"]