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

mreg_cli-1.2.0/.github/workflows/publish.yml

@@ -0,0 +1,201 @@
+name: build mreg-cli
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+*'
+
+concurrency:
+  group: build-mreg-cli-${{ github.head_ref }}
+
+env:
+  UV_FROZEN: 1
+
+jobs:
+  build_pypi:
+    name: Build wheels and source distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      
+      # https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/accessing-contextual-information-about-workflow-runs#determining-when-to-use-contexts
+      - name: Exit if not on master branch
+        if: ${{ github.ref == 'refs/heads/master' }}
+        run: exit -1
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v2
+
+      - name: Set up Python 3.12
+        run: uv python install 3.12
+
+      - name: Install build dependencies
+        run: uv sync
+
+      - name: Build source distribution
+        run: uv build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: pypi_artifacts
+          path: dist/*
+          if-no-files-found: error
+
+  build_pyinstaller:
+    name: Build pyinstaller binary
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
+          - macos-13 # only non-large x86 macOS runner image available
+          - macos-latest
+        include:
+          - os: ubuntu-latest
+            platform: linux-x86_64
+            container: redhat/ubi8:latest
+          - os: windows-latest
+            platform: win-x86_64
+          - os: macos-13
+            platform: macos-x86_64
+          - os: macos-latest
+            platform: macos-arm64
+        python-version:
+          - '3.12'
+    runs-on: ${{ matrix.os }}
+    container: ${{ matrix.container }}
+
+    steps:
+      - name: Install RHEL 8 dependencies
+        if: contains(matrix.container, 'redhat/ubi8')
+        run: dnf install -y git binutils
+
+      - name: Ensure git is available
+        run: git --version
+      
+      - 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 build dependencies
+        run: uv sync --group ci
+
+      - name: Run PyInstaller with Tox
+        run: uv run tox
+      
+      - name: Set platform binary names
+        shell: bash
+        run: |
+          VERSION="${{ github.ref_name }}"
+          BASE_NAME="mreg-cli-${VERSION}-${{ matrix.platform }}"
+          if [[ "${{ matrix.os }}" == "windows-latest" ]]; then
+            echo "BINARY_NAME=${BASE_NAME}.exe" >> $GITHUB_ENV
+            echo "SOURCE_NAME=dist/mreg-cli.exe" >> $GITHUB_ENV
+          else
+            echo "BINARY_NAME=${BASE_NAME}" >> $GITHUB_ENV
+            echo "SOURCE_NAME=dist/mreg-cli" >> $GITHUB_ENV
+          fi
+
+      - name: Rename binary
+        shell: bash
+        run: mv "${{ env.SOURCE_NAME }}" "dist/${{ env.BINARY_NAME }}"
+      
+      - uses: actions/upload-artifact@v4
+        with:
+          name: ${{ env.BINARY_NAME }}
+          path: dist/${{ env.BINARY_NAME }}
+          if-no-files-found: error
+          
+  publish_pypi:
+    name: Publish PyPI release
+    needs:
+      - build_pypi
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: pypi_artifacts
+          path: dist
+
+      - name: Push build artifacts to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.8.14
+  
+  publish_github:
+    name: Publish GitHub release
+    needs:
+      - build_pyinstaller
+      - publish_pypi
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download PyInstaller binaries
+        uses: actions/download-artifact@v4
+        with:
+          pattern: mreg-cli-*
+          path: dist
+          merge-multiple: true
+    
+      - name: Download wheel and source distributions
+        uses: actions/download-artifact@v4
+        with:
+          pattern: pypi_artifacts
+          path: dist
+          merge-multiple: true
+
+      - name: Generate SHA256 checksums
+        id: sha
+        run: |
+          cd dist
+          echo "checksums<<EOF" >> $GITHUB_OUTPUT
+          sha256sum * >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          body: |
+            Release ${{ github.ref_name }}
+            
+            ## Binary Downloads
+            
+            Platform | Architecture | Download
+            ---------|--------------|----------
+            Linux | x86_64 | [mreg-cli-${{ github.ref_name }}-linux-x86_64](https://github.com/${{ github.repository }}/releases/download/${{ github.ref_name }}/mreg-cli-${{ github.ref_name }}-linux-x86_64)
+            Windows | x86_64 | [mreg-cli-${{ github.ref_name }}-win-x86_64.exe](https://github.com/${{ github.repository }}/releases/download/${{ github.ref_name }}/mreg-cli-${{ github.ref_name }}-win-x86_64.exe)
+            macOS | x86_64 | [mreg-cli-${{ github.ref_name }}-macos-x86_64](https://github.com/${{ github.repository }}/releases/download/${{ github.ref_name }}/mreg-cli-${{ github.ref_name }}-macos-x86_64)
+            macOS | ARM64 | [mreg-cli-${{ github.ref_name }}-macos-arm64](https://github.com/${{ github.repository }}/releases/download/${{ github.ref_name }}/mreg-cli-${{ github.ref_name }}-macos-arm64)
+            
+            ## PyPI Package
+
+            ### uv
+
+            ```bash
+            uv tool install mreg-cli==${{ github.ref_name }}
+            ```
+
+            ### pipx
+
+            ```bash
+            pipx install mreg-cli==${{ github.ref_name }}
+            ```
+
+            ### pip
+
+            ```bash
+            pip install mreg-cli==${{ github.ref_name }}
+            ```
+            
+            ## SHA256 Checksums
+            ```
+            ${{ steps.sha.outputs.checksums }}
+            ```
+          draft: false
+          prerelease: false

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

@@ -1,5 +1,7 @@
 on: [push, pull_request]
 
+env:
+  UV_FROZEN: 1
 
 name: CI
 jobs:
@@ -23,9 +25,7 @@ jobs:
       - name: Set up Python ${{ matrix.python-version }}
         run: uv python install ${{ matrix.python-version }}
       - name: Install mreg-cli
-        run: |
-          uv venv
-          uv pip install -e .[dev]
+        run: uv sync
       - name: Test and compare api calls
         run: uv run ci/run_testsuite_and_record.sh
 
@@ -45,12 +45,20 @@ jobs:
       - name: Set up Python ${{ matrix.python-version }}
         run: uv python install ${{ matrix.python-version }}
       - name: Install dependencies
-        run: |
-          uv venv
-          uv pip install tox-uv tox-gh-actions 
+        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
@@ -67,8 +75,6 @@ jobs:
       - name: Set up Python ${{ matrix.python-version }}
         run: uv python install ${{ matrix.python-version }}
       - name: Install dependencies
-        run: |
-          uv venv
-          uv pip install -U -e ".[test]"
+        run: uv sync
       - name: Run unittest
         run: uv run pytest

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.2.0/CHANGELOG.md

@@ -0,0 +1,79 @@
+# Changelog
+
+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] -->
+
+## [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
+
+- Customizable prompt with string interpolation. The prompt can be customized with the `--prompt` option or with the `prompt` option in the config. The prompt can be customized with the following variables:
+  - `{user}`: Username of active user
+  - `{proto}`: Protocol part of the server URL
+  - `{host}`: Host/domain name part of the server URL
+  - `{port}`: Port part of the server URL (if any)
+  - `{domain}`: Domain name. Defaults to `uio.no` if not specified.
+    Uses the domain specified with `--domain` or the `domain` option in the config.
+
+### Fixed
+
+- 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 network address (first address of subnet) or broadcast address (last address of subnet) to a host.
+
+## [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](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.
+
+### Added
+
+- `--version` option to display current application version and exit.
+    Version number is in the form of `major.minor.patch` if installed from a published version.
+    Shows a version number including the commit hash if installed from a git repository in the form of `major.minor.patch.dev123+gabc1234`.
+    See [Default versioning scheme](https://setuptools-scm.readthedocs.io/en/latest/usage/#default-versioning-scheme) in the [setuptools_scm](https://github.com/pypa/setuptools_scm/) documentation for more information.
+  - The version can be accessed programmatically with `mreg_cli.__version__`.
+- `label set_description` command to set the description of a label.
+- `network list_excluded_ranges` command to list the excluded ranges of a network.
+- Application can now store tokens for multiple servers and will pick the correct one based on the server URL.
+- Building binaries for Windows, Linux and MacOS, and publishing the package to PyPI on each GitHub release.
+
+### Changed
+
+- The application now uses Pydantic internally to validate request and response data. This should make the code more robust and easier to maintain.
+- Application now attempts to send JSON for every request. This should improve the consistency of the API responses.
+- Version now follows Semantic Versioning 2.0.0 and is automatically determined based on the most recent git tag (`mreg-cli-v*`). As part of this change, the verison has been bumped from 0.9.10 to 1.0.0. See the Added section for more information on how version numbers are accessed.
+
+### Removed
+
+- `label rename -desc` option. Description modification is now done through the new `label set_description` command.
+
+### Fixed
+
+- Hopefully more than we broke.

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mreg-cli
-Version: 1.0.1
+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>
@@ -699,19 +699,8 @@ Requires-Dist: prompt_toolkit>=3.0.0
 Requires-Dist: requests[socks]>=2.31.0
 Requires-Dist: typing_extensions>=4.12.0
 Requires-Dist: pydantic[email]>=2.7.1
-Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: inline-snapshot; extra == "test"
-Requires-Dist: pytest-httpserver; extra == "test"
-Provides-Extra: dev
-Requires-Dist: mreg-cli[test]; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
-Requires-Dist: tox-uv; extra == "dev"
-Requires-Dist: rich; extra == "dev"
-Requires-Dist: setuptools; extra == "dev"
-Requires-Dist: setuptools-scm; extra == "dev"
-Requires-Dist: build; extra == "dev"
-Requires-Dist: pyinstaller; extra == "dev"
+Requires-Dist: pydantic-extra-types>=2.1.0
+Requires-Dist: platformdirs>=4.3.0
 
 # 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)
 
@@ -737,15 +726,7 @@ Requires-Dist: pyinstaller; extra == "dev"
       - [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
 
@@ -753,10 +734,65 @@ Options can be set in ~/.config/mreg-cli.conf. A typical config file looks like
 
 ```ini
 [mreg]
-USER=mreg-user
-SERVER=https://mreg.example.com:8000
+url=https://mreg.example.com:8000
+user=mreg-user
 ```
 
+<details>
+<summary>Other options</summary>
+
+### Prompt
+
+The prompt text can be configured with a custom format string. The available variables are:
+
+- `{user}`: Username of active user
+- `{proto}`: Protocol part of the server URL
+- `{host}`: Name part of the server URL
+- `{port}`: Port part of the server URL (if any)
+- `{domain}`: Domain name. Defaults to `uio.no` if not specified.
+
+By default the prompt is set to `{user}@{host}`, which is equivalent to the following config:
+
+```ini
+[mreg]
+PROMPT={user}@{host}
+```
+
+Which results in a prompt like this:
+
+```cli
+admin@mreg.example.com>
+```
+
+#### Command line
+
+A custom prompt string can be specified as a command line argument as well:
+
+```bash
+mreg-cli --prompt "<string>"
+```
+
+#### Disabling the prompt prefix text
+
+The prompt text can be disabled by setting it to no value in the config file or by using the `--prompt` flag with an empty string.
+
+```ini
+[mreg]
+PROMPT=
+```
+
+```bash
+mreg-cli --prompt ""
+```
+
+Which results in the following prompt:
+
+```cli
+>
+```
+
+</details>
+
 ## General usage
 
 Commands in `mreg-cli` take on the form of a fairly standard command line interface:

{mreg_cli-1.0.1 → 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
 
@@ -38,10 +30,65 @@ Options can be set in ~/.config/mreg-cli.conf. A typical config file looks like
 
 ```ini
 [mreg]
-USER=mreg-user
-SERVER=https://mreg.example.com:8000
+url=https://mreg.example.com:8000
+user=mreg-user
 ```
 
+<details>
+<summary>Other options</summary>
+
+### Prompt
+
+The prompt text can be configured with a custom format string. The available variables are:
+
+- `{user}`: Username of active user
+- `{proto}`: Protocol part of the server URL
+- `{host}`: Name part of the server URL
+- `{port}`: Port part of the server URL (if any)
+- `{domain}`: Domain name. Defaults to `uio.no` if not specified.
+
+By default the prompt is set to `{user}@{host}`, which is equivalent to the following config:
+
+```ini
+[mreg]
+PROMPT={user}@{host}
+```
+
+Which results in a prompt like this:
+
+```cli
+admin@mreg.example.com>
+```
+
+#### Command line
+
+A custom prompt string can be specified as a command line argument as well:
+
+```bash
+mreg-cli --prompt "<string>"
+```
+
+#### Disabling the prompt prefix text
+
+The prompt text can be disabled by setting it to no value in the config file or by using the `--prompt` flag with an empty string.
+
+```ini
+[mreg]
+PROMPT=
+```
+
+```bash
+mreg-cli --prompt ""
+```
+
+Which results in the following prompt:
+
+```cli
+>
+```
+
+</details>
+
 ## General usage
 
 Commands in `mreg-cli` take on the form of a fairly standard command line interface:

{mreg_cli-1.0.1 → 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.0.1 → 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.0.1 → mreg_cli-1.2.0}/data/mreg-cli.conf

@@ -3,5 +3,6 @@
 # user=test
 # domain=example.org
 # logfile=cli.log
+# prompt={user}@{host}
 category_tags=cat1,cat2,cat3
 location_tags=loc1,loc2,loc3