Express + PostgreSQL + Prisma Sample Application

Introduction

A sample Task Management application and see how seamlessly Keploy integrates with Express , PostgreSQL and Prisma ORM. Buckle up, it's gonna be a fun ride! 🎢

🛠️ 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			Docker Desktop version must be 4.25.2 or above
Windows			- Use WSL `wsl --install` - Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11
Linux			Linux kernel 5.15 or higher

On MacOS and Windows, additional tools are required for Keploy due to the lack of native eBPF support.

Keploy Installation

Quick Installation Using CLI

Let's get started by setting up the Keploy alias with this command:

 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.

Other Installation Methods

Install using Docker

Downloading and running Keploy in Docker

On macOS

Note : Keploy is not supported natively on MacOS, so you can follow the below method to run with docker

Open up a terminal window.
Create a bridge network in Docker using the following docker network create command:

docker network create keploy-network

Run the following command to start the Keploy container:

alias keploy="docker run --name keploy-v2 -p 16789:16789 --network keploy-network --privileged --pid=host -v $(pwd):$(pwd) -w $(pwd) -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm ghcr.io/keploy/keploy"

Running Keploy Natively on MacOS by setting up a linux env

Downloading and running Keploy in Native using Debian on MacOS

Open the terminal Session.
Run the following command

limactl show-ssh --format=config debian-12 & add it to its ssh config

Open a remote window on your code editor
Click on connect to host
Now select the configured SSH as "lima-debian"
Once you are in the terminal run the following commands to go into your directory

cd /Users

cd /{Username}

Run the following command to install Keploy

curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy

Run the following command to install Zsh

sudo apt-get -y install zsh

Why? : zsh (Z Shell) is an advanced shell that offers enhanced features compared to the default bash shell. It provides better autocompletion, advanced globbing, improved history management, and more customization options.

Install Git

sudo apt-get -y install git

Install 'Oh-my-zsh'

sh -c "$(wget https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh -O -)"

Why? : oh-my-zsh is a framework for managing your zsh configuration. It comes with a collection of plugins, themes, and helpful features that enhance the zsh experience.

Commands to Install docker

sudo apt-get -y update

sudo apt-get -y install ca-certificates curl

sudo install -m 0755 -d /etc/apt/keyrings

sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc

sudo chmod a+r /etc/apt/keyrings/docker.asc

echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

sudo apt-get -y update

sudo apt-get -y update

sudo apt-get -y install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

Add docker to sudoers

sudo groupadd docker

sudo gpasswd -a $USER docker

Downloading and running Keploy in Native

Prequisites:

Linux Kernel version 5.15 or higher
Run uname -a to verify the system architecture.
In case of Windows, use WSL with Ubuntu 20.04 LTS or higher.

Downloading and running Keploy On WSL/Linux AMD

On WSL/Linux AMD

Open the terminal Session.
Run the following command to download and install Keploy:

curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_amd64.tar.gz" | tar xz --overwrite -C /tmp
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy

On WSL/Linux ARM

Open the terminal Session
Run the following command to download and install Keploy:

curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_arm64.tar.gz" | tar xz --overwrite -C /tmp
sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin/keploy

Note: Keploy is not supported on MacOS natively.

Setting up the Docker Desktop for WSL 2

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.

With Arkade

Installing Arkade

# Note: you can also run without `sudo` and move the binary yourself
curl -sLS https://get.arkade.dev | sudo sh

arkade --help
ark --help  # a handy alias

# Windows users with Git Bash
curl -sLS https://get.arkade.dev | sh

Install Keploy

arkade get keploy

Or you can also download specific version of Keploy using the following command:

arkade get keploy@2.2.0-alpha23

Get Started! 🎬

Prerequisites

Ensure you have the following installed:

Docker
Node.js and npm
Keploy CLI

Clone the repository and move to express-postgresql-prisma folder

git clone https://github.com/keploy/samples-typescript.git
cd samples-typescript/express-postgresql-prisma

Install the dependencies

npm install

Set up environment variables:

cp .env.example .env

Start PostgreSQL Container

docker run --name my-postgres -e POSTGRES_PASSWORD=mysecretpassword -p 5432:5432 -d postgres

Note: PostgreSQL Password is mysecretpassword

Update the `.env` file with your PostgreSQL connection string:

PORT=3000
DATABASE_URL="postgresql://postgres:mysecretpassword@localhost:5432/postgres"

Migrate the database:

npm run generate
npm run migrate init

root@Linus:~/samples-typescript/express-postgresql-prisma# npm run migrate init

> task-manager@1.0.0 migrate
> prisma migrate dev --name init

Environment variables loaded from .env
Prisma schema loaded from prisma/schema.prisma
Datasource "db": PostgreSQL database "postgres", schema "public" at "localhost:5432"

Applying migration `20240730015533_initial_migration`
Applying migration `20240731010434_due_date_type_change_to_string`

The following migration(s) have been applied:

migrations/
  └─ 20240730015533_initial_migration/
    └─ migration.sql
  └─ 20240731010434_due_date_type_change_to_string/
    └─ migration.sql

Your database is now in sync with your schema.

✔ Generated Prisma Client (v5.17.0) to ./node_modules/@prisma/clie
nt in 50ms


┌─────────────────────────────────────────────────────────┐
│  Update available 5.17.0 -> 5.19.0                      │
│  Run the following to update                            │
│    npm i --save-dev prisma@latest                       │
│    npm i @prisma/client@latest                          │
└─────────────────────────────────────────────────────────┘

Start the application:

npm run dev

Server is listening at PORT 3000

    Server: http://localhost:3000
    API Docs: http://localhost:3000/api/docs

Note: The application will run on http://localhost:3000.

Now we walkthrough how to leverage Keploy to automatically generate test cases for the application, and later test the application using Keploy.

Generate Test Cases

Note: Build the application first using npm run build

keploy record -c "npm start"

root@Linus:~/samples-typescript/express-postgresql-prisma# keploy record -c "npm start"
🐰 Keploy: 2024-08-28T09:48:30+05:30    INFO    config file not found; proceeding with flags only

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

version: 2.3.0-beta14

🐰 Keploy: 2024-08-28T09:48:30+05:30    INFO    Generated config file based on the flags that are used
🐰 Keploy: 2024-08-28T09:48:32+05:30    INFO    keploy initialized and probes added to the kernel.
🐰 Keploy: 2024-08-28T09:48:32+05:30    INFO    Keploy has taken control of the DNS resolution mechanism, your application may misbehave if you have provided wrong domain name in your application code.
🐰 Keploy: 2024-08-28T09:48:32+05:30    INFO    Proxy started at port:16789
🐰 Keploy: 2024-08-28T09:48:32+05:30    INFO    starting TCP DNS server at addr :26789
🐰 Keploy: 2024-08-28T09:48:32+05:30    INFO    starting UDP DNS server at addr :26789

> task-manager@1.0.0 start
> node dist/index.js

Server is listening at PORT 3000

    Server: http://localhost:3000
    API Docs: http://localhost:3000/api/docs

The above command will start recording the API calls made to the application and will generate a test case in the testcases/ directory.

💡 You can use Postman or any other API testing tool to test the API calls. Additionally, the application will run a swagger UI on http://localhost:3000/api/docs to visualize the API calls.

Interact with Application

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

API Routes

Add Task

URL: /api/v1/task/add
Method: POST
Description: Add a new task.

Request Body:

{
  "author": "John Doe",
  "title": "Complete the report",
  "description": "Complete the quarterly report by end of the week",
  "dueDate": "2024-08-01",
  "status": "Pending",
  "priority": 3
}

Using curl

curl -X 'POST' \
  'http://localhost:3000/api/v1/task/add' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "author": "John Doe",
  "title": "Complete the report",
  "description": "Complete the quarterly report by end of the week",
  "dueDate": "2024-08-01",
  "status": "Pending",
  "priority": 3
}'

View All Tasks

Using curl

curl -X 'GET' \
  'http://localhost:3000/api/v1/task/view' \
  -H 'accept: application/json'

View Task by ID

URL: /api/v1/task/view/:id
Method: GET
Description: Retrieve a specific task by its ID.
Request Params: id (task ID)

Using curl

curl -X 'GET' \
  'http://localhost:3000/api/v1/task/view/1' \
  -H 'accept: application/json'

Change Task Priority

URL: /api/v1/task/change-priority/:id
Method: PUT
Description: Update the priority of a specific task.
Request Params: id (task ID)
Request Body:
```
{
  "priority": 3
}
```

Using curl

curl -X 'PUT' \
  'http://localhost:3000/api/v1/task/change-priority/1' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "priority": 3
}'

Update Task

URL: /api/v1/task/update/:id
Method: PUT
Description: Update details of a specific task.
Request Params: id (task ID)

Request Body:

{
  "author": "John Doe",
  "title": "Complete the report",
  "description": "Complete the quarterly report by end of the week",
  "dueDate": "2024-08-01",
  "status": "Pending",
  "priority": 3
}

Using curl

curl -X 'PUT' \
  'http://localhost:3000/api/v1/task/update/2' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "author": "John Doe",
  "title": "Complete the report",
  "description": "Complete the quarterly report by end of the week",
  "dueDate": "2024-08-01",
  "status": "Pending",
  "priority": 3
}'

Delete Task

URL: /api/v1/task/delete/:id
Method: DELETE
Description: Delete a specific task.
Request Params: id (task ID)

Using curl

curl -X 'DELETE' \
  'http://localhost:3000/api/v1/task/delete/1' \
  -H 'accept: application/json'

🐰 Test Data and Configuration: After recording the interactions, a keploy folder will be created containing the recorded test data. Additionally, a keploy.yml file will be created as the configuration file.

Test the Application using Keploy

keploy test -c "npm start"

Keploy will replay the recorded interactions and validate the responses against the expected results.

Node.js v22.7.0
🐰 Keploy: 2024-08-28T10:14:14+05:30    WARN    To enable storing mocks in cloud please use disableMockUpload flag/configuration

 <=========================================>
  COMPLETE TESTRUN SUMMARY.
        Total tests: 7
        Total test passed: 7
        Total test failed: 0
        Total time taken: "5.66 s"

        Test Suite Name         Total Test      Passed          Failed          Time Taken

        "test-set-0"            7               7               0               "5.66 s"
<=========================================>

🐰 Keploy: 2024-08-28T10:14:14+05:30    INFO    calculating coverage for the test run and inserting it into the report
🐰 Keploy: 2024-08-28T10:14:14+05:30    INFO    [Total Coverage Percentage:  86.16%]
🐰 Keploy: 2024-08-28T10:14:14+05:30    INFO    stopping Keploy {"reason": "replay completed successfully"}
🐰 Keploy: 2024-08-28T10:14:14+05:30    INFO    proxy stopped...
🐰 Keploy: 2024-08-28T10:14:17+05:30    INFO    eBPF resources released successfully...

Voila! 🎉 You have successfully tested the application using Keploy. Keploy also generates coverage reports for the test-suites.

Introduction​

🛠️ Platform-Specific Requirements for Keploy​

Quick Installation Using CLI​

Other Installation Methods​

Downloading and running Keploy in Docker​

On macOS​

Downloading and running Keploy in Native using Debian on MacOS​

Downloading and running Keploy in Native​

On WSL/Linux AMD​

On WSL/Linux ARM​

Setting up the Docker Desktop for WSL 2​

With Arkade​

Get Started! 🎬​

Prerequisites​

Install the dependencies​

Set up environment variables:​

Start PostgreSQL Container​

Update the .env file with your PostgreSQL connection string:​

Migrate the database:​

Start the application:​

Generate Test Cases​

Interact with Application​

API Routes​

Add Task​

View All Tasks​

View Task by ID​

Change Task Priority​

Update Task​

Delete Task​

Test the Application using Keploy​

Introduction

🛠️ Platform-Specific Requirements for Keploy

Quick Installation Using CLI

Other Installation Methods

Downloading and running Keploy in Docker

On macOS

Downloading and running Keploy in Native using Debian on MacOS

Downloading and running Keploy in Native

On WSL/Linux AMD

On WSL/Linux ARM

Setting up the Docker Desktop for WSL 2

With Arkade

Get Started! 🎬

Prerequisites

Install the dependencies

Set up environment variables:

Start PostgreSQL Container

Update the `.env` file with your PostgreSQL connection string:

Migrate the database:

Start the application:

Generate Test Cases

Interact with Application

API Routes

Add Task

View All Tasks

View Task by ID

Change Task Priority

Update Task

Delete Task

Test the Application using Keploy