Sample CRUD App (Golang)

Introduction

🪄 Dive into the world of CRUD applications and see how seamlessly Keploy integrates with FastHttp and Postgres. 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			- Docker Desktop version must be 4.25.2 or above - For running Keploy on MacOS natively, refer to Guide
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

Open up a terminal window.
Create a bridge network in Docker using the following docker network create command:

docker network create keploy-network

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.

Downloading and running Keploy On WSL/Linux AMD

On WSL/Linux AMD

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

Open the terminal Session
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

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.

With Arkade

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

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

Clone the sample CRUD application 🧪

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

Installation 📥

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! 🎥

Fire up the application and Postgres instance with Keploy. Keep an eye on the two key flags: -c: Command to run the app (e.g., docker compose up).

--container-name: The container name in the docker-compose.yml for traffic interception.

keploy record -c "docker compose up" --container-name "fasthttpPostgresApp"

Getting logs like this? Perfect! 👌 Testcase

🔥 Challenge time! Generate some test cases. How? Just make some API calls. Postman, Hoppscotch or even curl - take your pick!

Let's create some users and books:

Post Requests

curl -X POST -H "Content-Type: application/json" -d '{"name":"Author Name"}' http://localhost:8080/authors
curl -X POST -H "Content-Type: application/json" -d '{"title":"Book Title","author_id":1}' http://localhost:8080/books

Get Request

curl -i http://localhost:8080/books

🎉 Woohoo! With simple API calls, you've crafted test cases with mocks! Dive into the Keploy directory and feast your eyes on the newly minted test-1.yml and mocks.yml.

Here's a peek of what you get:

version: api.keploy.io/v1beta1
kind: Http
name: test-1
spec:
  metadata: {}
  req:
    method: POST
    proto_major: 1
    proto_minor: 1
    url: http://localhost:8080/authors
    header:
      Accept: "*/*"
      Content-Length: "22"
      Content-Type: application/json
      Host: localhost:8080
      User-Agent: curl/7.88.1
    body: '{"name":"Author Name"}'
    timestamp: 2024-06-24T13:05:47.732915734+05:30
  resp:
    status_code: 201
    header:
      Content-Length: "0"
      Date: Mon, 24 Jun 2024 07:35:47 GMT
      Server: Server
    body: ""
    status_message: Created
    proto_major: 0
    proto_minor: 0
    timestamp: 2024-06-24T13:05:49.810554677+05:30
  objects: []
  assertions:
    noise:
      header.Date: []
  created: 1719214549
curl: |-
  curl --request POST \
    --url http://localhost:8080/authors \
    --header 'Host: localhost:8080' \
    --header 'User-Agent: curl/7.88.1' \
    --header 'Accept: */*' \
    --header 'Content-Type: application/json' \
    --data '{"name":"Author Name"}'

This is how the generated mock.yml will look like:

version: api.keploy.io/v1beta1
kind: Postgres
name: mock-0
spec:
  metadata:
    type: config
  postgresrequests:
    - identifier: StartupRequest
      length: 96
      payload: AAAAYAADAAB1c2VyAHBvc3RncmVzAGNsaWVudF9lbmNvZGluZwBVVEY4AGV4dHJhX2Zsb2F0X2RpZ2l0cwAyAGRhdGFiYXNlAGRiAGRhdGVzdHlsZQBJU08sIE1EWQAA
      startup_message:
        protocolversion: 196608
        parameters:
          client_encoding: UTF8
          database: db
          datestyle: ISO, MDY
          extra_float_digits: "2"
          user: postgres
      auth_type: 0
  postgresresponses:
    - header: [R]
      identifier: ServerResponse
      length: 96
      authentication_md5_password:
        salt: [200, 42, 157, 175]
      msg_type: 82
      auth_type: 5
  reqtimestampmock: 2024-06-24T13:05:47.736932812+05:30
  restimestampmock: 2024-06-24T13:05:47.74668502+05:30
connectionId: "0"

Time to perform more API magic!

Get All Books

curl -i http://localhost:8080/books

Or just type http://localhost:8080/books in your browser. Your choice!

Spotted the new test and mock files in your project? High five! 🙌

Run Tests 🏃‍♀️

Time to put things to the test 🧪

keploy test -c "docker compose up" --container-name "fasthttpPostgresApp" --delay 10

The --delay flag? Oh, that's just giving your app a little breather (in seconds) before the test cases come knocking.

Your results should be looking like this:

Testrun

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

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

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! 🎉

If you are using WSL on Windows then use below to start WSL in the user's home directory:

wsl ~

First things first, update the Postgres URL to localhost:5432 on line 21 of our trusty main.go file.

🍃 Kickstart Postgres

Let's breathe life into your Postgres container. A simple spell should do the trick:

docker compose up postgres

📼 Recording Time!

Ready, set, record! Here's how:

go build -cover
keploy record -c "./app"

Keep an eye out for the -c flag! It's the command charm to run the app. Whether you're using go run main.go or the binary path like ./app, it's your call. If you're seeing logs that resemble the ones below, you're on the right track:

Testcase

Alright! With the app alive and kicking, let's weave some test cases. Making some API calls! Postman, Hoppscotch,

or even the classic curl - take your pick!

Time to create some users and books:

Post Requests

curl -X POST -H "Content-Type: application/json" -d '{"name":"Author Name"}' http://localhost:8080/authors
curl -X POST -H "Content-Type: application/json" -d '{"title":"Book Title","author_id":1}' http://localhost:8080/books

Get Request

curl -i http://localhost:8080/books

🎉 Look at you go! With a few simple API calls, you've crafted test cases with mocks! Peek into the Keploy directory and behold the freshly minted test-1.yml and mocks.yml.

🏃‍♀️ Run the Tests!

Time to put it all to the test:

keploy test -c "./app" --delay 5

That --delay flag? Just a little pause (in seconds) to let your app catch its breath before the test cases start rolling in.

When all is said and done, your test results should look a little something like this:

Testrun

Wrapping it up 🎉

Happy coding! ✨👩‍💻👨‍💻✨

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

Introduction​

🛠️ Platform-Specific Requirements for Keploy​

Quick Installation Using CLI​

Other Installation Methods​

Downloading and running Keploy in Docker​

On macOS​

Downloading and running Keploy in Native​

On WSL/Linux AMD​

On WSL/Linux ARM​

Setting up the Docker Desktop for WSL 2​

With Arkade​

Clone the sample CRUD application 🧪​

Installation 📥​

Using Docker Compose 🐳​

Lights, Camera, Record! 🎥​

Post Requests​

Get Request​

Get All Books​

Run Tests 🏃‍♀️​

Wrapping it up 🎉​

Running App Locally on Linux/WSL 🐧​

🍃 Kickstart Postgres​

📼 Recording Time!​

Post Requests​

Get Request​

🏃‍♀️ Run the Tests!​

Wrapping it up 🎉​

Contact Us​

Introduction

🛠️ Platform-Specific Requirements for Keploy

Quick Installation Using CLI

Other Installation Methods

Downloading and running Keploy in Docker

On macOS

Downloading and running Keploy in Native

On WSL/Linux AMD

On WSL/Linux ARM

Setting up the Docker Desktop for WSL 2

With Arkade

Clone the sample CRUD application 🧪

Installation 📥

Using Docker Compose 🐳

Lights, Camera, Record! 🎥

Post Requests

Get Request

Get All Books

Run Tests 🏃‍♀️

Wrapping it up 🎉

Running App Locally on Linux/WSL 🐧

🍃 Kickstart Postgres

📼 Recording Time!

Post Requests

Get Request

🏃‍♀️ Run the Tests!

Wrapping it up 🎉

Contact Us