Push image to Gitea registry

Reviewed-on: #75

.drone.yml

@@ -4,28 +4,107 @@
 # 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
-  commands:
-  - pipenv install --dev
-  - pipenv run flake8
-  - pipenv run reuse lint
-  - pipenv run python -m unittest discover ki
-
-- name: docker-publish
-  image: plugins/docker
-  settings:
-    registry: registry.wtf-eg.net
-    repo: registry.wtf-eg.net/ki-backend
-    target: ki-backend
-    auto_tag: true
-    username:
-      from_secret: "docker_username"
-    password:
-      from_secret: "docker_password"
+  - name: install-lint-test
+    image: git.wtf-eg.de/kompetenzinventar/builder:1.0.2
+    commands:
+      - pipenv install --dev
+      - pipenv run flake8
+      - pipenv run reuse lint
+      - pipenv run python -m unittest discover ki
 
 image_pull_secrets:
-- dockerconfig
+  - dockerconfig
+
+---
+kind: pipeline
+type: docker
+name: build
+
+trigger:
+  event:
+    - push
+  branch:
+    - main
+
+depends_on:
+  - qa
+
+steps:
+  - name: docker-publish
+    image: plugins/docker
+    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"
+
+---
+kind: pipeline
+type: docker
+name: deploy
+
+trigger:
+  event:
+    - push
+  branch:
+    - main
+
+depends_on:
+  - build
+
+steps:
+  - name: deploy-dev
+    image: appleboy/drone-ssh
+    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: git.wtf-eg.de/kompetenzinventar/builder:1.0.2
+    commands:
+      - pipenv install --dev
+      - pipenv run flake8
+      - pipenv run reuse lint
+      - pipenv run python -m unittest discover ki
+  - name: docker-publish
+    image: plugins/docker
+    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"

.pre-commit-config.yaml

@@ -2,6 +2,7 @@
 #
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
+repos:
 - repo: local
   hooks:
     - id: flake8

.reuse/dep5

@@ -4,7 +4,7 @@ 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/
+Copyright: 2013 Panayiotis Lipiridis <https://flagicons.lipis.dev/>
 License: MIT
 
 Files: Pipfile.lock migrations/*

Dockerfile

@@ -2,7 +2,7 @@
 #
 # SPDX-License-Identifier: AGPL-3.0-or-later
 
-FROM registry.wtf-eg.net/ki-backend-builder:1.0.0 as builder
+FROM git.wtf-eg.de/kompetenzinventar/builder:1.0.2 as builder
 
 COPY Pipfile* ./
 
@@ -10,7 +10,7 @@ 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 git.wtf-eg.de/kompetenzinventar/base:1.0.2 as ki-backend
 
 # Install six explicitly. Otherwise Python complains about it missing.
 RUN pip3 install six
@@ -22,4 +22,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

@@ -14,7 +14,7 @@ flask-migrate = "~=3.0.1"
 flask-sqlalchemy  = "~=2.5.1"
 sqlalchemy = "~=1.4.18"
 waitress = "~=2.0.0"
-pyyaml = "~=5.4.1"
+pyyaml = "~=6.0.1"
 flask-cors = "~=3.0.10"
 ldap3 = "~=2.9"
 pymysql = "~=1.0.2"

README.md

@@ -9,6 +9,32 @@ SPDX-License-Identifier: AGPL-3.0-or-later
 [![Build Status](https://drone.wtf-eg.de/api/badges/kompetenzinventar/ki-backend/status.svg?ref=refs/heads/main)](https://drone.wtf-eg.de/kompetenzinventar/ki-backend)
 [![REUSE status](https://api.reuse.software/badge/git.wtf-eg.de/kompetenzinventar/ki-backend)](https://api.reuse.software/info/git.wtf-eg.de/kompetenzinventar/ki-backend)
 
+## Über
+
+Dieses Repo enthält das Backend des Projekts Kompentenzinventar - einer Webapplikation zur Erfassung von Userprofilen für die WTF eG.
+
+Implementiert ist das Backend mit Flask.
+
+### Mitmachen
+
+Du kannst gerne bei der Entwicklung des Kompetenzinventars mitmachen.
+
+- Fehler oder fehlende Funktionen erfassen. Bitte direkt über die [Issues](https://git.wtf-eg.de/kompetenzinventar/ki-backend/issues) in Gitea.
+- Dokumentation oder Implementierung verbessern. Bitte forke hierzu das Projekt, branche von `main` ab und erstelle dann einen [Pull Request](https://git.wtf-eg.de/kompetenzinventar/ki-backend/pulls).
+
+### Kommunikation
+
+Folgende Kanäle gibt es für die Kommunikation über das Kompetenzinventar:
+
+- Die [Issues](https://git.wtf-eg.de/kompetenzinventar/ki-backend/issues) im WTF Gitea.
+- Den Bereich [AG Entwicklung](https://forum.wtf-eg.de/c/interna/ag-entwicklung/21) im WTF Forum.
+- Einen Raum in Matrix. Zutritt per Einladung, frlan lädt ein, eine einfache PN im Forum reicht.
+
+### Repos
+
+* **[ki-backend](https://git.wtf-eg.de/kompetenzinventar/ki-backend)** (dieses Repo) enthält das Backend
+* [ki-frontend](https://git.wtf-eg.de/kompetenzinventar/ki-frontend) enthält das Frontend
+* Weitere Repositories befinden sich in der Gitea Organisation [Kompetenzinventar](https://git.wtf-eg.de/kompetenzinventar).
 ## Entwicklung
 
 ### Abhängigkeiten
@@ -22,7 +48,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
 Ggf. vorher aufräumen
 
 ```
-rm data/ki.sqlite
+rm storage/ki.sqlite
 ```
 
 ```
@@ -196,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.

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
@@ -38,8 +39,8 @@ app.config["KI_LDAP_BASE_DN"] = os.getenv("KI_LDAP_BASE_DN")
 
 CORS(app)
 db = SQLAlchemy(app)
-migrate = Migrate(app, db)
+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/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>

data/imgs/flags/el.svg

@@ -0,0 +1,16 @@
+<svg xmlns="http://www.w3.org/2000/svg" id="flag-icons-gr" viewBox="0 0 640 480">
+  <path fill="#005bae" fill-rule="evenodd" stroke-width="6.7" d="M0 0h640v53.3H0z"/>
+  <path fill="#fff" fill-rule="evenodd" stroke-width="6.7" d="M0 53.3h640v53.4H0z"/>
+  <path fill="#005bae" fill-rule="evenodd" stroke-width="6.7" d="M0 106.7h640V160H0z"/>
+  <path fill="#fff" fill-rule="evenodd" stroke-width="6.7" d="M0 160h640v53.3H0z"/>
+  <path fill="#005bae" stroke-width=".9" d="M0 0h266.7v266.7H0z"/>
+  <path fill="#005bae" fill-rule="evenodd" stroke-width="6.7" d="M0 213.3h640v53.4H0z"/>
+  <path fill="#fff" fill-rule="evenodd" stroke-width="6.7" d="M0 266.7h640V320H0z"/>
+  <path fill="#005bae" fill-rule="evenodd" stroke-width="6.7" d="M0 320h640v53.3H0z"/>
+  <path fill="#fff" fill-rule="evenodd" stroke-width="6.7" d="M0 373.3h640v53.4H0z"/>
+  <g fill="#fff" fill-rule="evenodd" stroke-width="1.3">
+    <path d="M20 0h10v50H20z" transform="scale(5.33333)"/>
+    <path d="M0 20h50v10H0z" transform="scale(5.33333)"/>
+  </g>
+  <path fill="#005bae" stroke-width=".6" d="M0 426.7h640V480H0z"/>
+</svg>