Merge pull request #115 from chanthafef/master

support aliases with ``serverless-bundle test``

README.md

@@ -136,6 +136,16 @@ custom:
   import Utility from 'Lib/utility';
   ```
 
+  To use aliases in your tests you'll need to use Jest's [`moduleNameMapper`](https://jestjs.io/docs/en/configuration#modulenamemapper-objectstring-string--arraystring). Add the following your `package.json`:
+
+  ``` json
+  "jest": {
+    "moduleNameMapper": {
+      "Lib(.*)$": "<rootDir>/custom-lib/src/lib/$1"
+    }
+  }
+  ```
+
 - Usage with WebStorm
 
   Here is some info on how to get this plugin to support running tests in WebStorm — https://github.com/AnomalyInnovations/serverless-bundle/issues/5#issuecomment-582237396
@@ -340,7 +350,7 @@ $ npm test
 To test the `serverless-bundle test` command.
 
 ```bash
-$ npm run test-scripts
+$ npm run test scripts
 ```
 
 To install locally in another project.

package.json

@@ -16,7 +16,8 @@
     ],
     "testPathIgnorePatterns": [
       "<rootDir>/scripts",
-      "<rootDir>/tests/scripts/tests"
+      "<rootDir>/tests/scripts/tests",
+      "<rootDir>/tests/aliases-jest/tests"
     ]
   },
   "repository": {

scripts/config/createJestConfig.js

@@ -45,7 +45,8 @@ module.exports = (resolve, rootDir) => {
     "testResultsProcessor",
     "transform",
     "transformIgnorePatterns",
-    "watchPathIgnorePatterns"
+    "watchPathIgnorePatterns",
+    "moduleNameMapper"
   ];
   if (overrides) {
     supportedKeys.forEach(key => {

tests/aliases-jest/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+  "parserOptions": {
+    "sourceType": "module"
+  }
+}

tests/aliases-jest/aliases-jest.test.js

@@ -0,0 +1,16 @@
+const { runJestCommand, clearNpmCache } = require("../helpers");
+
+beforeEach(async () => {
+  await clearNpmCache(__dirname);
+});
+
+afterAll(async () => {
+  await clearNpmCache(__dirname);
+});
+
+test("aliases-jest", async () => {
+  const result = await runJestCommand(__dirname);
+
+  // Ensure Jest ran the included tests successfully
+  expect(result).not.toMatch(/failed/);
+});

tests/aliases-jest/handler.js

@@ -0,0 +1,11 @@
+import sum from "libs/sum";
+
+const res = (body = {}) => ({
+  statusCode: 200,
+  body: JSON.stringify(body, null, 2)
+});
+
+export const hello = () =>
+  res({
+    sum: sum(1, 2, 3)
+  });

tests/aliases-jest/libs/sum.js

@@ -0,0 +1 @@
+export default (...numbers) => numbers.reduce((acc, nbr) => acc + nbr);

tests/aliases-jest/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "aliases-jest",
+  "version": "1.0.0",
+  "description": "",
+  "main": "handler.js",
+  "scripts": {
+    "test": "../../bin/scripts.js test --testPathIgnorePatterns=\"./aliases-jest.test.js\""
+  },
+  "jest": {
+    "moduleNameMapper": {
+      "libs(.*)$": "<rootDir>/libs/$1"
+    }
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}

tests/aliases-jest/serverless.yml

@@ -0,0 +1,12 @@
+service: my-service
+
+plugins:
+  - '../../index'
+
+provider:
+  name: aws
+  runtime: nodejs10.x
+
+functions:
+  hello:
+    handler: handler.hello

tests/aliases-jest/tests/index.test.js

@@ -0,0 +1,8 @@
+import { hello } from "../handler";
+
+test("hello returns sum equal 6 in body", () => {
+  const expected = 6;
+  const actual = JSON.parse(hello().body).sum;
+
+  expect(actual).toBe(expected);
+});