From ad78d97f8fc10fa4a9ed1f3f7d36caaf36d70870 Mon Sep 17 00:00:00 2001 From: Stefan Allius Date: Sun, 22 Jun 2025 16:03:58 +0200 Subject: [PATCH] improve unit-tests for the web-UI --- app/src/web/log_handler.py | 3 + app/tests/log/test.txt | 36 +++++------ app/tests/test_web_route.py | 121 +++++++++++++++++++++++++++++++----- 3 files changed, 127 insertions(+), 33 deletions(-) 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/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_web_route.py b/app/tests/test_web_route.py index 564a308..2ea7e28 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 +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, 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): @@ -161,9 +182,10 @@ async def test_language_en(client): assert response.mimetype == 'text/html' 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): @@ -174,6 +196,18 @@ async def test_language_de(client): assert response.location == '/' 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 - 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' @pytest.mark.asyncio async def test_language_unknown(client): @@ -182,6 +216,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 +231,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 +301,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 +310,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 +365,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