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

{mreg_cli-1.1.0 → mreg_cli-1.2.1}/.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.1}/.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.1/.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.1/CHANGELOG.md

@@ -5,9 +5,34 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-<!-- ## [Unreleased] -->
+<!-- ## Unreleased -->
 
-## [1.1.0] - 2024-11-19
+## [1.2.1](https://github.com/unioslo/mreg-cli/releases/tag/1.2.1) - 2024-12-02
+
+### Fixed
+
+- Host lookup with IPv6 addresses raising `ValidationError` when no host can be found with the given address.
+
+### Removed
+
+- Support for fetching hosts that have a valid IP/MAC address as their hostname.
+
+## [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 +46,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.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mreg-cli
-Version: 1.1.0
+Version: 1.2.1
 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.1}/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.1}/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.1}/ci/testsuite-result.json

@@ -6,7 +6,6 @@
     "command_issued": "zone create example.org hostmaster@example.org ns1.example.org  # should require force because ns1 is unknown",
     "ok": [],
     "warning": [
-      "Host ns1.example.org not found.",
       "ns1.example.org is not in mreg, must force"
     ],
     "error": [],
@@ -41,9 +40,7 @@
     "ok": [
       "Created zone example.org"
     ],
-    "warning": [
-      "Host ns1.example.org not found."
-    ],
+    "warning": [],
     "error": [],
     "output": [],
     "api_requests": [
@@ -210,10 +207,9 @@
     "command": "zone set_ns example.org ns2.example.org",
     "command_filter": null,
     "command_filter_negate": false,
-    "command_issued": "zone set_ns example.org ns2.example.org # requires force because ns2 is unknown",
+    "command_issued": "zone set_ns example.org ns2.example.org  #  requires force because ns2 is unknown",
     "ok": [],
     "warning": [
-      "Host ns2.example.org not found.",
       "ns2.example.org is not in mreg, must force"
     ],
     "error": [],
@@ -271,9 +267,7 @@
     "ok": [
       "Updated nameservers for example.org"
     ],
-    "warning": [
-      "Host ns2.example.org not found."
-    ],
+    "warning": [],
     "error": [],
     "output": [],
     "api_requests": [
@@ -15283,9 +15277,7 @@
     "ok": [
       "Created zone delegation wut.example.org"
     ],
-    "warning": [
-      "Host ns2.example.org not found."
-    ],
+    "warning": [],
     "error": [],
     "output": [],
     "api_requests": [
@@ -20022,6 +20014,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 +25041,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.1}/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.1'
+__version_tuple__ = version_tuple = (1, 2, 1)

{mreg_cli-1.1.0 → mreg_cli-1.2.1}/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.1}/mreg_cli/api/fields.py

@@ -21,25 +21,40 @@ class MACAddressField(FrozenModel):
 
     address: MacAddress
 
-    @classmethod
-    def validate(cls, value: str | MacAddress | Self) -> Self:
-        """Validate a MAC address and return it as a string."""
-        try:
-            return cls.validate_naive(value)
-        except ValueError as e:
-            raise InputFailure(e) from e
-
     # HACK: extremely hacky workaround for our custom exceptions always
     # logging errors/warnings even when caught.
     @classmethod
-    def validate_naive(cls, value: str | MacAddress | Self) -> Self:
+    def validate(cls, value: str | MacAddress | Self) -> Self:
         """Validate but raise built-in exceptions on failure."""
         if isinstance(value, MACAddressField):
-            return cls.validate_naive(value.address)
+            return cls.validate(value.address)
         try:
             return cls(address=value)  # pyright: ignore[reportArgumentType]
         except ValidationError as e:
-            raise ValueError(f"Invalid MAC address '{value}'") from e
+            raise InputFailure(f"Invalid MAC address '{value}'") from e
+
+    @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.
+        """
+        # Match interface of NetworkOrIP.parse_or_raise
+        return cls.validate(obj).address
+
+    @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 ValueError:
+            return None
 
     def __str__(self) -> str:
         """Return the MAC address as a string."""