diff --git a/CHANGELOG.md b/CHANGELOG.md
index 168f7c0..cd886b3 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [unreleased]
+- add-on: add links to config and log-file to the web-UI
- fix some SonarQube warnings
- remove unused 32-bit architectures
- Babel don't build new po file if only the pot creation-date was changed
diff --git a/app/src/server.py b/app/src/server.py
index 292a2de..fac746b 100644
--- a/app/src/server.py
+++ b/app/src/server.py
@@ -60,7 +60,16 @@ class Server():
@app.context_processor
def utility_processor():
- return {'version': self.version}
+ var = {'version': self.version,
+ 'slug': os.getenv("SLUG"),
+ 'hostname': os.getenv("HOSTNAME"),
+ }
+ if var['slug']:
+ var['hassio'] = True
+ slug_len = len(var['slug'])
+ var['addonname'] = var['slug'] + '_' + \
+ var['hostname'][slug_len+1:]
+ return var
def parse_args(self, arg_list: list[str] | None):
parser = argparse.ArgumentParser()
diff --git a/app/src/web/log_handler.py b/app/src/web/log_handler.py
index 7565649..1e3a54c 100644
--- a/app/src/web/log_handler.py
+++ b/app/src/web/log_handler.py
@@ -22,3 +22,6 @@ class LogHandler(Handler, metaclass=Singleton):
def get_buffer(self, elms=0) -> list:
return list(self.buffer)[-elms:]
+
+ def clear(self):
+ self.buffer.clear()
diff --git a/app/src/web/static/font-awesome/css/all.min.css b/app/src/web/static/font-awesome/css/all.min.css
index dd09622..1ef1424 100644
--- a/app/src/web/static/font-awesome/css/all.min.css
+++ b/app/src/web/static/font-awesome/css/all.min.css
@@ -7,3 +7,4 @@
.fa-rotate-right:before{content:"\f01e"}
.fa-cloud-arrow-down-alt:before{content:"\f381"}
.fa-cloud-arrow-up-alt:before{content:"\f382"}
+.fa-gear:before{content:"\f013"}
diff --git a/app/src/web/templates/base.html.j2 b/app/src/web/templates/base.html.j2
index 51268af..58bfd95 100644
--- a/app/src/web/templates/base.html.j2
+++ b/app/src/web/templates/base.html.j2
@@ -59,6 +59,11 @@
+ {% if hassio is defined %}
+
+ {{_('Add-on Config')}}
+ {{_('Add-on Log')}}
+ {% endif %}
diff --git a/app/tests/log/test.txt b/app/tests/log/test.txt
index d7c6d5e..6a56fe7 100644
--- a/app/tests/log/test.txt
+++ b/app/tests/log/test.txt
@@ -1,19 +1,19 @@
2025-04-30 00:01:23 INFO | root | Server "proxy - unknown" will be started
-2025-04-30 00:01:23 INFO | root | current dir: /Users/sallius/tsun/tsun-gen3-proxy
-2025-04-30 00:01:23 INFO | root | config_path: ./config/
-2025-04-30 00:01:23 INFO | root | json_config: None
-2025-04-30 00:01:23 INFO | root | toml_config: None
-2025-04-30 00:01:23 INFO | root | trans_path: ../translations/
-2025-04-30 00:01:23 INFO | root | rel_urls: False
-2025-04-30 00:01:23 INFO | root | log_path: ./log/
-2025-04-30 00:01:23 INFO | root | log_backups: unlimited
-2025-04-30 00:01:23 INFO | root | LOG_LVL : None
-2025-04-30 00:01:23 INFO | root | ******
-2025-04-30 00:01:23 INFO | root | Read from /Users/sallius/tsun/tsun-gen3-proxy/app/src/cnf/default_config.toml => ok
-2025-04-30 00:01:23 INFO | root | Read from environment => ok
-2025-04-30 00:01:23 INFO | root | Read from ./config/config.json => n/a
-2025-04-30 00:01:23 INFO | root | Read from ./config/config.toml => n/a
-2025-04-30 00:01:23 INFO | root | ******
-2025-04-30 00:01:23 INFO | root | listen on port: 5005 for inverters
-2025-04-30 00:01:23 INFO | root | listen on port: 10000 for inverters
-2025-04-30 00:01:23 INFO | root | Start Quart
\ No newline at end of file
+2025-04-30 00:01:24 INFO | root | current dir: /Users/sallius/tsun/tsun-gen3-proxy
+2025-04-30 00:01:25 INFO | root | config_path: ./config/
+2025-04-30 00:01:26 INFO | root | json_config: None
+2025-04-30 00:01:27 INFO | root | toml_config: None
+2025-04-30 00:01:28 INFO | root | trans_path: ../translations/
+2025-04-30 00:01:29 INFO | root | rel_urls: False
+2025-04-30 00:01:30 INFO | root | log_path: ./log/
+2025-04-30 00:01:31 INFO | root | log_backups: unlimited
+2025-04-30 00:01:32 INFO | root | LOG_LVL : None
+2025-04-30 00:01:33 INFO | root | ******
+2025-04-30 00:01:34 INFO | root | Read from /Users/sallius/tsun/tsun-gen3-proxy/app/src/cnf/default_config.toml => ok
+2025-04-30 00:01:35 INFO | root | Read from environment => ok
+2025-04-30 00:01:36 INFO | root | Read from ./config/config.json => n/a
+2025-04-30 00:01:37 INFO | root | Read from ./config/config.toml => n/a
+2025-04-30 00:01:38 INFO | root | ******
+2025-04-30 00:01:39 INFO | root | listen on port: 5005 for inverters
+2025-04-30 00:01:40 INFO | root | listen on port: 10000 for inverters
+2025-04-30 00:01:41 INFO | root | Start Quart
\ No newline at end of file
diff --git a/app/tests/test_server.py b/app/tests/test_server.py
index 7b0e934..1d94148 100644
--- a/app/tests/test_server.py
+++ b/app/tests/test_server.py
@@ -191,6 +191,7 @@ class TestApp:
"""Test the ready route."""
ProxyState.set_up(False)
+ app.testing = True
client = app.test_client()
response = await client.get('/-/ready')
assert response.status_code == 503
@@ -211,6 +212,7 @@ class TestApp:
with InverterBase(reader, writer, 'tsun', Talent):
ProxyState.set_up(False)
+ app.testing = True
client = app.test_client()
response = await client.get('/-/healthy')
assert response.status_code == 200
@@ -240,6 +242,7 @@ class TestApp:
with caplog.at_level(logging.INFO) and InverterBase(reader, writer, 'tsun', Talent):
ProxyState.set_up(False)
+ app.testing = True
client = app.test_client()
response = await client.get('/-/healthy')
assert response.status_code == 200
@@ -271,6 +274,7 @@ class TestApp:
with caplog.at_level(logging.INFO) and InverterBase(reader, writer, 'tsun', Talent):
ProxyState.set_up(False)
+ app.testing = True
client = app.test_client()
response = await client.get('/-/healthy')
assert response.status_code == 200
diff --git a/app/tests/test_web_route.py b/app/tests/test_web_route.py
index 564a308..4082f61 100644
--- a/app/tests/test_web_route.py
+++ b/app/tests/test_web_route.py
@@ -1,22 +1,37 @@
# test_with_pytest.py
import pytest
-from server import app
-from web import Web, web
+import logging
+import os, errno
+import datetime
+from os import DirEntry, stat_result
+from quart import current_app
+from mock import patch
+
+from server import app as my_app
+from server import Server
+from web import web
from async_stream import AsyncStreamClient
from gen3plus.inverter_g3p import InverterG3P
+from web.log_handler import LogHandler
from test_inverter_g3p import FakeReader, FakeWriter, config_conn
from cnf.config import Config
-from mock import patch
from proxy import Proxy
-import os, errno
-from os import DirEntry, stat_result
-import datetime
+
+
+class FakeServer(Server):
+ def __init__(self):
+ pass # don't call the suoer(.__init__ for unit tests
+
pytest_plugins = ('pytest_asyncio',)
+@pytest.fixture(scope="session")
+def app():
+ yield my_app
@pytest.fixture(scope="session")
-def client():
+def client(app):
app.secret_key = 'super secret key'
+ app.testing = True
return app.test_client()
@pytest.fixture
@@ -52,6 +67,7 @@ async def test_home(client):
response = await client.get('/')
assert response.status_code == 200
assert response.mimetype == 'text/html'
+ assert b"TSUN Proxy - Connections" in await response.data
@pytest.mark.asyncio
async def test_page(client):
@@ -59,14 +75,17 @@ async def test_page(client):
response = await client.get('/mqtt')
assert response.status_code == 200
assert response.mimetype == 'text/html'
+ assert b"TSUN Proxy - MQTT Status" in await response.data
+ assert b'fetch("/mqtt-fetch")' in await response.data
@pytest.mark.asyncio
async def test_rel_page(client):
- """Test the mqtt route."""
+ """Test the mqtt route with relative paths."""
web.build_relative_urls = True
response = await client.get('/mqtt')
assert response.status_code == 200
assert response.mimetype == 'text/html'
+ assert b'fetch("./mqtt-fetch")' in await response.data
web.build_relative_urls = False
@pytest.mark.asyncio
@@ -75,6 +94,7 @@ async def test_notes(client):
response = await client.get('/notes')
assert response.status_code == 200
assert response.mimetype == 'text/html'
+ assert b"TSUN Proxy - Important Messages" in await response.data
@pytest.mark.asyncio
async def test_logging(client):
@@ -82,6 +102,7 @@ async def test_logging(client):
response = await client.get('/logging')
assert response.status_code == 200
assert response.mimetype == 'text/html'
+ assert b"TSUN Proxy - Log Files" in await response.data
@pytest.mark.asyncio
async def test_favicon96(client):
@@ -119,37 +140,37 @@ async def test_manifest(client):
assert response.mimetype == 'application/manifest+json'
@pytest.mark.asyncio
-async def test_data_fetch(create_inverter):
+async def test_data_fetch(client, create_inverter):
"""Test the data-fetch route."""
_ = create_inverter
- client = app.test_client()
response = await client.get('/data-fetch')
assert response.status_code == 200
response = await client.get('/data-fetch')
assert response.status_code == 200
+ assert b'Connections
' in await response.data
@pytest.mark.asyncio
-async def test_data_fetch1(create_inverter_server):
+async def test_data_fetch1(client, create_inverter_server):
"""Test the data-fetch route with server connection."""
_ = create_inverter_server
- client = app.test_client()
response = await client.get('/data-fetch')
assert response.status_code == 200
response = await client.get('/data-fetch')
assert response.status_code == 200
+ assert b'Connections
' in await response.data
@pytest.mark.asyncio
-async def test_data_fetch2(create_inverter_client):
+async def test_data_fetch2(client, create_inverter_client):
"""Test the data-fetch route with client connection."""
_ = create_inverter_client
- client = app.test_client()
response = await client.get('/data-fetch')
assert response.status_code == 200
response = await client.get('/data-fetch')
assert response.status_code == 200
+ assert b'Connections
' in await response.data
@pytest.mark.asyncio
async def test_language_en(client):
@@ -159,21 +180,44 @@ async def test_language_en(client):
assert response.content_language.pop() == 'en'
assert response.location == '/index'
assert response.mimetype == 'text/html'
+ assert b'Redirecting...' in await response.data
client.set_cookie('test', key='language', value='de')
- response = await client.get('/mqtt')
+ response = await client.get('/')
assert response.status_code == 200
assert response.mimetype == 'text/html'
+ assert b'TSUN Proxy - Connections' in await response.data
@pytest.mark.asyncio
async def test_language_de(client):
"""Test the language/de route."""
+
response = await client.get('/language/de', headers={'referer': '/'})
assert response.status_code == 302
assert response.content_language.pop() == 'de'
assert response.location == '/'
assert response.mimetype == 'text/html'
+ assert b'' in await response.data
+ assert b'Redirecting...' in await response.data
+ client.set_cookie('test', key='language', value='en')
+ response = await client.get('/')
+ assert response.status_code == 200
+ assert response.mimetype == 'text/html'
+ assert b'TSUN Proxy - Verbindungen' in await response.data
+
+ """Switch back to english"""
+ response = await client.get('/language/en', headers={'referer': '/index'})
+ assert response.status_code == 302
+ assert response.content_language.pop() == 'en'
+ assert response.location == '/index'
+ assert response.mimetype == 'text/html'
+ assert b'' in await response.data
+ assert b'Redirecting...' in await response.data
@pytest.mark.asyncio
async def test_language_unknown(client):
@@ -182,6 +226,12 @@ async def test_language_unknown(client):
assert response.status_code == 404
assert response.mimetype == 'text/html'
+ client.set_cookie('test', key='language', value='en')
+ response = await client.get('/')
+ assert response.status_code == 200
+ assert response.mimetype == 'text/html'
+ assert b'TSUN Proxy - Connections' in await response.data
+
@pytest.mark.asyncio
async def test_mqtt_fetch(client, create_inverter):
@@ -191,15 +241,47 @@ async def test_mqtt_fetch(client, create_inverter):
response = await client.get('/mqtt-fetch')
assert response.status_code == 200
+ assert b'MQTT devices
' in await response.data
@pytest.mark.asyncio
async def test_notes_fetch(client, config_conn):
"""Test the notes-fetch route."""
- _ = create_inverter
+ _ = config_conn
+ s = FakeServer()
+ s.src_dir = 'app/src/'
+ s.init_logging_system()
+
+ # First clear log and test Well done message
+ logh = LogHandler()
+ logh.clear()
response = await client.get('/notes-fetch')
assert response.status_code == 200
+ assert b'Well done!
' in await response.data
+
+ # Check info logs which must be ignored here
+ logging.info('config_info')
+ logh.flush()
+ response = await client.get('/notes-fetch')
+ assert response.status_code == 200
+ assert b'Well done!
' in await response.data
+
+ # Check warning logs which must be added to the note list
+ logging.warning('config_warning')
+ logh.flush()
+ response = await client.get('/notes-fetch')
+ assert response.status_code == 200
+ assert b'WARNING' in await response.data
+ assert b'config_warning' in await response.data
+
+ # Check error logs which must be added to the note list
+ logging.error('config_err')
+ logh.flush()
+ response = await client.get('/notes-fetch')
+ assert response.status_code == 200
+ assert b'ERROR' in await response.data
+ assert b'config_err' in await response.data
@pytest.mark.asyncio
@@ -229,6 +311,7 @@ async def test_file_fetch(client, config_conn, monkeypatch):
monkeypatch.delattr(stat_result, "st_birthtime")
response = await client.get('/file-fetch')
assert response.status_code == 200
+ assert b'test.txt
' in await response.data
@pytest.mark.asyncio
async def test_send_file(client, config_conn):
@@ -237,6 +320,7 @@ async def test_send_file(client, config_conn):
assert Config.log_path == 'app/tests/log/'
response = await client.get('/send-file/test.txt')
assert response.status_code == 200
+ assert b'2025-04-30 00:01:23' in await response.data
@pytest.mark.asyncio
@@ -291,3 +375,20 @@ async def test_del_file_err(client, config_conn, patch_os_remove_err):
assert Config.log_path == 'app/tests/log/'
response = await client.delete ('/del-file/test.txt')
assert response.status_code == 404
+
+@pytest.mark.asyncio
+async def test_addon_links(client):
+ """Test links to HA add-on config/log in UI"""
+ with patch.dict(os.environ, {'SLUG': 'c676133d', 'HOSTNAME': 'c676133d-tsun-proxy'}):
+ response = await client.get('/')
+ assert response.status_code == 200
+ assert response.mimetype == 'text/html'
+ assert b'Add-on Config' in await response.data
+ assert b'href="/hassio/addon/c676133d_tsun-proxy/logs' in await response.data
+ assert b'href="/hassio/addon/c676133d_tsun-proxy/config' in await response.data
+
+ # check that links are not available if env vars SLUG and HOSTNAME are not defined (docker version)
+ response = await client.get('/')
+ assert response.status_code == 200
+ assert response.mimetype == 'text/html'
+ assert b'Add-on Config' not in await response.data
diff --git a/app/translations/de/LC_MESSAGES/messages.po b/app/translations/de/LC_MESSAGES/messages.po
index 85c6c76..8237494 100644
--- a/app/translations/de/LC_MESSAGES/messages.po
+++ b/app/translations/de/LC_MESSAGES/messages.po
@@ -75,6 +75,14 @@ msgstr "Wichtige Hinweise"
msgid "Log Files"
msgstr "Log Dateien"
+#: src/web/templates/base.html.j2:64
+msgid "Add-on Config"
+msgstr "Add-on Konfiguration"
+
+#: src/web/templates/base.html.j2:65
+msgid "Add-on Log"
+msgstr "Add-on Protokoll"
+
#: src/web/templates/page_index.html.j2:3
msgid "TSUN Proxy - Connections"
msgstr "TSUN Proxy - Verbindungen"
diff --git a/ha_addons/ha_addon/rootfs/run.sh b/ha_addons/ha_addon/rootfs/run.sh
index c2dc223..c4ba7e1 100755
--- a/ha_addons/ha_addon/rootfs/run.sh
+++ b/ha_addons/ha_addon/rootfs/run.sh
@@ -4,8 +4,10 @@ bashio::log.blue "-----------------------------------------------------------"
bashio::log.blue "run.sh: info: setup Add-on environment"
bashio::cache.flush_all
MQTT_HOST=""
+SLUG=""
+HOSTNAME=""
if bashio::supervisor.ping; then
- bashio::log "run.sh: info: check for Home Assistant MQTT service"
+ bashio::log "run.sh: info: check Home Assistant bashio for config values"
if bashio::services.available mqtt; then
MQTT_HOST=$(bashio::services mqtt "host")
MQTT_PORT=$(bashio::services mqtt "port")
@@ -14,15 +16,31 @@ if bashio::supervisor.ping; then
else
bashio::log.yellow "run.sh: info: Home Assistant MQTT service not available!"
fi
+ SLUG=$(bashio::addon.repository)
+ HOSTNAME=$(bashio::addon.hostname)
else
bashio::log.red "run.sh: error: Home Assistant Supervisor API not available!"
fi
+if [ -z "$SLUG" ]; then
+ bashio::log.yellow "run.sh: info: addon slug not found"
+else
+ bashio::log.green "run.sh: info: found addon slug: $SLUG"
+ export SLUG
+
+fi
+if [ -z "$HOSTNAME" ]; then
+ bashio::log.yellow "run.sh: info: addon hostname not found"
+else
+ bashio::log.green "run.sh: info: found addon hostname: $HOSTNAME"
+ export HOSTNAME
+fi
+
# if a MQTT was/not found, drop a note
if [ -z "$MQTT_HOST" ]; then
bashio::log.yellow "run.sh: info: MQTT config not found"
else
- bashio::log.green "run.sh: info: MQTT config found"
+ bashio::log.green "run.sh: info: found MQTT config"
export MQTT_HOST
export MQTT_PORT
export MQTT_USER