Skip to main content
Version: 2.0.0

Example Employee-Manager App​

A sample Employee-Manager app to test Keploy integration capabilities using SpringBoot and PostgreSQL.

If you are macOS users please try the application using docker compose.

🛠️ 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 SystemWithout DockerDocker InstallationPrerequisites
MacOS MacOSNot SupportedSupported- Docker Desktop version must be 4.25.2 or above
- For running Keploy on MacOS natively, refer to Guide
Windows WindowsSupportedSupported- Use WSL wsl --install
- Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11
Linux LinuxSupportedSupportedLinux 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

  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
  1. 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"
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​

  1. Open the terminal Session.
  2. 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​

  1. Open the terminal Session
  2. 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​

  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.

Setup Employee-Manager App​

Application Pre-Requisites​

  • Java 1.8+ or <17 ☕
  • Maven 🛠️

Clone the repository and install the dependencies

git clone https://github.com/keploy/samples-java && cd samples-java/employee-manager
mvn clean install -Dmaven.test.skip=true

You can start the backend using Keploy in 2 ways:

Instructions For Starting Using Binary​

Setup the backend​

You need to update the postgresql properties, go to employee-manager/src/main/resources/application-postgresql.properties and change

spring.datasource.url=jdbc:postgresql://postgres:5432/keploy-test/

to

spring.datasource.url=jdbc:postgresql://localhost:5432/keploy-test/

and then build the jar using:

mvn clean install -Dmaven.test.skip=true

Start the Postgres DB 🐳​

docker run -e POSTGRES_USER=keploy-user -e POSTGRES_PASSWORD=keploy -e POSTGRES_DB=postgres -p 5432:5432 --name postgres postgres:15.2

Note: You may have to use sudo if you are not part of the docker group.

Capture the testcases 🎬​

keploy record -c "java -jar target/springbootapp-0.0.1-SNAPSHOT.jar"

Testcases

Now let's run a few tests to capture some more scenarios:

Generate testcases 📝​

To generate testcases we just need to make some API calls. You can use Postman , Hoppscotch, or simply curl

  1. Make an employee entry 📥
curl --location --request POST 'http://localhost:8080/api/employees' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "Myke",
    "lastName": "Tyson",
    "email": "mt@gmail.com",
    "timestamp":1
}'

this will return the response or an entry. The timestamp would automatically be ignored during testing because it'll always be different.

{
    "id": 1,
    "firstName": "Myke",
    "lastName": "Tyson",
    "email": "mt@gmail.com",
    "timestamp": 1661493301
}
  1. Fetch recorded info about employees
curl --location --request GET 'http://localhost:8080/api/employees/1'

or by querying through the browser http://localhost:8080/api/employees/1

Now both these API calls were captured as editable testcases and written to keploy/test folder. The keploy directory would also have mock.yml file.

Now, let's see the magic! 🪄💫

Run the test cases​

First lets shutdown the database to verify that keploy's magic is taking care of the database mocking. No need to worry about the database anymore! 🎉

docker-compose down

Now, let's run the keploy in test mode: -

keploy test -c "java -jar target/springbootapp-0.0.1-SNAPSHOT.jar" --delay 10

This will run the testcases and generate the report in keploy/reports folder. You will see the following output:-

🐰 Keploy: 2025-04-17T13:30:11+05:30    INFO    starting test for of    {"test case": "[test-1]", "test set": "[test-set-0]"}
2025-04-17 13:30:11.410  INFO 28035 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring DispatcherServlet 'dispatcherServlet'
2025-04-17 13:30:11.410  INFO 28035 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
2025-04-17 13:30:11.410  INFO 28035 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Completed initialization in 0 ms
Testrun failed for testcase with id: "test-1"

--------------------------------------------------------------------

+-------------------------------------------------------------------------------------------------------------+
|                                                DIFFS TEST-1                                                 |
+-------------------------------------------------------------------------------------------------------------+
|                     EXPECT HEADER                    |                   ACTUAL HEADER                      |
| -----------------------------------------------------+----------------------------------------------------- |
|                                                      |                                                      |
|                                                                                                             |
|                      EXPECT BODY                     |                    ACTUAL BODY                       |
| -----------------------------------------------------+----------------------------------------------------- |
|   {                                                  | {                                                    |
|    "timestamp": "1744871332" ,                       |  "timestamp": "1744876811" ,                         |
|   lastName:Tyson                                     | lastName:Tyson                                       |
|    }                                                 |  }                                                   |
|                                                      |                                                      |
|                                                                                                             |
+-------------------------------------------------------------------------------------------------------------+
🐰 Keploy: 2025-04-17T13:30:11+05:30    INFO    result  {"testcase id": "[test-1]", "testset id": "[test-set-0]", "passed": "[false]"}
🐰 Keploy: 2025-04-17T13:30:11+05:30    INFO    starting test for of    {"test case": "[test-2]", "test set": "[test-set-0]"}
Testrun passed for testcase with id: "test-2"

--------------------------------------------------------------------

🐰 Keploy: 2025-04-17T13:30:11+05:30    INFO    result  {"testcase id": "[test-2]", "testset id": "[test-set-0]", "passed": "[true]"}

 <=========================================>
  TESTRUN SUMMARY. For test-set: "test-set-0"
        Total tests: 2
        Total test passed: 1
        Total test failed: 1
        Time Taken: "10.37 s"
 <=========================================>
<=========================================>```

Did you spot that the timestamp is showing some differences? Yep, time has a way of doing that! 🕰️

Worry not, just add the ever-changing fields (like our ts here) to the noise parameter to dodge those assertions.

Pro tip: Add body.timestamp to noise in keploy.yml.

Adding Noise to Test case Java Postgres Employee Manager App

Run that keploy test command once more and watch as everything falls into place with all tests passing! 🌟

Final thoughts? Dive deeper! Try different API calls, tweak the DB response in the mocks.yml, or fiddle with the request or response in test-x.yml. Run the tests again and see the magic unfold! ✨👩‍💻👨‍💻✨

Next we move on to the instructions to start the application using docker.

Instructions For Starting Using Docker​

Prerequisites For Docker:

  1. Docker Desktop 4.25.2 and above or docker cli installed

Here we just need to change the command used to start the application.

Capture the testcases 🎬​

keploy record -c "docker compose up" --container-name javaApp --build-delay 100
Sample Keploy Record Java

Now let's run a few tests to capture some more scenarios:

Generate testcases 📝​

To generate testcases we just need to make some API calls. You can use Postman , Hoppscotch, or simply curl

  1. Make an employee entry 📥
curl --location --request POST 'http://localhost:8080/api/employees' \
--header 'Content-Type: application/json' \
--data-raw '{
    "firstName": "Myke",
    "lastName": "Tyson",
    "email": "mt@gmail.com",
    "timestamp":1
}'

this will return the response or an entry. The timestamp would automatically be ignored during testing because it'll always be different.

{
    "id": 1,
    "firstName": "Myke",
    "lastName": "Tyson",
    "email": "mt@gmail.com",
    "timestamp": 1661493301
}
  1. Fetch recorded info about employees
curl --location --request GET 'http://localhost:8080/api/employees/1'

or by querying through the browser http://localhost:8080/api/employees/1

Now both these API calls were captured as editable testcases and written to keploy/test folder. The keploy directory would also have mock.yml file.

Now, let's see the magic! 🪄💫

Running the testcases using Keploy​

keploy test -c "docker compose up" --container-name javaApp --build-delay 50 --delay 20

Your CLI should look something like this

Sample Keploy Test Java

This is a summary of the test cases recorded

Sample Keploy Test Summary Java

Here delay is the time it takes for your application to get started, after which Keploy will start running the testcases. If your application takes longer than 10s to get started, you can change the delay accordingly. buildDelay is the time that it takes for the image to get built. This is useful when you are building the docker image from your docker compose file itself.

🎉 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. 😊🚀

🚀 Wanna try Keploy in CI/CD?​

We got you 😎
Here’s how to set it up with GitHub Actions:
👉 Keploy + GitHub CI/CD Guide

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 Slack or open a discussion on GitHub Discussion