Merge branch 'main' of https://github.com/s-allius/tsun-gen3-proxy into s-allius/issue415

Fixes #415

.github/workflows/python-app.yml

@@ -5,7 +5,7 @@ name: Python application
 
 on:
   push:
-    branches: [ "main", "dev-*", "*/issue*" ]
+    branches: [ "main", "dev-*", "*/issue*", "releases/*" ]
     paths-ignore:
     - '**.md' # Do no build on *.md changes
     - '**.yml' # Do no build on *.yml changes
@@ -18,7 +18,7 @@ on:
     - '**.dockerfile' # Do no build on *.dockerfile changes
     - '**.sh' # Do no build on *.sh changes     
   pull_request:
-    branches: [ "main", "dev-*" ]
+    branches: [ "main", "dev-*", "releases/*" ]
 
 permissions:
   contents: read

.python-version

@@ -1 +1 @@
-3.13.2
+3.13.4

CHANGELOG.md

@@ -7,10 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+- Update dependency pytest-asyncio to v1
+
+## [0.14.1] - 2025-05-31
+
+- handle missing MQTT addon [#438](https://github.com/s-allius/tsun-gen3-proxy/issues/438)
+
+## [0.14.0] - 2025-05-29
+
 - add-on: bump python to version 3.12.10-r1
 - set no of pv modules for MS800 GEN3PLUS inverters
 - fix the paths to copy the config.example.toml file during proxy start
 - add MQTT topic `dcu_power` for setting output power on DCUs
+- add MQTT topic `dcu_power` for setting output power on DCUs
 - Update ghcr.io/hassio-addons/base Docker tag to v17.2.5
 - fix a lot of pytest-asyncio problems in the unit tests  
 - Cleanup startup code for Quart and the Proxy

app/.version

@@ -1 +1 @@
-0.14.0
+0.15.0

app/requirements-test.txt

@@ -1,8 +1,8 @@
     flake8==7.2.0
-    pytest==8.3.5
+    pytest==8.4.0
-    pytest-asyncio==0.26.0
+    pytest-asyncio==1.0.0
-    pytest-cov==6.1.1
+    pytest-cov==6.2.1
     python-dotenv==1.1.0
     mock==5.2.0
-    coverage==7.8.2
+    coverage==7.9.0
     jinja2-cli==0.8.2

app/src/scheduler.py

@@ -12,7 +12,7 @@ class Schedule:
     count = 0
 
     @classmethod
-    def start(cls) -> None:
+    def start(cls) -> None:    # pragma: no cover
         '''Start the scheduler and schedule the tasks (cron jobs)'''
         logging.debug("Scheduler init")
         cls.mqtt = Mqtt(None)
@@ -20,7 +20,7 @@ class Schedule:
         crontab('0 0 * * *', func=cls.atmidnight, start=True)
 
     @classmethod
-    async def atmidnight(cls) -> None:
+    async def atmidnight(cls) -> None:    # pragma: no cover
         '''Clear daily counters at midnight'''
         logging.info("Clear daily counters at midnight")
 

app/tests/test_mqtt.py

@@ -3,8 +3,7 @@ import pytest
 import asyncio
 import aiomqtt
 import logging
-from aiomqtt import MqttError, MessagesIterator
+from aiomqtt import MqttError
-from aiomqtt import Message as AiomqttMessage
 from mock import patch, Mock
 
 from async_stream import AsyncIfcImpl
@@ -35,26 +34,6 @@ def test_hostname():
     # else:
         return 'test.mosquitto.org'
 
-@pytest.fixture(scope="function")
-def aiomqtt_mock(monkeypatch):
-    recv_que = asyncio.Queue()
-        
-    async def my_aenter(self):
-        return self
-    async def my_subscribe(self, *arg):
-        return
-    async def my_anext(self):
-        return await recv_que.get()
-    async def my_receive(self, topic: str, payload: bytes):
-        msg = AiomqttMessage(topic, payload,qos=0, retain=False, mid=0, properties=None)
-        await recv_que.put(msg)
-        await asyncio.sleep(0)  # dispath the msg
-
-    monkeypatch.setattr(aiomqtt.Client, "__aenter__", my_aenter)
-    monkeypatch.setattr(aiomqtt.Client, "subscribe", my_subscribe)
-    monkeypatch.setattr(MessagesIterator, "__anext__", my_anext)
-    monkeypatch.setattr(Mqtt, "receive", my_receive, False)
-
 @pytest.fixture
 def config_mqtt_conn(test_hostname, test_port):
     Config.act_config = {'mqtt':{'host': test_hostname, 'port': test_port, 'user': '', 'passwd': ''},
@@ -271,97 +250,92 @@ async def test_mqtt_except_def_config(config_def_conn, monkeypatch, caplog):
     assert 'MQTT is unconfigured; Check your config.toml!' in caplog.text
 
 @pytest.mark.asyncio
-async def test_mqtt_dispatch(config_mqtt_conn, aiomqtt_mock, spy_modbus_cmd):
+async def test_msg_dispatch(config_mqtt_conn, spy_modbus_cmd):
     _ = config_mqtt_conn
-    _ = aiomqtt_mock
     spy = spy_modbus_cmd
     try:
         m = Mqtt(None)
-        assert m.ha_restarts == 0
+        msg = aiomqtt.Message(topic= 'homeassistant/status', payload= b'online', qos= 0, retain = False, mid= 0, properties= None)
-        await m.receive('homeassistant/status', b'online')  # send the message
+        await m.dispatch_msg(msg)
         assert m.ha_restarts == 1
 
-        await m.receive(topic= 'tsun/inv_1/rated_load', payload= b'2')
+        msg = aiomqtt.Message(topic= 'tsun/inv_1/rated_load', payload= b'2', qos= 0, retain = False, mid= 0, properties= None)
+        await m.dispatch_msg(msg)
         spy.assert_awaited_once_with(Modbus.WRITE_SINGLE_REG, 0x2008, 2, logging.INFO)
-
+        
         spy.reset_mock()
-        await m.receive(topic= 'tsun/inv_1/out_coeff', payload= b'100')
+        msg = aiomqtt.Message(topic= 'tsun/inv_1/out_coeff', payload= b'100', qos= 0, retain = False, mid= 0, properties= None)
+        await m.dispatch_msg(msg)
         spy.assert_awaited_once_with(Modbus.WRITE_SINGLE_REG, 0x202c, 1024, logging.INFO)
         
         spy.reset_mock()
-        await m.receive(topic= 'tsun/inv_1/out_coeff', payload= b'50')
+        msg = aiomqtt.Message(topic= 'tsun/inv_1/out_coeff', payload= b'50', qos= 0, retain = False, mid= 0, properties= None)
+        await m.dispatch_msg(msg)
         spy.assert_awaited_once_with(Modbus.WRITE_SINGLE_REG, 0x202c, 512, logging.INFO)
     
         spy.reset_mock()
-        await m.receive(topic= 'tsun/inv_1/modbus_read_regs', payload= b'0x3000, 10')
+        msg = aiomqtt.Message(topic= 'tsun/inv_1/modbus_read_regs', payload= b'0x3000, 10', qos= 0, retain = False, mid= 0, properties= None)
+        await m.dispatch_msg(msg)
         spy.assert_awaited_once_with(Modbus.READ_REGS, 0x3000, 10, logging.INFO)
 
         spy.reset_mock()
-        await m.receive(topic= 'tsun/inv_1/modbus_read_inputs', payload= b'0x3000, 10')
+        msg = aiomqtt.Message(topic= 'tsun/inv_1/modbus_read_inputs', payload= b'0x3000, 10', qos= 0, retain = False, mid= 0, properties= None)
+        await m.dispatch_msg(msg)
         spy.assert_awaited_once_with(Modbus.READ_INPUTS, 0x3000, 10, logging.INFO)
 
         # test dispatching with empty mapping table
         m.topic_defs.clear()
         spy.reset_mock()
-        await m.receive(topic= 'tsun/inv_1/modbus_read_inputs', payload= b'0x3000, 10')
+        msg = aiomqtt.Message(topic= 'tsun/inv_1/modbus_read_inputs', payload= b'0x3000, 10', qos= 0, retain = False, mid= 0, properties= None)
+        await m.dispatch_msg(msg)
         spy.assert_not_called()
 
         # test dispatching with incomplete mapping table - invalid fnc defined
         m.topic_defs.append(
             {'prefix': 'entity_prefix', 'topic': '/+/modbus_read_inputs',
-             'full_topic': 'tsun/+/modbus_read_inputs', 'fnc': 'addr'}
+             'full_topic': 'tsun/+/modbus_read_inputs', 'fnc': 'invalid'}
         )
         spy.reset_mock()
-        await m.receive(topic= 'tsun/inv_1/modbus_read_inputs', payload= b'0x3000, 10')
+        msg = aiomqtt.Message(topic= 'tsun/inv_1/modbus_read_inputs', payload= b'0x3000, 10', qos= 0, retain = False, mid= 0, properties= None)
+        await m.dispatch_msg(msg)
         spy.assert_not_called()
 
-    except MqttError:
-        assert False
-    except Exception:
-        assert False          
     finally:
         await m.close()
 
 @pytest.mark.asyncio
-async def test_mqtt_dispatch_err(config_mqtt_conn, aiomqtt_mock, spy_modbus_cmd, caplog):
+async def test_msg_dispatch_err(config_mqtt_conn, spy_modbus_cmd):
     _ = config_mqtt_conn
-    _ = aiomqtt_mock
     spy = spy_modbus_cmd
-
-    LOGGER = logging.getLogger("mqtt")
-    LOGGER.propagate = True
-    LOGGER.setLevel(logging.INFO)
-
     try:
         m = Mqtt(None)
-
         # test out of range param
-        await m.receive(topic= 'tsun/inv_1/out_coeff', payload= b'-1')
+        msg = aiomqtt.Message(topic= 'tsun/inv_1/out_coeff', payload= b'-1', qos= 0, retain = False, mid= 0, properties= None)
+        await m.dispatch_msg(msg)
         spy.assert_not_called()
 
         # test unknown node_id
-        await m.receive(topic= 'tsun/inv_2/out_coeff', payload= b'2')
+        spy.reset_mock()
+        msg = aiomqtt.Message(topic= 'tsun/inv_2/out_coeff', payload= b'2', qos= 0, retain = False, mid= 0, properties= None)
+        await m.dispatch_msg(msg)
         spy.assert_not_called()
 
         # test invalid fload param
-        await m.receive(topic= 'tsun/inv_1/out_coeff', payload= b'2, 3')
+        spy.reset_mock()
-        spy.assert_not_called()
+        msg = aiomqtt.Message(topic= 'tsun/inv_1/out_coeff', payload= b'2, 3', qos= 0, retain = False, mid= 0, properties= None)
-    
+        await m.dispatch_msg(msg)
-        await m.receive(topic= 'tsun/inv_1/modbus_read_regs', payload= b'0x3000, 10, 7')
         spy.assert_not_called()
 
-        await m.receive(topic= 'tsun/inv_1/dcu_power', payload= b'100W')
+        spy.reset_mock()
+        msg = aiomqtt.Message(topic= 'tsun/inv_1/modbus_read_regs', payload= b'0x3000, 10, 7', qos= 0, retain = False, mid= 0, properties= None)
+        await m.dispatch_msg(msg)
+        spy.assert_not_called()
+
+        spy.reset_mock()
+        msg = aiomqtt.Message(topic= 'tsun/inv_1/dcu_power', payload= b'100W', qos= 0, retain = False, mid= 0, properties= None)
+        await m.dispatch_msg(msg)
         spy.assert_not_called()
 
-        with caplog.at_level(logging.INFO):
-            msg = aiomqtt.Message(topic= 'tsun/inv_1/out_coeff', payload= b'2', qos= 0, retain = False, mid= 0, properties= None)
-            for _ in m.each_inverter(msg, "addr"):
-                pass  # do nothing here
-        assert 'Cmd not supported by: inv_1/' in caplog.text
-    except MqttError:
-        assert False
-    except Exception:
-        assert False          
     finally:
         await m.close()
 

app/tests/test_server.py

@@ -4,6 +4,10 @@ import logging
 import os
 from mock import patch
 from server import app, Server, ProxyState, HypercornLogHndl
+from inverter_base import InverterBase
+from gen3.talent import Talent
+
+from test_inverter_base import FakeReader, FakeWriter
 
 pytest_plugins = ('pytest_asyncio',)
 
@@ -108,20 +112,20 @@ class TestServerClass:
         assert logging.getLogger('hypercorn.access').level == logging.INFO
         assert logging.getLogger('hypercorn.error').level == logging.INFO
 
-        os.environ["LOG_LVL"] = "WARN"
+        with patch.dict(os.environ, {'LOG_LVL': 'WARN'}):
-        s.parse_args(['--log_backups', '3'])
+            s.parse_args(['--log_backups', '3'])
-        s.init_logging_system()
+            s.init_logging_system()
-        assert s.log_backups == 3
+            assert s.log_backups == 3
-        assert s.log_level == logging.WARNING
+            assert s.log_level == logging.WARNING
-        assert logging.handlers.log_backups == 3
+            assert logging.handlers.log_backups == 3
-        assert logging.getLogger().level == s.log_level
+            assert logging.getLogger().level == s.log_level
-        assert logging.getLogger('msg').level == s.log_level
+            assert logging.getLogger('msg').level == s.log_level
-        assert logging.getLogger('conn').level == s.log_level
+            assert logging.getLogger('conn').level == s.log_level
-        assert logging.getLogger('data').level == s.log_level
+            assert logging.getLogger('data').level == s.log_level
-        assert logging.getLogger('tracer').level == s.log_level
+            assert logging.getLogger('tracer').level == s.log_level
-        assert logging.getLogger('asyncio').level == s.log_level
+            assert logging.getLogger('asyncio').level == s.log_level
-        assert logging.getLogger('hypercorn.access').level == logging.INFO
+            assert logging.getLogger('hypercorn.access').level == logging.INFO
-        assert logging.getLogger('hypercorn.error').level == logging.INFO
+            assert logging.getLogger('hypercorn.error').level == logging.INFO
 
     def test_build_config_error(self, caplog):
         s = self.FakeServer()
@@ -202,17 +206,81 @@ class TestApp:
     @pytest.mark.asyncio
     async def test_healthy(self):
         """Test the healthy route."""
+        reader = FakeReader()
+        writer =  FakeWriter()
 
-        ProxyState.set_up(False)
+        with InverterBase(reader, writer, 'tsun', Talent):
-        client = app.test_client()
+            ProxyState.set_up(False)
-        response = await client.get('/-/healthy')
+            client = app.test_client()
-        assert response.status_code == 200
+            response = await client.get('/-/healthy')
-        result = await response.get_data()
+            assert response.status_code == 200
-        assert result == b"I'm fine"
+            result = await response.get_data()
+            assert result == b"I'm fine"
 
-        ProxyState.set_up(True)
+            ProxyState.set_up(True)
-        response = await client.get('/-/healthy')
+            response = await client.get('/-/healthy')
-        assert response.status_code == 200
+            assert response.status_code == 200
-        result = await response.get_data()
+            result = await response.get_data()
-        assert result == b"I'm fine"
+            assert result == b"I'm fine"
 
+    @pytest.mark.asyncio
+    async def test_unhealthy(self, monkeypatch, caplog):
+        """Test the healthy route."""
+        def result_false(self):
+            return False
+        
+        LOGGER = logging.getLogger("mqtt")
+        LOGGER.propagate = True
+        LOGGER.setLevel(logging.INFO)
+
+        monkeypatch.setattr(InverterBase, "healthy", result_false)
+        InverterBase._registry.clear()
+        reader = FakeReader()
+        writer = FakeWriter()
+
+        with caplog.at_level(logging.INFO) and InverterBase(reader, writer, 'tsun', Talent):
+            ProxyState.set_up(False)
+            client = app.test_client()
+            response = await client.get('/-/healthy')
+            assert response.status_code == 200
+            result = await response.get_data()
+            assert result == b"I'm fine"
+            assert "" == caplog.text
+
+            ProxyState.set_up(True)
+            response = await client.get('/-/healthy')
+            assert response.status_code == 503
+            result = await response.get_data()
+            assert result == b"I have a problem"
+            assert "" == caplog.text
+
+    @pytest.mark.asyncio
+    async def test_healthy_exception(self, monkeypatch, caplog):
+        """Test the healthy route."""
+        def result_except(self):
+            raise ValueError
+        
+        LOGGER = logging.getLogger("mqtt")
+        LOGGER.propagate = True
+        LOGGER.setLevel(logging.INFO)
+
+        monkeypatch.setattr(InverterBase, "healthy", result_except)
+        InverterBase._registry.clear()
+        reader = FakeReader()
+        writer = FakeWriter()
+
+        with caplog.at_level(logging.INFO) and InverterBase(reader, writer, 'tsun', Talent):
+            ProxyState.set_up(False)
+            client = app.test_client()
+            response = await client.get('/-/healthy')
+            assert response.status_code == 200
+            result = await response.get_data()
+            assert result == b"I'm fine"
+            assert "" == caplog.text
+
+            ProxyState.set_up(True)
+            response = await client.get('/-/healthy')
+            assert response.status_code == 200
+            result = await response.get_data()
+            assert result == b"I'm fine"
+            assert "Exception:" in caplog.text

app/tests/test_solarman.py

@@ -2662,7 +2662,6 @@ async def test_proxy_dcu_cmd(my_loop, config_tsun_dcu1, patch_open_connection, d
         assert l.db.stat['proxy']['AT_Command'] == 0
         assert l.db.stat['proxy']['AT_Command_Blocked'] == 0
         assert l.db.stat['proxy']['Modbus_Command'] == 0
-        assert 2 == l.db.get_db_value(Register.NO_INPUTS, 0)
 
         l.append_msg(dcu_command_rsp_msg)
         l.read() # read at resp

app/translations/de/LC_MESSAGES/messages.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: tsun-gen3-proxy 0.14.0\n"
 "Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
-"POT-Creation-Date: 2025-05-13 22:34+0200\n"
+"POT-Creation-Date: 2025-05-18 15:30+0200\n"
 "PO-Revision-Date: 2025-04-18 16:24+0200\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language: de\n"
@@ -120,6 +120,7 @@ msgid "TSUN Proxy - Log Files"
 msgstr "TSUN Proxy - Log Dateien"
 
 #: src/web/templates/page_logging.html.j2:10
+#, python-format
 msgid "Do you really want to delete the log file: <br>%(file)s ?"
 msgstr "Soll die Datei: <br>%(file)s<br>wirklich gelöscht werden?"
 

ha_addons/Makefile

@@ -192,7 +192,7 @@ $(repro_all_subdirs) :
 	mkdir -p $@
 
 $(repro_all_templates) : $(INST_BASE)/ha_addon_%/config.yaml: $(TEMPL)/config.jinja $(TEMPL)/%_data.json $(SRC)/.version FORCE
-	$(JINJA) --strict -D AppVersion=$(VERSION)-$* -D BuildID=$(BUILD_ID) $< $(filter %.json,$^) -o $@
+	$(JINJA) --strict -D AppVersion=$(VERSION)-$*$(RC) -D BuildID=$(BUILD_ID) $< $(filter %.json,$^) -o $@
 
 $(repro_all_apparmor) : $(INST_BASE)/ha_addon_%/apparmor.txt: $(TEMPL)/apparmor.jinja $(TEMPL)/%_data.json
 	$(JINJA) --strict $< $(filter %.json,$^) -o $@

ha_addons/ha_addon/rootfs/run.sh

@@ -1,18 +1,28 @@
 #!/usr/bin/with-contenv bashio
 
-echo "Add-on environment started"
+bashio::log.blue "-----------------------------------------------------------"
-
+bashio::log.blue "run.sh: info: setup Add-on environment"
-echo "check for Home Assistant MQTT"
+bashio::cache.flush_all
-MQTT_HOST=$(bashio::services mqtt "host")
+MQTT_HOST=""
-MQTT_PORT=$(bashio::services mqtt "port")
+if bashio::supervisor.ping; then
-MQTT_USER=$(bashio::services mqtt "username")
+    bashio::log "run.sh: info: check for Home Assistant MQTT service"
-MQTT_PASSWORD=$(bashio::services mqtt "password")
+    if bashio::services.available mqtt; then
+        MQTT_HOST=$(bashio::services mqtt "host")
+        MQTT_PORT=$(bashio::services mqtt "port")
+        MQTT_USER=$(bashio::services mqtt "username")
+        MQTT_PASSWORD=$(bashio::services mqtt "password")
+    else
+        bashio::log.yellow "run.sh: info: Home Assistant MQTT service not available!"
+    fi
+else
+    bashio::log.red "run.sh: error: Home Assistant Supervisor API not available!"
+fi
 
 # if a MQTT was/not found, drop a note
 if [ -z "$MQTT_HOST" ]; then
-    echo "MQTT not found"
+    bashio::log.yellow "run.sh: info: MQTT config not found"
 else
-    echo "MQTT found"
+    bashio::log.green "run.sh: info: MQTT config found"
     export MQTT_HOST
     export MQTT_PORT
     export MQTT_USER
@@ -29,5 +39,6 @@ cd /home/proxy || exit
 
 export VERSION=$(cat /proxy-version.txt)
 
-echo "Start Proxyserver..."
+bashio::log.blue "run.sh: info: Start Proxyserver..."
+bashio::log.blue "-----------------------------------------------------------"
 python3 server.py --rel_urls --json_config=/data/options.json  --log_path=/homeassistant/tsun-proxy/logs/ --config_path=/homeassistant/tsun-proxy/ --log_backups=2