Chore: devcontainer setup

.devcontainer/Dockerfile

@@ -1,13 +1,13 @@
-FROM eligibility_server:latest
-
-# install python tooling
-COPY .devcontainer/requirements.txt .devcontainer/requirements.txt
-RUN pip install --no-cache-dir -r .devcontainer/requirements.txt
-
-# install docs tooling
-COPY docs/requirements.txt docs/requirements.txt
-RUN pip install --no-cache-dir -r docs/requirements.txt
-
-# install test tooling
-COPY tests/requirements.txt tests/requirements.txt
-RUN pip install -r tests/requirements.txt
+FROM eligibility_server:latest
+
+# install python tooling
+COPY .devcontainer/requirements.txt .devcontainer/requirements.txt
+RUN pip install --no-cache-dir -r .devcontainer/requirements.txt
+
+# install docs tooling
+COPY docs/requirements.txt docs/requirements.txt
+RUN pip install --no-cache-dir -r docs/requirements.txt
+
+# install test tooling
+COPY tests/requirements.txt tests/requirements.txt
+RUN pip install -r tests/requirements.txt

.devcontainer/devcontainer.json

@@ -1,28 +1,30 @@
 // For format details, see https://aka.ms/vscode-remote/devcontainer.json
 {
   "name": "cal-itp/eligibility-server",
-  "dockerComposeFile": ["compose.yml"],
+  "dockerComposeFile": ["../compose.yml"],
   "service": "dev",
   "runServices": ["dev", "docs"],
   "workspaceFolder": "/home/calitp/app",
-  "postAttachCommand": ["/bin/bash", ".devcontainer/pre-commit.sh"],
+  "postStartCommand": ["/bin/bash", "bin/init.sh"],
+  "postAttachCommand": ["/bin/bash", ".devcontainer/postAttach.sh"],
 
   // Set *default* container specific settings.json values on container create.
   "settings": {
-      "terminal.integrated.defaultProfile.linux": "bash",
-      "terminal.integrated.profiles.linux": {
-          "bash": {
-              "path": "/bin/bash"
-          }
+    "terminal.integrated.defaultProfile.linux": "bash",
+    "terminal.integrated.profiles.linux": {
+      "bash": {
+        "path": "/bin/bash"
       }
+    }
   },
 
   // Add the IDs of extensions you want installed when the container is created.
   "extensions": [
-      "batisteo.vscode-django",
-      "ms-python.python",
-      "ms-python.vscode-pylance",
-      "eamodio.gitlens",
-      "mhutchie.git-graph"
+    "bpruitt-goddard.mermaid-markdown-syntax-highlighting",
+    "eamodio.gitlens",
+    "esbenp.prettier-vscode",
+    "mhutchie.git-graph",
+    "ms-python.python",
+    "ms-python.vscode-pylance"
   ]
 }

.devcontainer/pre-commit.sh → .devcontainer/postAttach.sh

@@ -1,8 +1,5 @@
 #!/usr/bin/env bash
-set -eu
+set -eux
 
 # initialize hook environments
 pre-commit install --install-hooks --overwrite
-
-# manage commit-msg hooks
-pre-commit install --hook-type commit-msg

.devcontainer/requirements.txt

@@ -1,2 +1,3 @@
+black
 flake8
 pre-commit

.dockerignore

@@ -0,0 +1,5 @@
+.git/
+.github/
+.vscode/
+.flake8
+.*ignore

.github/workflows/run-tests.yml

@@ -2,7 +2,7 @@ name: Run pytests
 
 on:
   pull_request:
-    branches: [ "*" ]
+    branches: ["*"]
 
 jobs:
   tests:
@@ -23,7 +23,7 @@ jobs:
       - name: Load environment variables
         uses: cardinalby/export-env-action@v1
         with:
-          envFile: .devcontainer/.env.sample
+          envFile: .env.sample
 
       - name: Test with pytest
         run: |

.pre-commit-config.yaml

@@ -1,3 +1,7 @@
+default_install_hook_types:
+  - pre-commit
+  - commit-msg
+
 repos:
   - repo: https://github.com/compilerla/conventional-pre-commit
     rev: v2.0.0

.vscode/settings.json

@@ -1,11 +1,20 @@
 {
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "files.encoding": "utf8",
+  "files.eol": "\n",
+  "files.insertFinalNewline": true,
+  "files.trimFinalNewlines": true,
+  "files.trimTrailingWhitespace": true,
+  "[python]": {
+    "editor.defaultFormatter": "ms-python.python"
+  },
+  "python.defaultInterpreterPath": "/usr/local/bin/python",
+  "python.formatting.provider": "black",
+  "python.languageServer": "Pylance",
   "python.linting.flake8Enabled": true,
   "python.linting.enabled": true,
-  "python.languageServer": "Pylance",
-  "python.testing.pytestArgs": [
-    "tests"
-  ],
+  "python.testing.pytestArgs": ["tests"],
   "python.testing.unittestEnabled": false,
-  "python.testing.pytestEnabled": true,
-  "python.defaultInterpreterPath": "/usr/local/bin/python",
+  "python.testing.pytestEnabled": true
 }

bin/init.sh

@@ -0,0 +1,6 @@
+#! usr/bin/env bash
+set -eux
+
+# run database migrations
+
+python setup.py

bin/start.sh

@@ -1,6 +1,10 @@
 #! usr/bin/env bash
 set -eux
 
-python setup.py
+# initialize Flask
+
+bin/init.sh
+
+# start the web server
 
 flask run -h 0.0.0.0

.devcontainer/compose.yml → compose.yml

@@ -1,30 +1,33 @@
+name: eligibility-server
 version: "3.8"
 
 services:
   server:
-    build: ..
+    build: .
     env_file: .env
     image: eligibility_server:latest
     ports:
       - "5000"
     volumes:
-      - ../:/home/calitp/app/
+      - .:/home/calitp/app/
+
   dev:
     build:
-      context: ..
+      context: .
       dockerfile: .devcontainer/Dockerfile
     entrypoint: sleep infinity
     env_file: .env
     image: eligibility_server:dev
     ports:
       - "5000"
     volumes:
-      - ../:/home/calitp/app/
+      - .:/home/calitp/app/
+
   docs:
     image: eligibility_server:dev
     entrypoint: mkdocs
     command: serve --dev-addr "0.0.0.0:8000"
     ports:
       - "8000"
     volumes:
-      - ../:/home/calitp/app:cached
+      - .:/home/calitp/app