MacOS Installation

As of now there are two ways to use Keploy eBPF in MacOS, i.e. using Colima and using Docker Desktop.

There are two ways to install Keploy eBPF in MacOS, you can use either use:

1. One-Click Install.
2. Manual Setup.

One click install Keploy.

 curl -O https://raw.githubusercontent.com/keploy/keploy/main/keploy.sh && source keploy.sh

Using Docker Desktop

Note: To run Keploy on MacOS through Docker the version must be 4.25.2 or above.

Creating Docker Volume & Network

We need to create debug volume to run Keploy using Docker-Desktop:

docker volume create --driver local --opt type=debugfs --opt device=debugfs debugfs

We need to create a custom network for Keploy since we are using the Docker, therefore application container would require docker network to act as the bridge between them.

If you're using a docker-compose network, replace keploy-network with your app's docker_compose_network_name below.

docker network create keploy-network

Using Colima

Install Colima

You need to have the latest version of brew installed on your system and then run this command from a terminal:

brew install colima

Start Colima with defaults

colima start

Creating Alias

We need to create a custom network for Keploy since we are using the Docker, therefore application container would require docker network to act as the bridge between them.

If you're using a docker-compose network, replace keploy-network with your app's docker_compose_network_name below.

docker network create keploy-network

Recording Testcases and Data Mocks

Here are few points to consider before recording!

• If you're running via docker compose, ensure to include the <CONTAINER_NAME> under your application service in the docker-compose.yaml file like this .

• Change the network name (--network flag) from keploy-network to your custom network if you changed it above.

• Docker_CMD_to_run_user_container refers to the Docker command for launching the application.

Utilize keploy to capture testcases. Execute the following command within your application's root directory.

keploy record -c "docker run -p <appPort>:<hostPort> --name <containerName> --network keploy-network --rm <applicationImage>" --containerName "<containerName>" --delay 10

Perform API calls using tools like Hoppscotch, Postman, or cURL commands.

Keploy will capture the API calls you've conducted, generating test suites comprising testcases (KTests) and data mocks (KMocks) in YAML format.

Running Testcases

Now, execute the testcases. Follow these steps in the root directory of your application.

When using docker-compose to start the application, it's important to ensure that the --containerName parameter matches the container name in your docker-compose.yaml file.

keploy test -c "docker run -p <appPort>:<hostPort> --name <containerName> --network keploy-network --rm <applicationImage>" --containerName "<containerName>" --delay 20

Voilà! 🧑🏻‍💻 We have the tests with data mocks running! 🐰🎉

You'll be able to see the test-cases that ran with the results report on the console as well locally in the testReport directory.

1. delay is required while using Test Mode.
2. containerName is optional if you are using Docker run command, as the Container name would be present within the command itself.