Refactor dump_json method to use model_dump_json

- Fix the `dump_json` method in the `ModelView` class to call `model_dump_json` instead of `model_dump`, ensuring consistency in JSON serialization.
- Added a new test case in `TestListModelView` to verify the functionality of `dump_json` and check for correct IP address serialization.

.gitea/workflows/ci.yml

@@ -0,0 +1,50 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  lint:
+    runs-on: rassbery
+    container: catthehacker/ubuntu:act-22.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Sync dependencies
+        run: uv sync --group dev
+      - name: Ruff lint
+        run: uv run ruff check --output-format=github .
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+  test:
+    runs-on: rassbery
+    container: catthehacker/ubuntu:act-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Sync dependencies
+        run: uv sync --group dev
+      - name: Run tests
+        run: uv run pytest -q
+
+  ci-success:
+    if: always()
+    needs: [lint, test]
+    runs-on: rassbery
+    container: catthehacker/ubuntu:act-22.04
+    steps:
+      - name: Verify all jobs succeeded
+        if: ${{ contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') }}
+        run: exit 1

.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Sync dependencies
+        run: uv sync --group dev
+      - name: Ruff lint
+        run: uv run ruff check --output-format=github .
+      - name: Ruff format check
+        run: uv run ruff format --check .
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Sync dependencies
+        run: uv sync --group dev
+      - name: Run tests
+        run: uv run pytest -q
+
+  ci-success:
+    if: always()
+    needs: [lint, test]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Verify all jobs succeeded
+        if: ${{ contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') }}
+        run: exit 1

.gitignore

@@ -6,8 +6,10 @@ dist/
 wheels/
 *.egg-info
 main.py
+.coverage
 # Virtual environments
 .venv
+.python-version
 .idea
 .DS_Store
 .vscode

.python-version

@@ -1 +0,0 @@
-3.13

oxi/conf.py

@@ -10,6 +10,9 @@ from .interfaces import BaseDevice, device_registry
 if TYPE_CHECKING:
     from requests import Session
 
+    from oxi.interfaces.contract import Interfaces, System, Vlans
+
+
 TModel = TypeVar("TModel", bound=BaseModel)
 
 
@@ -20,7 +23,7 @@ class ModelView(Generic[TModel]):
     def dump_json(self) -> str:
         if isinstance(self._model, list):
             return json.dumps(
-                [item.model_dump(by_alias=True) for item in self._model],
+                [item.model_dump_json(by_alias=True) for item in self._model],
                 ensure_ascii=False,
             )
         return self._model.model_dump_json(by_alias=True)
@@ -83,13 +86,42 @@ class NodeConfig:
         return self.text
 
     @property
-    def vlans(self):
+    def vlans(self) -> list["Vlans"]:
+        """
+        Returns the list of VLAN configurations for the node.
+
+        :return: List of Vlans associated with the device.
+                vlan_id: int
+                name: str | None = Field(default=None, alias="description")
+        :rtype: list[oxi.interfaces.contract.Vlans]
+        """
+        return ModelView(self._parsed_data.vlans)
         return ModelView(self._parsed_data.vlans)
 
     @property
-    def interfaces(self):
+    def interfaces(self) -> list["Interfaces"]:
+        """
+        Returns the list of Interfaces configurations for the node.
+
+        :return: List of Interfaces associated with the device.
+                    name: str = Field(alias="interface")
+                    ip_address: IPv4Address | None = None
+                    mask: int | None = None
+                    description: str | None = None
+                    shutdown: bool = False
+        :rtype: list[oxi.interfaces.contract.Interfaces]
+        """
         return ModelView(self._parsed_data.interfaces)
 
     @property
-    def system(self):
+    def system(self) -> "System":
+        """
+        Returns the Systems configurations for the node.
+
+        :return: System associated with the device.
+                    model: str
+                    serial_number: str
+                    version: str
+        :rtype: oxi.interfaces.contract.System
+        """
         return ModelView(self._parsed_data.system)

oxi/interfaces/contract.py

@@ -26,6 +26,7 @@ class Interfaces(Base):
     ip_address: IPv4Address | None = None
     mask: int | None = None
     description: str | None = None
+    shutdown: bool = False
 
 
 class Vlans(Base):

oxi/interfaces/models/templates/eltex.ttp

@@ -25,6 +25,7 @@ Active-image: {{ ignore }} {{ _start_ }}
 
 <group name="interfaces">
 interface {{ interface | ORPHRASE }}
+ shutdown {{ shutdown | set(True) }}
  ip address {{ ip_address }} {{ mask | to_cidr }}
  name {{ description | ORPHRASE}}
  description {{ description | ORPHRASE }}

oxi/interfaces/models/templates/h3c.ttp

@@ -23,6 +23,7 @@ default_system = {
 interface {{ interface }}
  description {{ description | ORPHRASE }}
  ip address {{ ip_address }} {{ mask | to_cidr }}
+ shutdown {{ shutdown | set(True) }}
 </group>
 
 <group name="vlans">

oxi/interfaces/models/templates/huawei.ttp

@@ -21,6 +21,7 @@ default_system = {
 <group name="interfaces">
 interface {{ interface }}
  description {{ description | ORPHRASE }}
+ shutdown {{ shutdown | set(True) }}
  ip address {{ ip_address }} {{ mask | to_cidr }}
 </group>
 <group name="vlans">

oxi/interfaces/models/templates/mikrotik.ttp

@@ -28,9 +28,9 @@ add address={{ ip_address | _start_ }}/{{ mask }} interface={{ name }} network={
 ## not disabled and comment with/without quotes
 add address={{ ip_address | _start_ }}/{{ mask }} comment={{ description | ORPHRASE | exclude("disabled=") | strip('"')}} interface={{ name }} network={{ network }}
 ## disabled no comment
-add address={{ ip_address | _start_ }}/{{ mask }} disabled={{ disabled | replace("yes","True") | strip('"')}} interface={{ name }} network={{ network }}
+add address={{ ip_address | _start_ }}/{{ mask }} disabled={{ shutdown | replace("yes","True") | strip('"')}} interface={{ name }} network={{ network }}
 ## disabled with comment with/without quotes
-add address={{ ip_address | _start_ }}/{{ mask }} comment={{ description | ORPHRASE | exclude("disabled=") | strip('"') }} disabled={{ disabled }} interface={{ name }} network={{ network }}
+add address={{ ip_address | _start_ }}/{{ mask }} comment={{ description | ORPHRASE | exclude("disabled=") | strip('"') }} disabled={{ shutdown | replace("yes","True") | strip('"')}} interface={{ name }} network={{ network }}
 </group>
 
 <group name="vlans">

oxi/interfaces/models/templates/qtech.ttp

@@ -29,6 +29,7 @@ default_system = {
 
 <group name="interfaces">
 interface {{ interface | ORPHRASE }}
+ shutdown {{ shutdown | set(True) }}
  description {{ description | ORPHRASE }}
  ip address {{ ip_address }} {{ mask | to_cidr }}
 </group>

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "oxipy"
-version = "0.1.0"
+version = "0.1.4"
 description = "Python client for Oxidized API with TTP-based config parsing"
 readme = "README.md"
 license = "Apache-2.0"

tests/fixtures/eltex/config.expected.json

@@ -7,30 +7,35 @@
   "interfaces": [
     {
       "interface": "TenGigabitEthernet1/0/2",
+      "shutdown": true,
       "ip_address": null,
       "mask": null,
       "description": "FREE"
     },
     {
       "interface": "TenGigabitEthernet1/0/11",
+      "shutdown": true,
       "ip_address": null,
       "mask": null,
       "description": "FREE"
     },
     {
       "interface": "vlan 1700",
+      "shutdown": false,
       "ip_address": "13.36.8.1",
       "mask": 24,
       "description": "sw-test_HW"
     },
     {
       "interface": "vlan 666",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "test"
     },  
     {
       "interface": "vlan 777",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "test2"

tests/fixtures/h3c/config.conf

@@ -152,6 +152,7 @@ interface HundredGigE1/0/3
  port link-type trunk
  undo port trunk permit vlan 1
  port trunk permit vlan 221 1112 to 1116 1512
+ shutdown
  storm-constrain broadcast pps 1100 1000
  storm-constrain multicast pps 1100 1000
  storm-constrain control shutdown

tests/fixtures/h3c/config.expected.json

@@ -7,72 +7,84 @@
   "interfaces": [
     {
       "interface": "Bridge-Aggregation1",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "HW_TEST_1"
     },
     {
       "interface": "Bridge-Aggregation2",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "HW_TEST_2"
     },
     {
       "interface": "Bridge-Aggregation3",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "HW_TEST_3"
     },
     {
       "interface": "Bridge-Aggregation4",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "HW_TEST_4"
     },
     {
       "interface": "NULL0",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "Vlan-interface1",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "Vlan-interface12",
+      "shutdown": false,
       "ip_address": "15.12.16.246",
       "mask": 30,
       "description": "BGP to OSPF1"
     },
     {
       "interface": "Vlan-interface3000",
+      "shutdown": false,
       "ip_address": "192.168.19.254",
       "mask": 25,
       "description": "L3 to HW_TEST_3"
     },
     {
       "interface": "HundredGigE1/0/3",
+      "shutdown": true,
       "ip_address": null,
       "mask": null,
       "description": "HW_TEST_1"
     },
     {
       "interface": "HundredGigE1/0/63",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "HW_TEST_2"
     },
     {
       "interface": "M-GigabitEthernet0/0/0",
+      "shutdown": false,
       "ip_address": "192.168.10.101",
       "mask": 24,
       "description": null
     },
     {
       "interface": "M-GigabitEthernet0/0/1",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": null

tests/fixtures/huawei/config.conf

@@ -30,6 +30,17 @@ interface GigabitEthernet0/0/33
  storm-control multicast min-rate 1000 max-rate 2000
  storm-control action error-down
 #
+interface GigabitEthernet1/0/43
+ description FREE
+ shutdown
+ port link-type access
+ port default vlan 102
+ loopback-detect enable
+ stp disable
+ storm-control broadcast min-rate 1500 max-rate 2500
+ storm-control multicast min-rate 1000 max-rate 2000
+ storm-control action error-down
+#
 interface Vlanif120
  description SSH
  ip address 10.26.196.254 255.255.255.0

tests/fixtures/huawei/config.expected.json

@@ -7,12 +7,21 @@
   "interfaces": [
     {
       "interface": "GigabitEthernet0/0/33",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": null
     },
+    {
+      "interface": "GigabitEthernet1/0/43",
+      "shutdown": true,
+      "ip_address": null,
+      "mask": null,
+      "description": "FREE"
+    },
     {
       "interface": "Vlanif120",
+      "shutdown": false,
       "ip_address": "10.26.196.254",
       "mask": 24,
       "description": "SSH"

tests/fixtures/keenetic/config.expected.json

@@ -7,138 +7,161 @@
   "interfaces": [
     {
       "interface": "GigabitEthernet0",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "GigabitEthernet0/1",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "GigabitEthernet0/2",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "GigabitEthernet0/3",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "GigabitEthernet0/0",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "WifiMaster0",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "WifiMaster0/AccessPoint0",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "WifiMaster0/AccessPoint1",
+      "shutdown": true,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "WifiMaster0/AccessPoint2",
+      "shutdown": true,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "WifiMaster0/WifiStation0",
+      "shutdown": true,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "WifiMaster1",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "WifiMaster1/AccessPoint0",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "WifiMaster1/AccessPoint1",
+      "shutdown": true,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "WifiMaster1/AccessPoint2",
+      "shutdown": true,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "WifiMaster1/WifiStation0",
+      "shutdown": true,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "Bridge0",
+      "shutdown": false,
       "ip_address": "17.36.1.1",
       "mask": 24,
       "description": "Home network"
     },
     {
       "interface": "Bridge1",
+      "shutdown": true,
       "ip_address": "10.1.30.1",
       "mask": 24,
       "description": "Guest network"
     },
     {
       "interface": "Bridge2",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": null
     },
     {
       "interface": "OpenVPN0",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "test_HW-udp"
     },
     {
       "interface": "OpenVPN2",
+      "shutdown": true,
       "ip_address": null,
       "mask": null,
       "description": "test_HW-tcp"
     },
     {
       "interface": "Wireguard0",
+      "shutdown": false,
       "ip_address": "10.3.100.1",
       "mask": 24,
       "description": "test_HW"
     },
     {
       "interface": "Wireguard1",
+      "shutdown": false,
       "ip_address": "10.1.100.1",
       "mask": 24,
       "description": "test_HW"
     },
     {
       "interface": "Wireguard2",
+      "shutdown": false,
       "ip_address": "10.2.100.1",
       "mask": 24,
       "description": "test_HW"

tests/fixtures/mikrotik/config.expected.json

@@ -7,24 +7,28 @@
   "interfaces": [
     {
       "interface": "bridge.LAN",
+      "shutdown": false,
       "ip_address": "172.16.3.1",
       "mask": 24,
       "description": null
     },
     {
       "interface": "ether1",
+      "shutdown": false,
       "ip_address": "10.38.3.245",
       "mask": 24,
       "description": null
     },
     {
       "interface": "wireguard2",
+      "shutdown": false,
       "ip_address": "10.1.100.2",
       "mask": 24,
       "description": null
     },
     {
       "interface": "ether4",
+      "shutdown": true,
       "ip_address": "100.10.10.1",
       "mask": 24,
       "description": null

tests/fixtures/qtech/config_1.expected.json

@@ -7,18 +7,21 @@
   "interfaces": [
     {
       "interface": "GigaEthernet1/0/9",
+      "shutdown": true,
       "ip_address": null,
       "mask": null,
       "description": "FREE"
     },
     {
       "interface": "VLAN1",
+      "shutdown": false,
       "ip_address": "192.168.0.1",
       "mask": 16,
       "description": null
     },
     {
       "interface": "VLAN1002",
+      "shutdown": false,
       "ip_address": "13.36.8.1",
       "mask": 24,
       "description": "test-1002"

tests/fixtures/qtech/config_2.expected.json

@@ -7,18 +7,21 @@
   "interfaces": [
     {
       "interface": "GigaEthernet1/0/9",
+      "shutdown": true,
       "ip_address": null,
       "mask": null,
       "description": "FREE"
     },
     {
       "interface": "VLAN1",
+      "shutdown": false,
       "ip_address": "192.168.0.1",
       "mask": 16,
       "description": null
     },
     {
       "interface": "VLAN1002",
+      "shutdown": false,
       "ip_address": "13.36.8.1",
       "mask": 24,
       "description": "test-1002"

tests/fixtures/quasar/config_1.expected.json

@@ -7,48 +7,56 @@
   "interfaces": [
     {
       "interface": "7/4",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "IN DWDM / OUT TEST_HW_08_N0_p1"
     },
     {
       "interface": "8/1",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "IN DWDM / OUT TEST_HW_09_N1_p0"
     },
     {
       "interface": "8/2",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "IN DWDM / OUT TEST_HW_09_N0_p0"
     },
     {
       "interface": "8/3",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "IN DWDM / OUT TEST_HW_10_N1_p0"
     },
     {
       "interface": "8/4",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "IN DWDM / OUT TEST_HW_10_N0_p0"
     },
     {
       "interface": "9/1",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "IN DWDM / OUT TEST_HW_11_N0_p0"
     },
     {
       "interface": "9/2",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "IN DWDM / OUT TEST_HW_11_N0_p1"
     },
     {
       "interface": "ethernet",
+      "shutdown": false,
       "ip_address": "25.25.1.221",
       "mask": 24,
       "description": null

tests/fixtures/quasar/config_2.expected.json

@@ -7,84 +7,98 @@
   "interfaces": [
     {
       "interface": "1/1",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "TEST_HW_1_1"
     },
     {
       "interface": "1/3",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "TEST_HW_1_3"
     },
     {
       "interface": "2/1",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "TEST_HW_2_1"
     },
     {
       "interface": "2/2",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "TEST_HW_2_2"
     },
     {
       "interface": "2/3",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "TEST_HW_2_3"
     },
     {
       "interface": "2/4",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "TEST_HW_2_4"
     },
     {
       "interface": "3/1",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "TEST_HW_3_1"
     },
     {
       "interface": "3/3",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "TEST_HW_3_3"
     },
     {
       "interface": "3/4",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "TEST_HW_3_4"
     },
     {
       "interface": "4/1",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "TEST_HW_4_1"
     },
     {
       "interface": "4/2",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "TEST_HW_4_2"
     },
     {
       "interface": "4/3",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "TEST_HW_4_3"
     },
     {
       "interface": "4/4",
+      "shutdown": false,
       "ip_address": null,
       "mask": null,
       "description": "TEST_HW_4_4"
     },
     {
       "interface": "ethernet",
+      "shutdown": false,
       "ip_address": "25.25.18.19",
       "mask": 24,
       "description": null

tests/test_view.py

@@ -1,4 +1,5 @@
 import json
+from ipaddress import IPv4Address
 
 import pytest
 
@@ -66,6 +67,10 @@ class TestListModelView:
     def test_dump_uses_aliases(self, interfaces_view):
         dumped = interfaces_view.dump()
         assert dumped[0]["interface"] == "eth0"
+        assert dumped[0]["ip_address"] == IPv4Address("192.168.1.1")
+
+    def test_dump_json(self, interfaces_view):
+        assert interfaces_view.dump_json()
 
     def test_dump_json_keeps_unicode(self):
         view = ModelView([Interfaces(interface="eth0", description="Дом")])