flask-redis

A sample App using flask and redis

Setup application

1. Clone the repository and move to flask-redis folder
2. Create a .env file and copy-paste below credentials:

REDIS_HOST=redis
REDIS_PORT=6379

Installing Redis

brew install redis

If homebrew is not installed, then go to https://brew.sh/ and install it.

git clone https://github.com/keploy/samples-typescript && cd samples-typescript/flask-redis

# Install the dependencies
pip3 install -r requirements.txt

Installing Keploy

Let's get started by setting up the Keploy alias with this command:

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

Using Keploy :

There are 2 ways you can run this sample application.

1. Natively on Linux/WSL
2. Using Docker

Natively on Ubuntu/WSL

Let's install certificates

1. Install required packages:

   sudo apt-get install -y --no-install-recommends ca-certificates curl

   This command installs necessary packages without additional recommended packages.

2. Download CA certificate:

   curl -o ca.crt https://raw.githubusercontent.com/keploy/keploy/main/pkg/core/proxy/asset/ca.crt

   This command downloads the CA certificate to ca.crt.

3. Download setup script:

   curl -o setup_ca.sh https://raw.githubusercontent.com/keploy/keploy/main/pkg/core/proxy/asset/setup_ca.sh

   This command downloads the setup script to setup_ca.sh.

4. Make the setup script executable:

   chmod +x setup_ca.sh

   This command changes the permissions of setup_ca.sh to make it executable.

5. Run the setup script:

   source ./setup_ca.sh

   This command executes the setup script in the current shell.

6. Start the redis server:

   redis-server

   This command starts the redis server.

Capture the test cases

1. Start recording tests:

   sudo -E env "PATH=$PATH" keploybin record -c 'python3 app.py'

Let's Generate the test cases

Make API Calls using Hoppscotch, Postman or cURL command. Keploy will capture those calls to generate test suites containing test cases and data mocks.

1. Refer to flask-redis/api.txt to make api calls.

2. Observe terminal output: Let's go ahead and create a few more test cases for different endpoints!

Running the test cases

1. Start the application:

   python3 app.py

2. Run the recorded tests:

   sudo -E env "PATH=$PATH" keploybin test -c 'python3 app.py' --delay 10

3. Observe test run results: Voila!! Our test cases have passed 🌟

---

Using Docker

Since we have to setup our app using docker(make sure your docker is running)

Create a custom network for Keploy since we are using the Docker

docker network create keploy-network

Capture the testcases

We will run the keploy in record mode with docker-compose to start our application:-

keploy record -c "sudo docker-compose up" --containerName "flask-web"

Let's generate the testcases.

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

1. Refer to flask-redis/api.txt to make api calls

Running the testcases

keploy test -c 'sudo docker-compose up' --containerName "flask-web" --delay 10

Voila!! Our testcases has passed 🌟