mreg-cli 1.2.4__tar.gz → 1.4.0__tar.gz

{mreg_cli-1.2.4 → mreg_cli-1.4.0}/.github/workflows/publish.yml

@@ -125,7 +125,7 @@ jobs:
           path: dist
 
       - name: Push build artifacts to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.8.14
+        uses: pypa/gh-action-pypi-publish@release/v1
   
   publish_github:
     name: Publish GitHub release

{mreg_cli-1.2.4 → mreg_cli-1.4.0}/CHANGELOG.md

@@ -7,6 +7,60 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- ## Unreleased -->
 
+## [1.4.0](https://github.com/unioslo/mreg-cli/releases/tag/1.4.0) - 2025-06-20
+
+### Added
+
+- Configurable HTTP request timeout. The timeout can be set with the `--timeout` option or with the `timeout` option in the config file.
+
+### Changed
+
+- Require `-force` for `host {a,aaaa}_remove` if the argument is a CNAME.
+- Require `-force` when using network or broadcast addresses as arguments for the following commands:
+  - `host add`
+  - `host a_add`
+  - `host aaaa_add`
+  - `host a_change`
+  - `host aaaa_change`
+
+### Fixed
+
+- `host info <ip>` command not working for IP addresses associated with multiple hosts.
+
+## [1.3.0](https://github.com/unioslo/mreg-cli/releases/tag/1.3.0) - 2025-05-20
+
+### Added
+
+- Network policy commands:
+  - `network policy_add`
+  - `network policy_create`
+  - `network policy_delete`
+  - `network policy_info`
+  - `network policy_list`
+  - `network policy_rename`
+  - `network policy_remove`
+  - `network policy_set_description`
+  - `network policy_set_prefix`
+  - `network policy_unset_prefix`
+  - `network policy_attribute_add`
+  - `network policy_attribute_create`
+  - `network policy_attribute_delete`
+  - `network policy_attribute_info`
+  - `network policy_attribute_list`
+  - `network policy_attribute_remove`
+  - `network policy_attribute_set_description`
+  - `network community_create`
+  - `network community_delete`
+  - `network community_info`
+  - `network community_list`
+  - `network community_rename`
+  - `network community_set_description`
+  - `network community_host_add`
+  - `network community_host_remove`
+- `network create -policy` option for specifying the policy of the network to create.
+- Error handling for DRF errors.
+- Handling of 404 errors that do not contain a JSON payload.
+
 ## [1.2.4](https://github.com/unioslo/mreg-cli/releases/tag/1.2.4) - 2025-01-30
 
 ### Fixed

{mreg_cli-1.2.4 → mreg_cli-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: mreg-cli
-Version: 1.2.4
+Version: 1.4.0
 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>
@@ -701,6 +701,7 @@ Requires-Dist: typing_extensions>=4.12.0
 Requires-Dist: pydantic[email]>=2.7.1
 Requires-Dist: pydantic-extra-types>=2.1.0
 Requires-Dist: platformdirs>=4.3.0
+Dynamic: license-file
 
 # MREG CLI [![Build Status](https://github.com/unioslo/mreg-cli/actions/workflows/test.yml/badge.svg)](https://github.com/unioslo/mreg-cli/actions/workflows/test.yml)
 

{mreg_cli-1.2.4 → mreg_cli-1.4.0}/ci/diff.py

@@ -7,13 +7,17 @@ import re
 import sys
 import urllib.parse
 from enum import StrEnum
-from typing import Any, Generator, Iterable, NamedTuple
+from typing import Any, Generator, Iterable, Literal, NamedTuple, Self, TypeAlias, overload
 
 from rich import box
 from rich.console import Console, Group
 from rich.markup import escape
 from rich.panel import Panel
 from rich.prompt import Prompt
+from rich.table import Table
+
+ProcessedCommand: TypeAlias = dict[str, Any]
+UnprocessedCommand: TypeAlias = dict[str, Any]
 
 console = Console(soft_wrap=True, highlight=False)
 """Stdout console used to print diffs."""
@@ -77,12 +81,35 @@ def fmt_lines(lines: Iterable[str]) -> str:
 DIFF_HEADER = f"{fmt_line('-expected')}, {fmt_line('+tested')}"
 
 
-def get_diff(count: int, expected: list[str], result: list[str]) -> Group:
-    """Print a diff between two lists of strings."""
-    gen = difflib.ndiff(expected, result)
-    lines = fmt_lines(gen)
-    diff_title = f"\n[bold]#{count}[/]"
-    return Group(diff_title, DIFF_HEADER, Panel(lines, box=box.HORIZONTALS))
+class Diff(NamedTuple):
+    """A diff between two lists of strings."""
+
+    number: int
+    """The number of the diff."""
+
+    diff: list[str]
+    """The diff between the two lists of strings."""
+
+    @property
+    def renderable(self) -> Group:
+        """Console renderable for the diff."""
+        diff_lines = fmt_lines(self.diff)
+        diff_title = f"\n[bold]#{self.number}[/]"
+        return Group(diff_title, DIFF_HEADER, Panel(diff_lines, box=box.HORIZONTALS))
+
+    @classmethod
+    def from_lines(cls, number: int, expected: list[str], result: list[str]) -> Self:
+        """Print a diff between two lists of strings."""
+        lines = list(difflib.ndiff(expected, result))
+        return cls(number, lines)
+
+    def get_changed_lines(self) -> Iterable[str]:
+        """Get lines with changes (added or removed)."""
+        return (line for line in self.diff if line.startswith("+ ") or line.startswith("- "))
+
+    def get_changes(self) -> str:
+        """Get a formatted string of only the changes in the diff."""
+        return "\n".join(fmt_line(line) for line in self.get_changed_lines())
 
 
 class Choice(StrEnum):
@@ -142,7 +169,17 @@ def preprocess_json(s: str) -> str:
     return s
 
 
-def load_commands(file: str, preprocess: bool = True) -> list[dict[str, Any]]:
+@overload
+def load_commands(file: str, *, preprocess: Literal[False]) -> list[UnprocessedCommand]: ...
+
+
+@overload
+def load_commands(file: str, *, preprocess: Literal[True]) -> list[ProcessedCommand]: ...
+
+
+def load_commands(
+    file: str, *, preprocess: bool = True
+) -> list[ProcessedCommand] | list[UnprocessedCommand]:
     """Load JSON commands from a test suite log file."""
     with open(file, "r") as f:
         s = f.read()
@@ -159,8 +196,11 @@ def load_commands(file: str, preprocess: bool = True) -> list[dict[str, Any]]:
 class TestCommand(NamedTuple):
     """A single command from a test suite log."""
 
-    command: dict[str, Any]
-    original: dict[str, Any]
+    command: ProcessedCommand
+    """Processed command data, with placeholders for non-deterministic values."""
+
+    original: UnprocessedCommand
+    """Unprocessed original command data."""
 
 
 class TestSuiteResult:
@@ -168,7 +208,7 @@ class TestSuiteResult:
 
     def __init__(self, file: str) -> None:
         self.file = file
-        self.commands = load_commands(file)
+        self.commands = load_commands(file, preprocess=True)
         self.commands_original = load_commands(file, preprocess=False)
 
     def iterate(
@@ -195,6 +235,23 @@ class TestSuiteResult:
                 )
 
 
+class CommandDiff(NamedTuple):
+    """(un)resolved diff between two test suite results."""
+
+    expected: UnprocessedCommand
+    """The command that was expected."""
+
+    result: UnprocessedCommand
+    """The command that was actually run."""
+
+    diff: Diff
+    """The diff between the two commands."""
+
+    def get_command(self) -> str:
+        """Get the name of the command that was run."""
+        return self.expected.get("command", self.result.get("command", "<unknown>"))
+
+
 class CommandDiffer:
     """Diffs the results (JSON output) of commands from two files."""
 
@@ -208,8 +265,8 @@ class CommandDiffer:
         self.expected = TestSuiteResult(file1)
         self.result = TestSuiteResult(file2)
 
-        self.diff_resolved = 0
-        self.diff_unresolved = 0
+        self.diff_resolved: list[CommandDiff] = []
+        self.diff_unresolved: list[CommandDiff] = []
 
     def diff(self) -> None:
         """Diff the two files."""
@@ -233,6 +290,14 @@ class CommandDiffer:
                 err_console.print(fmt_line(line))
             raise CommandCountError(len(expected_commands), len(result_commands))
 
+    def log_unresolved_diff(self, expected: TestCommand, result: TestCommand, diff: Diff) -> None:
+        """Log an unresolved diff between two commands."""
+        self.diff_unresolved.append(CommandDiff(expected.original, result.original, diff))
+
+    def log_resolved_diff(self, expected: TestCommand, result: TestCommand, diff: Diff) -> None:
+        """Log a resolved diff between two commands."""
+        self.diff_resolved.append(CommandDiff(expected.original, result.original, diff))
+
     def diff_command_results(self) -> None:
         """Diff the contents of each command in the two files."""
         # NOTE: Only used in review mode
@@ -257,10 +322,10 @@ class CommandDiffer:
 
             if expected_lines != result_lines:
                 diff_n += 1
-                d = get_diff(diff_n, expected_lines, result_lines)
+                d = Diff.from_lines(diff_n, expected_lines, result_lines)
                 if not self.review:
-                    self.diff_unresolved += 1
-                    console.print(d)
+                    self.log_unresolved_diff(expected, result, d)
+                    console.print(d.renderable)
                     continue  # Nothing more to do for this command
 
                 if no_all:
@@ -268,7 +333,7 @@ class CommandDiffer:
                 elif yes_all:
                     choice = Choice.YES
                 else:
-                    console.print(d)
+                    console.print(d.renderable)
                     choice = Prompt.ask(
                         f"Accept change #{diff_n}? ({Choice.as_string()})",
                         choices=list(Choice),
@@ -284,23 +349,42 @@ class CommandDiffer:
                 if choice == Choice.YES:
                     # Accept new line
                     new_testsuite_results.append(result.original)
-                    self.diff_resolved += 1
+                    self.log_resolved_diff(expected, result, d)
                 else:
                     # Keep old line
                     new_testsuite_results.append(expected.original)
-                    self.diff_unresolved += 1
+                    self.log_unresolved_diff(expected, result, d)
             else:
                 # 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:
+        if self.review and len(self.diff_resolved) > 0:
             # Write accepted changes back to file1
             with open(self.file1, "w") as f:
                 json.dump(new_testsuite_results, f, indent=2)
             err_console.print(f"Wrote accepted changes back to {self.file1}")
 
 
+def print_diff_summary(diffs: list[CommandDiff], title: str) -> None:
+    """Print a summary of diffs."""
+    if diffs:
+        tbl = Table(
+            "Command",
+            "Diff",
+            title=title,
+            show_header=True,
+            show_lines=True,
+            expand=True,
+        )
+        for cmd in diffs:
+            tbl.add_row(
+                cmd.get_command(),
+                cmd.diff.get_changes(),
+            )
+        err_console.print(tbl)
+
+
 def main() -> None:
     """Compare two JSON files."""
     parser = argparse.ArgumentParser(prog="diff.py")
@@ -327,10 +411,14 @@ def main() -> None:
     # I.e. resolved msg followed by unresolved msg with non-zero exit code
     resolved = differ.diff_resolved
     unresolved = differ.diff_unresolved
+    print_diff_summary(resolved, "[green italic]Resolved diffs[/]")
+    print_diff_summary(unresolved, "[red italic]Unresolved diffs[/]")
     if resolved:
-        err_console.print(f"[green]Resolved {resolved} diffs between {file1} and {file2}[/]")
+        err_console.print(f"[green]Resolved {len(resolved)} diffs between {file1} and {file2}[/]")
     if unresolved:  # non-zero exit code if unresolved diffs
-        err_console.print(f"[red]{unresolved} unresolved diffs between {file1} and {file2}.[/]")
+        err_console.print(
+            f"[red]{len(unresolved)} unresolved diffs between {file1} and {file2}.[/]"
+        )
         sys.exit(1)
     if not resolved and not unresolved:  # no diffs found
         err_console.print(f"No differences found between {file1} and {file2}")

{mreg_cli-1.2.4 → mreg_cli-1.4.0}/ci/docker-compose.yml

@@ -13,7 +13,7 @@ services:
        start_period: 5s
 
   mreg:
-    image: ghcr.io/unioslo/mreg:latest
+    image: ghcr.io/unioslo/mreg:master
     container_name: mreg
     depends_on:
       postgres:
@@ -25,6 +25,7 @@ services:
       - MREG_DB_NAME=mreg
       - MREG_DB_USER=mreg
       - MREG_DB_PASSWORD=mreg
+      - MREG_MAP_GLOBAL_COMMUNITY_NAMES=1
       - CI=yes
     healthcheck:
       test: sh -c "[ -f /var/run/gunicorn.pid ]"

{mreg_cli-1.2.4 → mreg_cli-1.4.0}/ci/run_testsuite_and_record_V2.sh

@@ -28,7 +28,6 @@ function cleanup {
 	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
@@ -59,7 +58,7 @@ else
 fi
 
 # give mreg some time to create the database schema and start up
-sleep 5s
+sleep 5
 
 # create a superuser
 if docker exec -t mreg uv version >/dev/null; then
@@ -81,8 +80,10 @@ 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
+	set +e
 	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/new_testsuite_log.json .
 	docker cp finished-mreg-tests:/build/ci/testsuite-result.json .
 	exit $EXITCODE
 fi

{mreg_cli-1.2.4 → mreg_cli-1.4.0}/ci/testsuite

@@ -68,7 +68,7 @@ host add otherhost -ip 10.0.1.20 -contact support@example.org  # fails because r
 network remove_excluded_range 10.0.1.0/24 10.0.1.20 10.0.1.30
 host add otherhost -ip 10.0.1.20 -contact support@example.org  # should not need force now that net is unfrozen
 host remove otherhost
-network remove 10.0.1.0/24 -f
+
 # IPv6
 network create -network 2001:db8::/64 -desc "Lorem ipsum dolor sit amet"
 network set_frozen 2001:db8::/64
@@ -81,6 +81,51 @@ network info 2001:db8::/64
 host aaaa_add somehost 2001:db8::/64  # should require force, because the network is frozen
 host aaaa_add somehost 2001:db8::/64 -force
 host remove somehost -force
+network unset_frozen 2001:db8::/64
+
+# Test handling of network and broadcast address arguments
+## IPv4
+### Adding/changing A-records for an existing host
+host add somehost -contact support@example.org
+host a_add somehost 10.0.1.0 # should require force because it is a network address
+host a_add somehost 10.0.1.0 -force
+host a_remove somehost 10.0.1.0 # force not required for removal
+host a_add somehost 10.0.1.255 # force again (broadcast address)
+host a_add somehost 10.0.1.255 -force
+host a_change -old 10.0.1.255 -new 10.0.1.0 somehost # changing to network address, requires force
+host a_change -old 10.0.1.255 -new 10.0.1.0 somehost -force
+host remove somehost -force # cleanup
+
+### Adding A-records for a new host
+host add somehost -ip 10.0.1.0 # requires force because it is a network address
+host add somehost -ip 10.0.1.1 -force
+host remove somehost -force -override ipaddress
+host add somehost -ip 10.0.1.255 # requires force because it is a broadcast address
+host add somehost -ip 10.0.1.255 -force
+host a_remove somehost 10.0.1.255 # cleanup
+
+## IPv6
+### Adding/changing AAAA-records for an existing host
+host aaaa_add somehost 2001:db8:: # should require force because it is a network address
+host aaaa_add somehost 2001:db8:: -force
+host aaaa_remove somehost 2001:db8:: # force not required for removal
+host aaaa_add somehost 2001:db8::ffff:ffff:ffff:ffff # force again (broadcast address)
+host aaaa_add somehost 2001:db8::ffff:ffff:ffff:ffff -force
+host aaaa_change -old 2001:db8::ffff:ffff:ffff:ffff -new 2001:db8:: somehost # changing to network address, requires force
+host aaaa_change -old 2001:db8::ffff:ffff:ffff:ffff -new 2001:db8:: somehost -force
+host aaaa_remove somehost 2001:db8::ffff:ffff:ffff:ffff # force not required for removal
+host remove somehost -force -override ipaddress# cleanup
+
+### Adding AAAA-records for a new host
+host add somehost -ip 10.0.1.0 # requires force because it is a network address
+host add somehost -ip 10.0.1.1 -force
+host remove somehost -force -override ipaddress
+host add somehost -ip 10.0.1.255 # requires force because it is a broadcast address
+host add somehost -ip 10.0.1.255 -force
+
+# Cleanup
+host remove somehost -force
+network remove 10.0.1.0/24 -f
 network remove 2001:db8::/64 -f
 
 
@@ -383,6 +428,95 @@ permission network_remove 192.168.0.0/16 mygroup .*
 label remove postit
 
 
+##### Tests: Network Policy
+network create -network 10.0.2.0/28 -desc "TinyNet"
+network policy_attribute_create foo "Foo attribute"
+network policy_attribute_create bar "Bar attribute"
+network policy_attribute_create baz "Baz attribute"
+network policy_create SecurePolicy "Secure policy for a network" -attribute foo -attribute bar
+network policy_create Autoconfigure "Automatic host configuration" -attribute baz
+network policy_create NoICMP "ICMP disallowed" # no attributes
+network policy_list
+network policy_info SecurePolicy
+network policy_info Autoconfigure
+network policy_add 10.0.2.0/28 SecurePolicy
+network policy_add 10.0.2.0/28 Autoconfigure # requires force
+network policy_add 10.0.2.0/28 Autoconfigure -force
+network info 10.0.2.0/28
+network policy_delete Autoconfigure # requires force
+network policy_delete Autoconfigure -force
+network info 10.0.2.0/28
+network policy_list
+network policy_add 10.0.2.0/28 SecurePolicy
+network policy_rename SecurePolicy InsecurePolicy
+network policy_list
+network info 10.0.2.0/28
+network policy_set_description InsecurePolicy "Insecure policy for a network"
+network policy_attribute_add InsecurePolicy baz
+network policy_attribute_set_description baz "Baz attribute (new)"
+network policy_attribute_list
+network policy_attribute_remove InsecurePolicy foo
+network policy_info InsecurePolicy
+network policy_attribute_delete bar # requires force (in use)
+network policy_attribute_delete bar -force
+
+# Communities
+host add tinyhost -ip 10.0.2.0/28 -macaddress 11:22:33:aa:bb:cc -contact tinyhost@example.org
+network community_create 10.0.2.0/28 guests "Guest hosts."
+network community_create 10.0.2.0/28 lab "Lab hosts."
+network community_list 10.0.2.0/28
+network community_host_add tinyhost guests
+host info tinyhost
+network community_host_add tinyhost lab
+host info tinyhost
+# TODO: test network community_host_add with specific IP address on host with multiple IPs
+network community_info 10.0.2.0/28 guests
+network community_info 10.0.2.0/28 lab
+
+# Custom communtiy mapping prefix
+network policy_create CustomPrefix "Custom community mapping prefix" -prefix "custom" # no attributes
+network create -network 10.0.3.0/24 -desc "CustomPrefixNet" -policy CustomPrefix # add policy during creation
+network policy_info CustomPrefix
+network community_create 10.0.3.0/24 foo "Foo community"
+network community_info 10.0.3.0/24 foo
+network policy_set_prefix CustomPrefix "newprefix"
+network community_info 10.0.3.0/24 foo
+network policy_unset_prefix CustomPrefix
+network community_info 10.0.3.0/24 foo
+network remove 10.0.3.0/24 -force
+network policy_delete CustomPrefix
+
+## Rename community
+network community_rename 10.0.2.0/28 lab labequipment
+network community_set_description 10.0.2.0/28 labequipment "Lab equipment (expensive)"
+network community_info 10.0.2.0/28 labequipment
+
+## Add another host to a community before displaying communities with hosts
+host add tinierhost -ip 10.0.2.0/28 -contact tinierhost@example.org
+network community_host_add tinierhost guests
+network community_list 10.0.2.0/28 -hosts
+
+## Attempt to add host from other network to community (fails)
+network create -network 10.0.0.0/24 -desc "MediumNet"
+host add mediumhost -ip 10.0.0.0/24 -macaddress 11:22:34:aa:bb:cd -contact mediumhost@example.org
+network community_host_add mediumhost labequipment # fails, community not found in network
+host remove mediumhost -force
+network remove 10.0.0.0/24
+
+## Delete community (remove host from community first)
+network community_delete 10.0.2.0/28 labequipment # fails
+network community_host_remove tinyhost labequipment
+network community_delete 10.0.2.0/28 labequipment
+
+## Delete community with hosts (force)
+network community_delete 10.0.2.0/28 guests # fails
+network community_delete 10.0.2.0/28 guests -force
+
+## Clean up community resources
+host remove tinyhost
+host remove tinierhost
+network remove 10.0.2.0/28 -force
+
 ##### Tests: Zone
 #    - Zone removal
 zone delete example.org