dbca-utils 3.0.7

Utilities for DBCA Django apps

Overview

DBCA Django utility classes and functions.

Requirements

• Python 3.12 or later
• Django 5.2 or later

Development

Dependencies for this project are managed using uv. With uv installed, change into the project directory and run:

uv sync

Activate the virtualenv like so:

source .venv/bin/activate

Run unit tests using pytest (or tox, to test against multiple Python versions):

pytest -sv
tox -v

Releases

Tagged releases are built and pushed to PyPI automatically using a GitHub workflow in the project. Update the project version in pyproject.toml and tag the required commit with the same value to trigger a release. Packages can also be built and uploaded manually to PyPI using uv, if required:

uv build
uv publish

Installation

1. Install via uv/pip/etc.: pip install dbca-utils

SSO Login Middleware

This will automatically login and create users using headers from an upstream proxy (REMOTE_USER and some others). The logout view will redirect to a separate logout page which clears the SSO session.

Usage

Add dbca_utils.middleware.SSOLoginMiddleware to settings.MIDDLEWARE (after both of django.contrib.sessions.middleware.SessionMiddleware and django.contrib.auth.middleware.AuthenticationMiddleware. Ensure that AUTHENTICATION_BACKENDS contains django.contrib.auth.backends.ModelBackend, as this middleware depends on it for retrieving the logged in user for a session. Note that the middleware will still work without it, but will reauthenticate the session on every request, and request.user.is_authenticated won't work properly/will be false.

Example:

MIDDLEWARE = [
    ...,
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'dbca_utils.middleware.SSOLoginMiddleware'
    ...,
]

Audit model mixin

AuditMixin is an extension of Django.db.model.Model that adds a number of additional fields:

• creator - FK to AUTH_USER_MODEL, used to record the object creator
• modifier - FK to AUTH_USER_MODEL, used to record who the object was last modified by
• created - a timestamp that is set on initial object save
• modified - an auto-updating timestamp (on each object save)

Healthcheck feature

Requirements

• Django 5.2 or later
• Declared the default cache and also the cache is shared by all pod instances
• The image has the command 'ps' which is used to collect the cpu and memory data

Usage

• Install the app 'dbca_utils' in INSTALLED_APPS
• Service Configuration
  • HEALTHCHECK_ENABLED: Optional. enable/disable the healthcheck service. default is 'true'
  • PROCESS_FILTER: Optional. find the web app related processes from command 'ps aux'. default is '| grep python'
  • CACHE_PREFIX: Optional. used as the prefix of the cache key. default is ''
  • PORT: Optional. The listening port of the web application. default is '8080'
  • WORKLOADS: Optional. Used if the web app has a fixed replicas.
  • WORKLOAD_DEPLOYMENT: Optional. the workload is deployment if it is true; otherwise it is statefulset. default is 'true'
  • WORKLOAD_FAILED_THRESHOLD: Optional. The number of continuous failed times to treat a pod is offline.
• Nginx Configuration.
  • Add a location 'location /healthcheck/' and configure it to use basic auth in nginx.
• Access the url : https://xxx.dbca.wa.gov.au/healthcheck/healthdata to get the health json data