Merge pull request #346 from micahflee/containerize

Containerize Hush Line

Author: glenn-sorrentino

.github/workflows/merge-to-main.yml

@@ -37,9 +37,9 @@ jobs:
         run: poetry install --all-extras
 
       - name: Lint
-        run: poetry -v run make lint
+        run: poetry run isort --check . && poetry run black --check . && poetry run flake8 --config setup.cfg . && poetry run mypy --config-file pyproject.toml .
 
       - name: Test
-        run: poetry -v run make test
+        run: source test.env && poetry run pytest -vv tests -p no:warnings
         env:
           CI: true

.github/workflows/pull-request.yml

@@ -37,8 +37,8 @@ jobs:
         run: poetry install --all-extras
 
       - name: Lint
-        run: poetry -v run make lint
+        run: poetry run isort --check . && poetry run black --check . && poetry run flake8 --config setup.cfg . && poetry run mypy --config-file pyproject.toml .
 
       - name: Test
-        run: poetry -v run make test
+        run: source test.env && poetry run pytest -vv tests -p no:warnings
         continue-on-error: true

.gitignore

@@ -9,3 +9,5 @@ _DEV.md
 hushline.db
 /tests/__pycache__
 hushline/static/data/users_directory.json
+volumes/app
+volumes/redis

Dockerfile

@@ -0,0 +1,27 @@
+FROM python:3.12-bookworm
+WORKDIR /app
+
+# Install system dependencies
+RUN apt-get update && \
+    apt-get upgrade -y && \
+    apt-get install -y --no-install-recommends \
+    build-essential curl libpcsclite-dev clang llvm pkg-config nettle-dev \
+    && rm -rf /var/lib/apt/lists/*
+
+# Install Poetry
+RUN pip install poetry
+
+# Install Rust (for SequoiaPGP)
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+ENV PATH="/root/.cargo/bin:${PATH}"
+
+# Install Poetry dependencies
+COPY poetry.lock pyproject.toml /app/
+RUN poetry install
+
+# Copy the rest of the application
+COPY . /app
+
+# Run!
+ENV FLASK_APP="hushline/__init__.py"
+CMD ["poetry", "run", "flask", "run", "-p", "5000", "--host", "0.0.0.0"]

Makefile

@@ -6,31 +6,22 @@ help: ## Print the help message
 		sort | \
 		column -s ':' -t
 
-.PHONY: run
-run: ## Run the app
-	@source ./files/dev/env.sh && \
-	flask run --debug -h localhost -p 5000
+.PHONY: dev
+dev: ## Run the app in development mode
+	docker-compose up --build
+
+.PHONY: test
+test: ## Run the test suite
+	docker-compose exec app bash -c "poetry run pytest -vv tests -p no:warnings"
 
 .PHONY: lint
 lint: ## Lint the code
-	isort --check . && \
-		black --check . && \
-		flake8 --config setup.cfg . && \
-		mypy --config-file pyproject.toml .
+	docker-compose exec app poetry run bash -c "isort --check . && black --check . && flake8 --config setup.cfg . && mypy --config-file pyproject.toml ."
 
 .PHONY: fmt
 fmt: ## Format the code
-	isort . && \
-		black .
+	docker-compose exec app poetry run bash -c "isort . && black ."
 
-.PHONY: init-db
-init-db: ## Initialize the dev database
-	flask db-extras init-db
-
-.PHONY: test
-test: ## Run the test suite
-	@if [ -n "$$BASH_VERSION" ]; then \
-		source ./files/dev/env.sh && pytest -vv tests -p no:warnings; \
-	else \
-		. ./files/dev/env.sh; pytest -vv tests -p no:warnings; \
-	fi
+.PHONY: shell
+shell: ## Get a shell in the container
+	docker-compose exec app bash

docker-compose.yaml

@@ -0,0 +1,21 @@
+services:
+  app:
+    build: .
+    ports:
+      - "5000:5000"
+    environment:
+      - SQLALCHEMY_DATABASE_URI=sqlite:////data/hushline.db
+      - FLASK_ENV=development
+      - SECRET_KEY="cb3f4afde364bfb3956b97ca22ef4d2b593d9d980a4330686267cabcd2c0befd"
+      - ENCRYPTION_KEY="bi5FDwhZGKfc4urLJ_ChGtIAaOPgxd3RDOhnvct10mw="
+      - REDIS_URI=redis://redis:6379
+    volumes:
+      - ./volumes/app:/data
+      - ./:/app
+    depends_on:
+      - redis
+
+  redis:
+    image: "redis:alpine"
+    ports:
+      - "6379:6379"

docs/DEV.md

@@ -2,50 +2,33 @@
 
 👋 Welcome to the Hush Line Development setup guide. This document provides detailed instructions for configuring your local development environment across Mac, Windows, and Linux systems. It includes specific steps for installing dependencies, cloning the repository, and initiating a local server using the included `Makefile`. The guide also covers utilizing tests, linters, and formatters to ensure code integrity and consistency. Follow these instructions to prepare your machine for Hush Line development 👇.
 
-<img src="https://github.com/scidsg/hushline/assets/28545431/3108811e-226e-4451-9793-c893da96184c" width="66%">
+<img src="https://github.com/scidsg/hushline/assets/28545431/3108811e-226e-4451-9793-c893da96184c" width="80%">
 
 <h2>Local Development</h2>
 
-## Mac
+Install [Docker Desktop](https://www.docker.com/products/docker-desktop/) for your platform.
 
-| Tested Platform | OS Version | Browser | Status | Date | Notes |
-|-|-|-|-|-|-|
-| Macbook M2 | OSX 13.2.1 | Firefox 124.0.2 | ✅ | Apr. 2024 | |
-| Macbook M1 | OSX 14.4.1 | Firefox 124.0.2 | ✅ | Apr. 2024 | |
-| Macbook M1 | OSX 14.4.1 | Safari 17.4.1 | ☑️ | Apr. 2024 | App starts but a CSRF token mismatch blocks registration. |
+Clone the repo:
 
-### Install Packages
-1. `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
-2. `eval "$(/opt/homebrew/bin/brew shellenv)"`
-3. `brew install python git git-lfs redis rust poetry`
+```sh
+git clone https://github.com/scidsg/hushline.git
+cd hushline
+```
 
-### Clone the Repo
-4. `git clone https://github.com/scidsg/hushline.git`
-5. `cd hushline`
-6. `/opt/homebrew/bin/python3 -m venv venv`
-7. `source venv/bin/activate`
-8. `poetry install`
-9. `source files/dev/env.sh`
-10. `sudo lsof -ti:5000 | xargs kill -9` _Optional_
-11. `poetry run flask db upgrade` _Optional_
-12. `poetry run make init-db run`
+Start Hush Line for development:
 
-## Windows
+```sh
+make dev
+```
 
-| Tested Platform | Date |
-|-|-|
-|  |  |
+Test changes:
 
-### Linux
+```sh
+make test
+```
 
-| Tested Platform | Date |
-|-|-|
-|  |  |
+If you need to get a shell in the container to manually run commands:
 
-<h2>Tests, Linters, and Formatters</h2>
-
-## Testing Changes
-
-1. `poetry run pre-commit run --all-files --verbose`.
-
-2. `poetry run make test`.
+```sh
+make shell
+```