Compare commits
199 Commits
consolidat
...
5a1df7345d
| Author | SHA1 | Date | |
|---|---|---|---|
| 5a1df7345d | |||
| e3c5f6a9d7 | |||
| a26290fc92 | |||
| 08d94a9269 | |||
| 6f8f273344 | |||
| f96226170b | |||
| 0783033c70 | |||
| 35fbfdccec | |||
| 1196d3cdd2 | |||
| df67948efc | |||
| a78f53f58e | |||
| 2c39db104e | |||
| ad17b394a3 | |||
| 745ce4fabc | |||
| b6fbe750a2 | |||
| 89d3eec5fb | |||
| cd4783efc4 | |||
| 9efef2c5e2 | |||
| 09010a117e | |||
| 8ea0937ea4 | |||
| 5330493c85 | |||
| 9e6e9e9830 | |||
| f311050412 | |||
| 492b3c5a20 | |||
| a81b6eb9d5 | |||
| f6be6d6a02 | |||
| c8d3ef4631 | |||
| 46912cff8c | |||
| 1af50c45ff | |||
| 40551094e6 | |||
| 4297c2d8bf | |||
| 3a89f6d871 | |||
| 07ba717de9 | |||
| 048105ef27 | |||
| b579f5fb42 | |||
| db9bd92036 | |||
| 7e89ffb6f1 | |||
| dd6d0fae46 | |||
| e5202d9b2b | |||
| 5535684a45 | |||
| f933b7d99a | |||
| fd729b3019 | |||
| e1c1eafb39 | |||
| 1b016c49f2 | |||
| 4376069b11 | |||
| c285ae81af | |||
| 5bfe4866a4 | |||
| f7799675d5 | |||
| c125427b8d | |||
| a14a80f7bd | |||
| 477143b3ff | |||
| fc404f6755 | |||
| fe7c55eceb | |||
| bb01174bd2 | |||
| 38ce55d8fd | |||
| d439741339 | |||
| bc75cac6cd | |||
| 47c264e8e1 | |||
| 4d0ed116dd | |||
| ceb6e13447 | |||
| 7e9059a9aa | |||
| ccf31e4ef4 | |||
| 94e047c7ff | |||
| 57f2210c77 | |||
| 1745596d14 | |||
| e923624aec | |||
| 3649878b7d | |||
| 179e7d41b3 | |||
| 5f95042cad | |||
| 9a3ab1234a | |||
| 7591de99e0 | |||
| b2e2da95b2 | |||
| 8ec294c8a8 | |||
| 4fece110d9 | |||
| dbc4f89055 | |||
| c5f4715e97 | |||
| cca9022f53 | |||
| 1a1115db6d | |||
| 34275addaf | |||
| 0df0cef681 | |||
| 3c5a69f30a | |||
| aa5a95844a | |||
| eedc63741f | |||
| 105f00f126 | |||
| d0d163282d | |||
| e88f862a0f | |||
| 79cb730115 | |||
| a34ec67576 | |||
| d1c7218fcf | |||
| 683d53dac0 | |||
| d2d260381e | |||
| dfdd68e9de | |||
| 04fa504bb2 | |||
| 2204eb762a | |||
| 892c229647 | |||
| 441b9c99d2 | |||
| a84e5b34b6 | |||
| 55a5b10d6a | |||
| d11d666f45 | |||
| d7b6d05cb5 | |||
| 254317ee08 | |||
| d9345a0251 | |||
| 362f474e3d | |||
| b8069802f6 | |||
| 26d62014c9 | |||
| 69ca9bce4d | |||
| 733a437ae0 | |||
| 277a24bb50 | |||
| 4b15c5f173 | |||
| b8d5bc796d | |||
| 9bd4cb19d3 | |||
| 28f87509d6 | |||
| 9d4c7d5f87 | |||
| f7e6795c00 | |||
| 8520412867 | |||
| e94f61a697 | |||
| 0cd09d0878 | |||
| 994ba5d797 | |||
| af636fe6ea | |||
| 3ccb32e8e1 | |||
| af4e1c61aa | |||
| 8153aa56ce | |||
| b82c6fea38 | |||
| cb374bfa77 | |||
| 2b41490806 | |||
| 7186fa2cbe | |||
| da1deac44e | |||
| faae37e6ae | |||
| 6aefb046b6 | |||
| 2350cca32c | |||
| 671d259c44 | |||
| 28a1bb4b62 | |||
| 898e9b8163 | |||
| 48bf8526b9 | |||
| 7e4d2fa29b | |||
| 779604750e | |||
| aca9a2f307 | |||
| d14d9eba4c | |||
| 081ea4de1c | |||
| a075811173 | |||
| d4143da9fc | |||
| b0c9b89e94 | |||
|
|
94363d49ce | ||
|
|
8bca1bb3c7 | ||
|
|
1ce8eb15c0 | ||
|
|
4d2ffeea27 | ||
|
|
8860947d38 | ||
|
|
6df72c95cb | ||
| 2afada0bce | |||
|
|
a42a65b40f | ||
| 5609a735f4 | |||
| 6654779e67 | |||
| 7befde104d | |||
| 96819a7427 | |||
| a437af554b | |||
| 650fe0a87b | |||
|
|
ddf035c50f | ||
|
|
886baa163e | ||
|
|
1146506ca2 | ||
|
|
9610024739 | ||
|
|
c8755e4339 | ||
|
|
0bc1fe7413 | ||
|
|
8ce761c248 | ||
|
|
39a2021cc3 | ||
| 957a1b9255 | |||
| afc07d4561 | |||
| af06598172 | |||
| 4213ca60ac | |||
| bf2f15fa5c | |||
| c1eb2d7871 | |||
| b29e894b22 | |||
| 0f096d18aa | |||
| 9b484787a4 | |||
| 8dd3b4e9af | |||
| 0d0199ca62 | |||
| 5f58d660c0 | |||
| e84f25ca1d | |||
| dfb8eeef97 | |||
| 0225fb3396 | |||
| 7377ddaea3 | |||
| 67c393ecf1 | |||
| dbb3ecd5bf | |||
| 966cd46228 | |||
| 1ee9b3c46f | |||
| 8f57f5fc5b | |||
| cd7195b3aa | |||
| 020dff0871 | |||
| 1dbdbc7f3c | |||
| 4d1232b764 | |||
|
fe2e02934a
|
|||
|
add1a88ce4
|
|||
| 3c23918e1f | |||
| fa0a2a9df9 | |||
|
|
9feaf6686f | ||
| 7087be672a | |||
|
|
969141601d | ||
|
|
b391ab0ef6 | ||
| 4de2ad38c5 | |||
| d46d937e93 |
287
.gitea/workflows/build-containers-on-demand.yml
Normal file
287
.gitea/workflows/build-containers-on-demand.yml
Normal file
@@ -0,0 +1,287 @@
|
||||
name: Build containers when image tags change
|
||||
|
||||
on:
|
||||
push:
|
||||
# Uncomment/adjust once working:
|
||||
# branches: [ main ]
|
||||
paths:
|
||||
- "argocd/deployment.yaml"
|
||||
- "Dockerfile"
|
||||
- "data-loader/**"
|
||||
- ".gitea/workflows/build-containers-on-demand.yml"
|
||||
|
||||
jobs:
|
||||
build-if-image-changed:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
include:
|
||||
- container_name: web
|
||||
expected_repo: git.baumann.gr/adebaumann/vui
|
||||
build_context: .
|
||||
container_type: containers
|
||||
description: main container
|
||||
- container_name: loader
|
||||
expected_repo: git.baumann.gr/adebaumann/vui-data-loader
|
||||
build_context: data-loader
|
||||
container_type: initContainers
|
||||
description: init-container
|
||||
|
||||
env:
|
||||
DEPLOY_FILE: "argocd/deployment.yaml"
|
||||
CONTAINER_NAME: ${{ matrix.container_name }}
|
||||
EXPECTED_REPO: ${{ matrix.expected_repo }}
|
||||
CONTAINER_TYPE: ${{ matrix.container_type }}
|
||||
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 2
|
||||
|
||||
- name: Determine base commit
|
||||
id: base
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
if git rev-parse --verify -q HEAD~1 >/dev/null; then
|
||||
echo "base=$(git rev-parse HEAD~1)" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "base=$(git hash-object -t tree /dev/null)" >> "$GITHUB_OUTPUT"
|
||||
fi
|
||||
|
||||
- name: Install yq
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
YQ_VER=v4.44.3
|
||||
curl -sL "https://github.com/mikefarah/yq/releases/download/${YQ_VER}/yq_linux_amd64" -o /usr/local/bin/yq
|
||||
chmod +x /usr/local/bin/yq
|
||||
yq --version
|
||||
|
||||
- name: Read ${{ matrix.description }} image from deployment (old vs new)
|
||||
id: img
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
file="${DEPLOY_FILE:-argocd/deployment.yaml}"
|
||||
cname="${CONTAINER_NAME}"
|
||||
expected_repo="${EXPECTED_REPO}"
|
||||
ctype="${CONTAINER_TYPE}"
|
||||
|
||||
export cname
|
||||
export expected_repo
|
||||
export ctype
|
||||
|
||||
echo "========================================"
|
||||
echo "Checking: $ctype / $cname"
|
||||
echo "Expected repo: $expected_repo"
|
||||
echo "========================================"
|
||||
|
||||
# --- functions ------------------------------------------------------
|
||||
have_yq() { command -v yq >/dev/null 2>&1; }
|
||||
|
||||
# yq-based extractor (multi-doc aware; Deployment only; container name match)
|
||||
yq_extract() {
|
||||
if [[ "$ctype" == "initContainers" ]]; then
|
||||
yq -r '
|
||||
select(.kind == "Deployment") |
|
||||
.spec.template.spec.initContainers // [] |
|
||||
map(select(.name == env(cname))) |
|
||||
.[]?.image
|
||||
' "$1" 2>/dev/null | tail -n 1
|
||||
else
|
||||
yq -r '
|
||||
select(.kind == "Deployment") |
|
||||
.spec.template.spec.containers // [] |
|
||||
map(select(.name == env(cname))) |
|
||||
.[]?.image
|
||||
' "$1" 2>/dev/null | tail -n 1
|
||||
fi
|
||||
}
|
||||
|
||||
# ultra-tolerant fallback: grep around the appropriate block
|
||||
fallback_extract() {
|
||||
local block_pattern
|
||||
local end_pattern
|
||||
|
||||
if [[ "$ctype" == "initContainers" ]]; then
|
||||
block_pattern="^[[:space:]]*initContainers:"
|
||||
end_pattern="^[[:space:]]*containers:|^[[:alpha:]][[:alnum:]_:-]*:"
|
||||
else
|
||||
block_pattern="^[[:space:]]*containers:"
|
||||
end_pattern="^[[:alpha:]][[:alnum:]_:-]*:|^[[:space:]]*initContainers:"
|
||||
fi
|
||||
|
||||
awk -v cname="$cname" -v block="$block_pattern" -v endp="$end_pattern" '
|
||||
BEGIN{ in_cont=0; name=""; image="" }
|
||||
$0 ~ block {in_cont=1; next}
|
||||
in_cont {
|
||||
# end of block when we hit the end pattern
|
||||
if ($0 ~ endp) { in_cont=0 }
|
||||
# capture name and image lines
|
||||
if ($0 ~ /^[[:space:]]*-?[[:space:]]*name:[[:space:]]*/) {
|
||||
name=$0; sub(/^.*name:[[:space:]]*/,"",name); gsub(/^[ "\047]+|[ "\047]+$/,"",name)
|
||||
}
|
||||
if ($0 ~ /^[[:space:]]*image:[[:space:]]*/) {
|
||||
image=$0; sub(/^.*image:[[:space:]]*/,"",image); gsub(/^[ "\047]+|[ "\047]+$/,"",image)
|
||||
if (name==cname) { print image; exit }
|
||||
}
|
||||
}
|
||||
' "$1"
|
||||
}
|
||||
|
||||
list_workload_images() {
|
||||
echo "== workload $ctype in $1 ==" >&2
|
||||
if have_yq; then
|
||||
if [[ "$ctype" == "initContainers" ]]; then
|
||||
yq -r '
|
||||
select(.kind == "Deployment") |
|
||||
.spec.template.spec.initContainers // [] |
|
||||
.[] | "\(.name): \(.image)"
|
||||
' "$1" 2>/dev/null | nl -ba >&2 || true
|
||||
else
|
||||
yq -r '
|
||||
select(.kind == "Deployment") |
|
||||
.spec.template.spec.containers // [] |
|
||||
.[] | "\(.name): \(.image)"
|
||||
' "$1" 2>/dev/null | nl -ba >&2 || true
|
||||
fi
|
||||
else
|
||||
# coarse list for visibility
|
||||
if [[ "$ctype" == "initContainers" ]]; then
|
||||
awk '
|
||||
/^ *initContainers:/, /^ *containers:/ { if ($0 ~ /name:|image:/) print }
|
||||
' "$1" | nl -ba >&2 || true
|
||||
else
|
||||
awk '
|
||||
/^ *containers:/, /^[^ ]/ { if ($0 ~ /name:|image:/) print }
|
||||
' "$1" | nl -ba >&2 || true
|
||||
fi
|
||||
fi
|
||||
}
|
||||
# --------------------------------------------------------------------
|
||||
|
||||
# Ensure yq is present; if install failed earlier, try once more
|
||||
if ! have_yq; then
|
||||
echo "yq missing; attempting quick install..." >&2
|
||||
curl -fsSL https://github.com/mikefarah/yq/releases/latest/download/yq_linux_amd64 -o /usr/local/bin/yq || true
|
||||
chmod +x /usr/local/bin/yq || true
|
||||
fi
|
||||
|
||||
# Prepare old file (previous commit) if exists
|
||||
if git cat-file -e "${{ steps.base.outputs.base }}":"$file" 2>/dev/null; then
|
||||
git show "${{ steps.base.outputs.base }}:$file" > /tmp/old.yaml
|
||||
else
|
||||
: > /tmp/old.yaml
|
||||
fi
|
||||
|
||||
list_workload_images /tmp/old.yaml || true
|
||||
list_workload_images "$file" || true
|
||||
|
||||
if have_yq; then
|
||||
old_image="$(yq_extract /tmp/old.yaml || true)"
|
||||
new_image="$(yq_extract "$file" || true)"
|
||||
else
|
||||
old_image="$(fallback_extract /tmp/old.yaml || true)"
|
||||
new_image="$(fallback_extract "$file" || true)"
|
||||
fi
|
||||
|
||||
# If yq path failed to find it, try fallback once more as safety
|
||||
if [ -z "${new_image:-}" ]; then
|
||||
new_image="$(fallback_extract "$file" || true)"
|
||||
fi
|
||||
if [ -z "${old_image:-}" ]; then
|
||||
old_image="$(fallback_extract /tmp/old.yaml || true)"
|
||||
fi
|
||||
|
||||
echo "Old $ctype image: ${old_image:-<none>}"
|
||||
echo "New $ctype image: ${new_image:-<none>}"
|
||||
|
||||
if [ -z "${new_image:-}" ]; then
|
||||
echo "ERROR: Could not find $ctype[].name == \"$cname\" image in $file"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Split repo and tag
|
||||
new_repo="${new_image%:*}"
|
||||
new_tag="${new_image##*:}"
|
||||
if [[ "$new_repo" != "$expected_repo" ]]; then
|
||||
echo "ERROR: Found $ctype \"$cname\" image repo is \"$new_repo\" but expected \"$expected_repo\""
|
||||
exit 1
|
||||
fi
|
||||
|
||||
registry="$(echo "$new_repo" | awk -F/ '{print $1}')"
|
||||
|
||||
{
|
||||
echo "new_image=$new_image"
|
||||
echo "new_repo=$new_repo"
|
||||
echo "new_tag=$new_tag"
|
||||
echo "registry=$registry"
|
||||
} >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Check if image exists on registry
|
||||
id: check_image
|
||||
shell: bash
|
||||
run: |
|
||||
set -euo pipefail
|
||||
new_repo="${{ steps.img.outputs.new_repo }}"
|
||||
new_tag="${{ steps.img.outputs.new_tag }}"
|
||||
registry_user="${{ secrets.REGISTRY_USER }}"
|
||||
registry_password="${{ secrets.REGISTRY_PASSWORD }}"
|
||||
|
||||
# Extract registry host and image name
|
||||
registry_host=$(echo "$new_repo" | cut -d/ -f1)
|
||||
image_path=$(echo "$new_repo" | cut -d/ -f2-)
|
||||
|
||||
echo "Checking if $new_repo:$new_tag exists on registry $registry_host"
|
||||
|
||||
# Use Docker Registry API v2 to check manifest
|
||||
# Format: https://registry/v2/{image_path}/manifests/{tag}
|
||||
manifest_url="https://${registry_host}/v2/${image_path}/manifests/${new_tag}"
|
||||
|
||||
# Check with authentication
|
||||
http_code=$(curl -s -o /dev/null -w "%{http_code}" \
|
||||
-u "${registry_user}:${registry_password}" \
|
||||
-H "Accept: application/vnd.docker.distribution.manifest.v2+json,application/vnd.docker.distribution.manifest.list.v2+json" \
|
||||
"$manifest_url" || echo "000")
|
||||
|
||||
if [ "$http_code" = "200" ]; then
|
||||
echo "Image already exists on registry (HTTP $http_code)"
|
||||
echo "exists=true" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "Image does not exist on registry (HTTP $http_code)"
|
||||
echo "exists=false" >> "$GITHUB_OUTPUT"
|
||||
fi
|
||||
|
||||
- name: Skip if image already exists
|
||||
if: steps.check_image.outputs.exists == 'true'
|
||||
run: echo "${{ matrix.description }} image ${{ steps.img.outputs.new_image }} already exists on registry; skipping build."
|
||||
|
||||
- name: Set up Buildx
|
||||
if: steps.check_image.outputs.exists == 'false'
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Log in to registry
|
||||
if: steps.check_image.outputs.exists == 'false'
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ${{ steps.img.outputs.registry }}
|
||||
username: ${{ secrets.REGISTRY_USER }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
|
||||
- name: Build and push ${{ matrix.description }} (exact tag from deployment)
|
||||
if: steps.check_image.outputs.exists == 'false'
|
||||
uses: docker/build-push-action@v6
|
||||
with:
|
||||
context: ${{ matrix.build_context }}
|
||||
push: true
|
||||
tags: |
|
||||
${{ steps.img.outputs.new_image }}
|
||||
${{ steps.img.outputs.new_repo }}:latest
|
||||
labels: |
|
||||
org.opencontainers.image.source=${{ gitea.repository }}
|
||||
org.opencontainers.image.revision=${{ gitea.sha }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
67
.gitea/workflows/check_code_in_sonarqube.yaml
Normal file
67
.gitea/workflows/check_code_in_sonarqube.yaml
Normal file
@@ -0,0 +1,67 @@
|
||||
on:
|
||||
push:
|
||||
# branches:
|
||||
# - main
|
||||
# - development
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened]
|
||||
|
||||
name: SonarQube Scan
|
||||
jobs:
|
||||
sonarqube:
|
||||
name: SonarQube Trigger
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checking out
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.11'
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
pip install -r requirements.txt
|
||||
|
||||
- name: Run tests with coverage
|
||||
run: |
|
||||
coverage run --source='.' manage.py test
|
||||
coverage xml
|
||||
|
||||
- name: Set up JDK 17
|
||||
uses: actions/setup-java@v3
|
||||
with:
|
||||
java-version: '17'
|
||||
distribution: 'temurin'
|
||||
|
||||
- name: Cache SonarQube packages
|
||||
uses: actions/cache@v3
|
||||
with:
|
||||
path: ~/.sonar/cache
|
||||
key: ${{ runner.os }}-sonar
|
||||
restore-keys: ${{ runner.os }}-sonar
|
||||
|
||||
- name: Download and setup SonarScanner
|
||||
run: |
|
||||
mkdir -p $HOME/.sonar
|
||||
wget -q https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-5.0.1.3006-linux.zip
|
||||
unzip -q sonar-scanner-cli-5.0.1.3006-linux.zip -d $HOME/.sonar/
|
||||
echo "$HOME/.sonar/sonar-scanner-5.0.1.3006-linux/bin" >> $GITHUB_PATH
|
||||
|
||||
- name: Verify Java version
|
||||
run: java -version
|
||||
|
||||
- name: SonarQube Scan
|
||||
env:
|
||||
SONAR_HOST_URL: ${{ secrets.SONARQUBE_HOST }}
|
||||
SONAR_TOKEN: ${{ secrets.SONARQUBE_TOKEN }}
|
||||
run: |
|
||||
sonar-scanner \
|
||||
-Dsonar.projectKey=${{ github.event.repository.name }} \
|
||||
-Dsonar.sources=. \
|
||||
-Dsonar.host.url=${SONAR_HOST_URL} \
|
||||
-Dsonar.token=${SONAR_TOKEN} \
|
||||
-Dsonar.python.coverage.reportPaths=coverage.xml
|
||||
9
.gitignore
vendored
9
.gitignore
vendored
@@ -8,5 +8,12 @@ include/
|
||||
keys/
|
||||
.venv/
|
||||
.idea/
|
||||
|
||||
*.kate-swp
|
||||
node_modules/
|
||||
package-lock.json
|
||||
package.json
|
||||
AGENT*.md
|
||||
# Diagram cache directory
|
||||
media/diagram_cache/
|
||||
.env
|
||||
data/db.sqlite3
|
||||
|
||||
18
Dockerfile
18
Dockerfile
@@ -1,4 +1,4 @@
|
||||
FROM python:3.13-slim AS baustelle
|
||||
FROM python:3.14 AS baustelle
|
||||
RUN mkdir /app
|
||||
WORKDIR /app
|
||||
ENV PYTHONDONTWRITEBYTECODE=1
|
||||
@@ -7,28 +7,30 @@ RUN pip install --upgrade pip
|
||||
COPY requirements.txt /app/
|
||||
RUN pip install --no-cache-dir -r requirements.txt
|
||||
|
||||
FROM python:3.13-slim
|
||||
FROM python:3.14-slim
|
||||
RUN useradd -m -r appuser && \
|
||||
mkdir /app && \
|
||||
chown -R appuser /app
|
||||
|
||||
COPY --from=baustelle /usr/local/lib/python3.13/site-packages/ /usr/local/lib/python3.13/site-packages/
|
||||
COPY --from=baustelle /usr/local/lib/python3.14/site-packages/ /usr/local/lib/python3.14/site-packages/
|
||||
COPY --from=baustelle /usr/local/bin/ /usr/local/bin/
|
||||
RUN rm /usr/bin/tar
|
||||
RUN rm /usr/lib/x86_64-linux-gnu/libncur*
|
||||
RUN rm /usr/bin/tar /usr/lib/x86_64-linux-gnu/libncur*
|
||||
WORKDIR /app
|
||||
COPY --chown=appuser:appuser . .
|
||||
ENV PYTHONDONTWRITEBYTECODE=1
|
||||
ENV PYTHONUNBUFFERED=1
|
||||
USER appuser
|
||||
EXPOSE 8000
|
||||
RUN rm -rf /app/Dockerfile* \
|
||||
RUN rm -rvf /app/Dockerfile* \
|
||||
/app/README.md \
|
||||
/app/argocd \
|
||||
/app/k8s \
|
||||
/app/data-loader \
|
||||
/app/keys \
|
||||
/app/requirements.txt
|
||||
RUN python3 manage.py collectstatic
|
||||
/app/requirements.txt \
|
||||
/app/node_modules \
|
||||
/app/*.json \
|
||||
/app/test_*.py && \
|
||||
python3 /app/manage.py collectstatic --noinput
|
||||
CMD ["gunicorn","--bind","0.0.0.0:8000","--workers","3","VorgabenUI.wsgi:application"]
|
||||
|
||||
|
||||
241
Documentation/ArgoCD.md
Normal file
241
Documentation/ArgoCD.md
Normal file
@@ -0,0 +1,241 @@
|
||||
# ArgoCD Configuration Documentation
|
||||
|
||||
## Overview
|
||||
This directory contains the ArgoCD application manifests for deploying the VorgabenUI application and its dependencies to Kubernetes.
|
||||
|
||||
## Files
|
||||
|
||||
### Application Manifests
|
||||
|
||||
#### `001_pvc.yaml`
|
||||
- **Purpose**: PersistentVolumeClaim for Django application data
|
||||
- **Storage**: 2Gi storage with ReadWriteMany access mode
|
||||
- **Storage Class**: Uses NFS storage class for shared storage across multiple pods
|
||||
- **Namespace**: vorgabenui
|
||||
|
||||
#### `deployment.yaml`
|
||||
- **Purpose**: Main application deployment configuration
|
||||
- **Contains**: Django application container, environment variables, resource limits
|
||||
- **Replicas**: Configurable replica count for high availability
|
||||
|
||||
#### `ingress.yaml`
|
||||
- **Purpose**: External access configuration
|
||||
- **Host**: Configurable hostname for the application
|
||||
- **TLS**: SSL/TLS termination configuration
|
||||
- **Backend**: Routes traffic to the Django application service
|
||||
|
||||
#### `nfs-pv.yaml`
|
||||
- **Purpose**: PersistentVolume definition for NFS storage
|
||||
- **Server**: 192.168.17.199
|
||||
- **Path**: /mnt/user/vorgabenui
|
||||
- **Access**: ReadWriteMany for multi-pod access
|
||||
- **Reclaim Policy**: Retain (data preserved after PVC deletion)
|
||||
|
||||
#### `nfs-storageclass.yaml`
|
||||
- **Purpose**: StorageClass definition for NFS volumes
|
||||
- **Provisioner**: kubernetes.io/no-provisioner (static provisioning)
|
||||
- **Volume Expansion**: Enabled for growing storage capacity
|
||||
- **Binding Mode**: Immediate (binds PV to PVC as soon as possible)
|
||||
|
||||
#### `diagrammer.yaml`
|
||||
- **Purpose**: Deployment configuration for the diagram generation service
|
||||
- **Function**: Handles diagram creation and caching for the application
|
||||
|
||||
## NFS Storage Configuration
|
||||
|
||||
### Prerequisites
|
||||
1. NFS server must be running at 192.168.17.199
|
||||
2. The directory `/mnt/user/vorgabenui` must exist and be exported
|
||||
3. Kubernetes nodes must have NFS client utilities installed
|
||||
4. For MicroK8s: `microk8s enable nfs`
|
||||
|
||||
## MicroK8s Addons Required
|
||||
|
||||
### Required Addons
|
||||
Enable the following MicroK8s addons before deployment:
|
||||
|
||||
```bash
|
||||
# Enable storage and NFS support
|
||||
sudo microk8s enable storage
|
||||
sudo microk8s enable nfs
|
||||
|
||||
# Enable ingress for external access
|
||||
sudo microk8s enable ingress
|
||||
|
||||
# Enable DNS for service discovery
|
||||
sudo microk8s enable dns
|
||||
|
||||
# Optional: Enable metrics for monitoring
|
||||
sudo microk8s enable metrics-server
|
||||
```
|
||||
|
||||
### Addon Descriptions
|
||||
|
||||
#### `storage`
|
||||
- **Purpose**: Provides default storage class for persistent volumes
|
||||
- **Required for**: Basic PVC functionality
|
||||
- **Note**: Works alongside our custom NFS storage class
|
||||
|
||||
#### `nfs`
|
||||
- **Purpose**: Installs NFS client utilities on all MicroK8s nodes
|
||||
- **Required for**: Mounting NFS volumes in pods
|
||||
- **Components**: Installs `nfs-common` package with mount helpers
|
||||
|
||||
#### `ingress`
|
||||
- **Purpose**: Provides Ingress controller for external HTTP/HTTPS access
|
||||
- **Required for**: `ingress.yaml` to function properly
|
||||
- **Implementation**: Uses NGINX Ingress Controller
|
||||
|
||||
#### `dns`
|
||||
- **Purpose**: Provides DNS service for service discovery within cluster
|
||||
- **Required for**: Inter-service communication
|
||||
- **Note**: Usually enabled by default in MicroK8s
|
||||
|
||||
#### `metrics-server` (Optional)
|
||||
- **Purpose**: Enables resource usage monitoring
|
||||
- **Required for**: `kubectl top` commands and HPA (Horizontal Pod Autoscaling)
|
||||
- **Recommended for**: Production monitoring
|
||||
|
||||
### Addon Verification
|
||||
After enabling addons, verify they are running:
|
||||
|
||||
```bash
|
||||
# Check addon status
|
||||
microk8s status
|
||||
|
||||
# Check pods in kube-system namespace
|
||||
microk8s kubectl get pods -n kube-system
|
||||
|
||||
# Check storage classes
|
||||
microk8s kubectl get storageclass
|
||||
|
||||
# Check ingress controller
|
||||
microk8s kubectl get pods -n ingress
|
||||
```
|
||||
|
||||
### Troubleshooting Addons
|
||||
|
||||
#### NFS Addon Issues
|
||||
```bash
|
||||
# Check if NFS utilities are installed
|
||||
which mount.nfs
|
||||
|
||||
# Manually install if addon fails
|
||||
sudo apt update && sudo apt install nfs-common
|
||||
|
||||
# Restart MicroK8s after manual installation
|
||||
sudo microk8s restart
|
||||
```
|
||||
|
||||
#### Ingress Issues
|
||||
```bash
|
||||
# Check ingress controller pods
|
||||
microk8s kubectl get pods -n ingress
|
||||
|
||||
# Check ingress services
|
||||
microk8s kubectl get svc -n ingress
|
||||
|
||||
# Test ingress connectivity
|
||||
curl -k https://your-domain.com
|
||||
```
|
||||
|
||||
#### Storage Issues
|
||||
```bash
|
||||
# List available storage classes
|
||||
microk8s kubectl get storageclass
|
||||
|
||||
# Check default storage class
|
||||
microk8s kubectl get storageclass -o yaml
|
||||
```
|
||||
|
||||
### Storage Architecture
|
||||
- **Storage Class**: `nfs` - Static provisioning for NFS shares
|
||||
- **Persistent Volume**: Pre-provisioned PV pointing to NFS server
|
||||
- **Persistent Volume Claim**: Claims the NFS storage for application use
|
||||
- **Access Mode**: ReadWriteMany allows multiple pods to access the same data
|
||||
|
||||
### NFS Server Setup
|
||||
On the NFS server (192.168.17.199), ensure the following:
|
||||
|
||||
```bash
|
||||
# Create the shared directory
|
||||
sudo mkdir -p /mnt/user/vorgabenui
|
||||
sudo chmod 755 /mnt/user/vorgabenui
|
||||
|
||||
# Add to /etc/exports
|
||||
echo "/mnt/user/vorgabenui *(rw,sync,no_subtree_check,no_root_squash)" | sudo tee -a /etc/exports
|
||||
|
||||
# Export the directory
|
||||
sudo exportfs -a
|
||||
sudo systemctl restart nfs-kernel-server
|
||||
```
|
||||
|
||||
## Deployment Order
|
||||
|
||||
1. **StorageClass** (`nfs-storageclass.yaml`) - Defines NFS storage class
|
||||
2. **PersistentVolume** (`nfs-pv.yaml`) - Creates the NFS volume
|
||||
3. **PersistentVolumeClaim** (`001_pvc.yaml`) - Claims storage for application
|
||||
4. **Application Deployments** (`deployment.yaml`, `diagrammer.yaml`) - Deploy application services
|
||||
5. **Ingress** (`ingress.yaml`) - Configure external access
|
||||
|
||||
## Configuration Notes
|
||||
|
||||
### Namespace
|
||||
All resources are deployed to the `vorgabenui` namespace.
|
||||
|
||||
### Storage Sizing
|
||||
- Current allocation: 2Gi
|
||||
- Volume expansion is enabled through the StorageClass
|
||||
- Monitor usage and adjust PVC size as needed
|
||||
|
||||
### Access Control
|
||||
- NFS export uses `no_root_squash` for container root access
|
||||
- Ensure proper network security between Kubernetes nodes and NFS server
|
||||
- Consider implementing network policies for additional security
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Common Issues
|
||||
|
||||
#### Mount Failures
|
||||
- **Error**: "bad option; for several filesystems you might need a /sbin/mount.<type> helper program"
|
||||
- **Solution**: Install NFS client utilities or enable NFS addon in MicroK8s
|
||||
|
||||
#### Permission Issues
|
||||
- **Error**: Permission denied when accessing mounted volume
|
||||
- **Solution**: Check NFS export permissions and ensure `no_root_squash` is set
|
||||
|
||||
#### Network Connectivity
|
||||
- **Error**: Connection timeout to NFS server
|
||||
- **Solution**: Verify network connectivity and firewall rules between nodes and NFS server
|
||||
|
||||
### Debug Commands
|
||||
```bash
|
||||
# Check PVC status
|
||||
kubectl get pvc -n vorgabenui
|
||||
|
||||
# Check PV status
|
||||
kubectl get pv
|
||||
|
||||
# Describe PVC for detailed information
|
||||
kubectl describe pvc django-data-pvc -n vorgabenui
|
||||
|
||||
# Check pod mount status
|
||||
kubectl describe pod <pod-name> -n vorgabenui
|
||||
```
|
||||
|
||||
## Maintenance
|
||||
|
||||
### Backup Strategy
|
||||
- The NFS server should have regular backups of `/mnt/user/vorgabenui`
|
||||
- Consider snapshot capabilities if using enterprise NFS solutions
|
||||
|
||||
### Monitoring
|
||||
- Monitor NFS server performance and connectivity
|
||||
- Track storage usage and plan capacity upgrades
|
||||
- Monitor pod restarts related to storage issues
|
||||
|
||||
### Updates
|
||||
- When updating storage configuration, update PV first, then PVC
|
||||
- Test changes in non-production environment first
|
||||
- Ensure backward compatibility when modifying NFS exports
|
||||
105
Documentation/DIAGRAM_CACHING.md
Normal file
105
Documentation/DIAGRAM_CACHING.md
Normal file
@@ -0,0 +1,105 @@
|
||||
# Diagram POST Caching Implementation
|
||||
|
||||
This feature replaces the URL-encoded GET approach for diagram generation with POST requests and local filesystem caching.
|
||||
|
||||
## Changes Overview
|
||||
|
||||
### New Files
|
||||
- `diagramm_proxy/__init__.py` - Module initialization
|
||||
- `diagramm_proxy/diagram_cache.py` - Caching logic and POST request handling
|
||||
- `abschnitte/management/commands/clear_diagram_cache.py` - Management command for cache clearing
|
||||
|
||||
### Modified Files
|
||||
- `abschnitte/utils.py` - Updated `render_textabschnitte()` to use caching
|
||||
- `.gitignore` - Added cache directory exclusion
|
||||
|
||||
## Configuration Required
|
||||
|
||||
Add to your Django settings file (e.g., `VorgabenUI/settings.py`):
|
||||
|
||||
```python
|
||||
# Diagram cache settings
|
||||
DIAGRAM_CACHE_DIR = 'diagram_cache' # relative to MEDIA_ROOT
|
||||
|
||||
# Ensure MEDIA_ROOT and MEDIA_URL are configured
|
||||
MEDIA_ROOT = os.path.join(BASE_DIR, 'media')
|
||||
MEDIA_URL = '/media/'
|
||||
```
|
||||
|
||||
### URL Configuration
|
||||
|
||||
Ensure media files are served in development. In your main `urls.py`:
|
||||
|
||||
```python
|
||||
from django.conf import settings
|
||||
from django.conf.urls.static import static
|
||||
|
||||
# ... existing urlpatterns ...
|
||||
|
||||
# Serve media files in development
|
||||
if settings.DEBUG:
|
||||
urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
|
||||
```
|
||||
|
||||
## How It Works
|
||||
|
||||
1. When a diagram is rendered, the system computes a SHA256 hash of the diagram content
|
||||
2. It checks if a cached SVG exists for that hash
|
||||
3. If cached: serves the existing file
|
||||
4. If not cached: POSTs content to Kroki server, saves the response, and serves it
|
||||
5. Diagrams are served from `MEDIA_URL/diagram_cache/{type}/{hash}.svg`
|
||||
|
||||
## Benefits
|
||||
|
||||
- **No URL length limitations** - Content is POSTed instead of URL-encoded
|
||||
- **Improved performance** - Cached diagrams are served directly from filesystem
|
||||
- **Reduced server load** - Kroki server is only called once per unique diagram
|
||||
- **Persistent cache** - Survives application restarts
|
||||
- **Better error handling** - Graceful fallback on generation failures
|
||||
|
||||
## Usage
|
||||
|
||||
### Viewing Diagrams
|
||||
No changes required - diagrams will be automatically cached on first render.
|
||||
|
||||
### Clearing Cache
|
||||
|
||||
Clear all cached diagrams:
|
||||
```bash
|
||||
python manage.py clear_diagram_cache
|
||||
```
|
||||
|
||||
Clear diagrams of a specific type:
|
||||
```bash
|
||||
python manage.py clear_diagram_cache --type plantuml
|
||||
python manage.py clear_diagram_cache --type mermaid
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
1. Create or view a page with diagrams
|
||||
2. Verify diagrams render correctly
|
||||
3. Check that `media/diagram_cache/` directory is created with cached SVGs
|
||||
4. Refresh the page - second load should be faster (cache hit)
|
||||
5. Check logs for cache hit/miss messages
|
||||
6. Test cache clearing command
|
||||
|
||||
## Migration Notes
|
||||
|
||||
- Existing diagrams will be regenerated on first view after deployment
|
||||
- The old URL-based approach is completely replaced
|
||||
- No database migrations needed
|
||||
- Ensure `requests` library is installed (already in requirements.txt)
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Diagrams not rendering
|
||||
- Check that MEDIA_ROOT and MEDIA_URL are configured correctly
|
||||
- Verify Kroki server is accessible at `http://svckroki:8000`
|
||||
- Check application logs for error messages
|
||||
- Ensure media directory is writable
|
||||
|
||||
### Cache not working
|
||||
- Verify Django storage configuration
|
||||
- Check file permissions on media/diagram_cache directory
|
||||
- Review logs for cache-related errors
|
||||
491
Documentation/Datei-importieren.md
Normal file
491
Documentation/Datei-importieren.md
Normal file
@@ -0,0 +1,491 @@
|
||||
# Dokumenten-Import: Anleitung
|
||||
|
||||
Diese Anleitung beschreibt, wie Dokumente und Vorgaben mittels des `import-document` Management Commands in die VorgabenUI importiert werden können.
|
||||
|
||||
## Übersicht
|
||||
|
||||
Der `import-document` Command ermöglicht es, strukturierte Textdateien zu importieren, die Dokumente mit Einleitung, Geltungsbereich und Vorgaben enthalten. Das Format ist speziell für die einfache Erfassung und Pflege von IT-Sicherheitsstandards konzipiert.
|
||||
|
||||
## Grundlegende Verwendung
|
||||
|
||||
### Minimaler Aufruf
|
||||
|
||||
```bash
|
||||
python manage.py import-document <dateipfad> \
|
||||
--nummer <dokumentnummer> \
|
||||
--name "<dokumentname>" \
|
||||
--dokumententyp "<typ>"
|
||||
```
|
||||
|
||||
### Beispiel
|
||||
|
||||
```bash
|
||||
python manage.py import-document Documentation/import\ formats/r009.txt \
|
||||
--nummer "R0009" \
|
||||
--name "Serversysteme" \
|
||||
--dokumententyp "Standard IT-Sicherheit"
|
||||
```
|
||||
|
||||
## Parameter
|
||||
|
||||
### Pflichtparameter
|
||||
|
||||
| Parameter | Beschreibung | Beispiel |
|
||||
|-----------|--------------|----------|
|
||||
| `file_path` | Pfad zur Importdatei | `Documentation/import formats/r009.txt` |
|
||||
| `--nummer` | Dokumentnummer (eindeutig) | `R0009`, `R0066` |
|
||||
| `--name` | Dokumentname | `"Logging"`, `"Serversysteme"` |
|
||||
| `--dokumententyp` | Dokumententyp (muss bereits existieren) | `"Standard IT-Sicherheit"` |
|
||||
|
||||
### Optionale Parameter
|
||||
|
||||
| Parameter | Beschreibung | Verwendung |
|
||||
|-----------|--------------|------------|
|
||||
| `--gueltigkeit_von` | Startdatum der Gültigkeit | `--gueltigkeit_von 2024-01-01` |
|
||||
| `--gueltigkeit_bis` | Enddatum der Gültigkeit | `--gueltigkeit_bis 2025-12-31` |
|
||||
| `--dry-run` | Testlauf ohne Datenbankänderungen | `--dry-run` |
|
||||
| `--verbose` | Ausführliche Ausgabe (mit `--dry-run`) | `--dry-run --verbose` |
|
||||
| `--purge` | Löscht bestehende Einleitung/Geltungsbereich/Vorgaben vor Import | `--purge` |
|
||||
|
||||
### Dry-Run Modus
|
||||
|
||||
Der Dry-Run Modus ist besonders nützlich zum Testen:
|
||||
|
||||
```bash
|
||||
python manage.py import-document r009.txt \
|
||||
--nummer "R0009" \
|
||||
--name "Serversysteme" \
|
||||
--dokumententyp "Standard IT-Sicherheit" \
|
||||
--dry-run --verbose
|
||||
```
|
||||
|
||||
Dies zeigt an, was importiert würde, ohne die Datenbank zu ändern.
|
||||
|
||||
### Purge Modus
|
||||
|
||||
**Achtung:** Der Purge-Modus löscht alle bestehenden Vorgaben des Dokuments!
|
||||
|
||||
```bash
|
||||
python manage.py import-document r009.txt \
|
||||
--nummer "R0009" \
|
||||
--name "Serversysteme" \
|
||||
--dokumententyp "Standard IT-Sicherheit" \
|
||||
--purge
|
||||
```
|
||||
|
||||
Nutzen Sie `--dry-run --purge` zuerst, um zu sehen, was gelöscht würde.
|
||||
|
||||
## Dateiformat
|
||||
|
||||
### Grundstruktur
|
||||
|
||||
Die Importdatei ist eine Textdatei (UTF-8 kodiert) mit speziellen Trennzeichen `>>>` am Zeilenanfang.
|
||||
|
||||
### Aufbau
|
||||
|
||||
```
|
||||
>>>Einleitung
|
||||
>>>text
|
||||
[Einleitungstext]
|
||||
|
||||
>>>Geltungsbereich
|
||||
>>>text
|
||||
[Geltungsbereichstext]
|
||||
|
||||
>>>Vorgabe [Thema]
|
||||
>>>Nummer [nummer]
|
||||
>>>Titel
|
||||
[Titel der Vorgabe]
|
||||
>>>Kurztext
|
||||
>>>Text
|
||||
[Kurztext-Inhalt]
|
||||
>>>Langtext
|
||||
>>>Text
|
||||
[Langtext-Inhalt]
|
||||
>>>Stichworte
|
||||
[Stichwort1, Stichwort2, ...]
|
||||
>>>Checkliste
|
||||
[Frage 1]
|
||||
[Frage 2]
|
||||
```
|
||||
|
||||
### Abschnitt-Trenner
|
||||
|
||||
Jeder Abschnitt beginnt mit `>>>` gefolgt vom Abschnittstyp:
|
||||
|
||||
- `>>>Einleitung` - Startet den Einleitungsbereich
|
||||
- `>>>Geltungsbereich` - Startet den Geltungsbereichsbereich
|
||||
- `>>>Vorgabe [Thema]` - Startet eine neue Vorgabe mit angegebenem Thema
|
||||
|
||||
### Abschnitttypen für Textinhalte
|
||||
|
||||
Nach `>>>Einleitung`, `>>>Geltungsbereich`, `>>>Kurztext` oder `>>>Langtext` folgt ein Abschnitttyp:
|
||||
|
||||
| Typ | Verwendung | Beispiel |
|
||||
|-----|------------|----------|
|
||||
| `>>>text` oder `>>>Text` | Normaler Fliesstext | `>>>text` |
|
||||
| `>>>liste geordnet` oder `>>>Liste geordnet` | Nummerierte Liste | `>>>Liste geordnet` |
|
||||
| `>>>liste ungeordnet` oder `>>>Liste ungeordnet` | Aufzählungsliste | `>>>liste ungeordnet` |
|
||||
|
||||
**Hinweis:** Gross-/Kleinschreibung und Bindestriche (`liste-ungeordnet`) werden normalisiert.
|
||||
|
||||
## Beispiele
|
||||
|
||||
### Beispiel 1: Einfaches Dokument mit einer Vorgabe
|
||||
|
||||
```
|
||||
>>>Einleitung
|
||||
>>>text
|
||||
Dieser Standard definiert Anforderungen für XYZ.
|
||||
|
||||
>>>Geltungsbereich
|
||||
>>>text
|
||||
Dieser Standard gilt für alle Systeme im BIT.
|
||||
|
||||
>>>Vorgabe Technik
|
||||
>>>Nummer 1
|
||||
>>>Titel
|
||||
Verschlüsselung verwenden
|
||||
>>>Kurztext
|
||||
>>>Text
|
||||
Alle Verbindungen müssen verschlüsselt sein.
|
||||
>>>Langtext
|
||||
>>>Text
|
||||
Die Verschlüsselung muss mindestens TLS 1.2 verwenden.
|
||||
Es sind folgende Cipher Suites erlaubt:
|
||||
>>>Liste ungeordnet
|
||||
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
|
||||
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
|
||||
>>>Stichworte
|
||||
Verschlüsselung, TLS, Kryptographie
|
||||
>>>Checkliste
|
||||
TLS 1.2 oder höher ist konfiguriert
|
||||
Schwache Cipher Suites sind deaktiviert
|
||||
```
|
||||
|
||||
### Beispiel 2: Mehrere Vorgaben mit gleichem Thema
|
||||
|
||||
```
|
||||
>>>Vorgabe Organisation
|
||||
>>>Nummer 1
|
||||
>>>Titel
|
||||
CMDB-Erfassung
|
||||
>>>Kurztext
|
||||
>>>Text
|
||||
Alle Assets müssen in der CMDB erfasst sein.
|
||||
>>>Langtext
|
||||
>>>Text
|
||||
Jedes Asset muss dokumentiert werden...
|
||||
|
||||
>>>Vorgabe Organisation
|
||||
>>>Nummer 2
|
||||
>>>Titel
|
||||
Verantwortlichkeiten
|
||||
>>>Kurztext
|
||||
>>>Text
|
||||
Verantwortlichkeiten müssen definiert sein.
|
||||
>>>Langtext
|
||||
>>>Text
|
||||
Für jedes System muss ein Verantwortlicher...
|
||||
```
|
||||
|
||||
### Beispiel 3: Verschiedene Themen
|
||||
|
||||
```
|
||||
>>>Vorgabe Technik
|
||||
>>>Nummer 1
|
||||
>>>Titel
|
||||
Firewall-Konfiguration
|
||||
>>>Kurztext
|
||||
>>>Text
|
||||
Lokale Firewall muss aktiviert sein.
|
||||
>>>Langtext
|
||||
>>>Text
|
||||
Details zur Firewall-Konfiguration...
|
||||
|
||||
>>>Vorgabe Organisation
|
||||
>>>Nummer 1
|
||||
>>>Titel
|
||||
Dokumentation
|
||||
>>>Kurztext
|
||||
>>>Text
|
||||
Konfiguration muss dokumentiert sein.
|
||||
>>>Langtext
|
||||
>>>Text
|
||||
Die Firewall-Regeln müssen...
|
||||
|
||||
>>>Vorgabe Informationen
|
||||
>>>Nummer 1
|
||||
>>>Titel
|
||||
Datenklassifizierung
|
||||
>>>Kurztext
|
||||
>>>Text
|
||||
Daten müssen klassifiziert werden.
|
||||
>>>Langtext
|
||||
>>>Text
|
||||
Klassifizierungsstufen sind...
|
||||
```
|
||||
|
||||
### Beispiel 4: Mehrere Textabschnitte
|
||||
|
||||
```
|
||||
>>>Vorgabe Technik
|
||||
>>>Nummer 1
|
||||
>>>Titel
|
||||
Komplexe Anforderung
|
||||
>>>Kurztext
|
||||
>>>Text
|
||||
Erste Zusammenfassung.
|
||||
>>>Langtext
|
||||
>>>Text
|
||||
Erster Absatz mit Details.
|
||||
>>>Text
|
||||
Zweiter Absatz mit weiteren Informationen.
|
||||
>>>Liste ungeordnet
|
||||
Punkt 1
|
||||
Punkt 2
|
||||
Punkt 3
|
||||
>>>Text
|
||||
Abschliessender Text nach der Liste.
|
||||
```
|
||||
|
||||
## Vorgaben-Struktur
|
||||
|
||||
### Vorgabe-Header
|
||||
|
||||
```
|
||||
>>>Vorgabe [Thema]
|
||||
```
|
||||
|
||||
Das Thema muss in der Datenbank bereits als `Thema`-Objekt existieren. Übliche Themen:
|
||||
- Organisation
|
||||
- Technik
|
||||
- Informationen
|
||||
- Systeme
|
||||
- Anwendungen
|
||||
- Zonen
|
||||
|
||||
### Vorgabe-Felder
|
||||
|
||||
#### Nummer (Pflicht)
|
||||
|
||||
```
|
||||
>>>Nummer 1
|
||||
```
|
||||
|
||||
oder inline:
|
||||
|
||||
```
|
||||
>>>Nummer: 1
|
||||
```
|
||||
|
||||
Die Nummer wird als Integer gespeichert. Sie ist eindeutig innerhalb eines Dokuments und Themas.
|
||||
|
||||
#### Titel (Pflicht)
|
||||
|
||||
```
|
||||
>>>Titel
|
||||
Titel der Vorgabe
|
||||
```
|
||||
|
||||
oder inline:
|
||||
|
||||
```
|
||||
>>>Titel: Titel der Vorgabe
|
||||
```
|
||||
|
||||
#### Kurztext (Optional)
|
||||
|
||||
```
|
||||
>>>Kurztext
|
||||
>>>Text
|
||||
Kurze Zusammenfassung der Vorgabe.
|
||||
```
|
||||
|
||||
#### Langtext (Optional)
|
||||
|
||||
```
|
||||
>>>Langtext
|
||||
>>>Text
|
||||
Ausführliche Beschreibung der Vorgabe.
|
||||
>>>Liste ungeordnet
|
||||
Punkt 1
|
||||
Punkt 2
|
||||
```
|
||||
|
||||
#### Stichworte (Optional)
|
||||
|
||||
Komma-getrennte Liste:
|
||||
|
||||
```
|
||||
>>>Stichworte
|
||||
Firewall, Netzwerk, Sicherheit
|
||||
```
|
||||
|
||||
oder als Block:
|
||||
|
||||
```
|
||||
>>>Stichworte
|
||||
>>>Text
|
||||
Firewall, Netzwerk, Sicherheit
|
||||
```
|
||||
|
||||
**Hinweis:** Stichworte werden automatisch in der Datenbank angelegt, falls sie noch nicht existieren.
|
||||
|
||||
#### Checkliste (Optional)
|
||||
|
||||
```
|
||||
>>>Checkliste
|
||||
Ist die Firewall aktiviert?
|
||||
Sind alle unnötigen Ports geschlossen?
|
||||
Wurde die Konfiguration dokumentiert?
|
||||
```
|
||||
|
||||
Jede Zeile wird als separate Checklistenfrage gespeichert.
|
||||
|
||||
## Tipps und Best Practices
|
||||
|
||||
### 1. Dry-Run vor Import
|
||||
|
||||
Führen Sie immer zuerst einen Dry-Run durch:
|
||||
|
||||
```bash
|
||||
python manage.py import-document datei.txt \
|
||||
--nummer "R0XXX" \
|
||||
--name "Test" \
|
||||
--dokumententyp "Standard IT-Sicherheit" \
|
||||
--dry-run --verbose
|
||||
```
|
||||
|
||||
### 2. Themen vorab erstellen
|
||||
|
||||
Stellen Sie sicher, dass alle verwendeten Themen in der Datenbank existieren:
|
||||
|
||||
```python
|
||||
python manage.py shell
|
||||
>>> from dokumente.models import Thema
|
||||
>>> Thema.objects.get_or_create(name="Organisation")
|
||||
>>> Thema.objects.get_or_create(name="Technik")
|
||||
>>> Thema.objects.get_or_create(name="Informationen")
|
||||
```
|
||||
|
||||
### 3. Dokumententyp vorab erstellen
|
||||
|
||||
Der Dokumententyp muss existieren:
|
||||
|
||||
```python
|
||||
python manage.py shell
|
||||
>>> from dokumente.models import Dokumententyp
|
||||
>>> Dokumententyp.objects.get_or_create(
|
||||
... name="Standard IT-Sicherheit",
|
||||
... defaults={"verantwortliche_ve": "SR-SUR-SEC"}
|
||||
... )
|
||||
```
|
||||
|
||||
### 4. Abschnitttypen prüfen
|
||||
|
||||
Folgende Abschnitttypen müssen in der Datenbank existieren:
|
||||
- `text`
|
||||
- `liste geordnet`
|
||||
- `liste ungeordnet`
|
||||
- `code`
|
||||
- `diagramm`
|
||||
|
||||
Prüfen Sie diese in der Autorenumgebung unter "Abschnitttypen".
|
||||
|
||||
### 5. UTF-8 Kodierung
|
||||
|
||||
Stellen Sie sicher, dass Ihre Importdatei UTF-8 kodiert ist, besonders bei Umlauten (ä, ö, ü) und Sonderzeichen.
|
||||
|
||||
### 6. Versionierung mit Purge
|
||||
|
||||
Beim Re-Import mit `--purge`:
|
||||
|
||||
```bash
|
||||
# 1. Backup erstellen
|
||||
python manage.py dumpdata dokumente.Dokument dokumente.Vorgabe > backup.json
|
||||
|
||||
# 2. Import mit Purge
|
||||
python manage.py import-document datei.txt \
|
||||
--nummer "R0009" \
|
||||
--name "Serversysteme" \
|
||||
--dokumententyp "Standard IT-Sicherheit" \
|
||||
--purge
|
||||
```
|
||||
|
||||
### 7. Mehrzeilige Inhalte
|
||||
|
||||
Mehrzeiliger Text wird automatisch erkannt:
|
||||
|
||||
```
|
||||
>>>Langtext
|
||||
>>>Text
|
||||
Dies ist Zeile 1.
|
||||
Dies ist Zeile 2.
|
||||
|
||||
Dies ist ein neuer Absatz.
|
||||
```
|
||||
|
||||
### 8. Leerzeilen
|
||||
|
||||
Leerzeilen innerhalb eines Abschnitts werden beibehalten. Eine Leerzeile nach einem `>>>`-Trenner wird ignoriert.
|
||||
|
||||
## Fehlerbehebung
|
||||
|
||||
### "Dokumententyp does not exist"
|
||||
|
||||
Der angegebene Dokumententyp existiert nicht in der Datenbank.
|
||||
|
||||
**Lösung:** Erstellen Sie den Dokumententyp in der Autorenumgebung oder per Shell.
|
||||
|
||||
### "Thema not found, skipping Vorgabe"
|
||||
|
||||
Das in der Vorgabe verwendete Thema existiert nicht.
|
||||
|
||||
**Lösung:** Erstellen Sie das Thema in der Autorenumgebung oder passen Sie die Importdatei an.
|
||||
|
||||
### "AbschnittTyp not found"
|
||||
|
||||
Ein verwendeter Abschnitttyp existiert nicht.
|
||||
|
||||
**Lösung:**
|
||||
- Prüfen Sie die Schreibweise (Gross-/Kleinschreibung wird normalisiert)
|
||||
- Erstellen Sie den Abschnitttyp in der Autorenumgebung
|
||||
- Standardtypen: `text`, `liste geordnet`, `liste ungeordnet`
|
||||
|
||||
### Vorgabe wird nicht importiert
|
||||
|
||||
Prüfen Sie:
|
||||
- Ist `>>>Nummer` gesetzt?
|
||||
- Ist `>>>Titel` gesetzt?
|
||||
- Existiert das Thema?
|
||||
|
||||
Verwenden Sie `--dry-run --verbose` für detaillierte Informationen.
|
||||
|
||||
## Weitere Informationen
|
||||
|
||||
### Beispieldateien
|
||||
|
||||
Beispieldateien finden Sie in:
|
||||
- `Documentation/import formats/r009.txt`
|
||||
- `Documentation/import formats/r0126.txt`
|
||||
|
||||
### Export-Format
|
||||
|
||||
Der Export verwendet JSON statt Textformat. Für JSON-Export siehe:
|
||||
|
||||
```bash
|
||||
python manage.py export_json --output dokumente.json
|
||||
```
|
||||
|
||||
Oder über die Web-Oberfläche: `/dokumente/R0066/?format=json`
|
||||
|
||||
### Verwandte Commands
|
||||
|
||||
- `export_json` - Exportiert Dokumente als JSON
|
||||
- `sanity_check_vorgaben` - Prüft Vorgaben auf Konflikte
|
||||
- `clear_diagram_cache` - Löscht Diagramm-Cache
|
||||
|
||||
## Kontakt
|
||||
|
||||
Bei Fragen oder Problemen wenden Sie sich an das Information Security Management BIT.
|
||||
544
Documentation/diagramm.md
Normal file
544
Documentation/diagramm.md
Normal file
@@ -0,0 +1,544 @@
|
||||
# Diagramme in VorgabenUI
|
||||
|
||||
Diese Anleitung beschreibt, wie Diagramme in Textabschnitten verwendet werden können. VorgabenUI nutzt [Kroki](https://kroki.io/) zur Generierung von Diagrammen aus Textbeschreibungen.
|
||||
|
||||
## Übersicht
|
||||
|
||||
Der Abschnitttyp **"diagramm"** ermöglicht es, verschiedene Diagrammtypen direkt in Vorgaben, Einleitungen und Geltungsbereichen einzubinden. Die Diagramme werden aus Textbeschreibungen automatisch als SVG-Grafiken generiert und gecacht.
|
||||
|
||||
## Grundlegende Verwendung
|
||||
|
||||
### Format
|
||||
|
||||
```
|
||||
[Diagrammtyp]
|
||||
option: [HTML-Attribute] (optional)
|
||||
[Diagramm-Code]
|
||||
```
|
||||
|
||||
**Zeile 1:** Diagrammtyp (z.B. `plantuml`, `mermaid`, `graphviz`)
|
||||
**Zeile 2 (optional):** `option:` gefolgt von HTML-Attributen für die Bildgrösse
|
||||
**Zeile 3+:** Der eigentliche Diagramm-Quellcode
|
||||
|
||||
### Standard-Einstellungen
|
||||
|
||||
Wenn keine `option:`-Zeile angegeben wird, wird das Diagramm mit `width="100%"` dargestellt.
|
||||
|
||||
### Grösse anpassen
|
||||
|
||||
Um die Grösse des Diagramms anzupassen, verwenden Sie die `option:`-Zeile:
|
||||
|
||||
```
|
||||
plantuml
|
||||
option: width="50%"
|
||||
@startuml
|
||||
...
|
||||
@enduml
|
||||
```
|
||||
|
||||
Weitere Beispiele für Optionen:
|
||||
|
||||
```
|
||||
option: width="800px"
|
||||
option: width="60%" style="max-width: 600px;"
|
||||
option: height="400px"
|
||||
option: width="100%" class="img-fluid"
|
||||
```
|
||||
|
||||
## Unterstützte Diagrammtypen
|
||||
|
||||
Kroki unterstützt über 20 verschiedene Diagrammtypen. Die wichtigsten sind:
|
||||
|
||||
| Typ | Beschreibung | Verwendung |
|
||||
|-----|--------------|------------|
|
||||
| `plantuml` | UML-Diagramme, Sequenzdiagramme, Aktivitätsdiagramme | Prozesse, Architekturen |
|
||||
| `mermaid` | Flussdiagramme, Sequenzdiagramme, Gantt-Charts | Prozessabläufe, Zeitpläne |
|
||||
| `graphviz` | Gerichtete/ungerichtete Graphen | Abhängigkeiten, Netzwerke |
|
||||
| `blockdiag` | Block-Diagramme | Systemübersichten |
|
||||
| `nwdiag` | Netzwerk-Diagramme | Netzwerktopologien |
|
||||
| `seqdiag` | Sequenz-Diagramme | Kommunikationsabläufe |
|
||||
| `c4plantuml` | C4-Modell Diagramme | Software-Architektur |
|
||||
| `ditaa` | ASCII-Art zu Diagrammen | Einfache Skizzen |
|
||||
| `excalidraw` | Hand-gezeichnete Diagramme | Präsentationen |
|
||||
| `bpmn` | Business Process Model Notation | Geschäftsprozesse |
|
||||
|
||||
Vollständige Liste: https://kroki.io/
|
||||
|
||||
## Beispiele
|
||||
|
||||
### PlantUML: Sequenzdiagramm
|
||||
|
||||
```
|
||||
plantuml
|
||||
option: width="80%"
|
||||
@startuml
|
||||
Alice -> Bob: Authentifizierungsanfrage
|
||||
Bob --> Alice: Authentifizierungsantwort
|
||||
|
||||
Alice -> Bob: Weitere Anfrage
|
||||
Alice <-- Bob: Weitere Antwort
|
||||
@enduml
|
||||
```
|
||||
|
||||
**Verwendung:** Darstellung von Kommunikationsabläufen, API-Interaktionen
|
||||
|
||||
### PlantUML: Aktivitätsdiagramm
|
||||
|
||||
```
|
||||
plantuml
|
||||
@startuml
|
||||
start
|
||||
:Sicherheitsrichtlinie prüfen;
|
||||
if (Richtlinie erfüllt?) then (ja)
|
||||
:Zugriff gewähren;
|
||||
else (nein)
|
||||
:Zugriff verweigern;
|
||||
:Incident loggen;
|
||||
endif
|
||||
stop
|
||||
@enduml
|
||||
```
|
||||
|
||||
**Verwendung:** Prozesse, Entscheidungsabläufe, Workflows
|
||||
|
||||
### PlantUML: Komponentendiagramm
|
||||
|
||||
```
|
||||
plantuml
|
||||
option: width="70%"
|
||||
@startuml
|
||||
package "Web-Tier" {
|
||||
[Web-Server]
|
||||
[Load Balancer]
|
||||
}
|
||||
|
||||
package "App-Tier" {
|
||||
[Application Server]
|
||||
[Cache]
|
||||
}
|
||||
|
||||
package "Data-Tier" {
|
||||
[Datenbank]
|
||||
}
|
||||
|
||||
[Load Balancer] --> [Web-Server]
|
||||
[Web-Server] --> [Application Server]
|
||||
[Application Server] --> [Cache]
|
||||
[Application Server] --> [Datenbank]
|
||||
@enduml
|
||||
```
|
||||
|
||||
**Verwendung:** System-Architekturen, Komponenten-Übersicht
|
||||
|
||||
### Mermaid: Flussdiagramm
|
||||
|
||||
```
|
||||
mermaid
|
||||
option: width="75%"
|
||||
flowchart TD
|
||||
Start[Log-Event empfangen] --> Check{Schweregrad?}
|
||||
Check -->|CRITICAL| Alert[Alert auslösen]
|
||||
Check -->|WARNING| Log[In Log-System speichern]
|
||||
Check -->|INFO| Archive[Archivieren]
|
||||
Alert --> SIEM[An SIEM weiterleiten]
|
||||
Log --> SIEM
|
||||
SIEM --> End[Fertig]
|
||||
Archive --> End
|
||||
```
|
||||
|
||||
**Verwendung:** Prozessabläufe, Entscheidungsbäume
|
||||
|
||||
### Mermaid: Sequenzdiagramm
|
||||
|
||||
```
|
||||
mermaid
|
||||
sequenceDiagram
|
||||
participant Benutzer
|
||||
participant Firewall
|
||||
participant Server
|
||||
|
||||
Benutzer->>Firewall: Verbindungsanfrage
|
||||
Firewall->>Firewall: Regel-Prüfung
|
||||
alt Regel erlaubt
|
||||
Firewall->>Server: Weiterleitung
|
||||
Server-->>Firewall: Antwort
|
||||
Firewall-->>Benutzer: Antwort
|
||||
else Regel blockiert
|
||||
Firewall-->>Benutzer: Verbindung abgelehnt
|
||||
end
|
||||
```
|
||||
|
||||
**Verwendung:** Kommunikationsabläufe mit Bedingungen
|
||||
|
||||
### GraphViz: Abhängigkeitsgraph
|
||||
|
||||
```
|
||||
graphviz
|
||||
digraph G {
|
||||
rankdir=LR;
|
||||
node [shape=box, style=rounded];
|
||||
|
||||
"R0066\nLogging" -> "R0009\nServersysteme";
|
||||
"R0066\nLogging" -> "R0126\nNetzwerksicherheit";
|
||||
"R0009\nServersysteme" -> "R0135\nInformationssicherheit";
|
||||
"R0126\nNetzwerksicherheit" -> "R0135\nInformationssicherheit";
|
||||
|
||||
"R0135\nInformationssicherheit" [style="rounded,filled", fillcolor=lightblue];
|
||||
}
|
||||
```
|
||||
|
||||
**Verwendung:** Abhängigkeiten zwischen Dokumenten/Standards
|
||||
|
||||
### GraphViz: Netzwerk-Topologie
|
||||
|
||||
```
|
||||
graphviz
|
||||
option: width="100%"
|
||||
graph G {
|
||||
layout=neato;
|
||||
|
||||
Internet [shape=cloud];
|
||||
Firewall [shape=box, style=filled, fillcolor=red];
|
||||
DMZ [shape=box, style=filled, fillcolor=yellow];
|
||||
LAN [shape=box, style=filled, fillcolor=green];
|
||||
|
||||
Internet -- Firewall [label="WAN"];
|
||||
Firewall -- DMZ [label="DMZ-Segment"];
|
||||
Firewall -- LAN [label="Internes Netz"];
|
||||
}
|
||||
```
|
||||
|
||||
**Verwendung:** Netzwerk-Segmentierung, Zonen-Modelle
|
||||
|
||||
### BlockDiag: System-Übersicht
|
||||
|
||||
```
|
||||
blockdiag
|
||||
blockdiag {
|
||||
orientation = portrait;
|
||||
|
||||
Client -> "Load Balancer" -> "Web-Server 1", "Web-Server 2";
|
||||
"Web-Server 1", "Web-Server 2" -> "App-Server";
|
||||
"App-Server" -> "Datenbank Primary";
|
||||
"Datenbank Primary" -> "Datenbank Replica";
|
||||
|
||||
"Load Balancer" [color = "lightblue"];
|
||||
"App-Server" [color = "lightgreen"];
|
||||
"Datenbank Primary" [color = "pink"];
|
||||
}
|
||||
```
|
||||
|
||||
**Verwendung:** Einfache System-Diagramme, Datenflüsse
|
||||
|
||||
### NwDiag: Netzwerk-Diagramm
|
||||
|
||||
```
|
||||
nwdiag
|
||||
nwdiag {
|
||||
network dmz {
|
||||
address = "192.168.1.0/24";
|
||||
|
||||
web01 [address = "192.168.1.10"];
|
||||
web02 [address = "192.168.1.11"];
|
||||
}
|
||||
|
||||
network internal {
|
||||
address = "10.0.0.0/8";
|
||||
|
||||
web01 [address = "10.0.1.10"];
|
||||
web02 [address = "10.0.1.11"];
|
||||
app01 [address = "10.0.2.10"];
|
||||
db01 [address = "10.0.3.10"];
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Verwendung:** Netzwerk-Topologien mit IP-Adressen
|
||||
|
||||
### SeqDiag: Authentifizierungsablauf
|
||||
|
||||
```
|
||||
seqdiag
|
||||
seqdiag {
|
||||
Benutzer -> System: Benutzername + Passwort;
|
||||
System -> LDAP: Authentifizierung prüfen;
|
||||
LDAP --> System: Erfolgreich;
|
||||
System -> 2FA: 2FA-Code anfordern;
|
||||
2FA --> Benutzer: Code per SMS;
|
||||
Benutzer -> System: 2FA-Code eingeben;
|
||||
System --> Benutzer: Zugriff gewährt;
|
||||
}
|
||||
```
|
||||
|
||||
**Verwendung:** Authentifizierungs- und Autorisierungsabläufe
|
||||
|
||||
### C4 PlantUML: System-Kontext
|
||||
|
||||
```
|
||||
c4plantuml
|
||||
@startuml
|
||||
!include https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/C4_Context.puml
|
||||
|
||||
Person(admin, "Administrator", "BIT System-Administrator")
|
||||
System(vorgaben, "VorgabenUI", "IT-Sicherheits-Vorgaben Portal")
|
||||
System_Ext(ldap, "LDAP", "Authentifizierung")
|
||||
|
||||
Rel(admin, vorgaben, "Verwaltet Vorgaben")
|
||||
Rel(vorgaben, ldap, "Authentifiziert über")
|
||||
@enduml
|
||||
```
|
||||
|
||||
**Verwendung:** Software-Architektur nach C4-Modell
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Diagramm-Grösse anpassen
|
||||
|
||||
Verwenden Sie die `option:`-Zeile, um die Grösse für bessere Lesbarkeit anzupassen:
|
||||
|
||||
```
|
||||
plantuml
|
||||
option: width="60%"
|
||||
...
|
||||
```
|
||||
|
||||
Für sehr detaillierte Diagramme:
|
||||
```
|
||||
plantuml
|
||||
option: width="100%" style="max-width: 1200px;"
|
||||
...
|
||||
```
|
||||
|
||||
### 2. Einfachheit bevorzugen
|
||||
|
||||
Halten Sie Diagramme einfach und fokussiert. Zu komplexe Diagramme sind schwer zu lesen.
|
||||
|
||||
**Gut:**
|
||||
```
|
||||
mermaid
|
||||
flowchart LR
|
||||
A[Start] --> B{Prüfung}
|
||||
B -->|OK| C[Weiter]
|
||||
B -->|Fehler| D[Abbruch]
|
||||
```
|
||||
|
||||
**Zu komplex:** Vermeiden Sie Diagramme mit mehr als 15-20 Elementen.
|
||||
|
||||
### 3. Konsistente Stil-Wahl
|
||||
|
||||
Verwenden Sie für ähnliche Konzepte den gleichen Diagrammtyp:
|
||||
- **Prozesse:** Mermaid Flowchart oder PlantUML Activity
|
||||
- **Kommunikation:** Mermaid/PlantUML Sequence
|
||||
- **Architektur:** PlantUML Component oder C4
|
||||
- **Netzwerke:** NwDiag oder GraphViz
|
||||
|
||||
### 4. Beschriftungen auf Deutsch
|
||||
|
||||
Verwenden Sie deutsche Beschriftungen für bessere Verständlichkeit:
|
||||
|
||||
```
|
||||
mermaid
|
||||
flowchart TD
|
||||
Start[Anfrage empfangen] --> Prüfung{Berechtigung?}
|
||||
Prüfung -->|Ja| Zugriff[Zugriff gewähren]
|
||||
Prüfung -->|Nein| Ablehnung[Zugriff verweigern]
|
||||
```
|
||||
|
||||
### 5. Farben sparsam einsetzen
|
||||
|
||||
Nutzen Sie Farben zur Hervorhebung wichtiger Elemente:
|
||||
|
||||
```
|
||||
graphviz
|
||||
digraph {
|
||||
node [shape=box];
|
||||
|
||||
Kritisch [style=filled, fillcolor=red, fontcolor=white];
|
||||
Wichtig [style=filled, fillcolor=orange];
|
||||
Normal [style=filled, fillcolor=lightgreen];
|
||||
|
||||
Kritisch -> Wichtig -> Normal;
|
||||
}
|
||||
```
|
||||
|
||||
### 6. Lesbarkeit testen
|
||||
|
||||
Nach dem Speichern prüfen, ob das Diagramm in der Webansicht gut lesbar ist. Bei Bedarf:
|
||||
- Grösse anpassen (`option: width="..."`)
|
||||
- Diagramm vereinfachen
|
||||
- Anderen Diagrammtyp wählen
|
||||
|
||||
## Fehlerbehandlung
|
||||
|
||||
### Diagramm wird nicht angezeigt
|
||||
|
||||
**Mögliche Ursachen:**
|
||||
|
||||
1. **Syntaxfehler im Diagramm-Code**
|
||||
- Prüfen Sie die Syntax gemäss Dokumentation des Diagrammtyps
|
||||
- Testen Sie den Code auf https://kroki.io/
|
||||
|
||||
2. **Falscher Diagrammtyp**
|
||||
- Erste Zeile muss genau dem Kroki-Typ entsprechen
|
||||
- Beispiel: `plantuml` (nicht `PlantUML` oder `plant-uml`)
|
||||
|
||||
3. **Kroki-Server nicht erreichbar**
|
||||
- Bei Fehlermeldung "Error generating diagram" Server prüfen
|
||||
|
||||
### Fehlersuche
|
||||
|
||||
1. **Code auf kroki.io testen:**
|
||||
```
|
||||
https://kroki.io/
|
||||
```
|
||||
Geben Sie dort den Code ein und testen Sie die Generierung.
|
||||
|
||||
2. **Diagramm-Cache leeren:**
|
||||
```bash
|
||||
python manage.py clear_diagram_cache
|
||||
```
|
||||
|
||||
3. **Logs prüfen:**
|
||||
Fehler werden im Application-Log ausgegeben.
|
||||
|
||||
## Häufig verwendete Diagramm-Szenarien
|
||||
|
||||
### IT-Sicherheit: Bedrohungsmodell
|
||||
|
||||
```
|
||||
mermaid
|
||||
flowchart TB
|
||||
Asset[Schützenswertes Asset]
|
||||
Threat[Bedrohung]
|
||||
Vuln[Schwachstelle]
|
||||
Control[Sicherheitsmassnahme]
|
||||
|
||||
Threat -->|nutzt aus| Vuln
|
||||
Vuln -->|betrifft| Asset
|
||||
Control -->|schliesst| Vuln
|
||||
Control -->|schützt| Asset
|
||||
```
|
||||
|
||||
### Netzwerk-Segmentierung
|
||||
|
||||
```
|
||||
nwdiag
|
||||
nwdiag {
|
||||
network internet {
|
||||
address = "Internet";
|
||||
internet [shape = cloud];
|
||||
}
|
||||
network dmz {
|
||||
address = "DMZ (192.168.1.0/24)";
|
||||
fw [address = "192.168.1.1"];
|
||||
web [address = "192.168.1.10"];
|
||||
}
|
||||
network internal {
|
||||
address = "Intern (10.0.0.0/8)";
|
||||
fw [address = "10.0.0.1"];
|
||||
app [address = "10.0.1.10"];
|
||||
db [address = "10.0.2.10"];
|
||||
}
|
||||
|
||||
internet -- fw;
|
||||
}
|
||||
```
|
||||
|
||||
### Patch-Management Prozess
|
||||
|
||||
```
|
||||
plantuml
|
||||
@startuml
|
||||
start
|
||||
:Patch-Benachrichtigung empfangen;
|
||||
:Schweregrad bewerten;
|
||||
if (Kritischer Patch?) then (ja)
|
||||
:Sofort in Test-Umgebung testen;
|
||||
if (Test erfolgreich?) then (ja)
|
||||
:Notfall-Change erstellen;
|
||||
:In Produktion ausrollen;
|
||||
else (nein)
|
||||
:Vendor kontaktieren;
|
||||
endif
|
||||
else (nein)
|
||||
:In regulären Patch-Zyklus einplanen;
|
||||
:Testen im Change-Window;
|
||||
:Reguläres Rollout;
|
||||
endif
|
||||
:Dokumentation aktualisieren;
|
||||
stop
|
||||
@enduml
|
||||
```
|
||||
|
||||
### Zugriffskontrolle
|
||||
|
||||
```
|
||||
plantuml
|
||||
@startuml
|
||||
skinparam actorStyle awesome
|
||||
|
||||
actor Benutzer
|
||||
actor Administrator
|
||||
actor "Security Team" as ST
|
||||
|
||||
rectangle "VorgabenUI" {
|
||||
usecase "Vorgaben lesen" as UC1
|
||||
usecase "Vorgaben bearbeiten" as UC2
|
||||
usecase "Vorgaben publizieren" as UC3
|
||||
usecase "Sicherheitsreview" as UC4
|
||||
}
|
||||
|
||||
Benutzer --> UC1
|
||||
Administrator --> UC1
|
||||
Administrator --> UC2
|
||||
ST --> UC4
|
||||
UC2 .> UC4 : <<extends>>
|
||||
UC4 --> UC3
|
||||
@enduml
|
||||
```
|
||||
|
||||
## Weiterführende Ressourcen
|
||||
|
||||
- **Kroki Dokumentation:** https://kroki.io/
|
||||
- **PlantUML Dokumentation:** https://plantuml.com/
|
||||
- **Mermaid Dokumentation:** https://mermaid.js.org/
|
||||
- **GraphViz Dokumentation:** https://graphviz.org/
|
||||
- **Live-Editor zum Testen:** https://kroki.io/
|
||||
|
||||
## Tipps für spezifische Diagrammtypen
|
||||
|
||||
### PlantUML Tipps
|
||||
|
||||
```
|
||||
@startuml
|
||||
' Kommentare mit Apostroph
|
||||
skinparam backgroundColor transparent
|
||||
skinparam defaultFontName Arial
|
||||
@enduml
|
||||
```
|
||||
|
||||
### Mermaid Tipps
|
||||
|
||||
```
|
||||
%%{ init: { 'theme': 'base' } }%%
|
||||
flowchart LR
|
||||
%% Kommentare mit doppeltem Prozent
|
||||
```
|
||||
|
||||
### GraphViz Tipps
|
||||
|
||||
```
|
||||
digraph {
|
||||
// Kommentare mit doppeltem Slash
|
||||
rankdir=LR; // Links nach Rechts
|
||||
// rankdir=TB; // Top nach Bottom
|
||||
}
|
||||
```
|
||||
|
||||
## Support
|
||||
|
||||
Bei Fragen oder Problemen mit Diagrammen:
|
||||
1. Code auf https://kroki.io/ testen
|
||||
2. Syntax-Dokumentation des jeweiligen Diagrammtyps konsultieren
|
||||
3. Diagramm-Cache leeren: `python manage.py clear_diagram_cache`
|
||||
4. Bei technischen Problemen: Information Security Management BIT kontaktieren
|
||||
544
Documentation/modelle.md
Normal file
544
Documentation/modelle.md
Normal file
@@ -0,0 +1,544 @@
|
||||
# Alle Modelle der vgui-cicd Django-Anwendung
|
||||
|
||||
Dieses Dokument beschreibt alle Datenmodelle in der vgui-cicd Anwendung mit ihren Eigenschaften, Beziehungen und Verwendungszwecken.
|
||||
|
||||
---
|
||||
|
||||
## App: dokumente
|
||||
|
||||
Die Hauptmodelle für die Verwaltung von Dokumenten, Vorgaben und deren Metadaten.
|
||||
|
||||
### Dokumententyp
|
||||
|
||||
**Zweck**: Kategorisierung von Dokumenten (z. B. Richtlinie, Standard).
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `name` (CharField, max_length=100, **PRIMARY KEY**)
|
||||
- `verantwortliche_ve` (CharField, max_length=255): Die verantwortliche Verwaltungseinheit
|
||||
|
||||
**Besonderheiten**:
|
||||
- `__str__()` gibt den Namen zurück
|
||||
- Dient als Klassifizierungskategorie für Dokumente
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name = "Dokumententyp"`
|
||||
- `verbose_name_plural = "Dokumententypen"`
|
||||
|
||||
---
|
||||
|
||||
### Person
|
||||
|
||||
**Zweck**: Repräsentiert Personen, die als Autoren, Prüfer oder in anderen Rollen tätig sind.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `name` (CharField, max_length=100, **PRIMARY KEY**)
|
||||
- `funktion` (CharField, max_length=255): Funktionsbezeichnung der Person
|
||||
|
||||
**Beziehungen**:
|
||||
- Many-to-Many mit `Dokument` über `verfasste_dokumente` (Autoren)
|
||||
- Many-to-Many mit `Dokument` über `gepruefte_dokumente` (Prüfer)
|
||||
|
||||
**Besonderheiten**:
|
||||
- `__str__()` gibt den Namen zurück
|
||||
- `ordering = ['name']`: Alphabetische Sortierung
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name_plural = "Personen"`
|
||||
|
||||
---
|
||||
|
||||
### Thema
|
||||
|
||||
**Zweck**: Thematische Einordnung und Kategorisierung von Vorgaben innerhalb von Dokumenten.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `name` (CharField, max_length=100, **PRIMARY KEY**)
|
||||
- `erklaerung` (TextField, blank=True): Optionale Erklärung des Themas
|
||||
|
||||
**Besonderheiten**:
|
||||
- `__str__()` gibt den Namen zurück
|
||||
- Der erste Buchstabe des Themas wird in Vorgabennummern verwendet
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name_plural = "Themen"`
|
||||
|
||||
---
|
||||
|
||||
### Dokument
|
||||
|
||||
**Zweck**: Hauptmodell für ein einzelnes Dokument mit allen zugehörigen Metadaten und Inhalten.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `nummer` (CharField, max_length=50, **PRIMARY KEY**): Eindeutige Dokumentennummer
|
||||
- `dokumententyp` (ForeignKey → Dokumententyp, on_delete=PROTECT): Klassifizierung
|
||||
- `name` (CharField, max_length=255): Dokumenttitel
|
||||
- `autoren` (ManyToManyField → Person, related_name='verfasste_dokumente')
|
||||
- `pruefende` (ManyToManyField → Person, related_name='gepruefte_dokumente')
|
||||
- `gueltigkeit_von` (DateField, null=True, blank=True): Gültig ab Datum
|
||||
- `gueltigkeit_bis` (DateField, null=True, blank=True): Gültig bis Datum
|
||||
- `signatur_cso` (CharField, max_length=255, blank=True): CSO-Signatur
|
||||
- `anhaenge` (TextField, blank=True): Beschreibung von Anhängen
|
||||
- `aktiv` (BooleanField, blank=True): Aktivierungsstatus
|
||||
|
||||
**Beziehungen**:
|
||||
- 1-to-Many mit `Vorgabe` (über related_name='vorgaben')
|
||||
- 1-to-Many mit `Geltungsbereich`
|
||||
- 1-to-Many mit `Einleitung`
|
||||
- 1-to-Many mit `Changelog`
|
||||
|
||||
**Besonderheiten**:
|
||||
- `__str__()` formatiert als "nummer – name"
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name = "Dokument"`
|
||||
- `verbose_name_plural = "Dokumente"`
|
||||
|
||||
---
|
||||
|
||||
### Vorgabe
|
||||
|
||||
**Zweck**: Repräsentiert eine einzelne Vorgabe oder Anforderung innerhalb eines Dokuments.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `order` (IntegerField): Sortierreihenfolge für die Darstellung
|
||||
- `nummer` (IntegerField): Nummer innerhalb eines Themas/Dokuments. Muss nicht eindeutig sein (z.B. für geänderte Vorgaben)
|
||||
- `dokument` (ForeignKey → Dokument, on_delete=CASCADE, related_name='vorgaben')
|
||||
- `thema` (ForeignKey → Thema, on_delete=PROTECT): Thematische Einordnung
|
||||
- `titel` (CharField, max_length=255): Titel der Vorgabe
|
||||
- `referenzen` (ManyToManyField → Referenz, blank=True): Verweise auf externe Referenzen
|
||||
- `gueltigkeit_von` (DateField): Gültig ab Datum
|
||||
- `gueltigkeit_bis` (DateField, blank=True, null=True): Gültig bis Datum (offen = unbegrenzt)
|
||||
- `stichworte` (ManyToManyField → Stichwort, blank=True): Tags zur Kategorisierung
|
||||
- `relevanz` (ManyToManyField → Rolle, blank=True): Relevante Rollen
|
||||
|
||||
**Beziehungen**:
|
||||
- Foreign Key zu `Dokument` und `Thema`
|
||||
- Many-to-Many zu `Referenz`, `Stichwort`, `Rolle`
|
||||
- 1-to-Many zu `VorgabeLangtext`, `VorgabeKurztext`
|
||||
- 1-to-Many zu `Checklistenfrage`
|
||||
|
||||
**Wichtige Methoden**:
|
||||
|
||||
- `Vorgabennummer()` → str
|
||||
- Generiert eine eindeutige, lesbare Kennummer
|
||||
- Format: "{dokument.nummer}.{thema.name[0]}.{nummer}"
|
||||
- Beispiel: "R0066.A.1"
|
||||
|
||||
- `get_status(check_date=None, verbose=False)` → str
|
||||
- Bestimmt den Status einer Vorgabe zu einem gegebenen Datum
|
||||
- Parameter: `check_date` (Default: heute), `verbose` (Deutsche Beschreibung ja/nein)
|
||||
- Rückgabewerte:
|
||||
- "future": Vorgabe ist noch nicht gültig
|
||||
- "active": Vorgabe ist aktuell gültig
|
||||
- "expired": Vorgabe ist nicht mehr gültig
|
||||
- Verbose-Ausgaben enthalten Datumsangaben
|
||||
|
||||
- `sanity_check_vorgaben()` (statisch) → list
|
||||
- Findet zeitliche Konflikte zwischen Vorgaben mit gleicher Nummer/Thema/Dokument
|
||||
- Überprüft, ob sich Geltungszeiträume überschneiden
|
||||
- Gibt Liste mit Konflikt-Dictionaries zurück
|
||||
|
||||
- `clean()`
|
||||
- Validiert die Vorgabe vor dem Speichern
|
||||
- Ruft `find_conflicts()` auf
|
||||
- Wirft `ValidationError` bei erkannten Konflikten
|
||||
|
||||
- `find_conflicts()` → list
|
||||
- Findet Konflikte mit bestehenden Vorgaben (ausgenommen self)
|
||||
- Überprüft auf zeitliche Überschneidungen
|
||||
- Gibt Liste mit Konflikt-Details zurück
|
||||
|
||||
- `_date_ranges_intersect(start1, end1, start2, end2)` (statisch) → bool
|
||||
- Prüft, ob zwei Datumsbereiche sich überschneiden
|
||||
- `None` als Enddatum = unbegrenzter Bereich
|
||||
- Gibt `True` bei Überschneidung zurück
|
||||
|
||||
**Besonderheiten**:
|
||||
- `__str__()` gibt "Vorgabennummer: titel" zurück
|
||||
- Validierung von Gültigkeitszeiträumen ist implementiert
|
||||
- Sehr wichtiges Modell im Geschäftslogik-Kontext
|
||||
|
||||
**Meta**:
|
||||
- `ordering = ['order']`
|
||||
- `verbose_name_plural = "Vorgaben"`
|
||||
|
||||
---
|
||||
|
||||
### VorgabeLangtext
|
||||
|
||||
**Zweck**: Speichert ausführliche Textinhalte (Langtext) einer Vorgabe.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `abschnitt` (ForeignKey → Vorgabe, on_delete=CASCADE): Referenz zur Vorgabe
|
||||
- Erbt von `Textabschnitt` (siehe App: abschnitte):
|
||||
- `abschnitttyp` (ForeignKey → AbschnittTyp, optional)
|
||||
- `inhalt` (TextField, blank=True, null=True)
|
||||
- `order` (PositiveIntegerField, default=0)
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name = "Langtext-Abschnitt"`
|
||||
- `verbose_name_plural = "Langtext"`
|
||||
|
||||
---
|
||||
|
||||
### VorgabeKurztext
|
||||
|
||||
**Zweck**: Speichert kurze Textinhalte (Kurztext) einer Vorgabe.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `abschnitt` (ForeignKey → Vorgabe, on_delete=CASCADE): Referenz zur Vorgabe
|
||||
- Erbt von `Textabschnitt` (siehe App: abschnitte):
|
||||
- `abschnitttyp` (ForeignKey → AbschnittTyp, optional)
|
||||
- `inhalt` (TextField, blank=True, null=True)
|
||||
- `order` (PositiveIntegerField, default=0)
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name = "Kurztext-Abschnitt"`
|
||||
- `verbose_name_plural = "Kurztext"`
|
||||
|
||||
---
|
||||
|
||||
### Geltungsbereich
|
||||
|
||||
**Zweck**: Speichert den Geltungsbereich-Abschnitt eines Dokuments.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `geltungsbereich` (ForeignKey → Dokument, on_delete=CASCADE): Referenz zum Dokument
|
||||
- Erbt von `Textabschnitt` (siehe App: abschnitte):
|
||||
- `abschnitttyp` (ForeignKey → AbschnittTyp, optional)
|
||||
- `inhalt` (TextField, blank=True, null=True)
|
||||
- `order` (PositiveIntegerField, default=0)
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name = "Geltungsbereichs-Abschnitt"`
|
||||
- `verbose_name_plural = "Geltungsbereich"`
|
||||
|
||||
---
|
||||
|
||||
### Einleitung
|
||||
|
||||
**Zweck**: Speichert die Einleitungs-Abschnitte eines Dokuments.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `einleitung` (ForeignKey → Dokument, on_delete=CASCADE): Referenz zum Dokument
|
||||
- Erbt von `Textabschnitt` (siehe App: abschnitte):
|
||||
- `abschnitttyp` (ForeignKey → AbschnittTyp, optional)
|
||||
- `inhalt` (TextField, blank=True, null=True)
|
||||
- `order` (PositiveIntegerField, default=0)
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name = "Einleitungs-Abschnitt"`
|
||||
- `verbose_name_plural = "Einleitung"`
|
||||
|
||||
---
|
||||
|
||||
### Checklistenfrage
|
||||
|
||||
**Zweck**: Repräsentiert eine Frage für die Checkliste zu einer Vorgabe.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `vorgabe` (ForeignKey → Vorgabe, on_delete=CASCADE, related_name='checklistenfragen')
|
||||
- `frage` (CharField, max_length=255): Text der Checklistenfrage
|
||||
|
||||
**Besonderheiten**:
|
||||
- `__str__()` gibt den Fragetext zurück
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name = "Frage für Checkliste"`
|
||||
- `verbose_name_plural = "Fragen für Checkliste"`
|
||||
|
||||
---
|
||||
|
||||
### VorgabenTable
|
||||
|
||||
**Zweck**: Proxy-Modell für `Vorgabe` für die Darstellung von Vorgaben in Tabellenform.
|
||||
|
||||
**Besonderheiten**:
|
||||
- Proxy-Modell (kein eigenes Datenbankschema)
|
||||
- Ermöglicht alternative Django-Admin-Ansicht
|
||||
- Erbt alle Felder und Methoden von `Vorgabe`
|
||||
|
||||
**Meta**:
|
||||
- `proxy = True`
|
||||
- `verbose_name = "Vorgabe (Tabellenansicht)"`
|
||||
- `verbose_name_plural = "Vorgaben (Tabellenansicht)"`
|
||||
|
||||
---
|
||||
|
||||
### Changelog
|
||||
|
||||
**Zweck**: Dokumentiert Änderungen und Versionshistorie für Dokumente.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `dokument` (ForeignKey → Dokument, on_delete=CASCADE, related_name='changelog'): Referenz zum Dokument
|
||||
- `autoren` (ManyToManyField → Person): Personen, die die Änderung vorgenommen haben
|
||||
- `datum` (DateField): Datum der Änderung
|
||||
- `aenderung` (TextField): Beschreibung der Änderung
|
||||
|
||||
**Beziehungen**:
|
||||
- Foreign Key zu `Dokument`
|
||||
- Many-to-Many zu `Person`
|
||||
|
||||
**Besonderheiten**:
|
||||
- `__str__()` formatiert als "datum – dokumentnummer"
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name = "Changelog-Eintrag"`
|
||||
- `verbose_name_plural = "Changelog"`
|
||||
|
||||
---
|
||||
|
||||
## App: abschnitte
|
||||
|
||||
Modelle für die Verwaltung von Textabschnitten, die von mehreren Modellen geerbt werden.
|
||||
|
||||
### AbschnittTyp
|
||||
|
||||
**Zweck**: Klassifizierung von Textabschnitten (z. B. "Beschreibung", "Erklärung", "Anleitung").
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `abschnitttyp` (CharField, max_length=100, **PRIMARY KEY**): Name des Abschnitttyps
|
||||
|
||||
**Besonderheiten**:
|
||||
- `__str__()` gibt den Namen zurück
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name_plural = "Abschnitttypen"`
|
||||
|
||||
---
|
||||
|
||||
### Textabschnitt (abstrakt)
|
||||
|
||||
**Zweck**: Abstrakte Basisklasse für Textinhalte, die mit anderen Modellen verknüpft sind.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `abschnitttyp` (ForeignKey → AbschnittTyp, on_delete=PROTECT, optional)
|
||||
- `inhalt` (TextField, blank=True, null=True): Der Textinhalt
|
||||
- `order` (PositiveIntegerField, default=0): Sortierreihenfolge
|
||||
|
||||
**Besonderheiten**:
|
||||
- Abstrakte Klasse (wird nicht direkt in der Datenbank gespeichert)
|
||||
- Wird von anderen Modellen geerbt: `VorgabeLangtext`, `VorgabeKurztext`, `Geltungsbereich`, `Einleitung`, `Referenzerklaerung`, `Stichworterklaerung`, `RollenBeschreibung`
|
||||
|
||||
**Meta**:
|
||||
- `abstract = True`
|
||||
- `verbose_name = "Abschnitt"`
|
||||
- `verbose_name_plural = "Abschnitte"`
|
||||
|
||||
---
|
||||
|
||||
## App: referenzen
|
||||
|
||||
Modelle für die Verwaltung von Referenzen und Verweisen auf externe Standards.
|
||||
|
||||
### Referenz (MPTT-Tree)
|
||||
|
||||
**Zweck**: Hierarchische Verwaltung von Referenzen und externen Normen (z. B. ISO-Standards, Gesetze, übergeordnete Vorgaben).
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `id` (AutoField, **PRIMARY KEY**)
|
||||
- `name_nummer` (CharField, max_length=100): Nummer/Kennung der Referenz (z. B. "ISO 27001")
|
||||
- `name_text` (CharField, max_length=255, blank=True): Ausführlicher Name/Beschreibung
|
||||
- `oberreferenz` (TreeForeignKey zu self, optional): Parent-Referenz für Hierarchien
|
||||
- `url` (URLField, blank=True): Link zur Referenz
|
||||
|
||||
**Beziehungen**:
|
||||
- Many-to-Many mit `Vorgabe`
|
||||
- MPTT Tree-Struktur für hierarchische Referenzen
|
||||
|
||||
**Wichtige Methoden**:
|
||||
|
||||
- `Path()` → str
|
||||
- Gibt die vollständige Pfad-Hierarchie als String zurück
|
||||
- Format: "Referenz → Subreferenz → Unterreferenz (Beschreibung)"
|
||||
- Beispiel: "ISO → 27000 → 27001 (Information Security Management)"
|
||||
|
||||
**Besonderheiten**:
|
||||
- Verwendet MPPT (Modified Preorder Tree Traversal) für Baumoperationen
|
||||
- `get_ancestors(include_self=True)`: Gibt alle Vorfahren zurück
|
||||
- `unterreferenzen`: Related_name für Kindreferenzen
|
||||
- Sortierung: Nach `name_nummer`
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name_plural = "Referenzen"`
|
||||
- **MPTTMeta**:
|
||||
- `parent_attr = 'oberreferenz'`
|
||||
- `order_insertion_by = ['name_nummer']`
|
||||
|
||||
---
|
||||
|
||||
### Referenzerklaerung
|
||||
|
||||
**Zweck**: Speichert Erklärungen und zusätzliche Informationen zu einer Referenz.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `erklaerung` (ForeignKey → Referenz, on_delete=CASCADE): Referenz zur Referenz
|
||||
- Erbt von `Textabschnitt`:
|
||||
- `abschnitttyp` (ForeignKey → AbschnittTyp, optional)
|
||||
- `inhalt` (TextField, blank=True, null=True)
|
||||
- `order` (PositiveIntegerField, default=0)
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name = "Erklärung"`
|
||||
- `verbose_name_plural = "Erklärungen"`
|
||||
|
||||
---
|
||||
|
||||
## App: stichworte
|
||||
|
||||
Modelle für die Verwaltung von Stichworte und Tags.
|
||||
|
||||
### Stichwort
|
||||
|
||||
**Zweck**: Einfache Tag/Keyword-Modell zur Kategorisierung von Vorgaben.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `stichwort` (CharField, max_length=50, **PRIMARY KEY**): Das Stichwort
|
||||
|
||||
**Beziehungen**:
|
||||
- Many-to-Many mit `Vorgabe`
|
||||
|
||||
**Besonderheiten**:
|
||||
- `__str__()` gibt das Stichwort zurück
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name_plural = "Stichworte"`
|
||||
|
||||
---
|
||||
|
||||
### Stichworterklaerung
|
||||
|
||||
**Zweck**: Speichert Erklärungen zu Stichworten.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `erklaerung` (ForeignKey → Stichwort, on_delete=CASCADE): Referenz zum Stichwort
|
||||
- Erbt von `Textabschnitt`:
|
||||
- `abschnitttyp` (ForeignKey → AbschnittTyp, optional)
|
||||
- `inhalt` (TextField, blank=True, null=True)
|
||||
- `order` (PositiveIntegerField, default=0)
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name = "Erklärung"`
|
||||
- `verbose_name_plural = "Erklärungen"`
|
||||
|
||||
---
|
||||
|
||||
## App: rollen
|
||||
|
||||
Modelle für die Verwaltung von Rollen und deren Beschreibungen.
|
||||
|
||||
### Rolle
|
||||
|
||||
**Zweck**: Definiert Rollen/Positionen im Unternehmen (z. B. "Geschäftsleiter", "IT-Sicherheit", "Datenschutzbeauftragter").
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `name` (CharField, max_length=100, **PRIMARY KEY**): Name der Rolle
|
||||
|
||||
**Beziehungen**:
|
||||
- Many-to-Many mit `Vorgabe` (über `relevanz`)
|
||||
|
||||
**Besonderheiten**:
|
||||
- `__str__()` gibt den Namen zurück
|
||||
- Wird verwendet, um Rollen zu markieren, die von einer Vorgabe betroffen sind
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name_plural = "Rollen"`
|
||||
|
||||
---
|
||||
|
||||
### RollenBeschreibung
|
||||
|
||||
**Zweck**: Speichert detaillierte Beschreibungen und Informationen zu einer Rolle.
|
||||
|
||||
**Wichtige Felder**:
|
||||
- `abschnitt` (ForeignKey → Rolle, on_delete=CASCADE): Referenz zur Rolle
|
||||
- Erbt von `Textabschnitt`:
|
||||
- `abschnitttyp` (ForeignKey → AbschnittTyp, optional)
|
||||
- `inhalt` (TextField, blank=True, null=True)
|
||||
- `order` (PositiveIntegerField, default=0)
|
||||
|
||||
**Meta**:
|
||||
- `verbose_name = "Rollenbeschreibungs-Abschnitt"`
|
||||
- `verbose_name_plural = "Rollenbeschreibung"`
|
||||
|
||||
---
|
||||
|
||||
## Allgemeine Hinweise zur Modellverwaltung
|
||||
|
||||
### Primärschlüssel-Strategie
|
||||
- Viele Modelle verwenden CharField-basierte Primärschlüssel (`name`, `nummer`, `stichwort`)
|
||||
- Dies ermöglicht direkte Verwendung von Strings als Identifikatoren
|
||||
- Vorteil: Lesbarkeit; Nachteil: Umbenennungen sind kritisch
|
||||
|
||||
### On-Delete-Strategien
|
||||
- **PROTECT**: Verwendet für wichtige Beziehungen (z. B. Dokumententyp, Thema, AbschnittTyp)
|
||||
- Verhindert versehentliches Löschen von Daten, auf die verwiesen wird
|
||||
- **CASCADE**: Verwendet für Unterkomponenten (z. B. Vorgabe → Dokument)
|
||||
- Löscht abhängige Datensätze automatisch
|
||||
- **SET_NULL**: Nur bei optionalen Referenzen (z. B. Oberreferenz in Referenz-Tree)
|
||||
|
||||
### Validierungsmechanismen
|
||||
- **Vorgabe.clean()**: Validiert Gültigkeitszeiträume
|
||||
- **Vorgabe.find_conflicts()**: Prüft zeitliche Überschneidungen
|
||||
- Wird von Django-Admin automatisch aufgerufen vor dem Speichern
|
||||
|
||||
### MPTT (Modified Preorder Tree Traversal)
|
||||
- Verwendet in `Referenz` für hierarchische Strukturen
|
||||
- Ermöglicht effiziente Abfragen von Vorfahren und Nachkommen
|
||||
- Zusätzliche Datenbank-Felder für Tree-Management (automatisch verwaltet)
|
||||
|
||||
### Textabschnitt-Vererbung
|
||||
- Mehrere Modelle erben von `Textabschnitt`
|
||||
- Wird verwendet für Lang-/Kurztexte, Erklärungen, Beschreibungen
|
||||
- `order`-Feld ermöglicht Sortierung mehrerer Abschnitte
|
||||
|
||||
### Datumsverwaltung
|
||||
- `gueltigkeit_von`: Immer erforderlich für Vorgaben
|
||||
- `gueltigkeit_bis`: Optional; `None` bedeutet unbegrenzte Gültigkeit
|
||||
- `_date_ranges_intersect()` prüft korrekt auf Überschneidungen mit None-Werten
|
||||
|
||||
### Many-to-Many-Beziehungen
|
||||
- Vielfach verwendet für flexible Zuordnungen (Autoren, Stichworte, Rollen, Referenzen)
|
||||
- `related_name`-Attribute ermöglichen rückwärts Zugriff
|
||||
- Beispiel: `dokument.vorgaben.all()`, `person.verfasste_dokumente.all()`
|
||||
|
||||
---
|
||||
|
||||
## Zusammenfassung der Beziehungen
|
||||
|
||||
```
|
||||
Dokumententyp ← Dokument
|
||||
Person ← Dokument (Autoren/Prüfer)
|
||||
Dokument → Vorgabe (1-to-Many)
|
||||
Dokument → Geltungsbereich (1-to-Many)
|
||||
Dokument → Einleitung (1-to-Many)
|
||||
Dokument → Changelog (1-to-Many)
|
||||
|
||||
Thema ← Vorgabe
|
||||
Vorgabe → VorgabeLangtext (1-to-Many)
|
||||
Vorgabe → VorgabeKurztext (1-to-Many)
|
||||
Vorgabe → Checklistenfrage (1-to-Many)
|
||||
Vorgabe ← Referenz (Many-to-Many)
|
||||
Vorgabe ← Stichwort (Many-to-Many)
|
||||
Vorgabe ← Rolle (Many-to-Many)
|
||||
|
||||
Referenz → Referenz (Hierarchie via MPPT)
|
||||
Referenz → Referenzerklaerung (1-to-Many)
|
||||
|
||||
Stichwort → Stichworterklaerung (1-to-Many)
|
||||
|
||||
Rolle → RollenBeschreibung (1-to-Many)
|
||||
|
||||
AbschnittTyp ← Textabschnitt (von verschiedenen Modellen geerbt)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Entwicklungsrichtlinien
|
||||
|
||||
- Alle Modelle sollten aussagekräftige `__str__()`-Methoden haben
|
||||
- `verbose_name` und `verbose_name_plural` sollten auf Deutsch sein (für Django-Admin)
|
||||
- Validierungslogik (z. B. `clean()`) sollte implementiert werden für komplexe Business-Logic
|
||||
- Related-Names sollten aussagekräftig und konsistent sein
|
||||
- Textinhalte sollten die `Textabschnitt`-Basisklasse erben
|
||||
- Datumsverwaltung: Immer auf None-Werte bei `gueltigkeit_bis` achten, wenn Vorgaben noch aktiv sind.
|
||||
92
Documentation/modelle_dokumente.md
Normal file
92
Documentation/modelle_dokumente.md
Normal file
@@ -0,0 +1,92 @@
|
||||
# Modelle (App: dokumente)
|
||||
|
||||
Kurzbeschreibungen der Modelle in dokumente/models.py.
|
||||
|
||||
## Dokumententyp
|
||||
- Zweck: Kategorisierung von Dokumenten (z. B. Richtlinie, Verfahren).
|
||||
- Wichtige Felder: `name` (CharField, PK), `verantwortliche_ve` (CharField).
|
||||
- Besonderheiten: `__str__()` gibt `name` zurück.
|
||||
- Meta: `verbose_name` und `verbose_name_plural` gesetzt.
|
||||
|
||||
## Person
|
||||
- Zweck: Repräsentiert Personen (Autoren, Prüfer).
|
||||
- Wichtige Felder: `name` (CharField, PK), `funktion` (CharField).
|
||||
- Beziehungen: Many-to-many mit Dokument über `autoren` und `pruefende`.
|
||||
- Besonderheiten: `__str__()` gibt `name` zurück; `ordering = ['name']`.
|
||||
- Meta: `verbose_name_plural = "Personen"`.
|
||||
|
||||
## Thema
|
||||
- Zweck: Thematische Einordnung von Vorgaben.
|
||||
- Wichtige Felder: `name` (CharField, PK), `erklaerung` (TextField, optional).
|
||||
- Besonderheiten: `__str__()` gibt `name` zurück.
|
||||
|
||||
## Dokument
|
||||
- Zweck: Hauptobjekt; ein einzelnes Dokument mit Metadaten.
|
||||
- Wichtige Felder:
|
||||
- `nummer` (CharField, PK)
|
||||
- `dokumententyp` (FK → Dokumententyp, on_delete=PROTECT)
|
||||
- `name` (CharField)
|
||||
- `autoren`, `pruefende` (ManyToManyField → Person)
|
||||
- `gueltigkeit_von`, `gueltigkeit_bis` (DateField, optional)
|
||||
- `aktiv` (BooleanField)
|
||||
- `signatur_cso`, `anhaenge` (Metadaten)
|
||||
- Besonderheiten: `__str__()` formatiert als "nummer – name".
|
||||
- Meta: `verbose_name` / `verbose_name_plural`.
|
||||
|
||||
## Vorgabe
|
||||
- Zweck: Einzelne Vorgabe / Anforderung innerhalb eines Dokuments.
|
||||
- Wichtige Felder:
|
||||
- `order` (IntegerField) — Sortierreihenfolge
|
||||
- `nummer` (IntegerField) — Nummer innerhalb Thema/Dokument
|
||||
- `dokument` (FK → Dokument, CASCADE, related_name='vorgaben')
|
||||
- `thema` (FK → Thema, PROTECT)
|
||||
- `titel` (CharField)
|
||||
- `referenzen` (M2M → Referenz, optional)
|
||||
- `stichworte` (M2M → Stichwort, optional)
|
||||
- `relevanz` (M2M → Rolle, optional)
|
||||
- `gueltigkeit_von`, `gueltigkeit_bis` (Datum/Felder)
|
||||
- Beziehungen: zu Dokument, Thema, Referenzen, Stichworte, Rollen.
|
||||
- Wichtige Methoden:
|
||||
- `Vorgabennummer()` — generiert eine lesbare Kennung (z. B. "DOK. T. N").
|
||||
- `get_status(check_date, verbose)` — liefert "future", "active" oder "expired" oder eine deutsche Statusbeschreibung, abhängig von Gültigkeitsdaten.
|
||||
- `sanity_check_vorgaben()` (static) — findet Konflikte zwischen Vorgaben mit gleicher Nummer/Thema/Dokument, deren Zeiträume sich überschneiden.
|
||||
- `clean()` — ruft `find_conflicts()` auf und wirft ValidationError bei Konflikten.
|
||||
- `find_conflicts()` — prüft Konflikte mit bestehenden Vorgaben (ohne sich selbst).
|
||||
- `_date_ranges_intersect(...)` (static) — prüft, ob sich zwei Datumsbereiche überschneiden (None = offen).
|
||||
- Besonderheiten: `__str__()` gibt "Vorgabennummer: titel" zurück.
|
||||
- Meta: `ordering = ['order']`, `verbose_name_plural = "Vorgaben"`.
|
||||
|
||||
## VorgabeLangtext, VorgabeKurztext
|
||||
- Zweck: Textabschnitts-Modelle, erben von `Textabschnitt` (aus abschnitte.models).
|
||||
- Wichtige Felder: je ein FK `abschnitt` → Vorgabe.
|
||||
- Besonderheit: konkrete Untertypen für Lang- und Kurztexte; Meta-`verbose_name` gesetzt.
|
||||
|
||||
## Geltungsbereich, Einleitung
|
||||
- Zweck: Dokumentbezogene Textabschnitte (erben von `Textabschnitt`).
|
||||
- Wichtige Felder: FK zum `Dokument` (`geltungsbereich` bzw. `einleitung`).
|
||||
- Meta: `verbose_name`/`verbose_name_plural` gesetzt.
|
||||
|
||||
## Checklistenfrage
|
||||
- Zweck: Einzelne Frage für Checklisten zu einer Vorgabe.
|
||||
- Wichtige Felder: `vorgabe` (FK → Vorgabe, related_name="checklistenfragen"), `frage` (CharField).
|
||||
- Besonderheiten: `__str__()` gibt `frage` zurück.
|
||||
|
||||
## VorgabenTable
|
||||
- Zweck: Proxy-Modell für Vorgabe zur Darstellung (Tabellenansicht).
|
||||
- Besonderheiten: kein eigenes Schema; nur Meta-Attribute (`proxy = True`, `verbose_name`).
|
||||
|
||||
## Changelog
|
||||
- Zweck: Änderungsverzeichnis-Eintrag für ein Dokument.
|
||||
- Wichtige Felder:
|
||||
- `dokument` (FK → Dokument, related_name='changelog')
|
||||
- `autoren` (M2M → Person)
|
||||
- `datum` (DateField)
|
||||
- `aenderung` (TextField)
|
||||
- Besonderheiten: `__str__()` formatiert als "datum – dokumentnummer".
|
||||
- Meta: `verbose_name` / `verbose_name_plural`.
|
||||
|
||||
Hinweise zur Pflege
|
||||
- Wichtige Relationen nutzen häufig on_delete=PROTECT, um versehentliche Löschungen zu vermeiden.
|
||||
- Viele Modelle haben CharField-Primärschlüssel (z. B. `nummer`, `name`).
|
||||
- Validierungslogik für zeitliche Konflikte ist in Vorgabe implementiert (clean / find_conflicts).
|
||||
- Textabschnitt-Modelle erben Verhalten aus `abschnitte.models.Textabschnitt` — dort sind Anzeige- und Inhaltsregeln definiert.
|
||||
1599
R0066.json
Normal file
1599
R0066.json
Normal file
File diff suppressed because it is too large
Load Diff
@@ -1 +1,6 @@
|
||||
# VDeployment2
|
||||
# vgui-cicd
|
||||
|
||||
There are examples for importing text in the "Documentation"-directory. Actual documentation follows.
|
||||
|
||||
Documentation on Confluence so far.
|
||||
This commit should be signed.
|
||||
|
||||
431
Test Suite-DE.md
Normal file
431
Test Suite-DE.md
Normal file
@@ -0,0 +1,431 @@
|
||||
# Test-Suite Dokumentation
|
||||
|
||||
Dieses Dokument bietet einen umfassenden Überblick über alle Tests im vgui-cicd Django-Projekt und beschreibt, was jeder Test tut und wie er funktioniert.
|
||||
|
||||
## Inhaltsverzeichnis
|
||||
|
||||
- [abschnitte App Tests](#abschnitte-app-tests)
|
||||
- [dokumente App Tests](#dokumente-app-tests)
|
||||
- [pages App Tests](#pages-app-tests)
|
||||
- [referenzen App Tests](#referenzen-app-tests)
|
||||
- [rollen App Tests](#rollen-app-tests)
|
||||
- [stichworte App Tests](#stichworte-app-tests)
|
||||
|
||||
---
|
||||
|
||||
## abschnitte App Tests
|
||||
|
||||
Die abschnitte App enthält 33 Tests, die Modelle, Utility-Funktionen, Diagram-Caching, Management-Befehle und Sicherheit abdecken.
|
||||
|
||||
### Modell-Tests
|
||||
|
||||
#### AbschnittTypModelTest
|
||||
- **test_abschnitttyp_creation**: Überprüft, dass AbschnittTyp-Objekte korrekt mit den erwarteten Feldwerten erstellt werden
|
||||
- **test_abschnitttyp_primary_key**: Bestätigt, dass das `abschnitttyp`-Feld als Primärschlüssel dient
|
||||
- **test_abschnitttyp_str**: Testet die String-Repräsentation, die den `abschnitttyp`-Wert zurückgibt
|
||||
- **test_abschnitttyp_verbose_name_plural**: Validiert den korrekt gesetzten verbose_name_plural
|
||||
- **test_create_multiple_abschnitttypen**: Stellt sicher, dass mehrere AbschnittTyp-Objekte mit verschiedenen Typen erstellt werden können
|
||||
|
||||
#### TextabschnittModelTest
|
||||
- **test_textabschnitt_creation**: Testet, dass Textabschnitt über das konkrete Modell instanziiert werden kann
|
||||
- **test_textabschnitt_default_order**: Überprüft, dass das `order`-Feld standardmäßig 0 ist
|
||||
- **test_textabschnitt_ordering**: Testet, dass Textabschnitt-Objekte nach dem `order`-Feld sortiert werden können
|
||||
- **test_textabschnitt_blank_fields**: Bestätigt, dass `abschnitttyp`- und `inhalt`-Felder leer/null sein können
|
||||
- **test_textabschnitt_foreign_key_protection**: Testet, dass AbschnittTyp-Objekte vor Löschung geschützt sind, wenn sie von Textabschnitt referenziert werden
|
||||
|
||||
### Utility-Funktions-Tests
|
||||
|
||||
#### MdTableToHtmlTest
|
||||
- **test_simple_table**: Konvertiert eine einfache Markdown-Tabelle mit Überschriften und einer Zeile nach HTML
|
||||
- **test_table_with_multiple_rows**: Testet die Konvertierung von Tabellen mit mehreren Datenzeilen
|
||||
- **test_table_with_empty_cells**: Verarbeitet Tabellen mit leeren Zellen in den Daten
|
||||
- **test_table_with_spaces**: Verarbeitet Tabellen mit zusätzlichen Leerzeichen in Zellen
|
||||
- **test_table_empty_string**: Löst ValueError für leere Eingabe-Strings aus
|
||||
- **test_table_only_whitespace**: Löst ValueError für Strings aus, die nur Leerzeichen enthalten
|
||||
- **test_table_insufficient_lines**: Löst ValueError aus, wenn die Eingabe weniger als 2 Zeilen hat
|
||||
|
||||
#### RenderTextabschnitteTest
|
||||
- **test_render_empty_queryset**: Gibt leeren String für leere Querysets zurück
|
||||
- **test_render_multiple_abschnitte**: Rendert mehrere Textabschnitte in korrekter Reihenfolge
|
||||
- **test_render_text_markdown**: Konvertiert Klartext mit Markdown-Formatierung
|
||||
- **test_render_ordered_list**: Rendert geordnete Listen korrekt
|
||||
- **test_render_unordered_list**: Rendert ungeordnete Listen korrekt
|
||||
- **test_render_code_block**: Rendert Code-Blöcke mit korrekter Syntax-Hervorhebung
|
||||
- **test_render_table**: Konvertiert Markdown-Tabellen mit md_table_to_html nach HTML
|
||||
- **test_render_diagram_success**: Testet die Diagramm-Generierung mit erfolgreichem Caching
|
||||
- **test_render_diagram_error**: Behandelt Diagramm-Generierungsfehler angemessen
|
||||
- **test_render_diagram_with_options**: Testet das Diagramm-Rendering mit benutzerdefinierten Optionen
|
||||
- **test_render_text_with_footnotes**: Verarbeitet Text, der Fußnoten enthält
|
||||
- **test_render_abschnitt_without_type**: Behandelt Textabschnitte ohne AbschnittTyp
|
||||
- **test_render_abschnitt_with_empty_content**: Behandelt Textabschnitte mit leerem Inhalt
|
||||
- **test_render_textabschnitte_xss_prevention**: Überprüft, dass bösartiger HTML-Code und Skript-Tags aus gerenderten Inhalten bereinigt werden, um XSS-Angriffe zu verhindern
|
||||
|
||||
### Diagram-Caching-Tests
|
||||
|
||||
#### DiagramCacheTest
|
||||
- **test_compute_hash**: Generiert konsistente SHA256-Hashes für dieselbe Eingabe
|
||||
- **test_get_cache_path**: Erstellt korrekte Cache-Dateipfade basierend auf Hash und Typ
|
||||
- **test_get_cached_diagram_hit**: Gibt zwischengespeichertes Diagramm zurück bei Cache-Treffer
|
||||
- **test_get_cached_diagram_miss**: Generiert neues Diagramm bei Cache-Fehltreffer
|
||||
- **test_get_cached_diagram_request_error**: Behandelt und löst Request-Fehler korrekt aus
|
||||
- **test_clear_cache_specific_type**: Löscht Cache-Dateien für spezifische Diagrammtypen
|
||||
- **test_clear_cache_all_types**: Löscht alle Cache-Dateien, wenn kein Typ angegeben ist
|
||||
|
||||
### Management-Befehl-Tests
|
||||
|
||||
#### ClearDiagramCacheCommandTest
|
||||
- **test_command_without_type**: Testet die Ausführung des Management-Befehls ohne Angabe des Typs
|
||||
- **test_command_with_type**: Testet die Ausführung des Management-Befehls mit spezifischem Diagrammtyp
|
||||
|
||||
### Integrations-Tests
|
||||
|
||||
#### IntegrationTest
|
||||
- **test_textabschnitt_inheritance**: Überprüft, dass VorgabeLangtext Textabschnitt-Felder korrekt erbt
|
||||
- **test_render_vorgabe_langtext**: Testet das Rendern von VorgabeLangtext durch render_textabschnitte
|
||||
|
||||
---
|
||||
|
||||
## dokumente App Tests
|
||||
|
||||
Die dokumente App enthält 121 Tests und ist damit die umfassendste Test-Suite, die alle Modelle, Views, URLs, Geschäftslogik und Kommentarfunktionalität mit XSS-Schutz abdeckt.
|
||||
|
||||
### Modell-Tests
|
||||
|
||||
#### DokumententypModelTest
|
||||
- **test_dokumententyp_creation**: Überprüft die Erstellung von Dokumententyp mit korrekten Feldwerten
|
||||
- **test_dokumententyp_str**: Testet die String-Repräsentation, die das `typ`-Feld zurückgibt
|
||||
- **test_dokumententyp_verbose_name**: Validiert den korrekt gesetzten verbose_name
|
||||
|
||||
#### PersonModelTest
|
||||
- **test_person_creation**: Testet die Erstellung von Person-Objekten mit Name und optionalem Titel
|
||||
- **test_person_str**: Überprüft, dass die String-Repräsentation Titel und Namen enthält
|
||||
- **test_person_verbose_name_plural**: Testet die Konfiguration von verbose_name_plural
|
||||
|
||||
#### ThemaModelTest
|
||||
- **test_thema_creation**: Testet die Erstellung von Thema mit Name und optionaler Erklärung
|
||||
- **test_thema_str**: Überprüft, dass die String-Repräsentation den Themennamen zurückgibt
|
||||
- **test_thema_blank_erklaerung**: Bestätigt, dass das `erklaerung`-Feld leer sein kann
|
||||
|
||||
#### DokumentModelTest
|
||||
- **test_dokument_creation**: Testet die Erstellung von Dokument mit erforderlichen und optionalen Feldern
|
||||
- **test_dokument_str**: Überprüft, dass die String-Repräsentation den Dokumenttitel zurückgibt
|
||||
- **test_dokument_optional_fields**: Testet, dass optionale Felder None oder leer sein können
|
||||
- **test_dokument_many_to_many_relationships**: Überprüft Many-to-Many-Beziehungen mit Personen und Themen
|
||||
|
||||
#### VorgabeModelTest
|
||||
- **test_vorgabe_creation**: Testet die Erstellung von Vorgabe mit allen erforderlichen Feldern
|
||||
- **test_vorgabe_str**: Überprüft, dass die String-Repräsentation die Vorgabennummer zurückgibt
|
||||
- **test_vorgabennummer**: Testet die automatische Generierung des Vorgabennummer-Formats
|
||||
- **test_get_status_active**: Testet die Statusbestimmung für aktuelle aktive Vorgaben
|
||||
- **test_get_status_expired**: Testet die Statusbestimmung für abgelaufene Vorgaben
|
||||
- **test_get_status_future**: Testet die Statusbestimmung für zukünftige Vorgaben
|
||||
- **test_get_status_with_custom_check_date**: Testet den Status mit benutzerdefiniertem Prüfdatum
|
||||
- **test_get_status_verbose**: Testet die ausführliche Statusausgabe
|
||||
|
||||
#### ChangelogModelTest
|
||||
- **test_changelog_creation**: Testet die Erstellung von Changelog mit Version, Datum und Beschreibung
|
||||
- **test_changelog_str**: Überprüft, dass die String-Repräsentation Version und Datum enthält
|
||||
|
||||
#### ChecklistenfrageModelTest
|
||||
- **test_checklistenfrage_creation**: Testet die Erstellung von Checklistenfrage mit Frage und optionaler Antwort
|
||||
- **test_checklistenfrage_str**: Überprüft, dass die String-Repräsentation lange Fragen kürzt
|
||||
- **test_checklistenfrage_related_name**: Testet die umgekehrte Beziehung von Vorgabe
|
||||
|
||||
#### VorgabeCommentModelTest
|
||||
- **test_comment_creation**: Testet die Erstellung von VorgabeComment mit Vorgabe, Benutzer und Text
|
||||
- **test_comment_str**: Überprüft, dass die String-Repräsentation Benutzername und Vorgabennummer enthält
|
||||
- **test_comment_related_name**: Testet die umgekehrte Beziehung von Vorgabe
|
||||
- **test_comment_ordering**: Testet, dass Kommentare nach created_at absteigend sortiert sind (neueste zuerst)
|
||||
- **test_comment_timestamps_auto_update**: Testet, dass sich updated_at ändert, wenn ein Kommentar geändert wird
|
||||
- **test_multiple_users_can_comment**: Testet, dass mehrere Benutzer zur selben Vorgabe kommentieren können
|
||||
|
||||
### Text-Abschnitt-Tests
|
||||
|
||||
#### DokumentTextAbschnitteTest
|
||||
- **test_einleitung_creation**: Testet die Erstellung von Einleitung und Vererbung von Textabschnitt
|
||||
- **test_geltungsbereich_creation**: Testet die Erstellung von Geltungsbereich und Vererbung
|
||||
|
||||
#### VorgabeTextAbschnitteTest
|
||||
- **test_vorgabe_kurztext_creation**: Testet die Erstellung von VorgabeKurztext und Vererbung
|
||||
- **test_vorgabe_langtext_creation**: Testet die Erstellung von VorgabeLangtext und Vererbung
|
||||
|
||||
### Sanity-Check-Tests
|
||||
|
||||
#### VorgabeSanityCheckTest
|
||||
- **test_date_ranges_intersect_no_overlap**: Testet Datumsüberschneidung mit nicht überlappenden Bereichen
|
||||
- **test_date_ranges_intersect_with_overlap**: Testet Datumsüberschneidung mit überlappenden Bereichen
|
||||
- **test_date_ranges_intersect_identical_ranges**: Testet Datumsüberschneidung mit identischen Bereichen
|
||||
- **test_date_ranges_intersect_with_none_end_date**: Testet Überschneidung mit offenen Endbereichen
|
||||
- **test_date_ranges_intersect_both_none_end_dates**: Testet Überschneidung mit zwei offenen Endbereichen
|
||||
- **test_check_vorgabe_conflicts_utility**: Testet die Utility-Funktion zur Konflikterkennung
|
||||
- **test_find_conflicts_no_conflicts**: Testet die Konflikterkennung bei Vorgabe ohne Konflikte
|
||||
- **test_find_conflicts_with_conflicts**: Testet die Konflikterkennung mit konfliktbehafteten Vorgaben
|
||||
- **test_format_conflict_report_no_conflicts**: Testet die Konfliktbericht-Formatierung ohne Konflikte
|
||||
- **test_format_conflict_report_with_conflicts**: Testet die Konfliktbericht-Formatierung mit Konflikten
|
||||
- **test_sanity_check_vorgaben_no_conflicts**: Testet vollständigen Sanity-Check ohne Konflikte
|
||||
- **test_sanity_check_vorgaben_with_conflicts**: Testet vollständigen Sanity-Check mit Konflikten
|
||||
- **test_sanity_check_vorgaben_multiple_conflicts**: Testet Sanity-Check mit mehreren Konfliktgruppen
|
||||
- **test_vorgabe_clean_no_conflicts**: Testet Vorgabe.clean()-Methode ohne Konflikte
|
||||
- **test_vorgabe_clean_with_conflicts**: Testet, dass Vorgabe.clean() ValidationError bei Konflikten auslöst
|
||||
|
||||
### Management-Befehl-Tests
|
||||
|
||||
#### SanityCheckManagementCommandTest
|
||||
- **test_sanity_check_command_no_conflicts**: Testet Management-Befehlsausgabe ohne Konflikte
|
||||
- **test_sanity_check_command_with_conflicts**: Testet Management-Befehlsausgabe mit Konflikten
|
||||
|
||||
### URL-Pattern-Tests
|
||||
|
||||
#### URLPatternsTest
|
||||
- **test_standard_list_url_resolves**: Überprüft, dass standard_list URL zur korrekten View aufgelöst wird
|
||||
- **test_standard_detail_url_resolves**: Überprüft, dass standard_detail URL mit pk-Parameter aufgelöst wird
|
||||
- **test_standard_history_url_resolves**: Überprüft, dass standard_history URL mit check_date aufgelöst wird
|
||||
- **test_standard_checkliste_url_resolves**: Überprüft, dass standard_checkliste URL mit pk aufgelöst wird
|
||||
|
||||
### View-Tests
|
||||
|
||||
#### ViewsTestCase
|
||||
- **test_standard_list_view**: Testet, dass die Standard-Listen-View 200 zurückgibt und erwartete Inhalte enthält
|
||||
- **test_standard_detail_view**: Testet die Standard-Detail-View mit existierendem Dokument
|
||||
- **test_standard_detail_view_404**: Testet, dass die Standard-Detail-View 404 für nicht existierendes Dokument zurückgibt
|
||||
- **test_standard_history_view**: Testet die Standard-Detail-View mit historischem check_date-Parameter
|
||||
- **test_standard_checkliste_view**: Testet die Funktionalität der Checklisten-View
|
||||
|
||||
### JSON-Export-Tests
|
||||
|
||||
#### JSONExportManagementCommandTest
|
||||
- **test_export_json_command_to_file**: Testet, dass der export_json-Befehl JSON in die angegebene Datei ausgibt
|
||||
- **test_export_json_command_stdout**: Testet, dass der export_json-Befehl JSON an stdout ausgibt, wenn keine Datei angegeben ist
|
||||
- **test_export_json_command_inactive_documents**: Testet, dass der export_json-Befehl inaktive Dokumente herausfiltert
|
||||
- **test_export_json_command_empty_database**: Testet, dass der export_json-Befehl leere Datenbank angemessen behandelt
|
||||
|
||||
#### StandardJSONViewTest
|
||||
- **test_standard_json_view_success**: Testet, dass die standard_json-View korrektes JSON für existierendes Dokument zurückgibt
|
||||
- **test_standard_json_view_not_found**: Testet, dass die standard_json-View 404 für nicht existierendes Dokument zurückgibt
|
||||
- **test_standard_json_view_json_formatting**: Testet, dass die standard_json-View korrekt formatiertes JSON zurückgibt
|
||||
- **test_standard_json_view_null_dates**: Testet, dass die standard_json-View null-Datumfelder korrekt behandelt
|
||||
- **test_standard_json_view_empty_sections**: Testet, dass die standard_json-View leere Dokumentabschnitte behandelt
|
||||
|
||||
### Unvollständige Vorgaben Tests
|
||||
|
||||
#### IncompleteVorgabenTest
|
||||
- **test_incomplete_vorgaben_page_status**: Testet, dass die Seite erfolgreich lädt (200-Status)
|
||||
- **test_incomplete_vorgaben_staff_only**: Testet, dass Nicht-Staff-Benutzer zum Login weitergeleitet werden
|
||||
- **test_incomplete_vorgaben_page_content**: Testet, dass die Seite erwartete Überschriften und Struktur enthält
|
||||
- **test_navigation_link**: Testet, dass die Navigation einen Link zur unvollständigen Vorgaben-Seite enthält
|
||||
- **test_no_references_list**: Testet, dass Vorgaben ohne Referenzen korrekt aufgelistet werden
|
||||
- **test_no_stichworte_list**: Testet, dass Vorgaben ohne Stichworte korrekt aufgelistet werden
|
||||
- **test_no_text_list**: Testet, dass Vorgaben ohne Kurz- oder Langtext korrekt aufgelistet werden
|
||||
- **test_no_checklistenfragen_list**: Testet, dass Vorgaben ohne Checklistenfragen korrekt aufgelistet werden
|
||||
- **test_vorgabe_with_both_text_types**: Testet, dass Vorgabe mit beiden Texttypen als vollständig betrachtet wird
|
||||
- **test_vorgabe_with_langtext_only**: Testet, dass Vorgabe mit nur Langtext immer noch unvollständig für Text ist
|
||||
- **test_empty_lists_message**: Testet angemessene Nachrichten, wenn Listen leer sind
|
||||
- **test_badge_counts**: Testet, dass Badge-Zähler korrekt berechnet werden
|
||||
- **test_summary_section**: Testet, dass die Zusammenfassungssektion korrekte Zähler anzeigt
|
||||
- **test_vorgabe_links**: Testet, dass Vorgaben zu korrekten Admin-Seiten verlinken
|
||||
- **test_back_link**: Testet, dass der Zurück-Link zur Standardübersicht existiert
|
||||
|
||||
### Kommentar-Funktionalität Tests
|
||||
|
||||
#### GetVorgabeCommentsViewTest
|
||||
- **test_get_comments_requires_login**: Testet, dass anonyme Benutzer keine Kommentare sehen können und weitergeleitet werden
|
||||
- **test_regular_user_sees_only_own_comments**: Testet, dass normale Benutzer nur ihre eigenen Kommentare sehen
|
||||
- **test_staff_user_sees_all_comments**: Testet, dass Staff-Benutzer alle Kommentare sehen können
|
||||
- **test_get_comments_returns_404_for_nonexistent_vorgabe**: Testet 404-Antwort für nicht existierende Vorgabe
|
||||
- **test_comments_are_html_escaped**: Testet HTML-Escaping zur Verhinderung von XSS-Angriffen (z.B. `<script>`-Tags)
|
||||
- **test_line_breaks_preserved**: Testet, dass Zeilenumbrüche in `<br>`-Tags umgewandelt werden
|
||||
- **test_security_headers_present**: Testet, dass Content-Security-Policy und X-Content-Type-Options Header gesetzt sind
|
||||
|
||||
#### AddVorgabeCommentViewTest
|
||||
- **test_add_comment_requires_login**: Testet, dass anonyme Benutzer keine Kommentare hinzufügen können
|
||||
- **test_add_comment_requires_post**: Testet, dass nur POST-Methode erlaubt ist (405 für GET)
|
||||
- **test_add_comment_success**: Testet erfolgreiche Kommentarerstellung mit gültigen Daten
|
||||
- **test_add_empty_comment_fails**: Testet, dass leere Kommentare mit 400-Fehler abgelehnt werden
|
||||
- **test_add_whitespace_only_comment_fails**: Testet, dass Kommentare nur mit Leerzeichen abgelehnt werden
|
||||
- **test_add_too_long_comment_fails**: Testet, dass Kommentare über 2000 Zeichen abgelehnt werden
|
||||
- **test_add_comment_xss_script_tag_blocked**: Testet, dass Kommentare mit `<script>`-Tags blockiert werden
|
||||
- **test_add_comment_xss_javascript_protocol_blocked**: Testet, dass `javascript:`-Protokoll blockiert wird
|
||||
- **test_add_comment_xss_event_handlers_blocked**: Testet, dass Event-Handler (onload, onerror, onclick, onmouseover) blockiert werden
|
||||
- **test_add_comment_invalid_json_fails**: Testet, dass ungültige JSON-Payloads abgelehnt werden
|
||||
- **test_add_comment_nonexistent_vorgabe_fails**: Testet 404-Antwort für nicht existierende Vorgabe
|
||||
- **test_add_comment_security_headers**: Testet, dass Sicherheits-Header in Antworten vorhanden sind
|
||||
|
||||
#### DeleteVorgabeCommentViewTest
|
||||
- **test_delete_comment_requires_login**: Testet, dass anonyme Benutzer keine Kommentare löschen können
|
||||
- **test_delete_comment_requires_post**: Testet, dass nur POST-Methode erlaubt ist (405 für GET)
|
||||
- **test_user_can_delete_own_comment**: Testet, dass Benutzer ihre eigenen Kommentare löschen können
|
||||
- **test_user_cannot_delete_other_users_comment**: Testet, dass Benutzer keine Kommentare anderer löschen können (403 Forbidden)
|
||||
- **test_staff_can_delete_any_comment**: Testet, dass Staff-Benutzer jeden Kommentar löschen können
|
||||
- **test_delete_nonexistent_comment_returns_404**: Testet 404-Antwort für nicht existierenden Kommentar
|
||||
- **test_delete_comment_security_headers**: Testet, dass Sicherheits-Header in Antworten vorhanden sind
|
||||
|
||||
---
|
||||
|
||||
## pages App Tests
|
||||
|
||||
Die pages App enthält 4 Tests, die sich auf die Suchfunktionalität und Validierung konzentrieren.
|
||||
|
||||
### ViewsTestCase
|
||||
- **test_search_view_get**: Testet GET-Anfrage an die Search-View gibt 200-Status zurück
|
||||
- **test_search_view_post_with_query**: Testet POST-Anfrage mit Query gibt Ergebnisse zurück
|
||||
- **test_search_view_post_empty_query**: Testet POST-Anfrage mit leerer Query zeigt Validierungsfehler
|
||||
- **test_search_view_post_no_query**: Testet POST-Anfrage ohne Query-Parameter zeigt Validierungsfehler
|
||||
|
||||
---
|
||||
|
||||
## referenzen App Tests
|
||||
|
||||
Die referenzen App enthält 18 Tests, die sich auf MPTT-Hierarchiefunktionalität und Modellbeziehungen konzentrieren.
|
||||
|
||||
### Modell-Tests
|
||||
|
||||
#### ReferenzModelTest
|
||||
- **test_referenz_creation**: Testet die Erstellung von Referenz mit erforderlichen Feldern
|
||||
- **test_referenz_str**: Testet die String-Repräsentation gibt den Referenztext zurück
|
||||
- **test_referenz_ordering**: Testet die Standard-Sortierung nach `order`-Feld
|
||||
- **test_referenz_optional_fields**: Testet, dass optionale Felder leer sein können
|
||||
|
||||
#### ReferenzerklaerungModelTest
|
||||
- **test_referenzerklaerung_creation**: Testet die Erstellung von Referenzerklaerung mit Referenz und Erklärung
|
||||
- **test_referenzerklaerung_str**: Testet die String-Repräsentation enthält Referenz und Erklärungsvorschau
|
||||
- **test_referenzerklaerung_ordering**: Testet die Standard-Sortierung nach `order`-Feld
|
||||
- **test_referenzerklaerung_optional_explanation**: Testet, dass das Erklärungsfeld leer sein kann
|
||||
|
||||
### Hierarchie-Tests
|
||||
|
||||
#### ReferenzHierarchyTest
|
||||
- **test_hierarchy_relationships**: Testet Eltern-Kind-Beziehungen im MPTT-Baum
|
||||
- **test_get_root**: Testet das Abrufen des Wurzelknotens einer Hierarchie
|
||||
- **test_get_children**: Testet das Abrufen direkter Kinder eines Knotens
|
||||
- **test_get_descendants**: Testet das Abrufen aller Nachkommen eines Knotens
|
||||
- **test_get_ancestors**: Testet das Abrufen aller Vorfahren eines Knotens
|
||||
- **test_get_ancestors_include_self**: Testet das Abrufen von Vorfahren einschließlich des Knotens selbst
|
||||
- **test_is_leaf_node**: Testet die Erkennung von Blattknoten
|
||||
- **test_is_root_node**: Testet die Erkennung von Wurzelknoten
|
||||
- **test_tree_ordering**: Testet die Baum-Sortierung mit mehreren Ebenen
|
||||
- **test_move_node**: Testet das Verschieben von Knoten innerhalb der Baumstruktur
|
||||
|
||||
---
|
||||
|
||||
## rollen App Tests
|
||||
|
||||
Die rollen App enthält 18 Tests, die Rollenmodelle und ihre Beziehungen zu Dokumentabschnitten abdecken.
|
||||
|
||||
### Modell-Tests
|
||||
|
||||
#### RolleModelTest
|
||||
- **test_rolle_creation**: Testet die Erstellung von Rolle mit Name und optionaler Beschreibung
|
||||
- **test_rolle_str**: Testet die String-Repräsentation gibt den Rollennamen zurück
|
||||
- **test_rolle_ordering**: Testet die Standard-Sortierung nach `order`-Feld
|
||||
- **test_rolle_unique_name**: Testet, dass Rollennamen einzigartig sein müssen
|
||||
- **test_rolle_optional_beschreibung**: Testet, dass das Beschreibungsfeld leer sein kann
|
||||
|
||||
#### RollenBeschreibungModelTest
|
||||
- **test_rollenbeschreibung_creation**: Testet die Erstellung von RollenBeschreibung mit Rolle und Abschnittstyp
|
||||
- **test_rollenbeschreibung_str**: Testet die String-Repräsentation enthält Rolle und Abschnittstyp
|
||||
- **test_rollenbeschreibung_ordering**: Testet die Standard-Sortierung nach `order`-Feld
|
||||
- **test_rollenbeschreibung_unique_combination**: Testet die Unique-Constraint auf Rolle und Abschnittstyp
|
||||
- **test_rollenbeschreibung_optional_beschreibung**: Testet, dass das Beschreibungsfeld leer sein kann
|
||||
|
||||
### Beziehungs-Tests
|
||||
|
||||
#### RelationshipTest
|
||||
- **test_rolle_rollenbeschreibung_relationship**: Testet die Eins-zu-viele-Beziehung zwischen Rolle und RollenBeschreibung
|
||||
- **test_abschnitttyp_rollenbeschreibung_relationship**: Testet die Beziehung zwischen AbschnittTyp und RollenBeschreibung
|
||||
- **test_cascade_delete**: Testet das Cascade-Delete-Verhalten beim Löschen einer Rolle
|
||||
- **test_protected_delete**: Testet das Protected-Delete-Verhalten, wenn Abschnittstyp referenziert wird
|
||||
- **test_query_related_objects**: Testet das effiziente Abfragen verwandter Objekte
|
||||
- **test_string_representations**: Testet, dass alle String-Repräsentationen korrekt funktionieren
|
||||
- **test_ordering_consistency**: Testet, dass die Sortierung über Abfragen hinweg konsistent ist
|
||||
|
||||
---
|
||||
|
||||
## stichworte App Tests
|
||||
|
||||
Die stichworte App enthält 18 Tests, die Schlüsselwortmodelle und ihre Sortierung abdecken.
|
||||
|
||||
### Modell-Tests
|
||||
|
||||
#### StichwortModelTest
|
||||
- **test_stichwort_creation**: Testet die Erstellung von Stichwort mit Schlüsselworttext
|
||||
- **test_stichwort_str**: Testet die String-Repräsentation gibt den Schlüsselworttext zurück
|
||||
- **test_stichwort_ordering**: Testet die Standard-Sortierung nach `stichwort`-Feld
|
||||
- **test_stichwort_unique**: Testet, dass Schlüsselwörter einzigartig sein müssen
|
||||
- **test_stichwort_case_insensitive**: Testet die Groß-/Kleinschreibungs-unabhängige Eindeutigkeit
|
||||
|
||||
#### StichworterklaerungModelTest
|
||||
- **test_stichworterklaerung_creation**: Testet die Erstellung von Stichworterklaerung mit Schlüsselwort und Erklärung
|
||||
- **test_stichworterklaerung_str**: Testet die String-Repräsentation enthält Schlüsselwort und Erklärungsvorschau
|
||||
- **test_stichworterklaerung_ordering**: Testet die Standard-Sortierung nach `order`-Feld
|
||||
- **test_stichworterklaerung_optional_erklaerung**: Testet, dass das Erklärungsfeld leer sein kann
|
||||
- **test_stichworterklaerung_unique_stichwort**: Testet den Unique-Constraint auf das Schlüsselwort
|
||||
|
||||
### Beziehungs-Tests
|
||||
|
||||
#### RelationshipTest
|
||||
- **test_stichwort_stichworterklaerung_relationship**: Testet die Eins-zu-eins-Beziehung zwischen Stichwort und Stichworterklaerung
|
||||
- **test_cascade_delete**: Testet das Cascade-Delete-Verhalten beim Löschen eines Schlüsselworts
|
||||
- **test_protected_delete**: Testet das Protected-Delete-Verhalten, wenn Erklärung referenziert wird
|
||||
- **test_query_related_objects**: Testet das effiziente Abfragen verwandter Objekte
|
||||
- **test_string_representations**: Testet, dass alle String-Repräsentationen korrekt funktionieren
|
||||
- **test_ordering_consistency**: Testet, dass die Sortierung über Abfragen hinweg konsistent ist
|
||||
- **test_reverse_relationship**: Testet die umgekehrte Beziehung von Erklärung zu Schlüsselwort
|
||||
|
||||
---
|
||||
|
||||
## Test-Statistiken
|
||||
|
||||
- **Gesamt-Tests**: 230
|
||||
- **abschnitte**: 33 Tests (einschließlich XSS-Prävention)
|
||||
- **dokumente**: 121 Tests (einschließlich Kommentarfunktionalität mit XSS-Schutz)
|
||||
- Modell-Tests: 44 Tests
|
||||
- View-Tests: 7 Tests
|
||||
- URL-Pattern-Tests: 4 Tests
|
||||
- Sanity-Check-Tests: 16 Tests
|
||||
- Management-Befehl-Tests: 2 Tests
|
||||
- JSON-Export-Tests: 9 Tests
|
||||
- Unvollständige-Vorgaben-Tests: 15 Tests
|
||||
- Kommentar-Tests: 24 Tests (6 Modell + 18 View-Tests)
|
||||
- **pages**: 4 Tests
|
||||
- **referenzen**: 18 Tests
|
||||
- **rollen**: 18 Tests
|
||||
- **stichworte**: 18 Tests
|
||||
|
||||
## Test-Abdeckungsbereiche
|
||||
|
||||
1. **Modell-Validierung**: Feldvalidierung, Constraints und Beziehungen
|
||||
2. **Geschäftslogik**: Statusbestimmung, Konflikterkennung, Hierarchieverwaltung
|
||||
3. **View-Funktionalität**: HTTP-Antworten, Template-Rendering, URL-Auflösung
|
||||
4. **Utility-Funktionen**: Textverarbeitung, Caching, Formatierung
|
||||
5. **Management-Befehle**: CLI-Schnittstelle und Ausgabeverarbeitung
|
||||
6. **Integration**: App-übergreifende Funktionalität und Datenfluss
|
||||
7. **Sicherheit**:
|
||||
- XSS-Prävention durch HTML-Bereinigung beim Rendern von Inhalten
|
||||
- XSS-Angriffsverhinderung im Kommentarsystem (Script-Tags, javascript:-Protokoll, Event-Handler)
|
||||
- Eingabevalidierung und -bereinigung
|
||||
- Autorisierungsprüfungen (Staff vs. normale Benutzer)
|
||||
- Sicherheits-Header (Content-Security-Policy, X-Content-Type-Options)
|
||||
8. **Kommentar-Funktionalität**:
|
||||
- CRUD-Operationen (Create, Read, Delete)
|
||||
- Benutzerberechtigungen und -besitz
|
||||
- HTML-Escaping und Erhalt von Zeilenumbrüchen
|
||||
- Verhinderung mehrerer XSS-Angriffsvektoren
|
||||
|
||||
## Ausführen der Tests
|
||||
|
||||
Um alle Tests auszuführen:
|
||||
```bash
|
||||
python manage.py test
|
||||
```
|
||||
|
||||
Um Tests für eine spezifische App auszuführen:
|
||||
```bash
|
||||
python manage.py test app_name
|
||||
```
|
||||
|
||||
Um mit ausführlicher Ausgabe auszuführen:
|
||||
```bash
|
||||
python manage.py test --verbosity=2
|
||||
```
|
||||
|
||||
Alle Tests laufen derzeit erfolgreich und bieten umfassende Abdeckung der Funktionalität der Anwendung.
|
||||
431
Test suite.md
Normal file
431
Test suite.md
Normal file
@@ -0,0 +1,431 @@
|
||||
# Test Suite Documentation
|
||||
|
||||
This document provides a comprehensive overview of all tests in the vgui-cicd Django project, describing what each test does and how it works.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [abschnitte App Tests](#abschnitte-app-tests)
|
||||
- [dokumente App Tests](#dokumente-app-tests)
|
||||
- [pages App Tests](#pages-app-tests)
|
||||
- [referenzen App Tests](#referenzen-app-tests)
|
||||
- [rollen App Tests](#rollen-app-tests)
|
||||
- [stichworte App Tests](#stichworte-app-tests)
|
||||
|
||||
---
|
||||
|
||||
## abschnitte App Tests
|
||||
|
||||
The abschnitte app contains 33 tests covering models, utility functions, diagram caching, management commands, and security.
|
||||
|
||||
### Model Tests
|
||||
|
||||
#### AbschnittTypModelTest
|
||||
- **test_abschnitttyp_creation**: Verifies that AbschnittTyp objects are created correctly with the expected field values
|
||||
- **test_abschnitttyp_primary_key**: Confirms that the `abschnitttyp` field serves as the primary key
|
||||
- **test_abschnitttyp_str**: Tests the string representation returns the `abschnitttyp` value
|
||||
- **test_abschnitttyp_verbose_name_plural**: Validates the verbose name plural is set correctly
|
||||
- **test_create_multiple_abschnitttypen**: Ensures multiple AbschnittTyp objects can be created with different types
|
||||
|
||||
#### TextabschnittModelTest
|
||||
- **test_textabschnitt_creation**: Tests that Textabschnitt can be instantiated through the concrete model
|
||||
- **test_textabschnitt_default_order**: Verifies the `order` field defaults to 0
|
||||
- **test_textabschnitt_ordering**: Tests that Textabschnitt objects can be ordered by the `order` field
|
||||
- **test_textabschnitt_blank_fields**: Confirms that `abschnitttyp` and `inhalt` fields can be blank/null
|
||||
- **test_textabschnitt_foreign_key_protection**: Tests that AbschnittTyp objects are protected from deletion when referenced by Textabschnitt
|
||||
|
||||
### Utility Function Tests
|
||||
|
||||
#### MdTableToHtmlTest
|
||||
- **test_simple_table**: Converts a basic markdown table with headers and one row to HTML
|
||||
- **test_table_with_multiple_rows**: Tests conversion of tables with multiple data rows
|
||||
- **test_table_with_empty_cells**: Handles tables with empty cells in the data
|
||||
- **test_table_with_spaces**: Processes tables with extra spaces in cells
|
||||
- **test_table_empty_string**: Raises ValueError for empty input strings
|
||||
- **test_table_only_whitespace**: Raises ValueError for strings containing only whitespace
|
||||
- **test_table_insufficient_lines**: Raises ValueError when input has fewer than 2 lines
|
||||
|
||||
#### RenderTextabschnitteTest
|
||||
- **test_render_empty_queryset**: Returns empty string for empty querysets
|
||||
- **test_render_multiple_abschnitte**: Renders multiple Textabschnitte in correct order
|
||||
- **test_render_text_markdown**: Converts plain text with markdown formatting
|
||||
- **test_render_ordered_list**: Renders ordered lists correctly
|
||||
- **test_render_unordered_list**: Renders unordered lists correctly
|
||||
- **test_render_code_block**: Renders code blocks with proper syntax highlighting
|
||||
- **test_render_table**: Converts markdown tables to HTML using md_table_to_html
|
||||
- **test_render_diagram_success**: Tests diagram generation with successful caching
|
||||
- **test_render_diagram_error**: Handles diagram generation errors gracefully
|
||||
- **test_render_diagram_with_options**: Tests diagram rendering with custom options
|
||||
- **test_render_text_with_footnotes**: Processes text containing footnotes
|
||||
- **test_render_abschnitt_without_type**: Handles Textabschnitte without AbschnittTyp
|
||||
- **test_render_abschnitt_with_empty_content**: Handles Textabschnitte with empty content
|
||||
- **test_render_textabschnitte_xss_prevention**: Verifies that malicious HTML and script tags are sanitized from rendered content to prevent XSS attacks
|
||||
|
||||
### Diagram Caching Tests
|
||||
|
||||
#### DiagramCacheTest
|
||||
- **test_compute_hash**: Generates consistent SHA256 hashes for the same input
|
||||
- **test_get_cache_path**: Creates correct cache file paths based on hash and type
|
||||
- **test_get_cached_diagram_hit**: Returns cached diagram when cache hit occurs
|
||||
- **test_get_cached_diagram_miss**: Generates new diagram when cache miss occurs
|
||||
- **test_get_cached_diagram_request_error**: Properly handles and raises request errors
|
||||
- **test_clear_cache_specific_type**: Clears cache files for specific diagram types
|
||||
- **test_clear_cache_all_types**: Clears all cache files when no type specified
|
||||
|
||||
### Management Command Tests
|
||||
|
||||
#### ClearDiagramCacheCommandTest
|
||||
- **test_command_without_type**: Tests management command execution without specifying type
|
||||
- **test_command_with_type**: Tests management command execution with specific diagram type
|
||||
|
||||
### Integration Tests
|
||||
|
||||
#### IntegrationTest
|
||||
- **test_textabschnitt_inheritance**: Verifies VorgabeLangtext properly inherits Textabschnitt fields
|
||||
- **test_render_vorgabe_langtext**: Tests rendering VorgabeLangtext through render_textabschnitte
|
||||
|
||||
---
|
||||
|
||||
## dokumente App Tests
|
||||
|
||||
The dokumente app contains 121 tests, making it the most comprehensive test suite, covering all models, views, URLs, business logic, and comment functionality with XSS protection.
|
||||
|
||||
### Model Tests
|
||||
|
||||
#### DokumententypModelTest
|
||||
- **test_dokumententyp_creation**: Verifies Dokumententyp creation with correct field values
|
||||
- **test_dokumententyp_str**: Tests string representation returns the `typ` field
|
||||
- **test_dokumententyp_verbose_name**: Validates verbose name is set correctly
|
||||
|
||||
#### PersonModelTest
|
||||
- **test_person_creation**: Tests Person object creation with name and optional title
|
||||
- **test_person_str**: Verifies string representation includes title and name
|
||||
- **test_person_verbose_name_plural**: Tests verbose name plural configuration
|
||||
|
||||
#### ThemaModelTest
|
||||
- **test_thema_creation**: Tests Thema creation with name and optional explanation
|
||||
- **test_thema_str**: Verifies string representation returns the theme name
|
||||
- **test_thema_blank_erklaerung**: Confirms `erklaerung` field can be blank
|
||||
|
||||
#### DokumentModelTest
|
||||
- **test_dokument_creation**: Tests Dokument creation with required and optional fields
|
||||
- **test_dokument_str**: Verifies string representation returns the document title
|
||||
- **test_dokument_optional_fields**: Tests that optional fields can be None or blank
|
||||
- **test_dokument_many_to_many_relationships**: Verifies many-to-many relationships with Personen and Themen
|
||||
|
||||
#### VorgabeModelTest
|
||||
- **test_vorgabe_creation**: Tests Vorgabe creation with all required fields
|
||||
- **test_vorgabe_str**: Verifies string representation returns the Vorgabennummer
|
||||
- **test_vorgabennummer**: Tests automatic generation of Vorgabennummer format
|
||||
- **test_get_status_active**: Tests status determination for current active Vorgaben
|
||||
- **test_get_status_expired**: Tests status determination for expired Vorgaben
|
||||
- **test_get_status_future**: Tests status determination for future Vorgaben
|
||||
- **test_get_status_with_custom_check_date**: Tests status with custom check date
|
||||
- **test_get_status_verbose**: Tests verbose status output
|
||||
|
||||
#### ChangelogModelTest
|
||||
- **test_changelog_creation**: Tests Changelog creation with version, date, and description
|
||||
- **test_changelog_str**: Verifies string representation includes version and date
|
||||
|
||||
#### ChecklistenfrageModelTest
|
||||
- **test_checklistenfrage_creation**: Tests Checklistenfrage creation with question and optional answer
|
||||
- **test_checklistenfrage_str**: Verifies string representation truncates long questions
|
||||
- **test_checklistenfrage_related_name**: Tests the reverse relationship from Vorgabe
|
||||
|
||||
#### VorgabeCommentModelTest
|
||||
- **test_comment_creation**: Tests VorgabeComment creation with vorgabe, user, and text
|
||||
- **test_comment_str**: Verifies string representation includes username and Vorgabennummer
|
||||
- **test_comment_related_name**: Tests the reverse relationship from Vorgabe
|
||||
- **test_comment_ordering**: Tests comments are ordered by created_at descending (newest first)
|
||||
- **test_comment_timestamps_auto_update**: Tests that updated_at changes when comment is modified
|
||||
- **test_multiple_users_can_comment**: Tests multiple users can comment on same Vorgabe
|
||||
|
||||
### Text Abschnitt Tests
|
||||
|
||||
#### DokumentTextAbschnitteTest
|
||||
- **test_einleitung_creation**: Tests Einleitung creation and inheritance from Textabschnitt
|
||||
- **test_geltungsbereich_creation**: Tests Geltungsbereich creation and inheritance
|
||||
|
||||
#### VorgabeTextAbschnitteTest
|
||||
- **test_vorgabe_kurztext_creation**: Tests VorgabeKurztext creation and inheritance
|
||||
- **test_vorgabe_langtext_creation**: Tests VorgabeLangtext creation and inheritance
|
||||
|
||||
### Sanity Check Tests
|
||||
|
||||
#### VorgabeSanityCheckTest
|
||||
- **test_date_ranges_intersect_no_overlap**: Tests date intersection with non-overlapping ranges
|
||||
- **test_date_ranges_intersect_with_overlap**: Tests date intersection with overlapping ranges
|
||||
- **test_date_ranges_intersect_identical_ranges**: Tests date intersection with identical ranges
|
||||
- **test_date_ranges_intersect_with_none_end_date**: Tests intersection with open-ended ranges
|
||||
- **test_date_ranges_intersect_both_none_end_dates**: Tests intersection with two open-ended ranges
|
||||
- **test_check_vorgabe_conflicts_utility**: Tests the utility function for conflict detection
|
||||
- **test_find_conflicts_no_conflicts**: Tests conflict detection on Vorgabe without conflicts
|
||||
- **test_find_conflicts_with_conflicts**: Tests conflict detection with conflicting Vorgaben
|
||||
- **test_format_conflict_report_no_conflicts**: Tests conflict report formatting with no conflicts
|
||||
- **test_format_conflict_report_with_conflicts**: Tests conflict report formatting with conflicts
|
||||
- **test_sanity_check_vorgaben_no_conflicts**: Tests full sanity check with no conflicts
|
||||
- **test_sanity_check_vorgaben_with_conflicts**: Tests full sanity check with conflicts
|
||||
- **test_sanity_check_vorgaben_multiple_conflicts**: Tests sanity check with multiple conflict groups
|
||||
- **test_vorgabe_clean_no_conflicts**: Tests Vorgabe.clean() method without conflicts
|
||||
- **test_vorgabe_clean_with_conflicts**: Tests Vorgabe.clean() raises ValidationError with conflicts
|
||||
|
||||
### Management Command Tests
|
||||
|
||||
#### SanityCheckManagementCommandTest
|
||||
- **test_sanity_check_command_no_conflicts**: Tests management command output with no conflicts
|
||||
- **test_sanity_check_command_with_conflicts**: Tests management command output with conflicts
|
||||
|
||||
### URL Pattern Tests
|
||||
|
||||
#### URLPatternsTest
|
||||
- **test_standard_list_url_resolves**: Verifies standard_list URL resolves to correct view
|
||||
- **test_standard_detail_url_resolves**: Verifies standard_detail URL resolves with pk parameter
|
||||
- **test_standard_history_url_resolves**: Verifies standard_history URL resolves with check_date
|
||||
- **test_standard_checkliste_url_resolves**: Verifies standard_checkliste URL resolves with pk
|
||||
|
||||
### View Tests
|
||||
|
||||
#### ViewsTestCase
|
||||
- **test_standard_list_view**: Tests standard list view returns 200 and contains expected content
|
||||
- **test_standard_detail_view**: Tests standard detail view with existing document
|
||||
- **test_standard_detail_view_404**: Tests standard detail view returns 404 for non-existent document
|
||||
- **test_standard_history_view**: Tests standard detail view with historical check_date parameter
|
||||
- **test_standard_checkliste_view**: Tests checklist view functionality
|
||||
|
||||
### JSON Export Tests
|
||||
|
||||
#### JSONExportManagementCommandTest
|
||||
- **test_export_json_command_to_file**: Tests export_json command outputs JSON to specified file
|
||||
- **test_export_json_command_stdout**: Tests export_json command outputs JSON to stdout when no file specified
|
||||
- **test_export_json_command_inactive_documents**: Tests export_json command filters out inactive documents
|
||||
- **test_export_json_command_empty_database**: Tests export_json command handles empty database gracefully
|
||||
|
||||
#### StandardJSONViewTest
|
||||
- **test_standard_json_view_success**: Tests standard_json view returns correct JSON for existing document
|
||||
- **test_standard_json_view_not_found**: Tests standard_json view returns 404 for non-existent document
|
||||
- **test_standard_json_view_json_formatting**: Tests standard_json view returns properly formatted JSON
|
||||
- **test_standard_json_view_null_dates**: Tests standard_json view handles null date fields correctly
|
||||
- **test_standard_json_view_empty_sections**: Tests standard_json view handles empty document sections
|
||||
|
||||
### Incomplete Vorgaben Tests
|
||||
|
||||
#### IncompleteVorgabenTest
|
||||
- **test_incomplete_vorgaben_page_status**: Tests page loads successfully (200 status)
|
||||
- **test_incomplete_vorgaben_staff_only**: Tests non-staff users are redirected to login
|
||||
- **test_incomplete_vorgaben_page_content**: Tests page contains expected headings and structure
|
||||
- **test_navigation_link**: Tests navigation includes link to incomplete Vorgaben page
|
||||
- **test_no_references_list**: Tests Vorgaben without references are listed correctly
|
||||
- **test_no_stichworte_list**: Tests Vorgaben without Stichworte are listed correctly
|
||||
- **test_no_text_list**: Tests Vorgaben without Kurz- or Langtext are listed correctly
|
||||
- **test_no_checklistenfragen_list**: Tests Vorgaben without Checklistenfragen are listed correctly
|
||||
- **test_vorgabe_with_both_text_types**: Tests Vorgabe with both text types is considered complete
|
||||
- **test_vorgabe_with_langtext_only**: Tests Vorgabe with only Langtext is still incomplete for text
|
||||
- **test_empty_lists_message**: Tests appropriate messages when lists are empty
|
||||
- **test_badge_counts**: Tests badge counts are calculated correctly
|
||||
- **test_summary_section**: Tests summary section shows correct counts
|
||||
- **test_vorgabe_links**: Tests Vorgaben link to correct admin pages
|
||||
- **test_back_link**: Tests back link to standard list exists
|
||||
|
||||
### Comment Functionality Tests
|
||||
|
||||
#### GetVorgabeCommentsViewTest
|
||||
- **test_get_comments_requires_login**: Tests anonymous users cannot view comments and are redirected
|
||||
- **test_regular_user_sees_only_own_comments**: Tests regular users only see their own comments
|
||||
- **test_staff_user_sees_all_comments**: Tests staff users can see all comments
|
||||
- **test_get_comments_returns_404_for_nonexistent_vorgabe**: Tests 404 response for non-existent Vorgabe
|
||||
- **test_comments_are_html_escaped**: Tests HTML escaping prevents XSS attacks (e.g., `<script>` tags)
|
||||
- **test_line_breaks_preserved**: Tests line breaks are converted to `<br>` tags
|
||||
- **test_security_headers_present**: Tests Content-Security-Policy and X-Content-Type-Options headers are set
|
||||
|
||||
#### AddVorgabeCommentViewTest
|
||||
- **test_add_comment_requires_login**: Tests anonymous users cannot add comments
|
||||
- **test_add_comment_requires_post**: Tests only POST method is allowed (405 for GET)
|
||||
- **test_add_comment_success**: Tests successful comment creation with valid data
|
||||
- **test_add_empty_comment_fails**: Tests empty comments are rejected with 400 error
|
||||
- **test_add_whitespace_only_comment_fails**: Tests whitespace-only comments are rejected
|
||||
- **test_add_too_long_comment_fails**: Tests comments exceeding 2000 characters are rejected
|
||||
- **test_add_comment_xss_script_tag_blocked**: Tests comments with `<script>` tags are blocked
|
||||
- **test_add_comment_xss_javascript_protocol_blocked**: Tests `javascript:` protocol is blocked
|
||||
- **test_add_comment_xss_event_handlers_blocked**: Tests event handlers (onload, onerror, onclick, onmouseover) are blocked
|
||||
- **test_add_comment_invalid_json_fails**: Tests invalid JSON payloads are rejected
|
||||
- **test_add_comment_nonexistent_vorgabe_fails**: Tests 404 response for non-existent Vorgabe
|
||||
- **test_add_comment_security_headers**: Tests security headers are present in responses
|
||||
|
||||
#### DeleteVorgabeCommentViewTest
|
||||
- **test_delete_comment_requires_login**: Tests anonymous users cannot delete comments
|
||||
- **test_delete_comment_requires_post**: Tests only POST method is allowed (405 for GET)
|
||||
- **test_user_can_delete_own_comment**: Tests users can delete their own comments
|
||||
- **test_user_cannot_delete_other_users_comment**: Tests users cannot delete others' comments (403 Forbidden)
|
||||
- **test_staff_can_delete_any_comment**: Tests staff users can delete any comment
|
||||
- **test_delete_nonexistent_comment_returns_404**: Tests 404 response for non-existent comment
|
||||
- **test_delete_comment_security_headers**: Tests security headers are present in responses
|
||||
|
||||
---
|
||||
|
||||
## pages App Tests
|
||||
|
||||
The pages app contains 4 tests focusing on search functionality and validation.
|
||||
|
||||
### ViewsTestCase
|
||||
- **test_search_view_get**: Tests GET request to search view returns 200 status
|
||||
- **test_search_view_post_with_query**: Tests POST request with query returns results
|
||||
- **test_search_view_post_empty_query**: Tests POST request with empty query shows validation error
|
||||
- **test_search_view_post_no_query**: Tests POST request without query parameter shows validation error
|
||||
|
||||
---
|
||||
|
||||
## referenzen App Tests
|
||||
|
||||
The referenzen app contains 18 tests focusing on MPTT hierarchy functionality and model relationships.
|
||||
|
||||
### Model Tests
|
||||
|
||||
#### ReferenzModelTest
|
||||
- **test_referenz_creation**: Tests Referenz creation with required fields
|
||||
- **test_referenz_str**: Tests string representation returns the reference text
|
||||
- **test_referenz_ordering**: Tests default ordering by `order` field
|
||||
- **test_referenz_optional_fields**: Tests optional fields can be blank
|
||||
|
||||
#### ReferenzerklaerungModelTest
|
||||
- **test_referenzerklaerung_creation**: Tests Referenzerklaerung creation with reference and explanation
|
||||
- **test_referenzerklaerung_str**: Tests string representation includes reference and explanation preview
|
||||
- **test_referenzerklaerung_ordering**: Tests default ordering by `order` field
|
||||
- **test_referenzerklaerung_optional_explanation**: Tests explanation field can be blank
|
||||
|
||||
### Hierarchy Tests
|
||||
|
||||
#### ReferenzHierarchyTest
|
||||
- **test_hierarchy_relationships**: Tests parent-child relationships in MPTT tree
|
||||
- **test_get_root**: Tests getting the root node of a hierarchy
|
||||
- **test_get_children**: Tests getting direct children of a node
|
||||
- **test_get_descendants**: Tests getting all descendants of a node
|
||||
- **test_get_ancestors**: Tests getting all ancestors of a node
|
||||
- **test_get_ancestors_include_self**: Tests getting ancestors including the node itself
|
||||
- **test_is_leaf_node**: Tests leaf node detection
|
||||
- **test_is_root_node**: Tests root node detection
|
||||
- **test_tree_ordering**: Tests tree ordering with multiple levels
|
||||
- **test_move_node**: Tests moving nodes within the tree structure
|
||||
|
||||
---
|
||||
|
||||
## rollen App Tests
|
||||
|
||||
The rollen app contains 18 tests covering role models and their relationships with document sections.
|
||||
|
||||
### Model Tests
|
||||
|
||||
#### RolleModelTest
|
||||
- **test_rolle_creation**: Tests Rolle creation with name and optional description
|
||||
- **test_rolle_str**: Tests string representation returns the role name
|
||||
- **test_rolle_ordering**: Tests default ordering by `order` field
|
||||
- **test_rolle_unique_name**: Tests that role names must be unique
|
||||
- **test_rolle_optional_beschreibung**: Tests description field can be blank
|
||||
|
||||
#### RollenBeschreibungModelTest
|
||||
- **test_rollenbeschreibung_creation**: Tests RollenBeschreibung creation with role and section type
|
||||
- **test_rollenbeschreibung_str**: Tests string representation includes role and section type
|
||||
- **test_rollenbeschreibung_ordering**: Tests default ordering by `order` field
|
||||
- **test_rollenbeschreibung_unique_combination**: Tests unique constraint on role and section type
|
||||
- **test_rollenbeschreibung_optional_beschreibung**: Tests description field can be blank
|
||||
|
||||
### Relationship Tests
|
||||
|
||||
#### RelationshipTest
|
||||
- **test_rolle_rollenbeschreibung_relationship**: Tests one-to-many relationship between Rolle and RollenBeschreibung
|
||||
- **test_abschnitttyp_rollenbeschreibung_relationship**: Tests relationship between AbschnittTyp and RollenBeschreibung
|
||||
- **test_cascade_delete**: Tests cascade delete behavior when role is deleted
|
||||
- **test_protected_delete**: Tests protected delete behavior when section type is referenced
|
||||
- **test_query_related_objects**: Tests querying related objects efficiently
|
||||
- **test_string_representations**: Tests all string representations work correctly
|
||||
- **test_ordering_consistency**: Tests ordering is consistent across queries
|
||||
|
||||
---
|
||||
|
||||
## stichworte App Tests
|
||||
|
||||
The stichworte app contains 18 tests covering keyword models and their ordering.
|
||||
|
||||
### Model Tests
|
||||
|
||||
#### StichwortModelTest
|
||||
- **test_stichwort_creation**: Tests Stichwort creation with keyword text
|
||||
- **test_stichwort_str**: Tests string representation returns the keyword text
|
||||
- **test_stichwort_ordering**: Tests default ordering by `stichwort` field
|
||||
- **test_stichwort_unique**: Tests that keywords must be unique
|
||||
- **test_stichwort_case_insensitive**: Tests case-insensitive uniqueness
|
||||
|
||||
#### StichworterklaerungModelTest
|
||||
- **test_stichworterklaerung_creation**: Tests Stichworterklaerung creation with keyword and explanation
|
||||
- **test_stichworterklaerung_str**: Tests string representation includes keyword and explanation preview
|
||||
- **test_stichworterklaerung_ordering**: Tests default ordering by `order` field
|
||||
- **test_stichworterklaerung_optional_erklaerung**: Tests explanation field can be blank
|
||||
- **test_stichworterklaerung_unique_stichwort**: Tests unique constraint on keyword
|
||||
|
||||
### Relationship Tests
|
||||
|
||||
#### RelationshipTest
|
||||
- **test_stichwort_stichworterklaerung_relationship**: Tests one-to-one relationship between Stichwort and Stichworterklaerung
|
||||
- **test_cascade_delete**: Tests cascade delete behavior when keyword is deleted
|
||||
- **test_protected_delete**: Tests protected delete behavior when explanation is referenced
|
||||
- **test_query_related_objects**: Tests querying related objects efficiently
|
||||
- **test_string_representations**: Tests all string representations work correctly
|
||||
- **test_ordering_consistency**: Tests ordering is consistent across queries
|
||||
- **test_reverse_relationship**: Tests reverse relationship from explanation to keyword
|
||||
|
||||
---
|
||||
|
||||
## Test Statistics
|
||||
|
||||
- **Total Tests**: 230
|
||||
- **abschnitte**: 33 tests (including XSS prevention)
|
||||
- **dokumente**: 121 tests (including comment functionality with XSS protection)
|
||||
- Model tests: 44 tests
|
||||
- View tests: 7 tests
|
||||
- URL pattern tests: 4 tests
|
||||
- Sanity check tests: 16 tests
|
||||
- Management command tests: 2 tests
|
||||
- JSON export tests: 9 tests
|
||||
- Incomplete Vorgaben tests: 15 tests
|
||||
- Comment tests: 24 tests (6 model + 18 view tests)
|
||||
- **pages**: 4 tests
|
||||
- **referenzen**: 18 tests
|
||||
- **rollen**: 18 tests
|
||||
- **stichworte**: 18 tests
|
||||
|
||||
## Test Coverage Areas
|
||||
|
||||
1. **Model Validation**: Field validation, constraints, and relationships
|
||||
2. **Business Logic**: Status determination, conflict detection, hierarchy management
|
||||
3. **View Functionality**: HTTP responses, template rendering, URL resolution
|
||||
4. **Utility Functions**: Text processing, caching, formatting
|
||||
5. **Management Commands**: CLI interface and output handling
|
||||
6. **Integration**: Cross-app functionality and data flow
|
||||
7. **Security**:
|
||||
- XSS prevention through HTML sanitization in content rendering
|
||||
- XSS attack prevention in comment system (script tags, javascript: protocol, event handlers)
|
||||
- Input validation and sanitization
|
||||
- Authorization checks (staff vs. regular users)
|
||||
- Security headers (Content-Security-Policy, X-Content-Type-Options)
|
||||
8. **Comment Functionality**:
|
||||
- CRUD operations (Create, Read, Delete)
|
||||
- User permissions and ownership
|
||||
- HTML escaping and line break preservation
|
||||
- Multiple XSS attack vector prevention
|
||||
|
||||
## Running the Tests
|
||||
|
||||
To run all tests:
|
||||
```bash
|
||||
python manage.py test
|
||||
```
|
||||
|
||||
To run tests for a specific app:
|
||||
```bash
|
||||
python manage.py test app_name
|
||||
```
|
||||
|
||||
To run with verbose output:
|
||||
```bash
|
||||
python manage.py test --verbosity=2
|
||||
```
|
||||
|
||||
All tests are currently passing and provide comprehensive coverage of the application's functionality.
|
||||
@@ -24,7 +24,7 @@ BASE_DIR = Path(__file__).resolve().parent.parent
|
||||
SECRET_KEY = os.environ.get("SECRET_KEY")
|
||||
|
||||
# SECURITY WARNING: don't run with debug turned on in production!
|
||||
DEBUG = bool(os.environ.get("DEBUG", default=0)
|
||||
DEBUG = bool(os.environ.get("DEBUG", default=0))
|
||||
|
||||
ALLOWED_HOSTS = os.environ.get("DJANGO_ALLOWED_HOSTS","127.0.0.1").split(",")
|
||||
|
||||
@@ -38,7 +38,7 @@ INSTALLED_APPS = [
|
||||
'django.contrib.sessions',
|
||||
'django.contrib.messages',
|
||||
'django.contrib.staticfiles',
|
||||
'standards',
|
||||
'dokumente',
|
||||
'abschnitte',
|
||||
'stichworte',
|
||||
'mptt',
|
||||
@@ -126,6 +126,13 @@ STATICFILES_DIRS= (
|
||||
os.path.join(BASE_DIR,"static"),
|
||||
)
|
||||
|
||||
# Media files (User-uploaded content)
|
||||
MEDIA_URL = '/media/'
|
||||
MEDIA_ROOT = os.path.join(BASE_DIR, 'media')
|
||||
|
||||
# Diagram cache settings
|
||||
DIAGRAM_CACHE_DIR = 'diagram_cache' # relative to MEDIA_ROOT
|
||||
|
||||
# Default primary key field type
|
||||
# https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field
|
||||
|
||||
|
||||
@@ -28,12 +28,6 @@ DEBUG = True
|
||||
|
||||
ALLOWED_HOSTS = ["10.128.128.144","localhost","127.0.0.1","*"]
|
||||
|
||||
TEMPLATES = [
|
||||
{"BACKEND": "django.template.backends.django.DjangoTemplates",
|
||||
"APP_DIRS": True,
|
||||
}
|
||||
]
|
||||
|
||||
# Application definition
|
||||
|
||||
INSTALLED_APPS = [
|
||||
@@ -43,7 +37,7 @@ INSTALLED_APPS = [
|
||||
'django.contrib.sessions',
|
||||
'django.contrib.messages',
|
||||
'django.contrib.staticfiles',
|
||||
'standards',
|
||||
'dokumente',
|
||||
'abschnitte',
|
||||
'stichworte',
|
||||
'referenzen',
|
||||
@@ -51,7 +45,6 @@ INSTALLED_APPS = [
|
||||
'mptt',
|
||||
'pages',
|
||||
'nested_admin',
|
||||
'revproxy.apps.RevProxyConfig',
|
||||
]
|
||||
|
||||
MIDDLEWARE = [
|
||||
@@ -134,11 +127,18 @@ USE_TZ = True
|
||||
|
||||
STATIC_URL = '/static/'
|
||||
#STATIC_ROOT="/home/adebaumann/VorgabenUI/staticfiles/"
|
||||
STATIC_ROOT="/app/staticfiles/"
|
||||
STATIC_ROOT="staticfiles/"
|
||||
STATICFILES_DIRS= (
|
||||
os.path.join(BASE_DIR,"static"),
|
||||
)
|
||||
|
||||
# Media files (User-uploaded content)
|
||||
MEDIA_URL = '/media/'
|
||||
MEDIA_ROOT = os.path.join(BASE_DIR, 'media')
|
||||
|
||||
# Diagram cache settings
|
||||
DIAGRAM_CACHE_DIR = 'diagram_cache' # relative to MEDIA_ROOT
|
||||
|
||||
# Default primary key field type
|
||||
# https://docs.djangoproject.com/en/5.2/ref/settings/#default-auto-field
|
||||
|
||||
@@ -146,6 +146,11 @@ DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
|
||||
DATA_UPLOAD_MAX_NUMBER_FIELDS=10250
|
||||
NESTED_ADMIN_LAZY_INLINES = True
|
||||
|
||||
# Authentication settings
|
||||
LOGIN_URL = 'login'
|
||||
LOGIN_REDIRECT_URL = '/'
|
||||
LOGOUT_REDIRECT_URL = 'login'
|
||||
|
||||
#LOGGING = {
|
||||
# "version": 1,
|
||||
# "handlers" :{
|
||||
|
||||
@@ -18,8 +18,8 @@ from django.contrib import admin
|
||||
from django.urls import include, path, re_path
|
||||
from django.conf import settings
|
||||
from django.conf.urls.static import static
|
||||
from diagramm_proxy.views import DiagrammProxyView
|
||||
import standards.views
|
||||
from django.contrib.auth import views as auth_views
|
||||
import dokumente.views
|
||||
import pages.views
|
||||
import referenzen.views
|
||||
|
||||
@@ -28,11 +28,21 @@ admin.site.site_header="Autorenumgebung"
|
||||
urlpatterns = [
|
||||
path('',pages.views.startseite),
|
||||
path('search/',pages.views.search),
|
||||
path('standards/', include("standards.urls")),
|
||||
path('dokumente/', include("dokumente.urls")),
|
||||
path('autorenumgebung/', admin.site.urls),
|
||||
path('stichworte/', include("stichworte.urls")),
|
||||
path('referenzen/', referenzen.views.tree, name="referenz_tree"),
|
||||
path('referenzen/<str:refid>/', referenzen.views.detail, name="referenz_detail"),
|
||||
re_path(r'^diagramm/(?P<path>.*)$', DiagrammProxyView.as_view()),
|
||||
] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)
|
||||
# Authentication URLs
|
||||
path('login/', auth_views.LoginView.as_view(template_name='registration/login.html'), name='login'),
|
||||
path('logout/', auth_views.LogoutView.as_view(next_page='/'), name='logout'),
|
||||
path('password_change/', auth_views.PasswordChangeView.as_view(template_name='registration/password_change.html', success_url='/'), name='password_change'),
|
||||
path('password_change/done/', auth_views.PasswordChangeDoneView.as_view(template_name='registration/password_change_done.html'), name='password_change_done'),
|
||||
]
|
||||
|
||||
# Serve static files
|
||||
urlpatterns += static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)
|
||||
|
||||
# Serve media files (including cached diagrams)
|
||||
if settings.DEBUG:
|
||||
urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
|
||||
|
||||
1
abschnitte/management/__init__.py
Normal file
1
abschnitte/management/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
# Management commands
|
||||
1
abschnitte/management/commands/__init__.py
Normal file
1
abschnitte/management/commands/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
# Commands package
|
||||
23
abschnitte/management/commands/clear_diagram_cache.py
Normal file
23
abschnitte/management/commands/clear_diagram_cache.py
Normal file
@@ -0,0 +1,23 @@
|
||||
from django.core.management.base import BaseCommand
|
||||
from diagramm_proxy.diagram_cache import clear_cache
|
||||
|
||||
|
||||
class Command(BaseCommand):
|
||||
help = 'Clear cached diagrams'
|
||||
|
||||
def add_arguments(self, parser):
|
||||
parser.add_argument(
|
||||
'--type',
|
||||
type=str,
|
||||
help='Diagram type to clear (e.g., plantuml, mermaid)',
|
||||
)
|
||||
|
||||
def handle(self, *args, **options):
|
||||
diagram_type = options.get('type')
|
||||
if diagram_type:
|
||||
self.stdout.write(f'Clearing cache for {diagram_type}...')
|
||||
clear_cache(diagram_type)
|
||||
else:
|
||||
self.stdout.write('Clearing all diagram caches...')
|
||||
clear_cache()
|
||||
self.stdout.write(self.style.SUCCESS('Cache cleared successfully'))
|
||||
@@ -1,3 +1,846 @@
|
||||
from django.test import TestCase
|
||||
from django.test import TestCase, TransactionTestCase
|
||||
from django.core.management import call_command
|
||||
from django.conf import settings
|
||||
from django.core.files.storage import default_storage
|
||||
from unittest.mock import patch, Mock, MagicMock
|
||||
from io import StringIO
|
||||
import os
|
||||
import hashlib
|
||||
import tempfile
|
||||
import shutil
|
||||
|
||||
# Create your tests here.
|
||||
from .models import AbschnittTyp, Textabschnitt
|
||||
from .utils import render_textabschnitte, md_table_to_html
|
||||
from diagramm_proxy.diagram_cache import (
|
||||
get_cached_diagram, compute_hash, get_cache_path, clear_cache
|
||||
)
|
||||
|
||||
|
||||
class AbschnittTypModelTest(TestCase):
|
||||
"""Test cases for AbschnittTyp model"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data"""
|
||||
self.abschnitttyp = AbschnittTyp.objects.create(
|
||||
abschnitttyp="text"
|
||||
)
|
||||
|
||||
def test_abschnitttyp_creation(self):
|
||||
"""Test that AbschnittTyp is created correctly"""
|
||||
self.assertEqual(self.abschnitttyp.abschnitttyp, "text")
|
||||
|
||||
def test_abschnitttyp_str(self):
|
||||
"""Test string representation of AbschnittTyp"""
|
||||
self.assertEqual(str(self.abschnitttyp), "text")
|
||||
|
||||
def test_abschnitttyp_verbose_name_plural(self):
|
||||
"""Test verbose name plural"""
|
||||
self.assertEqual(
|
||||
AbschnittTyp._meta.verbose_name_plural,
|
||||
"Abschnitttypen"
|
||||
)
|
||||
|
||||
def test_abschnitttyp_primary_key(self):
|
||||
"""Test that abschnitttyp field is the primary key"""
|
||||
pk_field = AbschnittTyp._meta.pk
|
||||
self.assertEqual(pk_field.name, 'abschnitttyp')
|
||||
|
||||
def test_create_multiple_abschnitttypen(self):
|
||||
"""Test creating multiple AbschnittTyp objects"""
|
||||
types = ['liste ungeordnet', 'liste geordnet', 'tabelle', 'diagramm', 'code']
|
||||
for typ in types:
|
||||
AbschnittTyp.objects.create(abschnitttyp=typ)
|
||||
|
||||
self.assertEqual(AbschnittTyp.objects.count(), 6) # Including setUp type
|
||||
|
||||
|
||||
class TextabschnittModelTest(TestCase):
|
||||
"""Test cases for Textabschnitt abstract model using VorgabeLangtext"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data"""
|
||||
from dokumente.models import Dokumententyp, Dokument, Vorgabe, VorgabeLangtext, Thema
|
||||
from datetime import date
|
||||
|
||||
self.typ_text = AbschnittTyp.objects.create(abschnitttyp="text")
|
||||
self.typ_code = AbschnittTyp.objects.create(abschnitttyp="code")
|
||||
|
||||
# Create required dokumente objects
|
||||
self.dokumententyp = Dokumententyp.objects.create(
|
||||
name="Test Type", verantwortliche_ve="TEST"
|
||||
)
|
||||
self.dokument = Dokument.objects.create(
|
||||
nummer="TEST-001",
|
||||
name="Test Doc",
|
||||
dokumententyp=self.dokumententyp,
|
||||
aktiv=True
|
||||
)
|
||||
self.thema = Thema.objects.create(name="Test Thema")
|
||||
self.vorgabe = Vorgabe.objects.create(
|
||||
dokument=self.dokument,
|
||||
nummer=1,
|
||||
order=1,
|
||||
thema=self.thema,
|
||||
titel="Test Vorgabe",
|
||||
gueltigkeit_von=date.today()
|
||||
)
|
||||
|
||||
def test_textabschnitt_creation(self):
|
||||
"""Test that Textabschnitt can be instantiated via concrete model"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_text,
|
||||
inhalt="Test content",
|
||||
order=1
|
||||
)
|
||||
self.assertEqual(abschnitt.abschnitttyp, self.typ_text)
|
||||
self.assertEqual(abschnitt.inhalt, "Test content")
|
||||
self.assertEqual(abschnitt.order, 1)
|
||||
|
||||
def test_textabschnitt_default_order(self):
|
||||
"""Test that order defaults to 0"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_text,
|
||||
inhalt="Test"
|
||||
)
|
||||
self.assertEqual(abschnitt.order, 0)
|
||||
|
||||
def test_textabschnitt_blank_fields(self):
|
||||
"""Test that abschnitttyp and inhalt can be blank/null"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe
|
||||
)
|
||||
self.assertIsNone(abschnitt.abschnitttyp)
|
||||
self.assertIsNone(abschnitt.inhalt)
|
||||
|
||||
def test_textabschnitt_ordering(self):
|
||||
"""Test that Textabschnitte can be ordered"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
abschnitt1 = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_text,
|
||||
inhalt="First",
|
||||
order=2
|
||||
)
|
||||
abschnitt2 = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_text,
|
||||
inhalt="Second",
|
||||
order=1
|
||||
)
|
||||
abschnitt3 = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_text,
|
||||
inhalt="Third",
|
||||
order=3
|
||||
)
|
||||
|
||||
ordered = VorgabeLangtext.objects.filter(abschnitt=self.vorgabe).order_by('order')
|
||||
self.assertEqual(list(ordered), [abschnitt2, abschnitt1, abschnitt3])
|
||||
|
||||
def test_textabschnitt_foreign_key_protection(self):
|
||||
"""Test that AbschnittTyp is protected from deletion"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
from django.db.models import ProtectedError
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_text,
|
||||
inhalt="Test"
|
||||
)
|
||||
|
||||
# Try to delete the AbschnittTyp
|
||||
with self.assertRaises(ProtectedError):
|
||||
self.typ_text.delete()
|
||||
|
||||
|
||||
class RenderTextabschnitteTest(TestCase):
|
||||
"""Test cases for render_textabschnitte function"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data"""
|
||||
from dokumente.models import Dokumententyp, Dokument, Vorgabe, VorgabeLangtext, Thema
|
||||
from datetime import date
|
||||
|
||||
self.typ_text = AbschnittTyp.objects.create(abschnitttyp="text")
|
||||
self.typ_unordered = AbschnittTyp.objects.create(abschnitttyp="liste ungeordnet")
|
||||
self.typ_ordered = AbschnittTyp.objects.create(abschnitttyp="liste geordnet")
|
||||
self.typ_table = AbschnittTyp.objects.create(abschnitttyp="tabelle")
|
||||
self.typ_code = AbschnittTyp.objects.create(abschnitttyp="code")
|
||||
self.typ_diagram = AbschnittTyp.objects.create(abschnitttyp="diagramm")
|
||||
|
||||
# Create required dokumente objects
|
||||
self.dokumententyp = Dokumententyp.objects.create(
|
||||
name="Test Type", verantwortliche_ve="TEST"
|
||||
)
|
||||
self.dokument = Dokument.objects.create(
|
||||
nummer="TEST-001",
|
||||
name="Test Doc",
|
||||
dokumententyp=self.dokumententyp,
|
||||
aktiv=True
|
||||
)
|
||||
self.thema = Thema.objects.create(name="Test Thema")
|
||||
self.vorgabe = Vorgabe.objects.create(
|
||||
dokument=self.dokument,
|
||||
nummer=1,
|
||||
order=1,
|
||||
thema=self.thema,
|
||||
titel="Test Vorgabe",
|
||||
gueltigkeit_von=date.today()
|
||||
)
|
||||
|
||||
def test_render_empty_queryset(self):
|
||||
"""Test rendering an empty queryset"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
result = render_textabschnitte(VorgabeLangtext.objects.none())
|
||||
self.assertEqual(result, [])
|
||||
|
||||
def test_render_text_markdown(self):
|
||||
"""Test rendering plain text with markdown"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_text,
|
||||
inhalt="# Heading\n\nThis is **bold** text.",
|
||||
order=1
|
||||
)
|
||||
|
||||
result = render_textabschnitte(VorgabeLangtext.objects.filter(abschnitt=self.vorgabe))
|
||||
self.assertEqual(len(result), 1)
|
||||
typ, html = result[0]
|
||||
self.assertEqual(typ, "text")
|
||||
self.assertIn("<h1>Heading</h1>", html)
|
||||
self.assertIn("<strong>bold</strong>", html)
|
||||
|
||||
def test_render_text_with_footnotes(self):
|
||||
"""Test rendering text with footnotes"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_text,
|
||||
inhalt="This is text[^1].\n\n[^1]: This is a footnote.",
|
||||
order=1
|
||||
)
|
||||
|
||||
result = render_textabschnitte(VorgabeLangtext.objects.filter(abschnitt=self.vorgabe))
|
||||
typ, html = result[0]
|
||||
self.assertIn("footnote", html.lower())
|
||||
|
||||
def test_render_unordered_list(self):
|
||||
"""Test rendering unordered list"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_unordered,
|
||||
inhalt="Item 1\nItem 2\nItem 3",
|
||||
order=1
|
||||
)
|
||||
|
||||
result = render_textabschnitte(VorgabeLangtext.objects.filter(abschnitt=self.vorgabe))
|
||||
typ, html = result[0]
|
||||
self.assertEqual(typ, "liste ungeordnet")
|
||||
self.assertIn("<ul>", html)
|
||||
self.assertIn("<li>Item 1</li>", html)
|
||||
self.assertIn("<li>Item 2</li>", html)
|
||||
self.assertIn("<li>Item 3</li>", html)
|
||||
|
||||
def test_render_ordered_list(self):
|
||||
"""Test rendering ordered list"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_ordered,
|
||||
inhalt="First item\nSecond item\nThird item",
|
||||
order=1
|
||||
)
|
||||
|
||||
result = render_textabschnitte(VorgabeLangtext.objects.filter(abschnitt=self.vorgabe))
|
||||
typ, html = result[0]
|
||||
self.assertEqual(typ, "liste geordnet")
|
||||
self.assertIn("<ol>", html)
|
||||
self.assertIn("<li>First item</li>", html)
|
||||
self.assertIn("<li>Second item</li>", html)
|
||||
self.assertIn("<li>Third item</li>", html)
|
||||
|
||||
def test_render_table(self):
|
||||
"""Test rendering table"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
table_content = """| Header 1 | Header 2 |
|
||||
|----------|----------|
|
||||
| Cell 1 | Cell 2 |
|
||||
| Cell 3 | Cell 4 |"""
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_table,
|
||||
inhalt=table_content,
|
||||
order=1
|
||||
)
|
||||
|
||||
result = render_textabschnitte(VorgabeLangtext.objects.filter(abschnitt=self.vorgabe))
|
||||
typ, html = result[0]
|
||||
self.assertEqual(typ, "tabelle")
|
||||
self.assertIn('<table class="table table-bordered table-hover">', html)
|
||||
self.assertIn("<thead>", html)
|
||||
self.assertIn("<th>Header 1</th>", html)
|
||||
self.assertIn("<th>Header 2</th>", html)
|
||||
self.assertIn("<tbody>", html)
|
||||
self.assertIn("<td>Cell 1</td>", html)
|
||||
self.assertIn("<td>Cell 2</td>", html)
|
||||
|
||||
def test_render_code_block(self):
|
||||
"""Test rendering code block"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
code_content = "def hello():\n print('Hello, World!')"
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_code,
|
||||
inhalt=code_content,
|
||||
order=1
|
||||
)
|
||||
|
||||
result = render_textabschnitte(VorgabeLangtext.objects.filter(abschnitt=self.vorgabe))
|
||||
typ, html = result[0]
|
||||
self.assertEqual(typ, "code")
|
||||
self.assertIn("<pre><code>", html)
|
||||
self.assertIn("</code></pre>", html)
|
||||
self.assertIn("hello", html)
|
||||
|
||||
@patch('abschnitte.utils.get_cached_diagram')
|
||||
def test_render_diagram_success(self, mock_get_cached):
|
||||
"""Test rendering diagram with successful caching"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
mock_get_cached.return_value = "diagram_cache/plantuml/abc123.svg"
|
||||
|
||||
diagram_content = """plantuml
|
||||
@startuml
|
||||
Alice -> Bob: Hello
|
||||
@enduml"""
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_diagram,
|
||||
inhalt=diagram_content,
|
||||
order=1
|
||||
)
|
||||
|
||||
result = render_textabschnitte(VorgabeLangtext.objects.filter(abschnitt=self.vorgabe))
|
||||
typ, html = result[0]
|
||||
self.assertEqual(typ, "diagramm")
|
||||
self.assertIn('<img', html)
|
||||
self.assertIn('width="100%"', html)
|
||||
self.assertIn('diagram_cache/plantuml/abc123.svg', html)
|
||||
|
||||
# Verify get_cached_diagram was called correctly
|
||||
mock_get_cached.assert_called_once()
|
||||
args = mock_get_cached.call_args[0]
|
||||
self.assertEqual(args[0], "plantuml")
|
||||
self.assertIn("Alice -> Bob", args[1])
|
||||
|
||||
@patch('abschnitte.utils.get_cached_diagram')
|
||||
def test_render_diagram_with_options(self, mock_get_cached):
|
||||
"""Test rendering diagram with custom options"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
mock_get_cached.return_value = "diagram_cache/mermaid/xyz789.svg"
|
||||
|
||||
diagram_content = """mermaid
|
||||
option: width="50%" height="300px"
|
||||
graph TD
|
||||
A-->B"""
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_diagram,
|
||||
inhalt=diagram_content,
|
||||
order=1
|
||||
)
|
||||
|
||||
result = render_textabschnitte(VorgabeLangtext.objects.filter(abschnitt=self.vorgabe))
|
||||
typ, html = result[0]
|
||||
self.assertIn('width="50%"', html)
|
||||
self.assertIn('height="300px"', html)
|
||||
|
||||
@patch('abschnitte.utils.get_cached_diagram')
|
||||
def test_render_diagram_error(self, mock_get_cached):
|
||||
"""Test rendering diagram when caching fails"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
mock_get_cached.side_effect = Exception("Connection error")
|
||||
|
||||
diagram_content = """plantuml
|
||||
@startuml
|
||||
A -> B
|
||||
@enduml"""
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_diagram,
|
||||
inhalt=diagram_content,
|
||||
order=1
|
||||
)
|
||||
|
||||
result = render_textabschnitte(VorgabeLangtext.objects.filter(abschnitt=self.vorgabe))
|
||||
typ, html = result[0]
|
||||
self.assertIn("Error generating diagram", html)
|
||||
self.assertIn("Connection error", html)
|
||||
self.assertIn('class="text-danger"', html)
|
||||
|
||||
def test_render_multiple_abschnitte(self):
|
||||
"""Test rendering multiple Textabschnitte in order"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
abschnitt1 = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_text,
|
||||
inhalt="First section",
|
||||
order=1
|
||||
)
|
||||
abschnitt2 = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_unordered,
|
||||
inhalt="Item 1\nItem 2",
|
||||
order=2
|
||||
)
|
||||
abschnitt3 = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_code,
|
||||
inhalt="print('hello')",
|
||||
order=3
|
||||
)
|
||||
|
||||
result = render_textabschnitte(
|
||||
VorgabeLangtext.objects.filter(abschnitt=self.vorgabe).order_by('order')
|
||||
)
|
||||
|
||||
self.assertEqual(len(result), 3)
|
||||
self.assertEqual(result[0][0], "text")
|
||||
self.assertEqual(result[1][0], "liste ungeordnet")
|
||||
self.assertEqual(result[2][0], "code")
|
||||
|
||||
def test_render_abschnitt_without_type(self):
|
||||
"""Test rendering Textabschnitt without AbschnittTyp"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=None,
|
||||
inhalt="Content without type",
|
||||
order=1
|
||||
)
|
||||
|
||||
result = render_textabschnitte(VorgabeLangtext.objects.filter(abschnitt=self.vorgabe))
|
||||
typ, html = result[0]
|
||||
self.assertEqual(typ, '')
|
||||
self.assertIn("Content without type", html)
|
||||
|
||||
def test_render_abschnitt_with_empty_content(self):
|
||||
"""Test rendering Textabschnitt with empty content"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_text,
|
||||
inhalt=None,
|
||||
order=1
|
||||
)
|
||||
|
||||
result = render_textabschnitte(VorgabeLangtext.objects.filter(abschnitt=self.vorgabe))
|
||||
self.assertEqual(len(result), 1)
|
||||
typ, html = result[0]
|
||||
self.assertEqual(typ, "text")
|
||||
|
||||
def test_render_textabschnitte_xss_prevention(self):
|
||||
"""Test that malicious HTML is sanitized in rendered content"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
# Create content with malicious HTML
|
||||
malicious_abschnitt = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_text,
|
||||
inhalt='<script>alert("xss")</script><img src=x onerror=alert(1)>Normal text',
|
||||
order=1
|
||||
)
|
||||
|
||||
result = render_textabschnitte(VorgabeLangtext.objects.filter(pk=malicious_abschnitt.pk))
|
||||
|
||||
self.assertEqual(len(result), 1)
|
||||
typ, html = result[0]
|
||||
self.assertEqual(typ, "text")
|
||||
|
||||
# Dangerous tags and attributes should be removed or sanitized
|
||||
self.assertNotIn('<script>', html) # Script tags should not be present unescaped
|
||||
self.assertNotIn('onerror', html) # Dangerous attributes removed
|
||||
# Note: 'alert' may still be present in escaped script tags, which is safe
|
||||
|
||||
# Safe content should remain
|
||||
self.assertIn('Normal text', html)
|
||||
|
||||
|
||||
class MdTableToHtmlTest(TestCase):
|
||||
"""Test cases for md_table_to_html function"""
|
||||
|
||||
def test_simple_table(self):
|
||||
"""Test converting a simple markdown table to HTML"""
|
||||
md = """| Name | Age |
|
||||
|------|-----|
|
||||
| John | 30 |
|
||||
| Jane | 25 |"""
|
||||
|
||||
html = md_table_to_html(md)
|
||||
|
||||
self.assertIn('<table class="table table-bordered table-hover">', html)
|
||||
self.assertIn("<thead>", html)
|
||||
self.assertIn("<th>Name</th>", html)
|
||||
self.assertIn("<th>Age</th>", html)
|
||||
self.assertIn("<tbody>", html)
|
||||
self.assertIn("<td>John</td>", html)
|
||||
self.assertIn("<td>30</td>", html)
|
||||
self.assertIn("<td>Jane</td>", html)
|
||||
self.assertIn("<td>25</td>", html)
|
||||
|
||||
def test_table_with_multiple_rows(self):
|
||||
"""Test table with multiple rows"""
|
||||
md = """| A | B | C |
|
||||
|---|---|---|
|
||||
| 1 | 2 | 3 |
|
||||
| 4 | 5 | 6 |
|
||||
| 7 | 8 | 9 |"""
|
||||
|
||||
html = md_table_to_html(md)
|
||||
|
||||
self.assertEqual(html.count("<tr>"), 4) # 1 header + 3 body rows
|
||||
self.assertEqual(html.count("<td>"), 9) # 3x3 cells
|
||||
self.assertEqual(html.count("<th>"), 3) # 3 headers
|
||||
|
||||
def test_table_with_spaces(self):
|
||||
"""Test table with extra spaces"""
|
||||
md = """ | Header 1 | Header 2 |
|
||||
| --------- | ---------- |
|
||||
| Value 1 | Value 2 | """
|
||||
|
||||
html = md_table_to_html(md)
|
||||
|
||||
self.assertIn("<th>Header 1</th>", html)
|
||||
self.assertIn("<th>Header 2</th>", html)
|
||||
self.assertIn("<td>Value 1</td>", html)
|
||||
self.assertIn("<td>Value 2</td>", html)
|
||||
|
||||
def test_table_with_empty_cells(self):
|
||||
"""Test table with empty cells"""
|
||||
md = """| Col1 | Col2 | Col3 |
|
||||
|------|------|------|
|
||||
| A | | C |
|
||||
| | B | |"""
|
||||
|
||||
html = md_table_to_html(md)
|
||||
|
||||
self.assertIn("<td>A</td>", html)
|
||||
self.assertIn("<td></td>", html)
|
||||
self.assertIn("<td>C</td>", html)
|
||||
self.assertIn("<td>B</td>", html)
|
||||
|
||||
def test_table_insufficient_lines(self):
|
||||
"""Test that ValueError is raised for insufficient lines"""
|
||||
md = """| Header |"""
|
||||
|
||||
with self.assertRaises(ValueError) as context:
|
||||
md_table_to_html(md)
|
||||
|
||||
self.assertIn("at least header + separator", str(context.exception))
|
||||
|
||||
def test_table_empty_string(self):
|
||||
"""Test that ValueError is raised for empty string"""
|
||||
with self.assertRaises(ValueError):
|
||||
md_table_to_html("")
|
||||
|
||||
def test_table_only_whitespace(self):
|
||||
"""Test that ValueError is raised for only whitespace"""
|
||||
with self.assertRaises(ValueError):
|
||||
md_table_to_html(" \n \n ")
|
||||
|
||||
|
||||
class DiagramCacheTest(TestCase):
|
||||
"""Test cases for diagram caching functionality"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test environment"""
|
||||
# Create a temporary directory for testing
|
||||
self.test_media_root = tempfile.mkdtemp()
|
||||
self.original_media_root = settings.MEDIA_ROOT
|
||||
settings.MEDIA_ROOT = self.test_media_root
|
||||
|
||||
def tearDown(self):
|
||||
"""Clean up test environment"""
|
||||
# Restore original settings
|
||||
settings.MEDIA_ROOT = self.original_media_root
|
||||
# Remove test directory
|
||||
if os.path.exists(self.test_media_root):
|
||||
shutil.rmtree(self.test_media_root)
|
||||
|
||||
def test_compute_hash(self):
|
||||
"""Test that compute_hash generates consistent SHA256 hashes"""
|
||||
content1 = "test content"
|
||||
content2 = "test content"
|
||||
content3 = "different content"
|
||||
|
||||
hash1 = compute_hash(content1)
|
||||
hash2 = compute_hash(content2)
|
||||
hash3 = compute_hash(content3)
|
||||
|
||||
# Same content should produce same hash
|
||||
self.assertEqual(hash1, hash2)
|
||||
# Different content should produce different hash
|
||||
self.assertNotEqual(hash1, hash3)
|
||||
# Hash should be 64 characters (SHA256 hex)
|
||||
self.assertEqual(len(hash1), 64)
|
||||
|
||||
def test_get_cache_path(self):
|
||||
"""Test that get_cache_path generates correct paths"""
|
||||
diagram_type = "plantuml"
|
||||
content_hash = "abc123"
|
||||
|
||||
path = get_cache_path(diagram_type, content_hash)
|
||||
|
||||
self.assertIn("diagram_cache", path)
|
||||
self.assertIn("plantuml", path)
|
||||
self.assertIn("abc123.svg", path)
|
||||
|
||||
@patch('diagramm_proxy.diagram_cache.requests.post')
|
||||
@patch('diagramm_proxy.diagram_cache.default_storage')
|
||||
def test_get_cached_diagram_miss(self, mock_storage, mock_post):
|
||||
"""Test diagram generation on cache miss"""
|
||||
# Setup mocks
|
||||
mock_storage.exists.return_value = False
|
||||
mock_storage.path.return_value = os.path.join(
|
||||
self.test_media_root, 'diagram_cache/plantuml/test.svg'
|
||||
)
|
||||
mock_response = Mock()
|
||||
mock_response.content = b'<svg>test</svg>'
|
||||
mock_post.return_value = mock_response
|
||||
|
||||
diagram_content = "@startuml\nA -> B\n@enduml"
|
||||
|
||||
# Call function
|
||||
result = get_cached_diagram("plantuml", diagram_content)
|
||||
|
||||
# Verify POST request was made
|
||||
mock_post.assert_called_once()
|
||||
call_args = mock_post.call_args
|
||||
# Check URL in positional args (first argument)
|
||||
self.assertIn("plantuml/svg", call_args[0][0])
|
||||
|
||||
# Verify storage.save was called
|
||||
mock_storage.save.assert_called_once()
|
||||
|
||||
@patch('diagramm_proxy.diagram_cache.default_storage')
|
||||
def test_get_cached_diagram_hit(self, mock_storage):
|
||||
"""Test diagram retrieval on cache hit"""
|
||||
# Setup mock - diagram exists in cache
|
||||
mock_storage.exists.return_value = True
|
||||
|
||||
diagram_content = "@startuml\nA -> B\n@enduml"
|
||||
|
||||
# Call function
|
||||
result = get_cached_diagram("plantuml", diagram_content)
|
||||
|
||||
# Verify no save was attempted (cache hit)
|
||||
mock_storage.save.assert_not_called()
|
||||
|
||||
# Verify result contains expected path elements
|
||||
self.assertIn("diagram_cache", result)
|
||||
self.assertIn("plantuml", result)
|
||||
self.assertIn(".svg", result)
|
||||
|
||||
@patch('diagramm_proxy.diagram_cache.requests.post')
|
||||
@patch('diagramm_proxy.diagram_cache.default_storage')
|
||||
def test_get_cached_diagram_request_error(self, mock_storage, mock_post):
|
||||
"""Test that request errors are properly raised"""
|
||||
import requests
|
||||
|
||||
mock_storage.exists.return_value = False
|
||||
mock_storage.path.return_value = os.path.join(
|
||||
self.test_media_root, 'diagram_cache/plantuml/test.svg'
|
||||
)
|
||||
mock_post.side_effect = requests.RequestException("Connection error")
|
||||
|
||||
with self.assertRaises(requests.RequestException):
|
||||
get_cached_diagram("plantuml", "@startuml\nA -> B\n@enduml")
|
||||
|
||||
@patch('diagramm_proxy.diagram_cache.default_storage')
|
||||
def test_clear_cache_specific_type(self, mock_storage):
|
||||
"""Test clearing cache for specific diagram type"""
|
||||
# Create real test cache structure for this test
|
||||
cache_dir = os.path.join(self.test_media_root, 'diagram_cache', 'plantuml')
|
||||
os.makedirs(cache_dir, exist_ok=True)
|
||||
|
||||
# Create test files
|
||||
test_file1 = os.path.join(cache_dir, 'test1.svg')
|
||||
test_file2 = os.path.join(cache_dir, 'test2.svg')
|
||||
open(test_file1, 'w').close()
|
||||
open(test_file2, 'w').close()
|
||||
|
||||
# Mock storage methods
|
||||
mock_storage.exists.return_value = True
|
||||
mock_storage.path.return_value = cache_dir
|
||||
|
||||
# Clear cache
|
||||
clear_cache('plantuml')
|
||||
|
||||
# Verify files are deleted
|
||||
self.assertFalse(os.path.exists(test_file1))
|
||||
self.assertFalse(os.path.exists(test_file2))
|
||||
|
||||
@patch('diagramm_proxy.diagram_cache.default_storage')
|
||||
def test_clear_cache_all_types(self, mock_storage):
|
||||
"""Test clearing cache for all diagram types"""
|
||||
# Create real test cache structure with multiple types
|
||||
cache_root = os.path.join(self.test_media_root, 'diagram_cache')
|
||||
for diagram_type in ['plantuml', 'mermaid', 'graphviz']:
|
||||
cache_dir = os.path.join(cache_root, diagram_type)
|
||||
os.makedirs(cache_dir, exist_ok=True)
|
||||
test_file = os.path.join(cache_dir, 'test.svg')
|
||||
open(test_file, 'w').close()
|
||||
|
||||
# Mock storage methods
|
||||
mock_storage.exists.return_value = True
|
||||
mock_storage.path.return_value = cache_root
|
||||
|
||||
# Clear all cache
|
||||
clear_cache()
|
||||
|
||||
# Verify all files are deleted
|
||||
for diagram_type in ['plantuml', 'mermaid', 'graphviz']:
|
||||
test_file = os.path.join(cache_root, diagram_type, 'test.svg')
|
||||
self.assertFalse(os.path.exists(test_file))
|
||||
|
||||
|
||||
class ClearDiagramCacheCommandTest(TestCase):
|
||||
"""Test cases for clear_diagram_cache management command"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test environment"""
|
||||
self.test_media_root = tempfile.mkdtemp()
|
||||
self.original_media_root = settings.MEDIA_ROOT
|
||||
settings.MEDIA_ROOT = self.test_media_root
|
||||
|
||||
def tearDown(self):
|
||||
"""Clean up test environment"""
|
||||
settings.MEDIA_ROOT = self.original_media_root
|
||||
if os.path.exists(self.test_media_root):
|
||||
shutil.rmtree(self.test_media_root)
|
||||
|
||||
def test_command_without_type(self):
|
||||
"""Test running command without specifying type"""
|
||||
# Create test cache
|
||||
cache_dir = os.path.join(self.test_media_root, 'diagram_cache', 'plantuml')
|
||||
os.makedirs(cache_dir, exist_ok=True)
|
||||
test_file = os.path.join(cache_dir, 'test.svg')
|
||||
open(test_file, 'w').close()
|
||||
|
||||
# Run command
|
||||
out = StringIO()
|
||||
call_command('clear_diagram_cache', stdout=out)
|
||||
|
||||
# Check output
|
||||
self.assertIn('Clearing all diagram caches', out.getvalue())
|
||||
self.assertIn('Cache cleared successfully', out.getvalue())
|
||||
|
||||
def test_command_with_type(self):
|
||||
"""Test running command with specific diagram type"""
|
||||
# Create test cache
|
||||
cache_dir = os.path.join(self.test_media_root, 'diagram_cache', 'mermaid')
|
||||
os.makedirs(cache_dir, exist_ok=True)
|
||||
test_file = os.path.join(cache_dir, 'test.svg')
|
||||
open(test_file, 'w').close()
|
||||
|
||||
# Run command
|
||||
out = StringIO()
|
||||
call_command('clear_diagram_cache', type='mermaid', stdout=out)
|
||||
|
||||
# Check output
|
||||
self.assertIn('Clearing cache for mermaid', out.getvalue())
|
||||
self.assertIn('Cache cleared successfully', out.getvalue())
|
||||
|
||||
|
||||
class IntegrationTest(TestCase):
|
||||
"""Integration tests with actual dokumente models"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data using dokumente models"""
|
||||
from dokumente.models import (
|
||||
Dokumententyp, Dokument, Vorgabe, VorgabeLangtext, Thema
|
||||
)
|
||||
from datetime import date
|
||||
|
||||
# Create required objects
|
||||
self.dokumententyp = Dokumententyp.objects.create(
|
||||
name="Test Policy",
|
||||
verantwortliche_ve="TEST"
|
||||
)
|
||||
|
||||
self.dokument = Dokument.objects.create(
|
||||
nummer="TEST-001",
|
||||
name="Test Document",
|
||||
dokumententyp=self.dokumententyp,
|
||||
aktiv=True
|
||||
)
|
||||
|
||||
self.thema = Thema.objects.create(name="Test Thema")
|
||||
self.vorgabe = Vorgabe.objects.create(
|
||||
dokument=self.dokument,
|
||||
nummer=1,
|
||||
order=1,
|
||||
thema=self.thema,
|
||||
titel="Test Vorgabe",
|
||||
gueltigkeit_von=date.today()
|
||||
)
|
||||
|
||||
# Create AbschnittTypen
|
||||
self.typ_text = AbschnittTyp.objects.create(abschnitttyp="text")
|
||||
|
||||
# Create VorgabeLangtext (which inherits from Textabschnitt)
|
||||
self.langtext = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.typ_text,
|
||||
inhalt="# Test\n\nThis is a **test** vorgabe.",
|
||||
order=1
|
||||
)
|
||||
|
||||
def test_render_vorgabe_langtext(self):
|
||||
"""Test rendering VorgabeLangtext through render_textabschnitte"""
|
||||
from dokumente.models import VorgabeLangtext
|
||||
|
||||
result = render_textabschnitte(
|
||||
VorgabeLangtext.objects.filter(abschnitt=self.vorgabe).order_by('order')
|
||||
)
|
||||
|
||||
self.assertEqual(len(result), 1)
|
||||
typ, html = result[0]
|
||||
self.assertEqual(typ, "text")
|
||||
self.assertIn("<h1>Test</h1>", html)
|
||||
self.assertIn("<strong>test</strong>", html)
|
||||
self.assertIn("vorgabe", html)
|
||||
|
||||
def test_textabschnitt_inheritance(self):
|
||||
"""Test that VorgabeLangtext properly inherits Textabschnitt fields"""
|
||||
self.assertEqual(self.langtext.abschnitttyp, self.typ_text)
|
||||
self.assertIn("test", self.langtext.inhalt)
|
||||
self.assertEqual(self.langtext.order, 1)
|
||||
|
||||
@@ -3,9 +3,35 @@ import base64
|
||||
import zlib
|
||||
import re
|
||||
from textwrap import dedent
|
||||
from django.conf import settings
|
||||
import bleach
|
||||
|
||||
# Import the caching function
|
||||
from diagramm_proxy.diagram_cache import get_cached_diagram
|
||||
|
||||
DIAGRAMMSERVER="/diagramm"
|
||||
|
||||
# Allowed HTML tags for bleach sanitization
|
||||
ALLOWED_TAGS = [
|
||||
'p', 'br', 'strong', 'em', 'u', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6',
|
||||
'ul', 'ol', 'li', 'blockquote', 'code', 'pre', 'hr',
|
||||
'table', 'thead', 'tbody', 'tr', 'th', 'td',
|
||||
'img', 'a', 'sup', 'sub', 'span', 'div'
|
||||
]
|
||||
|
||||
ALLOWED_ATTRIBUTES = {
|
||||
'img': ['src', 'alt', 'width', 'height'],
|
||||
'a': ['href', 'title'],
|
||||
'span': ['class'],
|
||||
'div': ['class'],
|
||||
'p': ['class'],
|
||||
'table': ['class'],
|
||||
'th': ['colspan', 'rowspan', 'class'],
|
||||
'td': ['colspan', 'rowspan', 'class'],
|
||||
'pre': ['class'],
|
||||
'code': ['class'],
|
||||
}
|
||||
|
||||
def render_textabschnitte(queryset):
|
||||
"""
|
||||
Converts a queryset of Textabschnitt-like models into a list of (typ, html) tuples.
|
||||
@@ -25,21 +51,31 @@ def render_textabschnitte(queryset):
|
||||
elif typ == "tabelle":
|
||||
html = md_table_to_html(inhalt)
|
||||
elif typ == "diagramm":
|
||||
temp=inhalt.splitlines()
|
||||
diagramtype=temp.pop(0)
|
||||
diagramoptions='width="100%"'
|
||||
if temp[0][0:6].lower() == "option":
|
||||
diagramoptions=temp.pop(0).split(":",1)[1]
|
||||
rest="\n".join(temp)
|
||||
html = '<p><img '+diagramoptions+' src="'+DIAGRAMMSERVER+"/"+diagramtype+"/svg/"
|
||||
html += base64.urlsafe_b64encode(zlib.compress(rest.encode("utf-8"),9)).decode()
|
||||
html += '"></p>'
|
||||
temp = inhalt.splitlines()
|
||||
diagramtype = temp.pop(0)
|
||||
diagramoptions = 'width="100%"'
|
||||
if temp and temp[0][0:6].lower() == "option":
|
||||
diagramoptions = temp.pop(0).split(":", 1)[1]
|
||||
rest = "\n".join(temp)
|
||||
|
||||
# Use caching instead of URL encoding
|
||||
try:
|
||||
cache_path = get_cached_diagram(diagramtype, rest)
|
||||
# Generate URL to serve from media/static
|
||||
diagram_url = settings.MEDIA_URL + cache_path
|
||||
html = f'<p><img {diagramoptions} src="{diagram_url}"></p>'
|
||||
except Exception as e:
|
||||
# Fallback to error message
|
||||
html = f'<p class="text-danger">Error generating diagram: {str(e)}</p>'
|
||||
|
||||
elif typ == "code":
|
||||
html = "<pre><code>"
|
||||
html += markdown(inhalt, extensions=['tables', 'attr_list'])
|
||||
html += "</code></pre>"
|
||||
else:
|
||||
html = markdown(inhalt, extensions=['tables', 'attr_list','footnotes'])
|
||||
# Sanitize HTML to prevent XSS
|
||||
html = bleach.clean(html, tags=ALLOWED_TAGS, attributes=ALLOWED_ATTRIBUTES)
|
||||
output.append((typ, html))
|
||||
return output
|
||||
|
||||
|
||||
102
admin/css/vorgabe_border.css
Normal file
102
admin/css/vorgabe_border.css
Normal file
@@ -0,0 +1,102 @@
|
||||
/* Better visual separation for Vorgaben inlines */
|
||||
.inline-group[data-inline-model="vorgabe"] {
|
||||
border: 2px solid #ddd;
|
||||
border-radius: 8px;
|
||||
margin-bottom: 20px;
|
||||
padding: 15px;
|
||||
background-color: #f9f9f9;
|
||||
box-shadow: 0 2px 4px rgba(0,0,0,0.1);
|
||||
}
|
||||
|
||||
.inline-group[data-inline-model="vorgabe"] .inline-related {
|
||||
border: 1px solid #ccc;
|
||||
border-radius: 6px;
|
||||
margin-bottom: 10px;
|
||||
background-color: white;
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
.inline-group[data-inline-model="vorgabe"] h3 {
|
||||
background-color: #007cba;
|
||||
color: white;
|
||||
padding: 8px 12px;
|
||||
margin: -15px -15px 10px -15px;
|
||||
border-radius: 6px 6px 0 0;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.inline-group[data-inline-model="vorgabe"] .collapse .inline-related {
|
||||
border-left: 3px solid #007cba;
|
||||
}
|
||||
|
||||
/* Better spacing for nested inlines */
|
||||
.inline-group[data-inline-model="vorgabe"] .inline-group {
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
.inline-group[data-inline-model="vorgabe"] .inline-group h3 {
|
||||
background-color: #f0f8ff;
|
||||
color: #333;
|
||||
padding: 6px 10px;
|
||||
margin: 0 0 8px 0;
|
||||
border-left: 3px solid #007cba;
|
||||
}
|
||||
|
||||
/* Highlight active/expanded vorgabe */
|
||||
.inline-group[data-inline-model="vorgabe"] .inline-related:not(.collapsed) {
|
||||
border-color: #007cba;
|
||||
box-shadow: 0 0 8px rgba(0,124,186,0.2);
|
||||
}
|
||||
|
||||
/* Highlight actively edited vorgabe */
|
||||
.inline-group[data-inline-model="vorgabe"] .inline-related.active-edit {
|
||||
border-color: #28a745;
|
||||
box-shadow: 0 0 12px rgba(40,167,69,0.3);
|
||||
background-color: #f8fff9;
|
||||
}
|
||||
|
||||
/* Toggle hint styling */
|
||||
.toggle-hint {
|
||||
font-size: 0.8em;
|
||||
color: #666;
|
||||
font-weight: normal;
|
||||
}
|
||||
|
||||
/* Better fieldset styling for vorgabe inlines */
|
||||
.inline-group[data-inline-model="vorgabe"] .fieldset {
|
||||
border: 1px solid #e0e0e0;
|
||||
border-radius: 4px;
|
||||
padding: 10px;
|
||||
margin-bottom: 10px;
|
||||
background-color: #fafafa;
|
||||
}
|
||||
|
||||
.inline-group[data-inline-model="vorgabe"] .fieldset h2 {
|
||||
background-color: #e3f2fd;
|
||||
color: #1565c0;
|
||||
padding: 5px 10px;
|
||||
margin: -10px -10px 10px -10px;
|
||||
border-radius: 4px 4px 0 0;
|
||||
font-size: 0.9em;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* Better form layout */
|
||||
.inline-group[data-inline-model="vorgabe"] .form-row {
|
||||
border-bottom: 1px solid #eee;
|
||||
padding: 8px 0;
|
||||
}
|
||||
|
||||
.inline-group[data-inline-model="vorgabe"] .form-row:last-child {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
/* Wide fields styling */
|
||||
.inline-group[data-inline-model="vorgabe"] .wide .form-row > div {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.inline-group[data-inline-model="vorgabe"] .wide textarea {
|
||||
width: 100%;
|
||||
min-height: 80px;
|
||||
}
|
||||
25
admin/js/vorgabe_toggle.js
Normal file
25
admin/js/vorgabe_toggle.js
Normal file
@@ -0,0 +1,25 @@
|
||||
(function($) {
|
||||
'use strict';
|
||||
|
||||
$(document).ready(function() {
|
||||
// Add toggle buttons for each vorgabe inline
|
||||
$('.inline-group[data-inline-model="vorgabe"]').each(function() {
|
||||
var $group = $(this);
|
||||
var $headers = $group.find('h3');
|
||||
|
||||
$headers.css('cursor', 'pointer').append(' <span class="toggle-hint">(klicken zum umschalten)</span>');
|
||||
|
||||
$headers.on('click', function(e) {
|
||||
e.preventDefault();
|
||||
var $inline = $(this).closest('.inline-related');
|
||||
$inline.find('.collapse').toggleClass('collapsed');
|
||||
});
|
||||
});
|
||||
|
||||
// Highlight active vorgabe when editing
|
||||
$('.inline-group[data-inline-model="vorgabe"] .inline-related').on('click', function() {
|
||||
$('.inline-group[data-inline-model="vorgabe"] .inline-related').removeClass('active-edit');
|
||||
$(this).addClass('active-edit');
|
||||
});
|
||||
});
|
||||
})(django.jQuery);
|
||||
@@ -5,7 +5,8 @@ metadata:
|
||||
namespace: vorgabenui
|
||||
spec:
|
||||
accessModes:
|
||||
- ReadWriteOnce
|
||||
- ReadWriteMany
|
||||
storageClassName: nfs
|
||||
resources:
|
||||
requests:
|
||||
storage: 2Gi
|
||||
|
||||
@@ -18,14 +18,14 @@ spec:
|
||||
fsGroupChangePolicy: "OnRootMismatch"
|
||||
initContainers:
|
||||
- name: loader
|
||||
image: git.baumann.gr/adebaumann/vgui-data-loader:0.5
|
||||
image: git.baumann.gr/adebaumann/vui-data-loader:0.10
|
||||
command: [ "sh","-c","cp -n preload/preload.sqlite3 /data/db.sqlite3; chown -R 999:999 /data; ls -la /data; sleep 10; exit 0" ]
|
||||
volumeMounts:
|
||||
- name: data
|
||||
mountPath: /data
|
||||
containers:
|
||||
- name: web
|
||||
image: git.baumann.gr/adebaumann/vui:0.929
|
||||
image: git.baumann.gr/adebaumann/vui:0.968
|
||||
imagePullPolicy: Always
|
||||
ports:
|
||||
- containerPort: 8000
|
||||
@@ -63,6 +63,8 @@ spec:
|
||||
selector:
|
||||
app: django
|
||||
ports:
|
||||
- port: 8000
|
||||
- name: http
|
||||
protocol: TCP
|
||||
port: 8000
|
||||
targetPort: 8000
|
||||
|
||||
|
||||
@@ -4,8 +4,9 @@ metadata:
|
||||
name: django
|
||||
namespace: vorgabenui
|
||||
annotations:
|
||||
nginx.ingress.kubernetes.io/rewrite-target: /
|
||||
argocd.argoproj.io/ignore-healthcheck: "true"
|
||||
spec:
|
||||
ingressClassName: traefik
|
||||
rules:
|
||||
- host: vorgabenportal.knowyoursecurity.com
|
||||
http:
|
||||
|
||||
15
argocd/nfs-pv.yaml
Normal file
15
argocd/nfs-pv.yaml
Normal file
@@ -0,0 +1,15 @@
|
||||
apiVersion: v1
|
||||
kind: PersistentVolume
|
||||
metadata:
|
||||
name: django-data-pv
|
||||
namespace: vorgabenui
|
||||
spec:
|
||||
capacity:
|
||||
storage: 2Gi
|
||||
accessModes:
|
||||
- ReadWriteMany
|
||||
persistentVolumeReclaimPolicy: Retain
|
||||
storageClassName: nfs
|
||||
nfs:
|
||||
server: 192.168.17.199
|
||||
path: /mnt/user/vorgabenui
|
||||
8
argocd/nfs-storageclass.yaml
Normal file
8
argocd/nfs-storageclass.yaml
Normal file
@@ -0,0 +1,8 @@
|
||||
apiVersion: storage.k8s.io/v1
|
||||
kind: StorageClass
|
||||
metadata:
|
||||
name: nfs
|
||||
provisioner: kubernetes.io/no-provisioner
|
||||
allowVolumeExpansion: true
|
||||
reclaimPolicy: Retain
|
||||
volumeBindingMode: Immediate
|
||||
Binary file not shown.
BIN
data/db.sqlite3
BIN
data/db.sqlite3
Binary file not shown.
91
diagramm_proxy/diagram_cache.py
Normal file
91
diagramm_proxy/diagram_cache.py
Normal file
@@ -0,0 +1,91 @@
|
||||
import hashlib
|
||||
import os
|
||||
import requests
|
||||
from pathlib import Path
|
||||
from django.conf import settings
|
||||
from django.core.files.storage import default_storage
|
||||
from django.core.files.base import ContentFile
|
||||
import logging
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
# Configure cache directory
|
||||
CACHE_DIR = getattr(settings, 'DIAGRAM_CACHE_DIR', 'diagram_cache')
|
||||
KROKI_UPSTREAM = "http://svckroki:8000"
|
||||
|
||||
def get_cache_path(diagram_type, content_hash):
|
||||
"""Generate cache file path for a diagram."""
|
||||
return os.path.join(CACHE_DIR, diagram_type, f"{content_hash}.svg")
|
||||
|
||||
def compute_hash(content):
|
||||
"""Compute SHA256 hash of diagram content."""
|
||||
return hashlib.sha256(content.encode('utf-8')).hexdigest()
|
||||
|
||||
def get_cached_diagram(diagram_type, diagram_content):
|
||||
"""
|
||||
Retrieve diagram from cache or generate it via POST.
|
||||
|
||||
Args:
|
||||
diagram_type: Type of diagram (e.g., 'plantuml', 'mermaid')
|
||||
diagram_content: Raw diagram content
|
||||
|
||||
Returns:
|
||||
Path to cached diagram file (relative to MEDIA_ROOT)
|
||||
"""
|
||||
content_hash = compute_hash(diagram_content)
|
||||
cache_path = get_cache_path(diagram_type, content_hash)
|
||||
|
||||
# Check if diagram exists in cache
|
||||
if default_storage.exists(cache_path):
|
||||
logger.debug(f"Cache hit for {diagram_type} diagram: {content_hash[:8]}")
|
||||
return cache_path
|
||||
|
||||
# Generate diagram via POST request
|
||||
logger.info(f"Cache miss for {diagram_type} diagram: {content_hash[:8]}, generating...")
|
||||
try:
|
||||
url = f"{KROKI_UPSTREAM}/{diagram_type}/svg"
|
||||
response = requests.post(
|
||||
url,
|
||||
data=diagram_content.encode('utf-8'),
|
||||
headers={'Content-Type': 'text/plain'},
|
||||
timeout=30
|
||||
)
|
||||
response.raise_for_status()
|
||||
|
||||
# Ensure cache directory exists
|
||||
cache_dir = os.path.dirname(default_storage.path(cache_path))
|
||||
os.makedirs(cache_dir, exist_ok=True)
|
||||
|
||||
# Save to cache
|
||||
default_storage.save(cache_path, ContentFile(response.content))
|
||||
logger.info(f"Diagram cached successfully: {cache_path}")
|
||||
|
||||
return cache_path
|
||||
|
||||
except requests.RequestException as e:
|
||||
logger.error(f"Error generating diagram: {e}")
|
||||
raise
|
||||
|
||||
def clear_cache(diagram_type=None):
|
||||
"""
|
||||
Clear cached diagrams.
|
||||
|
||||
Args:
|
||||
diagram_type: If specified, only clear diagrams of this type
|
||||
"""
|
||||
if diagram_type:
|
||||
cache_path = os.path.join(CACHE_DIR, diagram_type)
|
||||
else:
|
||||
cache_path = CACHE_DIR
|
||||
|
||||
if default_storage.exists(cache_path):
|
||||
full_path = default_storage.path(cache_path)
|
||||
# Walk through and delete files
|
||||
for root, dirs, files in os.walk(full_path):
|
||||
for file in files:
|
||||
file_path = os.path.join(root, file)
|
||||
try:
|
||||
os.remove(file_path)
|
||||
logger.info(f"Deleted cached diagram: {file_path}")
|
||||
except OSError as e:
|
||||
logger.error(f"Error deleting {file_path}: {e}")
|
||||
@@ -1,4 +0,0 @@
|
||||
from revproxy.views import ProxyView
|
||||
|
||||
class DiagrammProxyView(ProxyView):
|
||||
upstream = "http://svckroki:8000/"
|
||||
298
dokumente/admin.py
Normal file
298
dokumente/admin.py
Normal file
@@ -0,0 +1,298 @@
|
||||
from django.contrib import admin
|
||||
#from nested_inline.admin import NestedStackedInline, NestedModelAdmin
|
||||
from nested_admin import NestedStackedInline, NestedModelAdmin, NestedTabularInline
|
||||
from django import forms
|
||||
from django.utils.html import format_html
|
||||
from mptt.forms import TreeNodeMultipleChoiceField
|
||||
from mptt.admin import DraggableMPTTAdmin
|
||||
from adminsortable2.admin import SortableInlineAdminMixin, SortableAdminBase
|
||||
|
||||
# Register your models here.
|
||||
from .models import *
|
||||
from stichworte.models import Stichwort, Stichworterklaerung
|
||||
from referenzen.models import Referenz
|
||||
|
||||
|
||||
|
||||
#class ChecklistenForm(forms.ModelForm):
|
||||
# class Meta:
|
||||
# model=Checklistenfrage
|
||||
# fields="__all__"
|
||||
# widgets = {
|
||||
# 'frage': forms.Textarea(attrs={'rows': 1, 'cols': 100}),
|
||||
# }
|
||||
|
||||
class ChecklistenfragenInline(NestedStackedInline):
|
||||
model=Checklistenfrage
|
||||
extra=0
|
||||
fk_name="vorgabe"
|
||||
classes = ['collapse']
|
||||
verbose_name_plural = "Checklistenfragen"
|
||||
fieldsets = (
|
||||
(None, {
|
||||
'fields': ('frage',),
|
||||
'classes': ('wide',),
|
||||
}),
|
||||
)
|
||||
|
||||
|
||||
class VorgabeKurztextInline(NestedStackedInline):
|
||||
model=VorgabeKurztext
|
||||
extra=0
|
||||
sortable_field_name = "order"
|
||||
show_change_link=True
|
||||
classes = ['collapse']
|
||||
verbose_name_plural = "Kurztext-Abschnitte"
|
||||
fieldsets = (
|
||||
(None, {
|
||||
'fields': ('abschnitttyp', 'inhalt', 'order'),
|
||||
'classes': ('wide',),
|
||||
}),
|
||||
)
|
||||
|
||||
class VorgabeLangtextInline(NestedStackedInline):
|
||||
model=VorgabeLangtext
|
||||
extra=0
|
||||
sortable_field_name = "order"
|
||||
show_change_link=True
|
||||
classes = ['collapse']
|
||||
verbose_name_plural = "Langtext-Abschnitte"
|
||||
fieldsets = (
|
||||
(None, {
|
||||
'fields': ('abschnitttyp', 'inhalt', 'order'),
|
||||
'classes': ('wide',),
|
||||
}),
|
||||
)
|
||||
|
||||
class GeltungsbereichInline(NestedStackedInline):
|
||||
model=Geltungsbereich
|
||||
extra=0
|
||||
sortable_field_name = "order"
|
||||
show_change_link=True
|
||||
classes = ['collapse']
|
||||
verbose_name_plural = "Geltungsbereich-Abschnitte"
|
||||
fieldsets = (
|
||||
(None, {
|
||||
'fields': ('abschnitttyp', 'inhalt', 'order'),
|
||||
'classes': ('wide',),
|
||||
}),
|
||||
)
|
||||
|
||||
class EinleitungInline(NestedStackedInline):
|
||||
model = Einleitung
|
||||
extra = 0
|
||||
sortable_field_name = "order"
|
||||
show_change_link = True
|
||||
classes = ['collapse']
|
||||
verbose_name_plural = "Einleitungs-Abschnitte"
|
||||
fieldsets = (
|
||||
(None, {
|
||||
'fields': ('abschnitttyp', 'inhalt', 'order'),
|
||||
'classes': ('wide',),
|
||||
}),
|
||||
)
|
||||
|
||||
class VorgabeForm(forms.ModelForm):
|
||||
referenzen = TreeNodeMultipleChoiceField(queryset=Referenz.objects.all(), required=False)
|
||||
class Meta:
|
||||
model = Vorgabe
|
||||
fields = '__all__'
|
||||
|
||||
class VorgabeInline(SortableInlineAdminMixin, NestedStackedInline):
|
||||
model = Vorgabe
|
||||
form = VorgabeForm
|
||||
extra = 0
|
||||
sortable_field_name = "order"
|
||||
show_change_link = False
|
||||
can_delete = False
|
||||
inlines = [VorgabeKurztextInline, VorgabeLangtextInline, ChecklistenfragenInline]
|
||||
autocomplete_fields = ['stichworte','referenzen','relevanz']
|
||||
# Remove collapse class so Vorgaben show by default
|
||||
|
||||
fieldsets = (
|
||||
('Grunddaten', {
|
||||
'fields': (('order', 'nummer'), ('thema', 'titel')),
|
||||
'classes': ('wide',),
|
||||
}),
|
||||
('Gültigkeit', {
|
||||
'fields': (('gueltigkeit_von', 'gueltigkeit_bis'),),
|
||||
'classes': ('wide',),
|
||||
}),
|
||||
('Verknüpfungen', {
|
||||
'fields': (('referenzen', 'stichworte', 'relevanz'),),
|
||||
'classes': ('wide',),
|
||||
}),
|
||||
)
|
||||
|
||||
class StichworterklaerungInline(NestedTabularInline):
|
||||
model=Stichworterklaerung
|
||||
extra=0
|
||||
sortable_field_name = "order"
|
||||
ordering=("order",)
|
||||
show_change_link = True
|
||||
|
||||
@admin.register(Stichwort)
|
||||
class StichwortAdmin(NestedModelAdmin):
|
||||
list_display = ('stichwort', 'vorgaben_count')
|
||||
search_fields = ('stichwort',)
|
||||
ordering=('stichwort',)
|
||||
inlines=[StichworterklaerungInline]
|
||||
readonly_fields = ('vorgaben_list',)
|
||||
fieldsets = (
|
||||
(None, {
|
||||
'fields': ('stichwort', 'vorgaben_list')
|
||||
}),
|
||||
)
|
||||
|
||||
def vorgaben_count(self, obj):
|
||||
"""Count the number of Vorgaben that have this Stichwort"""
|
||||
count = obj.vorgabe_set.count()
|
||||
return f"{count} Vorgabe{'n' if count != 1 else ''}"
|
||||
vorgaben_count.short_description = "Anzahl Vorgaben"
|
||||
|
||||
def vorgaben_list(self, obj):
|
||||
"""Display list of Vorgaben that use this Stichwort"""
|
||||
vorgaben = obj.vorgabe_set.select_related('dokument', 'thema').order_by('dokument__nummer', 'nummer')
|
||||
vorgaben_list = list(vorgaben) # Evaluate queryset once
|
||||
count = len(vorgaben_list)
|
||||
|
||||
if count == 0:
|
||||
return format_html("<em>Keine Vorgaben gefunden</em><p><strong>Gesamt: 0 Vorgaben</strong></p>")
|
||||
|
||||
html = "<div style='max-height: 300px; overflow-y: auto;'>"
|
||||
html += "<table style='width: 100%; border-collapse: collapse;'>"
|
||||
html += "<thead><tr style='background-color: #f5f5f5;'>"
|
||||
html += "<th style='padding: 8px; border: 1px solid #ddd; text-align: left;'>Vorgabe</th>"
|
||||
html += "<th style='padding: 8px; border: 1px solid #ddd; text-align: left;'>Titel</th>"
|
||||
html += "<th style='padding: 8px; border: 1px solid #ddd; text-align: left;'>Dokument</th>"
|
||||
html += "</tr></thead>"
|
||||
html += "<tbody>"
|
||||
|
||||
for vorgabe in vorgaben_list:
|
||||
html += "<tr>"
|
||||
html += f"<td style='padding: 6px; border: 1px solid #ddd;'>{vorgabe.Vorgabennummer()}</td>"
|
||||
html += f"<td style='padding: 6px; border: 1px solid #ddd;'>{vorgabe.titel}</td>"
|
||||
html += f"<td style='padding: 6px; border: 1px solid #ddd;'>{vorgabe.dokument.nummer} – {vorgabe.dokument.name}</td>"
|
||||
html += "</tr>"
|
||||
|
||||
html += "</tbody></table>"
|
||||
html += f"</div><p><strong>Gesamt: {count} Vorgabe{'n' if count != 1 else ''}</strong></p>"
|
||||
|
||||
return format_html(html)
|
||||
vorgaben_list.short_description = "Zugeordnete Vorgaben"
|
||||
|
||||
def get_queryset(self, request):
|
||||
"""Optimize queryset with related data"""
|
||||
return super().get_queryset(request).prefetch_related('vorgabe_set')
|
||||
|
||||
@admin.register(Person)
|
||||
class PersonAdmin(admin.ModelAdmin):
|
||||
class Media:
|
||||
js = ['admin/js/jquery.init.js', 'custom/js/inline_toggle.js']
|
||||
css = {'all': ['custom/css/admin_extras.css']}
|
||||
list_display=['name']
|
||||
ordering = ['name']
|
||||
|
||||
|
||||
|
||||
@admin.register(Dokument)
|
||||
class DokumentAdmin(SortableAdminBase, NestedModelAdmin):
|
||||
actions_on_top=True
|
||||
inlines = [EinleitungInline, GeltungsbereichInline, VorgabeInline]
|
||||
filter_horizontal=['autoren','pruefende']
|
||||
list_display=['nummer','name','dokumententyp','gueltigkeit_von','gueltigkeit_bis','aktiv']
|
||||
search_fields=['nummer','name']
|
||||
list_filter=['dokumententyp','aktiv','gueltigkeit_von']
|
||||
|
||||
fieldsets = (
|
||||
('Grunddaten', {
|
||||
'fields': ('nummer', 'name', 'dokumententyp', 'aktiv'),
|
||||
'classes': ('wide',),
|
||||
}),
|
||||
('Verantwortlichkeiten', {
|
||||
'fields': ('autoren', 'pruefende'),
|
||||
'classes': ('wide', 'collapse'),
|
||||
}),
|
||||
('Gültigkeit & Metadaten', {
|
||||
'fields': ('gueltigkeit_von', 'gueltigkeit_bis', 'signatur_cso', 'anhaenge'),
|
||||
'classes': ('wide', 'collapse'),
|
||||
}),
|
||||
)
|
||||
|
||||
class Media:
|
||||
js = ('admin/js/vorgabe_collapse.js',)
|
||||
css = {
|
||||
'all': ('admin/css/vorgabe_border.css',)
|
||||
}
|
||||
|
||||
|
||||
#admin.site.register(Stichwort)
|
||||
|
||||
@admin.register(VorgabenTable)
|
||||
class VorgabenTableAdmin(admin.ModelAdmin):
|
||||
list_display = ['order', 'nummer', 'dokument', 'thema', 'titel', 'gueltigkeit_von', 'gueltigkeit_bis']
|
||||
list_display_links = ['dokument']
|
||||
list_editable = ['order', 'nummer', 'thema', 'titel', 'gueltigkeit_von', 'gueltigkeit_bis']
|
||||
list_filter = ['dokument', 'thema', 'gueltigkeit_von', 'gueltigkeit_bis']
|
||||
search_fields = ['nummer', 'titel', 'dokument__nummer', 'dokument__name']
|
||||
autocomplete_fields = ['dokument', 'thema', 'stichworte', 'referenzen', 'relevanz']
|
||||
ordering = ['order']
|
||||
list_per_page = 100
|
||||
|
||||
fieldsets = (
|
||||
('Grunddaten', {
|
||||
'fields': ('order', 'nummer', 'dokument', 'thema', 'titel')
|
||||
}),
|
||||
('Gültigkeit', {
|
||||
'fields': ('gueltigkeit_von', 'gueltigkeit_bis')
|
||||
}),
|
||||
('Verknüpfungen', {
|
||||
'fields': ('referenzen', 'stichworte', 'relevanz'),
|
||||
'classes': ('collapse',)
|
||||
}),
|
||||
)
|
||||
|
||||
@admin.register(Thema)
|
||||
class ThemaAdmin(admin.ModelAdmin):
|
||||
search_fields = ['name']
|
||||
ordering = ['name']
|
||||
|
||||
@admin.register(Vorgabe)
|
||||
class VorgabeAdmin(NestedModelAdmin):
|
||||
form = VorgabeForm
|
||||
list_display = ['vorgabe_nummer', 'titel', 'dokument', 'thema', 'gueltigkeit_von', 'gueltigkeit_bis']
|
||||
list_filter = ['dokument', 'thema', 'gueltigkeit_von', 'gueltigkeit_bis']
|
||||
search_fields = ['nummer', 'titel', 'dokument__nummer', 'dokument__name']
|
||||
autocomplete_fields = ['stichworte', 'referenzen', 'relevanz']
|
||||
ordering = ['dokument', 'order']
|
||||
|
||||
inlines = [
|
||||
VorgabeKurztextInline,
|
||||
VorgabeLangtextInline,
|
||||
ChecklistenfragenInline
|
||||
]
|
||||
|
||||
fieldsets = (
|
||||
('Grunddaten', {
|
||||
'fields': (('order', 'nummer'), ('dokument', 'thema'), 'titel'),
|
||||
'classes': ('wide',),
|
||||
}),
|
||||
('Gültigkeit', {
|
||||
'fields': (('gueltigkeit_von', 'gueltigkeit_bis'),),
|
||||
'classes': ('wide',),
|
||||
}),
|
||||
('Verknüpfungen', {
|
||||
'fields': (('referenzen', 'stichworte', 'relevanz'),),
|
||||
'classes': ('wide',),
|
||||
}),
|
||||
)
|
||||
|
||||
def vorgabe_nummer(self, obj):
|
||||
return obj.Vorgabennummer()
|
||||
vorgabe_nummer.short_description = 'Vorgabennummer'
|
||||
|
||||
admin.site.register(Checklistenfrage)
|
||||
admin.site.register(Dokumententyp)
|
||||
admin.site.register(VorgabeComment)
|
||||
|
||||
#admin.site.register(Changelog)
|
||||
@@ -3,4 +3,4 @@ from django.apps import AppConfig
|
||||
|
||||
class standardsConfig(AppConfig):
|
||||
default_auto_field = 'django.db.models.BigAutoField'
|
||||
name = 'standards'
|
||||
name = 'dokumente'
|
||||
174
dokumente/management/commands/export_json.py
Normal file
174
dokumente/management/commands/export_json.py
Normal file
@@ -0,0 +1,174 @@
|
||||
from django.core.management.base import BaseCommand
|
||||
from django.core.serializers.json import DjangoJSONEncoder
|
||||
import json
|
||||
from datetime import datetime
|
||||
from dokumente.models import Dokument, Vorgabe, VorgabeKurztext, VorgabeLangtext, Checklistenfrage
|
||||
|
||||
|
||||
class Command(BaseCommand):
|
||||
help = 'Export all dokumente as JSON using R0066.json format as reference'
|
||||
|
||||
def add_arguments(self, parser):
|
||||
parser.add_argument(
|
||||
'--output',
|
||||
type=str,
|
||||
help='Output file path (default: stdout)',
|
||||
)
|
||||
|
||||
def handle(self, *args, **options):
|
||||
# Get all active documents
|
||||
dokumente = Dokument.objects.filter(aktiv=True).prefetch_related(
|
||||
'autoren', 'pruefende', 'vorgaben__thema',
|
||||
'vorgaben__referenzen', 'vorgaben__stichworte',
|
||||
'vorgaben__checklistenfragen', 'vorgaben__vorgabekurztext_set',
|
||||
'vorgaben__vorgabelangtext_set', 'geltungsbereich_set',
|
||||
'einleitung_set', 'changelog__autoren'
|
||||
).order_by('nummer')
|
||||
|
||||
result = {
|
||||
"Vorgabendokument": {
|
||||
"Typ": "Standard IT-Sicherheit",
|
||||
"Nummer": "", # Will be set per document
|
||||
"Name": "", # Will be set per document
|
||||
"Autoren": [], # Will be set per document
|
||||
"Pruefende": [], # Will be set per document
|
||||
"Geltungsbereich": {
|
||||
"Abschnitt": []
|
||||
},
|
||||
"Ziel": "",
|
||||
"Grundlagen": "",
|
||||
"Changelog": [],
|
||||
"Anhänge": [],
|
||||
"Verantwortlich": "Information Security Management BIT",
|
||||
"Klassifizierung": None,
|
||||
"Glossar": {},
|
||||
"Vorgaben": []
|
||||
}
|
||||
}
|
||||
|
||||
output_data = []
|
||||
|
||||
for dokument in dokumente:
|
||||
# Build document structure
|
||||
doc_data = {
|
||||
"Typ": dokument.dokumententyp.name if dokument.dokumententyp else "",
|
||||
"Nummer": dokument.nummer,
|
||||
"Name": dokument.name,
|
||||
"Autoren": [autor.name for autor in dokument.autoren.all()],
|
||||
"Pruefende": [pruefender.name for pruefender in dokument.pruefende.all()],
|
||||
"Gueltigkeit": {
|
||||
"Von": dokument.gueltigkeit_von.strftime("%Y-%m-%d") if dokument.gueltigkeit_von else "",
|
||||
"Bis": dokument.gueltigkeit_bis.strftime("%Y-%m-%d") if dokument.gueltigkeit_bis else None
|
||||
},
|
||||
"SignaturCSO": dokument.signatur_cso,
|
||||
"Geltungsbereich": {},
|
||||
"Einleitung": {},
|
||||
"Ziel": "",
|
||||
"Grundlagen": "",
|
||||
"Changelog": [],
|
||||
"Anhänge": dokument.anhaenge,
|
||||
"Verantwortlich": "Information Security Management BIT",
|
||||
"Klassifizierung": None,
|
||||
"Glossar": {},
|
||||
"Vorgaben": []
|
||||
}
|
||||
|
||||
# Process Geltungsbereich sections
|
||||
geltungsbereich_sections = []
|
||||
for gb in dokument.geltungsbereich_set.all().order_by('order'):
|
||||
geltungsbereich_sections.append({
|
||||
"typ": gb.abschnitttyp.abschnitttyp if gb.abschnitttyp else "text",
|
||||
"inhalt": gb.inhalt
|
||||
})
|
||||
|
||||
if geltungsbereich_sections:
|
||||
doc_data["Geltungsbereich"] = {
|
||||
"Abschnitt": geltungsbereich_sections
|
||||
}
|
||||
|
||||
# Process Einleitung sections
|
||||
einleitung_sections = []
|
||||
for ei in dokument.einleitung_set.all().order_by('order'):
|
||||
einleitung_sections.append({
|
||||
"typ": ei.abschnitttyp.abschnitttyp if ei.abschnitttyp else "text",
|
||||
"inhalt": ei.inhalt
|
||||
})
|
||||
|
||||
if einleitung_sections:
|
||||
doc_data["Einleitung"] = {
|
||||
"Abschnitt": einleitung_sections
|
||||
}
|
||||
|
||||
# Process Changelog entries
|
||||
changelog_entries = []
|
||||
for cl in dokument.changelog.all().order_by('-datum'):
|
||||
changelog_entries.append({
|
||||
"Datum": cl.datum.strftime("%Y-%m-%d"),
|
||||
"Autoren": [autor.name for autor in cl.autoren.all()],
|
||||
"Aenderung": cl.aenderung
|
||||
})
|
||||
|
||||
doc_data["Changelog"] = changelog_entries
|
||||
|
||||
# Process Vorgaben for this document
|
||||
vorgaben = dokument.vorgaben.all().order_by('order')
|
||||
|
||||
for vorgabe in vorgaben:
|
||||
# Get Kurztext and Langtext
|
||||
kurztext_sections = []
|
||||
for kt in vorgabe.vorgabekurztext_set.all().order_by('order'):
|
||||
kurztext_sections.append({
|
||||
"typ": kt.abschnitttyp.abschnitttyp if kt.abschnitttyp else "text",
|
||||
"inhalt": kt.inhalt
|
||||
})
|
||||
|
||||
langtext_sections = []
|
||||
for lt in vorgabe.vorgabelangtext_set.all().order_by('order'):
|
||||
langtext_sections.append({
|
||||
"typ": lt.abschnitttyp.abschnitttyp if lt.abschnitttyp else "text",
|
||||
"inhalt": lt.inhalt
|
||||
})
|
||||
|
||||
# Build text structures following Langtext pattern
|
||||
kurztext = {
|
||||
"Abschnitt": kurztext_sections if kurztext_sections else []
|
||||
} if kurztext_sections else {}
|
||||
langtext = {
|
||||
"Abschnitt": langtext_sections if langtext_sections else []
|
||||
} if langtext_sections else {}
|
||||
|
||||
# Get references and keywords
|
||||
referenzen = [f"{ref.name_nummer}: {ref.name_text}" if ref.name_text else ref.name_nummer for ref in vorgabe.referenzen.all()]
|
||||
stichworte = [stw.stichwort for stw in vorgabe.stichworte.all()]
|
||||
|
||||
# Get checklist questions
|
||||
checklistenfragen = [cf.frage for cf in vorgabe.checklistenfragen.all()]
|
||||
|
||||
vorgabe_data = {
|
||||
"Nummer": str(vorgabe.nummer),
|
||||
"Titel": vorgabe.titel,
|
||||
"Thema": vorgabe.thema.name if vorgabe.thema else "",
|
||||
"Kurztext": kurztext,
|
||||
"Langtext": langtext,
|
||||
"Referenz": referenzen,
|
||||
"Gueltigkeit": {
|
||||
"Von": vorgabe.gueltigkeit_von.strftime("%Y-%m-%d") if vorgabe.gueltigkeit_von else "",
|
||||
"Bis": vorgabe.gueltigkeit_bis.strftime("%Y-%m-%d") if vorgabe.gueltigkeit_bis else None
|
||||
},
|
||||
"Checklistenfragen": checklistenfragen,
|
||||
"Stichworte": stichworte
|
||||
}
|
||||
|
||||
doc_data["Vorgaben"].append(vorgabe_data)
|
||||
|
||||
output_data.append(doc_data)
|
||||
|
||||
# Output the data
|
||||
json_output = json.dumps(output_data, cls=DjangoJSONEncoder, indent=2, ensure_ascii=False)
|
||||
|
||||
if options['output']:
|
||||
with open(options['output'], 'w', encoding='utf-8') as f:
|
||||
f.write(json_output)
|
||||
self.stdout.write(self.style.SUCCESS(f'JSON exported to {options["output"]}'))
|
||||
else:
|
||||
self.stdout.write(json_output)
|
||||
@@ -4,7 +4,7 @@ from pathlib import Path
|
||||
from django.core.management.base import BaseCommand, CommandError
|
||||
from django.utils import timezone
|
||||
|
||||
from standards.models import (
|
||||
from dokumente.models import (
|
||||
Dokument,
|
||||
Dokumententyp,
|
||||
Thema,
|
||||
70
dokumente/management/commands/sanity_check_vorgaben.py
Normal file
70
dokumente/management/commands/sanity_check_vorgaben.py
Normal file
@@ -0,0 +1,70 @@
|
||||
from django.core.management.base import BaseCommand
|
||||
from django.db import transaction
|
||||
from dokumente.models import Vorgabe
|
||||
import datetime
|
||||
|
||||
|
||||
class Command(BaseCommand):
|
||||
help = 'Run sanity checks on Vorgaben to detect conflicts'
|
||||
|
||||
def add_arguments(self, parser):
|
||||
parser.add_argument(
|
||||
'--fix',
|
||||
action='store_true',
|
||||
help='Attempt to fix conflicts (not implemented yet)',
|
||||
)
|
||||
parser.add_argument(
|
||||
'--verbose',
|
||||
action='store_true',
|
||||
help='Show detailed output',
|
||||
)
|
||||
|
||||
def handle(self, *args, **options):
|
||||
self.verbose = options['verbose']
|
||||
|
||||
self.stdout.write(self.style.SUCCESS('Starting Vorgaben sanity check...'))
|
||||
|
||||
# Run the sanity check
|
||||
conflicts = Vorgabe.sanity_check_vorgaben()
|
||||
|
||||
if not conflicts:
|
||||
self.stdout.write(self.style.SUCCESS('✓ No conflicts found in Vorgaben'))
|
||||
return
|
||||
|
||||
self.stdout.write(
|
||||
self.style.WARNING(f'Found {len(conflicts)} conflicts:')
|
||||
)
|
||||
|
||||
for i, conflict in enumerate(conflicts, 1):
|
||||
self._display_conflict(i, conflict)
|
||||
|
||||
if options['fix']:
|
||||
self.stdout.write(self.style.ERROR('Auto-fix not implemented yet'))
|
||||
|
||||
def _display_conflict(self, index, conflict):
|
||||
"""Display a single conflict"""
|
||||
v1 = conflict['vorgabe1']
|
||||
v2 = conflict['vorgabe2']
|
||||
|
||||
self.stdout.write(f"\n{index}. {conflict['message']}")
|
||||
|
||||
if self.verbose:
|
||||
self.stdout.write(f" Vorgabe 1: {v1.Vorgabennummer()}")
|
||||
self.stdout.write(f" Valid from: {v1.gueltigkeit_von} to {v1.gueltigkeit_bis or 'unlimited'}")
|
||||
self.stdout.write(f" Title: {v1.titel}")
|
||||
|
||||
self.stdout.write(f" Vorgabe 2: {v2.Vorgabennummer()}")
|
||||
self.stdout.write(f" Valid from: {v2.gueltigkeit_von} to {v2.gueltigkeit_bis or 'unlimited'}")
|
||||
self.stdout.write(f" Title: {v2.titel}")
|
||||
|
||||
# Show the overlapping period
|
||||
overlap_start = max(v1.gueltigkeit_von, v2.gueltigkeit_von)
|
||||
overlap_end = min(
|
||||
v1.gueltigkeit_bis or datetime.date.max,
|
||||
v2.gueltigkeit_bis or datetime.date.max
|
||||
)
|
||||
|
||||
if overlap_end != datetime.date.max:
|
||||
self.stdout.write(f" Overlap: {overlap_start} to {overlap_end}")
|
||||
else:
|
||||
self.stdout.write(f" Overlap starts: {overlap_start} (no end)")
|
||||
@@ -53,7 +53,7 @@ class Migration(migrations.Migration):
|
||||
('rght', models.PositiveIntegerField(editable=False)),
|
||||
('tree_id', models.PositiveIntegerField(db_index=True, editable=False)),
|
||||
('level', models.PositiveIntegerField(editable=False)),
|
||||
('oberreferenz', mptt.fields.TreeForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='unterreferenzen', to='standards.referenz')),
|
||||
('oberreferenz', mptt.fields.TreeForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='unterreferenzen', to='dokumente.referenz')),
|
||||
],
|
||||
options={
|
||||
'verbose_name_plural': 'Referenzen',
|
||||
@@ -65,7 +65,7 @@ class Migration(migrations.Migration):
|
||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
||||
('inhalt', models.TextField(blank=True, null=True)),
|
||||
('abschnitttyp', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, to='abschnitte.abschnitttyp')),
|
||||
('erklaerung', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='standards.referenz')),
|
||||
('erklaerung', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='dokumente.referenz')),
|
||||
],
|
||||
options={
|
||||
'verbose_name': 'Erklärung',
|
||||
@@ -80,9 +80,9 @@ class Migration(migrations.Migration):
|
||||
('gueltigkeit_bis', models.DateField(blank=True, null=True)),
|
||||
('signatur_cso', models.CharField(blank=True, max_length=255)),
|
||||
('anhaenge', models.TextField(blank=True)),
|
||||
('autoren', models.ManyToManyField(related_name='verfasste_dokumente', to='standards.person')),
|
||||
('dokumententyp', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='standards.dokumententyp')),
|
||||
('pruefende', models.ManyToManyField(related_name='gepruefte_dokumente', to='standards.person')),
|
||||
('autoren', models.ManyToManyField(related_name='verfasste_dokumente', to='dokumente.person')),
|
||||
('dokumententyp', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='dokumente.dokumententyp')),
|
||||
('pruefende', models.ManyToManyField(related_name='gepruefte_dokumente', to='dokumente.person')),
|
||||
],
|
||||
options={
|
||||
'verbose_name': 'Standard',
|
||||
@@ -95,7 +95,7 @@ class Migration(migrations.Migration):
|
||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
||||
('inhalt', models.TextField(blank=True, null=True)),
|
||||
('abschnitttyp', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, to='abschnitte.abschnitttyp')),
|
||||
('geltungsbereich', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='standards.standard')),
|
||||
('geltungsbereich', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='dokumente.standard')),
|
||||
],
|
||||
options={
|
||||
'verbose_name': 'Geltungsbereichs-Abschnitt',
|
||||
@@ -108,8 +108,8 @@ class Migration(migrations.Migration):
|
||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
||||
('datum', models.DateField()),
|
||||
('aenderung', models.TextField()),
|
||||
('autoren', models.ManyToManyField(to='standards.person')),
|
||||
('dokument', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='changelog', to='standards.standard')),
|
||||
('autoren', models.ManyToManyField(to='dokumente.person')),
|
||||
('dokument', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='changelog', to='dokumente.standard')),
|
||||
],
|
||||
),
|
||||
migrations.CreateModel(
|
||||
@@ -120,10 +120,10 @@ class Migration(migrations.Migration):
|
||||
('titel', models.CharField(max_length=255)),
|
||||
('gueltigkeit_von', models.DateField()),
|
||||
('gueltigkeit_bis', models.DateField(blank=True, null=True)),
|
||||
('dokument', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='vorgaben', to='standards.standard')),
|
||||
('referenzen', models.ManyToManyField(blank=True, to='standards.referenz')),
|
||||
('dokument', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='vorgaben', to='dokumente.standard')),
|
||||
('referenzen', models.ManyToManyField(blank=True, to='dokumente.referenz')),
|
||||
('stichworte', models.ManyToManyField(blank=True, to='stichworte.stichwort')),
|
||||
('thema', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='standards.thema')),
|
||||
('thema', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, to='dokumente.thema')),
|
||||
],
|
||||
options={
|
||||
'verbose_name_plural': 'Vorgaben',
|
||||
@@ -134,7 +134,7 @@ class Migration(migrations.Migration):
|
||||
fields=[
|
||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
||||
('frage', models.CharField(max_length=255)),
|
||||
('vorgabe', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='checklistenfragen', to='standards.vorgabe')),
|
||||
('vorgabe', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='checklistenfragen', to='dokumente.vorgabe')),
|
||||
],
|
||||
options={
|
||||
'verbose_name_plural': 'Fragen für Checkliste',
|
||||
@@ -145,7 +145,7 @@ class Migration(migrations.Migration):
|
||||
fields=[
|
||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
||||
('inhalt', models.TextField(blank=True, null=True)),
|
||||
('abschnitt', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='standards.vorgabe')),
|
||||
('abschnitt', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='dokumente.vorgabe')),
|
||||
('abschnitttyp', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, to='abschnitte.abschnitttyp')),
|
||||
],
|
||||
options={
|
||||
@@ -158,7 +158,7 @@ class Migration(migrations.Migration):
|
||||
fields=[
|
||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
||||
('inhalt', models.TextField(blank=True, null=True)),
|
||||
('abschnitt', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='standards.vorgabe')),
|
||||
('abschnitt', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='dokumente.vorgabe')),
|
||||
('abschnitttyp', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, to='abschnitte.abschnitttyp')),
|
||||
],
|
||||
options={
|
||||
@@ -8,7 +8,7 @@ class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('abschnitte', '0001_initial'),
|
||||
('standards', '0001_initial'),
|
||||
('dokumente', '0001_initial'),
|
||||
]
|
||||
|
||||
operations = [
|
||||
@@ -18,7 +18,7 @@ class Migration(migrations.Migration):
|
||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
||||
('inhalt', models.TextField(blank=True, null=True)),
|
||||
('abschnitttyp', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, to='abschnitte.abschnitttyp')),
|
||||
('einleitung', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='standards.standard')),
|
||||
('einleitung', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='dokumente.standard')),
|
||||
],
|
||||
options={
|
||||
'verbose_name': 'Einleitungs-Abschnitt',
|
||||
@@ -6,7 +6,7 @@ from django.db import migrations, models
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('standards', '0002_einleitung'),
|
||||
('dokumente', '0002_einleitung'),
|
||||
]
|
||||
|
||||
operations = [
|
||||
@@ -7,7 +7,7 @@ class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('referenzen', '0001_initial'),
|
||||
('standards', '0003_einleitung_order_geltungsbereich_order_and_more'),
|
||||
('dokumente', '0003_einleitung_order_geltungsbereich_order_and_more'),
|
||||
]
|
||||
|
||||
operations = [
|
||||
@@ -7,7 +7,7 @@ class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('rollen', '0001_initial'),
|
||||
('standards', '0004_remove_referenzerklaerung_erklaerung_and_more'),
|
||||
('dokumente', '0004_remove_referenzerklaerung_erklaerung_and_more'),
|
||||
]
|
||||
|
||||
operations = [
|
||||
@@ -6,7 +6,7 @@ from django.db import migrations
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('standards', '0005_vorgabe_relevanz'),
|
||||
('dokumente', '0005_vorgabe_relevanz'),
|
||||
]
|
||||
|
||||
operations = [
|
||||
@@ -6,7 +6,7 @@ from django.db import migrations
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('standards', '0006_rename_standard_dokument_alter_dokument_options'),
|
||||
('dokumente', '0006_rename_standard_dokument_alter_dokument_options'),
|
||||
]
|
||||
|
||||
operations = [
|
||||
19
dokumente/migrations/0008_dokument_aktiv.py
Normal file
19
dokumente/migrations/0008_dokument_aktiv.py
Normal file
@@ -0,0 +1,19 @@
|
||||
# Generated by Django 5.2.5 on 2025-10-27 19:48
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('dokumente', '0007_alter_changelog_options_and_more'),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AddField(
|
||||
model_name='dokument',
|
||||
name='aktiv',
|
||||
field=models.BooleanField(blank=True, default=False),
|
||||
preserve_default=False,
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,23 @@
|
||||
# Generated by Django 5.2.5 on 2025-10-28 14:51
|
||||
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('dokumente', '0008_dokument_aktiv'),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterModelOptions(
|
||||
name='vorgabe',
|
||||
options={'ordering': ['order'], 'verbose_name_plural': 'Vorgaben'},
|
||||
),
|
||||
migrations.AddField(
|
||||
model_name='vorgabe',
|
||||
name='order',
|
||||
field=models.IntegerField(default=0),
|
||||
preserve_default=False,
|
||||
),
|
||||
]
|
||||
@@ -0,0 +1,49 @@
|
||||
# Generated by Django 5.2.5 on 2025-11-27 22:02
|
||||
|
||||
import django.db.models.deletion
|
||||
from django.conf import settings
|
||||
from django.db import migrations, models
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('dokumente', '0009_alter_vorgabe_options_vorgabe_order'),
|
||||
migrations.swappable_dependency(settings.AUTH_USER_MODEL),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.CreateModel(
|
||||
name='VorgabenTable',
|
||||
fields=[
|
||||
],
|
||||
options={
|
||||
'verbose_name': 'Vorgabe (Tabellenansicht)',
|
||||
'verbose_name_plural': 'Vorgaben (Tabellenansicht)',
|
||||
'proxy': True,
|
||||
'indexes': [],
|
||||
'constraints': [],
|
||||
},
|
||||
bases=('dokumente.vorgabe',),
|
||||
),
|
||||
migrations.AlterModelOptions(
|
||||
name='person',
|
||||
options={'ordering': ['name'], 'verbose_name_plural': 'Personen'},
|
||||
),
|
||||
migrations.CreateModel(
|
||||
name='VorgabeComment',
|
||||
fields=[
|
||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
||||
('text', models.TextField()),
|
||||
('created_at', models.DateTimeField(auto_now_add=True)),
|
||||
('updated_at', models.DateTimeField(auto_now=True)),
|
||||
('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
|
||||
('vorgabe', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='comments', to='dokumente.vorgabe')),
|
||||
],
|
||||
options={
|
||||
'verbose_name': 'Vorgabe-Kommentar',
|
||||
'verbose_name_plural': 'Vorgabe-Kommentare',
|
||||
'ordering': ['-created_at'],
|
||||
},
|
||||
),
|
||||
]
|
||||
308
dokumente/models.py
Normal file
308
dokumente/models.py
Normal file
@@ -0,0 +1,308 @@
|
||||
from django.db import models
|
||||
from mptt.models import MPTTModel, TreeForeignKey
|
||||
from django.contrib.auth.models import User
|
||||
from abschnitte.models import Textabschnitt
|
||||
from stichworte.models import Stichwort
|
||||
from referenzen.models import Referenz
|
||||
from rollen.models import Rolle
|
||||
import datetime
|
||||
|
||||
class Dokumententyp(models.Model):
|
||||
name = models.CharField(max_length=100, primary_key=True)
|
||||
verantwortliche_ve = models.CharField(max_length=255)
|
||||
|
||||
def __str__(self):
|
||||
return self.name
|
||||
|
||||
class Meta:
|
||||
verbose_name="Dokumententyp"
|
||||
verbose_name_plural="Dokumententypen"
|
||||
|
||||
|
||||
class Person(models.Model):
|
||||
name = models.CharField(max_length=100, primary_key=True)
|
||||
funktion = models.CharField(max_length=255)
|
||||
|
||||
def __str__(self):
|
||||
return self.name
|
||||
class Meta:
|
||||
verbose_name_plural="Personen"
|
||||
ordering = ['name']
|
||||
|
||||
class Thema(models.Model):
|
||||
name = models.CharField(max_length=100, primary_key=True)
|
||||
erklaerung = models.TextField(blank=True)
|
||||
|
||||
def __str__(self):
|
||||
return self.name
|
||||
class Meta:
|
||||
verbose_name_plural="Themen"
|
||||
|
||||
|
||||
class Dokument(models.Model):
|
||||
nummer = models.CharField(max_length=50, primary_key=True)
|
||||
dokumententyp = models.ForeignKey(Dokumententyp, on_delete=models.PROTECT)
|
||||
name = models.CharField(max_length=255)
|
||||
autoren = models.ManyToManyField(Person, related_name='verfasste_dokumente')
|
||||
pruefende = models.ManyToManyField(Person, related_name='gepruefte_dokumente')
|
||||
gueltigkeit_von = models.DateField(null=True, blank=True)
|
||||
gueltigkeit_bis = models.DateField(null=True, blank=True)
|
||||
signatur_cso = models.CharField(max_length=255, blank=True)
|
||||
anhaenge = models.TextField(blank=True)
|
||||
aktiv = models.BooleanField(blank=True)
|
||||
|
||||
def __str__(self):
|
||||
return f"{self.nummer} – {self.name}"
|
||||
|
||||
@property
|
||||
def dates(self):
|
||||
"""
|
||||
Returns an array of unique, chronologically sorted dates representing
|
||||
state-change dates from all Vorgaben in this document.
|
||||
|
||||
These are dates where Vorgaben become active (gueltigkeit_von) or change state
|
||||
(the day after gueltigkeit_bis). The very last date in the list is excluded
|
||||
as it has no relevance (nothing changes after it).
|
||||
"""
|
||||
dates_set = set()
|
||||
|
||||
# Get all vorgaben for this document
|
||||
for vorgabe in self.vorgaben.all():
|
||||
# Add gueltigkeit_von (when vorgabe becomes active)
|
||||
if vorgabe.gueltigkeit_von:
|
||||
dates_set.add(vorgabe.gueltigkeit_von)
|
||||
|
||||
# Add the day after gueltigkeit_bis (when vorgabe expires/changes state)
|
||||
# Only if gueltigkeit_bis is defined (not None)
|
||||
if vorgabe.gueltigkeit_bis:
|
||||
dates_set.add(vorgabe.gueltigkeit_bis + datetime.timedelta(days=1))
|
||||
|
||||
# Return sorted unique dates from oldest to newest, excluding the last date
|
||||
# (but only if there are multiple dates; single dates are kept)
|
||||
sorted_dates = sorted(list(dates_set))
|
||||
return sorted_dates[:-1] if len(sorted_dates) > 1 else sorted_dates
|
||||
|
||||
class Meta:
|
||||
verbose_name_plural="Dokumente"
|
||||
verbose_name="Dokument"
|
||||
|
||||
class Vorgabe(models.Model):
|
||||
order = models.IntegerField()
|
||||
nummer = models.IntegerField()
|
||||
dokument = models.ForeignKey(Dokument, on_delete=models.CASCADE, related_name='vorgaben')
|
||||
thema = models.ForeignKey(Thema, on_delete=models.PROTECT, blank=False)
|
||||
titel = models.CharField(max_length=255)
|
||||
referenzen = models.ManyToManyField(Referenz, blank=True)
|
||||
gueltigkeit_von = models.DateField()
|
||||
gueltigkeit_bis = models.DateField(blank=True,null=True)
|
||||
stichworte = models.ManyToManyField(Stichwort, blank=True)
|
||||
relevanz = models.ManyToManyField(Rolle,blank=True)
|
||||
|
||||
def Vorgabennummer(self):
|
||||
return str(self.dokument.nummer)+"."+self.thema.name[0]+"."+str(self.nummer)
|
||||
|
||||
def get_status(self, check_date: datetime.date = datetime.date.today(), verbose: bool = False) -> str:
|
||||
if self.gueltigkeit_von > check_date:
|
||||
return "future" if not verbose else "Ist erst ab dem "+self.gueltigkeit_von.strftime('%d.%m.%Y')+" in Kraft."
|
||||
|
||||
if not self.gueltigkeit_bis:
|
||||
return "active"
|
||||
|
||||
if self.gueltigkeit_bis >= check_date:
|
||||
return "active"
|
||||
|
||||
return "expired" if not verbose else "Ist seit dem "+self.gueltigkeit_bis.strftime('%d.%m.%Y')+" nicht mehr in Kraft."
|
||||
|
||||
def __str__(self):
|
||||
return f"{self.Vorgabennummer()}: {self.titel}"
|
||||
|
||||
@staticmethod
|
||||
def sanity_check_vorgaben():
|
||||
"""
|
||||
Sanity check for Vorgaben:
|
||||
If there are two Vorgaben with the same number, Thema and Dokument,
|
||||
their valid_from and valid_to date ranges shouldn't intersect.
|
||||
|
||||
Returns:
|
||||
list: List of dictionaries containing conflicts found
|
||||
"""
|
||||
conflicts = []
|
||||
|
||||
# Group Vorgaben by dokument, thema, and nummer
|
||||
from django.db.models import Count
|
||||
from itertools import combinations
|
||||
|
||||
# Find Vorgaben with same dokument, thema, and nummer
|
||||
duplicate_groups = (
|
||||
Vorgabe.objects.values('dokument', 'thema', 'nummer')
|
||||
.annotate(count=Count('id'))
|
||||
.filter(count__gt=1)
|
||||
)
|
||||
|
||||
for group in duplicate_groups:
|
||||
# Get all Vorgaben in this group
|
||||
vorgaben = Vorgabe.objects.filter(
|
||||
dokument=group['dokument'],
|
||||
thema=group['thema'],
|
||||
nummer=group['nummer']
|
||||
)
|
||||
|
||||
# Check all pairs for date range intersections
|
||||
for vorgabe1, vorgabe2 in combinations(vorgaben, 2):
|
||||
if Vorgabe._date_ranges_intersect(
|
||||
vorgabe1.gueltigkeit_von, vorgabe1.gueltigkeit_bis,
|
||||
vorgabe2.gueltigkeit_von, vorgabe2.gueltigkeit_bis
|
||||
):
|
||||
conflicts.append({
|
||||
'vorgabe1': vorgabe1,
|
||||
'vorgabe2': vorgabe2,
|
||||
'conflict_type': 'date_range_intersection',
|
||||
'message': f"Vorgaben {vorgabe1.Vorgabennummer()} and {vorgabe2.Vorgabennummer()} "
|
||||
f"überschneiden sich in der Geltungsdauer"
|
||||
})
|
||||
|
||||
return conflicts
|
||||
|
||||
def clean(self):
|
||||
"""
|
||||
Validate the Vorgabe before saving.
|
||||
"""
|
||||
from django.core.exceptions import ValidationError
|
||||
|
||||
# Check for conflicts with existing Vorgaben
|
||||
conflicts = self.find_conflicts()
|
||||
if conflicts:
|
||||
conflict_messages = [c['message'] for c in conflicts]
|
||||
raise ValidationError({
|
||||
'__all__': conflict_messages
|
||||
})
|
||||
|
||||
def find_conflicts(self):
|
||||
"""
|
||||
Find conflicts with existing Vorgaben.
|
||||
|
||||
Returns:
|
||||
list: List of conflict dictionaries
|
||||
"""
|
||||
conflicts = []
|
||||
|
||||
# Find Vorgaben with same dokument, thema, and nummer (excluding self)
|
||||
existing_vorgaben = Vorgabe.objects.filter(
|
||||
dokument=self.dokument,
|
||||
thema=self.thema,
|
||||
nummer=self.nummer
|
||||
).exclude(pk=self.pk)
|
||||
|
||||
for other_vorgabe in existing_vorgaben:
|
||||
if self._date_ranges_intersect(
|
||||
self.gueltigkeit_von, self.gueltigkeit_bis,
|
||||
other_vorgabe.gueltigkeit_von, other_vorgabe.gueltigkeit_bis
|
||||
):
|
||||
conflicts.append({
|
||||
'vorgabe1': self,
|
||||
'vorgabe2': other_vorgabe,
|
||||
'conflict_type': 'date_range_intersection',
|
||||
'message': f"Vorgabe {self.Vorgabennummer()} in Konflikt mit "
|
||||
f"bestehender {other_vorgabe.Vorgabennummer()} "
|
||||
f" - Geltungsdauer übeschneidet sich"
|
||||
})
|
||||
|
||||
return conflicts
|
||||
|
||||
@staticmethod
|
||||
def _date_ranges_intersect(start1, end1, start2, end2):
|
||||
"""
|
||||
Check if two date ranges intersect.
|
||||
None end date means open-ended range.
|
||||
|
||||
Args:
|
||||
start1, start2: Start dates
|
||||
end1, end2: End dates (can be None for open-ended)
|
||||
|
||||
Returns:
|
||||
bool: True if ranges intersect
|
||||
"""
|
||||
# If either start date is None, treat it as invalid case
|
||||
if not start1 or not start2:
|
||||
return False
|
||||
|
||||
# If end date is None, treat it as far future
|
||||
end1 = end1 or datetime.date.max
|
||||
end2 = end2 or datetime.date.max
|
||||
|
||||
# Ranges intersect if start1 <= end2 and start2 <= end1
|
||||
return start1 <= end2 and start2 <= end1
|
||||
|
||||
class Meta:
|
||||
verbose_name_plural="Vorgaben"
|
||||
ordering = ['order']
|
||||
|
||||
class VorgabeLangtext(Textabschnitt):
|
||||
abschnitt=models.ForeignKey(Vorgabe,on_delete=models.CASCADE)
|
||||
class Meta:
|
||||
verbose_name_plural="Langtext"
|
||||
verbose_name="Langtext-Abschnitt"
|
||||
|
||||
class VorgabeKurztext(Textabschnitt):
|
||||
abschnitt=models.ForeignKey(Vorgabe,on_delete=models.CASCADE)
|
||||
class Meta:
|
||||
verbose_name_plural="Kurztext"
|
||||
verbose_name="Kurztext-Abschnitt"
|
||||
|
||||
class Geltungsbereich(Textabschnitt):
|
||||
geltungsbereich=models.ForeignKey(Dokument,on_delete=models.CASCADE)
|
||||
class Meta:
|
||||
verbose_name_plural="Geltungsbereich"
|
||||
verbose_name="Geltungsbereichs-Abschnitt"
|
||||
|
||||
class Einleitung(Textabschnitt):
|
||||
einleitung=models.ForeignKey(Dokument,on_delete=models.CASCADE)
|
||||
class Meta:
|
||||
verbose_name_plural="Einleitung"
|
||||
verbose_name="Einleitungs-Abschnitt"
|
||||
|
||||
class Checklistenfrage(models.Model):
|
||||
vorgabe=models.ForeignKey(Vorgabe, on_delete=models.CASCADE, related_name="checklistenfragen")
|
||||
frage = models.CharField(max_length=255)
|
||||
|
||||
def __str__(self):
|
||||
return self.frage
|
||||
|
||||
class Meta:
|
||||
verbose_name_plural="Fragen für Checkliste"
|
||||
verbose_name="Frage für Checkliste"
|
||||
|
||||
class VorgabenTable(Vorgabe):
|
||||
class Meta:
|
||||
proxy = True
|
||||
verbose_name = "Vorgabe (Tabellenansicht)"
|
||||
verbose_name_plural = "Vorgaben (Tabellenansicht)"
|
||||
|
||||
class Changelog(models.Model):
|
||||
dokument = models.ForeignKey(Dokument, on_delete=models.CASCADE, related_name='changelog')
|
||||
autoren = models.ManyToManyField(Person)
|
||||
datum = models.DateField()
|
||||
aenderung = models.TextField()
|
||||
|
||||
def __str__(self):
|
||||
return f"{self.datum} – {self.dokument.nummer}"
|
||||
|
||||
class Meta:
|
||||
verbose_name_plural="Changelog"
|
||||
verbose_name="Changelog-Eintrag"
|
||||
|
||||
|
||||
class VorgabeComment(models.Model):
|
||||
vorgabe = models.ForeignKey(Vorgabe, on_delete=models.CASCADE, related_name='comments')
|
||||
user = models.ForeignKey(User, on_delete=models.CASCADE)
|
||||
text = models.TextField()
|
||||
created_at = models.DateTimeField(auto_now_add=True)
|
||||
updated_at = models.DateTimeField(auto_now=True)
|
||||
|
||||
class Meta:
|
||||
verbose_name = "Vorgabe-Kommentar"
|
||||
verbose_name_plural = "Vorgabe-Kommentare"
|
||||
ordering = ['-created_at']
|
||||
|
||||
def __str__(self):
|
||||
return f"Kommentar von {self.user.username} zu {self.vorgabe.Vorgabennummer()}"
|
||||
67
dokumente/templates/standards/all_comments.html
Normal file
67
dokumente/templates/standards/all_comments.html
Normal file
@@ -0,0 +1,67 @@
|
||||
{% extends "base.html" %}
|
||||
|
||||
{% block content %}
|
||||
<h1>Alle Kommentare</h1>
|
||||
|
||||
{% if total_comments == 0 %}
|
||||
<div class="alert alert-info">
|
||||
<p>Es gibt noch keine Kommentare zu Vorgaben.</p>
|
||||
<p><a href="{% url 'standard_list' %}">Zu den Standards</a></p>
|
||||
</div>
|
||||
{% else %}
|
||||
<p class="text-muted">Insgesamt {{ total_comments }} Kommentar{{ total_comments|pluralize:"e" }}</p>
|
||||
|
||||
{% for dokument, comments in comments_by_document.items %}
|
||||
<div class="panel panel-default" style="margin-top: 2rem;">
|
||||
<div class="panel-heading">
|
||||
<h2 style="margin: 0;">
|
||||
<a href="{% url 'standard_detail' nummer=dokument.nummer %}">
|
||||
{{ dokument.nummer }} – {{ dokument.name }}
|
||||
</a>
|
||||
</h2>
|
||||
<p style="margin: 0; color: #666; font-size: 0.9rem;">
|
||||
{{ comments|length }} Kommentar{{ comments|length|pluralize:"e" }}
|
||||
</p>
|
||||
</div>
|
||||
<div class="panel-body">
|
||||
<div class="list-group">
|
||||
{% for comment in comments %}
|
||||
<div class="list-group-item" style="border-left: 3px solid #007bff; padding: 1rem;">
|
||||
<div style="display: flex; justify-content: space-between; align-items: flex-start;">
|
||||
<div style="flex: 1;">
|
||||
<h4 style="margin: 0 0 0.5rem 0;">
|
||||
<a href="{% url 'standard_detail' nummer=comment.vorgabe.dokument.nummer %}#{{ comment.vorgabe.Vorgabennummer }}">
|
||||
{{ comment.vorgabe.Vorgabennummer }}
|
||||
</a> {{ comment.vorgabe.titel }}
|
||||
</h4>
|
||||
<p style="margin: 0 0 0.75rem 0; color: #666; font-size: 0.9rem;">
|
||||
<strong>Benutzer:</strong> {{ comment.user.first_name }} {{ comment.user.last_name }}<br>
|
||||
<strong>Erstellt:</strong> {{ comment.created_at|date:"d.m.Y H:i" }}
|
||||
{% if comment.updated_at != comment.created_at %}
|
||||
<br>
|
||||
<strong>Bearbeitet:</strong> {{ comment.updated_at|date:"d.m.Y H:i" }}
|
||||
{% endif %}
|
||||
</p>
|
||||
</div>
|
||||
<form method="POST" action="{% url 'delete_vorgabe_comment' comment.id %}"
|
||||
style="display: inline; margin-left: 1rem;"
|
||||
onsubmit="return confirm('Sind Sie sicher, dass Sie diesen Kommentar löschen möchten?');">
|
||||
{% csrf_token %}
|
||||
<button type="submit" class="btn btn-sm btn-danger">Löschen</button>
|
||||
</form>
|
||||
</div>
|
||||
<div style="background: #f8f9fa; padding: 0.75rem; border-radius: 4px; margin-top: 0.5rem; white-space: pre-wrap; word-wrap: break-word;">
|
||||
{{ comment.text }}
|
||||
</div>
|
||||
</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
<div style="margin-top: 2rem; padding-top: 2rem; border-top: 1px solid #ddd;">
|
||||
<a href="{% url 'standard_list' %}" class="btn btn-default">Zu den Standards</a>
|
||||
</div>
|
||||
{% endblock %}
|
||||
151
dokumente/templates/standards/incomplete_vorgaben.html
Normal file
151
dokumente/templates/standards/incomplete_vorgaben.html
Normal file
@@ -0,0 +1,151 @@
|
||||
{% extends "base.html" %}
|
||||
{% block content %}
|
||||
<h1 class="mb-4">Unvollständige Vorgaben</h1>
|
||||
|
||||
{% if vorgaben_data %}
|
||||
<div class="table-responsive">
|
||||
<table class="table table-striped table-hover">
|
||||
<thead class="table-dark">
|
||||
<tr>
|
||||
<th>Vorgabe</th>
|
||||
<th class="text-center">Referenzen</th>
|
||||
<th class="text-center">Stichworte</th>
|
||||
<th class="text-center">Text</th>
|
||||
<th class="text-center">Checklistenfragen</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{% for item in vorgaben_data %}
|
||||
<tr>
|
||||
<td>
|
||||
<a href="/autorenumgebung/dokumente/vorgabe/{{ item.vorgabe.id }}/change/"
|
||||
class="text-decoration-none" target="_blank">
|
||||
<strong>{{ item.vorgabe.Vorgabennummer }}</strong><br>
|
||||
<small class="text-muted">{{ item.vorgabe.titel }}</small><br>
|
||||
<small class="text-muted">{{ item.vorgabe.dokument.nummer }} – {{ item.vorgabe.dokument.name }}</small>
|
||||
</a>
|
||||
</td>
|
||||
<td class="text-center align-middle">
|
||||
{% if item.has_references %}
|
||||
<span class="text-success fs-4">✓</span>
|
||||
{% else %}
|
||||
<span class="text-danger fs-4">✗</span>
|
||||
{% endif %}
|
||||
</td>
|
||||
<td class="text-center align-middle">
|
||||
{% if item.has_stichworte %}
|
||||
<span class="text-success fs-4">✓</span>
|
||||
{% else %}
|
||||
<span class="text-danger fs-4">✗</span>
|
||||
{% endif %}
|
||||
</td>
|
||||
<td class="text-center align-middle">
|
||||
{% if item.has_text %}
|
||||
<span class="text-success fs-4">✓</span>
|
||||
{% else %}
|
||||
<span class="text-danger fs-4">✗</span>
|
||||
{% endif %}
|
||||
</td>
|
||||
<td class="text-center align-middle">
|
||||
{% if item.has_checklistenfragen %}
|
||||
<span class="text-success fs-4">✓</span>
|
||||
{% else %}
|
||||
<span class="text-danger fs-4">✗</span>
|
||||
{% endif %}
|
||||
</td>
|
||||
</tr>
|
||||
{% endfor %}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<!-- Summary -->
|
||||
<div class="row mt-4">
|
||||
<div class="col-12">
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<h5 class="mb-0">Zusammenfassung</h5>
|
||||
</div>
|
||||
<div class="card-body">
|
||||
<div class="row text-center">
|
||||
<div class="col-md-3">
|
||||
<div class="p-3">
|
||||
<h4 class="text-danger" id="no-references-count">0</h4>
|
||||
<p class="mb-0">Ohne Referenzen</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-md-3">
|
||||
<div class="p-3">
|
||||
<h4 class="text-danger" id="no-stichworte-count">0</h4>
|
||||
<p class="mb-0">Ohne Stichworte</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-md-3">
|
||||
<div class="p-3">
|
||||
<h4 class="text-danger" id="no-text-count">0</h4>
|
||||
<p class="mb-0">Ohne Text</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="col-md-3">
|
||||
<div class="p-3">
|
||||
<h4 class="text-danger" id="no-checklistenfragen-count">0</h4>
|
||||
<p class="mb-0">Ohne Checklistenfragen</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="row mt-3">
|
||||
<div class="col-12 text-center">
|
||||
<h4 class="text-primary">Gesamt: {{ vorgaben_data|length }} unvollständige Vorgaben</h4>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% else %}
|
||||
<div class="alert alert-success" role="alert">
|
||||
<h4 class="alert-heading">
|
||||
<span class="emoji-icon">✅</span> Alle Vorgaben sind vollständig!
|
||||
</h4>
|
||||
<p>Alle Vorgaben haben Referenzen, Stichworte, Text und Checklistenfragen.</p>
|
||||
<hr>
|
||||
<p class="mb-0">
|
||||
<a href="{% url 'standard_list' %}" class="btn btn-primary">
|
||||
<span class="emoji-icon">📋</span> Zurück zur Übersicht
|
||||
</a>
|
||||
</p>
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<div class="mt-3">
|
||||
<a href="{% url 'standard_list' %}" class="btn btn-secondary">
|
||||
<span class="emoji-icon">←</span> Zurück zur Übersicht
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<script>
|
||||
// Update summary counts
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
let noReferences = 0;
|
||||
let noStichworte = 0;
|
||||
let noText = 0;
|
||||
let noChecklistenfragen = 0;
|
||||
|
||||
const rows = document.querySelectorAll('tbody tr');
|
||||
rows.forEach(function(row) {
|
||||
const cells = row.querySelectorAll('td');
|
||||
if (cells.length >= 5) {
|
||||
if (cells[1].textContent.trim() === '✗') noReferences++;
|
||||
if (cells[2].textContent.trim() === '✗') noStichworte++;
|
||||
if (cells[3].textContent.trim() === '✗') noText++;
|
||||
if (cells[4].textContent.trim() === '✗') noChecklistenfragen++;
|
||||
}
|
||||
});
|
||||
|
||||
document.getElementById('no-references-count').textContent = noReferences;
|
||||
document.getElementById('no-stichworte-count').textContent = noStichworte;
|
||||
document.getElementById('no-text-count').textContent = noText;
|
||||
document.getElementById('no-checklistenfragen-count').textContent = noChecklistenfragen;
|
||||
});
|
||||
</script>
|
||||
{% endblock %}
|
||||
418
dokumente/templates/standards/standard_detail.html
Normal file
418
dokumente/templates/standards/standard_detail.html
Normal file
@@ -0,0 +1,418 @@
|
||||
{% extends "base.html" %}
|
||||
|
||||
{% block title %}{{ standard.nummer }} – {{ standard.name }}{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<div class="container-fluid">
|
||||
<nav aria-label="breadcrumb">
|
||||
<ol class="breadcrumb">
|
||||
<li class="breadcrumb-item"><a href="/">Startseite</a></li>
|
||||
<li class="breadcrumb-item"><a href="/dokumente">Standards</a></li>
|
||||
<li class="breadcrumb-item active" aria-current="page">{{ standard.nummer }}</li>
|
||||
</ol>
|
||||
</nav>
|
||||
|
||||
<h1>{{ standard.nummer }} – {{ standard.name }}</h1>
|
||||
|
||||
{% if standard.history == True %}
|
||||
<div class="alert alert-warning" role="alert">
|
||||
<strong>Historische Version vom {{ standard.check_date }}</strong>
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<!-- History Dates Dropdown -->
|
||||
{% if standard.dates %}
|
||||
<div class="mb-3">
|
||||
<div class="dropdown">
|
||||
<a href="#" class="dropdown-toggle" data-toggle="dropdown" style="text-decoration: none;">
|
||||
📅 Historische Versionen
|
||||
</a>
|
||||
<ul class="dropdown-menu" role="menu">
|
||||
<li><a href="/dokumente/{{ standard.nummer }}/">Aktuelle Version</a></li>
|
||||
<li class="divider"></li>
|
||||
{% for date in standard.dates %}
|
||||
<li><a href="/dokumente/{{ standard.nummer }}/history/{{ date|date:'Y-m-d' }}/">{{ date|date:'d.m.Y' }}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<!-- Einleitung -->
|
||||
{% if standard.einleitung_html %}
|
||||
<div class="row mb-4">
|
||||
<div class="col-md-12">
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<h2>Einleitung</h2>
|
||||
</div>
|
||||
<div class="card-body">
|
||||
{% for typ, html in standard.einleitung_html %}
|
||||
<div class="mb-2">{{ html|safe }}</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<!-- Geltungsbereich -->
|
||||
{% if standard.geltungsbereich_html %}
|
||||
<div class="row mb-4">
|
||||
<div class="col-md-12">
|
||||
<div class="card">
|
||||
<div class="card-header">
|
||||
<h2>Geltungsbereich</h2>
|
||||
</div>
|
||||
<div class="card-body">
|
||||
{% for typ, html in standard.geltungsbereich_html %}
|
||||
<div class="mb-2">{{ html|safe }}</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<!-- Vorgaben -->
|
||||
<div class="row">
|
||||
<div class="col-md-12">
|
||||
<h2>Vorgaben</h2>
|
||||
</div>
|
||||
</div>
|
||||
{% for vorgabe in vorgaben %}
|
||||
{% if standard.history == True or vorgabe.long_status == "active" %}
|
||||
<!-- Vorgabe {{ vorgabe.Vorgabennummer }} -->
|
||||
<div class="row">
|
||||
<div class="col-md-12">
|
||||
{% if not forloop.first %}
|
||||
<hr style="border: 0; border-top: 1px solid #d3d3d3; margin: 2rem 0;">
|
||||
{% endif %}
|
||||
|
||||
<a id="{{ vorgabe.Vorgabennummer }}"></a>
|
||||
<div class="card mb-4">
|
||||
<div class="card-header" style="display: flex; justify-content: space-between; align-items: center;">
|
||||
<h3>
|
||||
{{ vorgabe.Vorgabennummer }} – {{ vorgabe.titel }}
|
||||
{% if vorgabe.long_status != "active" and standard.history == True %}
|
||||
<span class="badge badge-danger">{{ vorgabe.long_status }}</span>
|
||||
{% endif %}
|
||||
</h3>
|
||||
<div style="display: flex; align-items: center; gap: 0.5rem; flex-shrink: 0; white-space: nowrap;">
|
||||
<span class="badge badge-info">{{ vorgabe.thema }}</span>
|
||||
{% if vorgabe.relevanzset %}
|
||||
<span class="badge badge-secondary">
|
||||
Relevanz: {{ vorgabe.relevanzset|join:", " }}
|
||||
</span>
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="card-body">
|
||||
<!-- Kurztext -->
|
||||
{% if vorgabe.kurztext_html.0.1 %}
|
||||
<div class="alert alert-info">
|
||||
{% for typ, html in vorgabe.kurztext_html %}
|
||||
{% if html %}
|
||||
<div class="mb-2">{{ html|safe }}</div>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<!-- Langtext -->
|
||||
<div class="mb-3">
|
||||
{% for typ, html in vorgabe.langtext_html %}
|
||||
{% if html %}
|
||||
<div class="mb-3">{{ html|safe }}</div>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</div>
|
||||
|
||||
<!-- Checklistenfragen -->
|
||||
<h4 class="h6">Checklistenfragen</h4>
|
||||
{% if vorgabe.checklistenfragen.all %}
|
||||
<ul class="list-group mb-3">
|
||||
{% for frage in vorgabe.checklistenfragen.all %}
|
||||
<li class="list-group-item">{{ frage.frage }}</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% else %}
|
||||
<p class="text-muted"><em>Keine Checklistenfragen</em></p>
|
||||
{% endif %}
|
||||
|
||||
<!-- Stichworte und Referenzen -->
|
||||
<div class="mt-4 p-3" style="background-color: #f8f9fa; border-left: 3px solid #dee2e6; padding-left: 0.5en;">
|
||||
<p class="mb-2">
|
||||
<strong>Stichworte:</strong>
|
||||
{% if vorgabe.stichworte.all %}
|
||||
{% for s in vorgabe.stichworte.all %}
|
||||
<a href="{% url 'stichwort_detail' stichwort=s %}" class="badge badge-secondary">{{ s }}</a>{% if not forloop.last %} {% endif %}
|
||||
{% endfor %}
|
||||
{% else %}
|
||||
<span class="text-muted">Keine</span>
|
||||
{% endif %}
|
||||
</p>
|
||||
<p class="mb-0">
|
||||
<strong>Referenzen:</strong>
|
||||
{% if vorgabe.referenzpfade %}
|
||||
{% for ref in vorgabe.referenzpfade %}
|
||||
{{ ref|safe }}{% if not forloop.last %}, {% endif %}
|
||||
{% endfor %}
|
||||
{% else %}
|
||||
<span class="text-muted">Keine</span>
|
||||
{% endif %}
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<!-- Comment Button -->
|
||||
{% if user.is_authenticated %}
|
||||
<div class="mt-3 text-right">
|
||||
<button class="btn btn-sm btn-outline-primary comment-btn"
|
||||
data-vorgabe-id="{{ vorgabe.id }}"
|
||||
data-vorgabe-nummer="{{ vorgabe.Vorgabennummer }}">
|
||||
<span class="emoji-icon">💬</span> Kommentare
|
||||
{% if vorgabe.comment_count > 0 %}
|
||||
<span class="comment-count">{{ vorgabe.comment_count }}</span>
|
||||
{% endif %}
|
||||
</button>
|
||||
</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
<!-- Metadata -->
|
||||
|
||||
<h2>Metadaten</h2>
|
||||
<div class="row mb-4">
|
||||
<div class="col-md-12">
|
||||
<dl class="row">
|
||||
<dt class="col-sm-3">Autoren:</dt>
|
||||
<dd class="col-sm-9">{{ standard.autoren.all|join:", " }}</dd>
|
||||
|
||||
<dt class="col-sm-3">Prüfende:</dt>
|
||||
<dd class="col-sm-9">{{ standard.pruefende.all|join:", " }}</dd>
|
||||
|
||||
<dt class="col-sm-3">Gültigkeit:</dt>
|
||||
<dd class="col-sm-9">{{ standard.gueltigkeit_von }} bis {{ standard.gueltigkeit_bis|default_if_none:"auf weiteres" }}</dd>
|
||||
</dl>
|
||||
<p>
|
||||
<a href="{% url 'standard_json' standard.nummer %}"
|
||||
class="btn btn-secondary icon icon--before icon--download"
|
||||
download="{{ standard.nummer }}.json">
|
||||
JSON herunterladen
|
||||
</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Comment Modal -->
|
||||
<div class="modal fade" id="commentModal" tabindex="-1" role="dialog" aria-labelledby="commentModalLabel" aria-hidden="true">
|
||||
<div class="modal-dialog modal-lg" role="document">
|
||||
<div class="modal-content">
|
||||
<div class="modal-header">
|
||||
<h5 class="modal-title" id="commentModalLabel">Kommentare für <span id="modalVorgabeNummer"></span></h5>
|
||||
<button type="button" class="close" data-dismiss="modal" aria-label="Close">
|
||||
<span aria-hidden="true">×</span>
|
||||
</button>
|
||||
</div>
|
||||
<div class="modal-body">
|
||||
<div id="commentsContainer">
|
||||
<!-- Comments will be loaded here -->
|
||||
</div>
|
||||
|
||||
<!-- Add Comment Form -->
|
||||
<div class="mt-4">
|
||||
<h6>Neuen Kommentar hinzufügen:</h6>
|
||||
<textarea id="newCommentText" class="form-control" rows="3" placeholder="Ihr Kommentar..."></textarea>
|
||||
<button id="addCommentBtn" class="btn btn-primary btn-sm mt-2">Kommentar hinzufügen</button>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- JavaScript for Comments -->
|
||||
<script>
|
||||
// Content Security Policy for comment system
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
// Prevent inline script execution in dynamically loaded content
|
||||
const commentsContainer = document.getElementById('commentsContainer');
|
||||
if (commentsContainer) {
|
||||
// Use DOMPurify-like approach - only allow safe HTML
|
||||
const allowedTags = ['br', 'small', 'div', 'span', 'button'];
|
||||
const allowedAttributes = ['class', 'data-comment-id', 'aria-hidden'];
|
||||
|
||||
// Monitor for any script injection attempts
|
||||
const observer = new MutationObserver(function(mutations) {
|
||||
mutations.forEach(function(mutation) {
|
||||
mutation.addedNodes.forEach(function(node) {
|
||||
if (node.nodeType === 1) { // Element node
|
||||
const tagName = node.tagName.toLowerCase();
|
||||
if (tagName === 'script') {
|
||||
console.warn('Script injection attempt blocked');
|
||||
node.parentNode.removeChild(node);
|
||||
}
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
observer.observe(commentsContainer, {
|
||||
childList: true,
|
||||
subtree: true
|
||||
});
|
||||
}
|
||||
});
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
let currentVorgabeId = null;
|
||||
let currentVorgabeNummer = null;
|
||||
|
||||
// Comment button click handler
|
||||
document.querySelectorAll('.comment-btn').forEach(btn => {
|
||||
btn.addEventListener('click', function() {
|
||||
currentVorgabeId = this.dataset.vorgabeId;
|
||||
currentVorgabeNummer = this.dataset.vorgabeNummer;
|
||||
|
||||
document.getElementById('modalVorgabeNummer').textContent = currentVorgabeNummer;
|
||||
document.getElementById('newCommentText').value = '';
|
||||
|
||||
loadComments();
|
||||
$('#commentModal').modal('show');
|
||||
});
|
||||
});
|
||||
|
||||
// Load comments function
|
||||
function loadComments() {
|
||||
fetch(`/dokumente/comments/${currentVorgabeId}/`)
|
||||
.then(response => response.json())
|
||||
.then(data => {
|
||||
renderComments(data.comments);
|
||||
})
|
||||
.catch(error => {
|
||||
console.error('Error loading comments:', error);
|
||||
document.getElementById('commentsContainer').innerHTML =
|
||||
'<div class="alert alert-danger">Fehler beim Laden der Kommentare</div>';
|
||||
});
|
||||
}
|
||||
|
||||
// Render comments function
|
||||
function renderComments(comments) {
|
||||
const container = document.getElementById('commentsContainer');
|
||||
|
||||
if (comments.length === 0) {
|
||||
container.innerHTML = '<p class="text-muted">Noch keine Kommentare vorhanden.</p>';
|
||||
return;
|
||||
}
|
||||
|
||||
let html = '';
|
||||
comments.forEach(comment => {
|
||||
const canDelete = comment.is_own || {% if user.is_authenticated %}'{{ user.is_staff|yesno:"true,false" }}'{% else %}'false'{% endif %} === 'true';
|
||||
html += `
|
||||
<div class="comment-item border-bottom pb-2 mb-2">
|
||||
<div class="d-flex justify-content-between align-items-start">
|
||||
<div class="flex-grow-1">
|
||||
<strong>${comment.user}</strong>
|
||||
<small class="text-muted">(${comment.created_at})</small>
|
||||
${comment.updated_at !== comment.created_at ? `<small class="text-muted">(bearbeitet: ${comment.updated_at})</small>` : ''}
|
||||
<div class="mt-1">${comment.text}</div>
|
||||
</div>
|
||||
${canDelete ? `
|
||||
<button class="btn btn-sm btn-outline-danger ml-2 delete-comment-btn" data-comment-id="${comment.id}">
|
||||
<span aria-hidden="true">×</span>
|
||||
</button>
|
||||
` : ''}
|
||||
</div>
|
||||
</div>
|
||||
`;
|
||||
});
|
||||
|
||||
container.innerHTML = html;
|
||||
|
||||
// Add delete handlers
|
||||
document.querySelectorAll('.delete-comment-btn').forEach(btn => {
|
||||
btn.addEventListener('click', function() {
|
||||
if (confirm('Möchten Sie diesen Kommentar wirklich löschen?')) {
|
||||
deleteComment(this.dataset.commentId);
|
||||
}
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
// Add comment function
|
||||
document.getElementById('addCommentBtn').addEventListener('click', function() {
|
||||
const text = document.getElementById('newCommentText').value.trim();
|
||||
|
||||
if (!text) {
|
||||
alert('Bitte geben Sie einen Kommentar ein.');
|
||||
return;
|
||||
}
|
||||
|
||||
fetch(`/dokumente/comments/${currentVorgabeId}/add/`, {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'Content-Type': 'application/json',
|
||||
'X-CSRFToken': getCookie('csrftoken')
|
||||
},
|
||||
body: JSON.stringify({ text: text })
|
||||
})
|
||||
.then(response => response.json())
|
||||
.then(data => {
|
||||
if (data.success) {
|
||||
document.getElementById('newCommentText').value = '';
|
||||
loadComments();
|
||||
} else {
|
||||
alert('Fehler: ' + (data.error || 'Unbekannter Fehler'));
|
||||
}
|
||||
})
|
||||
.catch(error => {
|
||||
console.error('Error adding comment:', error);
|
||||
alert('Fehler beim Hinzufügen des Kommentars');
|
||||
});
|
||||
});
|
||||
|
||||
// Delete comment function
|
||||
function deleteComment(commentId) {
|
||||
fetch(`/dokumente/comments/delete/${commentId}/`, {
|
||||
method: 'POST',
|
||||
headers: {
|
||||
'X-CSRFToken': getCookie('csrftoken')
|
||||
}
|
||||
})
|
||||
.then(response => response.json())
|
||||
.then(data => {
|
||||
if (data.success) {
|
||||
loadComments();
|
||||
} else {
|
||||
alert('Fehler: ' + (data.error || 'Unbekannter Fehler'));
|
||||
}
|
||||
})
|
||||
.catch(error => {
|
||||
console.error('Error deleting comment:', error);
|
||||
alert('Fehler beim Löschen des Kommentars');
|
||||
});
|
||||
}
|
||||
|
||||
// CSRF token helper
|
||||
function getCookie(name) {
|
||||
let cookieValue = null;
|
||||
if (document.cookie && document.cookie !== '') {
|
||||
const cookies = document.cookie.split(';');
|
||||
for (let i = 0; i < cookies.length; i++) {
|
||||
const cookie = cookies[i].trim();
|
||||
if (cookie.substring(0, name.length + 1) === (name + '=')) {
|
||||
cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
return cookieValue;
|
||||
}
|
||||
});
|
||||
</script>
|
||||
|
||||
{% endblock %}
|
||||
@@ -2,10 +2,10 @@
|
||||
{% block content %}
|
||||
<h1>Standards Informatiksicherheit</h1>
|
||||
<ul>
|
||||
{% for standard in standards %}
|
||||
{% for dokument in dokumente %}
|
||||
<li>
|
||||
<a href="{% url 'standard_detail' nummer=standard.nummer %}">
|
||||
{{ standard.nummer }} – {{ standard.name }}
|
||||
<a href="{% url 'standard_detail' nummer=dokument.nummer %}">
|
||||
{{ dokument.nummer }} – {{ dokument.name }}
|
||||
</a>
|
||||
</li>
|
||||
{% endfor %}
|
||||
66
dokumente/templates/standards/user_comments.html
Normal file
66
dokumente/templates/standards/user_comments.html
Normal file
@@ -0,0 +1,66 @@
|
||||
{% extends "base.html" %}
|
||||
|
||||
{% block content %}
|
||||
<h1>Meine Kommentare</h1>
|
||||
|
||||
{% if total_comments == 0 %}
|
||||
<div class="alert alert-info">
|
||||
<p>Sie haben noch keine Kommentare zu Vorgaben hinterlassen.</p>
|
||||
<p><a href="{% url 'standard_list' %}">Zu den Standards</a></p>
|
||||
</div>
|
||||
{% else %}
|
||||
<p class="text-muted">Insgesamt {{ total_comments }} Kommentar{{ total_comments|pluralize:"e" }}</p>
|
||||
|
||||
{% for dokument, comments in comments_by_document.items %}
|
||||
<div class="panel panel-default" style="margin-top: 2rem;">
|
||||
<div class="panel-heading">
|
||||
<h2 style="margin: 0;">
|
||||
<a href="{% url 'standard_detail' nummer=dokument.nummer %}">
|
||||
{{ dokument.nummer }} – {{ dokument.name }}
|
||||
</a>
|
||||
</h2>
|
||||
<p style="margin: 0; color: #666; font-size: 0.9rem;">
|
||||
{{ comments|length }} Kommentar{{ comments|length|pluralize:"e" }}
|
||||
</p>
|
||||
</div>
|
||||
<div class="panel-body">
|
||||
<div class="list-group">
|
||||
{% for comment in comments %}
|
||||
<div class="list-group-item" style="border-left: 3px solid #007bff; padding: 1rem;">
|
||||
<div style="display: flex; justify-content: space-between; align-items: flex-start;">
|
||||
<div style="flex: 1;">
|
||||
<h4 style="margin: 0 0 0.5rem 0;">
|
||||
<a href="{% url 'standard_detail' nummer=comment.vorgabe.dokument.nummer %}#{{ comment.vorgabe.Vorgabennummer }}">
|
||||
{{ comment.vorgabe.Vorgabennummer }}
|
||||
</a> {{ comment.vorgabe.titel }}
|
||||
</h4>
|
||||
<p style="margin: 0 0 0.75rem 0; color: #666; font-size: 0.9rem;">
|
||||
<strong>Erstellt:</strong> {{ comment.created_at|date:"d.m.Y H:i" }}
|
||||
{% if comment.updated_at != comment.created_at %}
|
||||
<br>
|
||||
<strong>Bearbeitet:</strong> {{ comment.updated_at|date:"d.m.Y H:i" }}
|
||||
{% endif %}
|
||||
</p>
|
||||
</div>
|
||||
<form method="POST" action="{% url 'delete_vorgabe_comment' comment.id %}"
|
||||
style="display: inline; margin-left: 1rem;"
|
||||
onsubmit="return confirm('Sind Sie sicher, dass Sie diesen Kommentar löschen möchten?');">
|
||||
{% csrf_token %}
|
||||
<button type="submit" class="btn btn-sm btn-danger">Löschen</button>
|
||||
</form>
|
||||
</div>
|
||||
<div style="background: #f8f9fa; padding: 0.75rem; border-radius: 4px; margin-top: 0.5rem; white-space: pre-wrap; word-wrap: break-word;">
|
||||
{{ comment.text }}
|
||||
</div>
|
||||
</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
<div style="margin-top: 2rem; padding-top: 2rem; border-top: 1px solid #ddd;">
|
||||
<a href="{% url 'standard_list' %}" class="btn btn-default">Zu den Standards</a>
|
||||
</div>
|
||||
{% endblock %}
|
||||
385
dokumente/test_json.py
Normal file
385
dokumente/test_json.py
Normal file
@@ -0,0 +1,385 @@
|
||||
from django.test import TestCase, Client
|
||||
from django.urls import reverse
|
||||
from django.core.management import call_command
|
||||
from datetime import date
|
||||
from io import StringIO
|
||||
import tempfile
|
||||
import os
|
||||
import json
|
||||
|
||||
from dokumente.models import (
|
||||
Dokumententyp, Person, Thema, Dokument, Vorgabe,
|
||||
VorgabeLangtext, VorgabeKurztext, Geltungsbereich,
|
||||
Einleitung, Checklistenfrage, Changelog
|
||||
)
|
||||
from abschnitte.models import AbschnittTyp
|
||||
|
||||
|
||||
class JSONExportManagementCommandTest(TestCase):
|
||||
"""Test cases for export_json management command"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data for JSON export"""
|
||||
# Create test data
|
||||
self.dokumententyp = Dokumententyp.objects.create(
|
||||
name="Standard IT-Sicherheit",
|
||||
verantwortliche_ve="SR-SUR-SEC"
|
||||
)
|
||||
|
||||
self.autor1 = Person.objects.create(
|
||||
name="Max Mustermann",
|
||||
funktion="Security Analyst"
|
||||
)
|
||||
self.autor2 = Person.objects.create(
|
||||
name="Erika Mustermann",
|
||||
funktion="Security Manager"
|
||||
)
|
||||
|
||||
self.thema = Thema.objects.create(
|
||||
name="Access Control",
|
||||
erklaerung="Zugangskontrolle"
|
||||
)
|
||||
|
||||
self.dokument = Dokument.objects.create(
|
||||
nummer="TEST-001",
|
||||
dokumententyp=self.dokumententyp,
|
||||
name="Test Standard",
|
||||
gueltigkeit_von=date(2023, 1, 1),
|
||||
gueltigkeit_bis=date(2025, 12, 31),
|
||||
signatur_cso="CSO-123",
|
||||
anhaenge="Anhang1.pdf, Anhang2.pdf",
|
||||
aktiv=True
|
||||
)
|
||||
self.dokument.autoren.add(self.autor1, self.autor2)
|
||||
|
||||
self.vorgabe = Vorgabe.objects.create(
|
||||
order=1,
|
||||
nummer=1,
|
||||
dokument=self.dokument,
|
||||
thema=self.thema,
|
||||
titel="Test Vorgabe",
|
||||
gueltigkeit_von=date(2023, 1, 1),
|
||||
gueltigkeit_bis=date(2025, 12, 31)
|
||||
)
|
||||
|
||||
# Create text sections
|
||||
self.abschnitttyp_text = AbschnittTyp.objects.create(abschnitttyp="text")
|
||||
self.abschnitttyp_table = AbschnittTyp.objects.create(abschnitttyp="table")
|
||||
|
||||
self.geltungsbereich = Geltungsbereich.objects.create(
|
||||
geltungsbereich=self.dokument,
|
||||
abschnitttyp=self.abschnitttyp_text,
|
||||
inhalt="Dies ist der Geltungsbereich",
|
||||
order=1
|
||||
)
|
||||
|
||||
self.einleitung = Einleitung.objects.create(
|
||||
einleitung=self.dokument,
|
||||
abschnitttyp=self.abschnitttyp_text,
|
||||
inhalt="Dies ist die Einleitung",
|
||||
order=1
|
||||
)
|
||||
|
||||
self.kurztext = VorgabeKurztext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.abschnitttyp_text,
|
||||
inhalt="Dies ist der Kurztext",
|
||||
order=1
|
||||
)
|
||||
|
||||
self.langtext = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.abschnitttyp_table,
|
||||
inhalt="Spalte1|Spalte2\nWert1|Wert2",
|
||||
order=1
|
||||
)
|
||||
|
||||
self.checklistenfrage = Checklistenfrage.objects.create(
|
||||
vorgabe=self.vorgabe,
|
||||
frage="Ist die Zugriffskontrolle implementiert?"
|
||||
)
|
||||
|
||||
self.changelog = Changelog.objects.create(
|
||||
dokument=self.dokument,
|
||||
datum=date(2023, 6, 1),
|
||||
aenderung="Erste Version erstellt"
|
||||
)
|
||||
self.changelog.autoren.add(self.autor1)
|
||||
|
||||
def test_export_json_command_stdout(self):
|
||||
"""Test export_json command output to stdout"""
|
||||
out = StringIO()
|
||||
call_command('export_json', stdout=out)
|
||||
|
||||
output = out.getvalue()
|
||||
|
||||
# Check that output contains expected JSON structure
|
||||
self.assertIn('"Typ": "Standard IT-Sicherheit"', output)
|
||||
self.assertIn('"Nummer": "TEST-001"', output)
|
||||
self.assertIn('"Name": "Test Standard"', output)
|
||||
self.assertIn('"Max Mustermann"', output)
|
||||
self.assertIn('"Erika Mustermann"', output)
|
||||
self.assertIn('"Von": "2023-01-01"', output)
|
||||
self.assertIn('"Bis": "2025-12-31"', output)
|
||||
self.assertIn('"SignaturCSO": "CSO-123"', output)
|
||||
self.assertIn('"Dies ist der Geltungsbereich"', output)
|
||||
self.assertIn('"Dies ist die Einleitung"', output)
|
||||
self.assertIn('"Dies ist der Kurztext"', output)
|
||||
self.assertIn('"Ist die Zugriffskontrolle implementiert?"', output)
|
||||
self.assertIn('"Erste Version erstellt"', output)
|
||||
|
||||
def test_export_json_command_to_file(self):
|
||||
"""Test export_json command output to file"""
|
||||
with tempfile.NamedTemporaryFile(mode='w', delete=False, suffix='.json') as tmp_file:
|
||||
tmp_filename = tmp_file.name
|
||||
|
||||
try:
|
||||
call_command('export_json', output=tmp_filename)
|
||||
|
||||
# Read file content
|
||||
with open(tmp_filename, 'r', encoding='utf-8') as f:
|
||||
content = f.read()
|
||||
|
||||
# Parse JSON to ensure it's valid
|
||||
data = json.loads(content)
|
||||
|
||||
# Verify structure
|
||||
self.assertIsInstance(data, list)
|
||||
self.assertEqual(len(data), 1)
|
||||
|
||||
doc_data = data[0]
|
||||
self.assertEqual(doc_data['Nummer'], 'TEST-001')
|
||||
self.assertEqual(doc_data['Name'], 'Test Standard')
|
||||
self.assertEqual(doc_data['Typ'], 'Standard IT-Sicherheit')
|
||||
self.assertEqual(len(doc_data['Autoren']), 2)
|
||||
self.assertIn('Max Mustermann', doc_data['Autoren'])
|
||||
self.assertIn('Erika Mustermann', doc_data['Autoren'])
|
||||
|
||||
finally:
|
||||
# Clean up temporary file
|
||||
if os.path.exists(tmp_filename):
|
||||
os.unlink(tmp_filename)
|
||||
|
||||
def test_export_json_command_empty_database(self):
|
||||
"""Test export_json command with no documents"""
|
||||
# Delete all documents
|
||||
Dokument.objects.all().delete()
|
||||
|
||||
out = StringIO()
|
||||
call_command('export_json', stdout=out)
|
||||
|
||||
output = out.getvalue()
|
||||
|
||||
# Should output empty array
|
||||
self.assertEqual(output.strip(), '[]')
|
||||
|
||||
def test_export_json_command_inactive_documents(self):
|
||||
"""Test export_json command filters inactive documents"""
|
||||
# Create inactive document
|
||||
inactive_doc = Dokument.objects.create(
|
||||
nummer="INACTIVE-001",
|
||||
dokumententyp=self.dokumententyp,
|
||||
name="Inactive Document",
|
||||
aktiv=False
|
||||
)
|
||||
|
||||
out = StringIO()
|
||||
call_command('export_json', stdout=out)
|
||||
|
||||
output = out.getvalue()
|
||||
|
||||
# Should not contain inactive document
|
||||
self.assertNotIn('"INACTIVE-001"', output)
|
||||
self.assertNotIn('"Inactive Document"', output)
|
||||
|
||||
# Should still contain active document
|
||||
self.assertIn('"TEST-001"', output)
|
||||
self.assertIn('"Test Standard"', output)
|
||||
|
||||
|
||||
class StandardJSONViewTest(TestCase):
|
||||
"""Test cases for standard_json view"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data for JSON view"""
|
||||
self.client = Client()
|
||||
|
||||
# Create test data
|
||||
self.dokumententyp = Dokumententyp.objects.create(
|
||||
name="Standard IT-Sicherheit",
|
||||
verantwortliche_ve="SR-SUR-SEC"
|
||||
)
|
||||
|
||||
self.autor = Person.objects.create(
|
||||
name="Test Autor",
|
||||
funktion="Security Analyst"
|
||||
)
|
||||
|
||||
self.pruefender = Person.objects.create(
|
||||
name="Test Pruefender",
|
||||
funktion="Security Manager"
|
||||
)
|
||||
|
||||
self.thema = Thema.objects.create(
|
||||
name="Access Control",
|
||||
erklaerung="Zugangskontrolle"
|
||||
)
|
||||
|
||||
self.dokument = Dokument.objects.create(
|
||||
nummer="JSON-001",
|
||||
dokumententyp=self.dokumententyp,
|
||||
name="JSON Test Standard",
|
||||
gueltigkeit_von=date(2023, 1, 1),
|
||||
gueltigkeit_bis=date(2025, 12, 31),
|
||||
signatur_cso="CSO-456",
|
||||
anhaenge="test.pdf",
|
||||
aktiv=True
|
||||
)
|
||||
self.dokument.autoren.add(self.autor)
|
||||
self.dokument.pruefende.add(self.pruefender)
|
||||
|
||||
self.vorgabe = Vorgabe.objects.create(
|
||||
order=1,
|
||||
nummer=1,
|
||||
dokument=self.dokument,
|
||||
thema=self.thema,
|
||||
titel="JSON Test Vorgabe",
|
||||
gueltigkeit_von=date(2023, 1, 1),
|
||||
gueltigkeit_bis=date(2025, 12, 31)
|
||||
)
|
||||
|
||||
# Create text sections
|
||||
self.abschnitttyp_text = AbschnittTyp.objects.create(abschnitttyp="text")
|
||||
|
||||
self.geltungsbereich = Geltungsbereich.objects.create(
|
||||
geltungsbereich=self.dokument,
|
||||
abschnitttyp=self.abschnitttyp_text,
|
||||
inhalt="Dies ist der Geltungsbereich",
|
||||
order=1
|
||||
)
|
||||
|
||||
self.einleitung = Einleitung.objects.create(
|
||||
einleitung=self.dokument,
|
||||
abschnitttyp=self.abschnitttyp_text,
|
||||
inhalt="Dies ist die Einleitung",
|
||||
order=1
|
||||
)
|
||||
|
||||
self.kurztext = VorgabeKurztext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.abschnitttyp_text,
|
||||
inhalt="JSON Kurztext",
|
||||
order=1
|
||||
)
|
||||
|
||||
self.langtext = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
abschnitttyp=self.abschnitttyp_text,
|
||||
inhalt="JSON Langtext",
|
||||
order=1
|
||||
)
|
||||
|
||||
self.checklistenfrage = Checklistenfrage.objects.create(
|
||||
vorgabe=self.vorgabe,
|
||||
frage="JSON Checklistenfrage?"
|
||||
)
|
||||
|
||||
self.changelog = Changelog.objects.create(
|
||||
dokument=self.dokument,
|
||||
datum=date(2023, 6, 1),
|
||||
aenderung="JSON Changelog Eintrag"
|
||||
)
|
||||
self.changelog.autoren.add(self.autor)
|
||||
|
||||
def test_standard_json_view_success(self):
|
||||
"""Test standard_json view returns correct JSON"""
|
||||
url = reverse('standard_json', kwargs={'nummer': 'JSON-001'})
|
||||
response = self.client.get(url)
|
||||
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertEqual(response['Content-Type'], 'application/json')
|
||||
|
||||
# Parse JSON response
|
||||
data = json.loads(response.content)
|
||||
|
||||
# Verify document structure
|
||||
self.assertEqual(data['Nummer'], 'JSON-001')
|
||||
self.assertEqual(data['Name'], 'JSON Test Standard')
|
||||
self.assertEqual(data['Typ'], 'Standard IT-Sicherheit')
|
||||
self.assertEqual(len(data['Autoren']), 1)
|
||||
self.assertEqual(data['Autoren'][0], 'Test Autor')
|
||||
self.assertEqual(len(data['Pruefende']), 1)
|
||||
self.assertEqual(data['Pruefende'][0], 'Test Pruefender')
|
||||
self.assertEqual(data['Gueltigkeit']['Von'], '2023-01-01')
|
||||
self.assertEqual(data['Gueltigkeit']['Bis'], '2025-12-31')
|
||||
self.assertEqual(data['SignaturCSO'], 'CSO-456')
|
||||
self.assertEqual(data['Anhänge'], 'test.pdf')
|
||||
self.assertEqual(data['Verantwortlich'], 'Information Security Management BIT')
|
||||
self.assertIsNone(data['Klassifizierung'])
|
||||
|
||||
def test_standard_json_view_not_found(self):
|
||||
"""Test standard_json view returns 404 for non-existent document"""
|
||||
url = reverse('standard_json', kwargs={'nummer': 'NONEXISTENT'})
|
||||
response = self.client.get(url)
|
||||
|
||||
self.assertEqual(response.status_code, 404)
|
||||
|
||||
def test_standard_json_view_empty_sections(self):
|
||||
"""Test standard_json view handles empty sections correctly"""
|
||||
# Create document without sections
|
||||
empty_doc = Dokument.objects.create(
|
||||
nummer="EMPTY-001",
|
||||
dokumententyp=self.dokumententyp,
|
||||
name="Empty Document",
|
||||
aktiv=True
|
||||
)
|
||||
|
||||
url = reverse('standard_json', kwargs={'nummer': 'EMPTY-001'})
|
||||
response = self.client.get(url)
|
||||
|
||||
data = json.loads(response.content)
|
||||
|
||||
# Verify empty sections are handled correctly
|
||||
self.assertEqual(data['Geltungsbereich'], {})
|
||||
self.assertEqual(data['Einleitung'], {})
|
||||
self.assertEqual(data['Vorgaben'], [])
|
||||
self.assertEqual(data['Changelog'], [])
|
||||
|
||||
def test_standard_json_view_null_dates(self):
|
||||
"""Test standard_json view handles null dates correctly"""
|
||||
# Create document with null dates
|
||||
null_doc = Dokument.objects.create(
|
||||
nummer="NULL-001",
|
||||
dokumententyp=self.dokumententyp,
|
||||
name="Null Dates Document",
|
||||
gueltigkeit_von=None,
|
||||
gueltigkeit_bis=None,
|
||||
aktiv=True
|
||||
)
|
||||
|
||||
url = reverse('standard_json', kwargs={'nummer': 'NULL-001'})
|
||||
response = self.client.get(url)
|
||||
|
||||
data = json.loads(response.content)
|
||||
|
||||
# Verify null dates are handled correctly
|
||||
self.assertEqual(data['Gueltigkeit']['Von'], '')
|
||||
self.assertIsNone(data['Gueltigkeit']['Bis'])
|
||||
|
||||
def test_standard_json_view_json_formatting(self):
|
||||
"""Test standard_json view returns properly formatted JSON"""
|
||||
url = reverse('standard_json', kwargs={'nummer': 'JSON-001'})
|
||||
response = self.client.get(url)
|
||||
|
||||
# Check that response is valid JSON
|
||||
try:
|
||||
data = json.loads(response.content)
|
||||
json_valid = True
|
||||
except json.JSONDecodeError:
|
||||
json_valid = False
|
||||
|
||||
self.assertTrue(json_valid)
|
||||
|
||||
# Check that JSON is properly indented (should be formatted)
|
||||
self.assertIn('\n', response.content.decode())
|
||||
self.assertIn(' ', response.content.decode()) # Check for indentation
|
||||
2838
dokumente/tests.py
Normal file
2838
dokumente/tests.py
Normal file
File diff suppressed because it is too large
Load Diff
18
dokumente/urls.py
Normal file
18
dokumente/urls.py
Normal file
@@ -0,0 +1,18 @@
|
||||
from django.urls import path
|
||||
from . import views
|
||||
|
||||
urlpatterns = [
|
||||
path('', views.standard_list, name='standard_list'),
|
||||
path('unvollstaendig/', views.incomplete_vorgaben, name='incomplete_vorgaben'),
|
||||
path('meine-kommentare/', views.user_comments, name='user_comments'),
|
||||
path('alle-kommentare/', views.all_comments, name='all_comments'),
|
||||
path('<str:nummer>/', views.standard_detail, name='standard_detail'),
|
||||
path('<str:nummer>/history/<str:check_date>/', views.standard_detail),
|
||||
path('<str:nummer>/history/', views.standard_detail, {"check_date":"today"}, name='standard_history'),
|
||||
path('<str:nummer>/checkliste/', views.standard_checkliste, name='standard_checkliste'),
|
||||
path('<str:nummer>/json/', views.standard_json, name='standard_json'),
|
||||
path('comments/<int:vorgabe_id>/', views.get_vorgabe_comments, name='get_vorgabe_comments'),
|
||||
path('comments/<int:vorgabe_id>/add/', views.add_vorgabe_comment, name='add_vorgabe_comment'),
|
||||
path('comments/delete/<int:comment_id>/', views.delete_vorgabe_comment, name='delete_vorgabe_comment'),
|
||||
]
|
||||
|
||||
123
dokumente/utils.py
Normal file
123
dokumente/utils.py
Normal file
@@ -0,0 +1,123 @@
|
||||
"""
|
||||
Utility functions for Vorgaben sanity checking
|
||||
"""
|
||||
import datetime
|
||||
from django.db.models import Count
|
||||
from itertools import combinations
|
||||
from dokumente.models import Vorgabe
|
||||
|
||||
|
||||
def check_vorgabe_conflicts():
|
||||
"""
|
||||
Check for conflicts in Vorgaben.
|
||||
|
||||
Main rule: If there are two Vorgaben with the same number, Thema and Dokument,
|
||||
their valid_from and valid_to date ranges shouldn't intersect.
|
||||
|
||||
Returns:
|
||||
list: List of conflict dictionaries
|
||||
"""
|
||||
conflicts = []
|
||||
|
||||
# Find Vorgaben with same dokument, thema, and nummer
|
||||
duplicate_groups = (
|
||||
Vorgabe.objects.values('dokument', 'thema', 'nummer')
|
||||
.annotate(count=Count('id'))
|
||||
.filter(count__gt=1)
|
||||
)
|
||||
|
||||
for group in duplicate_groups:
|
||||
# Get all Vorgaben in this group
|
||||
vorgaben = Vorgabe.objects.filter(
|
||||
dokument=group['dokument'],
|
||||
thema=group['thema'],
|
||||
nummer=group['nummer']
|
||||
)
|
||||
|
||||
# Check all pairs for date range intersections
|
||||
for vorgabe1, vorgabe2 in combinations(vorgaben, 2):
|
||||
if date_ranges_intersect(
|
||||
vorgabe1.gueltigkeit_von, vorgabe1.gueltigkeit_bis,
|
||||
vorgabe2.gueltigkeit_von, vorgabe2.gueltigkeit_bis
|
||||
):
|
||||
conflicts.append({
|
||||
'vorgabe1': vorgabe1,
|
||||
'vorgabe2': vorgabe2,
|
||||
'conflict_type': 'date_range_intersection',
|
||||
'message': f"Vorgaben {vorgabe1.Vorgabennummer()} and {vorgabe2.Vorgabennummer()} "
|
||||
f"have intersecting validity periods"
|
||||
})
|
||||
|
||||
return conflicts
|
||||
|
||||
|
||||
def date_ranges_intersect(start1, end1, start2, end2):
|
||||
"""
|
||||
Check if two date ranges intersect.
|
||||
None end date means open-ended range.
|
||||
|
||||
Args:
|
||||
start1, start2: Start dates
|
||||
end1, end2: End dates (can be None for open-ended)
|
||||
|
||||
Returns:
|
||||
bool: True if ranges intersect
|
||||
"""
|
||||
# If either start date is None, treat it as invalid case
|
||||
if not start1 or not start2:
|
||||
return False
|
||||
|
||||
# If end date is None, treat it as far future
|
||||
end1 = end1 or datetime.date.max
|
||||
end2 = end2 or datetime.date.max
|
||||
|
||||
# Ranges intersect if start1 <= end2 and start2 <= end1
|
||||
return start1 <= end2 and start2 <= end1
|
||||
|
||||
|
||||
def format_conflict_report(conflicts, verbose=False):
|
||||
"""
|
||||
Format conflicts into a readable report.
|
||||
|
||||
Args:
|
||||
conflicts: List of conflict dictionaries
|
||||
verbose: Whether to show detailed information
|
||||
|
||||
Returns:
|
||||
str: Formatted report
|
||||
"""
|
||||
if not conflicts:
|
||||
return "✓ No conflicts found in Vorgaben"
|
||||
|
||||
lines = [f"Found {len(conflicts)} conflicts:"]
|
||||
|
||||
for i, conflict in enumerate(conflicts, 1):
|
||||
lines.append(f"\n{i}. {conflict['message']}")
|
||||
|
||||
if verbose:
|
||||
v1 = conflict['vorgabe1']
|
||||
v2 = conflict['vorgabe2']
|
||||
|
||||
lines.append(f" Vorgabe 1: {v1.Vorgabennummer()}")
|
||||
lines.append(f" Valid from: {v1.gueltigkeit_von} to {v1.gueltigkeit_bis or 'unlimited'}")
|
||||
lines.append(f" Title: {v1.titel}")
|
||||
|
||||
lines.append(f" Vorgabe 2: {v2.Vorgabennummer()}")
|
||||
lines.append(f" Valid from: {v2.gueltigkeit_von} to {v2.gueltigkeit_bis or 'unlimited'}")
|
||||
lines.append(f" Title: {v2.titel}")
|
||||
|
||||
# Show the overlapping period
|
||||
v1 = conflict['vorgabe1']
|
||||
v2 = conflict['vorgabe2']
|
||||
overlap_start = max(v1.gueltigkeit_von, v2.gueltigkeit_von)
|
||||
overlap_end = min(
|
||||
v1.gueltigkeit_bis or datetime.date.max,
|
||||
v2.gueltigkeit_bis or datetime.date.max
|
||||
)
|
||||
|
||||
if overlap_end != datetime.date.max:
|
||||
lines.append(f" Overlap: {overlap_start} to {overlap_end}")
|
||||
else:
|
||||
lines.append(f" Overlap starts: {overlap_start} (no end)")
|
||||
|
||||
return "\n".join(lines)
|
||||
422
dokumente/views.py
Normal file
422
dokumente/views.py
Normal file
@@ -0,0 +1,422 @@
|
||||
from django.shortcuts import render, get_object_or_404
|
||||
from django.contrib.auth.decorators import login_required, user_passes_test
|
||||
from django.http import JsonResponse
|
||||
from django.core.serializers.json import DjangoJSONEncoder
|
||||
from django.views.decorators.http import require_POST
|
||||
from django.views.decorators.csrf import csrf_exempt
|
||||
from django.utils.html import escape, mark_safe
|
||||
from django.utils.safestring import SafeString
|
||||
import json
|
||||
from .models import Dokument, Vorgabe, VorgabeKurztext, VorgabeLangtext, Checklistenfrage, VorgabeComment
|
||||
from abschnitte.utils import render_textabschnitte
|
||||
|
||||
from datetime import date
|
||||
import parsedatetime
|
||||
|
||||
calendar=parsedatetime.Calendar()
|
||||
|
||||
|
||||
def standard_list(request):
|
||||
dokumente = Dokument.objects.all()
|
||||
return render(request, 'standards/standard_list.html',
|
||||
{'dokumente': dokumente}
|
||||
)
|
||||
|
||||
|
||||
def standard_detail(request, nummer,check_date=""):
|
||||
standard = get_object_or_404(Dokument, nummer=nummer)
|
||||
|
||||
if check_date:
|
||||
check_date = calendar.parseDT(check_date)[0].date()
|
||||
standard.history = True
|
||||
else:
|
||||
check_date = date.today()
|
||||
standard.history = False
|
||||
standard.check_date=check_date
|
||||
vorgaben = list(standard.vorgaben.order_by("thema","nummer").select_related("thema","dokument")) # convert queryset to list so we can attach attributes
|
||||
|
||||
standard.geltungsbereich_html = render_textabschnitte(standard.geltungsbereich_set.order_by("order").select_related("abschnitttyp"))
|
||||
standard.einleitung_html=render_textabschnitte(standard.einleitung_set.order_by("order"))
|
||||
for vorgabe in vorgaben:
|
||||
# Prepare Kurztext HTML
|
||||
vorgabe.kurztext_html = render_textabschnitte(vorgabe.vorgabekurztext_set.order_by("order").select_related("abschnitttyp","abschnitt"))
|
||||
vorgabe.langtext_html = render_textabschnitte(vorgabe.vorgabelangtext_set.order_by("order").select_related("abschnitttyp","abschnitt"))
|
||||
vorgabe.long_status=vorgabe.get_status(check_date,verbose=True)
|
||||
vorgabe.relevanzset=list(vorgabe.relevanz.all())
|
||||
|
||||
referenz_items = []
|
||||
for r in vorgabe.referenzen.all():
|
||||
referenz_items.append(r.Path())
|
||||
vorgabe.referenzpfade = referenz_items
|
||||
|
||||
# Add comment count
|
||||
if request.user.is_authenticated:
|
||||
if request.user.is_staff:
|
||||
vorgabe.comment_count = vorgabe.comments.count()
|
||||
else:
|
||||
vorgabe.comment_count = vorgabe.comments.filter(user=request.user).count()
|
||||
else:
|
||||
vorgabe.comment_count = 0
|
||||
|
||||
return render(request, 'standards/standard_detail.html', {
|
||||
'standard': standard,
|
||||
'vorgaben': vorgaben,
|
||||
})
|
||||
|
||||
|
||||
def standard_checkliste(request, nummer):
|
||||
standard = get_object_or_404(Dokument, nummer=nummer)
|
||||
vorgaben = list(standard.vorgaben.all())
|
||||
return render(request, 'standards/standard_checkliste.html', {
|
||||
'standard': standard,
|
||||
'vorgaben': vorgaben,
|
||||
})
|
||||
|
||||
|
||||
def is_staff_user(user):
|
||||
return user.is_staff
|
||||
|
||||
@login_required
|
||||
@user_passes_test(is_staff_user)
|
||||
def incomplete_vorgaben(request):
|
||||
"""
|
||||
Show table of all Vorgaben with completeness status:
|
||||
- References (✓ or ✗)
|
||||
- Stichworte (✓ or ✗)
|
||||
- Text (✓ or ✗)
|
||||
- Checklistenfragen (✓ or ✗)
|
||||
"""
|
||||
# Get all active Vorgaben
|
||||
all_vorgaben = Vorgabe.objects.all().select_related('dokument', 'thema').prefetch_related(
|
||||
'referenzen', 'stichworte', 'checklistenfragen', 'vorgabekurztext_set', 'vorgabelangtext_set'
|
||||
)
|
||||
|
||||
# Build table data
|
||||
vorgaben_data = []
|
||||
for vorgabe in all_vorgaben:
|
||||
has_references = vorgabe.referenzen.exists()
|
||||
has_stichworte = vorgabe.stichworte.exists()
|
||||
has_kurztext = vorgabe.vorgabekurztext_set.exists()
|
||||
has_langtext = vorgabe.vorgabelangtext_set.exists()
|
||||
has_text = has_kurztext or has_langtext
|
||||
has_checklistenfragen = vorgabe.checklistenfragen.exists()
|
||||
|
||||
# Only include Vorgaben that are incomplete in at least one way
|
||||
if not (has_references and has_stichworte and has_text and has_checklistenfragen):
|
||||
vorgaben_data.append({
|
||||
'vorgabe': vorgabe,
|
||||
'has_references': has_references,
|
||||
'has_stichworte': has_stichworte,
|
||||
'has_text': has_text,
|
||||
'has_checklistenfragen': has_checklistenfragen,
|
||||
'is_complete': has_references and has_stichworte and has_text and has_checklistenfragen
|
||||
})
|
||||
|
||||
# Sort by document number and Vorgabe number
|
||||
vorgaben_data.sort(key=lambda x: (x['vorgabe'].dokument.nummer, x['vorgabe'].Vorgabennummer()))
|
||||
|
||||
return render(request, 'standards/incomplete_vorgaben.html', {
|
||||
'vorgaben_data': vorgaben_data,
|
||||
})
|
||||
|
||||
|
||||
def standard_json(request, nummer):
|
||||
"""
|
||||
Export a single Dokument as JSON
|
||||
"""
|
||||
# Get the document with all related data
|
||||
dokument = get_object_or_404(
|
||||
Dokument.objects.prefetch_related(
|
||||
'autoren', 'pruefende', 'vorgaben__thema',
|
||||
'vorgaben__referenzen', 'vorgaben__stichworte',
|
||||
'vorgaben__checklistenfragen', 'vorgaben__vorgabekurztext_set',
|
||||
'vorgaben__vorgabelangtext_set', 'geltungsbereich_set',
|
||||
'einleitung_set', 'changelog__autoren'
|
||||
),
|
||||
nummer=nummer
|
||||
)
|
||||
|
||||
# Build document structure (reusing logic from export_json command)
|
||||
doc_data = {
|
||||
"Typ": dokument.dokumententyp.name if dokument.dokumententyp else "",
|
||||
"Nummer": dokument.nummer,
|
||||
"Name": dokument.name,
|
||||
"Autoren": [autor.name for autor in dokument.autoren.all()],
|
||||
"Pruefende": [pruefender.name for pruefender in dokument.pruefende.all()],
|
||||
"Gueltigkeit": {
|
||||
"Von": dokument.gueltigkeit_von.strftime("%Y-%m-%d") if dokument.gueltigkeit_von else "",
|
||||
"Bis": dokument.gueltigkeit_bis.strftime("%Y-%m-%d") if dokument.gueltigkeit_bis else None
|
||||
},
|
||||
"SignaturCSO": dokument.signatur_cso,
|
||||
"Geltungsbereich": {},
|
||||
"Einleitung": {},
|
||||
"Ziel": "",
|
||||
"Grundlagen": "",
|
||||
"Changelog": [],
|
||||
"Anhänge": dokument.anhaenge,
|
||||
"Verantwortlich": "Information Security Management BIT",
|
||||
"Klassifizierung": None,
|
||||
"Glossar": {},
|
||||
"Vorgaben": []
|
||||
}
|
||||
|
||||
# Process Geltungsbereich sections
|
||||
geltungsbereich_sections = []
|
||||
for gb in dokument.geltungsbereich_set.all().order_by('order'):
|
||||
geltungsbereich_sections.append({
|
||||
"typ": gb.abschnitttyp.abschnitttyp if gb.abschnitttyp else "text",
|
||||
"inhalt": gb.inhalt
|
||||
})
|
||||
|
||||
if geltungsbereich_sections:
|
||||
doc_data["Geltungsbereich"] = {
|
||||
"Abschnitt": geltungsbereich_sections
|
||||
}
|
||||
|
||||
# Process Einleitung sections
|
||||
einleitung_sections = []
|
||||
for ei in dokument.einleitung_set.all().order_by('order'):
|
||||
einleitung_sections.append({
|
||||
"typ": ei.abschnitttyp.abschnitttyp if ei.abschnitttyp else "text",
|
||||
"inhalt": ei.inhalt
|
||||
})
|
||||
|
||||
if einleitung_sections:
|
||||
doc_data["Einleitung"] = {
|
||||
"Abschnitt": einleitung_sections
|
||||
}
|
||||
|
||||
# Process Changelog entries
|
||||
changelog_entries = []
|
||||
for cl in dokument.changelog.all().order_by('-datum'):
|
||||
changelog_entries.append({
|
||||
"Datum": cl.datum.strftime("%Y-%m-%d"),
|
||||
"Autoren": [autor.name for autor in cl.autoren.all()],
|
||||
"Aenderung": cl.aenderung
|
||||
})
|
||||
|
||||
doc_data["Changelog"] = changelog_entries
|
||||
|
||||
# Process Vorgaben for this document
|
||||
vorgaben = dokument.vorgaben.all().order_by('order')
|
||||
|
||||
for vorgabe in vorgaben:
|
||||
# Get Kurztext and Langtext sections
|
||||
kurztext_sections = []
|
||||
for kt in vorgabe.vorgabekurztext_set.all().order_by('order'):
|
||||
kurztext_sections.append({
|
||||
"typ": kt.abschnitttyp.abschnitttyp if kt.abschnitttyp else "text",
|
||||
"inhalt": kt.inhalt
|
||||
})
|
||||
|
||||
langtext_sections = []
|
||||
for lt in vorgabe.vorgabelangtext_set.all().order_by('order'):
|
||||
langtext_sections.append({
|
||||
"typ": lt.abschnitttyp.abschnitttyp if lt.abschnitttyp else "text",
|
||||
"inhalt": lt.inhalt
|
||||
})
|
||||
|
||||
# Build text structures following Langtext pattern
|
||||
kurztext = {
|
||||
"Abschnitt": kurztext_sections if kurztext_sections else []
|
||||
} if kurztext_sections else {}
|
||||
langtext = {
|
||||
"Abschnitt": langtext_sections if langtext_sections else []
|
||||
} if langtext_sections else {}
|
||||
|
||||
# Get references and keywords
|
||||
referenzen = [f"{ref.name_nummer}: {ref.name_text}" if ref.name_text else ref.name_nummer for ref in vorgabe.referenzen.all()]
|
||||
stichworte = [stw.stichwort for stw in vorgabe.stichworte.all()]
|
||||
|
||||
# Get checklist questions
|
||||
checklistenfragen = [cf.frage for cf in vorgabe.checklistenfragen.all()]
|
||||
|
||||
vorgabe_data = {
|
||||
"Nummer": str(vorgabe.nummer),
|
||||
"Titel": vorgabe.titel,
|
||||
"Thema": vorgabe.thema.name if vorgabe.thema else "",
|
||||
"Kurztext": kurztext,
|
||||
"Langtext": langtext,
|
||||
"Referenz": referenzen,
|
||||
"Gueltigkeit": {
|
||||
"Von": vorgabe.gueltigkeit_von.strftime("%Y-%m-%d") if vorgabe.gueltigkeit_von else "",
|
||||
"Bis": vorgabe.gueltigkeit_bis.strftime("%Y-%m-%d") if vorgabe.gueltigkeit_bis else None
|
||||
},
|
||||
"Checklistenfragen": checklistenfragen,
|
||||
"Stichworte": stichworte
|
||||
}
|
||||
|
||||
doc_data["Vorgaben"].append(vorgabe_data)
|
||||
|
||||
# Return JSON response
|
||||
return JsonResponse(doc_data, json_dumps_params={'indent': 2, 'ensure_ascii': False}, encoder=DjangoJSONEncoder)
|
||||
|
||||
|
||||
@login_required
|
||||
def get_vorgabe_comments(request, vorgabe_id):
|
||||
"""Get comments for a specific Vorgabe"""
|
||||
vorgabe = get_object_or_404(Vorgabe, id=vorgabe_id)
|
||||
|
||||
if request.user.is_staff:
|
||||
# Staff can see all comments
|
||||
comments = vorgabe.comments.all().select_related('user').order_by('created_at')
|
||||
else:
|
||||
# Regular users can only see their own comments
|
||||
comments = vorgabe.comments.filter(user=request.user).select_related('user').order_by('created_at')
|
||||
|
||||
comments_data = []
|
||||
for comment in comments:
|
||||
# Escape HTML but preserve line breaks
|
||||
escaped_text = escape(comment.text).replace('\n', '<br>')
|
||||
comments_data.append({
|
||||
'id': comment.id,
|
||||
'text': escaped_text,
|
||||
'user': escape(comment.user.first_name+" "+comment.user.last_name),
|
||||
'created_at': comment.created_at.strftime('%d.%m.%Y %H:%M'),
|
||||
'updated_at': comment.updated_at.strftime('%d.%m.%Y %H:%M'),
|
||||
'is_own': comment.user == request.user
|
||||
})
|
||||
|
||||
response = JsonResponse({'comments': comments_data})
|
||||
response['Content-Security-Policy'] = "default-src 'self'"
|
||||
response['X-Content-Type-Options'] = 'nosniff'
|
||||
return response
|
||||
|
||||
|
||||
@require_POST
|
||||
@login_required
|
||||
def add_vorgabe_comment(request, vorgabe_id):
|
||||
"""Add a new comment to a Vorgabe"""
|
||||
vorgabe = get_object_or_404(Vorgabe, id=vorgabe_id)
|
||||
|
||||
try:
|
||||
data = json.loads(request.body)
|
||||
text = data.get('text', '').strip()
|
||||
|
||||
# Validate input
|
||||
if not text:
|
||||
return JsonResponse({'error': 'Kommentar darf nicht leer sein'}, status=400)
|
||||
|
||||
if len(text) > 2000: # Reasonable length limit
|
||||
return JsonResponse({'error': 'Kommentar ist zu lang (max 2000 Zeichen)'}, status=400)
|
||||
|
||||
# Additional XSS prevention - check for dangerous patterns
|
||||
dangerous_patterns = ['<script', 'javascript:', 'onload=', 'onerror=', 'onclick=', 'onmouseover=']
|
||||
text_lower = text.lower()
|
||||
for pattern in dangerous_patterns:
|
||||
if pattern in text_lower:
|
||||
return JsonResponse({'error': 'Kommentar enthält ungültige Zeichen'}, status=400)
|
||||
|
||||
comment = VorgabeComment.objects.create(
|
||||
vorgabe=vorgabe,
|
||||
user=request.user,
|
||||
text=text
|
||||
)
|
||||
|
||||
# Escape HTML but preserve line breaks
|
||||
escaped_text = escape(comment.text).replace('\n', '<br>')
|
||||
response = JsonResponse({
|
||||
'success': True,
|
||||
'comment': {
|
||||
'id': comment.id,
|
||||
'text': escaped_text,
|
||||
'user': escape(comment.user.username),
|
||||
'created_at': comment.created_at.strftime('%d.%m.%Y %H:%M'),
|
||||
'updated_at': comment.updated_at.strftime('%d.%m.%Y %H:%M'),
|
||||
'is_own': True
|
||||
}
|
||||
})
|
||||
response['Content-Security-Policy'] = "default-src 'self'"
|
||||
response['X-Content-Type-Options'] = 'nosniff'
|
||||
return response
|
||||
|
||||
except json.JSONDecodeError:
|
||||
response = JsonResponse({'error': 'Ungültige Daten'}, status=400)
|
||||
response['Content-Security-Policy'] = "default-src 'self'"
|
||||
response['X-Content-Type-Options'] = 'nosniff'
|
||||
return response
|
||||
except Exception as e:
|
||||
response = JsonResponse({'error': 'Serverfehler'}, status=500)
|
||||
response['Content-Security-Policy'] = "default-src 'self'"
|
||||
response['X-Content-Type-Options'] = 'nosniff'
|
||||
return response
|
||||
|
||||
|
||||
@require_POST
|
||||
@login_required
|
||||
def delete_vorgabe_comment(request, comment_id):
|
||||
"""Delete a comment (only own comments or staff can delete)"""
|
||||
comment = get_object_or_404(VorgabeComment, id=comment_id)
|
||||
|
||||
# Check if user can delete this comment
|
||||
if comment.user != request.user and not request.user.is_staff:
|
||||
response = JsonResponse({'error': 'Keine Berechtigung zum Löschen dieses Kommentars'}, status=403)
|
||||
response['Content-Security-Policy'] = "default-src 'self'"
|
||||
response['X-Content-Type-Options'] = 'nosniff'
|
||||
return response
|
||||
|
||||
try:
|
||||
comment.delete()
|
||||
response = JsonResponse({'success': True})
|
||||
response['Content-Security-Policy'] = "default-src 'self'"
|
||||
response['X-Content-Type-Options'] = 'nosniff'
|
||||
return response
|
||||
except Exception as e:
|
||||
response = JsonResponse({'error': 'Serverfehler'}, status=500)
|
||||
response['Content-Security-Policy'] = "default-src 'self'"
|
||||
response['X-Content-Type-Options'] = 'nosniff'
|
||||
return response
|
||||
|
||||
|
||||
@login_required
|
||||
def user_comments(request):
|
||||
"""
|
||||
Display all comments made by the logged-in user, grouped by document.
|
||||
"""
|
||||
# Get all comments by the current user
|
||||
user_comments = VorgabeComment.objects.filter(
|
||||
user=request.user
|
||||
).select_related('vorgabe', 'vorgabe__dokument').order_by(
|
||||
'vorgabe__dokument__nummer', '-created_at'
|
||||
)
|
||||
|
||||
# Group comments by document
|
||||
comments_by_document = {}
|
||||
for comment in user_comments:
|
||||
dokument = comment.vorgabe.dokument
|
||||
if dokument not in comments_by_document:
|
||||
comments_by_document[dokument] = []
|
||||
comments_by_document[dokument].append(comment)
|
||||
|
||||
return render(request, 'standards/user_comments.html', {
|
||||
'comments_by_document': comments_by_document,
|
||||
'total_comments': user_comments.count(),
|
||||
})
|
||||
|
||||
|
||||
@login_required
|
||||
@user_passes_test(is_staff_user)
|
||||
def all_comments(request):
|
||||
"""
|
||||
Display all comments from all users, grouped by document.
|
||||
Staff only.
|
||||
"""
|
||||
# Get all comments
|
||||
all_comments_qs = VorgabeComment.objects.select_related(
|
||||
'vorgabe', 'vorgabe__dokument', 'user'
|
||||
).order_by(
|
||||
'vorgabe__dokument__nummer', '-created_at'
|
||||
)
|
||||
|
||||
# Group comments by document
|
||||
comments_by_document = {}
|
||||
for comment in all_comments_qs:
|
||||
dokument = comment.vorgabe.dokument
|
||||
if dokument not in comments_by_document:
|
||||
comments_by_document[dokument] = []
|
||||
comments_by_document[dokument].append(comment)
|
||||
|
||||
return render(request, 'standards/all_comments.html', {
|
||||
'comments_by_document': comments_by_document,
|
||||
'total_comments': all_comments_qs.count(),
|
||||
})
|
||||
@@ -24,8 +24,8 @@ spec:
|
||||
- name: data
|
||||
mountPath: /data
|
||||
containers:
|
||||
- name: web
|
||||
image: docker.io/adebaumann/vui:0.917
|
||||
- name: web
|
||||
image: docker.io/adebaumann/vui:0.918
|
||||
imagePullPolicy: Always
|
||||
ports:
|
||||
- containerPort: 8000
|
||||
|
||||
@@ -4,7 +4,7 @@ metadata:
|
||||
name: django
|
||||
namespace: vorgabenui
|
||||
annotations:
|
||||
nginx.ingress.kubernetes.io/rewrite-target: /
|
||||
traefik.ingress.kubernetes.io/router.middlewares: "vorgabenui-vorgabenui-rewrite@kubernetescrd"
|
||||
spec:
|
||||
rules:
|
||||
- host: vorgabenui.adebaumann.com
|
||||
|
||||
15
k8s/nfs-pv.yaml
Normal file
15
k8s/nfs-pv.yaml
Normal file
@@ -0,0 +1,15 @@
|
||||
apiVersion: v1
|
||||
kind: PersistentVolume
|
||||
metadata:
|
||||
name: django-data-pv
|
||||
namespace: vorgabenui
|
||||
spec:
|
||||
capacity:
|
||||
storage: 2Gi
|
||||
accessModes:
|
||||
- ReadWriteMany
|
||||
persistentVolumeReclaimPolicy: Retain
|
||||
storageClassName: nfs
|
||||
nfs:
|
||||
server: 192.168.17.199
|
||||
path: /mnt/user/vorgabenui
|
||||
8
k8s/nfs-storageclass.yaml
Normal file
8
k8s/nfs-storageclass.yaml
Normal file
@@ -0,0 +1,8 @@
|
||||
apiVersion: storage.k8s.io/v1
|
||||
kind: StorageClass
|
||||
metadata:
|
||||
name: nfs
|
||||
provisioner: kubernetes.io/no-provisioner
|
||||
allowVolumeExpansion: true
|
||||
reclaimPolicy: Retain
|
||||
volumeBindingMode: Immediate
|
||||
@@ -5,7 +5,8 @@ metadata:
|
||||
namespace: vorgabenui
|
||||
spec:
|
||||
accessModes:
|
||||
- ReadWriteOnce
|
||||
- ReadWriteMany
|
||||
storageClassName: nfs
|
||||
resources:
|
||||
requests:
|
||||
storage: 2Gi
|
||||
|
||||
9
k8s/traefik-middleware.yaml
Normal file
9
k8s/traefik-middleware.yaml
Normal file
@@ -0,0 +1,9 @@
|
||||
apiVersion: traefik.containo.us/v1alpha1
|
||||
kind: Middleware
|
||||
metadata:
|
||||
name: vorgabenui-rewrite
|
||||
namespace: vorgabenui
|
||||
spec:
|
||||
stripPrefix:
|
||||
prefixes:
|
||||
- "/"
|
||||
5
openspec/changes/archive/2025-11-24-add-login/tasks.md
Normal file
5
openspec/changes/archive/2025-11-24-add-login/tasks.md
Normal file
@@ -0,0 +1,5 @@
|
||||
## 1. Add user login functionality
|
||||
- [x] add a login screen for users
|
||||
- [x] add an icon for logged in user on the top right corner of all page
|
||||
- [x] add a menu to log out and change password on the user icon
|
||||
- [x] all functions should go back to the main page, not the django admin page
|
||||
63
openspec/project.md
Normal file
63
openspec/project.md
Normal file
@@ -0,0 +1,63 @@
|
||||
# Project Context
|
||||
|
||||
## Purpose
|
||||
This is a Django-based document management system for regulatory documents (Dokumente) and their provisions (Vorgaben). It manages validity periods, conflicts between overlapping provisions, references, keywords, and roles. The system supports importing documents, checking for compliance, and maintaining changelogs.
|
||||
|
||||
## Tech Stack
|
||||
- Python 3.x
|
||||
- Django 5.2.5
|
||||
- SQLite (development), PostgreSQL (production)
|
||||
- Django MPTT for tree structures
|
||||
- Django Nested Admin for inline editing
|
||||
- Kubernetes for deployment
|
||||
- ArgoCD for continuous deployment
|
||||
- Traefik for ingress
|
||||
- Gunicorn for WSGI server
|
||||
|
||||
## Project Conventions
|
||||
|
||||
### Code Style
|
||||
- Language: German for user-facing strings and model names, English for code comments and internal naming
|
||||
- Imports: Standard library first, then Django, then third-party, then local apps
|
||||
- Model naming: German nouns (Dokument, Vorgabe, Person)
|
||||
- Field naming: German for field names, English Django conventions
|
||||
- Class naming: PascalCase for models, snake_case for functions/variables
|
||||
- All models have __str__ methods returning meaningful German strings
|
||||
- Use verbose_name and verbose_name_plural in Meta classes (German)
|
||||
|
||||
### Architecture Patterns
|
||||
- Django apps: abschnitte, dokumente, referenzen, rollen, stichworte, pages
|
||||
- MPTT for hierarchical text sections
|
||||
- Foreign keys with on_delete=models.PROTECT for important relationships
|
||||
- Many-to-many with descriptive related_name
|
||||
- Proxy models for different views (e.g., VorgabenTable)
|
||||
- Management commands for data operations
|
||||
|
||||
### Testing Strategy
|
||||
- Django test framework
|
||||
- Test class names in English, methods in English
|
||||
- Comprehensive model tests
|
||||
- Test both success and error cases
|
||||
- Run with `python manage.py test`
|
||||
|
||||
### Git Workflow
|
||||
- Standard Git workflow
|
||||
- Commits in English
|
||||
- Use Gitea workflows for CI/CD
|
||||
|
||||
## Domain Context
|
||||
The system manages regulatory documents with numbered provisions that have validity dates. Provisions can conflict if they have overlapping date ranges for the same document, theme, and number. The system includes sanity checks for conflicts, diagram caching for visualization, and JSON export functionality.
|
||||
|
||||
## Important Constraints
|
||||
- German language for all user interfaces and data
|
||||
- Strict validation of date ranges to prevent overlapping provisions
|
||||
- Documents have types, authors, reviewers, and validity periods
|
||||
- Provisions linked to themes, references, keywords, and relevant roles
|
||||
- Active/inactive status for documents
|
||||
|
||||
## External Dependencies
|
||||
- Django ecosystem: MPTT, nested-admin, revproxy
|
||||
- Kubernetes cluster for deployment
|
||||
- ArgoCD for GitOps
|
||||
- Traefik for load balancing
|
||||
- External diagram services (diagramm_proxy)
|
||||
@@ -1,33 +1,236 @@
|
||||
|
||||
{% load static %}
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<html lang="de-CH" class="no-js no-ie" itemscope itemtype="http://schema.org/WebPage">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>{% block title %}{% endblock %}</title>
|
||||
<link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet">
|
||||
{% load static %}
|
||||
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
|
||||
<title>{% block title %}Vorgaben Informatiksicherheit{% endblock %} - Schweizerische Eidgenossenschaft</title>
|
||||
|
||||
<!-- Swiss Design System CSS -->
|
||||
<link rel="stylesheet" href="{% static 'swiss/css/vendors.css' %}">
|
||||
<link rel="stylesheet" href="{% static 'swiss/css/admin.css' %}">
|
||||
<link rel="stylesheet" href="{% static 'swiss/css/print.css' %}" media="print">
|
||||
|
||||
<!-- Custom CSS -->
|
||||
<link rel="stylesheet" href="{% static 'custom/css/admin_extras.css' %}">
|
||||
|
||||
<!-- Favicons -->
|
||||
<link rel="shortcut icon" href="{% static 'swiss/img/ico/favicon.ico' %}">
|
||||
<link rel="apple-touch-icon" sizes="57x57" href="{% static 'swiss/img/ico/apple-touch-icon-57x57.png' %}">
|
||||
<link rel="apple-touch-icon" sizes="114x114" href="{% static 'swiss/img/ico/apple-touch-icon-114x114.png' %}">
|
||||
<link rel="icon" type="image/png" href="{% static 'swiss/img/ico/favicon-96x96.png' %}" sizes="96x96">
|
||||
<link rel="icon" type="image/png" href="{% static 'swiss/img/ico/favicon-32x32.png' %}" sizes="32x32">
|
||||
<meta name="msapplication-TileColor" content="#ffffff">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<nav class="navbar navbar-expand-lg navbar-light bg-light">
|
||||
<a class="navbar-brand" href="#">Vorgaben</a>
|
||||
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNavAltMarkup" aria-controls="navbarNavAltMarkup" aria-expanded="false" aria-label="Toggle navigation">
|
||||
<span class="navbar-toggler-icon"></span>
|
||||
</button>
|
||||
<div class="collapse navbar-collapse" id="navbarNavAltMarkup">
|
||||
<div class="navbar-nav">
|
||||
<a class="nav-item nav-link active" href="/standards">Standards</a>
|
||||
<a class="nav-item nav-link" href="/referenzen">Referenzen</a>
|
||||
<a class="nav-item nav-link" href="/stichworte">Stichworte</a>
|
||||
<a class="nav-item nav-link" href="/search">Suche</a>
|
||||
<!-- Accessibility skip links -->
|
||||
<ul class="access-keys">
|
||||
<li><a href="/" accesskey="0">Startseite</a></li>
|
||||
<li><a href="#main-navigation" accesskey="1">Hauptnavigation</a></li>
|
||||
<li><a href="#content" accesskey="2">Inhalt</a></li>
|
||||
</ul>
|
||||
|
||||
<!-- Header with Swiss Logo -->
|
||||
<header>
|
||||
<a href="/" class="brand hidden-xs" title="Zur Startseite">
|
||||
<img src="{% static 'swiss/img/logo-CH.svg' %}"
|
||||
onerror="this.onerror=null; this.src='{% static 'swiss/img/logo-CH.png' %}'"
|
||||
alt="Zur Startseite" />
|
||||
<h1>Vorgaben Informatiksicherheit BIT</h1>
|
||||
</a>
|
||||
|
||||
<!-- User Menu -->
|
||||
{% if user.is_authenticated %}
|
||||
<div class="user-menu" style="position: absolute; top: 20px; right: 20px; z-index: 1000;">
|
||||
<div class="dropdown">
|
||||
<a href="#" class="dropdown-toggle" data-toggle="dropdown" style="text-decoration: none; color: #000; display: flex; align-items: center;">
|
||||
<span style="font-size: 24px; margin-right: 8px;">👤</span>
|
||||
<span class="hidden-xs" style="margin-left: 0;">{{ user.first_name }} {{ user.last_name }}</span>
|
||||
<span class="caret" style="margin-left: 8px;"></span>
|
||||
</a>
|
||||
<ul class="dropdown-menu dropdown-menu-right" role="menu">
|
||||
<li><a href="{% url 'user_comments' %}">Meine Kommentare</a></li>
|
||||
{% if user.is_staff %}
|
||||
<li><a href="{% url 'all_comments' %}">Alle Kommentare</a></li>
|
||||
{% endif %}
|
||||
<li><a href="{% url 'password_change' %}">Passwort ändern</a></li>
|
||||
<li class="divider"></li>
|
||||
<li>
|
||||
<form method="post" action="{% url 'logout' %}" style="display: inline;">
|
||||
{% csrf_token %}
|
||||
<button type="submit" style="background: none; border: none; color: inherit; padding: 3px 20px; width: 100%; text-align: left; cursor: pointer;">
|
||||
Abmelden
|
||||
</button>
|
||||
</form>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
{% else %}
|
||||
<div class="user-menu" style="position: absolute; top: 20px; right: 20px; z-index: 1000;">
|
||||
<a href="{% url 'login' %}" class="btn btn-sm btn-primary" style="text-decoration: none;">
|
||||
Anmelden
|
||||
</a>
|
||||
</div>
|
||||
{% endif %}
|
||||
</header>
|
||||
|
||||
<!-- Main Navigation -->
|
||||
<nav class="nav-main yamm navbar" id="main-navigation">
|
||||
<h2 class="sr-only">Navigation</h2>
|
||||
|
||||
<!-- Mobile Navigation -->
|
||||
<section class="nav-mobile">
|
||||
<div class="table-row">
|
||||
<div class="nav-mobile-header">
|
||||
<div class="table-row">
|
||||
<span class="nav-mobile-logo">
|
||||
<img src="{% static 'swiss/img/swiss.svg' %}"
|
||||
onerror="this.onerror=null; this.src='{% static 'swiss/img/swiss.png' %}'"
|
||||
alt="Schweizerische Eidgenossenschaft" />
|
||||
</span>
|
||||
<h1><a href="/">Vorgaben Informatiksicherheit</a></h1>
|
||||
</div>
|
||||
</div>
|
||||
<div class="table-cell dropdown">
|
||||
<a href="#" class="nav-mobile-menu dropdown-toggle" data-toggle="dropdown">
|
||||
<span class="icon icon--menu"></span>
|
||||
</a>
|
||||
<div class="drilldown dropdown-menu" role="menu">
|
||||
<div class="drilldown-container">
|
||||
<nav class="nav-page-list">
|
||||
<ul>
|
||||
<li><a href="/dokumente">Standards</a></li>
|
||||
{% if user.is_staff %}
|
||||
<li><a href="/dokumente/unvollstaendig/">Unvollständig</a></li>
|
||||
<li><a href="/autorenumgebung/">Autor</a></li>
|
||||
{% endif %}
|
||||
<li><a href="/referenzen">Referenzen</a></li>
|
||||
<li><a href="/stichworte">Stichworte</a></li>
|
||||
<li><a href="/search">Suche</a></li>
|
||||
</ul>
|
||||
<a href="#" class="yamm-close-bottom">
|
||||
<span class="icon icon--top" aria-hidden="true"></span>
|
||||
</a>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="table-cell dropdown">
|
||||
<a href="/search" class="nav-mobile-menu">
|
||||
<span class="icon icon--search"></span>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Desktop Tab Navigation -->
|
||||
<ul class="nav navbar-nav">
|
||||
<li class="dropdown {% if request.resolver_match.url_name == 'standard_list' or 'standard' in request.resolver_match.url_name %}current{% endif %}">
|
||||
<a href="/dokumente">Standards</a>
|
||||
</li>
|
||||
{% if user.is_staff %}
|
||||
<li class="dropdown {% if 'unvollstaendig' in request.path %}current{% endif %}">
|
||||
<a href="/dokumente/unvollstaendig/">Unvollständig</a>
|
||||
</li>
|
||||
<li class="dropdown {% if 'autorenumgebung' in request.path %}current{% endif %}">
|
||||
<a href="/autorenumgebung/">Autor</a>
|
||||
</li>
|
||||
{% endif %}
|
||||
<li class="dropdown {% if 'referenzen' in request.path %}current{% endif %}">
|
||||
<a href="/referenzen">Referenzen</a>
|
||||
</li>
|
||||
<li class="dropdown {% if 'stichworte' in request.path %}current{% endif %}">
|
||||
<a href="/stichworte">Stichworte</a>
|
||||
</li>
|
||||
<li class="dropdown {% if 'search' in request.path %}current{% endif %}">
|
||||
<a href="/search">Suche</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
<!-- Main Content -->
|
||||
<div class="container container-main" id="content" style="padding: 2rem 3rem;">
|
||||
{% if messages %}
|
||||
<div class="row">
|
||||
<div class="col-md-12">
|
||||
{% for message in messages %}
|
||||
<div class="alert alert-{{ message.tags }} alert-dismissible fade show" role="alert">
|
||||
{{ message }}
|
||||
<button type="button" class="close" data-dismiss="alert" aria-label="Schliessen">
|
||||
<span aria-hidden="true">×</span>
|
||||
</button>
|
||||
</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<div class="row">
|
||||
{% block sidebar_left %}
|
||||
{% if block.super or sidebar_left_content %}
|
||||
<div class="col-md-3">
|
||||
<nav class="nav-page-list" aria-label="Seitennavigation">
|
||||
{{ block.super }}
|
||||
</nav>
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
|
||||
<div class="{% if sidebar_left_content or block.super %}col-md-{% if sidebar_right_content %}6{% else %}9{% endif %}{% else %}col-md-{% if sidebar_right_content %}9{% else %}12{% endif %}{% endif %}">
|
||||
{% block content %}
|
||||
<h2>Inhalt</h2>
|
||||
<p>Hauptinhalt der Seite</p>
|
||||
{% endblock %}
|
||||
</div>
|
||||
|
||||
{% block sidebar_right %}
|
||||
{% if block.super or sidebar_right_content %}
|
||||
<div class="col-md-3">
|
||||
<aside>
|
||||
{{ block.super }}
|
||||
</aside>
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
<div class="d-flex">
|
||||
<div class="col-md-2">{% block sidebar_left %}{% endblock %}</div>
|
||||
<div class="flex-fill">{% block content %}Main Content{% endblock %}</div>
|
||||
<div class="col-md-2">{% block sidebar_right %}{% endblock %}</div>
|
||||
</div>
|
||||
<div>VorgabenUI v0.930</div>
|
||||
|
||||
<!-- Footer -->
|
||||
<footer>
|
||||
<div class="container-fluid footer-service">
|
||||
<div class="row">
|
||||
<div class="col-sm-12">
|
||||
<h2 class="sr-only">Fussbereich</h2>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="container-fluid footer-address">
|
||||
<div class="row">
|
||||
<div class="col-sm-6">
|
||||
<h3>Vorgaben Informatiksicherheit</h3>
|
||||
<p>
|
||||
Bundesamt für Informatik und Telekommunikation BIT<br>
|
||||
<a href="https://www.bit.admin.ch" target="_blank" rel="noopener">www.bit.admin.ch</a>
|
||||
</p>
|
||||
</div>
|
||||
<div class="col-sm-6 text-right">
|
||||
<p class="text-muted">Version {{ version|default:"0.968" }}</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
<!-- Swiss Design System Scripts -->
|
||||
<script src="{% static 'swiss/js/vendors.min.js' %}"></script>
|
||||
<script src="{% static 'swiss/js/main.min.js' %}"></script>
|
||||
|
||||
<!-- Custom Scripts -->
|
||||
{% block extra_js %}{% endblock %}
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
43
pages/templates/registration/login.html
Normal file
43
pages/templates/registration/login.html
Normal file
@@ -0,0 +1,43 @@
|
||||
{% extends "base.html" %}
|
||||
{% load static %}
|
||||
|
||||
{% block title %}Anmelden{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<div class="row">
|
||||
<div class="col-md-4 col-md-offset-4">
|
||||
<div class="panel panel-default">
|
||||
<div class="panel-heading">
|
||||
<h3 class="panel-title">Anmelden</h3>
|
||||
</div>
|
||||
<div class="panel-body">
|
||||
<form method="post">
|
||||
{% csrf_token %}
|
||||
|
||||
{% if form.errors %}
|
||||
<div class="alert alert-danger">
|
||||
<p>Ihr Benutzername und Passwort stimmen nicht überein. Bitte versuchen Sie es erneut.</p>
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<div class="form-group">
|
||||
<label for="id_username">Benutzername:</label>
|
||||
<input type="text" name="username" class="form-control" id="id_username" required autofocus>
|
||||
</div>
|
||||
|
||||
<div class="form-group">
|
||||
<label for="id_password">Passwort:</label>
|
||||
<input type="password" name="password" class="form-control" id="id_password" required>
|
||||
</div>
|
||||
|
||||
<div class="form-group">
|
||||
<button type="submit" class="btn btn-primary">Anmelden</button>
|
||||
</div>
|
||||
|
||||
<input type="hidden" name="next" value="{{ next }}">
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endblock %}
|
||||
56
pages/templates/registration/password_change.html
Normal file
56
pages/templates/registration/password_change.html
Normal file
@@ -0,0 +1,56 @@
|
||||
{% extends "base.html" %}
|
||||
{% load static %}
|
||||
|
||||
{% block title %}Passwort ändern{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<div class="row">
|
||||
<div class="col-md-6 col-md-offset-3">
|
||||
<div class="panel panel-default">
|
||||
<div class="panel-heading">
|
||||
<h3 class="panel-title">Passwort ändern</h3>
|
||||
</div>
|
||||
<div class="panel-body">
|
||||
<form method="post">
|
||||
{% csrf_token %}
|
||||
|
||||
{% if form.errors %}
|
||||
<div class="alert alert-danger">
|
||||
<p>Bitte korrigieren Sie die Fehler unten.</p>
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<div class="form-group">
|
||||
<label for="id_old_password">Aktuelles Passwort:</label>
|
||||
<input type="password" name="old_password" class="form-control" id="id_old_password" required>
|
||||
{% if form.old_password.errors %}
|
||||
<div class="text-danger">{{ form.old_password.errors }}</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
|
||||
<div class="form-group">
|
||||
<label for="id_new_password1">Neues Passwort:</label>
|
||||
<input type="password" name="new_password1" class="form-control" id="id_new_password1" required>
|
||||
{% if form.new_password1.errors %}
|
||||
<div class="text-danger">{{ form.new_password1.errors }}</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
|
||||
<div class="form-group">
|
||||
<label for="id_new_password2">Neues Passwort bestätigen:</label>
|
||||
<input type="password" name="new_password2" class="form-control" id="id_new_password2" required>
|
||||
{% if form.new_password2.errors %}
|
||||
<div class="text-danger">{{ form.new_password2.errors }}</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
|
||||
<div class="form-group">
|
||||
<button type="submit" class="btn btn-primary">Passwort ändern</button>
|
||||
<a href="/" class="btn btn-default">Abbrechen</a>
|
||||
</div>
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endblock %}
|
||||
24
pages/templates/registration/password_change_done.html
Normal file
24
pages/templates/registration/password_change_done.html
Normal file
@@ -0,0 +1,24 @@
|
||||
{% extends "base.html" %}
|
||||
{% load static %}
|
||||
|
||||
{% block title %}Passwort geändert{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<div class="row">
|
||||
<div class="col-md-6 col-md-offset-3">
|
||||
<div class="panel panel-default">
|
||||
<div class="panel-heading">
|
||||
<h3 class="panel-title">Passwort erfolgreich geändert</h3>
|
||||
</div>
|
||||
<div class="panel-body">
|
||||
<div class="alert alert-success">
|
||||
<p>Ihr Passwort wurde erfolgreich geändert.</p>
|
||||
</div>
|
||||
<p>
|
||||
<a href="/" class="btn btn-primary">Zurück zur Startseite</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endblock %}
|
||||
@@ -1,30 +1,80 @@
|
||||
{% extends "base.html" %}
|
||||
{% load page_extras %}
|
||||
|
||||
{% block title %}Suchergebnisse für "{{ suchbegriff }}" - Vorgaben Informatiksicherheit{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<h1 class="mb-4">Suchresultate für {{ suchbegriff }}</h1>
|
||||
{% if resultat.geltungsbereich %}
|
||||
<h2>Standards mit "{{suchbegriff}}" im Geltungsbereich</h2>
|
||||
{% for standard,geltungsbereich in resultat.geltungsbereich.items %}
|
||||
<h4>{{ standard }}</h4>
|
||||
{% for typ, html in geltungsbereich %}
|
||||
<div>{{ html|highlighttext:suchbegriff|safe }}</div>
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
<div class="container-fluid">
|
||||
<h1>Suchergebnisse für "{{ suchbegriff }}"</h1>
|
||||
|
||||
{% if resultat.all %}
|
||||
<h2>Vorgaben mit "{{ suchbegriff }}"</h2>
|
||||
{% for standard, vorgaben in resultat.all.items %}
|
||||
<h4>{{ standard }}</h4>
|
||||
<ul>
|
||||
<div class="row">
|
||||
<div class="col-md-12">
|
||||
<p class="text-muted">
|
||||
<a href="/search" class="icon icon--before icon--less">Neue Suche starten</a>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{% if resultat.geltungsbereich %}
|
||||
<div class="row">
|
||||
<div class="col-md-12">
|
||||
<h2>Standards mit "{{ suchbegriff }}" im Geltungsbereich</h2>
|
||||
|
||||
{% for standard, geltungsbereich in resultat.geltungsbereich.items %}
|
||||
<div class="card mb-3">
|
||||
<div class="card-header">
|
||||
<h3 class="h4 mb-0">{{ standard }}</h3>
|
||||
</div>
|
||||
<div class="card-body">
|
||||
{% for typ, html in geltungsbereich %}
|
||||
<div class="mb-2">{{ html|highlighttext:suchbegriff|safe }}</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
{% if resultat.all %}
|
||||
<div class="row">
|
||||
<div class="col-md-12">
|
||||
<h2>Vorgaben mit "{{ suchbegriff }}"</h2>
|
||||
|
||||
{% for standard, vorgaben in resultat.all.items %}
|
||||
<div class="card mb-3">
|
||||
<div class="card-header">
|
||||
<h3 class="h4 mb-0">{{ standard }}</h3>
|
||||
</div>
|
||||
<div class="card-body">
|
||||
<ul class="list-unstyled">
|
||||
{% for vorgabe in vorgaben %}
|
||||
<li><a href="{% url 'standard_detail' nummer=vorgabe.dokument.nummer %}#{{vorgabe.Vorgabennummer}}">{{vorgabe}}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
<li class="mb-2">
|
||||
<a href="{% url 'standard_detail' nummer=vorgabe.dokument.nummer %}#{{ vorgabe.Vorgabennummer }}"
|
||||
class="icon icon--before icon--external">
|
||||
{{ vorgabe }}
|
||||
</a>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
{% if not resultat.all %}
|
||||
<h2>Keine Resultate für "{{suchbegriff}}"</h2>
|
||||
{% endif %}
|
||||
{% if not resultat.all and not resultat.geltungsbereich %}
|
||||
<div class="row">
|
||||
<div class="col-md-12">
|
||||
<div class="alert alert-warning" role="alert">
|
||||
<span class="icon icon--warning" aria-hidden="true"></span>
|
||||
<strong>Keine Ergebnisse gefunden</strong>
|
||||
<p>Für den Suchbegriff "{{ suchbegriff }}" wurden keine Resultate gefunden.</p>
|
||||
<p>Versuchen Sie es mit einem anderen Suchbegriff oder verwenden Sie weniger spezifische Begriffe.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
{% endblock %}
|
||||
@@ -1,20 +1,60 @@
|
||||
{% extends "base.html" %}
|
||||
{% block content %}
|
||||
<h1 class="mb-4">Suche</h1>
|
||||
|
||||
<!-- Search form -->
|
||||
<form action="." method="post">
|
||||
{% csrf_token %}
|
||||
<!-- Search field -->
|
||||
<div class="mb-3">
|
||||
<label for="query" class="form-label">Suchbegriff</label>
|
||||
<input type="text"
|
||||
class="form-control"
|
||||
id="query"
|
||||
name="q"
|
||||
placeholder="Suchbegriff eingeben …"
|
||||
required>
|
||||
{% block title %}Suche - Vorgaben Informatiksicherheit{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<div class="container-fluid">
|
||||
<h1>Suche in den Vorgaben</h1>
|
||||
|
||||
{% if error_message %}
|
||||
<div class="alert alert-danger" role="alert">
|
||||
<span class="icon icon--error" aria-hidden="true"></span>
|
||||
<strong>Fehler:</strong> {{ error_message }}
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<div class="row">
|
||||
<div class="col-md-8">
|
||||
<!-- Search form -->
|
||||
<form action="." method="post" class="form-horizontal">
|
||||
{% csrf_token %}
|
||||
|
||||
<div class="form-group">
|
||||
<label for="query" class="control-label">Suchbegriff</label>
|
||||
<div class="input-group">
|
||||
<input type="text"
|
||||
class="form-control"
|
||||
id="query"
|
||||
name="q"
|
||||
placeholder="Suchbegriff eingeben …"
|
||||
value="{{ search_term|default:'' }}"
|
||||
required
|
||||
maxlength="200"
|
||||
aria-describedby="search-help">
|
||||
<span class="input-group-btn">
|
||||
<button type="submit" class="btn btn-primary">
|
||||
<span class="icon icon--search" aria-hidden="true"></span>
|
||||
Suchen
|
||||
</button>
|
||||
</span>
|
||||
</div>
|
||||
<small id="search-help" class="form-text text-muted">
|
||||
Durchsuchen Sie Standards, Vorgaben und Referenzen nach Stichworten.
|
||||
</small>
|
||||
</div>
|
||||
</form>
|
||||
</div>
|
||||
|
||||
<div class="col-md-4">
|
||||
<div class="alert alert-info" role="alert">
|
||||
<h3 class="h4">Suchtipps</h3>
|
||||
<ul>
|
||||
<li>Verwenden Sie spezifische Begriffe für bessere Ergebnisse</li>
|
||||
<li>Die Suche erfasst Titel, Beschreibungen und Inhalte</li>
|
||||
<li>Groß-/Kleinschreibung wird nicht berücksichtigt</li>
|
||||
</ul>
|
||||
</div>
|
||||
<button type="submit" class="btn btn-primary">Suchen</button>
|
||||
</form>
|
||||
{% endblock %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endblock %}
|
||||
|
||||
@@ -1,10 +1,77 @@
|
||||
{% extends "base.html" %}
|
||||
|
||||
{% block title %}Startseite - Vorgaben Informatiksicherheit{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<h1>Vorgaben Informatiksicherheit BIT</h1>
|
||||
<h2>Aktuell erfasste Standards</h2>
|
||||
<ul>
|
||||
{% for standard in standards %}
|
||||
<li><a href="{% url 'standard_detail' nummer=standard.nummer %}">{{ standard }}</a></li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
<div class="container-fluid">
|
||||
<h1>Vorgaben Informatiksicherheit BIT</h1>
|
||||
|
||||
<div class="row">
|
||||
<div class="col-md-12">
|
||||
<p class="lead">
|
||||
Willkommen bei den Vorgaben zur Informatiksicherheit des Bundesamts für Informatik und Telekommunikation (BIT).
|
||||
Diese Plattform bietet Ihnen Zugang zu allen aktuellen IT-Sicherheitsstandards der Bundesverwaltung.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="row">
|
||||
<div class="col-md-12">
|
||||
<h2>Aktuell erfasste Standards</h2>
|
||||
|
||||
<div class="list-group">
|
||||
{% for standard in dokumente %}
|
||||
<a href="{% url 'standard_detail' nummer=standard.nummer %}"
|
||||
class="list-group-item list-group-item-action">
|
||||
<div class="d-flex w-100 justify-content-between">
|
||||
<h3 class="h5 mb-1">{{ standard.nummer }} - {{ standard.name }}</h3>
|
||||
{% if standard.status %}
|
||||
<small class="text-muted">{{ standard.status }}</small>
|
||||
{% endif %}
|
||||
</div>
|
||||
{% if standard.kurzbeschreibung %}
|
||||
<p class="mb-1">{{ standard.kurzbeschreibung|truncatewords:30 }}</p>
|
||||
{% endif %}
|
||||
</a>
|
||||
{% empty %}
|
||||
<div class="alert alert-info" role="alert">
|
||||
<p class="icon icon--info">Aktuell sind keine Standards erfasst.</p>
|
||||
</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="row mt-4">
|
||||
<div class="col-md-4">
|
||||
<div class="card">
|
||||
<div class="card-body">
|
||||
<h3 class="card-title h4">Standards durchsuchen</h3>
|
||||
<p class="card-text">Durchsuchen Sie alle Vorgaben nach Stichworten und Inhalten.</p>
|
||||
<a href="/search" class="btn btn-primary">Zur Suche</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="col-md-4">
|
||||
<div class="card">
|
||||
<div class="card-body">
|
||||
<h3 class="card-title h4">Referenzen</h3>
|
||||
<p class="card-text">Übersicht über externe Referenzen und Normen.</p>
|
||||
<a href="/referenzen" class="btn btn-secondary">Referenzen anzeigen</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="col-md-4">
|
||||
<div class="card">
|
||||
<div class="card-body">
|
||||
<h3 class="card-title h4">Stichworte</h3>
|
||||
<p class="card-text">Alphabetische Übersicht aller Schlagworte und Kategorien.</p>
|
||||
<a href="/stichworte" class="btn btn-secondary">Stichworte durchsuchen</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endblock %}
|
||||
|
||||
266
pages/test_auth.py
Normal file
266
pages/test_auth.py
Normal file
@@ -0,0 +1,266 @@
|
||||
from django.test import TestCase, Client
|
||||
from django.contrib.auth.models import User
|
||||
from django.urls import reverse
|
||||
from django.core.exceptions import ValidationError
|
||||
|
||||
|
||||
class AuthenticationTest(TestCase):
|
||||
"""Test login, logout, and password change functionality"""
|
||||
|
||||
def setUp(self):
|
||||
self.client = Client()
|
||||
self.test_user = User.objects.create_user(
|
||||
username='testuser',
|
||||
password='testpass123',
|
||||
email='test@example.com'
|
||||
)
|
||||
self.staff_user = User.objects.create_user(
|
||||
username='staffuser',
|
||||
password='staffpass123',
|
||||
email='staff@example.com'
|
||||
)
|
||||
self.staff_user.is_staff = True
|
||||
self.staff_user.save()
|
||||
|
||||
def test_login_page_loads(self):
|
||||
"""Test that login page loads correctly"""
|
||||
response = self.client.get(reverse('login'))
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Anmelden')
|
||||
self.assertContains(response, 'Benutzername:')
|
||||
self.assertContains(response, 'Passwort:')
|
||||
|
||||
def test_login_valid_credentials(self):
|
||||
"""Test successful login with valid credentials"""
|
||||
response = self.client.post(reverse('login'), {
|
||||
'username': 'testuser',
|
||||
'password': 'testpass123'
|
||||
})
|
||||
self.assertEqual(response.status_code, 302) # Redirect after login
|
||||
self.assertRedirects(response, '/') # Should redirect to main page
|
||||
|
||||
# Check user is logged in
|
||||
response = self.client.get('/')
|
||||
self.assertContains(response, 'testuser') # Username should appear in header
|
||||
|
||||
def test_login_invalid_credentials(self):
|
||||
"""Test login with invalid credentials shows error"""
|
||||
response = self.client.post(reverse('login'), {
|
||||
'username': 'testuser',
|
||||
'password': 'wrongpassword'
|
||||
})
|
||||
self.assertEqual(response.status_code, 200) # Stay on login page
|
||||
self.assertContains(response, 'Ihr Benutzername und Passwort stimmen nicht überein')
|
||||
|
||||
def test_login_empty_credentials(self):
|
||||
"""Test login with empty credentials"""
|
||||
response = self.client.post(reverse('login'), {
|
||||
'username': '',
|
||||
'password': ''
|
||||
})
|
||||
self.assertEqual(response.status_code, 200) # Stay on login page
|
||||
# Django's form validation should handle this
|
||||
|
||||
def test_logout_functionality(self):
|
||||
"""Test logout functionality"""
|
||||
# First login
|
||||
self.client.login(username='testuser', password='testpass123')
|
||||
|
||||
# Verify user is logged in
|
||||
response = self.client.get('/')
|
||||
self.assertContains(response, 'testuser')
|
||||
|
||||
# Logout using POST
|
||||
response = self.client.post(reverse('logout'))
|
||||
self.assertEqual(response.status_code, 302) # Redirect after logout
|
||||
self.assertRedirects(response, '/') # Should redirect to main page
|
||||
|
||||
# Verify user is logged out
|
||||
response = self.client.get('/')
|
||||
self.assertNotContains(response, 'testuser')
|
||||
self.assertContains(response, 'Anmelden') # Should show login link
|
||||
|
||||
def test_logout_requires_post(self):
|
||||
"""Test that logout requires POST method"""
|
||||
# Login first
|
||||
self.client.login(username='testuser', password='testpass123')
|
||||
|
||||
# Try GET logout (should fail with 405)
|
||||
response = self.client.get(reverse('logout'))
|
||||
self.assertEqual(response.status_code, 405) # Method Not Allowed
|
||||
|
||||
# User should still be logged in
|
||||
response = self.client.get('/')
|
||||
self.assertContains(response, 'testuser')
|
||||
|
||||
def test_password_change_page_loads(self):
|
||||
"""Test that password change page loads for authenticated users"""
|
||||
self.client.login(username='testuser', password='testpass123')
|
||||
|
||||
response = self.client.get(reverse('password_change'))
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Passwort ändern')
|
||||
self.assertContains(response, 'Aktuelles Passwort:')
|
||||
self.assertContains(response, 'Neues Passwort:')
|
||||
self.assertContains(response, 'Neues Passwort bestätigen:')
|
||||
|
||||
def test_password_change_requires_authentication(self):
|
||||
"""Test that password change page requires authentication"""
|
||||
response = self.client.get(reverse('password_change'))
|
||||
self.assertEqual(response.status_code, 302) # Redirect to login
|
||||
|
||||
# Should redirect to login page
|
||||
self.assertIn(reverse('login'), response.url)
|
||||
|
||||
def test_password_change_valid(self):
|
||||
"""Test successful password change"""
|
||||
self.client.login(username='testuser', password='testpass123')
|
||||
|
||||
response = self.client.post(reverse('password_change'), {
|
||||
'old_password': 'testpass123',
|
||||
'new_password1': 'newpass456',
|
||||
'new_password2': 'newpass456'
|
||||
})
|
||||
self.assertEqual(response.status_code, 302) # Redirect after success
|
||||
self.assertRedirects(response, '/') # Should redirect to main page
|
||||
|
||||
# Verify new password works
|
||||
self.client.logout()
|
||||
response = self.client.post(reverse('login'), {
|
||||
'username': 'testuser',
|
||||
'password': 'newpass456'
|
||||
})
|
||||
self.assertEqual(response.status_code, 302) # Successful login
|
||||
|
||||
def test_password_change_wrong_old_password(self):
|
||||
"""Test password change with wrong old password"""
|
||||
self.client.login(username='testuser', password='testpass123')
|
||||
|
||||
response = self.client.post(reverse('password_change'), {
|
||||
'old_password': 'wrongpassword',
|
||||
'new_password1': 'newpass456',
|
||||
'new_password2': 'newpass456'
|
||||
})
|
||||
self.assertEqual(response.status_code, 200) # Stay on form page
|
||||
self.assertContains(response, 'Bitte korrigieren Sie die Fehler unten')
|
||||
|
||||
def test_password_change_mismatched_new_passwords(self):
|
||||
"""Test password change with mismatched new passwords"""
|
||||
self.client.login(username='testuser', password='testpass123')
|
||||
|
||||
response = self.client.post(reverse('password_change'), {
|
||||
'old_password': 'testpass123',
|
||||
'new_password1': 'newpass456',
|
||||
'new_password2': 'differentpass789'
|
||||
})
|
||||
self.assertEqual(response.status_code, 200) # Stay on form page
|
||||
self.assertContains(response, 'Bitte korrigieren Sie die Fehler unten')
|
||||
|
||||
def test_password_change_same_as_old_password(self):
|
||||
"""Test password change with same password as old"""
|
||||
self.client.login(username='testuser', password='testpass123')
|
||||
|
||||
response = self.client.post(reverse('password_change'), {
|
||||
'old_password': 'testpass123',
|
||||
'new_password1': 'testpass123',
|
||||
'new_password2': 'testpass123'
|
||||
})
|
||||
# Django's default validators don't prevent same password, so it should succeed
|
||||
self.assertEqual(response.status_code, 302) # Redirect after success
|
||||
self.assertRedirects(response, '/') # Should redirect to main page
|
||||
|
||||
def test_password_change_cancel_button(self):
|
||||
"""Test password change cancel button"""
|
||||
self.client.login(username='testuser', password='testpass123')
|
||||
|
||||
response = self.client.get(reverse('password_change'))
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Abbrechen')
|
||||
# The cancel button should link to main page
|
||||
self.assertContains(response, 'href="/"')
|
||||
|
||||
def test_user_menu_display_for_authenticated_user(self):
|
||||
"""Test that user menu displays correctly for authenticated users"""
|
||||
self.client.login(username='testuser', password='testpass123')
|
||||
|
||||
response = self.client.get('/')
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'testuser') # Username in menu
|
||||
self.assertContains(response, 'Passwort ändern') # Password change link
|
||||
self.assertContains(response, 'Abmelden') # Logout link
|
||||
self.assertNotContains(response, 'Anmelden') # Should not show login link
|
||||
|
||||
def test_login_link_display_for_anonymous_user(self):
|
||||
"""Test that login link displays for anonymous users"""
|
||||
response = self.client.get('/')
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Anmelden') # Should show login link
|
||||
self.assertNotContains(response, 'testuser') # Should not show username
|
||||
self.assertNotContains(response, 'Passwort ändern') # Should not show password change
|
||||
self.assertNotContains(response, 'Abmelden') # Should not show logout
|
||||
|
||||
def test_staff_user_menu(self):
|
||||
"""Test that staff users see appropriate menu"""
|
||||
self.client.login(username='staffuser', password='staffpass123')
|
||||
|
||||
response = self.client.get('/')
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'staffuser') # Username in menu
|
||||
self.assertContains(response, 'Passwort ändern') # Password change link
|
||||
self.assertContains(response, 'Abmelden') # Logout link
|
||||
|
||||
def test_login_redirect_to_main_page(self):
|
||||
"""Test that successful login redirects to main page"""
|
||||
response = self.client.post(reverse('login'), {
|
||||
'username': 'testuser',
|
||||
'password': 'testpass123'
|
||||
}, follow=True)
|
||||
self.assertEqual(response.status_code, 200)
|
||||
# Should end up on main page
|
||||
self.assertContains(response, 'Vorgaben Informatiksicherheit')
|
||||
|
||||
def test_logout_redirect_to_main_page(self):
|
||||
"""Test that logout redirects to main page"""
|
||||
self.client.login(username='testuser', password='testpass123')
|
||||
|
||||
response = self.client.post(reverse('logout'), follow=True)
|
||||
self.assertEqual(response.status_code, 200)
|
||||
# Should end up on main page
|
||||
self.assertContains(response, 'Vorgaben Informatiksicherheit')
|
||||
# Should show login link for anonymous users
|
||||
self.assertContains(response, 'Anmelden')
|
||||
|
||||
def test_password_change_redirect_to_main_page(self):
|
||||
"""Test that successful password change redirects to main page"""
|
||||
self.client.login(username='testuser', password='testpass123')
|
||||
|
||||
response = self.client.post(reverse('password_change'), {
|
||||
'old_password': 'testpass123',
|
||||
'new_password1': 'newpass456',
|
||||
'new_password2': 'newpass456'
|
||||
}, follow=True)
|
||||
self.assertEqual(response.status_code, 200)
|
||||
# Should end up on main page
|
||||
self.assertContains(response, 'Vorgaben Informatiksicherheit')
|
||||
|
||||
def test_csrf_token_present_in_forms(self):
|
||||
"""Test that CSRF tokens are present in authentication forms"""
|
||||
# Login form
|
||||
response = self.client.get(reverse('login'))
|
||||
self.assertContains(response, 'csrfmiddlewaretoken')
|
||||
|
||||
# Password change form
|
||||
self.client.login(username='testuser', password='testpass123')
|
||||
response = self.client.get(reverse('password_change'))
|
||||
self.assertContains(response, 'csrfmiddlewaretoken')
|
||||
|
||||
def test_login_with_next_parameter(self):
|
||||
"""Test login with next parameter for redirect"""
|
||||
response = self.client.post(reverse('login'), {
|
||||
'username': 'testuser',
|
||||
'password': 'testpass123',
|
||||
'next': '/dokumente/'
|
||||
})
|
||||
self.assertEqual(response.status_code, 302)
|
||||
# Should redirect to the specified next page
|
||||
self.assertRedirects(response, '/dokumente/')
|
||||
310
pages/tests.py
Normal file
310
pages/tests.py
Normal file
@@ -0,0 +1,310 @@
|
||||
from django.test import TestCase, Client
|
||||
from django.core.exceptions import ValidationError
|
||||
from django.utils import timezone
|
||||
from datetime import date, timedelta
|
||||
from dokumente.models import Dokument, Vorgabe, VorgabeKurztext, VorgabeLangtext, Geltungsbereich, Dokumententyp, Thema
|
||||
from stichworte.models import Stichwort
|
||||
import re
|
||||
|
||||
|
||||
class SearchViewTest(TestCase):
|
||||
def setUp(self):
|
||||
self.client = Client()
|
||||
|
||||
# Create test data
|
||||
self.dokumententyp = Dokumententyp.objects.create(
|
||||
name="Test Typ",
|
||||
verantwortliche_ve="Test VE"
|
||||
)
|
||||
|
||||
self.thema = Thema.objects.create(
|
||||
name="Test Thema",
|
||||
erklaerung="Test Erklärung"
|
||||
)
|
||||
|
||||
self.dokument = Dokument.objects.create(
|
||||
nummer="TEST-001",
|
||||
dokumententyp=self.dokumententyp,
|
||||
name="Test Dokument",
|
||||
gueltigkeit_von=date.today(),
|
||||
aktiv=True
|
||||
)
|
||||
|
||||
self.vorgabe = Vorgabe.objects.create(
|
||||
order=1,
|
||||
nummer=1,
|
||||
dokument=self.dokument,
|
||||
thema=self.thema,
|
||||
titel="Test Vorgabe Titel",
|
||||
gueltigkeit_von=date.today()
|
||||
)
|
||||
|
||||
# Create text content
|
||||
self.kurztext = VorgabeKurztext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
inhalt="Dies ist ein Test Kurztext mit Suchbegriff"
|
||||
)
|
||||
|
||||
self.langtext = VorgabeLangtext.objects.create(
|
||||
abschnitt=self.vorgabe,
|
||||
inhalt="Dies ist ein Test Langtext mit anderem Suchbegriff"
|
||||
)
|
||||
|
||||
self.geltungsbereich = Geltungsbereich.objects.create(
|
||||
geltungsbereich=self.dokument,
|
||||
inhalt="Test Geltungsbereich mit Suchbegriff"
|
||||
)
|
||||
|
||||
def test_search_get_request(self):
|
||||
"""Test GET request returns search form"""
|
||||
response = self.client.get('/search/')
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Suche')
|
||||
self.assertContains(response, 'Suchbegriff')
|
||||
|
||||
def test_search_post_valid_term(self):
|
||||
"""Test POST request with valid search term"""
|
||||
response = self.client.post('/search/', {'q': 'Test'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Suchergebnisse')
|
||||
|
||||
def test_search_case_insensitive(self):
|
||||
"""Test that search is case insensitive"""
|
||||
# Search for lowercase
|
||||
response = self.client.post('/search/', {'q': 'test'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Suchergebnisse für "test"')
|
||||
|
||||
# Search for uppercase
|
||||
response = self.client.post('/search/', {'q': 'TEST'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Suchergebnisse für "TEST"')
|
||||
|
||||
# Search for mixed case
|
||||
response = self.client.post('/search/', {'q': 'TeSt'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Suchergebnisse für "TeSt"')
|
||||
|
||||
def test_search_in_kurztext(self):
|
||||
"""Test search in Kurztext content"""
|
||||
response = self.client.post('/search/', {'q': 'Suchbegriff'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'TEST-001')
|
||||
|
||||
def test_search_in_langtext(self):
|
||||
"""Test search in Langtext content"""
|
||||
response = self.client.post('/search/', {'q': 'anderem'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'TEST-001')
|
||||
|
||||
def test_search_in_titel(self):
|
||||
"""Test search in Vorgabe title"""
|
||||
response = self.client.post('/search/', {'q': 'Titel'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'TEST-001')
|
||||
|
||||
def test_search_in_geltungsbereich(self):
|
||||
"""Test search in Geltungsbereich content"""
|
||||
response = self.client.post('/search/', {'q': 'Geltungsbereich'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Standards mit')
|
||||
|
||||
def test_search_no_results(self):
|
||||
"""Test search with no results"""
|
||||
response = self.client.post('/search/', {'q': 'NichtVorhanden'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Keine Ergebnisse gefunden')
|
||||
|
||||
def test_search_expired_vorgabe_not_included(self):
|
||||
"""Test that expired Vorgaben are not included in results"""
|
||||
# Create expired Vorgabe
|
||||
expired_vorgabe = Vorgabe.objects.create(
|
||||
order=2,
|
||||
nummer=2,
|
||||
dokument=self.dokument,
|
||||
thema=self.thema,
|
||||
titel="Abgelaufene Vorgabe",
|
||||
gueltigkeit_von=date.today() - timedelta(days=10),
|
||||
gueltigkeit_bis=date.today() - timedelta(days=1)
|
||||
)
|
||||
|
||||
VorgabeKurztext.objects.create(
|
||||
abschnitt=expired_vorgabe,
|
||||
inhalt="Abgelaufener Inhalt mit Test"
|
||||
)
|
||||
|
||||
response = self.client.post('/search/', {'q': 'Test'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
|
||||
# Should only find the active Vorgabe, not the expired one
|
||||
self.assertContains(response, 'Test Vorgabe Titel')
|
||||
# The expired vorgabe should not appear in results
|
||||
self.assertNotContains(response, 'Abgelaufene Vorgabe')
|
||||
|
||||
def test_search_empty_term_validation(self):
|
||||
"""Test validation for empty search term"""
|
||||
response = self.client.post('/search/', {'q': ''})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Fehler:')
|
||||
self.assertContains(response, 'Suchbegriff darf nicht leer sein')
|
||||
|
||||
def test_search_no_term_validation(self):
|
||||
"""Test validation when no search term is provided"""
|
||||
response = self.client.post('/search/', {})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Fehler:')
|
||||
self.assertContains(response, 'Suchbegriff darf nicht leer sein')
|
||||
|
||||
def test_search_html_tags_stripped(self):
|
||||
"""Test that HTML tags are stripped from search input"""
|
||||
response = self.client.post('/search/', {'q': '<script>alert("xss")</script>Test'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
# Should search for "alert("xss")Test" after HTML tag removal
|
||||
self.assertContains(response, 'Suchergebnisse für "alert')
|
||||
|
||||
def test_search_invalid_characters_validation(self):
|
||||
"""Test validation for invalid characters"""
|
||||
response = self.client.post('/search/', {'q': 'Test| DROP TABLE users'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Fehler:')
|
||||
self.assertContains(response, 'Ungültige Zeichen im Suchbegriff')
|
||||
|
||||
def test_search_too_long_validation(self):
|
||||
"""Test validation for overly long search terms"""
|
||||
long_term = 'a' * 201 # 201 characters, exceeds limit of 200
|
||||
response = self.client.post('/search/', {'q': long_term})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
self.assertContains(response, 'Fehler:')
|
||||
self.assertContains(response, 'Suchbegriff ist zu lang')
|
||||
|
||||
def test_search_max_length_allowed(self):
|
||||
"""Test that exactly 200 characters are allowed"""
|
||||
max_term = 'a' * 200 # Exactly 200 characters
|
||||
response = self.client.post('/search/', {'q': max_term})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
# Should not show validation error
|
||||
self.assertNotContains(response, 'Fehler:')
|
||||
|
||||
def test_search_german_umlauts_allowed(self):
|
||||
"""Test that German umlauts are allowed in search"""
|
||||
response = self.client.post('/search/', {'q': 'Test Müller äöü ÄÖÜ ß'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
# Should not show validation error
|
||||
self.assertNotContains(response, 'Fehler:')
|
||||
|
||||
def test_search_special_characters_allowed(self):
|
||||
"""Test that allowed special characters work"""
|
||||
response = self.client.post('/search/', {'q': 'Test-Test, Test: Test; Test! Test? (Test) [Test] {Test} "Test" \'Test\''})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
# Should not show validation error
|
||||
self.assertNotContains(response, 'Fehler:')
|
||||
|
||||
def test_search_input_preserved_on_error(self):
|
||||
"""Test that search input is preserved on validation errors"""
|
||||
response = self.client.post('/search/', {'q': '<script>Test</script>'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
# The input should be preserved (escaped) in the form
|
||||
# Since HTML tags are stripped, we expect "Test" to be searched
|
||||
self.assertContains(response, 'Suchergebnisse für "Test"')
|
||||
|
||||
def test_search_xss_prevention_in_results(self):
|
||||
"""Test that search terms are escaped in results to prevent XSS"""
|
||||
# Create content with potential XSS
|
||||
self.kurztext.inhalt = "Content with <script>alert('xss')</script> term"
|
||||
self.kurztext.save()
|
||||
|
||||
response = self.client.post('/search/', {'q': 'term'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
# The script tag should be escaped in the output
|
||||
# Note: This depends on how the template renders the content
|
||||
self.assertContains(response, 'Suchergebnisse für "term"')
|
||||
|
||||
def test_search_result_structure(self):
|
||||
"""Test that search results have expected structure"""
|
||||
response = self.client.post('/search/', {'q': 'Test'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
# Verify the results page is rendered with correct structure
|
||||
self.assertContains(response, 'Suchergebnisse für "Test"')
|
||||
|
||||
def test_search_multiple_documents(self):
|
||||
"""Test search across multiple documents"""
|
||||
# Create second document
|
||||
dokument2 = Dokument.objects.create(
|
||||
nummer="TEST-002",
|
||||
dokumententyp=self.dokumententyp,
|
||||
name="Zweites Test Dokument",
|
||||
gueltigkeit_von=date.today(),
|
||||
aktiv=True
|
||||
)
|
||||
|
||||
vorgabe2 = Vorgabe.objects.create(
|
||||
order=1,
|
||||
nummer=1,
|
||||
dokument=dokument2,
|
||||
thema=self.thema,
|
||||
titel="Zweite Test Vorgabe",
|
||||
gueltigkeit_von=date.today()
|
||||
)
|
||||
|
||||
VorgabeKurztext.objects.create(
|
||||
abschnitt=vorgabe2,
|
||||
inhalt="Zweiter Test Inhalt"
|
||||
)
|
||||
|
||||
response = self.client.post('/search/', {'q': 'Test'})
|
||||
self.assertEqual(response.status_code, 200)
|
||||
# Should find results from both documents
|
||||
self.assertContains(response, 'TEST-001')
|
||||
self.assertContains(response, 'TEST-002')
|
||||
|
||||
|
||||
class SearchValidationTest(TestCase):
|
||||
"""Test the validate_search_input function directly"""
|
||||
|
||||
def test_validate_search_input_valid(self):
|
||||
"""Test valid search input"""
|
||||
from pages.views import validate_search_input
|
||||
|
||||
result = validate_search_input("Test Suchbegriff")
|
||||
self.assertEqual(result, "Test Suchbegriff")
|
||||
|
||||
def test_validate_search_input_empty(self):
|
||||
"""Test empty search input"""
|
||||
from pages.views import validate_search_input
|
||||
|
||||
with self.assertRaises(ValidationError) as context:
|
||||
validate_search_input("")
|
||||
|
||||
self.assertIn("Suchbegriff darf nicht leer sein", str(context.exception))
|
||||
|
||||
def test_validate_search_input_html_stripped(self):
|
||||
"""Test that HTML tags are stripped"""
|
||||
from pages.views import validate_search_input
|
||||
|
||||
result = validate_search_input("<script>alert('xss')</script>Test")
|
||||
self.assertEqual(result, "alert('xss')Test")
|
||||
|
||||
def test_validate_search_input_invalid_chars(self):
|
||||
"""Test validation of invalid characters"""
|
||||
from pages.views import validate_search_input
|
||||
|
||||
with self.assertRaises(ValidationError) as context:
|
||||
validate_search_input("Test| DROP TABLE users")
|
||||
|
||||
self.assertIn("Ungültige Zeichen im Suchbegriff", str(context.exception))
|
||||
|
||||
def test_validate_search_input_too_long(self):
|
||||
"""Test length validation"""
|
||||
from pages.views import validate_search_input
|
||||
|
||||
with self.assertRaises(ValidationError) as context:
|
||||
validate_search_input("a" * 201)
|
||||
|
||||
self.assertIn("Suchbegriff ist zu lang", str(context.exception))
|
||||
|
||||
def test_validate_search_input_whitespace_stripped(self):
|
||||
"""Test that whitespace is stripped"""
|
||||
from pages.views import validate_search_input
|
||||
|
||||
result = validate_search_input(" Test Suchbegriff ")
|
||||
self.assertEqual(result, "Test Suchbegriff")
|
||||
@@ -1,31 +1,71 @@
|
||||
from django.shortcuts import render
|
||||
from django.core.exceptions import ValidationError
|
||||
from django.utils.html import escape
|
||||
import re
|
||||
from abschnitte.utils import render_textabschnitte
|
||||
from standards.models import Dokument, VorgabeLangtext, VorgabeKurztext, Geltungsbereich
|
||||
from dokumente.models import Dokument, VorgabeLangtext, VorgabeKurztext, Geltungsbereich, Vorgabe
|
||||
from itertools import groupby
|
||||
import datetime
|
||||
|
||||
|
||||
def startseite(request):
|
||||
standards=list(Dokument.objects.all())
|
||||
return render(request, 'startseite.html', {"standards":standards,})
|
||||
standards=list(Dokument.objects.filter(aktiv=True))
|
||||
return render(request, 'startseite.html', {"dokumente":standards,})
|
||||
|
||||
def validate_search_input(search_term):
|
||||
"""
|
||||
Validate search input to prevent SQL injection and XSS
|
||||
"""
|
||||
if not search_term:
|
||||
raise ValidationError("Suchbegriff darf nicht leer sein")
|
||||
|
||||
# Remove any HTML tags to prevent XSS
|
||||
search_term = re.sub(r'<[^>]*>', '', search_term)
|
||||
|
||||
# Allow only alphanumeric characters, spaces, and basic punctuation
|
||||
# This prevents SQL injection and other malicious input while allowing useful characters
|
||||
if not re.match(r'^[a-zA-Z0-9äöüÄÖÜß\s\-\.\,\:\;\!\?\(\)\[\]\{\}\"\']+$', search_term):
|
||||
raise ValidationError("Ungültige Zeichen im Suchbegriff")
|
||||
|
||||
# Limit length to prevent DoS attacks
|
||||
if len(search_term) > 200:
|
||||
raise ValidationError("Suchbegriff ist zu lang")
|
||||
|
||||
return search_term.strip()
|
||||
|
||||
def search(request):
|
||||
if request.method == "GET":
|
||||
return render(request, 'search.html')
|
||||
elif request.method == "POST":
|
||||
suchbegriff=request.POST.get("q")
|
||||
areas=request.POST.getlist("suchbereich[]")
|
||||
raw_search_term = request.POST.get("q", "")
|
||||
|
||||
try:
|
||||
suchbegriff = validate_search_input(raw_search_term)
|
||||
except ValidationError as e:
|
||||
return render(request, 'search.html', {
|
||||
'error_message': str(e),
|
||||
'search_term': escape(raw_search_term)
|
||||
})
|
||||
|
||||
# Escape the search term for display in templates
|
||||
safe_search_term = escape(suchbegriff)
|
||||
result= {"all": {}}
|
||||
qs = VorgabeKurztext.objects.filter(inhalt__contains=suchbegriff).exclude(abschnitt__gueltigkeit_bis__lt=datetime.date.today())
|
||||
qs = VorgabeKurztext.objects.filter(inhalt__icontains=suchbegriff).exclude(abschnitt__gueltigkeit_bis__lt=datetime.date.today())
|
||||
result["kurztext"] = {k: [o.abschnitt for o in g] for k, g in groupby(qs, key=lambda o: o.abschnitt.dokument)}
|
||||
qs = VorgabeLangtext.objects.filter(inhalt__contains=suchbegriff).exclude(abschnitt__gueltigkeit_bis__lt=datetime.date.today())
|
||||
qs = VorgabeLangtext.objects.filter(inhalt__icontains=suchbegriff).exclude(abschnitt__gueltigkeit_bis__lt=datetime.date.today())
|
||||
result['langtext']= {k: [o.abschnitt for o in g] for k, g in groupby(qs, key=lambda o: o.abschnitt.dokument)}
|
||||
result["geltungsbereich"]={}
|
||||
geltungsbereich=set(list([x.geltungsbereich for x in Geltungsbereich.objects.filter(inhalt__contains=suchbegriff)]))
|
||||
for s in geltungsbereich:
|
||||
result["geltungsbereich"][s]=render_textabschnitte(s.geltungsbereich_set.order_by("order"))
|
||||
qs = Vorgabe.objects.filter(titel__icontains=suchbegriff).exclude(gueltigkeit_bis__lt=datetime.date.today())
|
||||
result['titel']= {k: list(g) for k, g in groupby(qs, key=lambda o: o.dokument)}
|
||||
for r in result.keys():
|
||||
for s in result[r].keys():
|
||||
result["all"][s] = set(result[r][s])
|
||||
print (result)
|
||||
return render(request,"results.html",{"suchbegriff":suchbegriff,"resultat":result})
|
||||
if r == 'titel':
|
||||
result["all"][s] = set(result["all"].get(s, set()) | set(result[r][s]))
|
||||
else:
|
||||
result["all"][s] = set(result["all"].get(s, set()) | set(result[r][s]))
|
||||
result["geltungsbereich"]={}
|
||||
geltungsbereich=set(list([x.geltungsbereich for x in Geltungsbereich.objects.filter(inhalt__icontains=suchbegriff)]))
|
||||
for s in geltungsbereich:
|
||||
result["geltungsbereich"][s]=render_textabschnitte(s.geltungsbereich_set.order_by("order"))
|
||||
|
||||
return render(request,"results.html",{"suchbegriff":safe_search_term,"resultat":result})
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
from django.contrib import admin
|
||||
from django.utils.html import format_html
|
||||
from nested_admin import NestedStackedInline, NestedModelAdmin, NestedTabularInline
|
||||
from .models import *
|
||||
|
||||
@@ -11,6 +12,50 @@ class ReferenzerklaerungInline(NestedStackedInline):
|
||||
|
||||
@admin.register(Referenz)
|
||||
class ReferenzAdmin(NestedModelAdmin):
|
||||
list_display = ('Path', 'vorgaben_count')
|
||||
inlines=[ReferenzerklaerungInline]
|
||||
list_display =['Path']
|
||||
search_fields=("referenz",)
|
||||
search_fields=("name_nummer","Path")
|
||||
readonly_fields=("vorgaben_list",)
|
||||
fieldsets = (
|
||||
(None, {
|
||||
'fields': ('name_nummer','name_text','oberreferenz','url', 'vorgaben_list')
|
||||
}),
|
||||
)
|
||||
|
||||
def vorgaben_count(self, obj):
|
||||
"""Count the number of Vorgaben that have this Stichwort"""
|
||||
count = obj.vorgabe_set.count()
|
||||
return f"{count} Vorgabe{'n' if count != 1 else ''}"
|
||||
vorgaben_count.short_description = "Anzahl Vorgaben"
|
||||
|
||||
def vorgaben_list(self, obj):
|
||||
"""Display list of Vorgaben that use this Stichwort"""
|
||||
vorgaben = obj.vorgabe_set.order_by('dokument__nummer', 'nummer')
|
||||
vorgaben_list = list(vorgaben) # Evaluate queryset once
|
||||
count = len(vorgaben_list)
|
||||
if count == 0:
|
||||
return format_html("<em>Keine Vorgaben gefunden</em><p><strong>Gesamt: 0 Vorgaben</strong></p>")
|
||||
|
||||
html = "<div style='max-height: 300px; overflow-y: auto;'>"
|
||||
html += "<table style='width: 100%; border-collapse: collapse;'>"
|
||||
html += "<thead><tr style='background-color: #f5f5f5;'>"
|
||||
html += "<th style='padding: 8px; border: 1px solid #ddd; text-align: left;'>Vorgabe</th>"
|
||||
html += "<th style='padding: 8px; border: 1px solid #ddd; text-align: left;'>Titel</th>"
|
||||
html += "<th style='padding: 8px; border: 1px solid #ddd; text-align: left;'>Dokument</th>"
|
||||
html += "</tr></thead>"
|
||||
html += "<tbody>"
|
||||
|
||||
for vorgabe in vorgaben_list:
|
||||
html += "<tr>"
|
||||
html += f"<td style='padding: 6px; border: 1px solid #ddd;'>{vorgabe.Vorgabennummer()}</td>"
|
||||
html += f"<td style='padding: 6px; border: 1px solid #ddd;'>{vorgabe.titel}</td>"
|
||||
html += f"<td style='padding: 6px; border: 1px solid #ddd;'>{vorgabe.dokument.nummer} – {vorgabe.dokument.name}</td>"
|
||||
html += "</tr>"
|
||||
|
||||
html += "</tbody></table>"
|
||||
html += f"</div><p><strong>Gesamt: {count} Vorgabe{'n' if count != 1 else ''}</strong></p>"
|
||||
|
||||
return format_html(html)
|
||||
|
||||
vorgaben_list.short_description = "Zugeordnete Vorgaben"
|
||||
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
# Generated by Django 5.2.5 on 2025-11-27 22:02
|
||||
|
||||
from django.db import migrations
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('referenzen', '0002_alter_referenz_table_alter_referenzerklaerung_table'),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterModelOptions(
|
||||
name='referenzerklaerung',
|
||||
options={'verbose_name': 'Erklärung', 'verbose_name_plural': 'Erklärungen'},
|
||||
),
|
||||
]
|
||||
@@ -31,3 +31,4 @@ class Referenzerklaerung (Textabschnitt):
|
||||
|
||||
class Meta:
|
||||
verbose_name="Erklärung"
|
||||
verbose_name_plural="Erklärungen"
|
||||
|
||||
@@ -1,51 +1,92 @@
|
||||
{% extends "base.html" %}
|
||||
{% load mptt_tags %}
|
||||
|
||||
{% block title %}{{ referenz.Path }} - Referenzen{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<h1><a href="../{{ referenz.ParentID }}">⭡</a>{{ referenz.Path }}</h1>
|
||||
{% if referenz.erklaerung %}
|
||||
<div class="card mb-4">
|
||||
<div class="card-header d-flex justify-content-between align-items-center bg-secondary text-light">
|
||||
<h3 class="h5 m-0">Beschreibung</h3>
|
||||
{% if referenz.url %}
|
||||
<span class="badge bg-light text-black">
|
||||
<a href="{{ referenz.url }}">Link</a>
|
||||
</span>{% endif %}
|
||||
</div>
|
||||
<div class="container-fluid">
|
||||
<nav aria-label="breadcrumb">
|
||||
<ol class="breadcrumb">
|
||||
<li class="breadcrumb-item"><a href="/">Startseite</a></li>
|
||||
<li class="breadcrumb-item"><a href="/referenzen">Referenzen</a></li>
|
||||
{% if referenz.ParentID %}
|
||||
<li class="breadcrumb-item"><a href="../{{ referenz.ParentID }}">Übergeordnet</a></li>
|
||||
{% endif %}
|
||||
<li class="breadcrumb-item active" aria-current="page">{{ referenz.name_nummer }}</li>
|
||||
</ol>
|
||||
</nav>
|
||||
|
||||
<div class="card-body p-2">
|
||||
{% for typ, html in referenz.erklaerung %}
|
||||
{% if html %}<div>{{ html|safe }}</div>{% endif %}{% endfor %}
|
||||
<h1>{{ referenz.Path }}</h1>
|
||||
|
||||
{% if referenz.url %}
|
||||
<p>
|
||||
<a href="{{ referenz.url }}" class="btn btn-secondary icon icon--before icon--external" target="_blank" rel="noopener">
|
||||
Externe Referenz öffnen
|
||||
</a>
|
||||
</p>
|
||||
{% endif %}
|
||||
|
||||
{% if referenz.erklaerung %}
|
||||
<div class="row">
|
||||
<div class="col-md-12">
|
||||
<div class="card mb-4">
|
||||
<div class="card-header">
|
||||
<h2 class="h4 mb-0">Beschreibung</h2>
|
||||
</div>
|
||||
<div class="card-body">
|
||||
{% for typ, html in referenz.erklaerung %}
|
||||
{% if html %}
|
||||
<div class="mb-2">{{ html|safe }}</div>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
<div class="card mb-4">
|
||||
<div class="card-header d-flex justify-content-between align-items-center bg-secondary text-light">
|
||||
<h3 class="h5 m-0">Referenzierte Vorgaben</h3>
|
||||
</div>
|
||||
|
||||
<div class="card-body p-2">
|
||||
{% recursetree referenz.children %}
|
||||
{% if not node == referenz %}
|
||||
{#<a href="../{{node.id}}">#}
|
||||
{{ node.Path }}
|
||||
{#</a>#}
|
||||
{% else %}
|
||||
<div class="row">
|
||||
<div class="col-md-12">
|
||||
<div class="card mb-4">
|
||||
<div class="card-header">
|
||||
<h2 class="h4 mb-0">Referenzierte Vorgaben</h2>
|
||||
</div>
|
||||
<div class="card-body">
|
||||
<div class="referenz-tree">
|
||||
{% recursetree referenz.children %}
|
||||
<div class="mb-3">
|
||||
<strong>
|
||||
{% if not node == referenz %}
|
||||
<a href="../{{ node.id }}">{{ node.Path }}</a>
|
||||
{% else %}
|
||||
{{ node.Path }}
|
||||
{% endif %}
|
||||
<br>
|
||||
{% if node.referenziertvon %}
|
||||
<ul>
|
||||
{% endif %}
|
||||
</strong>
|
||||
|
||||
{% if node.referenziertvon %}
|
||||
<ul class="list-unstyled mt-2 ml-3">
|
||||
{% for ref in node.referenziertvon %}
|
||||
<li><a href="{% url 'standard_detail' nummer=ref.dokument.nummer %}#{{ref.Vorgabennummer}}">{{ref}}</a></li>
|
||||
<li class="mb-1">
|
||||
<a href="{% url 'standard_detail' nummer=ref.dokument.nummer %}#{{ ref.Vorgabennummer }}"
|
||||
class="icon icon--before icon--external">
|
||||
{{ ref }}
|
||||
</a>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
<br>
|
||||
{% endif %}
|
||||
{% if not node.is_leaf_node %}
|
||||
</ul>
|
||||
{% endif %}
|
||||
|
||||
{% if not node.is_leaf_node %}
|
||||
<div class="ml-4 mt-2">
|
||||
{{ children }}
|
||||
{% endif %}
|
||||
{% endrecursetree %}
|
||||
</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
{% endrecursetree %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endblock %}
|
||||
@@ -1,21 +1,39 @@
|
||||
{% extends "base.html" %}
|
||||
{% load mptt_tags %}
|
||||
|
||||
{% block title %}Referenzen - Vorgaben Informatiksicherheit{% endblock %}
|
||||
|
||||
{% block content %}
|
||||
<h1>Referenzen</h1>
|
||||
<div class="container-fluid">
|
||||
<h1>Referenzen</h1>
|
||||
<p class="lead">Hierarchische Übersicht externer Referenzen und Normen</p>
|
||||
|
||||
<div>
|
||||
{% load mptt_tags %}
|
||||
<ul class="tree">
|
||||
{% recursetree referenzen %}
|
||||
<li>
|
||||
<a href="{{node.id}}">{{ node.name_nummer }}{% if node.name_text %} ({{node.name_text}}){% endif %}</a>
|
||||
{% if not node.is_leaf_node %}
|
||||
<ul class="children">
|
||||
{{ children }}
|
||||
<div class="row">
|
||||
<div class="col-md-12">
|
||||
<div class="card">
|
||||
<div class="card-body">
|
||||
<nav aria-label="Referenzen-Hierarchie">
|
||||
<ul class="nav nav-page-list">
|
||||
{% recursetree referenzen %}
|
||||
<li>
|
||||
<a href="{{ node.id }}">
|
||||
<strong>{{ node.name_nummer }}</strong>
|
||||
{% if node.name_text %}
|
||||
<span class="text-muted"> - {{ node.name_text }}</span>
|
||||
{% endif %}
|
||||
</a>
|
||||
{% if not node.is_leaf_node %}
|
||||
<ul class="nav nav-page-list">
|
||||
{{ children }}
|
||||
</ul>
|
||||
{% endif %}
|
||||
</li>
|
||||
{% endrecursetree %}
|
||||
</ul>
|
||||
{% endif %}
|
||||
</li>
|
||||
{% endrecursetree %}
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endblock %}
|
||||
@@ -1,3 +1,398 @@
|
||||
from django.test import TestCase
|
||||
from django.core.exceptions import ValidationError
|
||||
from .models import Referenz, Referenzerklaerung
|
||||
from abschnitte.models import AbschnittTyp
|
||||
|
||||
# Create your tests here.
|
||||
|
||||
class ReferenzModelTest(TestCase):
|
||||
"""Test cases for Referenz model"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data"""
|
||||
self.referenz = Referenz.objects.create(
|
||||
name_nummer="ISO-27001",
|
||||
name_text="Information Security Management",
|
||||
url="https://www.iso.org/isoiec-27001-information-security.html"
|
||||
)
|
||||
|
||||
def test_referenz_creation(self):
|
||||
"""Test that Referenz is created correctly"""
|
||||
self.assertEqual(self.referenz.name_nummer, "ISO-27001")
|
||||
self.assertEqual(self.referenz.name_text, "Information Security Management")
|
||||
self.assertEqual(self.referenz.url, "https://www.iso.org/isoiec-27001-information-security.html")
|
||||
self.assertIsNone(self.referenz.oberreferenz)
|
||||
|
||||
def test_referenz_str(self):
|
||||
"""Test string representation of Referenz"""
|
||||
self.assertEqual(str(self.referenz), "ISO-27001")
|
||||
|
||||
def test_referenz_verbose_name_plural(self):
|
||||
"""Test verbose name plural"""
|
||||
self.assertEqual(
|
||||
Referenz._meta.verbose_name_plural,
|
||||
"Referenzen"
|
||||
)
|
||||
|
||||
def test_referenz_path_method(self):
|
||||
"""Test Path method for root reference"""
|
||||
path = self.referenz.Path()
|
||||
self.assertEqual(path, "ISO-27001 (Information Security Management)")
|
||||
|
||||
def test_referenz_path_without_name_text(self):
|
||||
"""Test Path method when name_text is empty"""
|
||||
referenz_no_text = Referenz.objects.create(
|
||||
name_nummer="NIST-800-53"
|
||||
)
|
||||
path = referenz_no_text.Path()
|
||||
self.assertEqual(path, "NIST-800-53")
|
||||
|
||||
def test_referenz_blank_fields(self):
|
||||
"""Test that optional fields can be blank"""
|
||||
referenz_minimal = Referenz.objects.create(
|
||||
name_nummer="TEST-001"
|
||||
)
|
||||
self.assertEqual(referenz_minimal.name_text, "")
|
||||
self.assertEqual(referenz_minimal.url, "")
|
||||
self.assertIsNone(referenz_minimal.oberreferenz)
|
||||
|
||||
def test_referenz_max_lengths(self):
|
||||
"""Test max_length constraints"""
|
||||
max_name_nummer = "a" * 100
|
||||
max_name_text = "b" * 255
|
||||
|
||||
referenz = Referenz.objects.create(
|
||||
name_nummer=max_name_nummer,
|
||||
name_text=max_name_text
|
||||
)
|
||||
|
||||
self.assertEqual(referenz.name_nummer, max_name_nummer)
|
||||
self.assertEqual(referenz.name_text, max_name_text)
|
||||
|
||||
def test_create_multiple_references(self):
|
||||
"""Test creating multiple Referenz objects"""
|
||||
references = [
|
||||
("ISO-9001", "Quality Management"),
|
||||
("ISO-14001", "Environmental Management"),
|
||||
("ISO-45001", "Occupational Health and Safety")
|
||||
]
|
||||
|
||||
for name_nummer, name_text in references:
|
||||
Referenz.objects.create(
|
||||
name_nummer=name_nummer,
|
||||
name_text=name_text
|
||||
)
|
||||
|
||||
self.assertEqual(Referenz.objects.count(), 4) # Including setUp referenz
|
||||
|
||||
|
||||
class ReferenzHierarchyTest(TestCase):
|
||||
"""Test cases for Referenz hierarchy using MPTT"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up hierarchical test data"""
|
||||
# Create root references
|
||||
self.iso_root = Referenz.objects.create(
|
||||
name_nummer="ISO",
|
||||
name_text="International Organization for Standardization"
|
||||
)
|
||||
|
||||
self.iso_27000_series = Referenz.objects.create(
|
||||
name_nummer="ISO-27000",
|
||||
name_text="Information Security Management System Family",
|
||||
oberreferenz=self.iso_root
|
||||
)
|
||||
|
||||
self.iso_27001 = Referenz.objects.create(
|
||||
name_nummer="ISO-27001",
|
||||
name_text="Information Security Management",
|
||||
oberreferenz=self.iso_27000_series
|
||||
)
|
||||
|
||||
self.iso_27002 = Referenz.objects.create(
|
||||
name_nummer="ISO-27002",
|
||||
name_text="Code of Practice for Information Security Controls",
|
||||
oberreferenz=self.iso_27000_series
|
||||
)
|
||||
|
||||
def test_hierarchy_relationships(self):
|
||||
"""Test parent-child relationships"""
|
||||
self.assertEqual(self.iso_27000_series.oberreferenz, self.iso_root)
|
||||
self.assertEqual(self.iso_27001.oberreferenz, self.iso_27000_series)
|
||||
self.assertEqual(self.iso_27002.oberreferenz, self.iso_27000_series)
|
||||
|
||||
def test_get_ancestors(self):
|
||||
"""Test getting ancestors"""
|
||||
ancestors = self.iso_27001.get_ancestors()
|
||||
expected_ancestors = [self.iso_root, self.iso_27000_series]
|
||||
self.assertEqual(list(ancestors), expected_ancestors)
|
||||
|
||||
def test_get_ancestors_include_self(self):
|
||||
"""Test getting ancestors including self"""
|
||||
ancestors = self.iso_27001.get_ancestors(include_self=True)
|
||||
expected_ancestors = [self.iso_root, self.iso_27000_series, self.iso_27001]
|
||||
self.assertEqual(list(ancestors), expected_ancestors)
|
||||
|
||||
def test_get_descendants(self):
|
||||
"""Test getting descendants"""
|
||||
descendants = self.iso_27000_series.get_descendants()
|
||||
expected_descendants = [self.iso_27001, self.iso_27002]
|
||||
self.assertEqual(list(descendants), expected_descendants)
|
||||
|
||||
def test_get_children(self):
|
||||
"""Test getting direct children"""
|
||||
children = self.iso_27000_series.get_children()
|
||||
expected_children = [self.iso_27001, self.iso_27002]
|
||||
self.assertEqual(list(children), expected_children)
|
||||
|
||||
def test_get_root(self):
|
||||
"""Test getting root of hierarchy"""
|
||||
root = self.iso_27001.get_root()
|
||||
self.assertEqual(root, self.iso_root)
|
||||
|
||||
def test_is_root(self):
|
||||
"""Test is_root method"""
|
||||
self.assertTrue(self.iso_root.is_root_node())
|
||||
self.assertFalse(self.iso_27001.is_root_node())
|
||||
|
||||
def test_is_leaf(self):
|
||||
"""Test is_leaf method"""
|
||||
self.assertFalse(self.iso_root.is_leaf_node())
|
||||
self.assertFalse(self.iso_27000_series.is_leaf_node())
|
||||
self.assertTrue(self.iso_27001.is_leaf_node())
|
||||
self.assertTrue(self.iso_27002.is_leaf_node())
|
||||
|
||||
def test_level_property(self):
|
||||
"""Test level property"""
|
||||
self.assertEqual(self.iso_root.level, 0)
|
||||
self.assertEqual(self.iso_27000_series.level, 1)
|
||||
self.assertEqual(self.iso_27001.level, 2)
|
||||
self.assertEqual(self.iso_27002.level, 2)
|
||||
|
||||
def test_path_method_with_hierarchy(self):
|
||||
"""Test Path method with hierarchical references"""
|
||||
path = self.iso_27001.Path()
|
||||
expected_path = "ISO → ISO-27000 → ISO-27001 (Information Security Management)"
|
||||
self.assertEqual(path, expected_path)
|
||||
|
||||
def test_path_method_without_name_text_in_hierarchy(self):
|
||||
"""Test Path method when intermediate nodes have no name_text"""
|
||||
# Create reference without name_text
|
||||
ref_no_text = Referenz.objects.create(
|
||||
name_nummer="NO-TEXT",
|
||||
oberreferenz=self.iso_root
|
||||
)
|
||||
|
||||
child_ref = Referenz.objects.create(
|
||||
name_nummer="CHILD",
|
||||
name_text="Child Reference",
|
||||
oberreferenz=ref_no_text
|
||||
)
|
||||
|
||||
path = child_ref.Path()
|
||||
expected_path = "ISO → NO-TEXT → CHILD (Child Reference)"
|
||||
self.assertEqual(path, expected_path)
|
||||
|
||||
def test_order_insertion_by(self):
|
||||
"""Test that references are ordered by name_nummer"""
|
||||
# Create more children in different order
|
||||
ref_c = Referenz.objects.create(
|
||||
name_nummer="C-REF",
|
||||
oberreferenz=self.iso_root
|
||||
)
|
||||
ref_a = Referenz.objects.create(
|
||||
name_nummer="A-REF",
|
||||
oberreferenz=self.iso_root
|
||||
)
|
||||
ref_b = Referenz.objects.create(
|
||||
name_nummer="B-REF",
|
||||
oberreferenz=self.iso_root
|
||||
)
|
||||
|
||||
children = list(self.iso_root.get_children())
|
||||
# Should be ordered alphabetically by name_nummer
|
||||
expected_order = [ref_a, ref_b, ref_c, self.iso_27000_series]
|
||||
self.assertEqual(children, expected_order)
|
||||
|
||||
|
||||
class ReferenzerklaerungModelTest(TestCase):
|
||||
"""Test cases for Referenzerklaerung model"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data"""
|
||||
self.referenz = Referenz.objects.create(
|
||||
name_nummer="ISO-27001",
|
||||
name_text="Information Security Management"
|
||||
)
|
||||
self.abschnitttyp = AbschnittTyp.objects.create(
|
||||
abschnitttyp="text"
|
||||
)
|
||||
self.erklaerung = Referenzerklaerung.objects.create(
|
||||
erklaerung=self.referenz,
|
||||
abschnitttyp=self.abschnitttyp,
|
||||
inhalt="Dies ist eine Erklärung für ISO-27001.",
|
||||
order=1
|
||||
)
|
||||
|
||||
def test_referenzerklaerung_creation(self):
|
||||
"""Test that Referenzerklaerung is created correctly"""
|
||||
self.assertEqual(self.erklaerung.erklaerung, self.referenz)
|
||||
self.assertEqual(self.erklaerung.abschnitttyp, self.abschnitttyp)
|
||||
self.assertEqual(self.erklaerung.inhalt, "Dies ist eine Erklärung für ISO-27001.")
|
||||
self.assertEqual(self.erklaerung.order, 1)
|
||||
|
||||
def test_referenzerklaerung_foreign_key_relationship(self):
|
||||
"""Test foreign key relationship to Referenz"""
|
||||
self.assertEqual(self.erklaerung.erklaerung.name_nummer, "ISO-27001")
|
||||
self.assertEqual(self.erklaerung.erklaerung.name_text, "Information Security Management")
|
||||
|
||||
def test_referenzerklaerung_cascade_delete(self):
|
||||
"""Test that deleting Referenz cascades to Referenzerklaerung"""
|
||||
referenz_count = Referenz.objects.count()
|
||||
erklaerung_count = Referenzerklaerung.objects.count()
|
||||
|
||||
self.referenz.delete()
|
||||
|
||||
self.assertEqual(Referenz.objects.count(), referenz_count - 1)
|
||||
self.assertEqual(Referenzerklaerung.objects.count(), erklaerung_count - 1)
|
||||
|
||||
def test_referenzerklaerung_verbose_name(self):
|
||||
"""Test verbose name"""
|
||||
self.assertEqual(
|
||||
Referenzerklaerung._meta.verbose_name,
|
||||
"Erklärung"
|
||||
)
|
||||
|
||||
def test_referenzerklaerung_multiple_explanations(self):
|
||||
"""Test creating multiple explanations for one Referenz"""
|
||||
abschnitttyp2 = AbschnittTyp.objects.create(abschnitttyp="liste ungeordnet")
|
||||
erklaerung2 = Referenzerklaerung.objects.create(
|
||||
erklaerung=self.referenz,
|
||||
abschnitttyp=abschnitttyp2,
|
||||
inhalt="Zweite Erklärung für ISO-27001.",
|
||||
order=2
|
||||
)
|
||||
|
||||
explanations = Referenzerklaerung.objects.filter(erklaerung=self.referenz)
|
||||
self.assertEqual(explanations.count(), 2)
|
||||
self.assertIn(self.erklaerung, explanations)
|
||||
self.assertIn(erklaerung2, explanations)
|
||||
|
||||
def test_referenzerklaerung_ordering(self):
|
||||
"""Test that explanations can be ordered"""
|
||||
erklaerung2 = Referenzerklaerung.objects.create(
|
||||
erklaerung=self.referenz,
|
||||
abschnitttyp=self.abschnitttyp,
|
||||
inhalt="Zweite Erklärung",
|
||||
order=3
|
||||
)
|
||||
erklaerung3 = Referenzerklaerung.objects.create(
|
||||
erklaerung=self.referenz,
|
||||
abschnitttyp=self.abschnitttyp,
|
||||
inhalt="Erste Erklärung",
|
||||
order=2
|
||||
)
|
||||
|
||||
ordered = Referenzerklaerung.objects.filter(erklaerung=self.referenz).order_by('order')
|
||||
expected_order = [self.erklaerung, erklaerung3, erklaerung2]
|
||||
self.assertEqual(list(ordered), expected_order)
|
||||
|
||||
def test_referenzerklaerung_blank_fields(self):
|
||||
"""Test that optional fields can be blank/null"""
|
||||
referenz2 = Referenz.objects.create(name_nummer="TEST-001")
|
||||
erklaerung_blank = Referenzerklaerung.objects.create(
|
||||
erklaerung=referenz2
|
||||
)
|
||||
|
||||
self.assertIsNone(erklaerung_blank.abschnitttyp)
|
||||
self.assertIsNone(erklaerung_blank.inhalt)
|
||||
self.assertEqual(erklaerung_blank.order, 0)
|
||||
|
||||
def test_referenzerklaerung_inheritance(self):
|
||||
"""Test that Referenzerklaerung inherits from Textabschnitt"""
|
||||
# Check that it has the expected fields from Textabschnitt
|
||||
self.assertTrue(hasattr(self.erklaerung, 'abschnitttyp'))
|
||||
self.assertTrue(hasattr(self.erklaerung, 'inhalt'))
|
||||
self.assertTrue(hasattr(self.erklaerung, 'order'))
|
||||
|
||||
# Check that the fields work as expected
|
||||
self.assertIsInstance(self.erklaerung.abschnitttyp, AbschnittTyp)
|
||||
self.assertIsInstance(self.erklaerung.inhalt, str)
|
||||
self.assertIsInstance(self.erklaerung.order, int)
|
||||
|
||||
|
||||
class ReferenzIntegrationTest(TestCase):
|
||||
"""Integration tests for Referenz app"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data"""
|
||||
self.root_ref = Referenz.objects.create(
|
||||
name_nummer="ROOT",
|
||||
name_text="Root Reference"
|
||||
)
|
||||
|
||||
self.child_ref = Referenz.objects.create(
|
||||
name_nummer="CHILD",
|
||||
name_text="Child Reference",
|
||||
oberreferenz=self.root_ref
|
||||
)
|
||||
|
||||
self.abschnitttyp = AbschnittTyp.objects.create(abschnitttyp="text")
|
||||
|
||||
self.erklaerung = Referenzerklaerung.objects.create(
|
||||
erklaerung=self.child_ref,
|
||||
abschnitttyp=self.abschnitttyp,
|
||||
inhalt="Explanation for child reference",
|
||||
order=1
|
||||
)
|
||||
|
||||
def test_reference_with_explanations_query(self):
|
||||
"""Test querying references with their explanations"""
|
||||
references_with_explanations = Referenz.objects.filter(
|
||||
referenzerklaerung__isnull=False
|
||||
).distinct()
|
||||
|
||||
self.assertEqual(references_with_explanations.count(), 1)
|
||||
self.assertIn(self.child_ref, references_with_explanations)
|
||||
self.assertNotIn(self.root_ref, references_with_explanations)
|
||||
|
||||
def test_reference_without_explanations(self):
|
||||
"""Test finding references without explanations"""
|
||||
references_without_explanations = Referenz.objects.filter(
|
||||
referenzerklaerung__isnull=True
|
||||
)
|
||||
|
||||
self.assertEqual(references_without_explanations.count(), 1)
|
||||
self.assertEqual(references_without_explanations.first(), self.root_ref)
|
||||
|
||||
def test_explanation_count_annotation(self):
|
||||
"""Test annotating references with explanation count"""
|
||||
from django.db.models import Count
|
||||
|
||||
references_with_count = Referenz.objects.annotate(
|
||||
explanation_count=Count('referenzerklaerung')
|
||||
)
|
||||
|
||||
for reference in references_with_count:
|
||||
if reference == self.child_ref:
|
||||
self.assertEqual(reference.explanation_count, 1)
|
||||
else:
|
||||
self.assertEqual(reference.explanation_count, 0)
|
||||
|
||||
def test_hierarchy_with_explanations(self):
|
||||
"""Test that explanations work correctly with hierarchical references"""
|
||||
# Add explanation to root reference
|
||||
root_erklaerung = Referenzerklaerung.objects.create(
|
||||
erklaerung=self.root_ref,
|
||||
abschnitttyp=self.abschnitttyp,
|
||||
inhalt="Explanation for root reference",
|
||||
order=1
|
||||
)
|
||||
|
||||
# Both references should now have explanations
|
||||
references_with_explanations = Referenz.objects.filter(
|
||||
referenzerklaerung__isnull=False
|
||||
).distinct()
|
||||
|
||||
self.assertEqual(references_with_explanations.count(), 2)
|
||||
self.assertIn(self.root_ref, references_with_explanations)
|
||||
self.assertIn(self.child_ref, references_with_explanations)
|
||||
|
||||
@@ -5,7 +5,8 @@ certifi==2025.8.3
|
||||
charset-normalizer==3.4.3
|
||||
curtsies==0.4.3
|
||||
cwcwidth==0.1.10
|
||||
Django==5.2.5
|
||||
Django==5.2.8
|
||||
django-admin-sortable2==2.2.8
|
||||
django-js-asset==3.1.2
|
||||
django-mptt==0.17.0
|
||||
django-mptt-admin==2.8.0
|
||||
@@ -31,3 +32,5 @@ six==1.17.0
|
||||
sqlparse==0.5.3
|
||||
urllib3==2.5.0
|
||||
wcwidth==0.2.13
|
||||
bleach==6.1.0
|
||||
coverage==7.6.1
|
||||
|
||||
366
rollen/tests.py
366
rollen/tests.py
@@ -1,3 +1,367 @@
|
||||
from django.test import TestCase
|
||||
from django.core.exceptions import ValidationError
|
||||
from django.db.models import Count
|
||||
from .models import Rolle, RollenBeschreibung
|
||||
from abschnitte.models import AbschnittTyp
|
||||
|
||||
# Create your tests here.
|
||||
|
||||
class RolleModelTest(TestCase):
|
||||
"""Test cases for Rolle model"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data"""
|
||||
self.rolle = Rolle.objects.create(
|
||||
name="Systemadministrator"
|
||||
)
|
||||
|
||||
def test_rolle_creation(self):
|
||||
"""Test that Rolle is created correctly"""
|
||||
self.assertEqual(self.rolle.name, "Systemadministrator")
|
||||
|
||||
def test_rolle_str(self):
|
||||
"""Test string representation of Rolle"""
|
||||
self.assertEqual(str(self.rolle), "Systemadministrator")
|
||||
|
||||
def test_rolle_primary_key(self):
|
||||
"""Test that name field is the primary key"""
|
||||
pk_field = Rolle._meta.pk
|
||||
self.assertEqual(pk_field.name, 'name')
|
||||
self.assertEqual(pk_field.max_length, 100)
|
||||
|
||||
def test_rolle_verbose_name_plural(self):
|
||||
"""Test verbose name plural"""
|
||||
self.assertEqual(
|
||||
Rolle._meta.verbose_name_plural,
|
||||
"Rollen"
|
||||
)
|
||||
|
||||
def test_rolle_max_length(self):
|
||||
"""Test max_length constraint"""
|
||||
max_length_rolle = "a" * 100
|
||||
rolle = Rolle.objects.create(name=max_length_rolle)
|
||||
self.assertEqual(rolle.name, max_length_rolle)
|
||||
|
||||
def test_rolle_unique(self):
|
||||
"""Test that name must be unique"""
|
||||
with self.assertRaises(Exception):
|
||||
Rolle.objects.create(name="Systemadministrator")
|
||||
|
||||
def test_create_multiple_rollen(self):
|
||||
"""Test creating multiple Rolle objects"""
|
||||
rollen = [
|
||||
"Datenschutzbeauftragter",
|
||||
"IT-Sicherheitsbeauftragter",
|
||||
"Risikomanager",
|
||||
"Compliance-Officer"
|
||||
]
|
||||
for rolle_name in rollen:
|
||||
Rolle.objects.create(name=rolle_name)
|
||||
|
||||
self.assertEqual(Rolle.objects.count(), 5) # Including setUp rolle
|
||||
|
||||
def test_rolle_case_sensitivity(self):
|
||||
"""Test that role name is case sensitive"""
|
||||
rolle_lower = Rolle.objects.create(name="systemadministrator")
|
||||
self.assertNotEqual(self.rolle.pk, rolle_lower.pk)
|
||||
self.assertEqual(Rolle.objects.count(), 2)
|
||||
|
||||
def test_rolle_with_special_characters(self):
|
||||
"""Test creating roles with special characters"""
|
||||
special_roles = [
|
||||
"IT-Administrator",
|
||||
"CISO (Chief Information Security Officer)",
|
||||
"Datenschutz-Beauftragter/-in",
|
||||
"Sicherheitsbeauftragter"
|
||||
]
|
||||
|
||||
for role_name in special_roles:
|
||||
rolle = Rolle.objects.create(name=role_name)
|
||||
self.assertEqual(rolle.name, role_name)
|
||||
|
||||
self.assertEqual(Rolle.objects.count(), 5) # Including setUp rolle
|
||||
|
||||
|
||||
class RollenBeschreibungModelTest(TestCase):
|
||||
"""Test cases for RollenBeschreibung model"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data"""
|
||||
self.rolle = Rolle.objects.create(
|
||||
name="Systemadministrator"
|
||||
)
|
||||
self.abschnitttyp = AbschnittTyp.objects.create(
|
||||
abschnitttyp="text"
|
||||
)
|
||||
self.beschreibung = RollenBeschreibung.objects.create(
|
||||
abschnitt=self.rolle,
|
||||
abschnitttyp=self.abschnitttyp,
|
||||
inhalt="Der Systemadministrator ist für die Verwaltung und Wartung der IT-Systeme verantwortlich.",
|
||||
order=1
|
||||
)
|
||||
|
||||
def test_rollenbeschreibung_creation(self):
|
||||
"""Test that RollenBeschreibung is created correctly"""
|
||||
self.assertEqual(self.beschreibung.abschnitt, self.rolle)
|
||||
self.assertEqual(self.beschreibung.abschnitttyp, self.abschnitttyp)
|
||||
self.assertEqual(self.beschreibung.inhalt, "Der Systemadministrator ist für die Verwaltung und Wartung der IT-Systeme verantwortlich.")
|
||||
self.assertEqual(self.beschreibung.order, 1)
|
||||
|
||||
def test_rollenbeschreibung_foreign_key_relationship(self):
|
||||
"""Test foreign key relationship to Rolle"""
|
||||
self.assertEqual(self.beschreibung.abschnitt.name, "Systemadministrator")
|
||||
|
||||
def test_rollenbeschreibung_cascade_delete(self):
|
||||
"""Test that deleting Rolle cascades to RollenBeschreibung"""
|
||||
rolle_count = Rolle.objects.count()
|
||||
beschreibung_count = RollenBeschreibung.objects.count()
|
||||
|
||||
self.rolle.delete()
|
||||
|
||||
self.assertEqual(Rolle.objects.count(), rolle_count - 1)
|
||||
self.assertEqual(RollenBeschreibung.objects.count(), beschreibung_count - 1)
|
||||
|
||||
def test_rollenbeschreibung_verbose_names(self):
|
||||
"""Test verbose names"""
|
||||
self.assertEqual(
|
||||
RollenBeschreibung._meta.verbose_name,
|
||||
"Rollenbeschreibungs-Abschnitt"
|
||||
)
|
||||
self.assertEqual(
|
||||
RollenBeschreibung._meta.verbose_name_plural,
|
||||
"Rollenbeschreibung"
|
||||
)
|
||||
|
||||
def test_rollenbeschreibung_multiple_descriptions(self):
|
||||
"""Test creating multiple descriptions for one Rolle"""
|
||||
abschnitttyp2 = AbschnittTyp.objects.create(abschnitttyp="liste ungeordnet")
|
||||
beschreibung2 = RollenBeschreibung.objects.create(
|
||||
abschnitt=self.rolle,
|
||||
abschnitttyp=abschnitttyp2,
|
||||
inhalt="Aufgaben:\n- Systemüberwachung\n- Backup-Management\n- Benutzeradministration",
|
||||
order=2
|
||||
)
|
||||
|
||||
descriptions = RollenBeschreibung.objects.filter(abschnitt=self.rolle)
|
||||
self.assertEqual(descriptions.count(), 2)
|
||||
self.assertIn(self.beschreibung, descriptions)
|
||||
self.assertIn(beschreibung2, descriptions)
|
||||
|
||||
def test_rollenbeschreibung_ordering(self):
|
||||
"""Test that descriptions can be ordered"""
|
||||
beschreibung2 = RollenBeschreibung.objects.create(
|
||||
abschnitt=self.rolle,
|
||||
abschnitttyp=self.abschnitttyp,
|
||||
inhalt="Zweite Beschreibung",
|
||||
order=3
|
||||
)
|
||||
beschreibung3 = RollenBeschreibung.objects.create(
|
||||
abschnitt=self.rolle,
|
||||
abschnitttyp=self.abschnitttyp,
|
||||
inhalt="Erste Beschreibung",
|
||||
order=2
|
||||
)
|
||||
|
||||
ordered = RollenBeschreibung.objects.filter(abschnitt=self.rolle).order_by('order')
|
||||
expected_order = [self.beschreibung, beschreibung3, beschreibung2]
|
||||
self.assertEqual(list(ordered), expected_order)
|
||||
|
||||
def test_rollenbeschreibung_blank_fields(self):
|
||||
"""Test that optional fields can be blank/null"""
|
||||
rolle2 = Rolle.objects.create(name="Testrolle")
|
||||
beschreibung_blank = RollenBeschreibung.objects.create(
|
||||
abschnitt=rolle2
|
||||
)
|
||||
|
||||
self.assertIsNone(beschreibung_blank.abschnitttyp)
|
||||
self.assertIsNone(beschreibung_blank.inhalt)
|
||||
self.assertEqual(beschreibung_blank.order, 0)
|
||||
|
||||
def test_rollenbeschreibung_inheritance(self):
|
||||
"""Test that RollenBeschreibung inherits from Textabschnitt"""
|
||||
# Check that it has the expected fields from Textabschnitt
|
||||
self.assertTrue(hasattr(self.beschreibung, 'abschnitttyp'))
|
||||
self.assertTrue(hasattr(self.beschreibung, 'inhalt'))
|
||||
self.assertTrue(hasattr(self.beschreibung, 'order'))
|
||||
|
||||
# Check that the fields work as expected
|
||||
self.assertIsInstance(self.beschreibung.abschnitttyp, AbschnittTyp)
|
||||
self.assertIsInstance(self.beschreibung.inhalt, str)
|
||||
self.assertIsInstance(self.beschreibung.order, int)
|
||||
|
||||
def test_rollenbeschreibung_different_types(self):
|
||||
"""Test creating descriptions with different section types"""
|
||||
# Create different section types
|
||||
typ_list = AbschnittTyp.objects.create(abschnitttyp="liste ungeordnet")
|
||||
typ_table = AbschnittTyp.objects.create(abschnitttyp="tabelle")
|
||||
|
||||
# Create descriptions with different types
|
||||
beschreibung_text = RollenBeschreibung.objects.create(
|
||||
abschnitt=self.rolle,
|
||||
abschnitttyp=self.abschnitttyp,
|
||||
inhalt="Textbeschreibung der Rolle",
|
||||
order=1
|
||||
)
|
||||
|
||||
beschreibung_list = RollenBeschreibung.objects.create(
|
||||
abschnitt=self.rolle,
|
||||
abschnitttyp=typ_list,
|
||||
inhalt="Aufgabe 1\nAufgabe 2\nAufgabe 3",
|
||||
order=2
|
||||
)
|
||||
|
||||
beschreibung_table = RollenBeschreibung.objects.create(
|
||||
abschnitt=self.rolle,
|
||||
abschnitttyp=typ_table,
|
||||
inhalt="| Verantwortung | Priorität |\n|--------------|------------|\n| Systemwartung | Hoch |",
|
||||
order=3
|
||||
)
|
||||
|
||||
# Verify all descriptions are created
|
||||
descriptions = RollenBeschreibung.objects.filter(abschnitt=self.rolle)
|
||||
self.assertEqual(descriptions.count(), 4) # Including setUp beschreibung
|
||||
|
||||
# Verify types are correct
|
||||
self.assertEqual(beschreibung_text.abschnitttyp, self.abschnitttyp)
|
||||
self.assertEqual(beschreibung_list.abschnitttyp, typ_list)
|
||||
self.assertEqual(beschreibung_table.abschnitttyp, typ_table)
|
||||
|
||||
|
||||
class RolleIntegrationTest(TestCase):
|
||||
"""Integration tests for Rolle app"""
|
||||
|
||||
def setUp(self):
|
||||
"""Set up test data"""
|
||||
self.rolle1 = Rolle.objects.create(name="IT-Sicherheitsbeauftragter")
|
||||
self.rolle2 = Rolle.objects.create(name="Datenschutzbeauftragter")
|
||||
|
||||
self.abschnitttyp = AbschnittTyp.objects.create(abschnitttyp="text")
|
||||
|
||||
self.beschreibung1 = RollenBeschreibung.objects.create(
|
||||
abschnitt=self.rolle1,
|
||||
abschnitttyp=self.abschnitttyp,
|
||||
inhalt="Beschreibung für IT-Sicherheitsbeauftragten",
|
||||
order=1
|
||||
)
|
||||
|
||||
self.beschreibung2 = RollenBeschreibung.objects.create(
|
||||
abschnitt=self.rolle2,
|
||||
abschnitttyp=self.abschnitttyp,
|
||||
inhalt="Beschreibung für Datenschutzbeauftragten",
|
||||
order=1
|
||||
)
|
||||
|
||||
def test_rolle_with_descriptions_query(self):
|
||||
"""Test querying Rollen with their descriptions"""
|
||||
rollen_with_descriptions = Rolle.objects.filter(
|
||||
rollenbeschreibung__isnull=False
|
||||
).distinct()
|
||||
|
||||
self.assertEqual(rollen_with_descriptions.count(), 2)
|
||||
self.assertIn(self.rolle1, rollen_with_descriptions)
|
||||
self.assertIn(self.rolle2, rollen_with_descriptions)
|
||||
|
||||
def test_rolle_without_descriptions(self):
|
||||
"""Test finding Rollen without descriptions"""
|
||||
rolle3 = Rolle.objects.create(name="Compliance-Officer")
|
||||
|
||||
rollen_without_descriptions = Rolle.objects.filter(
|
||||
rollenbeschreibung__isnull=True
|
||||
)
|
||||
|
||||
self.assertEqual(rollen_without_descriptions.count(), 1)
|
||||
self.assertEqual(rollen_without_descriptions.first(), rolle3)
|
||||
|
||||
def test_description_count_annotation(self):
|
||||
"""Test annotating Rollen with description count"""
|
||||
from django.db.models import Count
|
||||
|
||||
rollen_with_count = Rolle.objects.annotate(
|
||||
description_count=Count('rollenbeschreibung')
|
||||
)
|
||||
|
||||
for rolle in rollen_with_count:
|
||||
if rolle.name in ["IT-Sicherheitsbeauftragter", "Datenschutzbeauftragter"]:
|
||||
self.assertEqual(rolle.description_count, 1)
|
||||
else:
|
||||
self.assertEqual(rolle.description_count, 0)
|
||||
|
||||
def test_multiple_descriptions_per_rolle(self):
|
||||
"""Test multiple descriptions for a single role"""
|
||||
# Add more descriptions to rolle1
|
||||
abschnitttyp2 = AbschnittTyp.objects.create(abschnitttyp="liste ungeordnet")
|
||||
|
||||
beschreibung2 = RollenBeschreibung.objects.create(
|
||||
abschnitt=self.rolle1,
|
||||
abschnitttyp=abschnitttyp2,
|
||||
inhalt="Zusätzliche Aufgaben:\n- Überwachung\n- Berichterstattung",
|
||||
order=2
|
||||
)
|
||||
|
||||
# Check that rolle1 now has 2 descriptions
|
||||
descriptions = RollenBeschreibung.objects.filter(abschnitt=self.rolle1)
|
||||
self.assertEqual(descriptions.count(), 2)
|
||||
|
||||
# Check annotation
|
||||
rolle_with_count = Rolle.objects.annotate(
|
||||
description_count=Count('rollenbeschreibung')
|
||||
).get(pk=self.rolle1.pk)
|
||||
self.assertEqual(rolle_with_count.description_count, 2)
|
||||
|
||||
def test_role_descriptions_ordered(self):
|
||||
"""Test that role descriptions are returned in correct order"""
|
||||
# Add more descriptions in random order
|
||||
beschreibung2 = RollenBeschreibung.objects.create(
|
||||
abschnitt=self.rolle1,
|
||||
abschnitttyp=self.abschnitttyp,
|
||||
inhalt="Dritte Beschreibung",
|
||||
order=3
|
||||
)
|
||||
|
||||
beschreibung3 = RollenBeschreibung.objects.create(
|
||||
abschnitt=self.rolle1,
|
||||
abschnitttyp=self.abschnitttyp,
|
||||
inhalt="Zweite Beschreibung",
|
||||
order=2
|
||||
)
|
||||
|
||||
# Get descriptions in order
|
||||
ordered_descriptions = RollenBeschreibung.objects.filter(
|
||||
abschnitt=self.rolle1
|
||||
).order_by('order')
|
||||
|
||||
expected_order = [self.beschreibung1, beschreibung3, beschreibung2]
|
||||
self.assertEqual(list(ordered_descriptions), expected_order)
|
||||
|
||||
def test_role_search_by_name(self):
|
||||
"""Test searching roles by name"""
|
||||
# Test exact match
|
||||
exact_match = Rolle.objects.filter(name="IT-Sicherheitsbeauftragter")
|
||||
self.assertEqual(exact_match.count(), 1)
|
||||
self.assertEqual(exact_match.first(), self.rolle1)
|
||||
|
||||
# Test case-sensitive contains
|
||||
contains_match = Rolle.objects.filter(name__contains="Sicherheits")
|
||||
self.assertEqual(contains_match.count(), 1)
|
||||
self.assertEqual(contains_match.first(), self.rolle1)
|
||||
|
||||
# Test case-insensitive contains
|
||||
icontains_match = Rolle.objects.filter(name__icontains="sicherheits")
|
||||
self.assertEqual(icontains_match.count(), 1)
|
||||
self.assertEqual(icontains_match.first(), self.rolle1)
|
||||
|
||||
def test_role_with_long_descriptions(self):
|
||||
"""Test roles with long description content"""
|
||||
long_content = "Dies ist eine sehr lange Beschreibung " * 50 # Repeat to make it long
|
||||
|
||||
rolle_long = Rolle.objects.create(name="Rolle mit langer Beschreibung")
|
||||
beschreibung_long = RollenBeschreibung.objects.create(
|
||||
abschnitt=rolle_long,
|
||||
abschnitttyp=self.abschnitttyp,
|
||||
inhalt=long_content,
|
||||
order=1
|
||||
)
|
||||
|
||||
# Verify the long content is stored correctly
|
||||
retrieved = RollenBeschreibung.objects.get(pk=beschreibung_long.pk)
|
||||
self.assertEqual(retrieved.inhalt, long_content)
|
||||
self.assertGreater(len(retrieved.inhalt), 1000) # Should be quite long
|
||||
|
||||
@@ -1,127 +0,0 @@
|
||||
from django.contrib import admin
|
||||
#from nested_inline.admin import NestedStackedInline, NestedModelAdmin
|
||||
from nested_admin import NestedStackedInline, NestedModelAdmin, NestedTabularInline
|
||||
from django import forms
|
||||
from mptt.forms import TreeNodeMultipleChoiceField
|
||||
from mptt.admin import DraggableMPTTAdmin
|
||||
|
||||
# Register your models here.
|
||||
from .models import *
|
||||
from stichworte.models import Stichwort, Stichworterklaerung
|
||||
from referenzen.models import Referenz
|
||||
|
||||
|
||||
|
||||
#class ChecklistenForm(forms.ModelForm):
|
||||
# class Meta:
|
||||
# model=Checklistenfrage
|
||||
# fields="__all__"
|
||||
# widgets = {
|
||||
# 'frage': forms.Textarea(attrs={'rows': 1, 'cols': 100}),
|
||||
# }
|
||||
|
||||
class ChecklistenfragenInline(NestedTabularInline):
|
||||
model=Checklistenfrage
|
||||
extra=0
|
||||
fk_name="vorgabe"
|
||||
# form=ChecklistenForm
|
||||
classes = ['collapse']
|
||||
|
||||
|
||||
class VorgabeKurztextInline(NestedTabularInline):
|
||||
model=VorgabeKurztext
|
||||
extra=0
|
||||
sortable_field_name = "order"
|
||||
show_change_link=True
|
||||
classes = ['collapse']
|
||||
#inline=inhalt
|
||||
|
||||
class VorgabeLangtextInline(NestedStackedInline):
|
||||
model=VorgabeLangtext
|
||||
extra=0
|
||||
sortable_field_name = "order"
|
||||
show_change_link=True
|
||||
classes = ['collapse']
|
||||
#inline=inhalt
|
||||
|
||||
class GeltungsbereichInline(NestedTabularInline):
|
||||
model=Geltungsbereich
|
||||
extra=0
|
||||
sortable_field_name = "order"
|
||||
show_change_link=True
|
||||
classes = ['collapse']
|
||||
classes = ['collapse']
|
||||
#inline=inhalt
|
||||
|
||||
class EinleitungInline(NestedTabularInline):
|
||||
model = Einleitung
|
||||
extra = 0
|
||||
sortable_field_name = "order"
|
||||
show_change_link = True
|
||||
classes = ['collapse']
|
||||
|
||||
class VorgabeForm(forms.ModelForm):
|
||||
# referenzen = TreeNodeMultipleChoiceField(queryset=Referenz.objects.all(), required=False)
|
||||
class Meta:
|
||||
model = Vorgabe
|
||||
fields = '__all__'
|
||||
|
||||
class VorgabeInline(NestedTabularInline): # or StackedInline for more vertical layout
|
||||
model = Vorgabe
|
||||
form = VorgabeForm
|
||||
extra = 0
|
||||
#show_change_link = True
|
||||
inlines = [VorgabeKurztextInline,VorgabeLangtextInline,ChecklistenfragenInline]
|
||||
autocomplete_fields = ['stichworte','referenzen','relevanz']
|
||||
#search_fields=['nummer','name']ModelAdmin.
|
||||
list_filter=['stichworte']
|
||||
#classes=["collapse"]
|
||||
|
||||
class StichworterklaerungInline(NestedStackedInline):
|
||||
model=Stichworterklaerung
|
||||
extra=0
|
||||
sortable_field_name = "order"
|
||||
ordering=("order",)
|
||||
show_change_link = True
|
||||
|
||||
@admin.register(Stichwort)
|
||||
class StichwortAdmin(NestedModelAdmin):
|
||||
search_fields = ('stichwort',)
|
||||
ordering=('stichwort',)
|
||||
inlines=[StichworterklaerungInline]
|
||||
|
||||
@admin.register(Person)
|
||||
class PersonAdmin(admin.ModelAdmin):
|
||||
class Media:
|
||||
js = ['admin/js/jquery.init.js', 'custom/js/inline_toggle.js']
|
||||
css = {'all': ['custom/css/admin_extras.css']}
|
||||
list_display=['name']
|
||||
|
||||
|
||||
|
||||
@admin.register(Dokument)
|
||||
class DokumentAdmin(NestedModelAdmin):
|
||||
actions_on_top=True
|
||||
inlines = [EinleitungInline,GeltungsbereichInline,VorgabeInline]
|
||||
#filter_horizontal=['autoren','pruefende']
|
||||
list_display=['nummer','name','dokumententyp']
|
||||
search_fields=['nummer','name']
|
||||
class Media:
|
||||
# js = ('admin/js/vorgabe_collapse.js',)
|
||||
css = {
|
||||
'all': ('admin/css/vorgabe_border.css',
|
||||
# 'admin/css/vorgabe_collapse.css',
|
||||
)
|
||||
}
|
||||
|
||||
|
||||
#admin.site.register(Stichwort)
|
||||
|
||||
admin.site.register(Checklistenfrage)
|
||||
admin.site.register(Dokumententyp)
|
||||
#admin.site.register(Person)
|
||||
admin.site.register(Thema)
|
||||
#admin.site.register(Referenz, DraggableM§PTTAdmin)
|
||||
admin.site.register(Vorgabe)
|
||||
|
||||
#admin.site.register(Changelog)
|
||||
@@ -1,137 +0,0 @@
|
||||
from django.db import models
|
||||
from mptt.models import MPTTModel, TreeForeignKey
|
||||
from abschnitte.models import Textabschnitt
|
||||
from stichworte.models import Stichwort
|
||||
from referenzen.models import Referenz
|
||||
from rollen.models import Rolle
|
||||
import datetime
|
||||
|
||||
class Dokumententyp(models.Model):
|
||||
name = models.CharField(max_length=100, primary_key=True)
|
||||
verantwortliche_ve = models.CharField(max_length=255)
|
||||
|
||||
def __str__(self):
|
||||
return self.name
|
||||
|
||||
class Meta:
|
||||
verbose_name="Dokumententyp"
|
||||
verbose_name_plural="Dokumententypen"
|
||||
|
||||
|
||||
class Person(models.Model):
|
||||
name = models.CharField(max_length=100, primary_key=True)
|
||||
funktion = models.CharField(max_length=255)
|
||||
|
||||
def __str__(self):
|
||||
return self.name
|
||||
class Meta:
|
||||
verbose_name_plural="Personen"
|
||||
|
||||
class Thema(models.Model):
|
||||
name = models.CharField(max_length=100, primary_key=True)
|
||||
erklaerung = models.TextField(blank=True)
|
||||
|
||||
def __str__(self):
|
||||
return self.name
|
||||
class Meta:
|
||||
verbose_name_plural="Themen"
|
||||
|
||||
|
||||
class Dokument(models.Model):
|
||||
nummer = models.CharField(max_length=50, primary_key=True)
|
||||
dokumententyp = models.ForeignKey(Dokumententyp, on_delete=models.PROTECT)
|
||||
name = models.CharField(max_length=255)
|
||||
autoren = models.ManyToManyField(Person, related_name='verfasste_dokumente')
|
||||
pruefende = models.ManyToManyField(Person, related_name='gepruefte_dokumente')
|
||||
gueltigkeit_von = models.DateField(null=True, blank=True)
|
||||
gueltigkeit_bis = models.DateField(null=True, blank=True)
|
||||
signatur_cso = models.CharField(max_length=255, blank=True)
|
||||
anhaenge = models.TextField(blank=True)
|
||||
|
||||
def __str__(self):
|
||||
return f"{self.nummer} – {self.name}"
|
||||
|
||||
class Meta:
|
||||
verbose_name_plural="Dokumente"
|
||||
verbose_name="Dokument"
|
||||
|
||||
class Vorgabe(models.Model):
|
||||
nummer = models.IntegerField()
|
||||
dokument = models.ForeignKey(Dokument, on_delete=models.CASCADE, related_name='vorgaben')
|
||||
thema = models.ForeignKey(Thema, on_delete=models.PROTECT)
|
||||
titel = models.CharField(max_length=255)
|
||||
referenzen = models.ManyToManyField(Referenz, blank=True)
|
||||
gueltigkeit_von = models.DateField()
|
||||
gueltigkeit_bis = models.DateField(blank=True,null=True)
|
||||
stichworte = models.ManyToManyField(Stichwort, blank=True)
|
||||
relevanz = models.ManyToManyField(Rolle,blank=True)
|
||||
|
||||
def Vorgabennummer(self):
|
||||
return str(self.dokument.nummer)+"."+self.thema.name[0]+"."+str(self.nummer)
|
||||
|
||||
def get_status(self, check_date: datetime.date = datetime.date.today(), verbose: bool = False) -> str:
|
||||
if self.gueltigkeit_von > check_date:
|
||||
return "future" if not verbose else "Ist erst ab dem "+self.gueltigkeit_von.strftime('%d.%m.%Y')+" in Kraft."
|
||||
|
||||
if not self.gueltigkeit_bis:
|
||||
return "active"
|
||||
|
||||
if self.gueltigkeit_bis > check_date:
|
||||
return "active"
|
||||
|
||||
return "expired" if not verbose else "Ist seit dem "+self.gueltigkeit_bis.strftime('%d.%m.%Y')+" nicht mehr in Kraft."
|
||||
|
||||
def __str__(self):
|
||||
return f"{self.Vorgabennummer()}: {self.titel}"
|
||||
|
||||
class Meta:
|
||||
verbose_name_plural="Vorgaben"
|
||||
|
||||
|
||||
class VorgabeLangtext(Textabschnitt):
|
||||
abschnitt=models.ForeignKey(Vorgabe,on_delete=models.CASCADE)
|
||||
class Meta:
|
||||
verbose_name_plural="Langtext"
|
||||
verbose_name="Langtext-Abschnitt"
|
||||
|
||||
class VorgabeKurztext(Textabschnitt):
|
||||
abschnitt=models.ForeignKey(Vorgabe,on_delete=models.CASCADE)
|
||||
class Meta:
|
||||
verbose_name_plural="Kurztext"
|
||||
verbose_name="Kurztext-Abschnitt"
|
||||
|
||||
class Geltungsbereich(Textabschnitt):
|
||||
geltungsbereich=models.ForeignKey(Dokument,on_delete=models.CASCADE)
|
||||
class Meta:
|
||||
verbose_name_plural="Geltungsbereich"
|
||||
verbose_name="Geltungsbereichs-Abschnitt"
|
||||
|
||||
class Einleitung(Textabschnitt):
|
||||
einleitung=models.ForeignKey(Dokument,on_delete=models.CASCADE)
|
||||
class Meta:
|
||||
verbose_name_plural="Einleitung"
|
||||
verbose_name="Einleitungs-Abschnitt"
|
||||
|
||||
class Checklistenfrage(models.Model):
|
||||
vorgabe=models.ForeignKey(Vorgabe, on_delete=models.CASCADE, related_name="checklistenfragen")
|
||||
frage = models.CharField(max_length=255)
|
||||
|
||||
def __str__(self):
|
||||
return self.frage
|
||||
|
||||
class Meta:
|
||||
verbose_name_plural="Fragen für Checkliste"
|
||||
verbose_name="Frage für Checkliste"
|
||||
|
||||
class Changelog(models.Model):
|
||||
dokument = models.ForeignKey(Dokument, on_delete=models.CASCADE, related_name='changelog')
|
||||
autoren = models.ManyToManyField(Person)
|
||||
datum = models.DateField()
|
||||
aenderung = models.TextField()
|
||||
|
||||
def __str__(self):
|
||||
return f"{self.datum} – {self.dokument.nummer}"
|
||||
|
||||
class Meta:
|
||||
verbose_name_plural="Changelog"
|
||||
verbose_name="Changelog-Eintrag"
|
||||
@@ -1,109 +0,0 @@
|
||||
{% extends "base.html" %}
|
||||
{% block title %}{{ standard }}{% endblock %}
|
||||
{% block content %}
|
||||
<h1>{{ standard.nummer }} – {{ standard.name }}</h1>
|
||||
{% if standard.history == True %}
|
||||
<h2>Version vom {{ standard.check_date }}</h2>
|
||||
{% endif %}
|
||||
<!-- Autoren, Prüfende etc. -->
|
||||
<p><strong>Autoren:</strong> {{ standard.autoren.all|join:", " }}</p>
|
||||
<p><strong>Prüfende:</strong> {{ standard.pruefende.all|join:", " }}</p>
|
||||
<p><strong>Gültigkeit:</strong> {{ standard.gueltigkeit_von }} bis {{ standard.gueltigkeit_bis }}</p>
|
||||
|
||||
<!-- Start Einleitung -->
|
||||
{% if standard.einleitung_html %}
|
||||
<h2>Einleitung</h2>
|
||||
{% for typ, html in standard.einleitung_html %}
|
||||
<div>{{ html|safe }}</div>
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
<!-- End Einleitung -->
|
||||
|
||||
<!-- Start Geltungsbereich -->
|
||||
{% if standard.geltungsbereich_html %}
|
||||
<h2>Geltungsbereich</h2>
|
||||
{% for typ, html in standard.geltungsbereich_html %}
|
||||
<div>{{ html|safe }}</div>
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
<!-- End Geltungsbereich -->
|
||||
|
||||
<h2>Vorgaben</h2>
|
||||
{% for vorgabe in vorgaben %}
|
||||
<!-- Start Vorgabe -->
|
||||
{% if standard.history == True or vorgabe.long_status == "active" %}
|
||||
<a id="{{ vorgabe.Vorgabennummer }}"></a><div class="card mb-4">
|
||||
{% if vorgabe.long_status == "active"%}
|
||||
<div class="card-header d-flex justify-content-between align-items-center bg-secondary text-light">
|
||||
{% elif standard.history == True %}
|
||||
<div class="card-header d-flex justify-content-between align-items-center bg-danger-subtle">
|
||||
{% endif %}
|
||||
<h3 class="h5 m-0">{{ vorgabe.Vorgabennummer }} – {{ vorgabe.titel }}
|
||||
{% if vorgabe.long_status != "active" and standard.history == True %}<span class="text-danger"> ({{ vorgabe.long_status}})</span>{% endif %}
|
||||
</h3>
|
||||
{% if vorgabe.relevanzset %}
|
||||
<span class="badge bg-light text-black"> Relevanz:
|
||||
{{ vorgabe.relevanzset|join:", " }}
|
||||
</span>
|
||||
{% endif %}
|
||||
|
||||
<span class="badge bg-light text-black">{{ vorgabe.thema }}</span>
|
||||
</div>
|
||||
|
||||
<div class="card-body p-0">
|
||||
<!-- Start Kurztext -->
|
||||
{% comment %} KURZTEXT BLOCK {% endcomment %}
|
||||
{% if vorgabe.kurztext_html.0.1 %}
|
||||
<div class="p-3 mb-3 bg-light border-3" style="width: 100%;">
|
||||
{% for typ, html in vorgabe.kurztext_html %}
|
||||
{% if html %}
|
||||
<div class="mb-2">{{ html|safe }}</div>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</div>
|
||||
{% endif %}
|
||||
<!-- Langtext -->
|
||||
<div class="p-3 mb-3">
|
||||
{% comment %} LANGTEXT BLOCK {% endcomment %}
|
||||
{# <h5>Langtext</h5> #}
|
||||
{% for typ, html in vorgabe.langtext_html %}
|
||||
{% if html %}<div class="mb-3">{{ html|safe }}</div>{% endif %}
|
||||
{% endfor %}
|
||||
<!-- Checklistenfragen -->
|
||||
{% comment %} CHECKLISTENFRAGEN BLOCK {% endcomment %}
|
||||
<h5>Checklistenfragen</h5>
|
||||
{% if vorgabe.checklistenfragen.all %}
|
||||
<ul class="list-group">
|
||||
{% for frage in vorgabe.checklistenfragen.all %}
|
||||
<li class="list-group-item">{{ frage.frage }}</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% else %}
|
||||
<p><em>Keine Checklistenfragen</em></p>
|
||||
{% endif %}
|
||||
{% comment %} STICHWORTE + REFERENZEN AT BOTTOM {% endcomment %}
|
||||
<div class="mt-4 small text-muted">
|
||||
<strong>Stichworte:</strong>
|
||||
{% if vorgabe.stichworte.all %}
|
||||
{% for s in vorgabe.stichworte.all %}
|
||||
<a href="{% url 'stichwort_detail' stichwort=s %}">{{ s }}</a>{% if not forloop.last %}, {% endif %}
|
||||
{% endfor %}
|
||||
{% else %}
|
||||
<em>Keine</em>
|
||||
{% endif %}
|
||||
<br>
|
||||
<strong>Referenzen:</strong>
|
||||
{% if vorgabe.referenzpfade %}
|
||||
{% for ref in vorgabe.referenzpfade %}
|
||||
{{ ref|safe }}{% if not forloop.last %}, {% endif %}
|
||||
{% endfor %}
|
||||
{% else %}
|
||||
<em>Keine</em>
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% endblock %}
|
||||
@@ -1,3 +0,0 @@
|
||||
from django.test import TestCase
|
||||
|
||||
# Create your tests here.
|
||||
@@ -1,11 +0,0 @@
|
||||
from django.urls import path
|
||||
from . import views
|
||||
|
||||
urlpatterns = [
|
||||
path('', views.standard_list, name='standard_list'),
|
||||
path('<str:nummer>/', views.standard_detail, name='standard_detail'),
|
||||
path('<str:nummer>/history/<str:check_date>/', views.standard_detail),
|
||||
path('<str:nummer>/history/', views.standard_detail, {"check_date":"today"}, name='standard_history'),
|
||||
path('<str:nummer>/checkliste/', views.standard_checkliste, name='standard_checkliste')
|
||||
]
|
||||
|
||||
@@ -1,58 +0,0 @@
|
||||
from django.shortcuts import render, get_object_or_404
|
||||
from .models import Dokument
|
||||
from abschnitte.utils import render_textabschnitte
|
||||
|
||||
from datetime import date
|
||||
import parsedatetime
|
||||
|
||||
calendar=parsedatetime.Calendar()
|
||||
|
||||
|
||||
def standard_list(request):
|
||||
standards = Dokument.objects.all()
|
||||
return render(request, 'standards/standard_list.html',
|
||||
{'standards': standards}
|
||||
)
|
||||
|
||||
|
||||
def standard_detail(request, nummer,check_date=""):
|
||||
standard = get_object_or_404(Dokument, nummer=nummer)
|
||||
|
||||
if check_date:
|
||||
check_date = calendar.parseDT(check_date)[0].date()
|
||||
standard.history = True
|
||||
else:
|
||||
check_date = date.today()
|
||||
standard.history = False
|
||||
standard.check_date=check_date
|
||||
vorgaben = list(standard.vorgaben.order_by("thema","nummer").select_related("thema","dokument")) # convert queryset to list so we can attach attributes
|
||||
|
||||
standard.geltungsbereich_html = render_textabschnitte(standard.geltungsbereich_set.order_by("order").select_related("abschnitttyp"))
|
||||
standard.einleitung_html=render_textabschnitte(standard.einleitung_set.order_by("order"))
|
||||
for vorgabe in vorgaben:
|
||||
# Prepare Kurztext HTML
|
||||
vorgabe.kurztext_html = render_textabschnitte(vorgabe.vorgabekurztext_set.order_by("order").select_related("abschnitttyp","abschnitt"))
|
||||
vorgabe.langtext_html = render_textabschnitte(vorgabe.vorgabelangtext_set.order_by("order").select_related("abschnitttyp","abschnitt"))
|
||||
vorgabe.long_status=vorgabe.get_status(check_date,verbose=True)
|
||||
vorgabe.relevanzset=list(vorgabe.relevanz.all())
|
||||
|
||||
referenz_items = []
|
||||
for r in vorgabe.referenzen.all():
|
||||
referenz_items.append(r.Path())
|
||||
vorgabe.referenzpfade = referenz_items
|
||||
|
||||
return render(request, 'standards/standard_detail.html', {
|
||||
'standard': standard,
|
||||
'vorgaben': vorgaben,
|
||||
})
|
||||
|
||||
|
||||
def standard_checkliste(request, nummer):
|
||||
standard = get_object_or_404(Dokument, nummer=nummer)
|
||||
vorgaben = list(standard.vorgaben.all())
|
||||
return render(request, 'standards/standard_checkliste.html', {
|
||||
'standard': standard,
|
||||
'vorgaben': vorgaben,
|
||||
})
|
||||
|
||||
|
||||
@@ -1,15 +1,40 @@
|
||||
/* Style each Vorgabe inline block */
|
||||
.djn-dynamic-form-Standards-vorgabe {
|
||||
border: 2px solid #ccc;
|
||||
.djn-dynamic-form-Standards-vorgabe,
|
||||
.djn-dynamic-form-dokumente-vorgabe {
|
||||
border: 3px solid #2c5aa0;
|
||||
border-radius: 8px;
|
||||
padding: 15px;
|
||||
margin-bottom: 20px;
|
||||
background-color: #f9f9f9;
|
||||
margin-bottom: 50px;
|
||||
box-shadow: 0 2px 5px rgba(0,0,0,0.1);
|
||||
}
|
||||
|
||||
/* Make Vorgabe title prominent */
|
||||
.djn-dynamic-form-Standards-vorgabe > h3,
|
||||
.djn-dynamic-form-dokumente-vorgabe > h3 {
|
||||
font-size: 18px;
|
||||
font-weight: 700;
|
||||
color: #2c5aa0;
|
||||
margin: -15px -15px 15px -15px;
|
||||
padding: 12px 15px;
|
||||
background: linear-gradient(to bottom, #e8f0f8, #d4e4f3);
|
||||
border-bottom: 2px solid #2c5aa0;
|
||||
border-radius: 5px 5px 0 0;
|
||||
}
|
||||
|
||||
/* Make Vorgabe identifier in tabular view prominent */
|
||||
tbody.djn-dynamic-form-Standards-vorgabe td.original,
|
||||
tbody.djn-dynamic-form-dokumente-vorgabe td.original,
|
||||
tbody.djn-dynamic-form-Standards-vorgabe td.original p,
|
||||
tbody.djn-dynamic-form-dokumente-vorgabe td.original p {
|
||||
font-size: 16px !important;
|
||||
font-weight: 700 !important;
|
||||
color: #2c5aa0 !important;
|
||||
}
|
||||
|
||||
/* Optional: Slight padding for inner fieldsets (e.g., Langtext/Kurztext inlines) */
|
||||
.djn-dynamic-form-Standards-vorgabe .inline-related {
|
||||
.djn-dynamic-form-Standards-vorgabe .inline-related,
|
||||
.djn-dynamic-form-dokumente-vorgabe .inline-related {
|
||||
margin-top: 10px;
|
||||
padding-left: 10px;
|
||||
border-left: 2px dashed #ccc;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,21 +1,58 @@
|
||||
window.addEventListener('load', function () {
|
||||
setTimeout(() => {
|
||||
const vorgabenBlocks = document.querySelectorAll('.djn-dynamic-form-Standards-vorgabe');
|
||||
console.log("Found", vorgabenBlocks.length, "Vorgaben blocks");
|
||||
// Try different selectors for nested admin vorgabe elements
|
||||
const selectors = [
|
||||
'.djn-dynamic-form-dokumente-vorgabe',
|
||||
'.djn-dynamic-form-Standards-vorgabe',
|
||||
'.inline-related[data-inline-type="stacked"]',
|
||||
'.nested-inline'
|
||||
];
|
||||
|
||||
let vorgabenBlocks = [];
|
||||
for (const selector of selectors) {
|
||||
vorgabenBlocks = document.querySelectorAll(selector);
|
||||
if (vorgabenBlocks.length > 0) {
|
||||
console.log("Found", vorgabenBlocks.length, "Vorgaben blocks with selector:", selector);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (vorgabenBlocks.length === 0) {
|
||||
console.log("No Vorgaben blocks found, trying fallback...");
|
||||
// Fallback: look for any inline with vorgabe in the class
|
||||
vorgabenBlocks = document.querySelectorAll('[class*="vorgabe"]');
|
||||
}
|
||||
|
||||
vorgabenBlocks.forEach((block, index) => {
|
||||
const header = document.createElement('div');
|
||||
header.className = 'vorgabe-toggle-header';
|
||||
header.innerHTML = `▼ Vorgabe ${index + 1}`;
|
||||
header.style.cursor = 'pointer';
|
||||
|
||||
block.parentNode.insertBefore(header, block);
|
||||
|
||||
header.addEventListener('click', () => {
|
||||
const isHidden = block.style.display === 'none';
|
||||
block.style.display = isHidden ? '' : 'none';
|
||||
header.innerHTML = `${isHidden ? '▼' : '▶'} Vorgabe ${index + 1}`;
|
||||
});
|
||||
// Find the existing title/header within the vorgabe block
|
||||
const existingHeader = block.querySelector('h3, .inline-label, .module h2, .djn-inline-header');
|
||||
|
||||
if (existingHeader) {
|
||||
// Make the existing header clickable for collapse/expand
|
||||
existingHeader.style.cursor = 'pointer';
|
||||
existingHeader.addEventListener('click', (e) => {
|
||||
e.preventDefault();
|
||||
e.stopPropagation();
|
||||
|
||||
// Find all content to collapse - everything except the header itself
|
||||
const allChildren = Array.from(block.children);
|
||||
const contentElements = allChildren.filter(child => child !== existingHeader && !child.contains(existingHeader));
|
||||
|
||||
contentElements.forEach(element => {
|
||||
const isHidden = element.style.display === 'none';
|
||||
element.style.display = isHidden ? '' : 'none';
|
||||
});
|
||||
|
||||
// Update the header text to show collapse state
|
||||
const originalText = existingHeader.textContent.replace(/[▼▶]\s*/, '');
|
||||
const anyHidden = contentElements.some(el => el.style.display === 'none');
|
||||
existingHeader.innerHTML = `${anyHidden ? '▶' : '▼'} ${originalText}`;
|
||||
});
|
||||
|
||||
// Add initial collapse indicator
|
||||
const originalText = existingHeader.textContent;
|
||||
existingHeader.innerHTML = `▼ ${originalText}`;
|
||||
}
|
||||
});
|
||||
}, 500); // wait 500ms to allow nested inlines to render
|
||||
}, 1000); // wait longer to allow nested inlines to render
|
||||
});
|
||||
|
||||
@@ -11,4 +11,93 @@
|
||||
margin-bottom: 1em;
|
||||
border: 1px solid #ccc;
|
||||
padding: 0;
|
||||
}
|
||||
}
|
||||
|
||||
/* Comment System Styles */
|
||||
.comment-btn {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.comment-btn .comment-count {
|
||||
position: absolute;
|
||||
top: -8px;
|
||||
right: -8px;
|
||||
background-color: #dc3545;
|
||||
color: white;
|
||||
border-radius: 50%;
|
||||
width: 20px;
|
||||
height: 20px;
|
||||
font-size: 11px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.comment-item {
|
||||
max-width: 100%;
|
||||
word-wrap: break-word;
|
||||
overflow-wrap: break-word;
|
||||
}
|
||||
|
||||
.comment-item .text-muted {
|
||||
font-size: 0.85em;
|
||||
}
|
||||
|
||||
#commentModal .modal-body {
|
||||
max-height: 60vh;
|
||||
overflow-y: auto;
|
||||
}
|
||||
|
||||
#commentsContainer {
|
||||
min-height: 100px;
|
||||
}
|
||||
|
||||
.delete-comment-btn {
|
||||
opacity: 0.7;
|
||||
transition: opacity 0.2s;
|
||||
}
|
||||
|
||||
.delete-comment-btn:hover {
|
||||
opacity: 1;
|
||||
}
|
||||
|
||||
.delete-comment-btn {
|
||||
font-size: 18px;
|
||||
font-weight: bold;
|
||||
line-height: 1;
|
||||
color: #721c24;
|
||||
border: 1px solid #f5c6cb;
|
||||
border-radius: 4px;
|
||||
width: 28px;
|
||||
height: 28px;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.delete-comment-btn:hover {
|
||||
opacity: 1;
|
||||
background-color: #f8d7da;
|
||||
border-color: #f5c6cb;
|
||||
}
|
||||
|
||||
/* Icon styling for emoji replacements */
|
||||
.emoji-icon {
|
||||
font-size: 1.1em;
|
||||
margin-right: 0.3em;
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
/* Responsive adjustments */
|
||||
@media (max-width: 768px) {
|
||||
.comment-item .d-flex {
|
||||
flex-direction: column;
|
||||
}
|
||||
|
||||
.delete-comment-btn {
|
||||
margin-left: 0 !important;
|
||||
margin-top: 0.5rem;
|
||||
}
|
||||
}
|
||||
10
static/swiss/css/admin.css
Executable file
10
static/swiss/css/admin.css
Executable file
File diff suppressed because one or more lines are too long
BIN
static/swiss/css/images/2-klick-logo.jpg
Normal file
BIN
static/swiss/css/images/2-klick-logo.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 90 KiB |
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user