feat: Enable environment variable injection through configuration file

restqa · Mar 22, 2023 · 437485a · 437485a
1 parent 7c65cc7
commit 437485a
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 2 deletions.
diff --git a/docs/getting-started/configuration.md b/docs/getting-started/configuration.md
@@ -23,6 +23,8 @@ tests:
     port: 8887
     command: npm run dev
     coverage: ./coverage/index.html
+    envs:
+      FOO: 'BAR'
   integrations:
     - name: 'uat'
       url: http://uat.example.com

diff --git a/docs/local-testing/_index.md b/docs/local-testing/_index.md
@@ -42,6 +42,7 @@ Depending on the technology that you use, you can refer to our documentation:
 | `tests.local.port`      | number         | The port exposing the microservice server                                    | Yes        |                                |
 | `tests.local.command`   | string         | The command used to run the microservice                                     | Yes        |                                |
 | `tests.local.coverage`  | string         | The path of the test generated coverage page (for custom coverage reporter ) | No         | ./restqa/coverage/index.html   |
+| `tests.local.envs`      | object         | The environment variable that need be injected in the microservice           | No         |                                |
 
 #### Example
 
@@ -57,4 +58,6 @@ tests:
   local:
     port: 8887
     command: npm run dev
+    envs:
+      FOO: BAR
 ```
diff --git a/packages/cli/src/config/index.js b/packages/cli/src/config/index.js
@@ -240,6 +240,14 @@ class LocalTest {
     this._config.command = command;
   }
 
+  getEnvs() {
+    return this._config.envs || {};
+  }
+
+  setEnvs(value) {
+    this._config.envs = value;
+  }
+
   getCoverage() {
     return this._config.coverage;
   }

diff --git a/packages/cli/src/config/index.test.js b/packages/cli/src/config/index.test.js
@@ -274,6 +274,8 @@ tests:
   local:
     port: 8080
     command: npm run dev
+    envs:
+      FOO: BAR
   integrations:
     - name: UAT
       url: !env-var URL
@@ -325,6 +327,7 @@ settings:
     // local test
     expect(Instance.getLocalTest().getPort()).toEqual(8080);
     expect(Instance.getLocalTest().getCommand()).toEqual("npm run dev");
+    expect(Instance.getLocalTest().getEnvs()).toEqual({FOO: "BAR"});
 
     // integration test
     expect(Instance.getIntegrationTests()[0].getName()).toEqual("UAT");

diff --git a/packages/cli/src/config/schema.js b/packages/cli/src/config/schema.js
@@ -36,7 +36,8 @@ function validate(config) {
         port: Joi.number().port().required(),
         command: Joi.string().required(),
         coverage: Joi.string(),
-        data
+        data,
+        envs: Joi.object({}).unknown()
       },
       integrations: Joi.array().items(integration),
       performance: {

diff --git a/packages/cli/src/core/plugin.js b/packages/cli/src/core/plugin.js
@@ -32,7 +32,8 @@ module.exports = function ({env, report, config}, processor = {}) {
   if (!env) {
     processor.BeforeAll(async function () {
       this.restqa = this.restqa || {};
-      const {envs} = this.restqa.mock || {};
+      let {envs} = this.restqa.mock || {};
+      envs = Object.assign(envs || {}, config.getLocalTest().getEnvs());
       const options = {
         port: config.getLocalTest().getPort(),
         command: config.getLocalTest().getCommand(),