Feat: Environment variables in templating

[Meldiron]

I find Mockoon CLI useful for testing purposes in CI/CD environments. In my use case, I am spinning up multiple Mockoon instances running in a Docker container. Even tho I want them to source from the same config file, I would prefer having the option to identify instances.

As a solution to this, I would like to add a new set of helpers that would allow you to read environment variables. Implementation might look something like this:

{ "server": "{{env 'Variable-Name' 'default value'}}" }

To keep the solution secure, this would only allow reading variables that are prefixed with MOCKOON_. There should be an option (CLI parameter?) to change this prefix. Setting prefix to empty string and allowing reading any variable should NOT be allowed.

Source of security concerns and solutions is Vite.

TODO:

• Discuss implementation with maintainers
• Add System Helpers
• Implement environment variable system helper
• Write tests (if applicable)
• Update docs

If possible, I would like to contribute to this issue.

[supr3m]

It would be great, even then the values ​​could be updated at runtime without restarting the service.

export MOCKOON_FOO_VAR=hello-world

fooVar = process.env.MOCKOON_FOO_VAR;
console.log('Show ENVVAR: ', fooVar); // Print "Show ENVVAR: hello-world"

Even better, dotenv can be used to isolate and bundle envvar's into a single .env file to be used only by the application.

MOCKOON_PRIVATE_KEY=-----BEGIN RSA PRIVATE KEY-----\nKh9NV...\n-----END RSA PRIVATE KEY-----\n
MOCKOON_PRIVATE_KEY_MULTILINE="-----BEGIN RSA PRIVATE KEY-----
...
Kh9NV...
...
-----END RSA PRIVATE KEY-----"
MOCKOON_ENV=development
MOCKOON_URL_HEALTHCHECK=http://localhost/api/v1/healthcheck
MOCKOON_HELLO=hello-world

import * as dotenv from 'dotenv';
dotenv.config();

process.env.MOCKOON_PRIVATE_KEY;
process.env.MOCKOON_PRIVATE_KEY_MULTILINE;
process.env.MOCKOON_ENV;
process.env.MOCKOON_URL_HEALTHCHECK;
process.env.MOCKOON_HELLO;

Reference:

• https://www.basedash.com/blog/environment-variables-in-typescript
• https://nodejs.org/docs/latest/api/process.html#process_process_env
• https://github.com/motdotla/dotenv

[255kb]

@supr3m Thank you for the feedback. There is currently no plan to support dotenv files as it requires way more work to make it work in the desktop/CLI/serverless apps.
It will first support traditional env vars, the one usually set up in the OS settings, or using a command line export, set, etc.

[255kb]

📦 This is now released in v7.0.0.