mreg-cli 1.2.1__tar.gz → 1.2.2__tar.gz

{mreg_cli-1.2.1 → mreg_cli-1.2.2}/.github/workflows/test.yml

@@ -14,20 +14,15 @@ jobs:
         python-version:
           - '3.11'
           - '3.12'
+          - '3.13'
     env:
       # Disable colors and formatting in Rich console output
       TERM: dumb
     steps:
       - name: Checkout
         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 mreg-cli
-        run: uv sync
       - name: Test and compare api calls
-        run: uv run ci/run_testsuite_and_record.sh
+        run: ci/run_testsuite_and_record_V2.sh ${{ matrix.python-version }}
 
   tox:
     name: tox
@@ -68,6 +63,7 @@ jobs:
         python-version:
           - "3.11"
           - "3.12"
+          - '3.13'
     steps:
       - uses: actions/checkout@v4
       - name: Install uv
@@ -77,4 +73,4 @@ jobs:
       - name: Install dependencies
         run: uv sync
       - name: Run unittest
-        run: uv run pytest
+        run: uv run pytest

{mreg_cli-1.2.1 → mreg_cli-1.2.2}/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- ## Unreleased -->
 
+## [1.2.2](https://github.com/unioslo/mreg-cli/releases/tag/1.2.2) - 2024-12-09
+
+### Fixed
+
+- `dhcp assoc` and `host add` commands displaying unique constraint error instead of a proper error message when a MAC is already associated with an IP.
+- Validation errors causing the application to crash instead of displaying a proper error message.
+
 ## [1.2.1](https://github.com/unioslo/mreg-cli/releases/tag/1.2.1) - 2024-12-02
 
 ### Fixed

{mreg_cli-1.2.1 → mreg_cli-1.2.2}/CONTRIBUTING

@@ -9,6 +9,10 @@ If you would like to contribute to this project, please follow these steps:
 5. Push to the branch (`git push origin feature/branch-name`)
 6. Create a Pull Request
 
+## Testing
+
+To run tests locally, just run the script `ci/run_testsuite_and_record_V2.sh` from anywhere. The only prerequisite is a working installation of docker or podman.
+
 ## Publishing
 
 Publishing new versions is automatically handled by GitHub actions for versions tagged with `x.y.z[.prerelease]` (`1.2.3`, `1.2.3.rc1`, etc.). If you are a maintainer, you can create a new release by following these steps:

{mreg_cli-1.2.1 → mreg_cli-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mreg-cli
-Version: 1.2.1
+Version: 1.2.2
 Summary: MREG interactive command line client
 Author: Others (see AUTHORS)
 Author-email: Øyvind Kolbu <oyvind.kolbu@usit.uio.no>, Safet A <amedov@usit.uio.no>, Magnus Hirth <mhmorgan42@gmail.com>, Nico <nicolaydmohebi@gmail.com>, Marius Bakke <marius.bakke@usit.uio.no>, Fredrik Larsen <fredrik.larsen@usit.uio.no>, Paal Braathen <paal.braathen@usit.uio.no>, Nils Hiorth <nils@nls.me>, Dmytro Karpenko <dmytrok@usit.uio.no>

mreg_cli-1.2.2/ci/Dockerfile

@@ -0,0 +1,13 @@
+# This container image is only used temporarily for testing during a CI process.
+FROM ubuntu:latest
+ARG python_version=3.12
+
+RUN apt-get -qq update
+RUN apt-get -y install curl git >/dev/null
+RUN curl -LsSf https://astral.sh/uv/0.5.6/install.sh | sh
+RUN /root/.local/bin/uv self update -q
+RUN /root/.local/bin/uv python install ${python_version}
+COPY . /build
+RUN cd /build; /root/.local/bin/uv sync -q
+
+CMD cd /build/ci; /root/.local/bin/uv run bash -c 'echo "test" | mreg-cli -u test -d example.org --url http://127.0.0.1:8000 --source testsuite --record new_testsuite_log.json --record-without-timestamps -v ERROR >/dev/null'

{mreg_cli-1.2.1 → mreg_cli-1.2.2}/ci/diff.py

@@ -290,8 +290,8 @@ class CommandDiffer:
                     new_testsuite_results.append(expected.original)
                     self.diff_unresolved += 1
             else:
-                # No diff, keep new line
-                new_testsuite_results.append(result.original)
+                # No diff, keep old line
+                new_testsuite_results.append(expected.original)
 
         # Only write back changes if we are in review mode and there are changes
         if self.review and self.diff_resolved > 0:

mreg_cli-1.2.2/ci/run_testsuite_and_record_V2.sh

@@ -0,0 +1,88 @@
+#!/bin/bash
+
+# exit immediately on error
+set -e
+
+# check if we have docker or podman
+if command -v docker >/dev/null 2>&1 && ! docker 2>&1 | grep -q podman; then
+	echo "Using Docker"
+	GH_PARAMS="--ansi=never"
+elif command -v podman >/dev/null 2>&1; then
+	echo "Using Podman"
+	GH_PARAMS="--no-ansi"
+	PODMAN=1
+	alias docker=podman
+else
+	echo "Found neither docker nor podman."
+	exit 1
+fi
+
+# clean up on exit, even if something fails
+function cleanup {
+	set +e
+	if [[ -n "$GITHUB_ACTIONS" ]]; then
+		docker compose $GH_PARAMS down
+	else
+		docker compose down
+	fi
+	docker ps -a | grep "mreg-" | awk '{print $1}' | xargs -r docker stop
+	docker ps -a | grep "mreg-" | awk '{print $1}' | xargs -r docker rm
+	docker images | grep "mreg-" | awk '{print $1}' | xargs -r docker rmi
+	rm -f new_testsuite_log.json
+	echo "cleanup done."
+}
+trap cleanup EXIT
+
+# chdir to where this script is
+cd `dirname $0`
+
+# get Python version from argument
+PYTHON_VERSION=3.12
+if [ ! -z "$1" ]; then
+	PYTHON_VERSION=$1
+fi
+echo "Python version $PYTHON_VERSION"
+
+# build a container image for mreg-cli
+docker build -f Dockerfile -t mreg-cli --build-arg python_version=$PYTHON_VERSION ..
+
+# start mreg+postgres in containers
+if [[ -n "$GITHUB_ACTIONS" ]]; then
+	if [[ "$PODMAN" == "1" ]]; then
+		docker compose $GH_PARAMS pull >/dev/null 2>&1
+	else
+		docker compose $GH_PARAMS pull --quiet
+	fi
+	docker compose $GH_PARAMS up -d
+else
+	docker compose up -d
+fi
+
+# give mreg some time to create the database schema and start up
+sleep 5s
+
+# create a superuser
+if docker exec -t mreg uv version >/dev/null; then
+	docker exec -t mreg uv run /app/manage.py create_mreg_superuser --username test --password test
+else
+	docker exec -t mreg /app/manage.py create_mreg_superuser --username test --password test
+fi
+
+# test connectivity
+#docker run --rm --tty --network host --entrypoint curl mreg-cli --head http://127.0.0.1:8000/admin/login/
+
+# start the mreg-cli container, which will automatically run the test suite
+echo "Running the tests..."
+docker run --name mreg-cli --network host --tty mreg-cli
+docker commit mreg-cli finished-mreg-tests # because inside is the file new_testsuite_log.json which we want to look at
+
+# show a detailed diff (and review if running locally)
+if [[ -n "$GITHUB_ACTIONS" ]]; then
+	docker run --rm --tty --entrypoint bash finished-mreg-tests -c 'cd /build/ci; /root/.local/bin/uv run diff.py testsuite-result.json new_testsuite_log.json'
+	exit $?
+else
+	docker run -it --name finished-mreg-tests --entrypoint bash finished-mreg-tests -c 'cd /build/ci; /root/.local/bin/uv run diff.py testsuite-result.json new_testsuite_log.json --review'
+	EXITCODE=$?
+	docker cp finished-mreg-tests:/build/ci/testsuite-result.json .
+	exit $EXITCODE
+fi

{mreg_cli-1.2.1 → mreg_cli-1.2.2}/ci/testsuite-result.json

@@ -17441,7 +17441,7 @@
     "command_filter_negate": false,
     "command_issued": "policy host_remove fruit foo",
     "ok": [
-      "Removed host foo.example.org from role 'fruit'"
+      "Removed host 'foo.example.org' from role 'fruit'"
     ],
     "warning": [],
     "error": [],
@@ -23730,57 +23730,6 @@
           "comment": "This is the comment",
           "zone": 1
         }
-      },
-      {
-        "method": "GET",
-        "url": "/api/v1/hosts/?id=14",
-        "data": {},
-        "status": 200,
-        "response": {
-          "count": 1,
-          "next": null,
-          "previous": null,
-          "results": [
-            {
-              "ipaddresses": [
-                {
-                  "macaddress": "",
-                  "ipaddress": "10.0.0.14",
-                  "host": 14
-                },
-                {
-                  "macaddress": "11:22:33:44:55:66",
-                  "ipaddress": "10.0.0.15",
-                  "host": 14
-                }
-              ],
-              "cnames": [
-                {
-                  "name": "fubar.example.org",
-                  "ttl": null,
-                  "zone": 1,
-                  "host": 14
-                }
-              ],
-              "mxs": [],
-              "txts": [
-                {
-                  "txt": "v=spf1 -all",
-                  "host": 14
-                }
-              ],
-              "ptr_overrides": [],
-              "hinfo": null,
-              "loc": null,
-              "bacnetid": null,
-              "name": "bar.example.org",
-              "contact": "me@example.org",
-              "ttl": null,
-              "comment": "This is the comment",
-              "zone": 1
-            }
-          ]
-        }
       }
     ],
     "time": null
@@ -27536,7 +27485,7 @@
     "command_issued": "host add -ip 10.0.0.0/24 -macaddress aa:bb:cc:cc:bb:aa directfail",
     "ok": [],
     "warning": [
-      "MAC address aa:bb:cc:cc:bb:aa is already associated with 10.0.0.4"
+      "MAC address aa:bb:cc:cc:bb:aa is already associated with IP address 10.0.0.184, must force."
     ],
     "error": [],
     "output": [],
@@ -27553,7 +27502,7 @@
           "results": [
             {
               "macaddress": "aa:bb:cc:cc:bb:aa",
-              "ipaddress": "10.0.0.4",
+              "ipaddress": "10.0.0.184",
               "host": 18
             }
           ]

{mreg_cli-1.2.1 → mreg_cli-1.2.2}/mreg_cli/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.2.1'
-__version_tuple__ = version_tuple = (1, 2, 1)
+__version__ = version = '1.2.2'
+__version_tuple__ = version_tuple = (1, 2, 2)

mreg_cli-1.2.2/mreg_cli/api/fields.py

@@ -0,0 +1,172 @@
+"""Custom field types for Pydantic models.
+
+The types validate to basic types like str, int, etc., but with additional
+validation added to them. The types are used in Pydantic models for consistent
+validation of common fields such as hostnames, MAC addresses, etc.
+
+Warning:
+Values constructed from these types should NOT be checked at runtime with isinstance()!
+Pydantic will always coerce these types to their schema types (str, int, etc.).
+
+"""
+
+from __future__ import annotations
+
+import logging
+import re
+from typing import Annotated, Any
+
+from pydantic import AfterValidator, BeforeValidator, GetCoreSchemaHandler
+from pydantic_core import core_schema
+from pydantic_extra_types.mac_address import MacAddress as PydanticMacAddress
+
+from mreg_cli.config import MregCliConfig
+from mreg_cli.exceptions import InputFailure
+from mreg_cli.types import get_type_adapter
+
+logger = logging.getLogger(__name__)
+
+
+class HostName(str):
+    """Hostname string type."""
+
+    @classmethod
+    def parse(cls, obj: Any) -> HostName | None:
+        """Parse a hostname from a string. Returns None if the hostname is invalid.
+
+        :param obj: The object to parse.
+        :returns: The hostname as a string or None if it is invalid.
+        """
+        try:
+            return cls.parse_or_raise(obj)
+        except InputFailure:
+            return None
+
+    @classmethod
+    def parse_or_raise(cls, obj: Any) -> HostName:
+        """Parse a hostname from a string. Returns the hostname as a string.
+
+        :param obj: The object to parse.
+        :returns: The hostname as a string.
+        :raises ValueError: If the object is not a valid hostname.
+        """
+        try:
+            adapter = get_type_adapter(cls)
+            return cls(adapter.validate_python(obj))
+        except ValueError as e:
+            raise InputFailure(f"Invalid hostname '{obj}'") from e
+
+    @staticmethod
+    def validate_hostname(value: str) -> str:
+        """Validate the hostname."""
+        value = value.lower()
+
+        if re.search(r"^(\*\.)?([a-z0-9_][a-z0-9\-]*\.?)+$", value) is None:
+            raise InputFailure(f"Invalid input for hostname: {value}")
+
+        # Assume user is happy with domain, but strip the dot.
+        if value.endswith("."):
+            return value[:-1]
+
+        # If a dot in name, assume long name.
+        if "." in value:
+            return value
+
+        config = MregCliConfig()
+        default_domain = config.get("domain")
+        # Append domain name if in config and it does not end with it
+        if default_domain and not value.endswith(default_domain):
+            return f"{value}.{default_domain}"
+        return value
+
+    @classmethod
+    def __get_pydantic_core_schema__(
+        cls, source: type[Any], handler: GetCoreSchemaHandler
+    ) -> core_schema.CoreSchema:
+        """Return a Pydantic CoreSchema with the hostname validation.
+
+        :param source: The source type to be converted.
+        :param handler: The handler to get the CoreSchema.
+        :returns: A Pydantic CoreSchema with the hostname validation.
+
+        """
+        return core_schema.with_info_before_validator_function(
+            cls._validate,
+            core_schema.str_schema(),
+        )
+
+    @classmethod
+    def _validate(cls, __input_value: str, _: Any) -> str:
+        """Validate a hostname from the provided str value.
+
+        Args:
+            __input_value: The str value to be validated.
+            _: The source type to be converted.
+
+        Returns:
+            str: The parsed hostname.
+
+        """
+        return cls.validate_hostname(__input_value)
+
+
+class MacAddress(PydanticMacAddress):
+    """MAC address string type used in Pydantic models."""
+
+    @classmethod
+    def parse(cls, obj: Any) -> MacAddress | None:
+        """Parse a MAC address from a string. Returns None if the MAC address is invalid.
+
+        :param obj: The object to parse.
+        :returns: The MAC address as a string or None if it is invalid.
+        """
+        try:
+            return cls.parse_or_raise(obj)
+        except InputFailure:
+            return None
+
+    @classmethod
+    def parse_or_raise(cls, obj: Any) -> MacAddress:
+        """Parse a MAC address from a string. Returns the MAC address as a string.
+
+        :param obj: The object to parse.
+        :returns: The MAC address as a string.
+        :raises ValueError: If the object is not a valid MAC address.
+        """
+        try:
+            adapter = get_type_adapter(cls)
+            return cls(adapter.validate_python(obj))
+        except ValueError as e:
+            raise InputFailure(f"Invalid MAC address '{obj}'") from e
+
+
+def _extract_name(value: Any) -> str:
+    """Extract the "name" value from a dictionary.
+
+    :param v: Dictionary containing the name.
+    :returns: Extracted name as a string.
+    """
+    if isinstance(value, dict):
+        try:
+            return str(value["name"])  # pyright: ignore[reportUnknownArgumentType]
+        except KeyError:
+            logger.error("No 'name' key in %s", value)  # pyright: ignore[reportUnknownArgumentType]
+            return ""
+    return value
+
+
+def _remove_falsy_list_items(value: Any) -> Any:
+    """Remove falsy items from a list.
+
+    For use in validators only.
+    """
+    if isinstance(value, list):
+        return [i for i in value if i]  # pyright: ignore[reportUnknownVariableType]
+    return value
+
+
+NameList = Annotated[
+    list[Annotated[str, BeforeValidator(_extract_name)]],
+    AfterValidator(_remove_falsy_list_items),
+]
+"""List of names extracted from a list of dicts."""