Merge pull request 'chore: adopt the NAPALM driver standard' (#7) from chore/driver-standard into main
driver / standard (push) Successful in 15s
driver / types (push) Failing after 5s
driver / lint (push) Successful in 13s
driver / test (3.10) (push) Successful in 5m54s
driver / test (3.11) (push) Successful in 5m51s
driver / test (3.12) (push) Successful in 5m52s
driver / security (push) Successful in 58s
driver / build (push) Successful in 23s
driver / lowest (push) Successful in 5m20s
driver / test (3.13) (push) Successful in 5m44s
CI / driver (push) Failing after 11m54s
driver / publish (push) Skipped
driver / standard (push) Successful in 15s
driver / types (push) Failing after 5s
driver / lint (push) Successful in 13s
driver / test (3.10) (push) Successful in 5m54s
driver / test (3.11) (push) Successful in 5m51s
driver / test (3.12) (push) Successful in 5m52s
driver / security (push) Successful in 58s
driver / build (push) Successful in 23s
driver / lowest (push) Successful in 5m20s
driver / test (3.13) (push) Successful in 5m44s
CI / driver (push) Failing after 11m54s
driver / publish (push) Skipped
This commit was merged in pull request #7.
This commit is contained in:
commit
efe253dc42
10 files changed
+376
-106
No files matched your search
@@ -0,0 +1,15 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
tags: ["v*"]
|
||||
pull_request:
|
||||
|
||||
jobs:
|
||||
driver:
|
||||
uses: NAPALM/driver-standard/.gitea/workflows/driver.yml@main
|
||||
with:
|
||||
standard-ref: main
|
||||
secrets:
|
||||
PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
|
||||
@@ -1,48 +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"
|
||||
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,35 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this driver. The format follows
|
||||
[Keep a Changelog](https://keepachangelog.com/), versions follow
|
||||
[Semantic Versioning](https://semver.org/).
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
## [0.3.0] - 2026-10-23
|
||||
|
||||
The first release on PyPI.
|
||||
|
||||
### 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`
|
||||
and a LICENSE file. Python 3.10 is the floor; napalm-device-types now comes from
|
||||
PyPI, 4.21.1 or later.
|
||||
- A WAN connection service that fails with an unexpected error while
|
||||
`get_wan_status()` tries it is now logged at debug level before the next one is
|
||||
tried.
|
||||
|
||||
## [0.2.0] - 2026-10-17
|
||||
|
||||
### Removed
|
||||
- `get_device_warnings()`. The DSL noise margin and the firmware on offer are facts in
|
||||
`get_system_config()` (`dsl_downstream_noise_margin`, `firmware_update_available`,
|
||||
`firmware_version`); whether they warrant a warning is the application's decision.
|
||||
|
||||
## [0.1.0] - 2026-06-13
|
||||
|
||||
### Added
|
||||
- `fritzbox` driver: read-only access to AVM FritzBox routers over TR-064
|
||||
(fritzconnection).
|
||||
@@ -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.
|
||||
@@ -6,8 +6,9 @@ NAPALM community driver for **AVM FritzBox** routers (read-only, via TR-064).
|
||||
|
||||
| Dependency | Minimum version |
|
||||
|---|---|
|
||||
| Python | 3.9 |
|
||||
| Python | 3.10 |
|
||||
| NAPALM | 4.0 |
|
||||
| napalm-device-types | 4.21.1 |
|
||||
| fritzconnection | 1.13 |
|
||||
|
||||
## Installation
|
||||
@@ -19,7 +20,7 @@ pip install napalm-fritzbox
|
||||
Or from source:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/napalm-automation-community/napalm-fritzbox
|
||||
git clone https://git.netork.io/NAPALM/napalm-fritzbox
|
||||
cd napalm-fritzbox
|
||||
pip install -e .
|
||||
```
|
||||
@@ -78,18 +79,16 @@ does not verify it, so no separate `verify` option is needed.
|
||||
|
||||
## Development
|
||||
|
||||
The rules are in [STANDARDS.md](https://git.netork.io/NAPALM/driver-standard/src/branch/main/STANDARDS.md).
|
||||
|
||||
```bash
|
||||
pip install -e ".[dev]"
|
||||
pytest tests/
|
||||
python -m venv .venv && .venv/bin/pip install -e ".[dev]"
|
||||
.venv/bin/pytest --cov
|
||||
```
|
||||
|
||||
## CI
|
||||
|
||||
This project includes a GitHub Actions workflow that:
|
||||
- Runs unit tests across Python 3.9–3.12
|
||||
- Builds sdist and wheel
|
||||
|
||||
See [.github/workflows/ci.yml](.github/workflows/ci.yml).
|
||||
CI ([.gitea/workflows/ci.yml](.gitea/workflows/ci.yml)) calls the shared workflow of
|
||||
the NAPALM driver standard: ruff, mypy, the tests on Python 3.10–3.13, bandit,
|
||||
pip-audit and a build check.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
+54
-27
@@ -1,4 +1,3 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# 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
|
||||
@@ -33,6 +32,7 @@ management methods (``load_merge_candidate``, ``commit_config``, ...).
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import logging
|
||||
import socket
|
||||
from typing import Any
|
||||
|
||||
@@ -44,7 +44,6 @@ from fritzconnection.core.exceptions import (
|
||||
FritzServiceError,
|
||||
)
|
||||
from napalm.base.exceptions import ConnectionClosedException, ConnectionException
|
||||
|
||||
from napalm_device_types import FingerprintRule, ResidentialGatewayDriver
|
||||
from napalm_device_types.models import (
|
||||
HostDict,
|
||||
@@ -57,6 +56,12 @@ from napalm_device_types.models import (
|
||||
WirelessClientDict,
|
||||
)
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
#: The remote host of a NAT translation whose port forward names none: any host.
|
||||
#: Reported as data, never bound to.
|
||||
_ANY_REMOTE = "0.0.0.0" # nosec B104
|
||||
|
||||
# Exceptions that indicate an optional/unavailable TR-064 service or action
|
||||
# (e.g. a service not present on a given FritzOS version/model).
|
||||
_OPTIONAL_SERVICE_ERRORS = (FritzServiceError, FritzActionError, FritzConnectionException)
|
||||
@@ -345,10 +350,18 @@ class FritzBoxDriver(ResidentialGatewayDriver):
|
||||
result["dsl_downstream_max_rate"] = int(_to_float(info.get("NewDownstreamMaxRate")))
|
||||
result["dsl_upstream_max_rate"] = int(_to_float(info.get("NewUpstreamMaxRate")))
|
||||
# SNR margins and attenuation are stored as dB×10 by TR-064
|
||||
result["dsl_downstream_noise_margin"] = int(_to_float(info.get("NewDownstreamNoiseMargin")))
|
||||
result["dsl_upstream_noise_margin"] = int(_to_float(info.get("NewUpstreamNoiseMargin")))
|
||||
result["dsl_downstream_attenuation"] = int(_to_float(info.get("NewDownstreamAttenuation")))
|
||||
result["dsl_upstream_attenuation"] = int(_to_float(info.get("NewUpstreamAttenuation")))
|
||||
result["dsl_downstream_noise_margin"] = int(
|
||||
_to_float(info.get("NewDownstreamNoiseMargin"))
|
||||
)
|
||||
result["dsl_upstream_noise_margin"] = int(
|
||||
_to_float(info.get("NewUpstreamNoiseMargin"))
|
||||
)
|
||||
result["dsl_downstream_attenuation"] = int(
|
||||
_to_float(info.get("NewDownstreamAttenuation"))
|
||||
)
|
||||
result["dsl_upstream_attenuation"] = int(
|
||||
_to_float(info.get("NewUpstreamAttenuation"))
|
||||
)
|
||||
except _OPTIONAL_SERVICE_ERRORS:
|
||||
pass
|
||||
|
||||
@@ -455,9 +468,15 @@ class FritzBoxDriver(ResidentialGatewayDriver):
|
||||
ext_ip = self._call(svc, "GetExternalIPAddress").get("NewExternalIPAddress", "")
|
||||
wan_service_used = svc
|
||||
break
|
||||
except (FritzArrayIndexError, FritzServiceError, FritzActionError, FritzConnectionException):
|
||||
except (
|
||||
FritzArrayIndexError,
|
||||
FritzServiceError,
|
||||
FritzActionError,
|
||||
FritzConnectionException,
|
||||
):
|
||||
continue
|
||||
except Exception:
|
||||
logger.debug("WAN status from %s: ignored", svc, exc_info=True)
|
||||
continue
|
||||
|
||||
if wan_service_used:
|
||||
@@ -494,7 +513,9 @@ class FritzBoxDriver(ResidentialGatewayDriver):
|
||||
index = 0
|
||||
while True:
|
||||
try:
|
||||
entry = self._call(service, "GetGenericPortMappingEntry", NewPortMappingIndex=index)
|
||||
entry = self._call(
|
||||
service, "GetGenericPortMappingEntry", NewPortMappingIndex=index
|
||||
)
|
||||
except (FritzArrayIndexError, FritzConnectionException):
|
||||
break
|
||||
|
||||
@@ -530,15 +551,21 @@ class FritzBoxDriver(ResidentialGatewayDriver):
|
||||
except (FritzArrayIndexError, FritzConnectionException, FritzActionError):
|
||||
break
|
||||
proto_num = int(ph.get("NewProtocol", 0) or 0)
|
||||
proto = "TCP6" if proto_num == 6 else ("UDP6" if proto_num == 17 else str(proto_num))
|
||||
forwards.append({
|
||||
"name": ph.get("NewPinholeDescription", ""),
|
||||
"protocol": proto,
|
||||
"external_port": int(ph.get("NewRemotePort", 0) or 0),
|
||||
"internal_ip": ph.get("NewInternalIPAddress", ""),
|
||||
"internal_port": int(ph.get("NewInternalPort", 0) or 0),
|
||||
"enabled": True,
|
||||
})
|
||||
proto = (
|
||||
"TCP6"
|
||||
if proto_num == 6
|
||||
else ("UDP6" if proto_num == 17 else str(proto_num))
|
||||
)
|
||||
forwards.append(
|
||||
{
|
||||
"name": ph.get("NewPinholeDescription", ""),
|
||||
"protocol": proto,
|
||||
"external_port": int(ph.get("NewRemotePort", 0) or 0),
|
||||
"internal_ip": ph.get("NewInternalIPAddress", ""),
|
||||
"internal_port": int(ph.get("NewInternalPort", 0) or 0),
|
||||
"enabled": True,
|
||||
}
|
||||
)
|
||||
index += 1
|
||||
except _OPTIONAL_SERVICE_ERRORS:
|
||||
pass
|
||||
@@ -552,9 +579,9 @@ class FritzBoxDriver(ResidentialGatewayDriver):
|
||||
``Hosts1.GetHostNumberOfEntries`` entries.
|
||||
"""
|
||||
try:
|
||||
count = int(self._call("Hosts1", "GetHostNumberOfEntries").get(
|
||||
"NewHostNumberOfEntries", 0
|
||||
) or 0)
|
||||
count = int(
|
||||
self._call("Hosts1", "GetHostNumberOfEntries").get("NewHostNumberOfEntries", 0) or 0
|
||||
)
|
||||
except _OPTIONAL_SERVICE_ERRORS:
|
||||
return []
|
||||
|
||||
@@ -600,7 +627,7 @@ class FritzBoxDriver(ResidentialGatewayDriver):
|
||||
continue
|
||||
if ":" in forward["internal_ip"]:
|
||||
continue
|
||||
remote = forward.get("remote_host") or "0.0.0.0"
|
||||
remote = forward.get("remote_host") or _ANY_REMOTE
|
||||
translations.append(
|
||||
{
|
||||
"protocol": forward["protocol"].lower(),
|
||||
@@ -631,9 +658,9 @@ class FritzBoxDriver(ResidentialGatewayDriver):
|
||||
for service in self._wlan_services():
|
||||
try:
|
||||
ssid = self._call(service, "GetInfo").get("NewSSID", "")
|
||||
total = int(self._call(service, "GetTotalAssociations").get(
|
||||
"NewTotalAssociations", 0
|
||||
) or 0)
|
||||
total = int(
|
||||
self._call(service, "GetTotalAssociations").get("NewTotalAssociations", 0) or 0
|
||||
)
|
||||
except _OPTIONAL_SERVICE_ERRORS:
|
||||
continue
|
||||
|
||||
@@ -680,9 +707,9 @@ class FritzBoxDriver(ResidentialGatewayDriver):
|
||||
continue
|
||||
|
||||
try:
|
||||
clients = int(self._call(service, "GetTotalAssociations").get(
|
||||
"NewTotalAssociations", 0
|
||||
) or 0)
|
||||
clients = int(
|
||||
self._call(service, "GetTotalAssociations").get("NewTotalAssociations", 0) or 0
|
||||
)
|
||||
except _OPTIONAL_SERVICE_ERRORS:
|
||||
clients = 0
|
||||
|
||||
|
||||
Whitespace-only changes.
+42
-13
@@ -1,54 +1,83 @@
|
||||
[build-system]
|
||||
requires = ["setuptools>=68", "wheel"]
|
||||
requires = ["setuptools>=77"]
|
||||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "napalm-fritzbox"
|
||||
version = "0.2.0"
|
||||
version = "0.3.0"
|
||||
description = "NAPALM driver for AVM FritzBox (TR-064 via fritzconnection)."
|
||||
readme = "README.md"
|
||||
license = { text = "Apache-2.0" }
|
||||
license = "Apache-2.0"
|
||||
requires-python = ">=3.10"
|
||||
authors = [
|
||||
{ name = "Christian Manivong" },
|
||||
]
|
||||
classifiers = [
|
||||
"Topic :: Utilities",
|
||||
"License :: OSI Approved :: Apache Software License",
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Programming Language :: Python :: 3.13",
|
||||
"Operating System :: POSIX :: Linux",
|
||||
"Operating System :: MacOS",
|
||||
"Typing :: Typed",
|
||||
]
|
||||
dependencies = [
|
||||
"napalm>=4.0.0",
|
||||
"napalm_device_types>=0.4.0",
|
||||
"napalm-device-types>=4.21.1",
|
||||
"fritzconnection>=1.13.0",
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
dev = [
|
||||
"pytest",
|
||||
"pytest-cov",
|
||||
"black",
|
||||
"ruff",
|
||||
]
|
||||
dev = ["pytest>=8", "pytest-cov>=5", "mypy>=1.11", "ruff>=0.6"]
|
||||
|
||||
[project.entry-points."napalm.drivers"]
|
||||
fritzbox = "napalm_fritzbox.fritzbox:FritzBoxDriver"
|
||||
|
||||
[project.urls]
|
||||
Repository = "https://github.com/napalm-automation-community/napalm-fritzbox"
|
||||
Repository = "https://git.netork.io/NAPALM/napalm-fritzbox"
|
||||
Issues = "https://git.netork.io/NAPALM/napalm-fritzbox/issues"
|
||||
Changelog = "https://git.netork.io/NAPALM/napalm-fritzbox/src/branch/main/CHANGELOG.md"
|
||||
|
||||
[tool.setuptools.packages.find]
|
||||
where = ["."]
|
||||
include = ["napalm_fritzbox*"]
|
||||
|
||||
[tool.setuptools.package-data]
|
||||
napalm_fritzbox = ["py.typed"]
|
||||
|
||||
[tool.ruff]
|
||||
line-length = 100
|
||||
target-version = "py39"
|
||||
target-version = "py310"
|
||||
|
||||
[tool.ruff.lint]
|
||||
select = ["E", "F", "I", "UP", "B"]
|
||||
|
||||
[tool.ruff.lint.per-file-ignores]
|
||||
# Recorded device output keeps its lines.
|
||||
"tests/**" = ["E501"]
|
||||
|
||||
[tool.mypy]
|
||||
python_version = "3.10"
|
||||
strict = true
|
||||
# napalm itself is untyped, so every driver subclasses Any.
|
||||
disallow_subclassing_any = false
|
||||
|
||||
[[tool.mypy.overrides]]
|
||||
module = ["napalm.*", "fritzconnection.*"]
|
||||
ignore_missing_imports = true
|
||||
|
||||
[[tool.mypy.overrides]]
|
||||
# Not yet under strict mypy (quality baseline); may only shrink.
|
||||
module = ["napalm_fritzbox.fritzbox"]
|
||||
ignore_errors = true
|
||||
|
||||
[tool.pytest.ini_options]
|
||||
testpaths = ["tests"]
|
||||
|
||||
[tool.coverage.run]
|
||||
source = ["napalm_fritzbox"]
|
||||
|
||||
[tool.coverage.report]
|
||||
fail_under = 81
|
||||
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"coverage_floor": 81.0,
|
||||
"function_complexity": {
|
||||
"napalm_fritzbox/fritzbox.py::FritzBoxDriver.get_interfaces": 12,
|
||||
"napalm_fritzbox/fritzbox.py::FritzBoxDriver.get_port_forwards": 18,
|
||||
"napalm_fritzbox/fritzbox.py::FritzBoxDriver.get_system_config": 15,
|
||||
"napalm_fritzbox/fritzbox.py::FritzBoxDriver.get_wan_status": 12
|
||||
},
|
||||
"function_lines": {
|
||||
"napalm_fritzbox/fritzbox.py::FritzBoxDriver.get_interfaces": 71,
|
||||
"napalm_fritzbox/fritzbox.py::FritzBoxDriver.get_port_forwards": 72,
|
||||
"napalm_fritzbox/fritzbox.py::FritzBoxDriver.get_system_config": 77,
|
||||
"napalm_fritzbox/fritzbox.py::FritzBoxDriver.get_wan_status": 67
|
||||
},
|
||||
"mypy_relaxed": [
|
||||
"napalm_fritzbox.fritzbox"
|
||||
],
|
||||
"python_file_lines": {},
|
||||
"untyped_public": []
|
||||
}
|
||||
@@ -6,7 +6,6 @@ import pytest
|
||||
from fritzconnection.core.exceptions import (
|
||||
FritzActionError,
|
||||
FritzArrayIndexError,
|
||||
FritzServiceError,
|
||||
)
|
||||
from napalm.base.exceptions import ConnectionClosedException, ConnectionException
|
||||
|
||||
@@ -135,9 +134,9 @@ DSL_INFO = {
|
||||
"NewDownstreamMaxRate": 120000,
|
||||
"NewUpstreamMaxRate": 50000,
|
||||
"NewDownstreamNoiseMargin": 120, # 12.0 dB
|
||||
"NewUpstreamNoiseMargin": 80, # 8.0 dB
|
||||
"NewUpstreamNoiseMargin": 80, # 8.0 dB
|
||||
"NewDownstreamAttenuation": 150, # 15.0 dB
|
||||
"NewUpstreamAttenuation": 90, # 9.0 dB
|
||||
"NewUpstreamAttenuation": 90, # 9.0 dB
|
||||
}
|
||||
|
||||
DSL_STATS = {
|
||||
@@ -639,7 +638,8 @@ class TestPPPoEInterface:
|
||||
class TestAutoMaxBitRate:
|
||||
def test_lan_speed_zero_when_auto(self, driver):
|
||||
driver.fc.call_action.side_effect = lambda svc, act, **kw: (
|
||||
LAN_INFO_AUTO_RATE if (svc, act) == ("LANEthernetInterfaceConfig1", "GetInfo")
|
||||
LAN_INFO_AUTO_RATE
|
||||
if (svc, act) == ("LANEthernetInterfaceConfig1", "GetInfo")
|
||||
else _call_action(svc, act, **kw)
|
||||
)
|
||||
interfaces = driver.get_interfaces()
|
||||
@@ -690,7 +690,8 @@ class TestGetSystemConfig:
|
||||
|
||||
def test_firmware_not_available_when_none(self, driver):
|
||||
driver.fc.call_action.side_effect = lambda svc, act, **kw: (
|
||||
UI_INFO_NO_UPDATE if (svc, act) == ("UserInterface1", "X_AVM-DE_GetInfo")
|
||||
UI_INFO_NO_UPDATE
|
||||
if (svc, act) == ("UserInterface1", "X_AVM-DE_GetInfo")
|
||||
else _call_action(svc, act, **kw)
|
||||
)
|
||||
assert driver.get_system_config()["firmware_update_available"] is False
|
||||
@@ -730,8 +731,9 @@ class TestIPv6Pinholes:
|
||||
def test_pinholes_are_not_reported_as_nat_translations(self, driver):
|
||||
"""A pinhole opens the firewall for a globally routable address; there
|
||||
is nothing to translate."""
|
||||
assert all(":" not in t["inside_local"].rsplit(":", 1)[0]
|
||||
for t in driver.get_nat_translations())
|
||||
assert all(
|
||||
":" not in t["inside_local"].rsplit(":", 1)[0] for t in driver.get_nat_translations()
|
||||
)
|
||||
|
||||
def test_no_pinholes_without_ipv6_service(self, driver):
|
||||
del driver.fc.services["WANIPv6Firewall1"]
|
||||
|
||||
Reference in new issue
Block a user