- add script to extract faker.js locales

- add and split tests
- update faker.js to latest version, make setSeed null safe
Closes #8

package.json

@@ -35,12 +35,12 @@
     "node": ">=10.0.0"
   },
   "dependencies": {
-    "@mockoon/commons": "2.1.0",
+    "@mockoon/commons": "2.1.1",
     "bson-objectid": "1.3.1",
     "cookie-parser": "1.4.5",
     "date-fns": "2.16.1",
     "express": "4.17.1",
-    "faker": "5.1.0",
+    "faker": "5.5.3",
     "handlebars": "4.7.6",
     "http-proxy-middleware": "1.0.6",
     "killable": "1.0.1",
@@ -54,7 +54,7 @@
     "@types/chai": "4.2.14",
     "@types/cookie-parser": "1.4.2",
     "@types/express": "4.17.8",
-    "@types/faker": "5.1.2",
+    "@types/faker": "5.5.4",
     "@types/lodash": "4.14.161",
     "@types/mime-types": "2.1.0",
     "@types/mocha": "8.2.0",

scripts/extract-faker-locales.js

@@ -0,0 +1,17 @@
+const fakerLocales = require('../node_modules/faker/lib/locales.js');
+
+/**
+ * Extract locales list from Faker.js to be used in the commons librairy and main app
+ */
+const localesList = Object.keys(fakerLocales);
+const locales = [];
+
+localesList.forEach((locale) => {
+  locales.push({
+    code: locale,
+    label: fakerLocales[locale].title
+  });
+});
+
+console.log(localesList);
+console.log(locales.sort((a, b) => (a.label < b.label ? -1 : 1)));

src/libs/faker.ts

@@ -16,5 +16,7 @@ export const SetFakerLocale = (locale: FakerAvailableLocales) => {
  * @param seed
  */
 export const SetFakerSeed = (seed: number) => {
-  faker.seed(seed);
+  if (seed !== undefined && seed !== null) {
+    faker.seed(seed);
+  }
 };

test/templating-helpers/faker-wrapper.spec.ts

@@ -0,0 +1,70 @@
+import { expect } from 'chai';
+import faker from 'faker';
+import { TemplateParser } from '../../src/libs/template-parser';
+
+faker.seed(1);
+
+describe('Template parser: Faker wrapper', () => {
+  it('should return value for simple helper', () => {
+    const parseResult = TemplateParser(
+      "{{faker 'name.firstName'}}",
+      {} as any,
+      {} as any
+    );
+    expect(parseResult).to.be.equal('Hayden');
+  });
+
+  it('should return value for helper with named parameters', () => {
+    const parseResult = TemplateParser(
+      "{{faker 'random.number' min=10 max=20}}",
+      {} as any,
+      {} as any
+    );
+    expect(parseResult).to.be.equal('20');
+  });
+
+  it('should return value for helper with arguments', () => {
+    const parseResult = TemplateParser(
+      "{{faker 'random.alphaNumeric' 1}}",
+      {} as any,
+      {} as any
+    );
+    expect(parseResult).to.be.equal('p');
+  });
+
+  it('should throw if helper name is missing', () => {
+    expect(() => {
+      TemplateParser('{{faker}}', {} as any, {} as any);
+    }).to.throw(
+      'Faker method name is missing (valid: "address.zipCode", "date.past", etc) line 1'
+    );
+  });
+
+  it('should throw if helper name is malformed', () => {
+    expect(() => {
+      TemplateParser("{{faker 'random'}}", {} as any, {} as any);
+    }).to.throw(
+      'random is not a valid Faker method (valid: "address.zipCode", "date.past", etc) line 1'
+    );
+  });
+
+  it('should throw if helper name is malformed', () => {
+    expect(() => {
+      TemplateParser("{{faker 'random.'}}", {} as any, {} as any);
+    }).to.throw(
+      'random. is not a valid Faker method (valid: "address.zipCode", "date.past", etc) line 1'
+    );
+  });
+
+  it('should throw if helper name does not exists', () => {
+    expect(() => {
+      TemplateParser(
+        "{{faker 'donotexists.donotexists'}}",
+        {} as any,
+        {} as any
+      );
+    }).to.throw(
+      'donotexists.donotexists is not a valid Faker method (valid: "address.zipCode", "date.past", etc) line 1'
+    );
+  });
+});