mreg-api 0.2.2__tar.gz → 0.3.0__tar.gz

mreg_api-0.3.0/.github/workflows/test.yml

@@ -0,0 +1,52 @@
+on:
+  push:
+  pull_request:
+
+env:
+  UV_FROZEN: 1
+
+name: Tests
+jobs:
+  unit:
+    name: Unit tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: uv sync
+      - name: Run unit tests
+        run: bash ci/run_tests.sh --unit-only --no-cov
+
+  integration:
+    name: Integration tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: uv sync
+      - name: Run integration tests
+        run: bash ci/run_tests.sh --integration-only --no-cov

{mreg_api-0.2.2 → mreg_api-0.3.0}/.gitignore

@@ -110,3 +110,8 @@ venv.bak/
 mreg/.idea
 
 *.log
+
+# Claude
+.claude/settings.local.json
+CLAUDE.local.md
+!.claude/CLAUDE.md

{mreg_api-0.2.2 → mreg_api-0.3.0}/CHANGELOG.md

@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- ## Unreleased -->
 
+## [0.3.0](https://github.com/unioslo/mreg-api/releases/tag/0.3.0) - 2026-08-12
+
+### Added
+
+- `Host.get_community_associations(name: str)` method to retrieve all ipaddress->community associations for the host with the given community name.
+- `Network.get_communities(name: str)` method to retrieve all communities with the given name.
+
+### Changed
+
+- **BREAKING**: `MregClient` is no longer a singleton. Each instance is independent and maintains its own state. The `MregClient.get_instance()` method has been removed. Each instantiation of `MregClient` is now independent and maintains its own state, including history, events and cache.
+- `Network.get_community()` now ignores case when searching for communities by name. It returns the first community with the given name, or None if not found.
+
+
+### Removed
+
+- **BREAKING**: `MregClient.reset_instance` removed because the singleton pattern has been removed.
+
+## [0.2.3](https://github.com/unioslo/mreg-api/releases/tag/0.2.3) - 2026-05-21
+
+### Fixed
+
+- Fixed `NAPTR` fields missing defaults after removal of nullability.
+
 ## [0.2.2](https://github.com/unioslo/mreg-api/releases/tag/0.2.2) - 2026-04-23
 
 ### Changed

{mreg_api-0.2.2 → mreg_api-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mreg-api
-Version: 0.2.2
+Version: 0.3.0
 Summary: MREG API
 Author-email: Terje Kvernes <terjekv@uio.no>
 Maintainer-email: Peder Hovdan Andresen <pederhan@uio.no>
@@ -692,7 +692,7 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: httpx[socks]>=0.28.1
-Requires-Dist: typing_extensions>=4.12.0
+Requires-Dist: typing-extensions>=4.16.0
 Requires-Dist: pydantic>=2.12
 Requires-Dist: pydantic-extra-types>=2.1.0
 Requires-Dist: diskcache>=5.6.3

mreg_api-0.3.0/TESTING.md

@@ -0,0 +1,136 @@
+# Testing
+
+mreg-api has two types of tests:
+
+- **Unit tests** — Unit testing of functions and methods used by the package. No interaction with a live mreg server is required.
+- **Integration tests** — Run against a live (containerized) mreg server. Skipped automatically when no server URL is configured.
+
+## Unit tests
+
+Unit tests use `pytest-httpserver` to mock MREG server responses for any tests that require HTTP interactions. No external services required.
+
+Bare `pytest` invocations ignore integration tests (skipped automatically when no server URL is configured):
+
+```bash
+uv run pytest
+```
+
+In case some configuration defines `MREG_URL`, unit tests can still be run exclusively by ignoring the integration tests via markers:
+
+```bash
+uv run pytest -m "not integration"
+```
+
+## Integration tests
+
+Integration tests run against a live mreg server. They are **skipped automatically** when no server URL is configured, so `uv run pytest` never fails due to a missing server.
+
+### Prerequisites
+
+A running mreg instance (and PostgreSQL). The fastest way is the containerized setup:
+
+```bash
+bash ci/run_tests.sh
+
+# If port 8000 is already in use (e.g., a local mreg dev server):
+MREG_PORT=8081 bash ci/run_tests.sh
+```
+
+This starts containers, creates a superuser, then runs both unit and integration tests with combined coverage output in `htmlcov/`.
+
+Flags:
+
+| Flag | Effect |
+|---|---|
+| `--unit-only` | Skip integration tests (no containers started) |
+| `--integration-only` | Skip unit tests |
+| `--no-cov` | Disable coverage. Used in CI |
+
+```bash
+# Fast run without coverage
+bash ci/run_tests.sh --no-cov
+```
+
+### Running manually against a local server
+
+```bash
+# Minimal — username/password default to "test"
+MREG_URL=http://127.0.0.1:8000 uv run pytest tests/integration/
+
+# All options explicit
+MREG_URL=http://127.0.0.1:8000 \
+MREG_USERNAME=myuser \
+MREG_PASSWORD=secret \
+MREG_DOMAIN=example.com \
+MREG_CACHE=0 \
+MREG_TEST_NETWORK=10.0.0.0/8 \
+  uv run pytest tests/integration/ -v
+
+# Via CLI flags instead of env vars
+uv run pytest tests/integration/ \
+  --mreg-url http://127.0.0.1:8000 \
+  --mreg-username myuser \
+  --mreg-password secret
+```
+
+### Configuration
+
+| Env var | CLI flag | Default | Description |
+|---|---|---|---|
+| `MREG_URL` | `--mreg-url` | *(none — required to activate integration tests)* | mreg server base URL |
+| `MREG_USERNAME` | `--mreg-username` | `test` | Login username |
+| `MREG_PASSWORD` | `--mreg-password` | `test` | Login password |
+| `MREG_DOMAIN` | `--mreg-domain` | `example.com` | Default domain for the client. Controls the main zone used in integration tests |
+| `MREG_CACHE` | `--mreg-cache` | `false` | Enable mreg client cache (`1`/`true`/`yes` = on) |
+| `MREG_TEST_NETWORK` | `--test-network` | `10.0.0.0/8` | Network CIDR created as shared test network |
+| `MREG_TEST_IP` | `--test-ip` | `10.0.0.1` | IP address used in IP-related tests |
+
+CLI flags take precedence over env vars.
+
+
+### Subset runs
+
+```bash
+# Read-only tests only (safe against staging/production)
+uv run pytest tests/integration/ -m readonly
+
+# Single resource type
+uv run pytest tests/integration/test_labels.py
+
+# Specific test
+uv run pytest tests/integration/test_labels.py::test_delete_by_name
+```
+
+## Coverage
+
+### Unit tests only
+
+```bash
+uv run pytest tests/ --ignore=tests/integration \
+  --cov=mreg_api --cov-report=term-missing
+```
+
+### Combined unit + integration
+
+Run `ci/run_tests.sh` (uses `--cov-append` to merge both passes), or manually:
+
+```bash
+# Pass 1: unit tests — write .coverage
+uv run pytest tests/ --ignore=tests/integration \
+  --cov=mreg_api --cov-report=
+
+# Pass 2: integration tests — append to .coverage
+MREG_URL=http://127.0.0.1:8000 MREG_USERNAME=test MREG_PASSWORD=test \
+  uv run pytest tests/integration/ \
+  --cov=mreg_api --cov-append --cov-report=html --cov-report=term
+
+# Open report
+open htmlcov/index.html
+```
+
+## Markers
+
+| Marker | Meaning |
+|---|---|
+| `integration` | Requires live mreg server — skipped without `MREG_URL` |
+| `readonly` | Test only reads data, safe against staging/production servers |

mreg_api-0.3.0/ci/Dockerfile

@@ -0,0 +1,15 @@
+FROM ubuntu:latest
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    curl \
+    git \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN curl -LsSf https://astral.sh/uv/install.sh | sh
+ENV PATH="/root/.local/bin:$PATH"
+
+RUN uv python install 3.12
+
+WORKDIR /build
+COPY . .
+RUN uv sync -q

mreg_api-0.3.0/ci/docker-compose.yml

@@ -0,0 +1,39 @@
+services:
+  postgres:
+    image: postgres
+    environment:
+      POSTGRES_USER: mreg
+      POSTGRES_DB: mreg
+      POSTGRES_PASSWORD: mreg
+    healthcheck:
+      test: ["CMD", "pg_isready", "--username=mreg"]
+      interval: 5s
+      timeout: 5s
+      retries: 10
+
+  mreg:
+    image: ${MREG_IMAGE:-ghcr.io/unioslo/mreg:master}
+    container_name: mreg
+    depends_on:
+      postgres:
+        condition: service_healthy
+    ports:
+      - "${MREG_PORT:-8000}:8000"
+    environment:
+      MREG_DB_HOST: postgres
+      MREG_DB_NAME: mreg
+      MREG_DB_USER: mreg
+      MREG_DB_PASSWORD: mreg
+      MREG_MAP_GLOBAL_COMMUNITY_NAMES: "1"
+      CI: "yes"
+    healthcheck:
+      test: ["CMD", "test", "-f", "/var/run/gunicorn.pid"]
+      interval: 5s
+      timeout: 5s
+      retries: 20
+
+  wait:
+    image: hello-world
+    depends_on:
+      mreg:
+        condition: service_healthy

mreg_api-0.3.0/ci/run_tests.sh

@@ -0,0 +1,94 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+REPO_ROOT="$(dirname "$SCRIPT_DIR")"
+
+RUN_UNIT=true
+RUN_INTEGRATION=true
+RUN_COVERAGE=true
+MREG_IMAGE="${MREG_IMAGE:-ghcr.io/unioslo/mreg:master}"
+# Host port the mreg container is exposed on. Override if 8000 is already in use.
+MREG_PORT="${MREG_PORT:-8000}"
+MREG_URL="${MREG_URL:-http://127.0.0.1:${MREG_PORT}}"
+MREG_USERNAME="${MREG_USERNAME:-test}"
+MREG_PASSWORD="${MREG_PASSWORD:-test}"
+MREG_CACHE="${MREG_CACHE:-0}"
+
+while [[ $# -gt 0 ]]; do
+    case $1 in
+        --unit-only)        RUN_INTEGRATION=false; shift ;;
+        --integration-only) RUN_UNIT=false; shift ;;
+        --no-cov)           RUN_COVERAGE=false; shift ;;
+        *) shift ;;
+    esac
+done
+
+if command -v podman &>/dev/null && ! command -v docker &>/dev/null; then
+    DOCKER=podman
+else
+    DOCKER=docker
+fi
+
+if [[ "$RUN_INTEGRATION" == "true" ]]; then
+    # Check if port is already in use before starting containers
+    if lsof -i ":${MREG_PORT}" 2>/dev/null | grep -q LISTEN; then
+        echo "ERROR: Port ${MREG_PORT} is already in use." >&2
+        echo "Set MREG_PORT to a free port: MREG_PORT=8081 bash ci/run_tests.sh" >&2
+        exit 1
+    fi
+
+    cleanup() {
+        cd "$SCRIPT_DIR"
+        $DOCKER compose down --remove-orphans 2>/dev/null || true
+    }
+    trap cleanup EXIT
+
+    cd "$SCRIPT_DIR"
+
+    echo "Starting mreg and postgres on port ${MREG_PORT}..."
+    MREG_IMAGE="$MREG_IMAGE" MREG_PORT="$MREG_PORT" $DOCKER compose up -d
+
+    echo "Creating superuser..."
+    $DOCKER exec mreg uv run /app/manage.py create_mreg_superuser \
+        --username "$MREG_USERNAME" --password "$MREG_PASSWORD" 2>/dev/null \
+        || $DOCKER exec mreg /app/manage.py create_mreg_superuser \
+            --username "$MREG_USERNAME" --password "$MREG_PASSWORD"
+
+
+fi
+
+cd "$REPO_ROOT"
+
+UNIT_EXIT=0
+INTEGRATION_EXIT=0
+
+if [[ "$RUN_UNIT" == "true" ]]; then
+    echo "Running unit tests..."
+    UNIT_ARGS=(tests/ --ignore=tests/integration -v)
+    if [[ "$RUN_COVERAGE" == "true" ]]; then
+        UNIT_ARGS+=(--cov=mreg_api --cov-report=)
+    else
+        UNIT_ARGS+=(--no-cov)
+    fi
+    uv run pytest "${UNIT_ARGS[@]}" || UNIT_EXIT=$?
+fi
+
+if [[ "$RUN_INTEGRATION" == "true" ]]; then
+    echo "Running integration tests..."
+    INTEGRATION_ARGS=(tests/integration/ -v)
+    if [[ "$RUN_COVERAGE" == "true" ]]; then
+        INTEGRATION_ARGS+=(--cov=mreg_api --cov-append --cov-report=html --cov-report=term)
+    else
+        INTEGRATION_ARGS+=(--no-cov)
+    fi
+    MREG_URL="$MREG_URL" \
+    MREG_USERNAME="$MREG_USERNAME" \
+    MREG_PASSWORD="$MREG_PASSWORD" \
+        uv run pytest "${INTEGRATION_ARGS[@]}" || INTEGRATION_EXIT=$?
+fi
+
+if [[ $UNIT_EXIT -ne 0 || $INTEGRATION_EXIT -ne 0 ]]; then
+    exit 1
+fi
+exit 0

{mreg_api-0.2.2 → mreg_api-0.3.0}/mreg_api/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '0.2.2'
-__version_tuple__ = version_tuple = (0, 2, 2)
+__version__ = version = '0.3.0'
+__version_tuple__ = version_tuple = (0, 3, 0)
 
-__commit_id__ = commit_id = 'ge065b8b90'
+__commit_id__ = commit_id = 'gd440dfea6'

{mreg_api-0.2.2 → mreg_api-0.3.0}/mreg_api/cache.py

@@ -17,6 +17,15 @@ from pydantic import field_serializer
 from mreg_api.exceptions import CacheError
 from mreg_api.exceptions import CacheMiss
 
+__all__ = [
+    "CacheConfig",
+    "MregApiCache",
+    "CacheInfo",
+    "CacheError",
+    "CacheMiss",
+]
+
+
 logger = logging.getLogger(__name__)
 
 
@@ -77,6 +86,10 @@ class CacheConfig(BaseModel):
     directory: str | None = None
 
 
+# NOTE: this class used to make more sense when we had a protocol type for
+# the backend class. Now that the backend class is explicitly `diskcache.Cache`,
+# this class is mostly a wrapper around the cache instance and config.
+# TODO: support other cache types: in-memory, etc.
 @final
 class MregApiCache(Generic[T]):
     """Wrapper around the mreg-api cache.
@@ -93,8 +106,8 @@ class MregApiCache(Generic[T]):
 
     Warning:
         NEVER use `if self._cache` checks! diskcache.Cache implements `__bool__`
-        to check if the cache is non-empty, not whether it exists. Always use
-        `if self._cache is None` instead.
+        to report whether the cache is NON-EMPTY, not whether it EXISTS.
+        Always use `if self._cache is None` instead in this class.
     """
 
     def __init__(self, cache: Cache | None, config: CacheConfig) -> None:
@@ -141,6 +154,18 @@ class MregApiCache(Generic[T]):
         """Disable the cache."""
         self.config.enable = False
 
+    def close(self) -> None:
+        """Close the cache and release resources."""
+        if self._cache is not None:
+            try:
+                self._cache.close()
+            except Exception as e:
+                logger.warning("Failed to close cache: %s", e)
+            finally:
+                # Unbind the object reference, allowing it to be garbage collected
+                # regardless of whether close() succeeded or not.
+                self._cache = None
+
     def get_info(self) -> CacheInfo | None:
         """Get information about the cache.