Merge pull request #1191 from ing-bank/fix/passGlobsViaCli

fix(providence-analytics): pass globs via cli

.changeset/proud-waves-kick.md

@@ -0,0 +1,5 @@
+---
+'providence-analytics': patch
+---
+
+- allowlist does not preprocess globs in cli before handing them over to the program

packages-node/providence-analytics/src/cli/cli.js

@@ -175,13 +175,13 @@ async function cli({ cwd } = {}) {
       v => cliHelpers.pathsArrayFromCs(v, cwd),
       InputDataService.referenceProjectPaths,
     )
-    .option('-a, --allowlist [allowlist]', `allowlisted paths, like './src, ./packages/*'`, v =>
+    .option('-a, --allowlist [allowlist]', `allowlisted paths, like 'src/**/*, packages/**/*'`, v =>
-      cliHelpers.pathsArrayFromCs(v, cwd),
+      cliHelpers.csToArray(v, cwd),
     )
     .option(
       '--allowlist-reference [allowlist-reference]',
-      `allowed paths for reference, like './src, ./packages/*'`,
+      `allowed paths for reference, like 'src/**/*, packages/**/*'`,
-      v => cliHelpers.pathsArrayFromCs(v, cwd),
+      v => cliHelpers.csToArray(v, cwd),
     )
     .option(
       '--search-target-collection [collection-name]',

packages-node/providence-analytics/test-node/cli/cli.test.js

@@ -52,7 +52,10 @@ const externalCfgMock = {
 };
 
 async function runCli(args, cwd) {
-  process.argv = [...process.argv.slice(0, 2), ...args.split(' ')];
+  process.argv = [
+    ...process.argv.slice(0, 2),
+    ...args.split(' ').map(a => a.replace(/^("|')?(.*)("|')?$/, '$2')),
+  ];
   await cli({ cwd });
 }
 
@@ -231,27 +234,26 @@ describe('Providence CLI', () => {
     });
 
     it('"-a --allowlist"', async () => {
-      await runCli(`${analyzeCmd} -a /mocked/path/example-project`, rootDir);
+      await runCli(`${analyzeCmd} -a mocked/**/*,rocked/*`, rootDir);
-      expect(pathsArrayFromCsStub.args[0][0]).to.equal('/mocked/path/example-project');
       expect(providenceStub.args[0][1].gatherFilesConfig.allowlist).to.eql([
-        '/mocked/path/example-project',
+        'mocked/**/*',
+        'rocked/*',
       ]);
 
-      pathsArrayFromCsStub.resetHistory();
       providenceStub.resetHistory();
 
-      await runCli(`${analyzeCmd} --allowlist /mocked/path/example-project`, rootDir);
+      await runCli(`${analyzeCmd} --allowlist mocked/**/*,rocked/*`, rootDir);
-      expect(pathsArrayFromCsStub.args[0][0]).to.equal('/mocked/path/example-project');
       expect(providenceStub.args[0][1].gatherFilesConfig.allowlist).to.eql([
-        '/mocked/path/example-project',
+        'mocked/**/*',
+        'rocked/*',
       ]);
     });
 
     it('"--allowlist-reference"', async () => {
-      await runCli(`${analyzeCmd} --allowlist-reference /mocked/path/example-project`, rootDir);
+      await runCli(`${analyzeCmd} --allowlist-reference mocked/**/*,rocked/*`, rootDir);
-      expect(pathsArrayFromCsStub.args[0][0]).to.equal('/mocked/path/example-project');
       expect(providenceStub.args[0][1].gatherFilesConfigReference.allowlist).to.eql([
-        '/mocked/path/example-project',
+        'mocked/**/*',
+        'rocked/*',
       ]);
     });
 
@@ -383,8 +385,8 @@ describe('Providence CLI', () => {
           },
           outputFolder: '/outp',
           extensions: ['.bla'],
-          allowlist: [`${rootDir}/al`],
+          allowlist: ['al'],
-          allowlistReference: [`${rootDir}/alr`],
+          allowlistReference: ['alr'],
           cwd: undefined,
         });
       });

packages-node/providence-analytics/test-node/program/services/InputDataService.test.js

@@ -197,6 +197,14 @@ describe('InputDataService', () => {
         ]);
       });
 
+      it('does not support non globs in "allowlist"', async () => {
+        const globOutput = InputDataService.gatherFilesFromDir('/fictional/project', {
+          extensions: ['.html', '.js'],
+          allowlist: ['nested'],
+        });
+        expect(globOutput).to.eql([]);
+      });
+
       it('omits node_modules and bower_components at root level by default', async () => {
         mockProject({
           './index.js': '',
@@ -229,6 +237,23 @@ describe('InputDataService', () => {
         ]);
       });
 
+      it('allows deeper globs', async () => {
+        mockProject({
+          './root-lvl.js': '',
+          './deeper/glob/structure/file.js': '',
+          './deeper/glob/file.js': '',
+          './deeper/file.js': '',
+        });
+        const globOutput = InputDataService.gatherFilesFromDir('/fictional/project', {
+          allowlist: ['deeper/**/*'],
+        });
+        expect(globOutput).to.eql([
+          '/fictional/project/deeper/file.js',
+          '/fictional/project/deeper/glob/file.js',
+          '/fictional/project/deeper/glob/structure/file.js',
+        ]);
+      });
+
       describe('Default config', () => {
         it('omits config files by default', async () => {
           mockProject({