diff --git a/CHANGELOG.md b/CHANGELOG.md index 85c6931..cd886b3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,11 @@ 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 +- Improve Makefile - Update dependency pytest-asyncio to v1 ## [0.14.1] - 2025-05-31 diff --git a/Makefile b/Makefile index 5964e6e..394ac69 100644 --- a/Makefile +++ b/Makefile @@ -1,27 +1,37 @@ -.PHONY: build babel clean addon-dev addon-debug addon-rc addon-rel debug dev preview rc rel check-docker-compose install +.PHONY: help build babel clean addon-dev addon-debug addon-rc addon-rel debug dev preview rc rel check-docker-compose install -babel: +help: ## show help message + @awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m\033[0m\n"} /^[$$()% a-zA-Z0-9_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) + +babel: ## build language files $(MAKE) -C app $@ build: $(MAKE) -C ha_addons $@ -clean: +clean: ## delete all built files $(MAKE) -C app $@ $(MAKE) -C ha_addons $@ -debug dev preview rc rel: +debug dev preview rc rel: ## build docker container in version $(MAKE) -C app babel $(MAKE) -C app $@ -addon-dev addon-debug addon-rc addon-rel: +addon-dev addon-debug addon-rc addon-rel: ## build HA add-on in version $(MAKE) -C app babel $(MAKE) -C ha_addons $(patsubst addon-%,%,$@) -check-docker-compose: +check-docker-compose: ## check the docker-compose file docker-compose config -q -install: - python3 -m pip install --upgrade pip - python3 -m pip install -r requirements.txt - python3 -m pip install -r requirements-test.txt \ No newline at end of file +PY_VER := $(shell cat .python-version) + +install: ## install requirements into the pyenv and switch to proper venv + @pyenv local $(PY_VER) || { pyenv install $(PY_VER) && pyenv local $(PY_VER) || exit 1; } + @pyenv exec pip install --upgrade pip + @pyenv exec pip install -r requirements.txt + @pyenv exec pip install -r requirements-test.txt + pyenv exec python --version + +run: ## run proxy locally out of the actual venv + pyenv exec python app/src/server.py -c /app/src/cnf \ No newline at end of file diff --git a/app/Makefile b/app/Makefile index 29be248..c192556 100644 --- a/app/Makefile +++ b/app/Makefile @@ -55,7 +55,7 @@ $(BABEL_TRANSLATIONS)/%.pot : $(SRC)/.babel.cfg $(BABEL_INPUT) $(BABEL_TRANSLATIONS)/%/LC_MESSAGES/messages.po : $(BABEL_TRANSLATIONS)/messages.pot @mkdir -p $(@D) - @pybabel update --init-missing -i $< -d $(BABEL_TRANSLATIONS) -l $* + @pybabel update --init-missing --ignore-pot-creation-date -i $< -d $(BABEL_TRANSLATIONS) -l $* $(BABEL_TRANSLATIONS)/%/LC_MESSAGES/messages.mo : $(BABEL_TRANSLATIONS)/%/LC_MESSAGES/messages.po @pybabel compile -d $(BABEL_TRANSLATIONS) -l $* diff --git a/app/docker-bake.hcl b/app/docker-bake.hcl index ba9d92b..324a68e 100644 --- a/app/docker-bake.hcl +++ b/app/docker-bake.hcl @@ -53,7 +53,7 @@ target "_common" { ] no-cache = false - platforms = ["linux/amd64", "linux/arm64", "linux/arm/v7"] + platforms = ["linux/amd64", "linux/arm64"] } target "_debug" { diff --git a/app/requirements-test.txt b/app/requirements-test.txt index 77b0b72..add2d3c 100644 --- a/app/requirements-test.txt +++ b/app/requirements-test.txt @@ -1,4 +1,4 @@ - flake8==7.2.0 + flake8==7.3.0 pytest==8.4.1 pytest-asyncio==1.0.0 pytest-cov==6.2.1 diff --git a/app/src/gen3plus/solarman_v5.py b/app/src/gen3plus/solarman_v5.py index 355890b..76d9297 100755 --- a/app/src/gen3plus/solarman_v5.py +++ b/app/src/gen3plus/solarman_v5.py @@ -341,9 +341,9 @@ class SolarmanV5(SolarmanBase): self.log_lvl.clear() super().close() - async def send_start_cmd(self, snr: int, host: str, - forward: bool, - start_timeout=MB_CLIENT_DATA_UP): + def send_start_cmd(self, snr: int, host: str, + forward: bool, + start_timeout=MB_CLIENT_DATA_UP): self.no_forwarding = True self.establish_inv_emu = forward self.snr = snr diff --git a/app/src/messages.py b/app/src/messages.py index 7c04121..1b50972 100644 --- a/app/src/messages.py +++ b/app/src/messages.py @@ -193,7 +193,7 @@ class Message(ProtocolIfc): return self.mb.build_msg(dev_id, func, addr, val, log_lvl) - async def send_modbus_cmd(self, func, addr, val, log_lvl) -> None: + def send_modbus_cmd(self, func, addr, val, log_lvl) -> None: self._send_modbus_cmd(Modbus.INV_ADDR, func, addr, val, log_lvl) def _send_modbus_scan(self): diff --git a/app/src/modbus_tcp.py b/app/src/modbus_tcp.py index 49786df..f51eef0 100644 --- a/app/src/modbus_tcp.py +++ b/app/src/modbus_tcp.py @@ -66,7 +66,7 @@ class ModbusTcp(): try: async with ModbusConn(host, port) as inverter: stream = inverter.local.stream - await stream.send_start_cmd(snr, host, forward) + stream.send_start_cmd(snr, host, forward) await stream.ifc.loop() logger.info(f'[{stream.node_id}:{stream.conn_no}] ' f'Connection closed - Shutdown: ' diff --git a/app/src/mqtt.py b/app/src/mqtt.py index 886b264..2594512 100755 --- a/app/src/mqtt.py +++ b/app/src/mqtt.py @@ -112,7 +112,7 @@ class Mqtt(metaclass=Singleton): except asyncio.CancelledError: logger_mqtt.debug("MQTT task cancelled") self.__client = None - return + raise except Exception: # self.inc_counter('SW_Exception') # fixme self.ctime = None @@ -151,7 +151,7 @@ class Mqtt(metaclass=Singleton): if self.__cb_mqtt_is_up: await self.__cb_mqtt_is_up() - async def _out_coeff(self, message): + def _out_coeff(self, message): payload = message.payload.decode("UTF-8") try: val = round(float(payload) * 1024/100) @@ -160,9 +160,9 @@ class Mqtt(metaclass=Singleton): 'the range 0..100,' f' got: {payload}') else: - await self._modbus_cmd(message, - Modbus.WRITE_SINGLE_REG, - 0, 0x202c, val) + self._modbus_cmd(message, + Modbus.WRITE_SINGLE_REG, + 0, 0x202c, val) except Exception: pass @@ -182,7 +182,7 @@ class Mqtt(metaclass=Singleton): else: logger_mqtt.warning(f'Node_id: {node_id} not found') - async def _modbus_cmd(self, message, func, params=0, addr=0, val=0): + def _modbus_cmd(self, message, func, params=0, addr=0, val=0): payload = message.payload.decode("UTF-8") for fnc in self.each_inverter(message, "send_modbus_cmd"): res = payload.split(',') @@ -195,7 +195,7 @@ class Mqtt(metaclass=Singleton): elif params == 2: addr = int(res[0], base=16) val = int(res[1]) # lenght - await fnc(func, addr, val, logging.INFO) + fnc(func, addr, val, logging.INFO) async def _at_cmd(self, message): payload = message.payload.decode("UTF-8") diff --git a/app/src/server.py b/app/src/server.py index 60a2fe8..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 dict(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/i18n.py b/app/src/web/i18n.py index 3520983..771b063 100644 --- a/app/src/web/i18n.py +++ b/app/src/web/i18n.py @@ -29,9 +29,9 @@ def get_tz(): @web.context_processor def utility_processor(): - return dict(lang=babel_get_locale(), - lang_str=LANGUAGES.get(str(babel_get_locale()), "English"), - languages=LANGUAGES) + return {'lang': babel_get_locale(), + 'lang_str': LANGUAGES.get(str(babel_get_locale()), "English"), + 'languages': LANGUAGES} @web.route('/language/') 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 28daaf8..e5ec423 100644 --- a/app/src/web/templates/base.html.j2 +++ b/app/src/web/templates/base.html.j2 @@ -60,6 +60,11 @@   {{_('Important Messages')}}   {{_('Log Files')}}   {{_('Network Tests')}} + {% 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_mqtt.py b/app/tests/test_mqtt.py index 2266132..623fb01 100755 --- a/app/tests/test_mqtt.py +++ b/app/tests/test_mqtt.py @@ -286,23 +286,23 @@ async def test_mqtt_dispatch(config_mqtt_conn, aiomqtt_mock, spy_modbus_cmd): assert m.ha_restarts == 1 await m.receive(topic= 'tsun/inv_1/rated_load', payload= b'2') - spy.assert_awaited_once_with(Modbus.WRITE_SINGLE_REG, 0x2008, 2, logging.INFO) + spy.assert_called_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') - spy.assert_awaited_once_with(Modbus.WRITE_SINGLE_REG, 0x202c, 1024, logging.INFO) + spy.assert_called_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') - spy.assert_awaited_once_with(Modbus.WRITE_SINGLE_REG, 0x202c, 512, logging.INFO) + spy.assert_called_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') - spy.assert_awaited_once_with(Modbus.READ_REGS, 0x3000, 10, logging.INFO) + spy.assert_called_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') - spy.assert_awaited_once_with(Modbus.READ_INPUTS, 0x3000, 10, logging.INFO) + spy.assert_called_once_with(Modbus.READ_INPUTS, 0x3000, 10, logging.INFO) # test dispatching with empty mapping table m.topic_defs.clear() 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_solarman.py b/app/tests/test_solarman.py index 92874f5..71ad8f7 100755 --- a/app/tests/test_solarman.py +++ b/app/tests/test_solarman.py @@ -1624,7 +1624,7 @@ async def test_msg_build_modbus_req(my_loop, config_tsun_inv1, device_ind_msg, d assert m.ifc.tx_fifo.get()==device_rsp_msg assert m.ifc.fwd_fifo.get()==device_ind_msg - await m.send_modbus_cmd(Modbus.WRITE_SINGLE_REG, 0x2008, 0, logging.DEBUG) + m.send_modbus_cmd(Modbus.WRITE_SINGLE_REG, 0x2008, 0, logging.DEBUG) assert 0 == m.send_msg_ofs assert m.ifc.fwd_fifo.get() == b'' assert m.sent_pdu == b'' # modbus command must be ignore, cause connection is still not up @@ -1642,7 +1642,7 @@ async def test_msg_build_modbus_req(my_loop, config_tsun_inv1, device_ind_msg, d assert m.ifc.tx_fifo.get()==inverter_rsp_msg assert m.ifc.fwd_fifo.get()==inverter_ind_msg - await m.send_modbus_cmd(Modbus.WRITE_SINGLE_REG, 0x2008, 0, logging.DEBUG) + m.send_modbus_cmd(Modbus.WRITE_SINGLE_REG, 0x2008, 0, logging.DEBUG) assert 0 == m.send_msg_ofs assert m.ifc.fwd_fifo.get() == b'' assert m.sent_pdu == msg_modbus_cmd @@ -2318,7 +2318,7 @@ async def test_start_client_mode(my_loop, config_tsun_inv1, str_test_ip): assert m.no_forwarding == False assert m.mb_timer.tim == None assert asyncio.get_running_loop() == m.mb_timer.loop - await m.send_start_cmd(get_sn_int(), str_test_ip, False, m.mb_first_timeout) + m.send_start_cmd(get_sn_int(), str_test_ip, False, m.mb_first_timeout) assert m.sent_pdu==bytearray(b'\xa5\x17\x00\x10E\x01\x00!Ce{\x02\xb0\x02\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x01\x030\x00\x000J\xde\xf1\x15') assert m.db.get_db_value(Register.IP_ADDRESS) == str_test_ip assert isclose(m.db.get_db_value(Register.POLLING_INTERVAL), 0.5) @@ -2351,7 +2351,7 @@ async def test_start_client_mode_scan(config_tsun_scan_dcu, str_test_ip, dcu_mod assert m.no_forwarding == False assert m.mb_timer.tim == None assert asyncio.get_running_loop() == m.mb_timer.loop - await m.send_start_cmd(get_dcu_sn_int(), str_test_ip, False, m.mb_first_timeout) + m.send_start_cmd(get_dcu_sn_int(), str_test_ip, False, m.mb_first_timeout) assert m.mb_start_reg == 0x0000 assert m.mb_step == 0x100 assert m.mb_bytes == 0x2d diff --git a/app/tests/test_solarman_emu.py b/app/tests/test_solarman_emu.py index a3d517c..d511f22 100644 --- a/app/tests/test_solarman_emu.py +++ b/app/tests/test_solarman_emu.py @@ -144,7 +144,7 @@ async def test_emu_start(my_loop, config_tsun_inv1, msg_modbus_rsp, str_test_ip, inv = InvStream(msg_modbus_rsp) assert asyncio.get_running_loop() == inv.mb_timer.loop - await inv.send_start_cmd(get_sn_int(), str_test_ip, True, inv.mb_first_timeout) + inv.send_start_cmd(get_sn_int(), str_test_ip, True, inv.mb_first_timeout) inv.read() # read complete msg, and dispatch msg assert not inv.header_valid # must be invalid, since msg was handled and buffer flushed assert inv.msg_count == 1 @@ -161,7 +161,7 @@ async def test_snd_hb(my_loop, config_tsun_inv1, heartbeat_ind): inv = InvStream() cld = CldStream(inv) - # await inv.send_start_cmd(get_sn_int(), str_test_ip, False, inv.mb_first_timeout) + # inv.send_start_cmd(get_sn_int(), str_test_ip, False, inv.mb_first_timeout) cld.send_heartbeat_cb(0) assert cld.ifc.tx_fifo.peek() == heartbeat_ind cld.close() @@ -178,7 +178,7 @@ async def test_snd_inv_data(my_loop, config_tsun_inv1, inverter_ind_msg, inverte inv.db.set_db_def_value(Register.GRID_FREQUENCY, 50.05) inv.db.set_db_def_value(Register.PROD_COMPL_TYPE, 6) assert asyncio.get_running_loop() == inv.mb_timer.loop - await inv.send_start_cmd(get_sn_int(), str_test_ip, False, inv.mb_first_timeout) + inv.send_start_cmd(get_sn_int(), str_test_ip, False, inv.mb_first_timeout) inv.db.set_db_def_value(Register.DATA_UP_INTERVAL, 17) # set test value cld = CldStream(inv) @@ -213,7 +213,7 @@ async def test_rcv_invalid(my_loop, config_tsun_inv1, inverter_ind_msg, inverter _ = config_tsun_inv1 inv = InvStream() assert asyncio.get_running_loop() == inv.mb_timer.loop - await inv.send_start_cmd(get_sn_int(), str_test_ip, False, inv.mb_first_timeout) + inv.send_start_cmd(get_sn_int(), str_test_ip, False, inv.mb_first_timeout) inv.db.set_db_def_value(Register.DATA_UP_INTERVAL, 17) # set test value cld = CldStream(inv) diff --git a/app/tests/test_talent.py b/app/tests/test_talent.py index fa42eed..01ef0fe 100644 --- a/app/tests/test_talent.py +++ b/app/tests/test_talent.py @@ -2411,14 +2411,14 @@ async def test_msg_build_modbus_req(config_tsun_inv1, msg_modbus_cmd): _ = config_tsun_inv1 m = MemoryStream(b'', (0,), True) m.id_str = b"R170000000000001" - await m.send_modbus_cmd(Modbus.WRITE_SINGLE_REG, 0x2008, 0, logging.DEBUG) + m.send_modbus_cmd(Modbus.WRITE_SINGLE_REG, 0x2008, 0, logging.DEBUG) assert 0 == m.send_msg_ofs assert m.ifc.fwd_fifo.get() == b'' assert m.ifc.tx_fifo.get() == b'' assert m.sent_pdu == b'' m.state = State.up - await m.send_modbus_cmd(Modbus.WRITE_SINGLE_REG, 0x2008, 0, logging.DEBUG) + m.send_modbus_cmd(Modbus.WRITE_SINGLE_REG, 0x2008, 0, logging.DEBUG) assert 0 == m.send_msg_ofs assert m.ifc.fwd_fifo.get() == b'' assert m.ifc.tx_fifo.get() == b'' 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 a15ce7e..6cc6a62 100644 --- a/app/translations/de/LC_MESSAGES/messages.po +++ b/app/translations/de/LC_MESSAGES/messages.po @@ -80,6 +80,14 @@ msgstr "Log Dateien" msgid "Network Tests" msgstr "" +#: 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/docker-bake.hcl b/ha_addons/docker-bake.hcl index 32cbf6c..4317a70 100644 --- a/ha_addons/docker-bake.hcl +++ b/ha_addons/docker-bake.hcl @@ -59,7 +59,7 @@ target "_common" { ] no-cache = false - platforms = ["linux/amd64", "linux/arm64", "linux/arm/v7"] + platforms = ["linux/amd64", "linux/arm64"] } target "_debug" { 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