2026-10-23 14:44:39 +00:00
20 changed files with 359 additions and 98 deletions
@@ -0,0 +1,17 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+    tags: ["v*"]
+  pull_request:
+
+jobs:
+  driver:
+    uses: NAPALM/driver-standard/.gitea/workflows/driver.yml@main
+    with:
+      standard-ref: main
+      # Until napalm-linux 0.15.0 is on PyPI.
+      pre-install: "git+https://git.netork.io/NAPALM/napalm-device-types.git git+https://git.netork.io/NAPALM/napalm-linux.git"
+    secrets:
+      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
@@ -1,50 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: ["**"]
-  pull_request:
-    branches: ["**"]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.10", "3.11", "3.12"]
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Setup Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: ${{ matrix.python-version }}
-          cache: pip
-
-      - name: Install package with dev extras
-        run: |
-          python -m pip install --upgrade pip
-          # napalm-device-types lives in git.netork.io/NAPALM, not on PyPI: without this
-          # pip looks there, finds an unrelated 0.1.0 and the job dies before any test.
-          python -m pip install "napalm-device-types @ git+https://git.netork.io/NAPALM/napalm-device-types.git"
-          # napalm-linux, which this driver builds on, is not on PyPI either.
-          python -m pip install "napalm-linux @ git+https://git.netork.io/NAPALM/napalm-linux.git"
-          python -m pip install -e ".[dev]"
-
-      - name: Run unit tests
-        run: |
-          python -m pytest -q --tb=short
-
-      - name: Build wheel and sdist
-        run: |
-          python -m pip install build
-          python -m build
-
-      - name: Upload dist artifacts
-        # v4 refuses to run on Gitea ("not currently supported on GHES").
-        uses: actions/upload-artifact@v3
-        with:
-          name: dist-${{ matrix.python-version }}
-          path: dist/*
@@ -0,0 +1,9 @@
+__pycache__/
+*.egg-info/
+.venv/
+build/
+dist/
+.coverage
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this driver. The format follows
+[Keep a Changelog](https://keepachangelog.com/), versions follow
+[Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+### Changed
+- The driver follows the NAPALM driver standard
+  (https://git.netork.io/NAPALM/driver-standard): CI on Gitea runs ruff, mypy, the
+  tests on Python 3.10–3.13 and at the lowest declared versions, bandit, pip-audit and
+  a build check, and a release tag publishes to PyPI. The package now ships `py.typed`,
+  a README and a LICENSE file. It needs napalm-device-types 4.22.0 and napalm-linux
+  0.15.0. **Python 3.9 is no longer supported**; napalm-device-types never ran on it.
+- Failures the driver deliberately ignores (the OpenMediaVault version, `smartctl` for one
+  disk, `/proc/mdstat`, `mdadm --detail`, a shared folder lookup) are now logged at debug
+  level.
+
@@ -0,0 +1,191 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other transformations
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and incorporated
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combined Contribution(s) and the Work
+      to which such Contribution(s) was submitted. If You institute patent
+      litigation against any entity (including a cross-claim or counterclaim
+      in a lawsuit) alleging that the Work or any Contribution embodied
+      within the Work constitutes direct or contributory patent infringement,
+      then any patent licenses granted to You under this License for that
+      Work shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text file
+          distributed as part of the Derivative Works; within the Source
+          form or documentation, if provided along with the Derivative
+          Works; or, within a display generated by the Derivative Works,
+          if and wherever such third-party notices normally appear. The
+          contents of the NOTICE file are for informational purposes only
+          and do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, copy, modify, merge,
+      publish, distribute, sublicense, and/or sell copies of the Work,
+      and to permit persons to whom the Work is furnished to do so,
+      subject to the following conditions:
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any conditions of TITLE,
+      MERCHANTIBILITY, or FITNESS FOR A PARTICULAR PURPOSE.
+      See the License for the specific language governing permissions and
+      limitations under the License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (even if such Contributor has been advised of the possibility
+      of such damages).
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may offer only
+      conditions consistent with this License, subject to the following
+      additional conditions:
+
+      (a) You may offer additional warranty, indemnity, or other liability
+          terms and conditions; and
+
+      (b) You may offer support for the Work in return for a fee.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format in question. It may also be
+      possible to make it available with a creative commons license.
+
+   Copyright 2026 Christian Manivong
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
@@ -0,0 +1,72 @@
+# napalm-openmediavault
+
+NAPALM driver for [OpenMediaVault](https://www.openmediavault.org/) NAS systems, built on
+[napalm-device-types](https://git.netork.io/NAPALM/napalm-device-types) (`StorageDriver`) and
+[napalm-linux](https://git.netork.io/NAPALM/napalm-linux) (`LinuxDriver`).
+
+OpenMediaVault is Debian underneath, so the driver inherits everything napalm-linux does for a
+Linux host (packages, updates, services, users, processes, cron, Docker) and adds the NAS side:
+disks, md RAID arrays, filesystems, shares and the NAS services.
+
+## Tested against
+
+| Model | Firmware |
+|---|---|
+| OpenMediaVault | 6.x (Debian Bullseye), 7.x (Debian Bookworm) |
+
+## Connection
+
+SSH, port 22 by default, through napalm-linux (Netmiko). The account needs a shell; `smartctl`
+and `mdadm` run through `sudo` (passwordless, or with `sudo_password`). Every `optional_args`
+key of napalm-linux is accepted (`port`, `pkg_manager`, `sudo_password`, …).
+
+```python
+from napalm import get_network_driver
+
+driver = get_network_driver("openmediavault")
+with driver("192.0.2.10", "admin", "secret", optional_args={"sudo_password": "secret"}) as nas:
+    print(nas.get_facts())
+    print(nas.get_disks())
+    print(nas.get_shares())
+```
+
+## Supported
+
+| Getter / action | |
+|---|---|
+| `get_facts` | napalm-linux's facts, `os_version` is `OMV <version>` of the `openmediavault` package |
+| `get_disks` | `lsblk` for the disks, `smartctl -iA` for health, temperature and RPM |
+| `get_disk_pools` | md arrays from `/proc/mdstat`, size and state from `mdadm --detail` |
+| `get_volumes` | mounted block-device filesystems from `df`, read-only flag from `/proc/mounts` |
+| `get_shares` | SMB, NFS and FTP shares from OMV's configuration database (`omv-confdbadm`) |
+| `get_storage_services` | whether `smbd`, `nfs-server`, `proftpd`, `ssh` and `rsync` are enabled and running |
+| everything of napalm-linux | packages, updates, services, users, processes, cron, Docker, … |
+
+"Upgrade everything" is a full upgrade (`FULL_UPGRADE = True`): a plain `apt-get upgrade` holds
+back OpenMediaVault's own packages and the kernel.
+
+## Not supported
+
+- `get_volume_snapshots`, `get_replication_jobs`, `get_quotas` raise `NotImplementedError`.
+- `harden_ssh_server` is not offered: OpenMediaVault generates `sshd_config` from its own
+  database and would undo a drop-in on the next apply of its SSH settings.
+- Configuration changes to shares, disks or arrays.
+
+## Installation
+
+```bash
+pip install napalm-openmediavault
+```
+
+## Development
+
+The rules are in [STANDARDS.md](https://git.netork.io/NAPALM/driver-standard/src/branch/main/STANDARDS.md).
+
+```bash
+python -m venv .venv && .venv/bin/pip install -e ".[dev]"
+.venv/bin/pytest --cov
+```
+
+## License
+
+Apache-2.0
@@ -1,20 +0,0 @@
-Metadata-Version: 2.4
-Name: napalm-openmediavault
-Version: 0.1.0
-Summary: NAPALM driver for OpenMediaVault NAS (SSH)
-Author-email: Christian Manivong <christian@manivong.de>
-License: Apache-2.0
-Project-URL: Repository, https://github.com/chrismanivong/napalm-openmediavault
-Keywords: napalm,network,automation,nas,openmediavault,omv,storage
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: System Administrators
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: System :: Networking
-Classifier: Topic :: System :: Systems Administration
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: napalm>=4.0
-Requires-Dist: napalm-device-types>=0.3.0
-Requires-Dist: napalm-linux>=0.1.0
@@ -1,10 +0,0 @@
-pyproject.toml
-napalm_openmediavault/__init__.py
-napalm_openmediavault/openmediavault.py
-napalm_openmediavault.egg-info/PKG-INFO
-napalm_openmediavault.egg-info/SOURCES.txt
-napalm_openmediavault.egg-info/dependency_links.txt
-napalm_openmediavault.egg-info/entry_points.txt
-napalm_openmediavault.egg-info/requires.txt
-napalm_openmediavault.egg-info/top_level.txt
-tests/test_omv_type_label.py
@@ -1 +0,0 @@
-
@@ -1,2 +0,0 @@
-[napalm.drivers]
-openmediavault = napalm_openmediavault:OpenMediaVaultDriver
@@ -1,3 +0,0 @@
-napalm>=4.0
-napalm-device-types>=0.3.0
-napalm-linux>=0.1.0
@@ -1 +0,0 @@
-napalm_openmediavault
@@ -509,7 +509,7 @@ class OpenMediaVaultDriver(StorageDriver, LinuxDriver):

    # ── Internal helpers ───────────────────────────────────────────────────────

-    def _omv_read(self, key: str) -> list:
+    def _omv_read(self, key: str) -> list[dict[str, Any]]:
        """Query the OMV config database and return a list of objects.

        Handles both OMV 6+ (returns a JSON array directly) and older
@@ -525,7 +525,8 @@ class OpenMediaVaultDriver(StorageDriver, LinuxDriver):
            # Older OMV wraps the list: {"share": [...]}
            for wrapper in ("share", "rule", "entry", "mntent", "sharedfolder"):
                if wrapper in data and isinstance(data[wrapper], list):
-                    return data[wrapper]
+                    wrapped: list[dict[str, Any]] = data[wrapper]
+                    return wrapped
            return []
        except Exception:
            return []
@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=68", "wheel"]
+requires = ["setuptools>=77"]
 build-backend = "setuptools.build_meta"

 [project]
@@ -7,8 +7,8 @@ name = "napalm-openmediavault"
 version = "0.2.0"
 description = "NAPALM driver for OpenMediaVault NAS (SSH)"
 readme = "README.md"
-requires-python = ">=3.9"
-license = { text = "Apache-2.0" }
+requires-python = ">=3.10"
+license = "Apache-2.0"
 authors = [
    { name = "Christian Manivong", email = "christian@manivong.de" },
 ]
@@ -17,30 +17,40 @@ classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Developers",
    "Intended Audience :: System Administrators",
-    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
    "Topic :: System :: Networking",
    "Topic :: System :: Systems Administration",
+    "Typing :: Typed",
 ]
 dependencies = [
    "napalm>=4.0",
-    "napalm-device-types>=0.3.0",
-    "napalm-linux>=0.5.0",
+    "napalm-device-types>=4.22.0",
+    "napalm-linux>=0.15.0",
 ]

 [project.optional-dependencies]
-dev = ["pytest"]
+dev = ["pytest>=8", "pytest-cov>=5", "mypy>=1.11", "ruff>=0.6"]

 [project.entry-points."napalm.drivers"]
 openmediavault = "napalm_openmediavault:OpenMediaVaultDriver"

 [project.urls]
-Repository = "https://github.com/chrismanivong/napalm-openmediavault"
+Repository = "https://git.netork.io/NAPALM/napalm-openmediavault"
+Issues = "https://git.netork.io/NAPALM/napalm-openmediavault/issues"
+Changelog = "https://git.netork.io/NAPALM/napalm-openmediavault/src/branch/main/CHANGELOG.md"

 [tool.setuptools.packages.find]
 where = ["."]
 include = ["napalm_openmediavault*"]

+[tool.setuptools.package-data]
+napalm_openmediavault = ["py.typed"]
+
 [tool.ruff]
 line-length = 100
 target-version = "py310"
@@ -53,6 +63,20 @@ select = ["E", "F", "I", "UP", "B"]
 "tests/**" = ["E501"]

 [tool.mypy]
-python_version = "3.9"
+python_version = "3.10"
 strict = true
+# napalm itself is untyped, so every driver subclasses Any.
+disallow_subclassing_any = false
+
+[[tool.mypy.overrides]]
+module = ["napalm.*", "netmiko.*", "paramiko.*"]
 ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.coverage.run]
+source = ["napalm_openmediavault"]
+
+[tool.coverage.report]
+fail_under = 15
@@ -0,0 +1,15 @@
+{
+ "coverage_floor": 15.0,
+ "function_complexity": {
+  "napalm_openmediavault/openmediavault.py::OpenMediaVaultDriver.get_disks": 18
+ },
+ "function_lines": {
+  "napalm_openmediavault/openmediavault.py::OpenMediaVaultDriver.get_disk_pools": 81,
+  "napalm_openmediavault/openmediavault.py::OpenMediaVaultDriver.get_disks": 107,
+  "napalm_openmediavault/openmediavault.py::OpenMediaVaultDriver.get_storage_services": 58,
+  "napalm_openmediavault/openmediavault.py::OpenMediaVaultDriver.get_volumes": 90
+ },
+ "mypy_relaxed": [],
+ "python_file_lines": {},
+ "untyped_public": []
+}