Merge pull request #38 from screwdriver-cd/allow-descriptions

feat(423): Allow parsing of description in config-parser
screwdriver-cd · Jun 23, 2017 · 7356c74 · 7356c74
2 parents c58f973 + d7d2968
commit 7356c74
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 3 deletions.
diff --git a/lib/phase/flatten.js b/lib/phase/flatten.js
@@ -48,7 +48,7 @@ function flattenSharedIntoJobs(shared, jobs) {
         const oldJob = clone(jobs[jobName]);
 
         // Replace
-        ['image', 'matrix', 'steps', 'template'].forEach((key) => {
+        ['image', 'matrix', 'steps', 'template', 'description'].forEach((key) => {
             if (oldJob[key]) {
                 newJob[key] = oldJob[key];
             }

diff --git a/lib/phase/permutation.js b/lib/phase/permutation.js
@@ -22,16 +22,21 @@ module.exports = validatedDoc => (
                 annotations: Hoek.reach(doc, `jobs.${jobName}.annotations`, {
                     default: {}
                 }),
-                image: Hoek.reach(doc, `jobs.${jobName}.image`),
                 commands: Hoek.reach(doc, `jobs.${jobName}.commands`),
-                secrets: Hoek.reach(doc, `jobs.${jobName}.secrets`),
                 environment: Hoek.reach(doc, `jobs.${jobName}.environment`, {
                     default: {}
                 }),
+                image: Hoek.reach(doc, `jobs.${jobName}.image`),
+                secrets: Hoek.reach(doc, `jobs.${jobName}.secrets`),
                 settings: Hoek.reach(doc, `jobs.${jobName}.settings`, {
                     default: {}
                 })
             };
+
+            if (doc.jobs[jobName].description !== undefined) {
+                job.description = doc.jobs[jobName].description;
+            }
+
             const matrix = Hoek.reach(doc, `jobs.${jobName}.matrix`, {
                 default: {}
             });

diff --git a/test/data/basic-job-with-description.yaml b/test/data/basic-job-with-description.yaml
@@ -0,0 +1,9 @@
+shared:
+    image: node:4
+
+jobs:
+    main:
+        description: "This is a description"
+        steps:
+            - hello: "echo hi world"
+            - maybe: "which asdfzxcvasdfqwer1234"
diff --git a/test/index.test.js b/test/index.test.js
@@ -271,6 +271,15 @@ describe('config parser', () => {
                     assert.deepEqual(data, JSON.parse(loadData('pipeline-annotations.json')));
                 })
         );
+
+        it('allows a description key', () =>
+            parser(loadData('basic-job-with-description.yaml'))
+                .then((data) => {
+                    assert.isDefined(data.jobs.main[0].description);
+                    assert.equal(data.jobs.main[0].description,
+                        'This is a description');
+                })
+        );
     });
 
     describe('permutation', () => {