chore: tests for hoppscotch-cli (#2300)
Co-authored-by: Andrew Bastin <andrewbastin.k@gmail.com>
This commit is contained in:
@@ -0,0 +1,26 @@
|
||||
import { HoppCLIError } from "../../../types/errors";
|
||||
import { checkFilePath } from "../../../utils/checks";
|
||||
|
||||
describe("checkFilePath", () => {
|
||||
test("File doesn't exists.", () => {
|
||||
return expect(
|
||||
checkFilePath("./src/samples/this-file-not-exists.json")()
|
||||
).resolves.toSubsetEqualLeft(<HoppCLIError>{
|
||||
code: "FILE_NOT_FOUND",
|
||||
});
|
||||
});
|
||||
|
||||
test("File not of JSON type.", () => {
|
||||
return expect(
|
||||
checkFilePath("./src/__tests__/samples/notjson.txt")()
|
||||
).resolves.toSubsetEqualLeft(<HoppCLIError>{
|
||||
code: "FILE_NOT_JSON",
|
||||
});
|
||||
});
|
||||
|
||||
test("Existing JSON file.", () => {
|
||||
return expect(
|
||||
checkFilePath("./src/__tests__/samples/passes.json")()
|
||||
).resolves.toBeRight();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,19 @@
|
||||
import { isHoppCLIError } from "../../../utils/checks";
|
||||
|
||||
describe("isHoppCLIError", () => {
|
||||
test("NULL error value.", () => {
|
||||
expect(isHoppCLIError(null)).toBeFalsy();
|
||||
});
|
||||
|
||||
test("Non-existing code property.", () => {
|
||||
expect(isHoppCLIError({ name: "name" })).toBeFalsy();
|
||||
});
|
||||
|
||||
test("Invalid code value.", () => {
|
||||
expect(isHoppCLIError({ code: 2 })).toBeFalsy();
|
||||
});
|
||||
|
||||
test("Valid code value.", () => {
|
||||
expect(isHoppCLIError({ code: "TEST_SCRIPT_ERROR" })).toBeTruthy();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,19 @@
|
||||
import { isHoppErrnoException } from "../../../utils/checks";
|
||||
|
||||
describe("isHoppErrnoException", () => {
|
||||
test("NULL exception value.", () => {
|
||||
expect(isHoppErrnoException(null)).toBeFalsy();
|
||||
});
|
||||
|
||||
test("Non-existing name property.", () => {
|
||||
expect(isHoppErrnoException({ what: "what" })).toBeFalsy();
|
||||
});
|
||||
|
||||
test("Invalid name value.", () => {
|
||||
expect(isHoppErrnoException({ name: 3 })).toBeFalsy();
|
||||
});
|
||||
|
||||
test("Valid name value.", () => {
|
||||
expect(isHoppErrnoException({ name: "name" })).toBeTruthy();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,84 @@
|
||||
import { isRESTCollection } from "../../../utils/checks";
|
||||
|
||||
describe("isRESTCollection", () => {
|
||||
test("Undefined collection value.", () => {
|
||||
expect(isRESTCollection(undefined)).toBeFalsy();
|
||||
});
|
||||
|
||||
test("Invalid id value.", () => {
|
||||
expect(
|
||||
isRESTCollection({
|
||||
v: 1,
|
||||
name: "test",
|
||||
id: 1,
|
||||
})
|
||||
).toBeFalsy();
|
||||
});
|
||||
|
||||
test("Invalid requests value.", () => {
|
||||
expect(
|
||||
isRESTCollection({
|
||||
v: 1,
|
||||
name: "test",
|
||||
id: "1",
|
||||
requests: null,
|
||||
})
|
||||
).toBeFalsy();
|
||||
});
|
||||
|
||||
test("Invalid folders value.", () => {
|
||||
expect(
|
||||
isRESTCollection({
|
||||
v: 1,
|
||||
name: "test",
|
||||
id: "1",
|
||||
requests: [],
|
||||
folders: undefined,
|
||||
})
|
||||
).toBeFalsy();
|
||||
});
|
||||
|
||||
test("Invalid RESTCollection(s) in folders.", () => {
|
||||
expect(
|
||||
isRESTCollection({
|
||||
v: 1,
|
||||
name: "test",
|
||||
id: "1",
|
||||
requests: [],
|
||||
folders: [
|
||||
{
|
||||
v: 1,
|
||||
name: "test1",
|
||||
id: "2",
|
||||
requests: undefined,
|
||||
folders: [],
|
||||
},
|
||||
],
|
||||
})
|
||||
).toBeFalsy();
|
||||
});
|
||||
|
||||
test("Invalid HoppRESTRequest(s) in requests.", () => {
|
||||
expect(
|
||||
isRESTCollection({
|
||||
v: 1,
|
||||
name: "test",
|
||||
id: "1",
|
||||
requests: [{}],
|
||||
folders: [],
|
||||
})
|
||||
).toBeFalsy();
|
||||
});
|
||||
|
||||
test("Valid RESTCollection.", () => {
|
||||
expect(
|
||||
isRESTCollection({
|
||||
v: 1,
|
||||
name: "test",
|
||||
id: "1",
|
||||
requests: [],
|
||||
folders: [],
|
||||
})
|
||||
).toBeTruthy();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,116 @@
|
||||
import { collectionsRunner } from "../../../utils/collections";
|
||||
import { HoppRESTRequest } from "@hoppscotch/data";
|
||||
import axios, { AxiosResponse } from "axios";
|
||||
|
||||
import "@relmify/jest-fp-ts";
|
||||
|
||||
jest.mock("axios");
|
||||
|
||||
const SAMPLE_HOPP_REQUEST = <HoppRESTRequest>{
|
||||
v: "1",
|
||||
name: "request",
|
||||
method: "GET",
|
||||
endpoint: "https://example.com",
|
||||
params: [],
|
||||
headers: [],
|
||||
preRequestScript: "",
|
||||
testScript: "",
|
||||
auth: {
|
||||
authActive: false,
|
||||
authType: "none",
|
||||
},
|
||||
body: {
|
||||
contentType: null,
|
||||
body: null,
|
||||
},
|
||||
};
|
||||
|
||||
const SAMPLE_RESOLVED_RESPONSE = <AxiosResponse>{
|
||||
data: { body: 1 },
|
||||
status: 200,
|
||||
statusText: "OK",
|
||||
config: {
|
||||
url: "https://example.com",
|
||||
supported: true,
|
||||
method: "GET",
|
||||
},
|
||||
headers: [],
|
||||
};
|
||||
|
||||
describe("collectionsRunner", () => {
|
||||
beforeEach(() => {
|
||||
jest.clearAllMocks();
|
||||
});
|
||||
|
||||
afterAll(() => {
|
||||
jest.clearAllMocks();
|
||||
});
|
||||
|
||||
test("Empty HoppCollection.", () => {
|
||||
return expect(collectionsRunner([])()).resolves.toStrictEqual([]);
|
||||
});
|
||||
|
||||
test("Empty requests and folders in collection.", () => {
|
||||
return expect(
|
||||
collectionsRunner([
|
||||
{
|
||||
v: 1,
|
||||
name: "name",
|
||||
folders: [],
|
||||
requests: [],
|
||||
},
|
||||
])()
|
||||
).resolves.toMatchObject([]);
|
||||
});
|
||||
|
||||
test("Non-empty requests in collection.", () => {
|
||||
(axios as unknown as jest.Mock).mockResolvedValue(SAMPLE_RESOLVED_RESPONSE);
|
||||
|
||||
return expect(
|
||||
collectionsRunner([
|
||||
{
|
||||
v: 1,
|
||||
name: "collection",
|
||||
folders: [],
|
||||
requests: [SAMPLE_HOPP_REQUEST],
|
||||
},
|
||||
])()
|
||||
).resolves.toMatchObject([
|
||||
{
|
||||
path: "collection/request",
|
||||
tests: [],
|
||||
errors: [],
|
||||
result: true,
|
||||
},
|
||||
]);
|
||||
});
|
||||
|
||||
test("Non-empty folders in collection.", () => {
|
||||
(axios as unknown as jest.Mock).mockResolvedValue(SAMPLE_RESOLVED_RESPONSE);
|
||||
|
||||
return expect(
|
||||
collectionsRunner([
|
||||
{
|
||||
v: 1,
|
||||
name: "collection",
|
||||
folders: [
|
||||
{
|
||||
v: 1,
|
||||
name: "folder",
|
||||
folders: [],
|
||||
requests: [SAMPLE_HOPP_REQUEST],
|
||||
},
|
||||
],
|
||||
requests: [],
|
||||
},
|
||||
])()
|
||||
).resolves.toMatchObject([
|
||||
{
|
||||
path: "collection/folder/request",
|
||||
tests: [],
|
||||
errors: [],
|
||||
result: true,
|
||||
},
|
||||
]);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,35 @@
|
||||
import { collectionsRunnerResult } from "../../../utils/collections";
|
||||
|
||||
const FALSE_RESULT_REPORT = {
|
||||
path: "some_path",
|
||||
tests: [],
|
||||
errors: [],
|
||||
result: false,
|
||||
duration: { test: 1, request: 1, preRequest: 1 },
|
||||
};
|
||||
|
||||
const TRUE_RESULT_REPORT = {
|
||||
path: "some_path",
|
||||
tests: [],
|
||||
errors: [],
|
||||
result: true,
|
||||
duration: { test: 1, request: 1, preRequest: 1 },
|
||||
};
|
||||
|
||||
describe("collectionsRunnerResult", () => {
|
||||
test("Empty request-report.", () => {
|
||||
expect(collectionsRunnerResult([])).toBeTruthy();
|
||||
});
|
||||
|
||||
test("Atleast 1 false result in request-report.", () => {
|
||||
expect(
|
||||
collectionsRunnerResult([FALSE_RESULT_REPORT, TRUE_RESULT_REPORT])
|
||||
).toBeFalsy();
|
||||
});
|
||||
|
||||
test("All true result(s) in request-report.", () => {
|
||||
expect(
|
||||
collectionsRunnerResult([TRUE_RESULT_REPORT, TRUE_RESULT_REPORT])
|
||||
).toBeTruthy();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,24 @@
|
||||
import { DEFAULT_DURATION_PRECISION } from "../../../utils/constants";
|
||||
import { getDurationInSeconds } from "../../../utils/getters";
|
||||
|
||||
describe("getDurationInSeconds", () => {
|
||||
const testDurations = [
|
||||
{ end: [1, 111111111], precision: 1, expected: 1.1 },
|
||||
{ end: [2, 333333333], precision: 2, expected: 2.33 },
|
||||
{
|
||||
end: [3, 555555555],
|
||||
precision: DEFAULT_DURATION_PRECISION,
|
||||
expected: 3.556,
|
||||
},
|
||||
{ end: [4, 777777777], precision: 4, expected: 4.7778 },
|
||||
];
|
||||
|
||||
test.each(testDurations)(
|
||||
"($end.0 s + $end.1 ns) rounded-off to $expected",
|
||||
({ end, precision, expected }) => {
|
||||
expect(getDurationInSeconds(end as [number, number], precision)).toBe(
|
||||
expected
|
||||
);
|
||||
}
|
||||
);
|
||||
});
|
||||
@@ -0,0 +1,42 @@
|
||||
import { Environment } from "@hoppscotch/data";
|
||||
import { getEffectiveFinalMetaData } from "../../../utils/getters";
|
||||
|
||||
const DEFAULT_ENV = <Environment>{
|
||||
name: "name",
|
||||
variables: [{ key: "PARAM", value: "parsed_param" }],
|
||||
};
|
||||
|
||||
describe("getEffectiveFinalMetaData", () => {
|
||||
test("Empty list of meta-data.", () => {
|
||||
expect(getEffectiveFinalMetaData([], DEFAULT_ENV)).toSubsetEqualRight([]);
|
||||
});
|
||||
|
||||
test("Non-empty active list of meta-data with unavailable ENV.", () => {
|
||||
expect(
|
||||
getEffectiveFinalMetaData(
|
||||
[{ active: true, key: "<<UNKNOWN_KEY>>", value: "<<UNKNOWN_VALUE>>" }],
|
||||
DEFAULT_ENV
|
||||
)
|
||||
).toSubsetEqualRight([{ active: true, key: "", value: "" }]);
|
||||
});
|
||||
|
||||
test("Inactive list of meta-data.", () => {
|
||||
expect(
|
||||
getEffectiveFinalMetaData(
|
||||
[{ active: false, key: "KEY", value: "<<PARAM>>" }],
|
||||
DEFAULT_ENV
|
||||
)
|
||||
).toSubsetEqualRight([]);
|
||||
});
|
||||
|
||||
test("Active list of meta-data.", () => {
|
||||
expect(
|
||||
getEffectiveFinalMetaData(
|
||||
[{ active: true, key: "PARAM", value: "<<PARAM>>" }],
|
||||
DEFAULT_ENV
|
||||
)
|
||||
).toSubsetEqualRight([
|
||||
{ active: true, key: "PARAM", value: "parsed_param" },
|
||||
]);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,36 @@
|
||||
import { HoppCLIError } from "../../../types/errors";
|
||||
import { parseCollectionData } from "../../../utils/mutators";
|
||||
|
||||
describe("parseCollectionData", () => {
|
||||
test("Reading non-existing file.", () => {
|
||||
return expect(
|
||||
parseCollectionData("./src/__tests__/samples/notexist.txt")()
|
||||
).resolves.toSubsetEqualLeft(<HoppCLIError>{
|
||||
code: "UNKNOWN_ERROR",
|
||||
});
|
||||
});
|
||||
|
||||
test("Unparseable JSON contents.", () => {
|
||||
return expect(
|
||||
parseCollectionData("./src/__tests__/samples/malformed-collection.json")()
|
||||
).resolves.toSubsetEqualLeft(<HoppCLIError>{
|
||||
code: "MALFORMED_COLLECTION",
|
||||
});
|
||||
});
|
||||
|
||||
test("Invalid HoppCollection.", () => {
|
||||
return expect(
|
||||
parseCollectionData(
|
||||
"./src/__tests__/samples/malformed-collection2.json"
|
||||
)()
|
||||
).resolves.toSubsetEqualLeft(<HoppCLIError>{
|
||||
code: "MALFORMED_COLLECTION",
|
||||
});
|
||||
});
|
||||
|
||||
test("Valid HoppCollection.", () => {
|
||||
return expect(
|
||||
parseCollectionData("./src/__tests__/samples/passes.json")()
|
||||
).resolves.toBeRight();
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,148 @@
|
||||
import { Environment, HoppRESTRequest } from "@hoppscotch/data";
|
||||
import { EffectiveHoppRESTRequest } from "../../../interfaces/request";
|
||||
import { HoppCLIError } from "../../../types/errors";
|
||||
import { getEffectiveRESTRequest } from "../../../utils/pre-request";
|
||||
|
||||
const DEFAULT_ENV = <Environment>{
|
||||
name: "name",
|
||||
variables: [
|
||||
{
|
||||
key: "HEADER",
|
||||
value: "parsed_header",
|
||||
},
|
||||
{ key: "PARAM", value: "parsed_param" },
|
||||
{ key: "TOKEN", value: "parsed_token" },
|
||||
{ key: "BODY_PROP", value: "parsed_body_prop" },
|
||||
{ key: "ENDPOINT", value: "https://parsed-endpoint.com" },
|
||||
],
|
||||
};
|
||||
|
||||
const DEFAULT_REQUEST = <HoppRESTRequest>{
|
||||
v: "1",
|
||||
name: "name",
|
||||
method: "GET",
|
||||
endpoint: "https://example.com",
|
||||
params: [],
|
||||
headers: [],
|
||||
preRequestScript: "",
|
||||
testScript: "",
|
||||
auth: {
|
||||
authActive: false,
|
||||
authType: "none",
|
||||
},
|
||||
body: {
|
||||
contentType: null,
|
||||
body: null,
|
||||
},
|
||||
};
|
||||
|
||||
describe("getEffectiveRESTRequest", () => {
|
||||
let SAMPLE_REQUEST = Object.assign({}, DEFAULT_REQUEST);
|
||||
|
||||
beforeEach(() => {
|
||||
SAMPLE_REQUEST = Object.assign({}, DEFAULT_REQUEST);
|
||||
});
|
||||
|
||||
test("Endpoint, headers and params with unavailable ENV.", () => {
|
||||
SAMPLE_REQUEST.headers = [
|
||||
{
|
||||
key: "HEADER",
|
||||
value: "<<UNKNOWN>>",
|
||||
active: true,
|
||||
},
|
||||
];
|
||||
SAMPLE_REQUEST.params = [
|
||||
{
|
||||
key: "PARAM",
|
||||
value: "<<UNKNOWN>>",
|
||||
active: true,
|
||||
},
|
||||
];
|
||||
SAMPLE_REQUEST.endpoint = "<<UNKNOWN>>";
|
||||
|
||||
expect(
|
||||
getEffectiveRESTRequest(SAMPLE_REQUEST, DEFAULT_ENV)
|
||||
).toSubsetEqualRight(<EffectiveHoppRESTRequest>{
|
||||
effectiveFinalHeaders: [{ active: true, key: "HEADER", value: "" }],
|
||||
effectiveFinalParams: [{ active: true, key: "PARAM", value: "" }],
|
||||
effectiveFinalURL: "",
|
||||
});
|
||||
});
|
||||
|
||||
test("Auth with unavailable ENV.", () => {
|
||||
SAMPLE_REQUEST.auth = {
|
||||
authActive: true,
|
||||
authType: "bearer",
|
||||
token: "<<UNKNOWN>>",
|
||||
};
|
||||
|
||||
expect(
|
||||
getEffectiveRESTRequest(SAMPLE_REQUEST, DEFAULT_ENV)
|
||||
).toSubsetEqualRight(<EffectiveHoppRESTRequest>{
|
||||
effectiveFinalHeaders: [
|
||||
{ active: true, key: "Authorization", value: "Bearer " },
|
||||
],
|
||||
});
|
||||
});
|
||||
|
||||
test("Body with unavailable ENV.", () => {
|
||||
SAMPLE_REQUEST.body = {
|
||||
contentType: "text/plain",
|
||||
body: "<<UNKNOWN>>",
|
||||
};
|
||||
|
||||
expect(
|
||||
getEffectiveRESTRequest(SAMPLE_REQUEST, DEFAULT_ENV)
|
||||
).toSubsetEqualLeft(<HoppCLIError>{
|
||||
code: "PARSING_ERROR",
|
||||
});
|
||||
});
|
||||
|
||||
test("Request meta-data with available ENVs.", () => {
|
||||
SAMPLE_REQUEST.headers = [
|
||||
{
|
||||
key: "HEADER",
|
||||
value: "<<HEADER>>",
|
||||
active: true,
|
||||
},
|
||||
];
|
||||
SAMPLE_REQUEST.params = [
|
||||
{
|
||||
key: "PARAM",
|
||||
value: "<<PARAM>>",
|
||||
active: true,
|
||||
},
|
||||
];
|
||||
SAMPLE_REQUEST.endpoint = "<<ENDPOINT>>";
|
||||
SAMPLE_REQUEST.auth = {
|
||||
authActive: true,
|
||||
authType: "bearer",
|
||||
token: "<<TOKEN>>",
|
||||
};
|
||||
SAMPLE_REQUEST.body = {
|
||||
contentType: "text/plain",
|
||||
body: "<<BODY_PROP>>",
|
||||
};
|
||||
|
||||
const vars = DEFAULT_ENV.variables;
|
||||
|
||||
expect(
|
||||
getEffectiveRESTRequest(SAMPLE_REQUEST, DEFAULT_ENV)
|
||||
).toSubsetEqualRight(<EffectiveHoppRESTRequest>{
|
||||
effectiveFinalHeaders: [
|
||||
{ active: true, key: "HEADER", value: vars[0].value },
|
||||
{
|
||||
active: true,
|
||||
key: "Authorization",
|
||||
value: `Bearer ${vars[2].value}`,
|
||||
},
|
||||
{ active: true, key: "content-type", value: "text/plain" },
|
||||
],
|
||||
effectiveFinalParams: [
|
||||
{ active: true, key: "PARAM", value: vars[1].value },
|
||||
],
|
||||
effectiveFinalURL: vars[4].value,
|
||||
effectiveFinalBody: vars[3].value,
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,24 @@
|
||||
import { PreRequestMetrics, RequestMetrics } from "../../../types/response";
|
||||
import { getPreRequestMetrics } from "../../../utils/pre-request";
|
||||
|
||||
describe("getPreRequestMetrics", () => {
|
||||
test("With empty errors.", () => {
|
||||
expect(getPreRequestMetrics([], 1)).toMatchObject(<PreRequestMetrics>{
|
||||
scripts: { failed: 0, passed: 1 },
|
||||
});
|
||||
});
|
||||
|
||||
test("With non-empty errors.", () => {
|
||||
expect(
|
||||
getPreRequestMetrics(
|
||||
[
|
||||
{ code: "REQUEST_ERROR", data: {} },
|
||||
{ code: "PRE_REQUEST_SCRIPT_ERROR", data: {} },
|
||||
],
|
||||
1
|
||||
)
|
||||
).toMatchObject(<PreRequestMetrics>{
|
||||
scripts: { failed: 1, passed: 0 },
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,71 @@
|
||||
import { HoppRESTRequest } from "@hoppscotch/data";
|
||||
import { HoppEnvs } from "../../../types/request";
|
||||
import * as E from "fp-ts/Either";
|
||||
import { HoppCLIError } from "../../../types/errors";
|
||||
import { EffectiveHoppRESTRequest } from "../../../interfaces/request";
|
||||
import { preRequestScriptRunner } from "../../../utils/pre-request";
|
||||
|
||||
import "@relmify/jest-fp-ts";
|
||||
|
||||
const SAMPLE_ENVS: HoppEnvs = {
|
||||
global: [],
|
||||
selected: [],
|
||||
};
|
||||
const VALID_PRE_REQUEST_SCRIPT = `
|
||||
pw.env.set("ENDPOINT","https://example.com");
|
||||
`;
|
||||
const INVALID_PRE_REQUEST_SCRIPT = "d";
|
||||
const SAMPLE_REQUEST: HoppRESTRequest = {
|
||||
v: "1",
|
||||
name: "request",
|
||||
method: "GET",
|
||||
endpoint: "<<ENDPOINT>>",
|
||||
params: [],
|
||||
headers: [],
|
||||
preRequestScript: "",
|
||||
testScript: "",
|
||||
auth: { authActive: false, authType: "none" },
|
||||
body: {
|
||||
contentType: null,
|
||||
body: null,
|
||||
},
|
||||
};
|
||||
|
||||
describe("preRequestScriptRunner", () => {
|
||||
let SUCCESS_PRE_REQUEST_RUNNER: E.Either<
|
||||
HoppCLIError,
|
||||
EffectiveHoppRESTRequest
|
||||
>,
|
||||
FAILURE_PRE_REQUEST_RUNNER: E.Either<
|
||||
HoppCLIError,
|
||||
EffectiveHoppRESTRequest
|
||||
>;
|
||||
|
||||
beforeAll(async () => {
|
||||
SAMPLE_REQUEST.preRequestScript = VALID_PRE_REQUEST_SCRIPT;
|
||||
SUCCESS_PRE_REQUEST_RUNNER = await preRequestScriptRunner(
|
||||
SAMPLE_REQUEST,
|
||||
SAMPLE_ENVS
|
||||
)();
|
||||
|
||||
SAMPLE_REQUEST.preRequestScript = INVALID_PRE_REQUEST_SCRIPT;
|
||||
FAILURE_PRE_REQUEST_RUNNER = await preRequestScriptRunner(
|
||||
SAMPLE_REQUEST,
|
||||
SAMPLE_ENVS
|
||||
)();
|
||||
});
|
||||
|
||||
test("Parsing of request endpoint with set ENV.", () => {
|
||||
expect(SUCCESS_PRE_REQUEST_RUNNER).toSubsetEqualRight(<
|
||||
EffectiveHoppRESTRequest
|
||||
>{
|
||||
effectiveFinalURL: "https://example.com",
|
||||
});
|
||||
});
|
||||
|
||||
test("Failed execution due to unknown variable error.", () => {
|
||||
expect(FAILURE_PRE_REQUEST_RUNNER).toSubsetEqualLeft(<HoppCLIError>{
|
||||
code: "PRE_REQUEST_SCRIPT_ERROR",
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,24 @@
|
||||
import { RequestMetrics } from "../../../types/response";
|
||||
import { getRequestMetrics } from "../../../utils/request";
|
||||
|
||||
describe("getRequestMetrics", () => {
|
||||
test("With empty errors.", () => {
|
||||
expect(getRequestMetrics([], 1)).toMatchObject(<RequestMetrics>{
|
||||
requests: { failed: 0, passed: 1 },
|
||||
});
|
||||
});
|
||||
|
||||
test("With non-empty errors.", () => {
|
||||
expect(
|
||||
getRequestMetrics(
|
||||
[
|
||||
{ code: "REQUEST_ERROR", data: {} },
|
||||
{ code: "PARSING_ERROR", data: {} },
|
||||
],
|
||||
1
|
||||
)
|
||||
).toMatchObject(<RequestMetrics>{
|
||||
requests: { failed: 1, passed: 0 },
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,104 @@
|
||||
import { HoppRESTRequest } from "@hoppscotch/data";
|
||||
import axios, { AxiosResponse } from "axios";
|
||||
import { processRequest } from "../../../utils/request";
|
||||
import { HoppEnvs } from "../../../types/request";
|
||||
|
||||
import "@relmify/jest-fp-ts";
|
||||
|
||||
jest.mock("axios");
|
||||
|
||||
const DEFAULT_REQUEST = <HoppRESTRequest>{
|
||||
v: "1",
|
||||
name: "name",
|
||||
method: "POST",
|
||||
endpoint: "https://example.com",
|
||||
params: [],
|
||||
headers: [],
|
||||
preRequestScript: "",
|
||||
testScript: "",
|
||||
auth: {
|
||||
authType: "none",
|
||||
authActive: false,
|
||||
},
|
||||
body: {
|
||||
contentType: null,
|
||||
body: null,
|
||||
},
|
||||
};
|
||||
|
||||
const DEFAULT_RESPONSE = <AxiosResponse>{
|
||||
data: {},
|
||||
status: 200,
|
||||
config: {
|
||||
url: "https://example.com",
|
||||
supported: true,
|
||||
method: "POST",
|
||||
},
|
||||
statusText: "OK",
|
||||
headers: [],
|
||||
};
|
||||
|
||||
const DEFAULT_ENVS = <HoppEnvs>{
|
||||
global: [],
|
||||
selected: [],
|
||||
};
|
||||
|
||||
describe("processRequest", () => {
|
||||
let SAMPLE_REQUEST = DEFAULT_REQUEST;
|
||||
|
||||
beforeEach(() => {
|
||||
jest.clearAllMocks();
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
SAMPLE_REQUEST = DEFAULT_REQUEST;
|
||||
});
|
||||
|
||||
test("With empty envs for 'true' result.", () => {
|
||||
(axios as unknown as jest.Mock).mockResolvedValue(DEFAULT_RESPONSE);
|
||||
|
||||
return expect(
|
||||
processRequest(SAMPLE_REQUEST, DEFAULT_ENVS, "fake/collection/path")()
|
||||
).resolves.toMatchObject({
|
||||
report: {
|
||||
result: true,
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
test("With non-empty envs, pre-request-script and test-script.", () => {
|
||||
SAMPLE_REQUEST.preRequestScript = `
|
||||
pw.env.set("ENDPOINT", "https://example.com");
|
||||
`;
|
||||
SAMPLE_REQUEST.testScript = `
|
||||
pw.test("check status.", () => {
|
||||
pw.expect(pw.response.status).toBe(200);
|
||||
});
|
||||
`;
|
||||
|
||||
(axios as unknown as jest.Mock).mockResolvedValue(DEFAULT_RESPONSE);
|
||||
|
||||
return expect(
|
||||
processRequest(SAMPLE_REQUEST, DEFAULT_ENVS, "fake/collection/path")()
|
||||
).resolves.toMatchObject({
|
||||
envs: {
|
||||
selected: [{ key: "ENDPOINT", value: "https://example.com" }],
|
||||
},
|
||||
report: {
|
||||
result: true,
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
test("With invalid-pre-request-script.", () => {
|
||||
SAMPLE_REQUEST.preRequestScript = `invalid`;
|
||||
|
||||
(axios as unknown as jest.Mock).mockResolvedValue(DEFAULT_RESPONSE);
|
||||
|
||||
return expect(
|
||||
processRequest(SAMPLE_REQUEST, DEFAULT_ENVS, "fake/request/path")()
|
||||
).resolves.toMatchObject({
|
||||
report: { result: false },
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,111 @@
|
||||
import axios, { AxiosError, AxiosResponse } from "axios";
|
||||
import { RequestConfig } from "../../../interfaces/request";
|
||||
import { requestRunner } from "../../../utils/request";
|
||||
import { RequestRunnerResponse } from "../../../interfaces/response";
|
||||
|
||||
import "@relmify/jest-fp-ts";
|
||||
|
||||
jest.mock("axios");
|
||||
|
||||
describe("requestRunner", () => {
|
||||
let SAMPLE_REQUEST_CONFIG: RequestConfig = {
|
||||
url: "https://example.com",
|
||||
supported: false,
|
||||
method: "GET",
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
SAMPLE_REQUEST_CONFIG.supported = false;
|
||||
SAMPLE_REQUEST_CONFIG.url = "https://example.com";
|
||||
SAMPLE_REQUEST_CONFIG.method = "GET";
|
||||
jest.clearAllMocks();
|
||||
});
|
||||
|
||||
afterAll(() => {
|
||||
jest.clearAllMocks();
|
||||
});
|
||||
|
||||
it("Should handle axios-error with response info.", () => {
|
||||
jest.spyOn(axios, "isAxiosError").mockReturnValue(true);
|
||||
(axios as unknown as jest.Mock).mockRejectedValueOnce(<AxiosError>{
|
||||
name: "name",
|
||||
message: "message",
|
||||
config: SAMPLE_REQUEST_CONFIG,
|
||||
isAxiosError: true,
|
||||
response: {
|
||||
data: "data",
|
||||
status: 404,
|
||||
statusText: "NOT FOUND",
|
||||
headers: [],
|
||||
config: SAMPLE_REQUEST_CONFIG,
|
||||
},
|
||||
toJSON: () => Object({}),
|
||||
});
|
||||
|
||||
return expect(
|
||||
requestRunner(SAMPLE_REQUEST_CONFIG)()
|
||||
).resolves.toSubsetEqualRight(<RequestRunnerResponse>{
|
||||
body: "data",
|
||||
status: 404,
|
||||
});
|
||||
});
|
||||
|
||||
it("Should handle axios-error for unsupported request.", () => {
|
||||
jest.spyOn(axios, "isAxiosError").mockReturnValue(true);
|
||||
(axios as unknown as jest.Mock).mockRejectedValueOnce(<AxiosError>{
|
||||
name: "name",
|
||||
message: "message",
|
||||
config: SAMPLE_REQUEST_CONFIG,
|
||||
isAxiosError: true,
|
||||
toJSON: () => Object({}),
|
||||
});
|
||||
|
||||
return expect(
|
||||
requestRunner(SAMPLE_REQUEST_CONFIG)()
|
||||
).resolves.toSubsetEqualRight(<RequestRunnerResponse>{
|
||||
status: 501,
|
||||
body: {},
|
||||
});
|
||||
});
|
||||
|
||||
it("Should handle axios-error with request info.", () => {
|
||||
jest.spyOn(axios, "isAxiosError").mockReturnValue(true);
|
||||
SAMPLE_REQUEST_CONFIG.supported = true;
|
||||
(axios as unknown as jest.Mock).mockRejectedValueOnce(<AxiosError>{
|
||||
name: "name",
|
||||
message: "message",
|
||||
config: SAMPLE_REQUEST_CONFIG,
|
||||
isAxiosError: true,
|
||||
request: {},
|
||||
toJSON: () => Object({}),
|
||||
});
|
||||
|
||||
return expect(requestRunner(SAMPLE_REQUEST_CONFIG)()).resolves.toBeLeft();
|
||||
});
|
||||
|
||||
it("Should handle unknown error.", () => {
|
||||
jest.spyOn(axios, "isAxiosError").mockReturnValue(false);
|
||||
(axios as unknown as jest.Mock).mockRejectedValueOnce({});
|
||||
|
||||
return expect(requestRunner(SAMPLE_REQUEST_CONFIG)()).resolves.toBeLeft();
|
||||
});
|
||||
|
||||
it("Should successfully execute.", () => {
|
||||
SAMPLE_REQUEST_CONFIG.supported = true;
|
||||
(axios as unknown as jest.Mock).mockResolvedValue(<AxiosResponse>{
|
||||
data: "data",
|
||||
status: 200,
|
||||
config: SAMPLE_REQUEST_CONFIG,
|
||||
statusText: "OK",
|
||||
headers: [],
|
||||
});
|
||||
|
||||
return expect(
|
||||
requestRunner(SAMPLE_REQUEST_CONFIG)()
|
||||
).resolves.toSubsetEqualRight(<RequestRunnerResponse>{
|
||||
status: 200,
|
||||
body: "data",
|
||||
method: "GET",
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,55 @@
|
||||
import { TestMetrics } from "../../../types/response";
|
||||
import { getTestMetrics } from "../../../utils/test";
|
||||
|
||||
describe("getTestMetrics", () => {
|
||||
test("With empty test-reports and errors.", () => {
|
||||
expect(getTestMetrics([], 1, [])).toMatchObject(<TestMetrics>{
|
||||
tests: { passed: 0, failed: 0 },
|
||||
testSuites: { failed: 0, passed: 0 },
|
||||
duration: 1,
|
||||
scripts: { failed: 0, passed: 1 },
|
||||
});
|
||||
});
|
||||
|
||||
test("With non-empty test-reports and no test-script-error.", () => {
|
||||
expect(
|
||||
getTestMetrics(
|
||||
[
|
||||
{
|
||||
descriptor: "descriptor",
|
||||
expectResults: [],
|
||||
failed: 0,
|
||||
passed: 2,
|
||||
},
|
||||
{
|
||||
descriptor: "descriptor",
|
||||
expectResults: [],
|
||||
failed: 2,
|
||||
passed: 1,
|
||||
},
|
||||
],
|
||||
5,
|
||||
[]
|
||||
)
|
||||
).toMatchObject(<TestMetrics>{
|
||||
tests: { failed: 2, passed: 3 },
|
||||
testSuites: { failed: 1, passed: 1 },
|
||||
scripts: { failed: 0, passed: 1 },
|
||||
duration: 5,
|
||||
});
|
||||
});
|
||||
|
||||
test("With empty test-reports and some test-script-error.", () => {
|
||||
expect(
|
||||
getTestMetrics([], 5, [
|
||||
{ code: "TEST_SCRIPT_ERROR", data: {} },
|
||||
{ code: "PRE_REQUEST_SCRIPT_ERROR", data: {} },
|
||||
])
|
||||
).toMatchObject(<TestMetrics>{
|
||||
tests: { failed: 0, passed: 0 },
|
||||
testSuites: { failed: 0, passed: 0 },
|
||||
scripts: { failed: 1, passed: 0 },
|
||||
duration: 5,
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,63 @@
|
||||
import { TestDescriptor } from "@hoppscotch/js-sandbox";
|
||||
import { testDescriptorParser, getTestMetrics } from "../../../utils/test";
|
||||
import { TestReport } from "../../../interfaces/response";
|
||||
import { TestMetrics } from "../../../types/response";
|
||||
|
||||
import "@relmify/jest-fp-ts";
|
||||
|
||||
const SAMPLE_TEST_DESCRIPTOR: TestDescriptor = {
|
||||
descriptor: "Status code is 200",
|
||||
expectResults: [
|
||||
{
|
||||
status: "error",
|
||||
message: "some_message",
|
||||
},
|
||||
],
|
||||
children: [
|
||||
{
|
||||
descriptor: "Check JSON response property",
|
||||
expectResults: [
|
||||
{
|
||||
status: "pass",
|
||||
message: "some_message",
|
||||
},
|
||||
],
|
||||
children: [],
|
||||
},
|
||||
{
|
||||
descriptor: "Check header property",
|
||||
expectResults: [
|
||||
{
|
||||
status: "fail",
|
||||
message: "some_message",
|
||||
},
|
||||
],
|
||||
children: [],
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
describe("testDescriptorParser", () => {
|
||||
let TEST_REPORT: TestReport[];
|
||||
beforeAll(async () => {
|
||||
TEST_REPORT = await testDescriptorParser(SAMPLE_TEST_DESCRIPTOR)();
|
||||
});
|
||||
|
||||
it("Should have 3 tests-report.", () => {
|
||||
expect(TEST_REPORT).toEqual(expect.any(Array));
|
||||
expect(TEST_REPORT.length).toStrictEqual(3);
|
||||
});
|
||||
|
||||
it("Should have 1 passed, 2 failed test-cases; 1 passed, 2 failed test-suite.", () => {
|
||||
expect(getTestMetrics(TEST_REPORT, 1, [])).toMatchObject(<TestMetrics>{
|
||||
tests: {
|
||||
failed: 2,
|
||||
passed: 1,
|
||||
},
|
||||
testSuites: {
|
||||
failed: 2,
|
||||
passed: 1,
|
||||
},
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,73 @@
|
||||
import { TestResponse } from "@hoppscotch/js-sandbox";
|
||||
import * as E from "fp-ts/Either";
|
||||
import { TestRunnerRes } from "../../../types/response";
|
||||
import { HoppCLIError } from "../../../types/errors";
|
||||
import { getTestMetrics, testRunner } from "../../../utils/test";
|
||||
import { HoppEnvs } from "../../../types/request";
|
||||
|
||||
import "@relmify/jest-fp-ts";
|
||||
|
||||
const SAMPLE_ENVS: HoppEnvs = {
|
||||
global: [],
|
||||
selected: [
|
||||
{
|
||||
key: "DEVBLIN",
|
||||
value: "set-by-devblin",
|
||||
},
|
||||
],
|
||||
};
|
||||
const SAMPLE_RESPONSE: TestResponse = {
|
||||
status: 200,
|
||||
headers: [],
|
||||
body: {},
|
||||
};
|
||||
|
||||
describe("testRunner", () => {
|
||||
let SUCCESS_TEST_RUNNER_RES: E.Either<HoppCLIError, TestRunnerRes>,
|
||||
FAILURE_TEST_RUNNER_RES: E.Either<HoppCLIError, TestRunnerRes>;
|
||||
|
||||
beforeAll(async () => {
|
||||
SUCCESS_TEST_RUNNER_RES = await testRunner({
|
||||
testScript: `
|
||||
// Check status code is 200
|
||||
pw.test("Status code is 200", ()=> {
|
||||
pw.expect(pw.response.status).toBe(200);
|
||||
});
|
||||
|
||||
// Check JSON response property
|
||||
pw.test("Check JSON response property", ()=> {
|
||||
pw.expect(pw.response.body).toBeType("string")
|
||||
pw.expect(pw.response.body).toBe("body");
|
||||
});
|
||||
`,
|
||||
envs: SAMPLE_ENVS,
|
||||
response: SAMPLE_RESPONSE,
|
||||
})();
|
||||
|
||||
FAILURE_TEST_RUNNER_RES = await testRunner({
|
||||
testScript: "a",
|
||||
envs: SAMPLE_ENVS,
|
||||
response: SAMPLE_RESPONSE,
|
||||
})();
|
||||
});
|
||||
|
||||
it("Should have 2 failed, 1 passed test-cases; 1 failed, 1 passed test-suites.", () => {
|
||||
expect(SUCCESS_TEST_RUNNER_RES).toBeRight();
|
||||
|
||||
if (E.isRight(SUCCESS_TEST_RUNNER_RES)) {
|
||||
const { duration, testsReport } = SUCCESS_TEST_RUNNER_RES.right;
|
||||
const { tests, testSuites } = getTestMetrics(testsReport, duration, []);
|
||||
|
||||
expect(tests.failed).toStrictEqual(2);
|
||||
expect(tests.passed).toStrictEqual(1);
|
||||
expect(testSuites.failed).toStrictEqual(1);
|
||||
expect(testSuites.passed).toStrictEqual(1);
|
||||
}
|
||||
});
|
||||
|
||||
it("Should fail to execute with test-script-error.", () => {
|
||||
expect(FAILURE_TEST_RUNNER_RES).toSubsetEqualLeft(<HoppCLIError>{
|
||||
code: "TEST_SCRIPT_ERROR",
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user