Skip to main content
Version: 2.0.0

Keploy with PetClinic​

This is a petclinic app where you can record testcases and mocks by interacting with the UI, and then test them using Keploy.

🛠️ 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

This project has two parts - the frontend and backend, since Keploy is a backend testing platform, we need to start the backend part of the project using Keploy and run the frontend as it is.

Setup the frontend​

git clone https://github.com/keploy/samples-java.git
cd samples-java/spring-petclinic/spring-petclinic-angular
npm uninstall -g angular-cli @angular/cli
npm cache clean
npm install -g @angular/cli@latest
npm install --save-dev @angular/cli@latest
npm i

Start the frontend​

npm run start

Now it's time to setup the backend of our application. Let's move to the backend directory and get started.

cd samples-java/spring-petclinic/spring-petclinic-rest

You can start the backend using Keploy in 2 ways:

Instructions For Starting Using Binary​

Prerequisites For Binary:

  1. Node 20.11.0 LTS
  2. OpenJDK 17.0.9
  3. MVN version 3.6.3

Setup the backend​

You need to update the postgresql properties, go to spring-petclinic/spring-petclinic-rest/src/main/resources/application-postgresql.properties and change

spring.datasource.url=jdbc:postgresql://mypostgres:5432/petclinic

to

spring.datasource.url=jdbc:postgresql://localhost:5432/petclinic

and then build the jar using:

mvn clean install -Dmaven.test.skip=true

Spin up the database​

docker run -e POSTGRES_USER=petclinic -e POSTGRES_PASSWORD=petclinic -e POSTGRES_DB=petclinic -p 5432:5432 --name mypostgres postgres:15.2

Recording the testcases with Keploy​

keploy record -c "java -jar target/spring-petclinic-rest-3.0.2.jar"

Now you can start interacting with the UI and Keploy will automatically create the testcases and mocks for it in a folder named 'keploy'.

Running the testcases using Keploy​

keploy test -c "java -jar target/spring-petclinic-rest-3.0.2.jar" --delay 20

🎉 Hooray! You've made it to the end of the binary section! 🎉

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

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

keploy record -c "docker compose up" --container-name javaApp --build-delay 100

Running the testcases using Keploy​

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

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.

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