Merge pull request 'Update dependency flask-migrate to v4' (!111) from renovate/flask-migrate-4.x into main

Reviewed-on: kompetenzinventar/ki-backend#111

.dockerignore

@@ -0,0 +1,13 @@
+# SPDX-FileCopyrightText: WTF Kooperative eG <https://wtf-eg.de/>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+*
+!Pipfile
+!Pipfile.lock
+!data/
+!ki/
+!LICENSES/
+!migrations/
+!app.py
+!run_prod.py

.drone.yml

@@ -4,31 +4,125 @@
 # SPDX-License-Identifier: AGPL-3.0-or-later
 kind: pipeline
 type: docker
-name: default
+name: qa
+
+trigger:
+  event:
+    - push
+    - pull_request
+  branch:
+    - main
 
 steps:
-- name: qa
-  image: registry.wtf-eg.net/ki-backend-builder:1.0.0
+  - name: install-lint-test
+    image: python:3.8.20-alpine@sha256:3d93b1f77efce339aa77db726656872517b0d67837989aa7c4b35bd5ae7e81ba
+    env:
+      PYROOT: '/pyroot'
+      PYTHONUSERBASE: '/pyroot'
     commands:
+      - apk add --no-cache gcc g++ musl-dev python3-dev
+      - pip3 install pipenv
+      - pipenv verify
       - pipenv install --dev
       - pipenv run flake8
       - pipenv run reuse lint
       - pipenv run python -m unittest discover ki
-
-- name: docker-publish
-  image: plugins/docker
+  - name: docker-dry-run
+    image: plugins/docker:20.18.4@sha256:a8d3d86853c721492213264815f1d00d3ed13f42f5c1855a02f47fa4d5f1e042
     settings:
-    registry: registry.wtf-eg.net
-    repo: registry.wtf-eg.net/ki-backend
+      registry: git.wtf-eg.de
+      repo: git.wtf-eg.de/kompetenzinventar/backend
+      target: ki-backend
+      dry_run: true
+    when:
+      event:
+        - pull_request
+
+---
+kind: pipeline
+type: docker
+name: build
+
+trigger:
+  event:
+    - push
+  branch:
+    - main
+
+depends_on:
+  - qa
+
+steps:
+  - name: docker-publish
+    image: plugins/docker:20.18.4@sha256:a8d3d86853c721492213264815f1d00d3ed13f42f5c1855a02f47fa4d5f1e042
+    settings:
+      registry: git.wtf-eg.de
+      repo: git.wtf-eg.de/kompetenzinventar/backend
       target: ki-backend
       auto_tag: true
       username:
         from_secret: "docker_username"
       password:
         from_secret: "docker_password"
-  when:
+
+---
+kind: pipeline
+type: docker
+name: deploy
+
+trigger:
+  event:
+    - push
   branch:
     - main
 
-image_pull_secrets:
-- dockerconfig
+depends_on:
+  - build
+
+steps:
+  - name: deploy-dev
+    image: appleboy/drone-ssh:1.7.5@sha256:995677e073454912f26d4c0fdd2f9df2e1f5a30d6603d3f2ece667311b6babb3
+    settings:
+      host:
+        - dev01.wtf-eg.net
+      username: drone_deployment
+      key:
+        from_secret: "dev01_deployment_key"
+      command_timeout: 2m
+      script:
+        - echo "Executing forced command..."
+
+
+---
+kind: pipeline
+type: docker
+name: tag-release
+
+trigger:
+  event:
+    - tag
+
+steps:
+  - name: install-lint-test
+    image: python:3.8.20-alpine@sha256:3d93b1f77efce339aa77db726656872517b0d67837989aa7c4b35bd5ae7e81ba
+    env:
+      PYROOT: '/pyroot'
+      PYTHONUSERBASE: '/pyroot'
+    commands:
+      - apk add --no-cache gcc g++ musl-dev python3-dev
+      - pip3 install pipenv
+      - pipenv install --dev
+      - pipenv run flake8
+      - pipenv run reuse lint
+      - pipenv run python -m unittest discover ki
+  - name: docker-publish
+    image: plugins/docker:20.18.4@sha256:a8d3d86853c721492213264815f1d00d3ed13f42f5c1855a02f47fa4d5f1e042
+    settings:
+      registry: git.wtf-eg.de
+      repo: git.wtf-eg.de/kompetenzinventar/backend
+      target: ki-backend
+      auto_tag: true
+      username:
+        from_secret: "docker_username"
+      password:
+        from_secret: "docker_password"

.python-version

@@ -0,0 +1 @@
+3.8.20

.reuse/dep5

@@ -1,12 +0,0 @@
-Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
-Upstream-Name: Kompetenzinventar
-Upstream-Contact: Michael Weimann <mail@michael-weimann.eu>
-Source: https://git.wtf-eg.de/kompetenzinventar/ki-backend
-
-Files: data/imgs/flags/*
-Copyright: 2017 Go Squared Ltd. http://www.gosquared.com/
-License: MIT
-
-Files: Pipfile.lock migrations/*
-Copyright: WTF Kooperative eG <https://wtf-eg.de/>
-License: AGPL-3.0-or-later

.yapfignore

@@ -0,0 +1,5 @@
+# SPDX-FileCopyrightText: WTF Kooperative eG <https://wtf-eg.de/>
+#
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+migrations/*.py

Dockerfile

@@ -2,7 +2,17 @@
 #
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
-FROM registry.wtf-eg.net/ki-backend-builder:1.0.0 as builder
+FROM python:3.8.20-alpine@sha256:3d93b1f77efce339aa77db726656872517b0d67837989aa7c4b35bd5ae7e81ba AS builder
+
+ENV PYROOT=/pyroot
+ENV PYTHONUSERBASE=$PYROOT
+
+RUN apk add --no-cache \
+    gcc \
+    g++ \
+    musl-dev \
+    python3-dev && \
+    pip3 install pipenv
 
 COPY Pipfile* ./
 
@@ -10,7 +20,10 @@ RUN PIP_USER=1 PIP_IGNORE_INSTALLED=1 pipenv install --system --deploy --ignore-
 RUN pip3 uninstall --yes pipenv
 
 
-FROM registry.wtf-eg.net/ki-backend-base:1.0.0 as ki-backend
+FROM python:3.8.20-alpine@sha256:3d93b1f77efce339aa77db726656872517b0d67837989aa7c4b35bd5ae7e81ba AS ki-backend
+
+ENV PYROOT=/pyroot
+ENV PYTHONUSERBASE=$PYROOT
 
 # Install six explicitly. Otherwise Python complains about it missing.
 RUN pip3 install six
@@ -22,4 +35,9 @@ WORKDIR /app
 
 COPY . .
 
+LABEL org.opencontainers.image.source=https://git.wtf-eg.de/kompetenzinventar/ki-backend.git
+LABEL org.opencontainers.image.url=https://git.wtf-eg.de/kompetenzinventar/ki-backend
+LABEL org.opencontainers.image.documentation=https://git.wtf-eg.de/kompetenzinventar/ki-backend#docker
+LABEL org.opencontainers.image.vendor="WTF Kooperative eG"
+
 CMD ["python3", "run_prod.py"]

Pipfile

@@ -8,22 +8,23 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
-flask = "~=2.0.1"
-python-dotenv = "~=0.17.1"
-flask-migrate = "~=3.0.1"
-flask-sqlalchemy  = "~=2.5.1"
-sqlalchemy = "~=1.4.18"
-waitress = "~=2.0.0"
-pyyaml = "~=5.4.1"
-flask-cors = "~=3.0.10"
-ldap3 = "~=2.9"
-pymysql = "~=1.0.2"
+flask = "==2.3.3"
+python-dotenv = "==1.0.1"
+flask-migrate = "==4.0.7"
+flask-sqlalchemy  = "==2.5.1"
+sqlalchemy = "==1.4.54"
+waitress = "==2.1.2"
+pyyaml = "==6.0.2"
+flask-cors = "==5.0.0"
+ldap3 = "==2.9.1"
+pymysql = "==1.1.1"
+werkzeug = "==2.3.8"
 
 [dev-packages]
-flake8 = "~=3.9.2"
-yapf = "~=0.31.0"
-pre-commit = "~=2.13.0"
-reuse = "~=0.13.0"
+flake8 = "==7.1.1"
+yapf = "==0.40.2"
+pre-commit = "==2.21.0"
+reuse = "==4.0.3"
 
 [requires]
 python_version = "3.8"

README.md

@@ -222,25 +222,6 @@ docker-compose up
 
 Dann http://localhost:13337 aufrufen.
 
-### Workaround, falls der Zugriff auf registry.wtf-eg.net nicht möglich ist
-
-Voraussetzung: 
-
-[ki-backend-docker](https://git.wtf-eg.de/kompetenzinventar/ki-backend-docker) muss parallel zum `ki-backend` ausgecheckt sein.
-
-```
-cd ki-backend-docker
-docker build . --target base -t ki-backend-base
-docker build . --target builder -t ki-backend-builder
-```
-
-Ändern der 2 Einträge im `Dockerfile` des `ki-backend`:
-
-- registry.wtf-eg.net/ki-backend-builder:1.0.0 -> ki-backend-builder
-- registry.wtf-eg.net/ki-backend-base:1.0.0 -> ki-backend-base
-
-Danach sollte `docker-compose up` funktionieren.
-
 ## Lizenzen
 
 Dieses Projekt erfüllt die [REUSE](https://reuse.software/) Spezifikation.

REUSE.toml

@@ -0,0 +1,24 @@
+# SPDX-FileCopyrightText: NONE
+# SPDX-License-Identifier: CC0-1.0
+
+version = 1
+SPDX-PackageName = "Kompetenzinventar Backend"
+SPDX-PackageDownloadLocation = "https://git.wtf-eg.de/kompetenzinventar/ki-backend"
+
+[[annotations]]
+path = "data/imgs/flags/**"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2013 Panayiotis Lipiridis <https://flagicons.lipis.dev/>"
+SPDX-License-Identifier = "MIT"
+
+[[annotations]]
+path = ["Pipfile.lock", "migrations/**"]
+precedence = "aggregate"
+SPDX-FileCopyrightText = "WTF Kooperative eG <https://wtf-eg.de/>"
+SPDX-License-Identifier = "AGPL-3.0-or-later"
+
+[[annotations]]
+path = ["renovate.json", ".python-version"]
+precedence = "aggregate"
+SPDX-FileCopyrightText = "WTF Kooperative eG <https://wtf-eg.de/>"
+SPDX-License-Identifier = "AGPL-3.0-or-later"

app.py

@@ -8,22 +8,23 @@ import os
 from dotenv import load_dotenv, find_dotenv
 from flask import Flask
 from flask_cors import CORS
-from flask.logging import default_handler
 from flask_migrate import Migrate
 from flask_sqlalchemy import SQLAlchemy
-from ldap3.utils.log import logger as ldap3_logger
 from ldap3.utils.log import set_library_log_detail_level, BASIC
 
 load_dotenv(find_dotenv())
 
 app = Flask(__name__)
+
+# Configure logging
 loglevel = os.getenv("KI_LOGLEVEL", logging.WARNING)
 loglevel = int(loglevel)
 app.logger.setLevel(loglevel)
-logging.basicConfig(level=loglevel)
-
-set_library_log_detail_level(BASIC)
-ldap3_logger.addHandler(default_handler)
+app.logger.propagate = False  # do not forward messages to the root logger
+logging.basicConfig(level=loglevel,
+                    format='[%(asctime)s] %(levelname)s [%(name)s] %(message)s')  # configure root logger as fallback
+logging.getLogger('werkzeug').propagate = False  # werkzeug has its own ColorStreamHandler
+set_library_log_detail_level(BASIC)  # ldap3 has different verbosity levels internally
 
 app.config["SQLALCHEMY_DATABASE_URI"] = os.getenv("SQLALCHEMY_DATABASE_URI")
 app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
@@ -40,6 +41,6 @@ CORS(app)
 db = SQLAlchemy(app)
 migrate = Migrate(app, db, compare_type=True)
 
-logging.debug("Hello from KI")
+app.logger.info("Hello from KI")
 
 from ki import module  # noqa

data/imgs/flags/Pipfile

@@ -1,11 +0,0 @@
-[[source]]
-url = "https://pypi.org/simple"
-verify_ssl = true
-name = "pypi"
-
-[packages]
-
-[dev-packages]
-
-[requires]
-python_version = "3.8"

data/imgs/flags/bg.svg

@@ -0,0 +1,7 @@
+<svg xmlns="http://www.w3.org/2000/svg" id="flag-icons-bg" viewBox="0 0 640 480">
+  <g fill-rule="evenodd" stroke-width="1pt">
+    <path fill="#d62612" d="M0 320h640v160H0z"/>
+    <path fill="#fff" d="M0 0h640v160H0z"/>
+    <path fill="#00966e" d="M0 160h640v160H0z"/>
+  </g>
+</svg>

data/imgs/flags/ca.svg

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="810" height="540">
+<rect width="810" height="540" fill="#FCDD09"/>
+<path stroke="#DA121A" stroke-width="60" d="M0,90H810m0,120H0m0,120H810m0,120H0"/>
+</svg>

data/imgs/flags/cs.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" id="flag-icons-cz" viewBox="0 0 640 480">
+  <path fill="#fff" d="M0 0h640v240H0z"/>
+  <path fill="#d7141a" d="M0 240h640v240H0z"/>
+  <path fill="#11457e" d="M360 240 0 0v480z"/>
+</svg>

data/imgs/flags/da.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" id="flag-icons-dk" viewBox="0 0 640 480">
+  <path fill="#c8102e" d="M0 0h640.1v480H0z"/>
+  <path fill="#fff" d="M205.7 0h68.6v480h-68.6z"/>
+  <path fill="#fff" d="M0 205.7h640.1v68.6H0z"/>
+</svg>

data/imgs/flags/de.svg

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" id="flag-icons-de" viewBox="0 0 640 480">
+  <path fill="#ffce00" d="M0 320h640v160H0z"/>
+  <path d="M0 0h640v160H0z"/>
+  <path fill="#d00" d="M0 160h640v160H0z"/>
+</svg>