new version 0.14.1

- we have to check if the supervisor API and a
MQTT broker add-on is installed. If not we assume
the user has an external MQTT broker

.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

CHANGELOG.md

@@ -5,7 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [unreleased]
+## [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

app/.version

@@ -1 +1 @@
-0.14.0
+0.14.1

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

@@ -182,13 +182,17 @@ async def test_ha_reconnect(config_mqtt_conn):
         await m.close()
 
 @pytest.mark.asyncio
-async def test_mqtt_no_config(config_no_conn):
+async def test_mqtt_no_config(config_no_conn, monkeypatch):
     _ = config_no_conn
     assert asyncio.get_running_loop()
 
     on_connect =  asyncio.Event()
     async def cb():
         on_connect.set()
+    async def my_publish(*args):
+        return
+
+    monkeypatch.setattr(aiomqtt.Client, "publish", my_publish)
 
     try:
         m = Mqtt(cb)
@@ -197,9 +201,9 @@ async def test_mqtt_no_config(config_no_conn):
         assert not on_connect.is_set()
         try:
             await m.publish('homeassistant/status', 'online')
-            assert False
+            assert m.published == 1
         except Exception:
-            pass          
+            assert False          
     except TimeoutError:
         assert False
     finally:
@@ -322,6 +326,28 @@ async def test_mqtt_dispatch(config_mqtt_conn, aiomqtt_mock, spy_modbus_cmd):
     finally:
         await m.close()
 
+@pytest.mark.asyncio
+async def test_mqtt_dispatch_cb(config_mqtt_conn, aiomqtt_mock):
+    _ = config_mqtt_conn
+    _ = aiomqtt_mock
+
+    on_connect =  asyncio.Event()
+    async def cb():
+        on_connect.set()
+    try:
+        m = Mqtt(cb)
+        assert m.ha_restarts == 0
+        await m.receive('homeassistant/status', b'online')  # send the message
+        assert on_connect.is_set()
+        assert m.ha_restarts == 1
+
+    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):
     _ = config_mqtt_conn

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"
-        s.parse_args(['--log_backups', '3'])
-        s.init_logging_system()
-        assert s.log_backups == 3
-        assert s.log_level == logging.WARNING
-        assert logging.handlers.log_backups == 3
-        assert logging.getLogger().level == s.log_level
-        assert logging.getLogger('msg').level == s.log_level
-        assert logging.getLogger('conn').level == s.log_level
-        assert logging.getLogger('data').level == s.log_level
-        assert logging.getLogger('tracer').level == s.log_level
-        assert logging.getLogger('asyncio').level == s.log_level
-        assert logging.getLogger('hypercorn.access').level == logging.INFO
-        assert logging.getLogger('hypercorn.error').level == logging.INFO
+        with patch.dict(os.environ, {'LOG_LVL': 'WARN'}):
+            s.parse_args(['--log_backups', '3'])
+            s.init_logging_system()
+            assert s.log_backups == 3
+            assert s.log_level == logging.WARNING
+            assert logging.handlers.log_backups == 3
+            assert logging.getLogger().level == s.log_level
+            assert logging.getLogger('msg').level == s.log_level
+            assert logging.getLogger('conn').level == s.log_level
+            assert logging.getLogger('data').level == s.log_level
+            assert logging.getLogger('tracer').level == s.log_level
+            assert logging.getLogger('asyncio').level == s.log_level
+            assert logging.getLogger('hypercorn.access').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)
-        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"
+        with 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"
 
-        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"
+            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"
 
+    @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

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"
-
-echo "check for Home Assistant MQTT"
-MQTT_HOST=$(bashio::services mqtt "host")
-MQTT_PORT=$(bashio::services mqtt "port")
-MQTT_USER=$(bashio::services mqtt "username")
-MQTT_PASSWORD=$(bashio::services mqtt "password")
+bashio::log.blue "-----------------------------------------------------------"
+bashio::log.blue "run.sh: info: setup Add-on environment"
+bashio::cache.flush_all
+MQTT_HOST=""
+if bashio::supervisor.ping; then
+    bashio::log "run.sh: info: check for Home Assistant MQTT service"
+    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