mreg-cli 1.1.0__tar.gz → 1.2.0__tar.gz

{mreg_cli-1.1.0 → mreg_cli-1.2.0}/.github/workflows/publish.yml

@@ -130,8 +130,8 @@ jobs:
   publish_github:
     name: Publish GitHub release
     needs:
-      - build_pypi
       - build_pyinstaller
+      - publish_pypi
     runs-on: ubuntu-latest
 
     steps:

{mreg_cli-1.1.0 → mreg_cli-1.2.0}/.github/workflows/test.yml

@@ -48,7 +48,17 @@ jobs:
         run: uv sync --group ci
       - name: Test building with tox
         run: uv run tox r
-        
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: DavidAnson/markdownlint-cli2-action@v18
+        with:
+          config: '.markdownlint.json'
+          globs: '**/*.md'
+
   unit:
     name: Unit tests
     runs-on: ubuntu-latest

mreg_cli-1.2.0/.markdownlint.json

@@ -0,0 +1,9 @@
+{
+    "default": true,
+    "no-duplicate-heading": {
+        "siblings_only": true
+    },
+    "line-length": false,
+    "no-bare-urls": false,
+    "no-inline-html": false
+}

mreg_cli-1.1.0/CHANGELOG → mreg_cli-1.2.0/CHANGELOG.md

@@ -7,7 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- ## [Unreleased] -->
 
-## [1.1.0] - 2024-11-19
+## [1.2.0](https://github.com/unioslo/mreg-cli/releases/tag/1.2.0) - 2024-11-25
+
+### Added
+
+- Support for `help versions` which shows versions of the CLI and the server for servers that have implemented the `/meta/version` (and `/meta/libraries` endpoints for superusers).
+- Support for `help whoami` which shows information about the current user as the server sees them. This includes the username, attributes, groups, and permissions. This command is only available if the server has implemented the `/meta/users` endpoint.
+- Support for `help whois <username>` which allows elevated users to see information about the given user. Also requires the `/meta/users` endpoint to be implemented on the server.
+
+### Fixed
+
+- REPL command completion not showing descriptions for commands.
+- `host info` with MAC address argument not working for hosts with multiple IPs associated with the same MAC address.
+- Failed token file write causing the application to crash.
+- Connection strings without domains and with ports are now parsed properly for prompt interpolation.
+
+## [1.1.0](https://github.com/unioslo/mreg-cli/releases/tag/1.1.0) - 2024-11-19
 
 ### Added
 
@@ -21,18 +36,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- `host add`: Re-introduced support for network/ip ending with `/`.
+- MAC adress validation. Now supports all common formats. See the [Pydantic docs](https://docs.pydantic.dev/latest/api/pydantic_extra_types_mac_address/) for more information.
+- `host add`: Re-introduced support for network/IP ending with `/`.
   - Automatically deduces the correct network to assign an IP from.
-- `host add`: No longer possible to assign the network ID (first address of subnet) to a host.
+- `host add`: No longer possible to assign network address (first address of subnet) or broadcast address (last address of subnet) to a host.
 
-## [1.0.1] - 2024-10-21
+## [1.0.1](https://github.com/unioslo/mreg-cli/releases/tag/1.0.1) - 2024-10-21
 
 ### Fixed
 
 - Rendering of top level command autocompletion in REPL.
 - `OK:` messages not being displayed outside of `--record` mode
 
-## [1.0.0] - 2024-10-12
+## [1.0.0](https://github.com/unioslo/mreg-cli/releases/tag/1.0.0) - 2024-10-12
 
 The big Pydantic update. The entire codebase has been rewritten to use Pydantic for request and response validation. This brings with it a huge improvement to the development experience and the robustness of the code.
 

{mreg_cli-1.1.0 → mreg_cli-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mreg-cli
-Version: 1.1.0
+Version: 1.2.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>
@@ -726,15 +726,7 @@ Requires-Dist: platformdirs>=4.3.0
       - [DHCP](#dhcp)
     - [subnet](#subnet)
     - [zone](#zone)
-    - [history](#history)
     - [other](#other)
-  - [Devhelp](#devhelp)
-        - [client.py](#clientpy)
-        - [commands.py](#commandspy)
-        - [util.py](#utilpy)
-        - [history.py](#historypy)
-        - [config.py](#configpy)
-        - [log.py](#logpy)
 
 ## Setup
 

{mreg_cli-1.1.0 → mreg_cli-1.2.0}/README.md

@@ -22,15 +22,7 @@
       - [DHCP](#dhcp)
     - [subnet](#subnet)
     - [zone](#zone)
-    - [history](#history)
     - [other](#other)
-  - [Devhelp](#devhelp)
-        - [client.py](#clientpy)
-        - [commands.py](#commandspy)
-        - [util.py](#utilpy)
-        - [history.py](#historypy)
-        - [config.py](#configpy)
-        - [log.py](#logpy)
 
 ## Setup
 

{mreg_cli-1.1.0 → mreg_cli-1.2.0}/ci/testsuite

@@ -203,6 +203,7 @@ dhcp assoc foo aa:bb:cc:dd:ee:ff # should fail, the host has two IPs of differen
 host aaaa_remove foo 2001:db9::5
 host aaaa_add foo 2001:db8::5 -f
 dhcp assoc foo aa:bb:cc:dd:ee:ff # should work, the host now has two IPs of different types on the same VLAN.
+host info foo # should work and show both IPs
 host remove foo -f
 network remove 10.0.0.0/24 -f
 network remove 2001:db8::/64 -f

{mreg_cli-1.1.0 → mreg_cli-1.2.0}/ci/testsuite-result.json

@@ -20022,6 +20022,127 @@
     ],
     "time": null
   },
+  {
+    "command": "host info foo",
+    "command_filter": null,
+    "command_filter_negate": false,
+    "command_issued": "host info foo # should work and show both IPs",
+    "ok": [],
+    "warning": [],
+    "error": [],
+    "output": [
+      "Name:         foo.example.org",
+      "Contact:      ",
+      "A_Records     IP            MAC",
+      "              10.0.0.5      aa:bb:cc:dd:ee:ff",
+      "AAAA_Records  IP            MAC",
+      "              2001:db8::5   <not set>",
+      "TTL:          (Default)",
+      "TXT:          v=spf1 -all",
+      "Created:      Thu Nov 21 10:34:55 2024",
+      "Updated:      Thu Nov 21 10:34:55 2024"
+    ],
+    "api_requests": [
+      {
+        "method": "GET",
+        "url": "/api/v1/hosts/foo.example.org",
+        "data": {},
+        "status": 200,
+        "response": {
+          "ipaddresses": [
+            {
+              "macaddress": "aa:bb:cc:dd:ee:ff",
+              "ipaddress": "10.0.0.5",
+              "host": 13
+            },
+            {
+              "macaddress": "",
+              "ipaddress": "2001:db8::5",
+              "host": 13
+            }
+          ],
+          "cnames": [],
+          "mxs": [],
+          "txts": [
+            {
+              "txt": "v=spf1 -all",
+              "host": 13
+            }
+          ],
+          "ptr_overrides": [],
+          "hinfo": null,
+          "loc": null,
+          "bacnetid": null,
+          "name": "foo.example.org",
+          "contact": "",
+          "ttl": null,
+          "comment": "",
+          "zone": 1
+        }
+      },
+      {
+        "method": "GET",
+        "url": "/api/v1/srvs/?host=13",
+        "data": {},
+        "status": 200,
+        "response": {
+          "count": 0,
+          "next": null,
+          "previous": null,
+          "results": []
+        }
+      },
+      {
+        "method": "GET",
+        "url": "/api/v1/naptrs/?host=13",
+        "data": {},
+        "status": 200,
+        "response": {
+          "count": 0,
+          "next": null,
+          "previous": null,
+          "results": []
+        }
+      },
+      {
+        "method": "GET",
+        "url": "/api/v1/sshfps/?host=13",
+        "data": {},
+        "status": 200,
+        "response": {
+          "count": 0,
+          "next": null,
+          "previous": null,
+          "results": []
+        }
+      },
+      {
+        "method": "GET",
+        "url": "/api/v1/hostpolicy/roles/?hosts=13",
+        "data": {},
+        "status": 200,
+        "response": {
+          "count": 0,
+          "next": null,
+          "previous": null,
+          "results": []
+        }
+      },
+      {
+        "method": "GET",
+        "url": "/api/v1/hostgroups/?hosts=13",
+        "data": {},
+        "status": 200,
+        "response": {
+          "count": 0,
+          "next": null,
+          "previous": null,
+          "results": []
+        }
+      }
+    ],
+    "time": null
+  },
   {
     "command": "host remove foo -f",
     "command_filter": null,
@@ -24928,7 +25049,7 @@
     "api_requests": [
       {
         "method": "GET",
-        "url": "/api/v1/hosts/?ipaddresses__ipaddress=10.0.0.20&ordering=name",
+        "url": "/api/v1/hosts/?ipaddresses__ipaddress=10.0.0.20",
         "data": {},
         "status": 200,
         "response": {

{mreg_cli-1.1.0 → mreg_cli-1.2.0}/mreg_cli/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.1.0'
-__version_tuple__ = version_tuple = (1, 1, 0)
+__version__ = version = '1.2.0'
+__version_tuple__ = version_tuple = (1, 2, 0)

{mreg_cli-1.1.0 → mreg_cli-1.2.0}/mreg_cli/api/endpoints.py

@@ -77,6 +77,13 @@ class Endpoint(str, Enum):
 
     ForwardZoneForHost = f"{ForwardZones}hostname/"
 
+    TokenIsValid = "/api/token-is-valid/"
+
+    MetaUser = "/api/meta/user"
+    MetaVersion = "/api/meta/version"
+    MetaLibraries = "/api/meta/libraries"
+    MetaHeartbeat = "/api/meta/heartbeat"
+
     def __str__(self):
         """Prevent direct usage without parameters where needed."""
         if "{}" in self.value:

{mreg_cli-1.1.0 → mreg_cli-1.2.0}/mreg_cli/api/models.py

@@ -7,16 +7,9 @@ import logging
 import re
 from datetime import date, datetime
 from functools import cached_property
-from typing import Any, Callable, ClassVar, Literal, Self, cast, overload
-
-from pydantic import (
-    AliasChoices,
-    BaseModel,
-    ConfigDict,
-    Field,
-    computed_field,
-    field_validator,
-)
+from typing import Any, Callable, ClassVar, List, Literal, Self, cast, overload
+
+from pydantic import AliasChoices, BaseModel, ConfigDict, Field, computed_field, field_validator
 from typing_extensions import Unpack
 
 from mreg_cli.api.abstracts import APIMixin, FrozenModel, FrozenModelWithTimestamps
@@ -38,7 +31,7 @@ from mreg_cli.exceptions import (
     InvalidIPv6Address,
     InvalidNetwork,
     IPNetworkWarning,
-    MultipleEntititesFound,
+    MultipleEntitiesFound,
     PatchError,
     UnexpectedDataError,
     ValidationError,
@@ -118,6 +111,7 @@ class NetworkOrIP(BaseModel):
         :param value:The value to parse.
         :param mode: The mode to validate the input as.
         :returns: The parsed value as an IP address or network.
+        :raises IPNetworkWarning: If the value is not an IP address or network.
         """
         ipnet = cls.validate(value)
         funcmap: dict[IPNetMode, Callable[..., IP_AddressT | IP_NetworkT]] = {
@@ -2185,7 +2179,7 @@ class CNAME(FrozenModelWithTimestamps, WithHost, WithZone, WithTTL, APIMixin):
             raise EntityNotFound(f"CNAME record for {name} not found for {target_hostname}.")
 
         if len(results) > 1:
-            raise MultipleEntititesFound(f"Multiple CNAME records found for {host} with {name}!")
+            raise MultipleEntitiesFound(f"Multiple CNAME records found for {host} with {name}!")
 
         return results[0]
 
@@ -2684,28 +2678,22 @@ class Host(FrozenModelWithTimestamps, WithTTL, WithHistory, APIMixin):
             try:
                 ptr = False
                 ipaddress.ip_address(identifier)
+                NetworkOrIP.parse(identifier, mode="ip")
 
-                hosts = Host.get_list_by_field(
-                    "ipaddresses__ipaddress", identifier, ordering="name"
-                )
-
-                if not hosts:
-                    hosts = Host.get_list_by_field("ptr_overrides__ipaddress", identifier)
+                host = Host.get_by_field("ipaddresses__ipaddress", identifier)
+                if not host:
+                    host = Host.get_by_field("ptr_overrides__ipaddress", identifier)
                     ptr = True
 
-                if len(hosts) == 1:
+                if host:
                     if ptr and inform_as_ptr:
-                        OutputManager().add_line(
-                            f"{identifier} is a PTR override for {hosts[0].name}"
-                        )
-                    return hosts[0]
-
-                if len(hosts) > 1:
-                    raise MultipleEntititesFound(
-                        f"Multiple hosts found with IP address or PTR {identifier}."
-                    )
-
-            except ValueError:
+                        OutputManager().add_line(f"{identifier} is a PTR override for {host.name}")
+                    return host
+            except MultipleEntitiesFound as e:
+                raise MultipleEntitiesFound(
+                    f"Multiple hosts found with IP address or PTR {identifier}."
+                ) from e
+            except ValueError:  # invalid IP
                 pass
 
             try:
@@ -3501,3 +3489,199 @@ class HostGroup(FrozenModelWithTimestamps, WithName, WithHistory, APIMixin):
 
         for host in self.hosts:
             manager.add_formatted_line_with_source("host", host, self.name)
+
+
+### Meta models
+
+
+class UserDjangoStatus(BaseModel):
+    """Model for Django status in the user response."""
+
+    superuser: bool
+    staff: bool
+    active: bool
+
+
+class UserMregStatus(BaseModel):
+    """Model for Mreg status in the user response."""
+
+    superuser: bool
+    admin: bool
+    group_admin: bool
+    network_admin: bool
+    hostpolicy_admin: bool
+    dns_wildcard_admin: bool
+    underscore_admin: bool
+
+
+class UserPermission(BaseModel):
+    """Model for permissions in the user response."""
+
+    group: str
+    range: str
+    regex: str
+    labels: List[str]
+
+
+class ServerVersion(BaseModel):
+    """Model for server version metadata."""
+
+    version: str
+
+    @classmethod
+    def endpoint(cls) -> str:
+        """Return the endpoint for the class."""
+        return Endpoint.MetaVersion
+
+    @classmethod
+    def fetch(cls, ignore_errors: bool = True) -> "ServerVersion":
+        """Fetch the server version from the endpoint.
+
+        :param ignore_errors: Whether to ignore errors.
+        :raises ValidationError: If the response data is invalid and ignore_errors is False.
+        :raises requests.RequestException: If the HTTP request fails and ignore_errors is False.
+        :returns: An instance of ServerVersion with the fetched data.
+        """
+        try:
+            response = get(cls.endpoint())
+            return cls.model_validate(response.json())
+        except Exception as e:
+            if ignore_errors:
+                return cls(version="Unknown")
+            raise e
+
+    def output(self) -> None:
+        """Output the server version to the console."""
+        manager = OutputManager()
+        manager.add_line(f"mreg-server: {self.version}")
+
+
+class Library(BaseModel):
+    """Model for library metadata."""
+
+    name: str
+    version: str
+
+
+class ServerLibraries(BaseModel):
+    """Model for server libraries metadata."""
+
+    libraries: List[Library]
+
+    @classmethod
+    def endpoint(cls) -> str:
+        """Return the endpoint for the class."""
+        return Endpoint.MetaLibraries
+
+    @classmethod
+    def fetch(cls, ignore_errors: bool = True) -> "ServerLibraries":
+        """Fetch the server libraries from the endpoint.
+
+        :param ignore_errors: Whether to ignore errors.
+        :raises ValidationError: If the response data is invalid and ignore_errors is False.
+        :raises requests.RequestException: If the HTTP request fails and ignore_errors is False.
+        :returns: An instance of ServerLibraries with the fetched data.
+        """
+        try:
+            response = get(cls.endpoint())
+            libraries: List[Library] = []
+
+            for name, version in response.json().items():
+                libraries.append(Library(name=name, version=version))
+            return cls(libraries=libraries)
+        except Exception as e:
+            if ignore_errors:
+                return cls(libraries=[])
+            raise e
+
+    def output(self, indent: int = 4) -> None:
+        """Output the server libraries to the console."""
+        manager = OutputManager()
+        if not self.libraries:
+            return
+
+        manager.add_line("Libraries:")
+        for lib in self.libraries:
+            manager.add_line(f"{' ' * indent}{lib.name}: {lib.version}")
+
+
+class UserInfo(BaseModel):
+    """Model for the user information."""
+
+    username: str
+    django_status: UserDjangoStatus
+    mreg_status: UserMregStatus
+    groups: List[str]
+    permissions: List[UserPermission]
+
+    @classmethod
+    def endpoint(cls) -> str:
+        """Return the endpoint for the class."""
+        return Endpoint.MetaUser
+
+    @classmethod
+    def fetch(cls, ignore_errors: bool = True, user: str | None = None) -> "UserInfo":
+        """Fetch the user information from the endpoint.
+
+        :param ignore_errors: Whether to ignore errors.
+        :param user: The username to fetch information for. If None, fetch information for the
+                              current user.
+
+        :raises ValidationError: If the response data is invalid and ignore_errors is False.
+        :raises requests.RequestException: If the HTTP request fails and ignore_errors is False.
+        :returns: An instance of UserInfo with the fetched data.
+        """
+        try:
+            endpoint = cls.endpoint()
+            if user:
+                endpoint = f"{endpoint}?username={user}"
+
+            response = get(endpoint)
+            return cls.model_validate(response.json())
+        except Exception as e:
+            if ignore_errors:
+                return cls(
+                    username="Unknown",
+                    django_status=UserDjangoStatus(superuser=False, staff=False, active=False),
+                    mreg_status=UserMregStatus(
+                        superuser=False,
+                        admin=False,
+                        group_admin=False,
+                        network_admin=False,
+                        hostpolicy_admin=False,
+                        dns_wildcard_admin=False,
+                        underscore_admin=False,
+                    ),
+                    groups=[],
+                    permissions=[],
+                )
+            raise e
+
+    def output(self) -> None:
+        """Output the user information to the console."""
+        outputmanager = OutputManager()
+        outputmanager.add_line(f"Username: {self.username}")
+        outputmanager.add_line("Django status:")
+        outputmanager.add_line(f"  Superuser: {self.django_status.superuser}")
+        outputmanager.add_line(f"  Staff: {self.django_status.staff}")
+        outputmanager.add_line(f"  Active: {self.django_status.active}")
+        outputmanager.add_line("Mreg status:")
+        outputmanager.add_line(f"  Superuser: {self.mreg_status.superuser}")
+        outputmanager.add_line(f"  Admin: {self.mreg_status.admin}")
+        outputmanager.add_line(f"  Group admin: {self.mreg_status.group_admin}")
+        outputmanager.add_line(f"  Network admin: {self.mreg_status.network_admin}")
+        outputmanager.add_line(f"  Hostpolicy admin: {self.mreg_status.hostpolicy_admin}")
+        outputmanager.add_line(f"  DNS wildcard admin: {self.mreg_status.dns_wildcard_admin}")
+        outputmanager.add_line(f"  Underscore admin: {self.mreg_status.underscore_admin}")
+        outputmanager.add_line("Groups:")
+        for group in self.groups:
+            outputmanager.add_line(f"  {group}")
+        outputmanager.add_line("Permissions:")
+        if not self.permissions:
+            outputmanager.add_line("  None")
+
+        for perm in self.permissions:
+            outputmanager.add_line(f"  Group: {perm.group}")
+            outputmanager.add_line(f"  Range: {perm.range}")
+            outputmanager.add_line(f"  Regex: {perm.regex}")
+            outputmanager.add_line(f"  Labels: {', '.join(perm.labels)}")

{mreg_cli-1.1.0 → mreg_cli-1.2.0}/mreg_cli/cli.py

@@ -222,6 +222,7 @@ class Command(Completer):
                     yield Completion(
                         name,
                         start_position=-len(cur),
+                        display_meta=self.children[name].short_desc,
                     )
 
         # if the line starts with one of the sub commands, pass it along

{mreg_cli-1.1.0 → mreg_cli-1.2.0}/mreg_cli/commands/help.py

@@ -5,9 +5,13 @@ from __future__ import annotations
 import argparse
 from typing import Any
 
+from mreg_cli.__about__ import __version__ as mreg_cli_version
+from mreg_cli.api.models import ServerLibraries, ServerVersion, UserInfo
 from mreg_cli.commands.base import BaseCommand
 from mreg_cli.commands.registry import CommandRegistry
 from mreg_cli.config import MregCliConfig
+from mreg_cli.outputmanager import OutputManager
+from mreg_cli.types import Flag
 
 command_registry = CommandRegistry()
 
@@ -27,7 +31,9 @@ class HelpCommands(BaseCommand):
         )
 
 
-@command_registry.register_command("filtering", "Show help for filtering.", "Filtering Help")
+@command_registry.register_command(
+    prog="filtering", description="Show help for filtering.", short_desc="Filtering Help"
+)
 def filtering_help(_: argparse.Namespace) -> None:
     """Show help for filtering."""
     print(
@@ -71,7 +77,50 @@ TXT:          v=spf1 -all
     )
 
 
-@command_registry.register_command("configuration", "Show configuration", "Show configuration")
+@command_registry.register_command(
+    prog="configuration", description="Show configuration", short_desc="Show configuration"
+)
 def configuration_help(_: argparse.Namespace) -> None:
     """Show configuration."""
     MregCliConfig().print_config_table()
+
+
+@command_registry.register_command(
+    prog="versions",
+    description="Show versions of client and server as much as possible",
+    short_desc="Show versions",
+)
+def versions_help(_: argparse.Namespace) -> None:
+    """Show versions of client and server as much as possible."""
+    output_manager = OutputManager()
+    output_manager.add_line(f"mreg-cli: {mreg_cli_version}")
+
+    ServerVersion.fetch().output()
+    ServerLibraries.fetch().output()
+
+
+@command_registry.register_command(
+    prog="whoami",
+    description="Show information about the the current user",
+    short_desc="Show self info",
+)
+def whoami_help(_: argparse.Namespace) -> None:
+    """Show information about the current user."""
+    try:
+        UserInfo.fetch(ignore_errors=False).output()
+    except Exception as e:
+        print("Failed to fetch user info:", e)
+
+
+@command_registry.register_command(
+    prog="whois",
+    description="Show information about a user",
+    short_desc="Show user info",
+    flags=[Flag("user", description="The user to show information about")],
+)
+def whois_help(args: argparse.Namespace) -> None:
+    """Show information about a user."""
+    try:
+        UserInfo.fetch(ignore_errors=False, user=args.user).output()
+    except Exception as e:
+        print("Failed to fetch user info:", e)