Poleg lokalne namestitve omogočil še Docker (#70)

Co-authored-by: Matija Pretnar <matija@pretnar.info>

Author: matijapretnar

.devcontainer/Dockerfile

@@ -1,10 +1,11 @@
-// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at:
-// https://github.com/microsoft/vscode-dev-containers/tree/v0.101.0/containers/python-3
 {
 	"name": "Nadlogar",
-	"context": "..",
-	"dockerFile": "Dockerfile",
-	// Set *default* container specific settings.json values on container create.
+	"dockerComposeFile": [
+		"../docker-compose.yml",
+		"docker-compose.yml"
+	],
+	"service": "web",
+	"workspaceFolder": "/workspace",
 	"settings": {
 		"[python]": {
 			"editor.codeActionsOnSave": {
@@ -14,10 +15,10 @@
 		},
 		"python.pythonPath": "/usr/local/bin/python",
 		"python.analysis.extraPaths": [
-			"nadlogar"
+			"/src"
 		],
 		"python.autoComplete.extraPaths": [
-			"nadlogar"
+			"/src"
 		],
 		"python.formatting.provider": "black",
 		"editor.formatOnSave": true,
@@ -31,17 +32,10 @@
 		"python.sortImports.args": [
 			"--profile",
 			"black"
-		],
+		]
 	},
-	// Add the IDs of extensions you want installed when the container is created.
 	"extensions": [
-		"ms-python.python",
-		"ms-python.vscode-pylance"
-	]
-	// Use 'forwardPorts' to make a list of ports inside the container available locally.
-	// "forwardPorts": [],
-	// Use 'postCreateCommand' to run commands after the container is created.
-	// "postCreateCommand": "pip install -r requirements.txt",
-	// Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root.
-	// "remoteUser": "vscode"
+		"ms-python.python"
+	],
+	"remoteUser": "nadlogar"
 }

.devcontainer/devcontainer.json

@@ -0,0 +1,7 @@
+version: "3"
+
+services:
+  web:
+    volumes:
+      - .:/workspace:cached
+      - ./nadlogar:/src:cached

.devcontainer/docker-compose.yml

@@ -4,27 +4,29 @@ on: [ push, pull_request ]
 
 jobs:
   build:
-
+    env:
+      POSTGRES_VERSION: 12
+      POSTGRES_DB: postgres
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      HTTP_PORT: 8001
+      ALLOWED_HOSTS: 127.0.0.1
+      SECRET_KEY: t2-r&t0yj0b%q$b^@ptqya=13mq0rsz1_5&h^ub-=+(ueiqsql
+      DJANGO_SETTINGS_MODULE: config.settings.docker
     runs-on: ubuntu-latest
-    strategy:
-      max-parallel: 4
-      matrix:
-        python-version: [3.6, 3.7, 3.8]
-
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install Dependencies
+    - name: Pull Images
+      run: |
+        docker compose pull
+    - uses: satackey/action-docker-layer-caching@v0.0.11
+      continue-on-error: true
+    - name: Build Containers
       run: |
-        python -m pip install --upgrade pip
-        pip install -r nadlogar/requirements.txt
-        pip install black
+        docker compose build
     - name: Run Tests
       run: |
-        python nadlogar/manage.py test nadlogar
+        docker compose run web python manage.py test .
     - name: Run Black
       run: |
-        python -m black --check .
+        docker compose run web python -m black --check .

.github/workflows/django.yml

@@ -0,0 +1,26 @@
+version: "3"
+   
+services:
+  db:
+    image: postgres:${POSTGRES_VERSION}
+    restart: always
+    volumes:
+      - ./data/db:/var/lib/postgresql/data
+    environment:
+      - POSTGRES_DB
+      - POSTGRES_USER
+      - POSTGRES_PASSWORD
+  web:
+    build: nadlogar
+    restart: always
+    ports:
+      - "${HTTP_PORT}:8000"
+    depends_on:
+      - db
+    environment:
+      - DJANGO_SETTINGS_MODULE
+      - ALLOWED_HOSTS
+      - SECRET_KEY
+      - POSTGRES_DB
+      - POSTGRES_USER
+      - POSTGRES_PASSWORD

docker-compose.yml

@@ -0,0 +1,8 @@
+POSTGRES_VERSION=12
+POSTGRES_DB=postgres
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=postgres
+HTTP_PORT=8000
+ALLOWED_HOSTS=127.0.0.1
+SECRET_KEY=t2-r&t0yj0b%q$b^@ptqya=13mq0rsz1_5&h^ub-=+(ueiqsql
+DJANGO_SETTINGS_MODULE=config.settings.docker

example.env

@@ -0,0 +1,11 @@
+FROM python:3
+ENV PYTHONUNBUFFERED=1
+RUN apt-get update && apt-get install -y texlive texlive-fonts-extra
+WORKDIR /src
+RUN groupadd -g 1000 nadlogar && useradd -m -u 1000 -g nadlogar nadlogar -s /bin/bash
+COPY requirements /src/requirements
+RUN pip install --no-cache-dir -r requirements/docker.txt
+COPY . /src/
+RUN chown -R nadlogar /src
+USER nadlogar
+CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]

nadlogar/Dockerfile

@@ -10,24 +10,15 @@
 https://docs.djangoproject.com/en/3.2/ref/settings/
 """
 
+import os
 from pathlib import Path
 
 # Build paths inside the project like this: BASE_DIR / 'subdir'.
-BASE_DIR = Path(__file__).resolve().parent.parent
-
+BASE_DIR = Path(__file__).resolve().parent.parent.parent
 
 # Quick-start development settings - unsuitable for production
 # See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
 
-# SECURITY WARNING: keep the secret key used in production secret!
-SECRET_KEY = "t2-r&t0yj0b%q$b^@ptqya=13mq0rsz1_5&h^ub-=+(ueiqsql"
-
-# SECURITY WARNING: don't run with debug turned on in production!
-DEBUG = True
-
-ALLOWED_HOSTS = []
-
-
 # Application definition
 
 INSTALLED_APPS = [
@@ -75,17 +66,6 @@
 WSGI_APPLICATION = "config.wsgi.application"
 
 
-# Database
-# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
-
-DATABASES = {
-    "default": {
-        "ENGINE": "django.db.backends.sqlite3",
-        "NAME": BASE_DIR / "db.sqlite3",
-    }
-}
-
-
 # Password validation
 # https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators
 

nadlogar/config/settings/__init__.py

@@ -0,0 +1,24 @@
+from .common import *
+import os
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = os.environ["SECRET_KEY"]
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = [os.environ["ALLOWED_HOSTS"]]
+
+# Database
+# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.postgresql",
+        "NAME": os.environ["POSTGRES_DB"],
+        "USER": os.environ["POSTGRES_USER"],
+        "PASSWORD": os.environ["POSTGRES_PASSWORD"],
+        "HOST": "db",
+        "PORT": "5432",
+    }
+}