feat: allow sourcePaths with pipeline template (#182)

Author: y-oksaku

lib/phase/merge.js

@@ -4,7 +4,14 @@ const Hoek = require('@hapi/hoek');
 const clone = require('clone');
 const TEMPLATE_NAME_REGEX_WITH_NAMESPACE =
     require('screwdriver-data-schema').config.regex.FULL_TEMPLATE_NAME_WITH_NAMESPACE;
-const ALLOWED_JOB_FIELDS_WITH_PIPELINE_TEMPLATE = ['settings', 'requires', 'image', 'environment', 'annotations'];
+const ALLOWED_JOB_FIELDS_WITH_PIPELINE_TEMPLATE = [
+    'settings',
+    'requires',
+    'image',
+    'environment',
+    'annotations',
+    'sourcePaths'
+];
 const { merge } = require('./flatten');
 
 /**
@@ -117,6 +124,13 @@ function handlePipelineTemplateMergeForJobs(parsedDoc, newPipeline, pipelineTemp
                     };
                 }
 
+                // Merge job sourcePaths
+                if (oldJob.sourcePaths || newJob.sourcePaths) {
+                    newJob.sourcePaths = Array.from(
+                        new Set([...(newJob.sourcePaths || []), ...(oldJob.sourcePaths || [])])
+                    );
+                }
+
                 // Merge settings
                 // Replace settings if empty object
                 if (Hoek.deepEqual(oldJob.settings, {})) {
@@ -303,6 +317,10 @@ function mergeConfig(parsedDoc, pipelineTemplate) {
         newPipeline.shared.image = yamlSharedConfig.image;
     }
 
+    if (yamlSharedConfig.sourcePaths) {
+        newPipeline.shared.sourcePaths = yamlSharedConfig.sourcePaths;
+    }
+
     newPipeline.templateVersionId = pipelineTemplate.id;
 
     return newPipeline;

test/data/pipeline-template-basic-result.json

@@ -26,7 +26,8 @@
             "requires": [
                 "~pr",
                 "~commit"
-            ]
+            ],
+            "sourcePaths": ["pipeline-template"]
         }]
     },
     "workflowGraph": {

test/data/pipeline-template-with-customized-job-result.json

@@ -73,7 +73,8 @@
                     "room_a"
                 ]
             },
-            "requires": []
+            "requires": [],
+            "sourcePaths": ["pipeline-template", "job"]
         }],
         "job1": [{
             "annotations": {

test/data/pipeline-template-with-customized-job.yaml

@@ -7,6 +7,7 @@ jobs:
         environment:
             BAR: baz
         requires: []
+        sourcePaths: ["job"]
     job1:
         image: node:10
         settings:

test/data/pipeline-template-with-new-customized-job-result.json

@@ -74,7 +74,8 @@
                     "room_a"
                 ]
             },
-            "requires": []
+            "requires": [],
+            "sourcePaths": ["pipeline-template"]
         }],
         "job1": [{
             "annotations": {

test/data/pipeline-template-with-pipeline-setting-result.json

@@ -84,7 +84,8 @@
             "requires": [
                 "~pr",
                 "~commit"
-            ]
+            ],
+            "sourcePaths": ["pipeline-template"]
         }],
         "job1": [{
             "annotations": {

test/data/pipeline-template-with-shared-setting-result.json

@@ -32,7 +32,8 @@
             "requires": [
                 "~pr",
                 "~commit"
-            ]
+            ],
+            "sourcePaths": ["shared", "pipeline-template"]
         }]
     },
     "workflowGraph": {

test/data/pipeline-template-with-shared-setting.json

@@ -36,7 +36,8 @@
             ],
             "minimized": true
           }
-        }
+        },
+        "sourcePaths": ["pipeline-template"]
       }
     }
   },

test/data/pipeline-template-with-shared-setting.yaml

@@ -8,3 +8,4 @@ shared:
         slack:
           channels:
             - test
+    sourcePaths: [ "shared" ]

test/data/pipeline-template-with-template-setting-result.json

@@ -83,7 +83,8 @@
         "requires": [
           "~pr",
           "~commit"
-        ]
+        ],
+        "sourcePaths": ["pipeline-template"]
       }
     ],
     "job1": [{