Refactor: pems_web package (#181)

Author: thekaveman

.devcontainer/Dockerfile

@@ -1,7 +1,54 @@
-FROM caltrans/pems:web
+ARG PYTHON_VERSION=3.12
 
+FROM python:${PYTHON_VERSION}
+
+WORKDIR /tmp
+
+# install AWS CLI and Copilot CLI (requires root permissions)
+# download AWS Copilot CLI to /tmp to avoid write error (23) from curl command
+RUN HOST_ARCH=$(uname -m) && \
+    case "$HOST_ARCH" in \
+      x86_64) HOST_ARCH="amd64" ;; \
+      aarch64) HOST_ARCH="arm64" ;; \
+    esac \
+    && if [ "$HOST_ARCH" = "amd64" ]; then \
+    curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"; \
+    elif [ "$HOST_ARCH" = "arm64" ]; then \
+    curl "https://awscli.amazonaws.com/awscli-exe-linux-aarch64.zip" -o "awscliv2.zip"; \
+    fi \
+    && unzip awscliv2.zip \
+    && ./aws/install \
+    && rm -rf aws awscliv2.zip \
+    && curl -Lo copilot https://github.com/aws/copilot-cli/releases/latest/download/copilot-linux \
+    && chmod +x copilot \
+    && mv copilot /usr/local/bin/copilot
+
+ENV PYTHONDONTWRITEBYTECODE=1 \
+    PYTHONUNBUFFERED=1 \
+    USER=caltrans
+ENV RUNTIME_DIR=/$USER/app
+
+# create non-root $USER and home directory
+RUN useradd --create-home --shell /bin/bash $USER \
+    && apt-get update \
+    && apt-get install -qq --no-install-recommends build-essential gettext \
+    && python -m pip install --upgrade pip \
+    && mkdir -p "$RUNTIME_DIR"
+
+WORKDIR /$USER/app
+
+# copy source files and update permissions
 COPY . .
 
+RUN git config --global --add safe.directory . \
+    && chown -R $USER:$USER /$USER
+
+# Switch to non-root user
+USER $USER
+
+ENV PATH="$PATH:/$USER/.local/bin" \
+    PYTHONUSERBASE="/$USER/.local"
+
 # install devcontainer requirements
 RUN pip install -e .[dev,test]
 
@@ -10,16 +57,3 @@ RUN pip install --no-cache-dir -r docs/requirements.txt
 
 # install streamlit requirements
 RUN pip install --no-cache-dir -r streamlit_app/requirements.txt
-
-# install AWS Copilot CLI (requires root permissions)
-USER root
-# download AWS Copilot CLI to /tmp to avoid write error (23) from curl command
-WORKDIR /tmp
-
-RUN curl -Lo copilot https://github.com/aws/copilot-cli/releases/latest/download/copilot-linux \
-    && chmod +x copilot \
-    && mv copilot /usr/local/bin/copilot
-
-# Switch back to non-root user and app directory
-USER $USER
-WORKDIR /$USER/app

.env.sample

@@ -8,7 +8,7 @@ DJANGO_DB_RESET=true
 DJANGO_DB_NAME=django
 DJANGO_DB_USER=django
 DJANGO_DB_PASSWORD=django_password
-DJANGO_DB_FIXTURES="pems/local_fixtures.json"
+DJANGO_DB_FIXTURES=pems_web/src/pems_web/local_fixtures.json
 
 # PostgreSQL settings
 POSTGRES_HOSTNAME=postgres

.github/workflows/deploy-troubleshoot.yml

@@ -24,21 +24,11 @@ jobs:
           cache: pip
           cache-dependency-path: "**/pyproject.toml"
 
-      - name: Write python packages to file
-        run: |
-          python -m venv .venv
-          source .venv/bin/activate
-          pip install pipdeptree
-          pip install -e .
-          mkdir -p pems/static
-          pipdeptree
-          pipdeptree >> pems/static/requirements.txt
-
       - name: Write commit SHA to file
-        run: echo "${{ github.sha }}" >> pems/static/sha.txt
+        run: echo "${{ github.sha }}" >> pems_web/src/pems_web/static/sha.txt
 
       - name: Write tag to file
-        run: echo "${{ github.ref_name }}" >> pems/static/version.txt
+        run: echo "${{ github.ref_name }}" >> pems_web/src/pems_web/static/version.txt
 
       - name: Configure AWS Credentials
         uses: aws-actions/configure-aws-credentials@v4

.github/workflows/deploy.yml

@@ -50,21 +50,11 @@ jobs:
           cache: pip
           cache-dependency-path: "**/pyproject.toml"
 
-      - name: Write python packages to file
-        run: |
-          python -m venv .venv
-          source .venv/bin/activate
-          pip install pipdeptree
-          pip install -e .
-          mkdir -p pems/static
-          pipdeptree
-          pipdeptree >> pems/static/requirements.txt
-
       - name: Write commit SHA to file
-        run: echo "${{ github.sha }}" >> pems/static/sha.txt
+        run: echo "${{ github.sha }}" >> pems_web/src/pems_web/static/sha.txt
 
       - name: Write tag to file
-        run: echo "${{ github.ref_name }}" >> pems/static/version.txt
+        run: echo "${{ github.ref_name }}" >> pems_web/src/pems_web/static/version.txt
 
       - name: Configure AWS Credentials
         uses: aws-actions/configure-aws-credentials@v4

.github/workflows/tests-pytest.yml

@@ -35,7 +35,7 @@ jobs:
         uses: actions/upload-artifact@v4
         with:
           name: coverage-report
-          path: pems/static/coverage
+          path: static/coverage
 
       - name: Coverage comment
         uses: py-cov-action/python-coverage-comment-action@v3

.gitignore

@@ -5,7 +5,7 @@
 *.tmp
 *.egg-info
 static/
-!pems/static
+!pems_web/src/pems_web/static
 __pycache__/
 .coverage
 .DS_Store

bin/makemigrations.sh

@@ -7,4 +7,4 @@ python manage.py makemigrations
 
 # reformat with black
 
-python -m black pems/districts/migrations/*.py
+python -m black pems_web/src/pems_web/**/migrations/*.py

bin/start.sh

@@ -11,4 +11,4 @@ nginx
 
 # start the application server
 
-python -m gunicorn -c $GUNICORN_CONF pems.wsgi
+python -m gunicorn -c $GUNICORN_CONF pems_web.wsgi

compose.yml

@@ -4,7 +4,7 @@ services:
   web:
     build:
       context: .
-      dockerfile: appcontainer/Dockerfile
+      dockerfile: pems_web/container/Dockerfile
     image: caltrans/pems:web
     command: ["-c", "bin/setup.sh && exec bin/start.sh"]
     depends_on:

infra/copilot/web/manifest.yml

@@ -18,7 +18,7 @@ http:
 image:
   # Docker build arguments. For additional overrides: https://aws.github.io/copilot-cli/docs/manifest/lb-web-service/#image-build
   build:
-    dockerfile: ../appcontainer/Dockerfile
+    dockerfile: ../pems_web/container/Dockerfile
     context: ../
   # Port exposed through your container to route traffic to it.
   port: 8000