sample course selling api (express)
Introduction
A simple sample CRUD application and see how seamlessly Keploy integrates with Express and MongoDB 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 | Guide | Guide | - Docker Desktop version must be 4.25.2 or above - Ensure that Lima is installed on your machine if you prefer to try without Docker. |
 Windows | Guide | Guide | - Use WSL wsl --install - Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11 - Ensure that Docker Desktop version 4.25.2 or above is installed if you are following the Docker installation guide |
 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.
Installation Overview
By default, this guide installs the Keploy Community Edition. The install command below is the same for everyone. Once you sign in, Keploy detects your plan and enables Community Edition features by default, or Pro / Enterprise features if your account has access to them.
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
By default, this command installs the Keploy Community Edition. Your plan (Community, Pro, or Enterprise) is determined after you log in.
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/Windows
Note : Keploy is not supported natively on MacOS and Windows, 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
- Install Keploy
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 Natively
Downloading and running Keploy in Native
Prequisites:
- Linux Kernel version 5.15 or higher
- Run
uname -ato 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 Desktopfor WSL 2, please refer to the official Docker documentation.
Get Started! 🎬
Clone the repository and move to express-mongoose folder
git clone https://github.com/keploy/samples-typescript && cd samples-typescript/node-mongoose
# Install the dependencies
npm install
Lights, Camera, Record! 🎥
Docker installation and running the mongodb compass
Here I'm using WSL , so follow below steps to configure docker with mongo db compass
1. Install docker in your windows and follow this tutorial to connect with mongodb compass :
https://www.youtube.com/watch?v=NEPZqSvKx40&list=PLff_PESolMjuDXQdjiqYRW_GnDQjU32QX
2. after installing docker and running those commands in video use this command as well to create a network:
docker network create keploy-network
*url should look something like this depending on your connection you can adjust, also update your .env file with mongodb_url:
mongodb://127.0.0.1:27023/courses.
Capturing Testcases
keploy record -c "npm start"
if using wsl use this :
sudo -E env PATH=$PATH keploy record -c 'npm start'
🔥 Challenge time! Generate some test cases. How? Just make some API calls. Postman, Hoppscotch or even curl - take your pick!
Let's generate the testcases.
Make API Calls using Postman or cURL command. Keploy with capture those calls to generate the test-suites containing testcases and data mocks.
🎉 Woohoo! With a simple API call, you've crafted a test case with a mock! Dive into the Keploy directory and feast your eyes on the newly minted test-1.yml and mocks.yml after doing below steps
Time to perform API magic! Follow the breadcrumbs... or Make more API Calls
Some api calls you can make
Get request - Get all courses
curl --request GET \
--url http://localhost:3000/courses
Post request - Add a new course
curl --location 'http://localhost:3000/courses' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'title=react advance' \
--data-urlencode 'description=advance' \
--data-urlencode 'price=1000' \
--data-urlencode 'published=true'
Put request - Add a new course
- Make sure to replace id of course
curl --location --request PUT 'http://localhost:3000/courses/6626a9cd3840cb305c0a6d52' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'title=react advance'
Delete request - Delete a course
- Make sure to replace id of course
curl --location --request DELETE 'http://localhost:3000/courses/6626a9cd3840cb305c0a6d52'
🎉 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/courses
header:
Accept: "*/*"
Accept-Encoding: gzip, deflate, br
Cache-Control: no-cache
Connection: keep-alive
Host: localhost:3000
Postman-Token: 61d4ef71-85a9-4dd9-b036-6beb0136c8d7
User-Agent: PostmanRuntime/7.32.1
body: ""
timestamp: 2024-04-22T23:56:36.910408265+05:30
resp:
status_code: 200
header:
Access-Control-Allow-Origin: "*"
Connection: keep-alive
Content-Length: "740"
Content-Type: application/json; charset=utf-8
Date: Mon, 22 Apr 2024 18:26:36 GMT
Etag: W/"2e4-bpK0GltUbFpXKUMEiWddtMBI/a4"
Keep-Alive: timeout=5
X-Powered-By: Express
body: '{"courses":[{"_id":"66269dd4a16b2f11f9c1c0e9","title":"python course","description":"advance","price":1000,"published":true,"__v":0},{"_id":"66269e13a16b2f11f9c1c0ec","title":"react course","description":"advance","price":1000,"published":true,"__v":0},{"_id":"66269f2034c9140719a0f7de","title":"express","description":"advance","price":1000,"published":true,"__v":0},{"_id":"6626a8f2946288ed91737eb7","title":"express and react","description":"advance","price":1000,"published":true,"__v":0},{"_id":"6626a9cd3840cb305c0a6d52","title":"react and next js","description":"advance","price":1000,"published":true,"__v":0},{"_id":"6626aa43f9602455c7dac9ea","title":"react advance","description":"advance","price":1000,"published":true,"__v":0}]}'
status_message: OK
proto_major: 0
proto_minor: 0
timestamp: 2024-04-22T23:56:38.951925148+05:30
objects: []
assertions:
noise:
header.Date: []
created: 1713810398
curl: |
curl --request GET \
--url http://localhost:3000/courses \
--header 'Connection: keep-alive' \
--header 'User-Agent: PostmanRuntime/7.32.1' \
--header 'Accept: */*' \
--header 'Cache-Control: no-cache' \
--header 'Postman-Token: 61d4ef71-85a9-4dd9-b036-6beb0136c8d7' \
--header 'Host: localhost:3000' \
--header 'Accept-Encoding: gzip, deflate, br' \
Or simply wander over to your browser and visit http://localhost:3000/courses.
Did you spot the new test and mock scrolls in your project library? Awesome! 👏
Run Tests
Time to put things to the test 🧪
keploy test -c "npm start" --delay 10
If using wsl use this :
keploy -E env PATH=$PATH keploy test -c 'npm start' --delay 10
Keploy test report:
The
--delayflag? Oh, that's just giving your app a little breather (in seconds) before the test cases come knocking.
To Run test using jest use this command :
npm test
jest test coverage report :
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 🎉
Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible.😊🚀
Happy coding! ✨👩💻👨💻✨