bruno/packages/bruno-js/src/bru.js
lohit ab9bcbe5ed
feat/rename collectionVariables variable name to runtimeVariables (#2638)
* pr review changes

* collection root object in export json

* import environment updates

* tests run execution order fix for collection runs

* updated validations

* collectionVariables -> runtimeVariables

* removed husky, adjusted indentation

---------

Co-authored-by: Anoop M D <anoop.md1421@gmail.com>
2024-07-17 17:21:03 +05:30

106 lines
2.4 KiB
JavaScript

const { cloneDeep } = require('lodash');
const { interpolate } = require('@usebruno/common');
const variableNameRegex = /^[\w-.]*$/;
class Bru {
constructor(envVariables, runtimeVariables, processEnvVars, collectionPath, requestVariables) {
this.envVariables = envVariables || {};
this.runtimeVariables = runtimeVariables || {};
this.processEnvVars = cloneDeep(processEnvVars || {});
this.requestVariables = requestVariables || {};
this.collectionPath = collectionPath;
}
_interpolate = (str) => {
if (!str || !str.length || typeof str !== 'string') {
return str;
}
const combinedVars = {
...this.envVariables,
...this.requestVariables,
...this.runtimeVariables,
process: {
env: {
...this.processEnvVars
}
}
};
return interpolate(str, combinedVars);
};
cwd() {
return this.collectionPath;
}
getEnvName() {
return this.envVariables.__name__;
}
getProcessEnv(key) {
return this.processEnvVars[key];
}
hasEnvVar(key) {
return Object.hasOwn(this.envVariables, key);
}
getEnvVar(key) {
return this._interpolate(this.envVariables[key]);
}
setEnvVar(key, value) {
if (!key) {
throw new Error('Creating a env variable without specifying a name is not allowed.');
}
this.envVariables[key] = value;
}
hasVar(key) {
return Object.hasOwn(this.runtimeVariables, key);
}
setVar(key, value) {
if (!key) {
throw new Error('Creating a variable without specifying a name is not allowed.');
}
if (variableNameRegex.test(key) === false) {
throw new Error(
`Variable name: "${key}" contains invalid characters!` +
' Names must only contain alpha-numeric characters, "-", "_", "."'
);
}
this.runtimeVariables[key] = value;
}
getVar(key) {
if (variableNameRegex.test(key) === false) {
throw new Error(
`Variable name: "${key}" contains invalid characters!` +
' Names must only contain alpha-numeric characters, "-", "_", "."'
);
}
return this._interpolate(this.runtimeVariables[key]);
}
deleteVar(key) {
delete this.runtimeVariables[key];
}
getRequestVar(key) {
return this._interpolate(this.requestVariables[key]);
}
setNextRequest(nextRequest) {
this.nextRequest = nextRequest;
}
}
module.exports = Bru;