feat: Add healthcheck command

.circleci/config.yml

@@ -12,7 +12,7 @@ jobs:
       - checkout
       - restore_cache: &restore_cache
           keys:
-            - v1-yarn-{{checksum ".circleci/config.yml"}}-{{ checksum "yarn.lock"}}
+            - v1-yarn-{{checksum ".circleci/config.yml"}}-{{ checksum "package-lock.json"}}
             - v1-yarn-{{checksum ".circleci/config.yml"}}
       - run: .circleci/greenkeeper
       - run: yarn add -D nyc@11 @oclif/nyc-config@1 mocha-junit-reporter@1

src/commands/health-check.ts

@@ -0,0 +1,37 @@
+import {flags} from '@oclif/command'
+import * as colors from 'colors'
+import Constants from '../services/constants'
+import healthCheck from '../utils/health-checker'
+import PercyCommand from './percy-command'
+
+export default class HealthCheck extends PercyCommand {
+  static description = 'Determins if the Percy Agent process is currently running'
+  static hidden = true
+
+  static flags = {
+    port: flags.integer({
+      char: 'p',
+      default: Constants.PORT,
+      description: 'port',
+    }),
+  }
+
+  static examples = [
+    '$ percy healthcheck',
+    '$ percy healthcheck --port 6884',
+  ]
+
+  async run() {
+    await super.run()
+
+    // If Percy is disabled or is missing a token, gracefully exit here
+    if (!this.percyWillRun()) { this.exit(0) }
+
+    const {flags} = this.parse(HealthCheck)
+    const port = flags.port as number
+
+    await healthCheck(port, {
+      shouldRetry: () => false,
+    })
+  }
+}

src/utils/health-checker.ts

@@ -2,13 +2,14 @@ import Axios from 'axios'
 import * as retryAxios from 'retry-axios'
 import logger from './logger'
 
-async function healthCheck(port: number) {
+async function healthCheck(port: number, retryOptions?: object) {
   const healthcheckUrl = `http://localhost:${port}/percy/healthcheck`
 
   const retryConfig = {
     retry: 5, // with exponential back off
     retryDelay: 500,
     shouldRetry: () => true,
+    ...retryOptions,
   }
 
   const interceptorId = retryAxios.attach()

test/commands/health-check.test.ts

@@ -0,0 +1,52 @@
+import * as chai from 'chai'
+import {describe} from 'mocha'
+import * as nock from 'nock'
+import HealthCheck from '../../src/commands/health-check'
+import {captureStdErr, captureStdOut} from '../helpers/stdout'
+
+const expect = chai.expect
+
+describe('Health check', () => {
+  describe('when agent is running', () => {
+    beforeEach(() => {
+      nock(/localhost/).get('/percy/healthcheck').reply(200)
+    })
+
+    afterEach(() => {
+      nock.cleanAll()
+    })
+
+    it('messages that agent is ready', async () => {
+      const stdout = await captureStdOut(async () => HealthCheck.run([]))
+
+      expect(stdout).to.contain('[percy] percy is ready.')
+    })
+  })
+
+  describe('when agent is not running', () => {
+    beforeEach(() => {
+      nock(/localhost/).get('/percy/healthcheck').reply(500)
+    })
+
+    afterEach(() => {
+      nock.cleanAll()
+    })
+
+    it('messages that agent is not ready', async () => {
+      const errorStdout = await captureStdErr(async () => HealthCheck.run([]))
+
+      expect(errorStdout).to
+        .contain('[percy] Failed to establish a connection with http://localhost:5338/percy/healthcheck')
+    })
+
+    it('properly passes the port', async () => {
+      const port = '5899'
+      const errorStdout = await captureStdErr(async () =>
+        HealthCheck.run(['--port', port]),
+      )
+
+      expect(errorStdout).to
+        .contain('[percy] Failed to establish a connection with http://localhost:5899/percy/healthcheck')
+    })
+  })
+})