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.

This sample application is not written for macOS users since this application doesn't have a docker file yet.

🛠️ 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 SupportedSupportedDocker Desktop version must be 4.25.2 or above
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.

Quick Installation​

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​

Downloading and running Keploy in Docker​

On macOS​

  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​

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.

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.

With Arkade​

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

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

Start the Postgres DB 🐳​

docker compose up -d

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

Capture the testcases 🎬​

Once we have our jar file ready,this command will start the recording of API calls using ebpf:-

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/testReports folder. You will see the following output:-

🐰 Keploy: 2024-02-20T13:49:20Z 	INFO	starting test for of	{"test case": "test-1", "test set": "test-set-1"}
2024-02-20 13:49:20.778  INFO 18888 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring DispatcherServlet 'dispatcherServlet'
2024-02-20 13:49:20.778  INFO 18888 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
2024-02-20 13:49:20.779  INFO 18888 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Completed initialization in 1 ms
Testrun failed for testcase with id: "test-1"

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

+-------------------------------------------------------------------------------------------------------------+
|                                                DIFFS TEST-1                                                 |
+-------------------------------------------------------------------------------------------------------------+
|                     EXPECT HEADER                    |                   ACTUAL HEADER                      |
| -----------------------------------------------------+----------------------------------------------------- |
|                                                      |                                                      |
|                                                                                                             |
|                      EXPECT BODY                     |                    ACTUAL BODY                       |
| -----------------------------------------------------+----------------------------------------------------- |
|    {                                                 |  {                                                   |
|      "email": "mt@gmail.com",                        |    "email": "mt@gmail.com",                          |
|      "firstName": "Myke",                            |    "firstName": "Myke",                              |
|      "id": 1,                                        |    "id": 1,                                          |
|      "lastName": "Tyson",                            |    "lastName": "Tyson",                              |
|   -  "timestamp": 1.70843653e+09                     | +  "timestamp": 1.70843696e+09                       |
|    }                                                 |  }                                                   |
|                                                      |                                                      |
|                                                                                                             |
+-------------------------------------------------------------------------------------------------------------+
🐰 Keploy: 2024-02-20T13:49:20Z 	INFO	result	{"testcase id": "test-1", "testset id": "test-set-1", "passed": "false"}
🐰 Keploy: 2024-02-20T13:49:21Z 	INFO	starting test for of	{"test case": "test-2", "test set": "test-set-1"}
Testrun passed for testcase with id: "test-2"

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

🐰 Keploy: 2024-02-20T13:49:21Z 	INFO	result	{"testcase id": "test-2", "testset id": "test-set-1", "passed": "true"}
🐰 Keploy: 2024-02-20T13:49:21Z 	INFO	test report for test-set-1: 	{"name: ": "report-2", "path: ": "/Users/neha/open-source/samples-java/employee-manager/keploy/report-2"}

<=========================================>
TESTRUN SUMMARY. For testrun with id: "test-set-1"
Total tests: 2
Total test passed: 1
Total test failed: 1
<=========================================>```

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 test-1.yaml.

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! ✨👩‍💻👨‍💻✨

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

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