✨ Check review-state in build:wait

packages/cli-build/src/wait.js

@@ -36,6 +36,10 @@ export const wait = command('wait', {
     name: 'fail-on-changes',
     description: 'Exit with an error when diffs are found',
     short: 'f'
+  }, {
+    name: 'pass-if-approved',
+    description: "Doesn't exit with an error if the build is approved, regardless of if diffs are found.",
+    inclusive: ['fail-on-changes']
   }],
 
   examples: [
@@ -124,12 +128,12 @@ function failureMessage(type, {
 
 // Return true or false if a build is considered failing or not
 function isFailing({
-  attributes: { state, 'total-comparisons-diff': diffs } = {}
-} = {}, { failOnChanges }) {
+  attributes: { state, 'review-state': reviewState, 'total-comparisons-diff': diffs } = {}
+} = {}, { failOnChanges, passIfApproved }) {
   // not pending and not processing
   return state != null && state !== 'pending' && state !== 'processing' &&
     // not finished or finished with diffs
-    (state !== 'finished' || (failOnChanges && !!diffs));
+    (state !== 'finished' || (failOnChanges && !!diffs && !(passIfApproved && reviewState === 'approved')));
 }
 
 export default wait;

packages/cli-build/test/wait.test.js

@@ -133,6 +133,54 @@ describe('percy build:wait', () => {
     ]));
   });
 
+  it('errors on diffs if the pass-if-approved is on but diffs are unreviewed', async () => {
+    api.reply('/builds/123', () => [200, build({
+      'total-comparisons-diff': 16,
+      'review-state': 'unreviewed',
+      state: 'finished'
+    })]);
+
+    await expectAsync(wait(['--build=123', '-f', '--pass-if-approved'])).toBeRejected();
+
+    expect(logger.stderr).toEqual([]);
+    expect(logger.stdout).toEqual([
+      '[percy] Build #10 finished! https://percy.io/test/test/123',
+      '[percy] Found 16 changes'
+    ]);
+  });
+
+  it('errors on diffs if the pass-if-approved is on but diffs have changes requested', async () => {
+    api.reply('/builds/123', () => [200, build({
+      'total-comparisons-diff': 16,
+      'review-state': 'changes_requested',
+      state: 'finished'
+    })]);
+
+    await expectAsync(wait(['--build=123', '-f', '--pass-if-approved'])).toBeRejected();
+
+    expect(logger.stderr).toEqual([]);
+    expect(logger.stdout).toEqual([
+      '[percy] Build #10 finished! https://percy.io/test/test/123',
+      '[percy] Found 16 changes'
+    ]);
+  });
+
+  it('does not error on diffs if the review status is approved and pass-if-approved is on', async () => {
+    api.reply('/builds/123', () => [200, build({
+      'total-comparisons-diff': 16,
+      'review-state': 'approved',
+      state: 'finished'
+    })]);
+
+    await wait(['--build=123', '-f', '--pass-if-approved']);
+
+    expect(logger.stderr).toEqual([]);
+    expect(logger.stdout).toEqual(jasmine.arrayContaining([
+      '[percy] Build #10 finished! https://percy.io/test/test/123',
+      '[percy] Found 16 changes'
+    ]));
+  });
+
   it('does not error when diffs are not found', async () => {
     api.reply('/builds/123', () => [200, build({
       'total-comparisons-diff': 0,
@@ -272,5 +320,14 @@ describe('percy build:wait', () => {
         '[percy] Error: unrecognized_reason'
       ]));
     });
+
+    it('logs an error if --pass-if-approved is provided without --fail-on-changes', async () => {
+      await expectAsync(wait(['--build=123', '--pass-if-approved'])).toBeRejected();
+
+      expect(logger.stdout).toEqual([]);
+      expect(logger.stderr).toEqual(jasmine.arrayContaining([
+        "[percy] ParseError: Options must be used together: '--pass-if-approved', '-f, --fail-on-changes'"
+      ]));
+    });
   });
 });