Echo SQL Sample Application

Introduction

A sample url shortener app to test Keploy integration capabilities using Echo and PostgreSQL. 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
Windows			- Use WSL wsl --install - Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11
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.

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

2. Install Keploy

 curl --silent -O -L https://keploy.io/install.sh && source install.sh

Examples:

Record:

keploy record -c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" --container-name "<containerName>" --buildDelay 60

Test:

keploy test --c "docker run -p 8080:8080 --name <containerName> --network keploy-network <applicationImage>" --delay 10 --buildDelay 60

Install Natively

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.

Get Started! 🎬

Clone a sample URL shortener app 🧪

git clone https://github.com/keploy/samples-go.git && cd samples-go/echo-sql
go mod download

Installation Keploy

Depending on your OS, choose your adventure:

There are 2 ways you can run this sample application.

• Using Docker compose : running application as well as Postgres on Docker container
• Using Docker container for Postgres and running application locally

Using Docker Compose 🐳

We will be using Docker compose to run the application as well as Postgres on Docker container.

Lights, Camera, Record! 🎥

Start Postgres Instance

Using the docker-compose file we will start our postgres instance:-

# Start Postgres
docker compose up

Creating Docker Volume

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

Capture the Testcases

Now, we will create the binary of our application:-

docker build -t echo-app:1.0 .

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

keploy record -c "docker run -p 8082:8082 --name echoSqlApp --network keploy-network echo-app:1.0"

Make API Calls using Hoppscotch, Postman or cURL command. Keploy with capture those calls to generate the test-suites containing testcases and data mocks.

Generate testcases

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

curl --request POST \
  --url http://localhost:8082/url \
  --header 'content-type: application/json' \
  --data '{
  "url": "https://github.com"
}'

this will return the shortened url. The ts would automatically be ignored during testing because it'll always be different.

{
  "ts": 1647802058801841100,
  "url": "http://localhost:8082/GuwHCgoQ"
}

Redirect to original URL from shortened URL

1. By using Curl Command

curl --request GET \
  --url http://localhost:8082/GuwHCgoQ

2. Or by querying through the browser http://localhost:8082/GuwHCgoQ

Now both these API calls were captured as editable testcases and written to keploy/tests folder. The keploy directory would also have mocks file that contains all the outputs of postgres operations. Here's what the folder structure look like:

Now, let's see the magic! ✨💫

Want to see if everything works as expected?

Run the Testcases

Now that we have our testcase captured, we will add ts to noise field in test-*.yaml files.

1. On line 32 we will add "- body.ts" under the "header.data".

Now let's run the test mode (in the echo-sql directory, not the Keploy directory).

keploy test -c "docker run -p 8082:8082 --name echoSqlApp --network keploy-network echo-app:1.0" --delay 10

output should look like

So no need to setup fake database/apis like Postgres or write mocks for them. Keploy automatically mocks them and, The application thinks it's talking to Postgres 😄

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

Running App Locally on Linux/WSL 🐧

We'll be running our sample application right on Linux, but just to make things a tad more thrilling, we'll have the database (Postgres) chill on Docker. Ready? Let's get the party started!🎉 Using the docker-compose file we will start our Postgres instance:-

docker-compose up -d

Since we are using docker to run the application, we need to update the postgres host on line 28 in main.go, update the host to localhost.

Now, we will create the binary of our application:-

go build -cover

Capture the Testcases

sudo -E PATH=$PATH keploy record -c "./echo-psql-url-shortener"

Generate testcases

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

curl --request POST \
  --url http://localhost:8082/url \
  --header 'content-type: application/json' \
  --data '{
  "url": "https://google.com"
}'

this will return the shortened url.

{
  "ts": 1645540022,
  "url": "http://localhost:8082/Lhr4BWAi"
}

Redirect to original url from shòrtened url

curl --request GET \ --url http://localhost:8082/Lhr4BWAi

or by querying through the browser http://localhost:8082/Lhr4BWAi

Now, let's see the magic! 🪄💫

Now both these API calls were captured as a testcase and should be visible on the Keploy CLI. You should be seeing an app named keploy folder with the test cases we just captured and data mocks created

Run the captured testcases

Now that we have our testcase captured, run the test file.

sudo -E PATH=$PATH keploy record -c "./echo-psql-url-shortener" --delay 10

So no need to setup dependencies like mongoDB, web-go locally or write mocks for your testing.

The application thinks it's talking to mongoDB 😄

We will get output something like this:

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 .