2024 05 datamodel

.env.example

@@ -0,0 +1,12 @@
+# Copy this file to .env
+# ----------------------
+# Define POSTGRES PORT for Docker when calling datamodel/scripts/run-docker.sh
+TDH_PG_PORT=5432
+
+QGIS_TEST_VERSION
+
+POSTGIS_IMAGE=postgis/postgis:14-3.4
+
+# fix access rights for schemaspy
+UID=1000
+GID=1001

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: pip
+    directory: "/"
+    schedule:
+      interval: monthly
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/workflows/README.md

@@ -1 +1 @@
-Here come all GitHub CI actions workflows 
+Here come all GitHub CI actions workflows

.github/workflows/datamodel-create-dumps.yml

@@ -0,0 +1,57 @@
+name: 📦 Datamodel | Create dumps
+
+concurrency:
+  group: dumps-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    paths:
+      - datamodel/**
+      - '.github/workflows/datamodel-create-dumps.yml'
+  workflow_dispatch:
+  workflow_call:
+
+
+jobs:
+  datamodel-dumps:
+    name: Create dumps and schemaspy of datamodel
+    runs-on: ubuntu-latest
+    env:
+      COMPOSE_PROFILES: schemaspy
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Docker build
+        run: docker compose up -d --build
+
+      - name: Initialize container
+        run: docker compose exec db init_db.sh wait
+
+      - name: Create dumps
+        run: docker compose exec db /src/datamodel/scripts/create-dumps.py
+
+      - name: Schemaspy
+        run:  docker compose run schemaspy
+
+      - name: Docker logs
+        if: failure()
+        run: docker compose logs db
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: datamodel-dumps
+          path: datamodel/artifacts/
+          if-no-files-found: error
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: datamodel-schemaspy
+          path: datamodel/schemaspy/
+          if-no-files-found: error

.github/workflows/datamodel-test.yml

@@ -39,19 +39,19 @@ jobs:
           --build-arg RUN_TEST=True \
           --build-arg PSYCOPG_VERSION=${{ matrix.psycopg-version }} \
           -f datamodel/.docker/Dockerfile \
-          --tag teksi/distance_heating:unstable .
+          --tag teksi/district_heating:unstable .
 
       - name: Initialize container
         run: |
-          docker run -d -p 5432:5432 --name teksi-distance_heating teksi/distance_heating:unstable
-          docker exec teksi-distance_heating init_db.sh wait
+          docker run -d -p 5432:5432 --name teksi-district_heating teksi/district_heating:unstable
+          docker exec teksi-district_heating init_db.sh wait
 
       - name: Run tests
-        run:  docker exec teksi-distance_heating pytest datamodel
+        run:  docker exec teksi-district_heating pytest datamodel
 
       - name: Docker logs
         if: failure()
-        run: docker logs teksi-distance_heating
+        run: docker logs teksi-district_heating
 
   static-tests:
     name: Run static tests on datamodel

.github/workflows/docs-builder.yml

@@ -0,0 +1,81 @@
+name: 📚 Documentation builder
+
+concurrency:
+  group: docs-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - docs/**
+      - '.github/workflows/docs-builder.yml'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - docs/**
+      - '.github/workflows/docs-builder.yml'
+  workflow_dispatch:
+
+
+jobs:
+  datamodel-documentation:
+    uses: ./.github/workflows/datamodel-create-dumps.yml
+
+  build:
+    needs: datamodel-documentation
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: install requirements
+        working-directory: docs
+        run: |
+          pip install -r requirements.txt
+          sudo apt-get install -y gettext
+          curl -OL https://github.com/transifex/cli/releases/download/v1.6.10/tx-linux-amd64.tar.gz
+          tar -xvzf tx-linux-amd64.tar.gz
+          make gettext
+
+      - name: tx pull
+        if: ${{ github.event.pull_request.head.repo.full_name == 'teksi/district_heating' }}
+        env:
+          TX_TOKEN: ${{ secrets.TX_TOKEN }}
+        working-directory: docs
+        run: make transifex_pull
+
+      - name: tx push
+        env:
+          TX_TOKEN: ${{ secrets.TX_TOKEN }}
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        working-directory: docs
+        run: make transifex_sync
+
+      - name: copy datamodel documentation
+        uses: actions/download-artifact@v4
+        with:
+          name: datamodel-schemaspy
+          path: docs/_static/datamodel
+
+      - name: build documentation
+        working-directory: docs
+        run: |
+          make html
+          touch build/html/.nojekyll
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: documentation
+          path: docs/build/html
+          if-no-files-found: error
+
+      - name: Deploy 🚀
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: docs/build/html

.github/workflows/plugin-package.yml

@@ -0,0 +1,64 @@
+name: 🔌 Plugin | Package and release
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+    paths:
+      - plugin/**
+      - '.github/workflows/datamodel-create-dumps.yml'
+  workflow_dispatch:
+
+
+jobs:
+  plugin-package:
+    name: Packages and releases plugin
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install Qt lrelease
+        run: |
+          sudo apt-get update
+          sudo apt-get install qtbase5-dev qttools5-dev-tools
+
+      - name: Install qgis-plugin-ci
+        run: pip install qgis-plugin-ci>=2.8.6
+
+      - name: 🌍 Push translations
+        if: ${{ github.event_name == 'push' }}
+        run: qgis-plugin-ci push-translation ${{ secrets.TX_TOKEN }}
+
+      - name: Package PyPI Packages
+        run: ./plugin/scripts/package-pip-packages.sh
+
+      - name: Download Interlis libs
+        run: ./plugin/scripts/download-interlis-libs.sh
+
+      - name: Package
+        run: |
+          VERSION=0.0.0
+          qgis-plugin-ci -v package ${VERSION} \
+            --allow-uncommitted-changes \
+            --asset-path plugin/teksi_district_heating/libs \
+            --asset-path plugin/teksi_district_heating/interlis/bin \
+            --transifex-token "${{ secrets.TX_TOKEN }}"
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: teksi_district_heating_plugin_dev
+          path: plugin/teksi_district_heating.0.0.0.zip
+          if-no-files-found: error

.github/workflows/plugin-test.yml

@@ -0,0 +1,69 @@
+name: 🪲 Plugin | Tests
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - datamodel/**
+      - plugin/**
+      - '.github/workflows/plugin-test.yml'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - datamodel/**
+      - plugin/**
+      - '.github/workflows/plugin-test.yml'
+  workflow_dispatch:
+
+
+jobs:
+  plugin-tests:
+    name: Run unit tests on plugin
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        qgis_version: [3.34-jammy, latest]
+    env:
+      QGIS_TEST_VERSION: ${{ matrix.qgis_version }}
+      COMPOSE_PROFILES: qgis
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup env
+        run: cp .env.example .env
+
+      - name: Package PyPI Packages
+        run: sudo ./plugin/scripts/package-pip-packages.sh
+
+      - name: Download Interlis libs
+        run: sudo ./plugin/scripts/download-interlis-libs.sh
+
+      - name: Docker build
+        run: docker compose --profile qgis up -d --build
+
+      - name: Test on QGIS
+        run: docker-compose run qgis /usr/src/plugin/.docker/run-docker-tests.sh
+
+      - name: Test command line import orgs
+        run: docker-compose run qgis sh -c 'xvfb-run /usr/src/plugin/tdh_cmd.py interlis_import --xtf_file /usr/src/plugin/teksi_district_heating/tests/data/minimal-dataset-organisation-arbon-only.xtf --pghost db --pgdatabase tdh --pguser postgres --pgpass postgres --pgport 5432'
+
+      - name: Test command line import minimal sia405 Distance heating
+        run: docker-compose run qgis sh -c 'xvfb-run /usr/src/plugin/tdh_cmd.py interlis_import --xtf_file /usr/src/plugin/teksi_district_heating/tests/data/minimal-dataset-SIA405-FERNWAERME.xtf --pghost db --pgdatabase tdh --pguser postgres --pgpass postgres --pgport 5432'
+
+      - name: Test command line minimal export
+        run: docker-compose run qgis sh -c 'xvfb-run /usr/src/plugin/tdh_cmd.py interlis_export --xtf_file "output.xtf" --pghost db --pgdatabase tdh --pguser postgres --pgpass postgres --pgport 5432'
+
+      - name: docker logs
+        #if: failure()
+        run: docker compose logs db

.github/workflows/project-translation.yml

@@ -0,0 +1,58 @@
+name: 🌎 Update project translations
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - project/**
+      - '.github/workflows/project-translation.yml'
+  workflow_dispatch:
+
+
+jobs:
+  build:
+    name: Update project translations
+    runs-on: ubuntu-latest
+
+    env:
+      TX_TOKEN: ${{ secrets.TX_TOKEN }}
+      COMPOSE_PROFILES: qgis
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install Transifex
+        working-directory: project
+        run: |
+          curl -OL https://github.com/transifex/cli/releases/download/v1.6.10/tx-linux-amd64.tar.gz
+          tar -xvzf tx-linux-amd64.tar.gz
+
+      - name: Start Docker compose
+        run: |
+          docker compose up --build -d
+          docker compose exec db init_db.sh wait
+
+      - name: Translate (create sources)
+        run: docker compose run qgis sh -c 'xvfb-run /usr/src/project/scripts/project-translation-create-source.py /usr/src/project/teksi_district_heating.qgs'
+
+      - name: Push to TX
+        working-directory: project
+        run: ./tx push --source
+
+      - name: Compile Translations (fetch translated content)
+        working-directory: project
+        run: |
+          ./tx pull -a
+          docker compose run qgis sh -c '/usr/src/project/scripts/project-translation-compile.sh /usr/src/project/teksi_district_heating.qgs'
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: project-translations
+          path: project/teksi_district_heating*
+          if-no-files-found: error