Redis

This guide shows you how to work with Redis locally using Docker and Python. This lab demonstrates how to manage user status using Redis and a custom context manager for connection management.

Prerequisites

Docker installed and running.
Dev Containers extension installed (optional).

How to execute

Setup Environment:
- Dev Container (recommended)
- Manually
Open VS Code in the project folder and execute this command in the Command Palette:
Terminal window
> Dev Containers: Reopen in Container
1. Run the setup script to install tools and dependencies:
  Terminal window
  scripts/setup.sh
2. Start Infrastructure: Launch the Redis container:
  Terminal window
  docker compose up -d
Run the Example:
- Python
- Redis CLI
Terminal window
python main.py
1. Enter Shell:
  Terminal window
  scripts/redis_cli.sh
2. Execute commands to set a key manually:
  Terminal window
  SET raulcastillabravo:status "available"

How to debug

main.py:
- Open: Open main.py.
- Breakpoints: Set breakpoints in the code.
- Run: Press F5 to start debugging.
Tests:
- Open: Open a test file (e.g., tests/providers/test_redis_client.py).
- Breakpoints: Set breakpoints in the test code.
- Run: Use the VS Code Testing tab and click the Debug Test icon next to the test you want to debug.

How to test

All tests: Run the automated script:
Terminal window
```
scripts/run_tests.sh
```
Individually: Use the VS Code Testing tab to run or debug specific test cases.

Validate results

Enter Shell:
Terminal window
```
scripts/redis_cli.sh
```
Check the stored status:
Terminal window
```
GET raulcastillabravo:status
```

Install: Database Client.
Connect: Connect using the connection settings defined in your .env.
Verify: Browse the keys and use the built-in Redis CLI directly from the extension UI.

Install: Redis Insight.
Connect: Connect using the connection settings defined in your .env.
Verify: Browse the keys to see raulcastillabravo:status.

Clean Up

docker compose down -v