Merge pull request #7 from EvilGenius13/EG-DC

Eg dc

.dockerignore

@@ -0,0 +1,7 @@
+__pycache__
+.dockerignore
+Dockerfile
+*.md
+*.pyc
+*.pyo
+.git

.github/workflows/ci-build.yml

@@ -0,0 +1,66 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+
+    - name: Cache Docker layers
+      uses: actions/cache@v2
+      with:
+        path: /tmp/.buildx-cache
+        key: ${{ runner.os }}-buildx-${{ github.sha }}
+        restore-keys: |
+          ${{ runner.os }}-buildx-
+
+    - name: Build and start Docker containers
+      run: |
+        docker-compose up -d
+
+    - name: Wait for the server to be up
+      run: |
+        while ! curl -s http://localhost:5000/ > /dev/null; do
+          sleep 1
+        done
+
+    - name: Run tests
+      run: |
+        docker exec -t pokebackpackfinal_pokeapp_1 python3 -m unittest discover -s /app/poke_app/ -p '*test.py'
+
+    - name: Stop Docker containers
+      run: docker-compose down
+
+  build:
+    needs: test
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+
+    - name: Login to Docker Hub
+      uses: docker/login-action@v1
+      with:
+        username: ${{ secrets.DOCKER_USERNAME }}
+        password: ${{ secrets.DOCKER_PASSWORD }}
+
+    - name: Build and push Docker image
+      run: |
+        echo "DOCKER_TAG=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV
+        docker build -t evilgenius13/pokeapp:${DOCKER_TAG} .
+        docker push evilgenius13/pokeapp:${DOCKER_TAG}

.github/workflows/ci-test.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v1
+
+    - name: Cache Docker layers
+      uses: actions/cache@v2
+      with:
+        path: /tmp/.buildx-cache
+        key: ${{ runner.os }}-buildx-${{ github.sha }}
+        restore-keys: |
+          ${{ runner.os }}-buildx-
+    - name: Build and start Docker containers
+      run: |
+        docker-compose up -d
+    - name: Wait for the server to be up
+      run: |
+        while ! curl -s http://localhost:5000/ > /dev/null; do
+          sleep 1
+        done
+    - name: Run tests
+      run: |
+        # Assuming you're running tests from within a container.
+        docker exec -t pokebackpackfinal_pokeapp_1 python3 -m unittest discover -s /app/poke_app/ -p '*test.py'
+    - name: Stop Docker containers
+      run: docker-compose down

Dockerfile

@@ -1,18 +1,24 @@
 # Base image
-FROM python:3.9
+FROM python:3.8-slim-buster
 
 # Set the working directory in the container
 WORKDIR /app
 
+# Install netcat for our startup script - doesn't come with slim-buster (needed for the startup script)
+RUN apt-get update && apt-get install -y netcat && rm -rf /var/lib/apt/lists/*
+
 # Copy the requirements file
 COPY requirements.txt .
 
 # Install the required dependencies
 RUN pip install -r requirements.txt
 
-# Copy the application code into the container
+# Copy the application code and the start-pokeapp.sh script into the container
 COPY . .
 
+# Ensure start-pokeapp.sh is executable
+RUN chmod +x start-pokeapp.sh
+
 # Expose the port your Flask app will be running on
 EXPOSE 5000
 

README.md

@@ -5,10 +5,10 @@
 - Find out their type, height, weight, and more!
 - Find items and their descriptions
 - Add Pokemon to your team, up to six.
+- Built in caching to speed up the app
 
 ## Filling the Database
 - To fill the database:
-  - Go to base.html
   - Click the button that says "Fill Database"
   - Please note it will take a bit to complete. When it's done you'll get a message saying data filled.
 
@@ -20,3 +20,7 @@
   - `docker-compose build`
   - `docker-compose up`
 
+## And DevOps!
+- If you have portainer or another docker management system that allows you to use github repos, you can point to this repo and use `dc-ops.yml` to deploy the app.
+### Thank you
+- Thank you to @digitsgaming for the continual support with server infrastructure and deployment.

dc-ops.yml

@@ -0,0 +1,45 @@
+version: '3' # This is a deployment config for portainer. It pulls from the github repo.
+
+volumes:
+  postgres_data:
+    driver: local
+
+services:
+  postgres:
+    image: postgres:latest
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    environment:
+      POSTGRES_USER: Ash
+      POSTGRES_PASSWORD: Ketchum
+      POSTGRES_DB: pokeappdb
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U Ash"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 5s
+
+  redis:
+    image: redis:latest
+    ports:
+      - "6379:6379"
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 5s
+
+  pokeapp:
+    build: .
+    ports:
+      - "5000:5000"
+    environment:
+      SECRET_KEY: pokemon
+      DATABASE_URL: postgresql://Ash:Ketchum@postgres:5432/pokeappdb
+      REDIS_URL: redis://redis:6379/0
+    depends_on:
+      - postgres
+      - redis
+    command: /app/start-pokeapp.sh  # Script command to watch for postgres and redis to be ready before starting the app

dc-swarm.yml

@@ -0,0 +1,54 @@
+version: '3.8'  # Newer Docker Compose version. This is a deployment config for portainer with docker swarm. It pulls from the github repo.
+
+volumes:
+  postgres_data:
+    driver: local
+
+services:
+  postgres:
+    image: postgres:latest
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+    environment:
+      POSTGRES_USER: Ash
+      POSTGRES_PASSWORD: Ketchum
+      POSTGRES_DB: pokeappdb
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U Ash"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 5s
+
+  redis:
+    image: redis:latest
+    ports:
+      - target: 6379
+        published: 6379
+        protocol: tcp
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 5s
+
+  pokeapp:
+    image: evilgenius13/pokeapp:v2.3
+    ports:
+      - target: 5000
+        published: 5000
+        protocol: tcp
+    environment:
+      SECRET_KEY: pokemon
+      DATABASE_URL: postgresql://Ash:Ketchum@postgres:5432/pokeappdb
+      REDIS_URL: redis://redis:6379/0
+    depends_on:
+      - postgres
+      - redis
+    command: /app/start-pokeapp.sh
+    deploy:
+      replicas: 3
+      update_config:
+        parallelism: 1
+        delay: 10s

docker-compose.yml

@@ -1,18 +1,45 @@
 version: '3'
+
+volumes:
+  postgres_data:
+    driver: local
+
 services:
   postgres:
     image: postgres:latest
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
     environment:
       POSTGRES_USER: Ash
       POSTGRES_PASSWORD: Ketchum
       POSTGRES_DB: pokeappdb
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U Ash"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 5s
+
+  redis:
+    image: redis:latest
+    ports:
+      - "6379:6379"
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 5s
 
   pokeapp:
-    image: evilgenius13/pokeapp:latest
+    image: evilgenius13/pokeapp:v2.3
     ports:
       - "5000:5000"
     environment:
       SECRET_KEY: pokemon
       DATABASE_URL: postgresql://Ash:Ketchum@postgres:5432/pokeappdb
+      REDIS_URL: redis://redis:6379/0
     depends_on:
       - postgres
+      - redis
+    command: /app/start-pokeapp.sh  # Script command to watch for postgres and redis to be ready before starting the app

poke_app/routes.py

@@ -1,5 +1,8 @@
+import os
 import asyncio
 import random
+import redis
+from flask_caching import Cache
 from flask import Blueprint, request, render_template, redirect, url_for, flash
 from flask_login import login_user, logout_user, login_required, current_user
 from poke_app.models import Pokemon, Items, User
@@ -11,6 +14,13 @@
 
 main = Blueprint("main", __name__)
 auth = Blueprint("auth", __name__)
+REDIS_URL = os.environ.get('REDIS_URL', 'redis://localhost:6379/0')
+app.redis = redis.StrictRedis.from_url(REDIS_URL)
+cache = Cache(config={
+    'CACHE_TYPE': 'redis',
+    'CACHE_REDIS_URL': REDIS_URL
+})
+cache.init_app(app)
 
 colours = {
     'Normal': '#A8A77A',
@@ -57,13 +67,24 @@ async def get_items_data(session):
 
     return items_data
 
+TIMEOUT = 300  # 300 seconds or 5 minutes
+
+@cache.memoize(timeout=TIMEOUT)
+def get_all_pokemon():
+    return Pokemon.query.all()
+
+@cache.memoize(timeout=TIMEOUT)
+def get_all_items():
+    return Items.query.all()
+
+
 #! Routes Below this line
 #------------------------------------------------------------#
 
 @main.route('/')
 def homepage():
-    pokemon = Pokemon.query.all()
-    items = Items.query.all()
+    pokemon = get_all_pokemon()
+    items = get_all_items()
     # If there are no Pokémon in the database, set a default Pokémon of the day.
     if not pokemon:
         potd = Pokemon(
@@ -257,15 +278,22 @@ async def fill_data():
         db.session.commit()
 
     asyncio.run(fill_data())
+
+    # Clear the cache for the get_all_pokemon and get_all_items functions
+    cache.delete_memoized(get_all_pokemon)
+    cache.delete_memoized(get_all_items)
+
     flash('Data has been filled!', 'success')
     return redirect(url_for('main.homepage'))
 
 @main.route('/profile/<username>')
 def profile(username):
     user = User.query.filter_by(username=username).first_or_404()
     users = User.query.all()
-    pokemon = Pokemon.query.all()
-    items = Items.query.all()
+
+    pokemon = get_all_pokemon()
+    items = get_all_items()
+
     num_users = len(users)
     num_pokemon = len(pokemon)
     num_items = len(items)

requirements.txt

@@ -14,6 +14,8 @@ WTForms==2.3.3
 Flask-Bcrypt==0.7.1
 Flask-Login==0.5.0
 Gunicorn==20.0.4
-psycopg2==2.8.6
+psycopg2-binary==2.8.6
 requests==2.25.1
 aiohttp==3.7.4.post0
+redis==4.0.2
+Flask-Caching==1.10.1