feat(cli): add failureLabels to healthcheck (#99)

Author: patrickhulce

packages/cli/src/healthcheck/healthcheck.js

@@ -34,16 +34,18 @@ function buildCommand(yargs) {
   });
 }
 
-/** @type {Array<{id?: string, label: string, test: (opts: LHCI.YargsOptions) => Promise<boolean>|boolean, shouldTest: (opts: LHCI.YargsOptions) => boolean}>} */
+/** @type {Array<{id?: string, label: string, failureLabel: string, test: (opts: LHCI.YargsOptions) => Promise<boolean>|boolean, shouldTest: (opts: LHCI.YargsOptions) => boolean}>} */
 const checks = [
   {
     label: '.lighthouseci/ directory writable',
+    failureLabel: '.lighthouseci/ directory not writable',
     shouldTest: () => true,
     test: () => loadSavedLHRs().length >= 0,
   },
   {
     id: 'rcFile',
     label: 'Configuration file found',
+    failureLabel: 'Configuration file not found',
     shouldTest: () => true,
     test: opts => {
       const rcFile = resolveRcFilePath(opts.config);
@@ -54,20 +56,23 @@ const checks = [
   {
     id: 'githubToken',
     label: 'GitHub token set',
+    failureLabel: 'GitHub token not set',
     // the test only makes sense if they've configured an upload target of some sort
     shouldTest: opts => !!opts.target || !!opts.serverBaseUrl,
     test: opts => Boolean(opts.githubToken || opts.githubAppToken),
   },
   {
     id: 'lhciServer',
     label: 'Ancestor hash determinable',
+    failureLabel: 'Ancestor hash not determinable',
     // the test only makes sense if they've configured an LHCI server
     shouldTest: opts => Boolean(opts.serverBaseUrl && opts.token),
     test: () => getAncestorHash().length > 0,
   },
   {
     id: 'lhciServer',
     label: 'LHCI server reachable',
+    failureLabel: 'LHCI server not reachable',
     // the test only makes sense if they've configured an LHCI server
     shouldTest: opts => Boolean(opts.serverBaseUrl && opts.token),
     test: async ({serverBaseUrl = ''}) =>
@@ -76,6 +81,7 @@ const checks = [
   {
     id: 'lhciServer',
     label: 'LHCI server token valid',
+    failureLabel: 'LHCI server token invalid',
     // the test only makes sense if they've configured an LHCI server
     shouldTest: opts => Boolean(opts.serverBaseUrl && opts.token),
     test: async ({serverBaseUrl = '', token = ''}) => {
@@ -87,6 +93,7 @@ const checks = [
   {
     id: 'lhciServer',
     label: 'LHCI server unique build for this hash',
+    failureLabel: 'LHCI server non-unique build for this hash',
     // the test only makes sense if they've configured an LHCI server
     shouldTest: opts => Boolean(opts.serverBaseUrl && opts.token),
     test: async ({serverBaseUrl = '', token = ''}) => {
@@ -124,8 +131,9 @@ async function runCommand(options) {
 
     const isWarn = !!check.id && !checkIdsToRun.includes(check.id);
     const icon = result ? PASS_ICON : isWarn ? WARN_ICON : FAIL_ICON;
+    const label = result ? check.label : check.failureLabel;
     allPassed = allPassed && (isWarn || result);
-    process.stdout.write(`${icon}  ${check.label}${message}\n`);
+    process.stdout.write(`${icon}  ${label}${message}\n`);
   }
 
   if (allPassed) {

packages/cli/test/autorun-start-server.test.js

@@ -28,7 +28,7 @@ describe('Lighthouse CI autorun CLI with startServerCommand', () => {
 
     expect(stdout).toMatchInlineSnapshot(`
       "✅  .lighthouseci/ directory writable
-      ⚠️   Configuration file found
+      ⚠️   Configuration file not found
       Healthcheck passed!
 
       Started a web server with \\"node autorun-server.js\\"...

packages/cli/test/autorun-static-dir.test.js

@@ -25,7 +25,7 @@ describe('Lighthouse CI autorun CLI', () => {
     expect(stdoutClean).toMatchInlineSnapshot(`
       "✅  .lighthouseci/ directory writable
       ✅  Configuration file found
-      ⚠️   GitHub token set
+      ⚠️   GitHub token not set
       Healthcheck passed!
 
       Automatically determined ./build as \`staticDistDir\`.

packages/cli/test/cli.test.js

@@ -109,8 +109,8 @@ describe('Lighthouse CI CLI', () => {
 
       expect(stdout).toMatchInlineSnapshot(`
         "✅  .lighthouseci/ directory writable
-        ⚠️   Configuration file found
-        ⚠️   GitHub token set
+        ⚠️   Configuration file not found
+        ⚠️   GitHub token not set
         ✅  Ancestor hash determinable
         ✅  LHCI server reachable
         ✅  LHCI server token valid
@@ -133,7 +133,7 @@ describe('Lighthouse CI CLI', () => {
       expect(stdout).toMatchInlineSnapshot(`
         "✅  .lighthouseci/ directory writable
         ✅  Configuration file found
-        ❌  GitHub token set
+        ❌  GitHub token not set
         ✅  Ancestor hash determinable
         ✅  LHCI server reachable
         ✅  LHCI server token valid

packages/cli/test/healthcheck.test.js

@@ -21,7 +21,7 @@ describe('Lighthouse CI healthcheck CLI', () => {
       expect(stdout).toMatchInlineSnapshot(`
         "✅  .lighthouseci/ directory writable
         ✅  Configuration file found
-        ⚠️   GitHub token set
+        ⚠️   GitHub token not set
         Healthcheck passed!
         "
       `);
@@ -38,7 +38,7 @@ describe('Lighthouse CI healthcheck CLI', () => {
       expect(stdout).toMatchInlineSnapshot(`
         "✅  .lighthouseci/ directory writable
         ✅  Configuration file found
-        ⚠️   GitHub token set
+        ⚠️   GitHub token not set
         Healthcheck passed!
         "
       `);
@@ -54,7 +54,7 @@ describe('Lighthouse CI healthcheck CLI', () => {
       expect(status).toEqual(0);
       expect(stdout).toMatchInlineSnapshot(`
         "✅  .lighthouseci/ directory writable
-        ⚠️   Configuration file found
+        ⚠️   Configuration file not found
         Healthcheck passed!
         "
       `);
@@ -70,7 +70,7 @@ describe('Lighthouse CI healthcheck CLI', () => {
       expect(status).toEqual(0);
       expect(stdout).toMatchInlineSnapshot(`
         "✅  .lighthouseci/ directory writable
-        ⚠️   Configuration file found
+        ⚠️   Configuration file not found
         Healthcheck passed!
         "
       `);
@@ -86,7 +86,7 @@ describe('Lighthouse CI healthcheck CLI', () => {
       expect(status).toEqual(0);
       expect(stdout).toMatchInlineSnapshot(`
         "✅  .lighthouseci/ directory writable
-        ⚠️   Configuration file found
+        ⚠️   Configuration file not found
         Healthcheck passed!
         "
       `);