Redis Express App (#65)

* redis-app

Signed-off-by: akshat99812 <138353837+akshat99812@users.noreply.github.com>

---------

Signed-off-by: akshat99812 <138353837+akshat99812@users.noreply.github.com>

Author: akshat99812

redis-express/.gitignore

@@ -0,0 +1,6 @@
+# node modules
+node_modules
+
+# vs code
+
+.DS_Store

redis-express/Dockerfile

@@ -0,0 +1,26 @@
+# Downloading node:alpine
+FROM node:alpine
+
+WORKDIR /redis-ts
+
+COPY package*.json ./
+
+RUN npm install
+
+COPY . .
+
+RUN npm run build
+
+# Download the ca.crt file and setup_ca.sh script
+RUN curl -o ca.crt  https://raw.githubusercontent.com/keploy/keploy/main/pkg/core/proxy/asset/ca.crt
+RUN curl -o setup_ca.sh https://raw.githubusercontent.com/keploy/keploy/main/pkg/core/proxy/asset/setup_ca.sh
+
+# Give execute permission to the setup_ca.sh script
+RUN chmod +x setup_ca.sh
+
+# Expose the port your app runs on
+EXPOSE 3000
+
+
+# Define the command to run your application with CA setup
+CMD ["/bin/bash", "-c", "source ./setup_ca.sh && node dist/index.js"]

redis-express/README.md

@@ -0,0 +1,178 @@
+
+# Express Redis Sample
+
+## Overview
+
+This API manages books record, built with Express and Redis. It provides routes to add, update, delete, view books, view books by ID, and change task authors.
+
+## Installation
+
+### Prerequisites
+
+Ensure you have the following installed:
+
+- Docker
+- Node.js and npm
+- Keploy CLI
+
+# Installing Keploy
+
+Let's get started by setting up the Keploy alias with this command:
+
+```sh
+curl -O https://raw.githubusercontent.com/keploy/keploy/main/keploy.sh && source keploy.sh
+```
+
+Clone the repository and move to express-redis folder
+
+```bash
+git clone https://github.com/keploy/samples-typescript.git
+cd samples-typescript/express-redis
+```
+## Installing Locally
+
+### Install the dependencies
+```bash
+npm install
+```
+
+### Start Redis-server Container
+```bash
+docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest
+```
+
+### Load the Samples and build server:
+
+In case of running application natively, we will have to change the host to localhost in index.ts
+
+```bash
+const redisClient = new Redis({
+```
+
+If running server on docker
+
+```bash
+host: 'redis',
+```
+
+If running server locally
+
+```bash
+host: 'localhost'
+port: 6379
+```
+
+### Build the application:
+```bash
+npm install
+npm run build
+```
+
+### Start the application:
+```bash
+npm run start
+```
+
+
+> redis-ts@1.0.0 start
+> node dist/index.js
+
+
+```bash
+Server is running on http://localhost:3000
+Connected to Redis server
+Sample books loaded into Redis
+```
+
+Some sample data is automatically created in redis.
+
+
+## Using Docker
+
+Make sure you have docker installed.
+
+```bash
+git clone https://github.com/keploy/samples-typescript.git
+cd samples-typescript/express-redis
+docker compose up
+```
+
+### Generate Test Cases
+
+For server running locally.
+```bash
+keploy record -c "npm run start"
+```
+
+For the docker container.
+
+```bash
+keploy record -c "docker compose up" --container-name "redis-express" -n "keploy-network"
+```
+
+The above command will start recording the API calls made to the application and will generate a test case in the `testcases/` directory.
+
+> 💡 You can use Postman ,CURL or any other API testing tool to test the API calls.
+
+### Interact with Application
+
+Use Postman, CURL, or any other API testing tool to hit your API routes. This interaction will be recorded by Keploy.
+
+Some curl commands to easily test the application are 
+
+1. "http://localhost:3000/books" to retrieve the data of the books
+
+```bash
+curl --location 'http://localhost:3000/books'
+```
+
+2. "http://localhost:3000/books/:id" to retrieve the data of a specific book
+
+```bash
+curl --location 'http://localhost:3000/books/2'
+```
+
+3. "http://localhost:3000/publish" to publish a book
+
+```bash
+curl --location 'http://localhost:3000/publish' --header 'Content-Type: application/json' --data '{
+    "id":"6",
+    "title":"Harry Potter and the Prisoner of Azkaban",
+    "author":"J.K. Rowling"
+}'
+```
+
+4. "http://localhost:3000/books/:id" to delete a book
+
+```bash
+curl --location --request DELETE 'http://localhost:3000/books/1'
+```
+
+5. "http://localhost:3000/books/:id" to update a book
+
+```bash
+curl --location --request PUT 'http://localhost:3000/books/6' --header 'Content-Type: application/json' --data '{
+    "title":"Harry Potter and the Half-Blood Prince",
+    "author":"J.K. Rowling"
+}'
+```
+
+Observe test run results:
+Voila!! Our test cases have passed 🌟
+
+### Test the Application using Keploy
+
+For server running locally.
+```bash
+keploy test -c "npm run start"
+```
+
+For the docker container.
+
+```bash
+keploy test -c "docker compose up" --container-name "redis-express" -n "keploy-network"
+```
+
+Keploy will replay the recorded interactions and validate the responses against the expected results.
+
+Voila! 🎉 You have successfully tested the application using Keploy. Keploy also generates coverage reports for the test-suites.

redis-express/docker-compose.yml

@@ -0,0 +1,23 @@
+version: '3.8'
+
+services:
+  app:
+    container_name: redis-express
+    build: .
+    ports:
+      - "3000:3000"
+    depends_on:
+      - redis
+    networks:
+      - keploy-network
+
+  redis:
+    image: redis/redis-stack-server:latest
+    ports:
+      - "6379:6379"
+    networks:
+      - keploy-network
+
+networks:
+  keploy-network:
+    external: true