Implementing whitelist (#39)

Implementing whitelist

README.md

@@ -37,3 +37,6 @@ $ pnr-scanner .
     -p, --pattern <pattern>  Glob pattern default is !(node_modules){,/**}
     -h, --help               output usage information
 ```
+
+### Whitelist
+If your project has any false positives that you want to exclude from the search you can place a .pnr-whitelist file in your search root. This file should have one whitelisted pnr per line.

lib/fileMockDataReader.test.js

@@ -1,6 +1,6 @@
 const FileMockDataReader = require("./fileMockDataReader");
 
-describe("Validator", () => {
+describe("FileMockDataReader", () => {
   const fileContent = ["Testpersonnummer", "201710022383", "201801202381"].join(
     "\r\n"
   );

lib/finder.js

@@ -5,11 +5,11 @@ const isTextOrBinary = require(`istextorbinary`);
 const Validator = require(`./validator`);
 const Pnr = require(`./pnr`);
 const FileMockDataReader = require("./fileMockDataReader");
+const WhitelistReader = require("./whitelistReader");
 const Logger = require(`../lib/logger/logger`);
 const logger = new Logger(`finder.js`);
 
 const defaultPattern = `!(node_modules){,/**}`;
-const validator = new Validator(FileMockDataReader.fetch());
 
 class Finder {
   static findPnrs(searchPath, pattern) {
@@ -24,18 +24,19 @@ class Finder {
     } else {
       files.push(searchPath);
     }
+    const validator = new Validator([...[FileMockDataReader.fetch()], ...[WhitelistReader.fetch(searchPath)]]);
 
     return files
       .map(file => {
-        const results = Finder.getPnrsInFile(file);
+        const results = Finder.getPnrsInFile(file, validator);
         return { file, results };
       })
       .filter(item => {
         return item && item.results && item.results.length > 0;
       });
   }
 
-  static getPnrsInFile(file) {
+  static getPnrsInFile(file, validator) {
     const fileBuffer = fs.readFileSync(file);
     const results = [];
     if (isTextOrBinary.isTextSync(path.basename(file), fileBuffer)) {

lib/finder.test.js

@@ -73,15 +73,15 @@ describe(`findPnrs`, () => {
 
 describe(`getPnrsInFile`, () => {
   test(`Should be able to find multiple results`, () => {
-    const result = Finder.getPnrsInFile("/path/to/file4");
+    const result = Finder.getPnrsInFile("/path/to/file4", mockValidator);
     expect(result.length).toBe(2);
   });
   test(`Should return an empty result for binary files`, () => {
-    const result = Finder.getPnrsInFile("/path/to/binary");
+    const result = Finder.getPnrsInFile("/path/to/binary", mockValidator);
     expect(result.length).toBe(0);
   });
   test(`Should not return mocked pnrs`, () => {
-    const result = Finder.getPnrsInFile("/path/to/file5");
+    const result = Finder.getPnrsInFile("/path/to/file5", mockValidator);
     expect(result.length).toBe(0);
   });
 });

lib/whitelistReader.js

@@ -0,0 +1,18 @@
+const fs = require(`fs`);
+const path = require(`path`);
+const Pnr = require(`./pnr`);
+
+class WhitelistReader {
+  static fetch(rootPath) {
+    const whiteListPath = path.join(rootPath, `.pnr-whitelist`);
+    if (fs.existsSync(whiteListPath)) {
+      return fs.readFileSync(whiteListPath, `utf8`)
+        .replace(/\r/g, ``)
+        .split(`\n`)
+        .filter(line => Pnr.isValidPnr(line));
+    }
+    return [];
+  }
+}
+
+module.exports = WhitelistReader;

lib/whitelistReader.test.js

@@ -0,0 +1,25 @@
+const fileContent = ["Testpersonnummer", "201710022383", "201801202381"].join(
+  "\r\n"
+);
+const mockFs = {
+  existsSync: jest.fn(file => true),
+  readFileSync: jest.fn(data => fileContent)
+};
+jest.mock("fs", () => mockFs);
+
+const WhitelistReader = require("./whitelistReader");
+
+describe("WhitelistReader", () => {
+  describe("fetch()", () => {
+    test("returns a list of pnrs", () => {
+      expect(WhitelistReader.fetch("nicePath")).toEqual(
+        expect.arrayContaining(["201801202381", "201710022383"])
+      );
+    });
+    test("can filter out non-pnr lines from mock data", () => {
+      expect(WhitelistReader.fetch("nicePath")).not.toContain(
+        "Testpersonnummer"
+      );
+    });
+  });
+});