View as Markdown

Introduction 📌

A sample CRUD application to see how Keploy integrates effortlessly with Express.js and MongoDB. Get ready to see the power of Keploy 🔅🔅.

This runs natively on Linux, macOS (Apple Silicon) and Windows (x86-64) — see Installing Keploy.

Get Started! 🎬

Clone the repository and move to express-mongodb folder

git clone https://github.com/keploy/samples-typescript && cd samples-typescript/express-mongodb

# Install the dependencies
npm install

🛠️ Platform-Specific Requirements for Keploy

Below is a table summarizing the tools needed for both native and Docker installations of Keploy on macOS, Windows, and Linux:

Operating System	Without Docker	Docker Installation	Prerequisites
macOS	Native, Apple Silicon (Go, Node, Python, Java)	Guide	Native: nothing to install — no Docker, no Lima, no sudo. Only if you choose a container route: Docker Desktop 4.25.2+, or Lima (which is also the route on an Intel Mac).
Windows	Native, x86‑64 (Go, Node, Python, Java)	Guide	Native: nothing to install — no WSL, no Docker, no Administrator. Only if you choose a container route: WSL (wsl --install, Windows 10 2004+/build 19041+ or Windows 11 — also the route on Windows/ARM), or Docker Desktop 4.25.2+.
Linux			Linux kernel 5.10 or higher

Keploy runs natively on macOS (Apple Silicon / arm64) and Windows (x86‑64) — neither has eBPF, so it intercepts traffic in userspace on both, and neither needs sudo or Administrator. Natively on macOS and Windows, Keploy understands HTTP/HTTPS, MySQL and MongoDB calls; calls to other services — PostgreSQL, Redis, Kafka, gRPC and the like — are captured only as raw bytes and usually don't replay, so for an app that runs in containers or depends on them, use Docker. Docker, Lima (macOS) and WSL (Windows) remain supported alternatives, and WSL is the route on Windows on ARM. On an Intel Mac use Lima: the Docker route on macOS still runs the native CLI on the host, so it is Apple Silicon only too.

Low-latency recording (keploy record --low-latency, or a Kubernetes Sidecar with low_latency_mode) and the Kubernetes DaemonSet agent capture with eBPF hooks that arm64 kernels support only from 6.4 (x86-64 kernels from 5.10). On an older arm64 kernel, record without low latency, and use Sidecar mode without low_latency_mode in Kubernetes.

Podman

On Linux, Keploy records and tests applications that run in Podman as well as in Docker. In a keploy record or keploy test command, use podman run (or podman compose) where these docs use docker run (or docker compose). Run every other container command they give, such as creating the network, building the image or starting a database with docker run -d, as sudo podman ..., so that it is in the rootful Podman Keploy uses. See the Podman tab under Linux in Installing Keploy for the commands.

• Rootful Podman. Keploy's agent loads eBPF, which a rootless Podman can't grant, so Keploy drives the rootful Podman and runs as root (it re-runs itself with sudo when it needs to). Images and containers you created with Podman without sudo aren't visible to it: build or pull your app's image with sudo podman.
• Podman's API. Keploy talks to Podman's Docker-compatible API. If the rootful podman.socket is enabled (sudo systemctl enable --now podman.socket) it uses that; otherwise it starts Podman's API service for the run and stops it when Keploy exits.
• Compose. podman compose (Podman 4.7 or later; Keploy is tested with Podman 5) works with Docker Compose v2 or later (docker-compose) as its compose provider, on a host that runs systemd: Podman runs healthchecks with systemd timers, and your app's service waits for the healthcheck of Keploy's agent service. podman-compose isn't supported.
• Local Podman on Linux only. A Podman set up as a podman-remote client (for example with CONTAINER_HOST, CONTAINER_CONNECTION, or remote = true in containers.conf) runs containers in another Podman service, but Keploy's agent runs in the local rootful Podman, so Keploy refuses it. On macOS and Windows, including Podman machine, Keploy refuses Podman commands: its agent uses Linux's eBPF.
• Which Keploy. Podman support is in the Keploy that curl --silent -O -L https://keploy.io/install.sh && source install.sh installs (free with an account), from v3.8.60. A keploy built from the open-source repository refuses Podman commands and says where to get it.

Installation Overview

The install is the same whatever your plan. You need a free Keploy account to record and replay: the first keploy record or keploy test signs you in, and your plan decides which additional features are available.

Quick Installation Using CLI

On Linux and macOS (Apple Silicon), install Keploy with:

 curl --silent -O -L https://keploy.io/install.sh && source install.sh

You should see something like this:

       ▓██▓▄
    ▓▓▓▓██▓█▓▄
     ████████▓▒
          ▀▓▓███▄      ▄▄   ▄               ▌
         ▄▌▌▓▓████▄    ██ ▓█▀  ▄▌▀▄  ▓▓▌▄   ▓█  ▄▌▓▓▌▄ ▌▌   ▓
       ▓█████████▌▓▓   ██▓█▄  ▓█▄▓▓ ▐█▌  ██ ▓█  █▌  ██  █▌ █▓
      ▓▓▓▓▀▀▀▀▓▓▓▓▓▓▌  ██  █▓  ▓▌▄▄ ▐█▓▄▓█▀ █▓█ ▀█▄▄█▀   █▓█
       ▓▌                           ▐█▌                   █▌
        ▓

Keploy CLI

Available Commands:
  example           Example to record and test via keploy
  config --generate generate the keploy configuration file
  record            record the keploy testcases from the API calls
  test              run the recorded testcases and execute assertions
  update            Update Keploy

Flags:
      --debug     Run in debug mode
  -h, --help      help for keploy
  -v, --version   version for keploy

Use "keploy [command] --help" for more information about a command.

🎉 Wohoo! You are all set to use Keploy.

On Windows (x86-64), Keploy is a single keploy.exe, installed from PowerShell without Administrator — see Run Keploy natively on Windows.

Other Installation Methods

Install using Docker

Downloading and running Keploy in Docker

With this method your application and Keploy's agent run in Docker, but the keploy CLI — which starts them both — runs on your machine. Use it when your app runs in containers, or on macOS and Windows when your app depends on services beyond HTTP/HTTPS, MySQL and MongoDB: natively there, calls to other services — PostgreSQL, Redis, Kafka, gRPC and the like — are captured only as raw bytes and usually don't replay.

1. Open up a terminal window.

2. Create a bridge network in Docker using the following docker network create command:

docker network create keploy-network

3. Install Keploy: on Linux and macOS with the command below, on Windows with the PowerShell steps. On macOS the CLI is Apple Silicon (arm64) only — on an Intel Mac, run Keploy with Lima instead.

 curl --silent -O -L https://keploy.io/install.sh && source install.sh

Examples:

Record:

keploy record -c "docker run -p <appPort>:<hostPort> --name <containerName> --network keploy-network <applicationImage>" --container-name "<containerName>" --buildDelay 60

Test:

keploy test --c "docker run -p <appPort>:<hostPort>  --name <containerName> --network keploy-network <applicationImage>" --delay 10

Install using Podman (Linux)

Keploy also records and tests applications that run in rootful Podman on Linux, started with podman run or podman compose: see the Podman tab under Linux in Installing Keploy.

Install Manually

Downloading the Keploy binary yourself

These download the same keploy binary the install command above installs.

On Linux

Prerequisite: Linux kernel 5.10 or higher (uname -r shows yours). This picks the build for your architecture:

case "$(uname -m)" in
  x86_64) ARCH=amd64 ;;
  aarch64 | arm64) ARCH=arm64 ;;
  *) echo "unsupported architecture: $(uname -m)" >&2; false ;;
esac &&
  curl --fail --silent --show-error --location -o /tmp/keploy \
    "https://keploy.io/ent/dl/latest/enterprise_linux_${ARCH}" &&
  sudo install -m 0755 /tmp/keploy /usr/local/bin/keploy

The same steps work inside WSL on Windows and inside a Lima VM on macOS.

On macOS (Apple Silicon)

mkdir -p ~/.keploy/bin &&
  curl --fail --silent --show-error --location -o ~/.keploy/bin/keploy \
    "https://keploy.io/ent/dl/latest/enterprise_darwin_arm64" &&
  chmod +x ~/.keploy/bin/keploy
export PATH="$HOME/.keploy/bin:$PATH"   # add this line to your ~/.zshrc too

There is no Intel macOS build: on an Intel Mac, use the Linux steps inside Lima.

On Windows (x86-64)

Follow the PowerShell steps. On Windows on ARM, use the Linux steps inside WSL.

If you run Keploy inside WSL with Docker: setting up Docker Desktop for WSL 2

1. Install Docker Desktop for Windows from here.

When developing on Windows with Docker Desktop and WSL 2, it's crucial to configure Docker Desktop to allow WSL 2 distributions to access the Docker daemon. This setup enables seamless integration between your Windows environment, WSL 2 Linux distros, and Docker.

By default, Docker Desktop may not be configured to work with all WSL 2 distros out of the box. Proper configuration ensures that you can run Docker commands from within your WSL 2 environment, allowing for a more native Linux development experience while leveraging the power of Windows.

This setup is essential for Keploy to function correctly in a WSL 2 environment, as it needs to interact with the Docker daemon to manage containers and networks effectively. For detailed instructions on how to configure Docker Desktop for WSL 2, please refer to the official Docker documentation.

🎉 Wohoo! We are all set to use Keploy.

🎬 Capturing Testcases

To begin recording your application's API calls, open your terminal and navigate to your application directory using the cd command. Then, execute the following command:

keploy record -c "npm start"

On macOS, Keploy is dropped by the npm start launcher — run the app's entry point directly instead, here and in keploy test below: keploy record -c "node server.js" (details).

Make API Calls using Hoppscotch, Postman or curl command. Keploy will capture those calls to generate the test-suites containing testcases and data mocks.

1. Give Product details
POST REQUEST

curl --request POST \
  --url http://localhost:3000/api/products \
  --header 'content-type: application/json' \
  --data '{
    "name" : "airpods",
    "quantity": 4,
    "price": 20000
}'

Here's a response of what you get:

{
  "name": "airpods",
  "quantity": 4,
  "price": 20000,
  "_id": "6629499175a4795410ee4012",
  "createdAt": "2024-04-24T18:04:01.499Z",
  "updatedAt": "2024-04-24T18:04:01.499Z",
  "__v": 0
}

2. Get the Product details
GET REQUEST

curl --location --request GET 'http://localhost:3000/api/products/:id'

Replace the :id, with the id of the product of which you want the details in the upcoming API request!

3. Update the Product details
PUT REQUEST

curl --location --request PUT 'http://localhost:3000/api/products/:id' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "airpods",
    "quantity": 4,
    "price": 20000
    }'

4. Delete a Product details
DELETE REQUEST

curl --location --request DELETE 'http://localhost:8080/potions/:id'

🎉 Easy right! Just one API call and you've whipped up a test case with a mock. Check out the Keploy directory to find your shiny new test-1.yml and mocks.yml files.

version: api.keploy.io/v1beta1
kind: Http
name: test-1
spec:
  metadata: {}
  req:
    method: GET
    proto_major: 1
    proto_minor: 1
    url: http://localhost:3000/
    header:
      Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8
      Accept-Encoding: gzip, deflate, br
      Accept-Language: en-GB,en
      Connection: keep-alived
      Host: localhost:3000
      If-None-Match: W/"22-1zTtRKCtWDH+a9AlmEC9xS1mvKM"
      Sec-Ch-Ua: '"Chromium";v="122", "Not(A:Brand";v="24", "Brave";v="122"'
      Sec-Ch-Ua-Mobile: ?0
      Sec-Ch-Ua-Platform: '"Linux"'
      Sec-Fetch-Dest: document
      Sec-Fetch-Mode: navigate
      Sec-Fetch-Site: none
      Sec-Fetch-User: ?1
      Sec-Gpc: "1"
      Upgrade-Insecure-Requests: "1"
      User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36
    body: ""
    timestamp: 2024-04-22T14:59:23.376284154+05:30
  resp:
    status_code: 304
    header:
      Connection: keep-alive
      Date: Mon, 22 Apr 2024 09:29:23 GMT
      Etag: W/"22-1zTtRKCtWDH+a9AlmEC9xS1mvKM"
      Keep-Alive: timeout=5
      X-Powered-By: Express
    body: ""
    status_message: Not Modified
    proto_major: 0
    proto_minor: 0
    timestamp: 2024-04-22T14:59:23.516347365+05:30
  objects: []
  assertions:
    noise:
      header.Date: []
  created: 1713778163
curl: |
  curl --request GET \
    --url http://localhost:3000/ \
    --header 'Sec-Fetch-User: ?1' \
    --header 'Sec-Fetch-Dest: document' \
    --header 'Upgrade-Insecure-Requests: 1' \
    --header 'Sec-Gpc: 1' \
    --header 'Accept-Encoding: gzip, deflate, br' \
    --header 'Sec-Fetch-Mode: navigate' \
    --header 'Accept-Language: en-GB,en' \
    --header 'Host: localhost:3000' \
    --header 'If-None-Match: W/"22-1zTtRKCtWDH+a9AlmEC9xS1mvKM"' \
    --header 'Sec-Ch-Ua-Mobile: ?0' \
    --header 'User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36' \
    --header 'Sec-Fetch-Site: none' \
    --header 'Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8' \
    --header 'Connection: keep-alive' \
    --header 'Sec-Ch-Ua: "Chromium";v="122", "Not(A:Brand";v="24", "Brave";v="122"' \
    --header 'Sec-Ch-Ua-Platform: "Linux"' \

Run keploy test

Want to see it in action? Run the following command to execute your Keploy tests

keploy test -c "npm start" --delay 10

Great job following along 🥳! Now, let's dive deeper and explore how to do Keploy integration with jest test 📌

Get Keploy jest sdk

npm i @keploy/sdk nyc jest

Update package file

Update the package.json file that runs the application:

 "scripts": {
    //other scripts
    "test": "jest --coverage --collectCoverageFrom='src/**/*.{js,jsx}'",
    "coverage": "nyc npm test && npm run coverage:merge && npm run coverage:report",
    "coverage:merge": "mkdir -p ./coverage && nyc merge ./coverage .nyc_output/out.json",
    "coverage:report": "nyc report --reporter=lcov --reporter=text"
    //other scripts
  }

Usage

For the code coverage for the keploy API tests using the jest integration, you need to add the following test to your Jest test file. It can be called as keploy.test.js. Jest test file. It can be called as keploy.test.js.

const {expect} = require("@jest/globals");
const keploy = require("@keploy/sdk");
const timeOut = 300000;

describe(
  "Keploy Server Tests",
  () => {
    test(
      "TestKeploy",
      (done) => {
        const cmd = "npm start";
        const options = {};
        keploy.Test(cmd, options, (err, res) => {
          if (err) {
            done(err);
          } else {
            expect(res).toBeTruthy(); // Assert the test result
            done();
          }
        });
      },
      timeOut
    );
  },
  timeOut
);

Now let's run jest tests along keploy using command

npm test

To get Combined coverage with keploy test coverage

npm run coverage

Wrapping it up 🎉

Congratulations! You've conquered Keploy and unleashed its power for effortless testing in your NodeJS application. With Jest by your side, you can ensure rock-solid code coverage. Time to go forth and build amazing things! 🧑🏻‍💻

Hope this helps you out, if you still have any questions, reach out to us .

Related

• Node.js Express Mongoose Sample — Express + Mongoose variant.
• sample course selling api (express) — another Express + Mongo app.
• Sample JavaScript Apps — browse all JS quickstarts.