Update dev container

.devcontainer/Dockerfile

@@ -1,42 +1,31 @@
-ARG PYTHON_VERSION=3.11
+FROM slackronyms:latest
 
-FROM python:${PYTHON_VERSION}
+# should match the version specified in terraform/pipeline/deploy.yml
+ENV TF_VERSION="1.14.5"
 
-ENV PYTHONDONTWRITEBYTECODE=1 \
-    PYTHONUNBUFFERED=1 \
-    USER=compiler
+# switch to root for package installation
+USER root
 
-# create non-root $USER and home directory
-RUN useradd --create-home --shell /bin/bash $USER && \
-    chown -R $USER /home/$USER
+# install system packages that don't come preinstalled on Alpine
+RUN apk add git \
+            nodejs \
+            npm \
+            openssh-client
 
-# switch to $USER
+# switch back to $USER
 USER $USER
 
-# enter src directory
-WORKDIR /home/$USER/src
-
-# update PATH for local pip installs
-ENV PATH="$PATH:/home/$USER/.local/bin"
-
-# upgrade pip
-RUN python -m pip install --upgrade pip
-
-# copy assets
-COPY . .
-
-# install devcontainer requirements
+# install devcontainer requirements (azure-cli and pre-commit)
+COPY .devcontainer/requirements.txt .devcontainer/requirements.txt
 RUN pip install --no-cache-dir -r .devcontainer/requirements.txt
 
 # install docs requirements
+COPY docs/requirements.txt docs/requirements.txt
 RUN pip install --no-cache-dir -r docs/requirements.txt
 
 # install pre-commit environments in throwaway Git repository
 # https://stackoverflow.com/a/68758943
+COPY .pre-commit-config.yaml .
 RUN git init . && \
     pre-commit install-hooks && \
     rm -rf .git
-
-CMD sleep infinity
-
-ENTRYPOINT []

.devcontainer/devcontainer.json

@@ -1,10 +1,16 @@
 {
-  "name": "compilerla/template-devcontainer",
+  "name": "slackronyms",
   "dockerComposeFile": ["../compose.yml"],
   "service": "dev",
-  "runServices": ["dev", "docs"],
-  "workspaceFolder": "/home/compiler/src",
-  "postAttachCommand": ["/bin/bash", ".devcontainer/postAttach.sh"],
+  "runServices": [
+    "dev",
+    "docs"
+  ],
+  "workspaceFolder": "/compiler/app",
+  "postCreateCommand": [
+    "/bin/bash",
+    ".devcontainer/postCreate.sh"
+  ],
   "customizations": {
     "vscode": {
       // Set *default* container specific settings.json values on container create.
@@ -22,7 +28,12 @@
         "DavidAnson.vscode-markdownlint",
         "eamodio.gitlens",
         "esbenp.prettier-vscode",
-        "mhutchie.git-graph"
+        "mhutchie.git-graph",
+        "ms-python.black-formatter",
+        "ms-python.isort",
+        "ms-python.flake8",
+        "ms-python.python",
+        "tombi-toml.tombi"
       ]
     }
   }

.devcontainer/postCreate.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -eux
+
+# initialize hook environments
+git config --global --add safe.directory /$USER/app
+pre-commit install --install-hooks --overwrite
+
+# manage commit-msg hooks
+pre-commit install --hook-type commit-msg

.devcontainer/requirements.txt

@@ -1 +1,5 @@
+black
+flake8
+isort
 pre-commit
+pytest

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 127

.pre-commit-config.yaml

@@ -17,6 +17,7 @@ repos:
     rev: v0.48.0
     hooks:
       - id: markdownlint
+        language_version: system
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v6.0.0

.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Run Slack Bolt App",
+      "type": "debugpy",
+      "request": "launch",
+      "cwd": "${workspaceFolder}/slackronyms",
+      "program": "app.py",
+      "justMyCode": false,
+      "env": {
+        "PYTHONWARNINGS": "default"
+      }
+    }
+  ]
+}

.vscode/settings.json

@@ -8,5 +8,14 @@
   "files.trimTrailingWhitespace": true,
   "[markdown]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
-  }
+  },
+  "[python]": {
+    "editor.defaultFormatter": "ms-python.black-formatter",
+    "editor.codeActionsOnSave": {
+      "source.organizeImports": "explicit"
+    }
+  },
+  "python.testing.cwd": "./slackronyms",
+  "python.testing.pytestEnabled": true,
+  "python.testing.unittestEnabled": false,
 }

compose.yml

@@ -12,15 +12,17 @@ services:
     build:
       context: .
       dockerfile: .devcontainer/Dockerfile
-    image: compilerla/template-devcontainer:main
+    image: slackronyms:dev
+    env_file: .env
+    entrypoint: sleep infinity
     volumes:
-      - ./:/home/compiler/src
+      - ./:/compiler/app
 
   docs:
-    image: compilerla/template-devcontainer:main
+    image: slackronyms:dev
     entrypoint: mkdocs
-    command: serve --dev-addr "0.0.0.0:8000"
+    command: serve --dev-addr "0.0.0.0:8001"
     ports:
-      - "8000"
+      - "8001"
     volumes:
-      - ./:/home/compiler/src
+      - ./:/compiler/app

pyproject.toml

@@ -0,0 +1,17 @@
+[tool.black]
+line-length = 127
+target-version = ['py312']
+include = '\.pyi?$'
+
+[tool.isort]
+profile = "black"
+combine_as_imports = true
+line_length = 127
+skip_gitignore = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+log_file = "logs/pytest.log"
+log_file_level = "DEBUG"
+log_format = "%(asctime)s %(levelname)s %(message)s"
+log_date_format = "%Y-%m-%d %H:%M:%S"