Merge branch 'main' into vsc#16_multi-jsonpath

.github/workflows/formatting.yml

@@ -11,4 +11,4 @@ jobs:
         with:
           node-version: "20"
       - name: prettier check
-        run: npx prettier -c ./src --config ./src/.prettierrc
+        run: npx prettier -c ./src ./tests --config ./.prettierrc

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Change Log
 
+## [todo]
+- Introduced automated tests
+
 ## 1.5.1
 - Fixed regression (status check failures were not detected)
 

jest.config.js

@@ -1,4 +1,6 @@
 module.exports = {
   preset: "ts-jest",
   testEnvironment: "node",
+  silent: false,
+  testTimeout: 120*1000,
 };

src/constructCurl.ts

@@ -3,6 +3,11 @@ import { getStringValueIfDefined } from "./utils/typeUtils";
 import { getParamsForUrl, getURL } from "./executeRequest";
 import { RequestSpec } from "./models";
 
+function replaceSingleQuotes<T>(value: T): T {
+  if (typeof value !== "string") return value;
+  return value.replace(/'/g, "%27") as T & string;
+}
+
 export function getCurlRequest(request: RequestSpec): string {
   let curl: string = "curl";
 
@@ -11,13 +16,14 @@ export function getCurlRequest(request: RequestSpec): string {
 
   // headers
   if (request.httpRequest.headers !== undefined) {
-    for (const header in request.httpRequest.headers)
-      curl += ` -H '${header}: ${request.httpRequest.headers[header]}'`;
+    for (const header in request.httpRequest.headers) {
+      curl += ` -H '${replaceSingleQuotes(`${header}: ${request.httpRequest.headers[header]}`)}'`;
+    }
   }
 
   // body
   if (request.httpRequest.body !== undefined)
-    curl += ` -d '${getStringValueIfDefined(request.httpRequest.body)}'`;
+    curl += ` -d '${replaceSingleQuotes(getStringValueIfDefined(request.httpRequest.body))}'`;
 
   // options.follow
   if (request.options.follow) curl += " -L";
@@ -29,10 +35,12 @@ export function getCurlRequest(request: RequestSpec): string {
   if (request.options.showHeaders) curl += " -i";
 
   // url w/ params
-  curl += ` '${getURL(
-    request.httpRequest.baseUrl,
-    request.httpRequest.url,
-    getParamsForUrl(request.httpRequest.params, request.options.rawParams),
+  curl += ` '${replaceSingleQuotes(
+    getURL(
+      request.httpRequest.baseUrl,
+      request.httpRequest.url,
+      getParamsForUrl(request.httpRequest.params, request.options.rawParams),
+    ),
   )}'`;
 
   return curl;

src/index.ts

@@ -5,6 +5,7 @@ export {
   GotRequest,
   TestResult,
   SpecResult,
+  Tests,
 } from "./models";
 
 export { getRequestPositions, getAllRequestSpecs, getRequestSpec } from "./parseBundle";

src/replaceVars.ts

@@ -137,9 +137,10 @@ export function replaceVariablesInRequest(request: RequestSpec, variables: Varia
 
   type keyOfHttp = Exclude<keyof typeof request.httpRequest, "method">;
   const httpPropertiesToReplace: string[] = ["baseUrl", "url", "params", "headers", "body"];
-  httpPropertiesToReplace.forEach((key) => {
-    const replacedData = replaceVariables(request.httpRequest[key as keyOfHttp], variables);
-    request.httpRequest[key as keyOfHttp] = replacedData.data;
+  httpPropertiesToReplace.forEach((prop) => {
+    const httpKey = prop as keyOfHttp;
+    const replacedData = replaceVariables(request.httpRequest[httpKey], variables);
+    request.httpRequest[httpKey] = replacedData.data;
     undefs.push(...replacedData.undefinedVars);
   });
 

src/variableParser.ts

@@ -38,6 +38,22 @@ export function getEnvironments(bundleContent: string | undefined, varFileConten
   return [...uniqueNames];
 }
 
+function replaceEnvironmentVariables(vars: Variables): Variables {
+  const PREFIX = "$env.";
+
+  const getVal = (val: any): any => {
+    if (typeof val !== "string" || !val.startsWith(PREFIX)) return val;
+
+    const envVarName = val.slice(PREFIX.length);
+    return envVarName in process.env ? process.env[envVarName] : val;
+  };
+
+  const replacedVars: Variables = {};
+  for (const key in vars) replacedVars[key] = getVal(vars[key]);
+
+  return replacedVars;
+}
+
 export function loadVariables(
   envName: string | undefined,
   bundleContent: string | undefined,
@@ -46,15 +62,16 @@ export function loadVariables(
   if (!envName) return {};
 
   const allBundleVariables = getBundleVariables(bundleContent);
-  const bundleVars = allBundleVariables.hasOwnProperty(envName) ? allBundleVariables[envName] : {};
+  const bundleVars: Variables = allBundleVariables[envName] ?? {};
 
-  let envVars = {};
+  const envVars: Variables = {};
   varFileContents.forEach((fileContents) => {
     const parsedData = YAML.parse(fileContents);
-    if (parsedData && isDict(parsedData[envName])) {
-      Object.assign(envVars, parsedData[envName]);
-    }
+    if (parsedData && isDict(parsedData[envName])) Object.assign(envVars, parsedData[envName]);
   });
 
-  return Object.assign({}, envVars, bundleVars);
+  const basicVars = Object.assign({}, envVars, bundleVars);
+  const vars = replaceEnvironmentVariables(basicVars);
+
+  return vars;
 }

tests/bundles/auto-test.zzv

@@ -0,0 +1,9 @@
+# to ensure that the module is reading from varfiles, we put some essential
+# variables in the varfiles
+
+default: 
+  getUrl: /get
+  fooVar: bar
+random:
+  getUrl: /random
+  fooVar: random