Merge pull request #1049 from api3dao/validator-cli

Create validator CLI

.changeset/mean-bikes-relax.md

@@ -0,0 +1,5 @@
+---
+'@api3/airnode-validator': minor
+---
+
+Create validator CLI

.github/workflows/build-test.yml

@@ -193,12 +193,12 @@ jobs:
           type: ${{ job.status }}
           url: ${{ secrets.SLACK_WEBHOOK_URL }}
   e2e-tests:
-    name: E2E tests - admin and node
+    name: E2E tests - admin, node and validator
     runs-on: ubuntu-latest
     needs: build
     strategy:
       matrix:
-        package: [admin, node]
+        package: [admin, node, validator]
     steps:
       - uses: actions/cache@v2
         id: restore-build

package.json

@@ -76,6 +76,7 @@
     "test:e2e-admin": "cd packages/airnode-admin && yarn run test:e2e",
     "test:e2e-examples": "cd packages/airnode-examples && yarn run test:e2e",
     "test:e2e-node": "cd packages/airnode-node && yarn run test:e2e",
+    "test:e2e-validator": "cd packages/airnode-validator && yarn run test:e2e",
     "test:e2e-node:debug": "cd packages/airnode-node && yarn run test:e2e:debug",
     "test:protocol": "cd packages/airnode-protocol && yarn run test",
     "test:node": "(cd packages/airnode-node && yarn run test)",

packages/airnode-validator/bin/validator.ts

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 
-require('../src/commands/validateCmd');
+require('../src/cli');

packages/airnode-validator/jest.config.js

@@ -1,5 +1,20 @@
 const config = require('../../jest.config.base');
 
 module.exports = {
-  ...config,
+  projects: [
+    {
+      ...config,
+      // Add custom settings below
+      name: 'e2e',
+      displayName: 'e2e',
+      testMatch: ['**/?(*.)+(feature).[tj]s?(x)'],
+    },
+    {
+      ...config,
+      // Add custom settings below
+      displayName: 'unit',
+      name: 'unit',
+      testMatch: ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[tj]s?(x)'],
+    },
+  ],
 };

packages/airnode-validator/package.json

@@ -14,15 +14,19 @@
   "scripts": {
     "build": "yarn run clean && yarn run compile && copyfiles templates/**/** dist/ && copyfiles conversions/** dist/",
     "clean": "rimraf -rf ./dist *.tgz",
-    "cli:validator": "ts-node bin/validator.ts",
+    "cli": "ts-node bin/validator.ts",
     "compile": "tsc -p tsconfig.build.json",
     "pack": "yarn pack",
-    "test": "jest"
+    "test": "jest --selectProjects unit",
+    "test:e2e": "jest --selectProjects e2e",
+    "test:e2e:update-snapshot": "yarn test:e2e --updateSnapshot"
   },
   "dependencies": {
     "@api3/airnode-utilities": "^0.6.0",
+    "@api3/promise-utils": "^0.3.0",
     "dotenv": "^16.0.0",
     "lodash": "^4.17.21",
+    "ora": "^5.4.1",
     "yargs": "^17.0.1",
     "zod": "^3.11.6"
   },

packages/airnode-validator/src/cli/cli.test.ts

@@ -0,0 +1,64 @@
+import { join } from 'path';
+import * as cli from './cli';
+
+describe('validateConfiguration', () => {
+  let succeedSpy: any;
+  let failSpy: any;
+
+  const configPath = join(__dirname, '../../test/fixtures/valid-config.json');
+  const secretsPath = join(__dirname, '../../test/fixtures/valid-secrets.env');
+
+  beforeEach(() => {
+    succeedSpy = jest.spyOn(cli, 'succeed').mockImplementation(jest.fn());
+    failSpy = jest.spyOn(cli, 'fail').mockImplementation(jest.fn() as any);
+  });
+
+  describe('calls fail', () => {
+    it('when config file does not exist', () => {
+      cli.validateConfiguration('non-existent-config.json', secretsPath);
+
+      expect(failSpy).toHaveBeenCalledTimes(1);
+      expect(failSpy).toHaveBeenCalledWith(
+        expect.stringContaining(
+          'Unable to read config file at "non-existent-config.json". Reason: Error: Error: ENOENT: no such file or directory'
+        )
+      );
+    });
+
+    it('when secrets file does not exist', () => {
+      cli.validateConfiguration(configPath, 'non-existent-secrets.env');
+
+      expect(failSpy).toHaveBeenCalledTimes(1);
+      expect(failSpy).toHaveBeenCalledWith(
+        expect.stringContaining(
+          'Unable to read secrets file at "non-existent-secrets.env". Reason: Error: Error: ENOENT: no such file or directory'
+        )
+      );
+    });
+
+    it('when secrets have invalid format', () => {
+      cli.validateConfiguration(configPath, join(__dirname, '../../test/fixtures/invalid-secrets.env'));
+
+      expect(failSpy).toHaveBeenCalledTimes(1);
+      expect(failSpy).toHaveBeenCalledWith(
+        'The configuration is not valid. Reason: Error: Error interpolating secrets. Make sure the secrets format is correct'
+      );
+    });
+
+    it('when configuration is invalid', () => {
+      cli.validateConfiguration(configPath, join(__dirname, '../../test/fixtures/missing-secrets.env'));
+
+      expect(failSpy).toHaveBeenCalledTimes(1);
+      expect(failSpy).toHaveBeenCalledWith(
+        'The configuration is not valid. Reason: Error: Error interpolating secrets. Make sure the secrets format is correct'
+      );
+    });
+  });
+
+  it('calls success when for valid configuration', () => {
+    cli.validateConfiguration(configPath, secretsPath);
+
+    expect(succeedSpy).toHaveBeenCalledTimes(1);
+    expect(succeedSpy).toHaveBeenCalledWith('The configuration is valid');
+  });
+});

packages/airnode-validator/src/cli/cli.ts

@@ -0,0 +1,66 @@
+import path from 'path';
+import { readFileSync } from 'fs';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import { goSync } from '@api3/promise-utils';
+import ora from 'ora';
+import * as dotenv from 'dotenv';
+import { parseConfigWithSecrets } from '../api';
+
+export const succeed = (s: string) => ora(s).succeed();
+export const fail = (s: string) => {
+  ora(s).fail();
+  process.exit(1);
+};
+
+const examples = [
+  '--config pathTo/config.json --secrets pathTo/secrets.env',
+  '-c pathTo/config.json -s pathTo/secrets.env',
+];
+
+export const validateConfiguration = (configPath: string, secretsPath: string) => {
+  const goRawConfig = goSync(() => readFileSync(path.resolve(configPath), 'utf-8'));
+  if (!goRawConfig.success) return fail(`Unable to read config file at "${configPath}". Reason: ${goRawConfig.error}`);
+
+  const goConfig = goSync(() => JSON.parse(goRawConfig.data));
+  if (!goConfig.success) return fail(`The configuration is not a valid JSON.`);
+
+  const goRawSecrets = goSync(() => readFileSync(path.resolve(secretsPath), 'utf-8'));
+  if (!goRawSecrets.success) {
+    return fail(`Unable to read secrets file at "${secretsPath}". Reason: ${goRawSecrets.error}`);
+  }
+
+  const goSecrets = goSync(() => dotenv.parse(goRawSecrets.data));
+  if (!goSecrets.success) return fail(`The secrets have incorrect format.`);
+
+  const parseResult = parseConfigWithSecrets(goConfig.data, goSecrets.data);
+  if (!parseResult.success) return fail(`The configuration is not valid. Reason: ${parseResult.error}`);
+
+  return succeed('The configuration is valid');
+};
+
+export const cli = () => {
+  const cliArguments = yargs(hideBin(process.argv))
+    .option('config', {
+      description: 'Path to "config.json" file to validate',
+      alias: 'c',
+      type: 'string',
+      demandOption: true,
+    })
+    .option('secrets', {
+      description: 'Path to "secrets.env" file to interpolate in the config',
+      alias: 's',
+      type: 'string',
+      // Making the secrets file required. If the users do not use a secrets file they can pass any empty file. However,
+      // not passing a secrets file is not recommended and usually is a mistake.
+      demandOption: true,
+    })
+    .strict()
+    .help()
+    .wrap(120)
+    .example(examples.map((e) => [e]))
+    .parseSync();
+
+  const { config, secrets } = cliArguments;
+  validateConfiguration(config, secrets);
+};

packages/airnode-validator/src/cli/index.ts

@@ -0,0 +1,3 @@
+import { cli } from './cli';
+
+cli();

packages/airnode-validator/test/__snapshots__/cli.feature.ts.snap

@@ -0,0 +1,14 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`validator CLI shows help 1`] = `
+"Options:
+      --version  Show version number                                                                           [boolean]
+  -c, --config   Path to \\"config.json\\" file to validate                                              [string] [required]
+  -s, --secrets  Path to \\"secrets.env\\" file to interpolate in the config                             [string] [required]
+      --help     Show help                                                                                     [boolean]
+
+Examples:
+  --config pathTo/config.json --secrets pathTo/secrets.env
+  -c pathTo/config.json -s pathTo/secrets.env
+"
+`;

packages/airnode-validator/test/cli.feature.ts

@@ -0,0 +1,46 @@
+import { spawnSync } from 'child_process';
+import { join } from 'path';
+
+const runValidator = (args: string[]) => {
+  const command = ['node', join(__dirname, '../dist/bin/validator.js'), ...args].join(' ');
+
+  return spawnSync(command, { shell: true });
+};
+
+describe('validator CLI', () => {
+  it('shows help', () => {
+    const cliHelp = runValidator(['--help']).stdout.toString();
+
+    expect(cliHelp).toMatchSnapshot();
+  });
+
+  it('validates valid configuration', () => {
+    const args = [
+      `--config ${join(__dirname, './fixtures/valid-config.json')}`,
+      `--secrets ${join(__dirname, './fixtures/valid-secrets.env')}`,
+    ];
+
+    const output = runValidator(args);
+
+    expect(output.status).toBe(0);
+    // We use "expect.stringContaining" because the output begins with "✔"
+    expect(output.stderr.toString()).toEqual(expect.stringContaining('The configuration is valid\n'));
+  });
+
+  it('validates invalid configuration', () => {
+    const args = [
+      `--config ${join(__dirname, './fixtures/valid-config.json')}`,
+      `--secrets ${join(__dirname, './fixtures/missing-secrets.env')}`,
+    ];
+
+    const output = runValidator(args);
+
+    expect(output.status).toBe(1);
+    expect(output.stderr.toString()).toEqual(
+      // We use "expect.stringContaining" because the output begins with "✖"
+      expect.stringContaining(
+        'The configuration is not valid. Reason: Error: Error interpolating secrets. Make sure the secrets format is correct\n'
+      )
+    );
+  });
+});

packages/airnode-validator/test/fixtures/invalid-secrets.env

@@ -0,0 +1,4 @@
+{
+  "key1": "value1",
+  "key2": "value2"
+}

packages/airnode-validator/test/fixtures/missing-secrets.env

@@ -0,0 +1 @@
+AIRNODE_WALLET_MNEMONIC=tube spin artefact salad slab lumber foot bitter wash reward vote cook