@villedemontreal/jwt-validator 5.7.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Ville de Montréal and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,313 @@
+# @villedemontreal/jwt-validator
+
+Module to validate JWT generated by Kong
+
+## Availabililty
+
+https://bitbucket.org/villemontreal/core-jwt-validator-nodejs-lib
+
+## Installation
+
+```shell
+    npm install --save @villedemontreal/jwt-validator
+    yarn add @villedemontreal/jwt-validator
+```
+
+## Usage
+
+### Initialisation
+
+Un code utilisant cette librarie doit premièrement la configurer en appellant la fonction
+"`ìnit(...)`" exportée par le fichier "`src/config/init.ts`".
+
+```typescript
+import { init as initJwtValidationLib } from '@villedemontreal/jwt-validator';
+import { createLogger } from './utils/logger';
+import { correlationIdService, init as initCidUtils } from '@villedemontreal/correlation-id';
+
+// ...
+
+export async function initComponents() {
+  initJwtValidationLib(
+    createLogger,
+    () => {
+      return correlationIdService.getId();
+    },
+    configs.security.jwt.host, // Optional: already defined
+    configs.security.jwt.endPoint // Optional: already defined
+  );
+
+  //...
+}
+```
+
+Notez qu'une fonction "`isInited()`" est exportée et permet au code appelant de valider que la librairie a été
+configurée correctement!
+
+### JWT Validation With Middleware
+
+Route definition:
+
+```typescript
+import { jwtValidationMiddleware } from '@villedemontreal/jwt-validator';
+
+export function getAPIRoutes(): IHandlerRoute[] {
+  return [
+    // Get Account Information
+    {
+      method: HttpMethods.GET,
+      path: '/v1/accounts/:id',
+      handler: accountsController.getAccount,
+      middlewares: [jwtValidationMiddleware()]
+    }
+  ];
+}
+```
+
+Global definition in `app.ts`:
+
+```typescript
+export async function createApp(apiRoutes: IHandlerRoute[]): Promise<express.Express> {
+  // ...
+
+  if (configs.security.jwt.enable) {
+    let jwtMiddleware = jwtValidationMiddleware();
+    app.use(function(req: express.Request, res: express.Response, next: express.NextFunction) {
+      if (req && req.path && req.path.toLowerCase().startsWith(constants.EnpointTypeRoots.API)) {
+        jwtMiddleware(req, res, next);
+      } else {
+        next();
+      }
+    });
+  }
+
+  // ...
+}
+```
+
+#### User validation
+
+Then in the controller, it's possible to check the ID inside the JWT:
+
+```typescript
+import { UserValidator } from "@villedemontreal/jwt-validator";
+
+// Controller to update an account: PUT /accounts/:inum
+public async update(req: express.Request, res: express.Response, next: express.NextFunction): Promise<void> {
+
+    // Get inum from request
+    let inum: string = req.params.id;
+
+    let userValidator: UserValidator = new UserValidator(req);
+
+    // Return if the ID is the same or not
+    let same: boolean = userValidator.isUser(inum);
+
+    // Throw an exception if the ID is not the same
+    userValidator.verifyUser(inum);
+}
+```
+
+#### Get JWT content
+
+To get the JWT content, you have to cast the `req` variable with the custom type `Request` .
+
+```typescript
+import { IJWTPayload, IRequestWithJwt } from "@villedemontreal/jwt-validator";
+
+// Controller to update an account: PUT /accounts/:inum
+public async update(req: express.Request, res: express.Response, next: express.NextFunction): Promise<void> {
+
+    // Get JWT content
+    let jwtPayload: IJWTPayload = (<IRequestWithJwt>req).jwt;
+}
+```
+
+### Manual JWT Validation
+
+Validate a JWT and a JWT and the ID inside the JWT
+
+```typescript
+import { jwtValidator, IJWTPayload } from "@villedemontreal/jwt-validator";
+
+// Controller to update an account: PUT /accounts/:inum
+public async update(req: express.Request, res: express.Response, next: express.NextFunction): Promise<void> {
+
+    // Get inum from request
+    let inum: string = req.params.id;
+
+    // Validate Authorization header, check inum in JWT and get JWT content
+    let jwtPayload: IJWTPayload = await jwtValidator.verifyAuthorizationHeader(req.header('Authorization'));
+
+    // Check the ID inside the JWT
+    assert.strictEqual(jwtPayload.sub, inum);
+}
+```
+
+It is also possible to check to validate directly the JWT value:
+
+```typescript
+import { jwtValidator, IJWTPayload } from '@villedemontreal/jwt-validator';
+
+let jwt: string = '...';
+
+// Validate JWT and get JWT content
+let jwtPayload: IJWTPayload = await jwtValidator.verifyToken(jwt);
+```
+
+## Usage For Tests
+
+This library provides a mock tool to generate your own JWT with a signature which it will be correcly validated.
+
+There are two parts to do this:
+
+- The method `mockPublicKeys`, clean the public keys cache and intercept the first request to get the public keys. Then, our mock keys are inserted in the pubic keys cache.
+
+- The method `generateJwt` allows to produce your own JWT signed with a private key.
+
+Example of tests with mocha:
+
+```typescript
+import { jwtMock } from '@villedemontreal/jwt-validator';
+
+describe('Test', function() {
+  before(async function() {
+    // Mock the public keys
+    await jwtMock.mockPublicKeys();
+
+    // Generate JWT
+    let jwtToken = jwtMock.generateJwt();
+
+    // Generate a JWT with your custom value:
+    let jwtToken = jwtMock.generateJwt({
+      accessToken: 'c9ba5a95-d7f9-41f9-9a24-a7e41882f7ef',
+      iss: 'jwt-mock',
+
+      // From Introspect
+      exp: Date.now() + 3600,
+      iat: Date.now(),
+      // Use this keyId to have a valid public key
+      keyId: 5,
+      /*
+                Key ID:
+                - 1: Public Key expired with the status as "expired"
+                - 2: Public Key expired WITHOUT the status as "expired"
+                - 3: Public Key revoked
+                - 4: Public Key still active but an expiration date is set
+                - 5: Public Key active without an expiration date
+            */
+
+      // From ClientInfo
+      displayName: 'Service Account',
+      aud: '@!4025.CA62.9BB6.16C5!0001!2212.0010!0008!2212.0010',
+
+      // From UserInfo
+      name: 'Guillaume Smaha',
+      sub: '@!4025.CA62.9BB6.16C5!0001!2212.0010!0000!0000.0001',
+      inum: '@!4025.CA62.9BB6.16C5!0001!2212.0010!0000!0000.0001',
+      userName: 'xsmahgu@ville.montreal.qc.ca',
+      givenName: 'Guillaume',
+      familyName: 'Smaha',
+
+      customData: {
+        // Role, permission, ...
+      }
+    });
+  });
+
+  it('should accept JWT and update password user', async function() {
+    let payload: any = {
+      oldPassword: 'testTest2',
+      password: 'testTest3'
+    };
+
+    let response = await request(testApp)
+      .put(`/api${configs.api.domainPath}/v1/accounts/${userInum}`)
+      .set('Authorization', 'Bearer ' + jwtToken)
+      .send(payload);
+
+    assert.strictEqual(response.status, 200);
+  });
+});
+```
+
+# Builder le projet
+
+**Note**: Sur Linux/Mac assurz-vous que le fichier `run` est exécutable. Autrement, lancez `chmod +x ./run`.
+
+Pour lancer le build :
+
+- > `run compile` ou `./run compile` (sur Linux/Mac)
+
+Pour lancer les tests :
+
+- > `run test` ou `./run test` (sur Linux/Mac)
+
+# Mode Watch
+
+Lors du développement, il est possible de lancer `run watch` (ou `./run watch` sur Linux/mac) dans un terminal
+externe pour démarrer la compilation incrémentale. Il est alors possible de lancer certaines _launch configuration_
+comme `Debug current tests file - fast` dans VsCode et ainsi déboguer le fichier de tests présentement ouvert sans
+avoir à (re)compiler au préalable (la compilation incrémentale s'en sera chargé).
+
+Notez que, par défaut, des _notifications desktop_ sont activées pour indiquer visuellement si la compilation
+incrémentale est un succès ou si une erreur a été trouvée. Vous pouvez désactiver ces notifications en utilisant
+`run watch --dn` (`d`isable `n`otifications).
+
+# Déboguer le projet
+
+Trois "_launch configurations_" sont founies pour déboguer le projet dans VSCode :
+
+- "`Debug all tests`", la launch configuration par défaut. Lance les tests en mode debug. Vous pouvez mettre
+  des breakpoints et ils seront respectés.
+
+- "`Debug a test file`". Lance _un_ fichier de tests en mode debug. Vous pouvez mettre
+  des breakpoints et ils seront respectés. Pour changer le fichier de tests à être exécuté, vous devez modifier la ligne appropriée dans le fichier "`.vscode/launch.json`".
+
+- "`Debug current tests file`". Lance le fichier de tests _présentement ouvert_ dans VSCode en mode debug. Effectue la compîlation au préalable.
+
+- "`Debug current tests file - fast`". Lance le fichier de tests _présentement ouvert_ dans VSCode en mode debug. Aucune compilation
+  n'est effectuée au préalable. Cette launch configuration doit être utilisée lorsque la compilation incrémentale roule (voir la section "`Mode Watch`" plus haut)
+
+# Test et publication de la librairie sur Nexus
+
+En mergant une pull request dans la branche `develop`, un artifact "`-pre.build`" sera créé automatiquement dans Nexus. Vous
+pouvez utiliser cette version temporaire de la librairie pour bien la tester dans un réel projet.
+
+Une fois mergée dans `master`, la librairie est définitiement publiée dans Nexus, en utilisant la version spécifiée dans
+le `package.json`.
+
+## Artifact Nexus privé, lors du développement
+
+Lors du développement d'une nouvelle fonctionnalité, sur une branche `feature`, il peut parfois être
+utile de déployer une version temporaire de la librairie dans Nexus. Ceci permet de bien tester
+l'utilisation de la librairie modifiée dans un vrai projet, ou même dans une autre librairie
+elle-même par la suite utilisée dans un vrai projet.
+
+Si le code à tester est terminé et prêt à être mis en commun avec d'autres développeurs, la solution
+de base, comme spécifiée à la section précédante, est de merger sur `develop`: ceci créera
+automatiquement un artifact "`-pre-build`" dans Nexus. Cependant, si le code est encore en développement
+et vous désirez éviter de polluer la branche commune `develop` avec du code temporaire, il y a une
+solution permettant de générer un artifact "`[votre prénom]-pre-build`" temporaire dans Nexus,
+à partir d'une branche `feature` directement:
+
+1. Checkoutez votre branche `feature` dans une branche nommée "`nexus`". Ce nom est
+   important et correspond à une entrée dans le `Jenkinsfile`.
+2. Une fois sur la branche `nexus`, ajoutez un suffixe "`-[votre prénom]`" à
+   la version dans le `package.json`, par exemple: "`5.15.0-roger`".
+   Ceci permet d'éviter tout conflit dans Nexus et exprime clairement qu'il
+   s'agit d'une version temporaire pour votre développement privé.
+3. Commitez et poussez la branche `nexus`.
+4. Une fois le build Jenkins terminé, un artifact pour votre version aura été
+   déployé dans Nexus. Détruire votre branche dans Bitbucket pour permettre aux
+   autres developpeurs d'utiliser cette approche.
+
+**Notez** que, lors du développement dans une branche `feature`, l'utilisation d'un simple
+`npm link` local peut souvent être suffisant! Mais cette solution a ses limites, par exemple si
+vous désirez tester la librairie modifiée _dans un container Docker_.
+
+# Aide / Contributions
+
+Pour obtenir de l'aide avec cette librairie, vous pouvez poster sur la salle Google Chat [dev-discussions](https://chat.google.com/room/AAAASmiQveI).
+
+Notez que les contributions sous forme de pull requests sont bienvenues.

package/dist/scripts/index.d.ts

@@ -0,0 +1,6 @@
+export { LintScript } from './lint';
+export { LintFixScript } from './lintFix';
+export { ShowCoverageScript } from './showCoverage';
+export { TestScript } from './test';
+export { TestUnitsScript } from './testUnits';
+export { WatchScript } from './watch';

package/dist/scripts/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WatchScript = exports.TestUnitsScript = exports.TestScript = exports.ShowCoverageScript = exports.LintFixScript = exports.LintScript = void 0;
+var lint_1 = require("./lint");
+Object.defineProperty(exports, "LintScript", { enumerable: true, get: function () { return lint_1.LintScript; } });
+var lintFix_1 = require("./lintFix");
+Object.defineProperty(exports, "LintFixScript", { enumerable: true, get: function () { return lintFix_1.LintFixScript; } });
+var showCoverage_1 = require("./showCoverage");
+Object.defineProperty(exports, "ShowCoverageScript", { enumerable: true, get: function () { return showCoverage_1.ShowCoverageScript; } });
+var test_1 = require("./test");
+Object.defineProperty(exports, "TestScript", { enumerable: true, get: function () { return test_1.TestScript; } });
+var testUnits_1 = require("./testUnits");
+Object.defineProperty(exports, "TestUnitsScript", { enumerable: true, get: function () { return testUnits_1.TestUnitsScript; } });
+var watch_1 = require("./watch");
+Object.defineProperty(exports, "WatchScript", { enumerable: true, get: function () { return watch_1.WatchScript; } });
+//# sourceMappingURL=index.js.map

package/dist/scripts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../scripts/index.ts"],"names":[],"mappings":";;;AAAA,+BAAoC;AAA3B,kGAAA,UAAU,OAAA;AACnB,qCAA0C;AAAjC,wGAAA,aAAa,OAAA;AACtB,+CAAoD;AAA3C,kHAAA,kBAAkB,OAAA;AAC3B,+BAAoC;AAA3B,kGAAA,UAAU,OAAA;AACnB,yCAA8C;AAArC,4GAAA,eAAe,OAAA;AACxB,iCAAsC;AAA7B,oGAAA,WAAW,OAAA"}

package/dist/scripts/lint.d.ts

@@ -0,0 +1,6 @@
+import { ScriptBase } from '@villedemontreal/scripting/dist/src';
+export declare class LintScript extends ScriptBase {
+    get name(): string;
+    get description(): string;
+    protected main(): Promise<void>;
+}

package/dist/scripts/lint.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LintScript = void 0;
+const src_1 = require("@villedemontreal/scripting/dist/src");
+const configs_1 = require("../src/config/configs");
+class LintScript extends src_1.ScriptBase {
+    get name() {
+        return 'lint';
+    }
+    get description() {
+        return `Run the ESLint validation (including TSLint and Prettier rules).`;
+    }
+    async main() {
+        await this.invokeShellCommand(`${configs_1.configs.libRoot}/node_modules/.bin/eslint`, [configs_1.configs.libRoot]);
+    }
+}
+exports.LintScript = LintScript;
+//# sourceMappingURL=lint.js.map

package/dist/scripts/lint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lint.js","sourceRoot":"","sources":["../../scripts/lint.ts"],"names":[],"mappings":";;;AAAA,6DAAiE;AACjE,mDAAgD;AAEhD,MAAa,UAAW,SAAQ,gBAAU;IACxC,IAAI,IAAI;QACN,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,kEAAkE,CAAC;IAC5E,CAAC;IAES,KAAK,CAAC,IAAI;QAClB,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,iBAAO,CAAC,OAAO,2BAA2B,EAAE,CAAC,iBAAO,CAAC,OAAO,CAAC,CAAC,CAAC;IAClG,CAAC;CACF;AAZD,gCAYC"}

package/dist/scripts/lintFix.d.ts

@@ -0,0 +1,6 @@
+import { ScriptBase } from '@villedemontreal/scripting/dist/src';
+export declare class LintFixScript extends ScriptBase {
+    get name(): string;
+    get description(): string;
+    protected main(): Promise<void>;
+}

package/dist/scripts/lintFix.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LintFixScript = void 0;
+const src_1 = require("@villedemontreal/scripting/dist/src");
+const configs_1 = require("../src/config/configs");
+class LintFixScript extends src_1.ScriptBase {
+    get name() {
+        return 'lint-fix';
+    }
+    get description() {
+        return `Fix the code using ESLint validation (including TSLint and Prettier rules).`;
+    }
+    async main() {
+        await this.invokeShellCommand(`${configs_1.configs.libRoot}/node_modules/.bin/eslint`, [
+            '--fix',
+            configs_1.configs.libRoot,
+        ]);
+    }
+}
+exports.LintFixScript = LintFixScript;
+//# sourceMappingURL=lintFix.js.map

package/dist/scripts/lintFix.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lintFix.js","sourceRoot":"","sources":["../../scripts/lintFix.ts"],"names":[],"mappings":";;;AAAA,6DAAiE;AACjE,mDAAgD;AAEhD,MAAa,aAAc,SAAQ,gBAAU;IAC3C,IAAI,IAAI;QACN,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,6EAA6E,CAAC;IACvF,CAAC;IAES,KAAK,CAAC,IAAI;QAClB,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,iBAAO,CAAC,OAAO,2BAA2B,EAAE;YAC3E,OAAO;YACP,iBAAO,CAAC,OAAO;SAChB,CAAC,CAAC;IACL,CAAC;CACF;AAfD,sCAeC"}

package/dist/scripts/showCoverage.d.ts

@@ -0,0 +1,13 @@
+import { Command } from '@caporal/core';
+import { ScriptBase } from '@villedemontreal/scripting/dist/src';
+export interface Options {
+    report?: string;
+}
+export declare class ShowCoverageScript extends ScriptBase<Options> {
+    get name(): string;
+    get description(): string;
+    protected get requiredDependencies(): string[];
+    protected configure(command: Command): Promise<void>;
+    protected main(): Promise<void>;
+    protected getReportDir(): string;
+}

package/dist/scripts/showCoverage.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShowCoverageScript = void 0;
+const core_1 = require("@caporal/core");
+const src_1 = require("@villedemontreal/scripting/dist/src");
+const path = require("path");
+const configs_1 = require("../src/config/configs");
+class ShowCoverageScript extends src_1.ScriptBase {
+    get name() {
+        return 'show-coverage';
+    }
+    get description() {
+        return `Open the tests coverage report.`;
+    }
+    get requiredDependencies() {
+        return ['nyc'];
+    }
+    async configure(command) {
+        command.option(`--report <path>`, `The relative path to the coverage report directory.`, {
+            default: `output/coverage`,
+            validator: core_1.program.STRING,
+        });
+    }
+    async main() {
+        if (configs_1.configs.isWindows) {
+            await this.invokeShellCommand('start', ['', this.getReportDir()], {
+                useShellOption: true,
+            });
+        }
+        else {
+            await this.invokeShellCommand('open', [this.getReportDir()]);
+        }
+    }
+    getReportDir() {
+        const reportDir = path.resolve(configs_1.configs.libRoot, this.options.report, 'lcov-report/index.html');
+        return reportDir;
+    }
+}
+exports.ShowCoverageScript = ShowCoverageScript;
+//# sourceMappingURL=showCoverage.js.map

package/dist/scripts/showCoverage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"showCoverage.js","sourceRoot":"","sources":["../../scripts/showCoverage.ts"],"names":[],"mappings":";;;AAAA,wCAAiD;AACjD,6DAAiE;AACjE,6BAA6B;AAC7B,mDAAgD;AAMhD,MAAa,kBAAmB,SAAQ,gBAAmB;IACzD,IAAI,IAAI;QACN,OAAO,eAAe,CAAC;IACzB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,iCAAiC,CAAC;IAC3C,CAAC;IAED,IAAc,oBAAoB;QAChC,OAAO,CAAC,KAAK,CAAC,CAAC;IACjB,CAAC;IAES,KAAK,CAAC,SAAS,CAAC,OAAgB;QACxC,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,qDAAqD,EAAE;YACvF,OAAO,EAAE,iBAAiB;YAC1B,SAAS,EAAE,cAAO,CAAC,MAAM;SAC1B,CAAC,CAAC;IACL,CAAC;IAES,KAAK,CAAC,IAAI;QAClB,IAAI,iBAAO,CAAC,SAAS,EAAE;YACrB,MAAM,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,EAAE;gBAChE,cAAc,EAAE,IAAI;aACrB,CAAC,CAAC;SACJ;aAAM;YACL,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;SAC9D;IACH,CAAC;IAES,YAAY;QACpB,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAO,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;QAC/F,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAlCD,gDAkCC"}

package/dist/scripts/test.d.ts

@@ -0,0 +1,13 @@
+import { Command } from '@caporal/core';
+import { ScriptBase } from '@villedemontreal/scripting/dist/src';
+export interface Options {
+    bail?: boolean;
+    jenkins?: boolean;
+    report?: string;
+}
+export declare class TestScript extends ScriptBase<Options> {
+    get name(): string;
+    get description(): string;
+    protected configure(command: Command): Promise<void>;
+    protected main(): Promise<void>;
+}

package/dist/scripts/test.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestScript = void 0;
+const core_1 = require("@caporal/core");
+const src_1 = require("@villedemontreal/scripting/dist/src");
+const lint_1 = require("./lint");
+const testUnits_1 = require("./testUnits");
+class TestScript extends src_1.ScriptBase {
+    get name() {
+        return 'test';
+    }
+    get description() {
+        return `Run the unit tests + the linting validations.`;
+    }
+    async configure(command) {
+        command.option(`--bail`, `Stop the execution of the tests as soon as an error occures.`);
+        command.option(`--jenkins`, `Configure the tests to be run by Jenkins.`);
+        command.option(`--report <path>`, `The relative path to the report, when the tests are run for Jenkins.`, {
+            default: `output/test-results/report.xml`,
+            validator: core_1.program.STRING,
+        });
+    }
+    async main() {
+        await this.invokeScript(lint_1.LintScript, {}, {});
+        await this.invokeScript(testUnits_1.TestUnitsScript, this.options, {});
+    }
+}
+exports.TestScript = TestScript;
+//# sourceMappingURL=test.js.map

package/dist/scripts/test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"test.js","sourceRoot":"","sources":["../../scripts/test.ts"],"names":[],"mappings":";;;AAAA,wCAAiD;AACjD,6DAAiE;AACjE,iCAAoC;AACpC,2CAA8C;AAQ9C,MAAa,UAAW,SAAQ,gBAAmB;IACjD,IAAI,IAAI;QACN,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,+CAA+C,CAAC;IACzD,CAAC;IAES,KAAK,CAAC,SAAS,CAAC,OAAgB;QACxC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,8DAA8D,CAAC,CAAC;QACzF,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,2CAA2C,CAAC,CAAC;QACzE,OAAO,CAAC,MAAM,CACZ,iBAAiB,EACjB,sEAAsE,EACtE;YACE,OAAO,EAAE,gCAAgC;YACzC,SAAS,EAAE,cAAO,CAAC,MAAM;SAC1B,CACF,CAAC;IACJ,CAAC;IAES,KAAK,CAAC,IAAI;QAClB,MAAM,IAAI,CAAC,YAAY,CAAC,iBAAU,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QAC5C,MAAM,IAAI,CAAC,YAAY,CAAC,2BAAe,EAAE,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IAC7D,CAAC;CACF;AA1BD,gCA0BC"}

package/dist/scripts/testUnits.d.ts

@@ -0,0 +1,15 @@
+import { Command } from '@caporal/core';
+import { ScriptBase } from '@villedemontreal/scripting/dist/src';
+export interface Options {
+    bail?: boolean;
+    jenkins?: boolean;
+    report?: string;
+}
+export declare class TestUnitsScript extends ScriptBase<Options> {
+    get name(): string;
+    get description(): string;
+    protected configure(command: Command): Promise<void>;
+    protected get requiredDependencies(): string[];
+    private addQuotes;
+    protected main(): Promise<void>;
+}

package/dist/scripts/testUnits.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TestUnitsScript = void 0;
+const core_1 = require("@caporal/core");
+const src_1 = require("@villedemontreal/scripting/dist/src");
+const _ = require("lodash");
+const configs_1 = require("../src/config/configs");
+const TESTS_LOCATIONS = [`${configs_1.configs.libRoot}/dist/src/**/*.test.js`];
+class TestUnitsScript extends src_1.ScriptBase {
+    get name() {
+        return 'test-units';
+    }
+    get description() {
+        return `Run the unit tests.`;
+    }
+    async configure(command) {
+        command.option(`--bail`, `Stop the execution of the tests as soon as an error occures.`);
+        command.option(`--jenkins`, `Configure the tests to be run by Jenkins.`);
+        command.option(`--report <path>`, `The relative path to the report, when the tests are run for Jenkins.`, {
+            default: `output/test-results/report.xml`,
+            validator: core_1.program.STRING,
+        });
+    }
+    get requiredDependencies() {
+        const deps = ['mocha'];
+        if (this.options.jenkins) {
+            deps.push('mocha-jenkins-reporter');
+        }
+        return deps;
+    }
+    addQuotes(tokens) {
+        if (_.isNil(tokens) || tokens.length === 0) {
+            return [];
+        }
+        return tokens.map((token) => {
+            return _.isNil(token) ? token : `"${_.trim(token, '"')}"`;
+        });
+    }
+    async main() {
+        const cmdArgs = [];
+        if (await this.isProjectDirectDependency(`nyc`)) {
+            cmdArgs.push(`${configs_1.configs.libRoot}/node_modules/nyc/bin/nyc`);
+        }
+        else {
+            this.logger.warn(`The "nyc" direct dependency was not found in your project. The tests will be run using Mocha only!`);
+        }
+        cmdArgs.push(`${configs_1.configs.libRoot}/node_modules/mocha/bin/_mocha`);
+        // ==========================================
+        // The test locations need to be quoted because
+        // they may contain a "**" wildcard that some
+        // shells may interpret differently otherwise!
+        //
+        // @see https://mochajs.org/#the-test-directory
+        // ==========================================
+        cmdArgs.push(...this.addQuotes(TESTS_LOCATIONS));
+        cmdArgs.push(`--exit`);
+        // ==========================================
+        // Stop testing as soon as one test fails?
+        // ==========================================
+        if (this.options.bail) {
+            cmdArgs.push('--bail');
+        }
+        // ==========================================
+        // For Jenkins, the path to the report to generate
+        // can be passed :
+        // - as a command line param :
+        //   "run test-units --jenkins --report output/test-results/report.xml"
+        // - as an "JUNIT_REPORT_PATH" environment variable.
+        //
+        // By default, the path will be "output/test-results/report.xml"
+        // ==========================================
+        if (this.options.jenkins) {
+            if (this.options.report) {
+                process.env.JUNIT_REPORT_PATH = this.options.report;
+            }
+            else if (!process.env.JUNIT_REPORT_PATH) {
+                process.env.JUNIT_REPORT_PATH = 'output/test-results/report.xml';
+            }
+            this.logger.info('Exporting tests to junit file ' + process.env.JUNIT_REPORT_PATH);
+            cmdArgs.push('--reporter');
+            cmdArgs.push('mocha-jenkins-reporter');
+        }
+        try {
+            await this.invokeShellCommand('node', cmdArgs, {
+                useTestsNodeAppInstance: true,
+            });
+            this.logger.info("   \u21b3  type 'run show-coverage' (or './run show-coverage' on Linux/Mac) to display the HTML report");
+        }
+        catch (err) {
+            throw new Error('Some unit tests failed');
+        }
+    }
+}
+exports.TestUnitsScript = TestUnitsScript;
+//# sourceMappingURL=testUnits.js.map

package/dist/scripts/testUnits.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testUnits.js","sourceRoot":"","sources":["../../scripts/testUnits.ts"],"names":[],"mappings":";;;AAAA,wCAAiD;AACjD,6DAAiE;AACjE,4BAA4B;AAC5B,mDAAgD;AAEhD,MAAM,eAAe,GAAG,CAAC,GAAG,iBAAO,CAAC,OAAO,wBAAwB,CAAC,CAAC;AAQrE,MAAa,eAAgB,SAAQ,gBAAmB;IACtD,IAAI,IAAI;QACN,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,IAAI,WAAW;QACb,OAAO,qBAAqB,CAAC;IAC/B,CAAC;IAES,KAAK,CAAC,SAAS,CAAC,OAAgB;QACxC,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE,8DAA8D,CAAC,CAAC;QACzF,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,2CAA2C,CAAC,CAAC;QACzE,OAAO,CAAC,MAAM,CACZ,iBAAiB,EACjB,sEAAsE,EACtE;YACE,OAAO,EAAE,gCAAgC;YACzC,SAAS,EAAE,cAAO,CAAC,MAAM;SAC1B,CACF,CAAC;IACJ,CAAC;IAED,IAAc,oBAAoB;QAChC,MAAM,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;QACvB,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YACxB,IAAI,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;SACrC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,SAAS,CAAC,MAAgB;QAChC,IAAI,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YAC1C,OAAO,EAAE,CAAC;SACX;QAED,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC1B,OAAO,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,GAAG,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC;IAES,KAAK,CAAC,IAAI;QAClB,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,IAAI,MAAM,IAAI,CAAC,yBAAyB,CAAC,KAAK,CAAC,EAAE;YAC/C,OAAO,CAAC,IAAI,CAAC,GAAG,iBAAO,CAAC,OAAO,2BAA2B,CAAC,CAAC;SAC7D;aAAM;YACL,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,oGAAoG,CACrG,CAAC;SACH;QAED,OAAO,CAAC,IAAI,CAAC,GAAG,iBAAO,CAAC,OAAO,gCAAgC,CAAC,CAAC;QAEjE,6CAA6C;QAC7C,+CAA+C;QAC/C,6CAA6C;QAC7C,8CAA8C;QAC9C,EAAE;QACF,+CAA+C;QAC/C,6CAA6C;QAC7C,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC,CAAC;QAEjD,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEvB,6CAA6C;QAC7C,0CAA0C;QAC1C,6CAA6C;QAC7C,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE;YACrB,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SACxB;QAED,6CAA6C;QAC7C,kDAAkD;QAClD,kBAAkB;QAClB,8BAA8B;QAC9B,uEAAuE;QACvE,oDAAoD;QACpD,EAAE;QACF,gEAAgE;QAChE,6CAA6C;QAC7C,IAAI,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;YACxB,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;gBACvB,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;aACrD;iBAAM,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE;gBACzC,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,gCAAgC,CAAC;aAClE;YAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gCAAgC,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;YACnF,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC3B,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;SACxC;QAED,IAAI;YACF,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,OAAO,EAAE;gBAC7C,uBAAuB,EAAE,IAAI;aAC9B,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,wGAAwG,CACzG,CAAC;SACH;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;SAC3C;IACH,CAAC;CACF;AAxGD,0CAwGC"}