Add Playwright integration with Docker setup and initial API routes

Author: Zaffer

README.md

@@ -59,6 +59,9 @@ Plotly Dash
 ### Grafana
 Grafana OSS
 
+### Playwright
+Microsoft Playwright
+
 
 # TOOLS
 

docker-compose.yml

@@ -90,3 +90,23 @@ services:
     command: ionic serve --external
     # tty: true
 
+
+  playwright:
+    container_name: playwright_container
+    build:
+      context: ./services/_templates/playwright
+      dockerfile: playwright.dockerfile
+      network: host
+      args:
+        - ENVIRONMENT=${ENVIRONMENT-dev}
+    environment:
+      - GOOGLE_APPLICATION_CREDENTIALS=/tmp/keys/application_default_credentials.json
+      - GOOGLE_CLOUD_PROJECT=gcp-proj-playwright
+    ports:
+      - 8000:8000
+    volumes:
+      - ./services/_templates/playwright/screens:/tmp/screens
+      - ./services/_templates/playwright/src/app:/app
+      - ~/.config/gcloud/application_default_credentials.json:/tmp/keys/application_default_credentials.json
+    command: uvicorn main:app --reload --workers 1 --host 0.0.0.0 --port ${PORT-8000} --log-level info
+    # tty: true

services/_templates/playwright/playwright.dockerfile

@@ -0,0 +1,76 @@
+# pull python image
+FROM python:3.12-slim as base-stage
+
+# set working directory
+WORKDIR /app
+
+# set python environment
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    PYTHONPATH=/
+
+# set environment variables
+ARG ENVIRONMENT=prod
+ENV ENVIRONMENT=${ENVIRONMENT}
+
+# set virtual environment
+ENV VIRTUAL_ENV=/venv
+RUN python3 -m venv ${VIRTUAL_ENV}
+ENV PATH="${VIRTUAL_ENV}/bin:$PATH"
+
+# specify location out of app dir so no override on copy
+ENV PLAYWRIGHT_BROWSERS_PATH=/temp/ms-playwright
+
+# install system dependencies
+RUN apt-get -y update \
+  && apt-get -y upgrade \
+  # && apt-get -y install netcat gcc postgresql \
+  # && apt-get -y install gcc \
+  && apt-get clean
+
+# use base-stage for build
+FROM base-stage as builder-stage
+
+# prevent poetry virtual environment
+ENV POETRY_VIRTUALENVS_CREATE false
+
+# # copy in local packages for installation
+# COPY ./local_package /app/local_package
+
+# install python dependencies
+RUN pip install --upgrade pip \
+  && pip install --no-cache-dir poetry
+COPY ./src/pyproject.toml ./src/poetry.lock ./
+RUN bash -c "if [ ${ENVIRONMENT} == 'dev' ] || [ ${ENVIRONMENT} == 'proxy' ] ; \
+  then . /venv/bin/activate && poetry install --no-root --no-interaction; \
+  else . /venv/bin/activate && poetry install --no-root --no-interaction --no-ansi --only main; fi"
+
+# lint and stop build if fail for CI/CD
+# COPY . .
+# RUN pip install black flake8 isort
+# RUN flake8 .
+# RUN black .
+# RUN isort .
+
+# use base-stage for final-stage image
+FROM base-stage as final-stage
+
+# copy built venv folder
+COPY --from=builder-stage /venv /venv
+
+# copy src to app folder
+COPY ./src/app .
+
+# Install playwrite dependencies
+RUN playwright install --with-deps chromium
+
+# use a non-root user
+RUN addgroup --system school && adduser --system --ingroup school fish
+RUN chown -R fish:school /app
+USER fish
+
+# start the worker
+CMD uvicorn main:app --workers 1 --host 0.0.0.0 --port ${PORT-8080} --log-level info
+
+# keep container alive for inspection
+# CMD sh -c "while true; do sleep 1; done"

services/_templates/playwright/scripts/deploy.sh

@@ -0,0 +1,27 @@
+#! /usr/bin/env sh
+
+set -e
+
+# # DEPLOY TO PRODUCTION # #
+
+# # set the environment
+export ENVIRONMENT=prod
+export GOOGLE_CLOUD_PROJECT=your_gcp_project_prod
+gcloud config set project your_gcp_project_prod
+
+docker compose down
+
+# # build the images
+docker compose -f docker-compose.yml build api --no-cache
+
+# # upload image to artifact registry
+docker tag fast-stack-api europe-west1-docker.pkg.dev/your_gcp_project_prod/your-gcp-artifacts/api:latest
+docker push europe-west1-docker.pkg.dev/your_gcp_project_prod/service_account-artifacts-prod/api:latest
+
+# # deploy cloud run revision with latest image
+gcloud run deploy api --image europe-west1-docker.pkg.dev/your_gcp_project_prod/your-gcp-artifacts/api:latest
+
+# # webhook alert
+curl -X POST -H "Content-Type: application/json" -d '{"content": "'${USER}' deployed API to PROD 🚢"}'  https://discord.com/api/webhooks/
+
+echo '🚢'

services/_templates/playwright/scripts/start.sh

@@ -0,0 +1,12 @@
+#! /usr/bin/env sh
+set -e
+
+## START SCRIPT FOR DEVELOPMENT ##
+## start the local development environment with this script
+
+## set environment variables
+gcloud config set project your_gcp_project_prod
+export GOOGLE_CLOUD_PROJECT=$(gcloud config get-value project)
+export ENVIRONMENT=dev
+
+docker compose up temp_api -d --build

services/_templates/playwright/src/.dockerignore

@@ -0,0 +1,14 @@
+**.pyc
+**.pyo
+**.pyd
+__pycache__
+.pytest_cache
+
+.env
+
+.dockerignore
+Dockerfile
+.dockerfile
+
+.coverage
+htmlcov/

services/_templates/playwright/src/app/__init__.py

@@ -0,0 +1,44 @@
+""""Central place to store Depends functions for use in path operator functions or path decorators
+"""
+from typing import Generator
+
+# from app import crud, schemas, models
+from app.core.config import secrets
+from app.core.security.auth0 import Auth0, Auth0User
+from fastapi import Depends, HTTPException, Security, status
+from fastapi.security import HTTPBearer, OAuth2PasswordBearer
+from loguru import logger
+from pydantic import ValidationError
+
+
+auth0 = Auth0(
+    domain=secrets.AUTH0_DOMAIN,
+    api_audience=secrets.AUTH0_API_AUDIENCE,
+    # These scopes are selectable in the interactive docs
+    scopes={
+        "read:users": "required role: ADMIN",
+        "read:all": "required role: SUPPORT",
+        "write:all": "required role: SUPPORT",
+    },
+)
+
+
+def get_auth0_user(
+    auth0_user: Auth0User = Security(auth0.get_user, scopes=[]),
+) -> Auth0User:
+
+    return auth0_user
+
+
+def get_auth0_user_be_admin(
+    auth0_user: Auth0User = Security(auth0.get_user, scopes=["read:users"]),
+) -> Auth0User:
+
+    return auth0_user
+
+
+def get_auth0_user_be_support(
+    auth0_user: Auth0User = Security(auth0.get_user, scopes=["read:all", "write:all"]),
+) -> Auth0User:
+
+    return auth0_user

services/_templates/playwright/src/app/api/__init__.py

@@ -0,0 +1,10 @@
+"""Routes for the V1 API"""
+
+from fastapi import APIRouter
+
+from app.api.v0 import ping, report
+
+v0_router = APIRouter(prefix="/v0")
+
+v0_router.include_router(report.router, tags=["report"])
+