feat(wrappedNodeFetch.test.ts): add test for the octokit module and j…

…est config

Signed-off-by: Tanmay Bajaj <[email protected]>

.github/workflows/ci.yml

@@ -33,3 +33,6 @@ jobs:
 
       - name: Check commits messages
         uses: wagoid/commitlint-github-action@v5
+
+      - name: Run the tests
+        run: npm test -- --coverage  

.gitignore

@@ -184,4 +184,7 @@ node_modules
 
 # Build files
 
-dist
+dist
+
+# Test files
+coverage

integrations/octokit/wrappedNodeFetch.test.ts

@@ -0,0 +1,122 @@
+import { describe, it, expect, jest } from "@jest/globals";
+import { createExecutionContext, getExecutionContext } from "../../src/context";
+import fetch, { Response } from "node-fetch";
+import { wrappedNodeFetch } from "./require";
+import { HTTP } from "../../src/keploy";
+
+describe("test for wrappedNodeFetch", () => {
+  it("should call fetch function in the record mode with proper agent", async () => {
+    const ctx = {
+      mode: "record",
+      testId: "test-1",
+      mocks: [],
+      deps: [],
+    };
+    createExecutionContext(ctx);
+    const wrappedFetch = (wrappedNodeFetch(fetch) as any).bind({
+      fetch: fetch,
+    });
+    const options = {
+      method: "GET",
+    };
+    const url = "https://www.reqres.in/api/users/2";
+    const resp = await wrappedFetch(url, options);
+    const responseBody = await resp.json();
+    const updatedCtx = getExecutionContext().context;
+    const output = updatedCtx.mocks[0].Spec.Res.Body;
+
+    expect(fetch).toHaveBeenCalled();
+    expect(resp).toHaveProperty("body");
+    expect(resp).toBeInstanceOf(Response);
+    expect(updatedCtx.mocks[0].Spec.Metadata.options).toEqual(options);
+    expect(updatedCtx.mocks.length).toBeGreaterThan(0);
+    expect(responseBody).toEqual(output);
+  });
+
+  it("should return the correct response in test mode", async () => {
+    const capturedResponse = new Response("captured");
+    const ctx = {
+      mode: "test",
+      testId: "test-1",
+      mocks: [
+        {
+          Version: "V1_BETA2",
+          Name: "test-1",
+          Kind: HTTP,
+          Spec: {
+            Metadata: {
+              name: "node-fetch",
+              url: "https://www.reqres.in/api/users/2",
+              options: { method: "GET" },
+              type: "HTTP_CLIENT",
+            },
+            Req: {
+              URL: "https://www.reqres.in/api/users/2",
+              Body: "",
+              Header: {},
+              Method: "GET",
+            },
+            Res: {
+              Header: { "content-type": "application/json" },
+              Body: "captured",
+              StatusCode: 200,
+            },
+          },
+        },
+      ],
+      deps: [],
+    };
+    createExecutionContext(ctx);
+    const wrappedFetch = (wrappedNodeFetch(fetch) as any).bind({ fetch });
+    const url = "https://www.reqres.in/api/users/2";
+    const options = {
+      method: "GET",
+    };
+    const resp = await wrappedFetch(url, options);
+    const updatedCtx = getExecutionContext().context;
+
+    expect(resp.status).toEqual(capturedResponse.status);
+    expect(resp.statusText).toEqual(capturedResponse.statusText);
+    expect(updatedCtx.mocks.length).toBe(0);
+  });
+
+  it("should return undefined if the context execution is not present in test mode", async () => {
+    const mockFetch = jest.fn().mockResolvedValue(new Response());
+    const spyConsole = jest.spyOn(console, "error").mockImplementation;
+    const wrappedFetch = (wrappedNodeFetch(mockFetch) as any).bind({
+      fetch: mockFetch,
+    });
+    const url = "https://www.reqres.in/api/users/2";
+    const options = {
+      method: "GET",
+    };
+    const resp = await wrappedFetch(url, options);
+
+    expect(resp).toBeUndefined();
+    expect(spyConsole).toHaveBeenCalledWith(
+      "keploy context is not present to mock dependencies"
+    );
+  });
+
+  it("should call fetch function with proper arguments in off mode", async () => {
+    const mockFetch = jest.fn().mockResolvedValue(new Response());
+    const ctx = {
+      mode: "off",
+      testId: "test-1",
+      mocks: [],
+      deps: [],
+    };
+    createExecutionContext(ctx);
+    const wrappedFetch = (wrappedNodeFetch(mockFetch) as any).bind({
+      fetch: mockFetch,
+    });
+    const url = "https://www.reqres.in/api/users/2";
+    const options = {
+      method: "GET",
+    };
+    const resp = await wrappedFetch(url, options);
+
+    expect(resp).toBeInstanceOf(Response);
+    expect(mockFetch).toHaveBeenCalledWith(url, options);
+  });
+});

jest.config.ts

@@ -0,0 +1,195 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+export default {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/tmp/jest_rs",
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: undefined,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: "v8",
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // The default configuration for fake timers
+  // fakeTimers: {
+  //   "enableGlobally": false
+  // },
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "mjs",
+  //   "cjs",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "json",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state before every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: undefined,
+
+  // Automatically restore mock state and implementation before every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  // testEnvironment: "jest-environment-node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: undefined,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jest-circus/runner",
+
+  // A map from regular expressions to paths to transformers
+  // transform: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: undefined,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

package.json

@@ -8,14 +8,16 @@
   "scripts": {
     "build": "tsc && cp ./proto/services.proto ./dist/proto/",
     "prepare": "npm run build",
-    "commit": "cz"
+    "commit": "cz",
+    "test": "jest"
   },
   "repository": "[email protected]:keploy/typescript-sdk.git",
   "author": "Keploy <[email protected]>",
   "license": "MIT",
   "devDependencies": {
     "@commitlint/cli": "^16.2.1",
     "@commitlint/config-conventional": "^16.2.1",
+    "@jest/globals": "^29.5.0",
     "@types/cors": "^2.8.12",
     "@types/express": "^4.17.13",
     "@types/merge-descriptors": "^1.0.1",
@@ -32,6 +34,7 @@
     "eslint-plugin-prettier": "^4.0.0",
     "husky": "^7.0.4",
     "prettier": "^2.5.1",
+    "ts-jest": "^29.0.5",
     "typescript": "^4.6.2"
   },
   "config": {