add validate command (#31)

* adding a validate command to help validate CODEOWNERS file

* fixing vuln in dev dependency

Author: jjmschofield

README.md

@@ -6,13 +6,12 @@
 A CLI tool for working with GitHub CODEOWNERS.
 
 Things it does:
-* Output who owns each file in your repo (ignoring files listed in `.gitignore`)
-* Output who owns a single file
-* Output ownership information at a specific git commit
-* Output ownership information of staged files
-* Outputs lots of lovely stats
-* Outputs handy formats for integrations (CSV and JSONL)
-* Validates that the provided owners are in the correct format for github
+* Calculate ownership stats
+* Find out who owns each and every file (ignoring files listed in `.gitignore`)
+* Find out who owns a single file
+* Find out who owns your staged files
+* Outputs in a bunch of script friendly handy formats for integrations (CSV and JSONL)
+* Validates that your CODEOWNERS file is valid
 
 ## Installation
 Install via npm globally then run
@@ -82,7 +81,7 @@ Usage: github-codeowners audit [options]
 list the owners for all files
 
 Options:
-  -d, --dir <dirPath>          path to VCS directory (default: "/Users/jjmschofield/projects/github/github-codeowners")
+  -d, --dir <dirPath>          path to VCS directory (default: "<current working directory>")
   -c, --codeowners <filePath>  path to codeowners file (default: "<dir>/.github/CODEOWNERS")
   -o, --output <outputFormat>  how to output format eg: simple, jsonl, csv (default: "simple")
   -u, --unloved                unowned files only (default: false)
@@ -152,6 +151,30 @@ Options:
   -h, --help                   output usage information
 ```
 
+### Validate
+Validates your CODEOWNERS file to find common mistakes, will throw on errors (such as malformed owners).
+```shell script
+$ cd <your awesome project> 
+$ github-codeowners validate
+Found duplicate rules [ 'some/duplicate/rule @octocat' ]
+Found rules which did not match any files [ 'some/non-existent/path @octocat' ]
+...
+```
+
+Full usage information:
+```shell script
+$ github-codeowners validate --help
+Usage: github-codeowners validate [options]
+
+Validates a CODOWNER file and files in dir
+
+Options:
+  -d, --dir <dirPath>          path to VCS directory (default: "<current working directory>")
+  -c, --codeowners <filePath>  path to codeowners file (default: "<dir>/.github/CODEOWNERS")
+  -r, --root <rootPath>        the root path to filter files by (default: "")
+  -h, --help                   output usage information
+```
+
 ## Output Formats
 Check `github-codeowners <command> --help` for support for a given command, however generally the following outputs are supported:
 * `simple` - tab delimited - terminal friendly output

package-lock.json

@@ -37,7 +37,7 @@
     "jest-junit": "^11.0.1",
     "ts-jest": "^26.1.3",
     "ts-node": "^8.6.2",
-    "tslint": "^6.0.0",
+    "tslint": "^6.1.3",
     "tslint-config-airbnb-base": "^0.3.0",
     "typescript": "^3.8.2",
     "uuid": "^8.2.0"

package.json

@@ -9,6 +9,7 @@ import { git } from './commands/git';
 import { log } from './lib/logger';
 
 import { OUTPUT_FORMAT } from './lib/writers/types';
+import { validate } from './commands/validate';
 
 commander.command('audit')
   .description('list the owners for all files')
@@ -35,6 +36,29 @@ commander.command('audit')
     }
   });
 
+commander.command('validate')
+  .description('Validates a CODOWNER file and files in dir')
+  .option('-d, --dir <dirPath>', 'path to VCS directory', process.cwd())
+  .option('-c, --codeowners <filePath>', 'path to codeowners file (default: "<dir>/.github/CODEOWNERS")')
+  .option('-r, --root <rootPath>', 'the root path to filter files by', '')
+  .action(async (options) => {
+    try {
+      if (!options.codeowners) {
+        options.codeowners = path.resolve(options.dir, '.github/CODEOWNERS');
+      }
+
+      if (options.root) {
+        options.dir = path.resolve(options.dir, options.root);
+      }
+
+      await validate(options);
+    } catch (error) {
+      log.error('failed to run validate command', error);
+      process.exit(1);
+    }
+  });
+
+
 commander.command('who <file>')
   .description('lists owners of a specific file')
   .option('-d, --dir <dirPath>', 'path to VCS directory', process.cwd())

src/cli.ts

@@ -0,0 +1,6 @@
+{
+  "files" : [
+    { "path": "valid.js" },
+    { "path": "duplicate-rule.js" }
+  ]
+}

src/commands/__fixtures__/validate/files.json

@@ -0,0 +1,16 @@
+import path from 'path';
+
+import { FixturePaths } from '../types';
+
+const paths: FixturePaths = {
+  files: path.resolve(__dirname, 'files.json'),
+  codeowners: path.resolve(__dirname, 'owners'),
+  gitignores: [],
+};
+
+export const invalidOwnerFixtures: FixturePaths = {
+  ...paths,
+  codeowners: path.resolve(__dirname, 'owners-invalid-format'),
+};
+
+export default paths;

src/commands/__fixtures__/validate/index.ts

@@ -0,0 +1,4 @@
+valid.js @some-owner
+duplicate-rule.js @some-owner
+file-does-not-exist.md @some-owner
+duplicate-rule.js @some-owner

src/commands/__fixtures__/validate/owners

@@ -0,0 +1 @@
+file-exists-duplicate-rule.md @valid-owner not-a-valid-owner

src/commands/__fixtures__/validate/owners-invalid-format

@@ -0,0 +1,9 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`validate when all owners are valid output the result of all validation checks: stderr 1`] = `
+"Found duplicate rules [ 'duplicate-rule.js @some-owner' ]
+Found rules which did not match any files [ 'file-does-not-exist.md @some-owner' ]
+"
+`;
+
+exports[`validate when all owners are valid output the result of all validation checks: stdout 1`] = `""`;

src/commands/__snapshots__/validate.test.int.ts.snap

@@ -0,0 +1,52 @@
+import { v4 as uuidv4 } from 'uuid';
+import fixtures, { invalidOwnerFixtures } from './__fixtures__/validate';
+import { generateProject } from './__fixtures__/project-builder.test.helper';
+
+import util from 'util';
+
+const exec = util.promisify(require('child_process').exec);
+
+describe('validate', () => {
+  describe('when all owners are valid', () => {
+    const testId = uuidv4();
+
+    let testDir = 'not set';
+
+    beforeAll(async () => {
+      testDir = await generateProject(testId, fixtures);
+      // tslint:disable-next-line:no-console
+      console.log(`test scratch dir: ${testDir}`);
+    });
+
+    const runCli = async (args: string) => {
+      return exec(`node  ../../../dist/cli.js ${args}`, { cwd: testDir });
+    };
+
+    it('output the result of all validation checks', async () => {
+      const { stdout, stderr } = await runCli('validate');
+      expect(stdout).toMatchSnapshot('stdout');
+      expect(stderr).toMatchSnapshot('stderr');
+    });
+  });
+
+
+  describe('when owners are invalid', () => {
+    const testId = uuidv4();
+
+    let testDir = 'not set';
+
+    beforeAll(async () => {
+      testDir = await generateProject(testId, invalidOwnerFixtures);
+      // tslint:disable-next-line:no-console
+      console.log(`test scratch dir: ${testDir}`);
+    });
+
+    const runCli = async (args: string) => {
+      return exec(`node  ../../../dist/cli.js ${args}`, { cwd: testDir });
+    };
+
+    it('should throw on invalid users', async () => {
+      await expect(() => runCli('validate')).rejects.toThrow();
+    });
+  });
+});