RenWal · ma4nn · Oct 6, 2021 · Oct 6, 2021 · Oct 6, 2021 · Oct 8, 2021
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
diff --git a/.github/workflows/pylint.yml b/.github/workflows/pylint.yml
diff --git a/.github/workflows/verify-plugin-scripts.yml b/.github/workflows/verify-plugin-scripts.yml
@@ -0,0 +1,35 @@
+name: Verify Plugin Scripts
+
+on: [push,workflow_dispatch,pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        cache: 'pip'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.dev.txt
+        pip install -r requirements.txt
+    - name: Analysing the code with pylint
+      run: |
+        pylint --errors-only $(find src/ -name "*.py" | xargs)
+    - name: Running tests
+      run: |
+        pytest --cov
+    - name: Archive production artifacts
+      if: ${{ matrix.python-version == '3.12' }}
+      uses: actions/upload-artifact@v4
+      with:
+        name: fritzbox-munin-plugins
+        path: src/fritzbox*.py
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -1,8 +1,10 @@
-## fritzbox-munin-fast contributors
+## fritzbox-munin-fast Contributors
+
+Special thanks to all the people who had helped this project so far:
 
  - Bob van de Vijver ([bobvandevijver](https://github.com/bobvandevijver))
  - Framps ([framps](https://github.com/framps))
- - Christian Stade-Schuldt
+ - Christian Stade-Schuldt ([Tafkas](https://github.com/Tafkas))
  - Oliver Edelmann
  - Rene Walendy ([RenWal](https://github.com/RenWal))
- - Christoph Massmann ([christophmassmann](https://github.com/christophmassmann))
+ - Christoph Massmann ([ma4nn](https://github.com/ma4nn))
diff --git a/README.md b/README.md
@@ -1,30 +1,41 @@
-# Munin Plugins for FritzBox
+# Munin Plugins for FRITZ!Box
 
-A collection of munin plugins to monitor your AVM FRITZ!Box router. The scripts have been developed using a FRITZ!Box 7590 running FRITZ!OS 7.50 and a FRITZ!WLAN Repeater 1750E running FRITZ!OS 7.27.
+![build status](https://github.com/ma4nn/fritzbox-munin-fast/actions/workflows/verify-plugin-scripts.yml/badge.svg)
 
-If you are using the scripts on a different FRITZ!Box model please let me know by
+A collection of [Munin](https://munin-monitoring.org) plugins to monitor your [AVM FRITZ!Box](https://avm.de/produkte/fritzbox/) router.  
+The values are retrieved via the [fritzconnection](https://pypi.org/project/fritzconnection/) project.
+
+So far the following FRITZ!Box models have been confirmed working:
 
-- opening an issue
-- submitting a pull request
+| Model            | Fritz!OS Version(s) |
+|------------------|---------------------|
+| FritzBox 7590    | 7.28 - 7.57         |
+| FritzBox 7530 AX | 7.80 - 8.02         |
+
+If you are using the scripts on a different FRITZ!Box model please let me know by
 
-These python scripts are [Munin](http://munin-monitoring.org) plugins for monitoring the [FRITZ!Box](https://avm.de/produkte/fritzbox/) router by AVM. 
+- Opening an issue
+- Submitting a pull request
 
 ## Purpose of this Fork
 
-The scripts are build upon the original [fritzbox-munin](https://github.com/Tafkas/fritzbox-munin) with the goal to make use of the modern APIs that FRITZ!OS 7 provides.  
+These scripts are build upon the original [fritzbox-munin](https://github.com/Tafkas/fritzbox-munin) with the goal to make 
+use of the more modern APIs that Fritz!OS 7 provides.
+
 The main differences to the original version are:
-- Compatibility with latest FRITZ!OS version using username/password authentication
-- No HTML Scraping is used
+- Compatibility with latest Fritz!OS version using username/password authentication
+- No HTML scraping
 - All data is fetched either through the TR-064 interface or the JSON API
 - Contrary to the original version this fork uses multigraphs: this removes the need to query the same API endpoint multiple times, all multigraph plugins have configuration options to switch individual graphs on and off
 - Support for Smart Home devices, e.g. for measuring temperature
-- Complete refactoring of the Python code base to make it more robust, use modern language features like type hinting and reuse identical code
-- Add possibility to connect to FRITZ!Box via TLS
+- Complete refactoring of the Python code base to make it more robust, use modern language features like type hinting, tests and remove code duplication
+- Added possibility to connect to FRITZ!Box via TLS
+- Added automated testing via GitHub Actions
 
 ## Requirements
-- FRITZ!Box router with FRITZ!OS >= 07.50 (if you are on an older FRITZ!OS version, select an older version of fritzbox-munin-fast by browsing the tags in this repository)
+- FRITZ!Box router with FRITZ!OS >= 7.50 (if you are on an older FRITZ!OS version, select an older version of fritzbox-munin-fast by browsing the tags in this repository)
 - Munin 1.4.0 or later is required
-- Python 3.x
+- Python >= 3.9
 
 ## Available Plugins
 
@@ -50,8 +61,14 @@ Multigraph plugin, showing:
  - CPU load
  - CPU temperature
 
-### Smart Home Temperature
-Plugin: `fritzbox_smart_home_temperature.py`  
+### Smart Home
+Plugin: `fritzbox_smart_home.py`  
+Multigraph plugin, showing:
+ - temperature sensors
+ - switch states
+ - power values
+ - energy consumption values
+
 ![Smart Home Temperature](doc/smart_home_temperature.png)
 
 ### Energy
@@ -77,38 +94,39 @@ Multigraph plugin, showing for 2.4GHz and 5GHz
 
 ## Installation & Configuration
 
-1. Pre-requisites for the `fritzbox_traffic` and `fritzbox_connection_uptime` plugins are the [fritzconnection](https://pypi.python.org/pypi/fritzconnection) and [requests](https://pypi.python.org/pypi/requests) package. To install run
+1. To install requirements run
 
         pip install -r requirements.txt
 
-1. Make sure the FRITZ!Box has UPnP status information enabled. (web interface: _Home Network > Network > Network Settings > Universal Plug & Play (UPnP)_)
+1. Make sure the FRITZ!Box has UPnP status information enabled. (web interface: _Home Network → Network → Network Settings → Universal Plug & Play (UPnP)_)
 
-1. Copy all the scripts from `src/` folder to `/usr/share/munin/plugins`
+1. Copy all the scripts from the [published release](https://github.com/ma4nn/fritzbox-munin-fast/releases) to `/usr/share/munin/plugins`
 
-1. (optional) If you want to connect to FRITZ!Box using SSL, download the Fritz certificate (web interface: _Internet > Freigaben > FritzBox Dienste > Zertifikat > Zertifikat herunterladen_) and save it to `/etc/munin/box.cer`.
+1. (optional) If you want to connect to FRITZ!Box using SSL, download the Fritz certificate (web interface: _Internet → Freigaben → FritzBox Dienste → Zertifikat → Zertifikat herunterladen_) and save it to `/etc/munin/box.cer`.
+   The certificate might change after a FRITZ!Box Update.
 
 1. Create entry in `/etc/munin/plugin-conf.d/munin-node`:
 
         [fritzbox_*]
-        env.fritzbox_password <fritzbox_password>
         env.fritzbox_user <fritzbox_user>
+        env.fritzbox_password <fritzbox_password>
         env.fritzbox_use_tls true
         host_name fritzbox
 
    See the plugin files for plugin-specific configuration options.
 
-1. For each plugin you want to activate, create a symbolic link to `/etc/munin/plugins`, e.g.:
+1. For each plugin you want to activate, create a symbolic link to `/etc/munin/plugins` and make it executable, e.g.:
    ```
-   ln -s fritzbox_dsl.py /etc/munin/plugins/fritzbox_dsl.py
+   ln -s fritzbox_dsl.py /etc/munin/plugins/fritzbox_dsl.py && chmod +x /etc/munin/plugins/fritzbox_dsl.py
    ```
 
 1. Restart the munin-node daemon: `service munin-node restart`.
 
-1. Done. You should now start to see the charts on the Munin pages!
+1. Done. You should now start to see the charts on the Munin pages🥳
 
 ## Localization
 
-The `fritzbox_energy` script depends on the language selected in your FRITZ!Box. Currently, two locales are
+The `fritzbox_energy.py` script depends on the language selected in your FRITZ!Box. Currently, two locales are
 supported:
 
 1. German: `de` (default)
@@ -128,7 +146,6 @@ You can split the graphs of your FRITZ!Box from the localhost graphs by followin
             address 127.0.0.1
             use_node_name yes
 
-
         [home.yourhost.net;fritzbox]
             address 127.0.0.1
             use_node_name no
@@ -137,7 +154,16 @@ You can split the graphs of your FRITZ!Box from the localhost graphs by followin
 
 ## Testing
 
-To test a plugin use
+### Manual Testing
+
+To manually test a plugin use
+```
+munin-run --pidebug fritzbox_connection_uptime.py
+```
+
+### Unit Tests
+
+Run all unit tests with
 ```
-munin-run --debug fritzbox_connection_uptime.py
+pytest --cov
 ```
diff --git a/pylintrc b/pylintrc
@@ -85,7 +85,8 @@ disable=raw-checker-failed,
         suppressed-message,
         useless-suppression,
         deprecated-pragma,
-        use-symbolic-message-instead
+        use-symbolic-message-instead,
+        line-too-long
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

diff --git a/requirements.dev.txt b/requirements.dev.txt
@@ -0,0 +1,3 @@
+pylint
+pytest
+pytest-cov
diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,3 @@
-fritzconnection>=1.3.0
+fritzconnection>=1.12.0
 requests
 lxml
diff --git a/src/FritzboxConfig.py b/src/FritzboxConfig.py
diff --git a/src/FritzboxFileSession.py b/src/FritzboxFileSession.py
diff --git a/src/conftest.py b/src/conftest.py
@@ -0,0 +1,18 @@
+from unittest.mock import patch
+import pytest
+from test_response_mock import ResponseMock
+from test_fritzconnection_mock import FritzConnectionMock
+
+# @see https://docs.pytest.org/en/7.3.x/example/parametrize.html#indirect-parametrization
+
+
+@pytest.fixture(autouse=True)
+def fixture_version(request):  # request param is fixture
+  with patch('requests.request', side_effect=ResponseMock) as mock_requests:
+    mock_requests.side_effect.version = request.param if hasattr(request, "param") else None
+    yield
+
+
+@pytest.fixture(autouse=True)
+def connection(request):
+  return FritzConnectionMock(version=request.param if hasattr(request, "param") else None)