NodeJS Sample Application
Intoduction 📌
A sample CRUD application to see how Keploy integrates effortlessly with Express.js and MongoDB. Get ready to see the power of Keploy 🔅🔅.
Get Started! 🎬
Clone the repository and move to crud-API folder
git clone https://github.com/keploy/samples-typescript && cd samples-typescript/crud-API
# 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 |
---|---|---|---|
![]() | Docker Desktop version must be 4.25.2 or above | ||
- Use WSL wsl --install - Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11 | |||
![]() | 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
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
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
🎉 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"
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 run" --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 .
Contact Us
If you have any questions or need help, please feel free to reach out to us at hello@keploy.io or reach out us on
or open a discussion on