fix(workflow-result): merge existing needs with verify jobs instead of replacing

Author: travi

src/jobs/workflow-result/lifter.js

@@ -1,5 +1,7 @@
-export default function (job, {jobs}) {
+export default function liftWorkflowResult(job, {jobs}) {
   if (!Object.keys(jobs).includes('verify-matrix')) return job;
 
-  return {...job, needs: ['verify', 'verify-matrix']};
+  const requiredNeeds = ['verify', 'verify-matrix'];
+
+  return {...job, needs: [...new Set([...job.needs || [], ...requiredNeeds])]};
 }

src/jobs/workflow-result/lifter.test.js

@@ -10,10 +10,24 @@ describe('workflow-result job lifter', () => {
     expect(liftWorkflowResultJob(existingJobDetails, {jobs: any.simpleObject()})).toEqual(existingJobDetails);
   });
 
-  it('should make the job depend on the `verify-matrix` job if it exists', () => {
+  it('should include the required dependencies if no existing needs are defined', () => {
     expect(liftWorkflowResultJob(
       existingJobDetails,
-      {jobs: {...any.simpleObject(), 'verify-matrix': any.simpleObject()}}
+      {jobs: {'verify-matrix': {}}}
     )).toEqual({...existingJobDetails, needs: ['verify', 'verify-matrix']});
   });
+
+  it('should update scaffolded needs to include verify-matrix', () => {
+    expect(liftWorkflowResultJob(
+      {...existingJobDetails, needs: ['verify']},
+      {jobs: {'verify-matrix': {}}}
+    )).toEqual({...existingJobDetails, needs: ['verify', 'verify-matrix']});
+  });
+
+  it('should keep existing needs and append missing required dependencies', () => {
+    expect(liftWorkflowResultJob(
+      {...existingJobDetails, needs: ['existing-dependency']},
+      {jobs: {'verify-matrix': {}}}
+    )).toEqual({...existingJobDetails, needs: ['existing-dependency', 'verify', 'verify-matrix']});
+  });
 });

test/integration/features/lift/result.feature

@@ -7,6 +7,14 @@ Feature: Overall Workflow Result
     Then the workflow-result job exists
     And the "workflow-result" job is unchanged
 
+  Scenario: Existing result job with existing matrix job
+    Given a CI workflow exists
+    And a "verify-matrix" job exists
+    And a "workflow-result" job exists
+    When the project is lifted
+    Then the workflow-result job exists
+    And the workflow-result job keeps its existing needs and includes required dependencies
+
   Scenario: No existing result job, existing verify
     Given a CI workflow exists
     And a "verify" job exists

test/integration/features/step_definitions/ci-steps.js

@@ -38,7 +38,7 @@ Given('a CI workflow exists', async function () {
 
 Given('a {string} job exists', async function (jobName) {
   const existingWorkflowContents = await loadWorkflowFile({projectRoot: this.projectRoot, name: ciWorkflowName});
-  const job = any.simpleObject();
+  const job = {...any.simpleObject(), needs: any.listOf(any.word)};
 
   this.injectedJobs[jobName] = job;
 
@@ -113,6 +113,15 @@ Then('the {string} job is unchanged', async function (jobName) {
   const {jobs} = await loadWorkflowFile({projectRoot: this.projectRoot, name: ciWorkflowName});
 
   assert.deepEqual(jobs[jobName], this.injectedJobs[jobName]);
+  assert.deepEqual(jobs[jobName].needs, this.injectedJobs[jobName].needs);
+});
+
+Then('the workflow-result job keeps its existing needs and includes required dependencies', async function () {
+  const {jobs} = await loadWorkflowFile({projectRoot: this.projectRoot, name: ciWorkflowName});
+  const resultJob = jobs['workflow-result'];
+
+  assert.includeMembers(resultJob.needs, this.injectedJobs['workflow-result'].needs);
+  assert.includeMembers(resultJob.needs, ['verify', 'verify-matrix']);
 });
 
 Then('the workflow-result job depends on {string}', async function (jobName) {