micrOSDevToolKit 3.0.2__tar.gz → 3.0.4__tar.gz

{microsdevtoolkit-3.0.2 → microsdevtoolkit-3.0.4}/MANIFEST.in

@@ -8,10 +8,9 @@ graft env/driver_cp210x/
 
 graft toolkit/simulator_lib
 graft toolkit/workspace/precompiled
+graft toolkit/gateway
 recursive-include toolkit/user_data .include
 recursive-include toolkit/user_data/node_config_archive/.include
-include toolkit/index.html
-include toolkit/img_stream.html
 include toolkit/LM_to_compile.dat
 graft toolkit/user_data/webhooks/
 
@@ -20,4 +19,3 @@ include media/logo_mini.png
 include media/logo.png
 include media/wifi_icon.png
 include media/usb_port_icon.png
-

{microsdevtoolkit-3.0.2/micrOSDevToolKit.egg-info → microsdevtoolkit-3.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: micrOSDevToolKit
-Version: 3.0.2
+Version: 3.0.4
 Summary: Development and deployment environment for micrOS, the diy micropython automation OS (IoT)
 Home-page: https://github.com/BxNxM/micrOS
 Author: Marcell Ban

{microsdevtoolkit-3.0.2 → microsdevtoolkit-3.0.4}/micrOS/release_info/micrOS_ReleaseInfo/system_analysis_sum.json

@@ -37,7 +37,7 @@
             13
         ],
         "Config.py": [
-            9.63,
+            9.62,
             17
         ],
         "Shell.py": [
@@ -323,7 +323,7 @@
     },
     "summary": {
         "core": [
-            5306,
+            5303,
             27
         ],
         "load": [
@@ -340,6 +340,6 @@
         ],
         "core_score": 9.26,
         "load_score": 8.44,
-        "version": "3.0.0-0"
+        "version": "3.0.4-0"
     }
 }

{microsdevtoolkit-3.0.2 → microsdevtoolkit-3.0.4}/micrOS/source/Config.py

@@ -14,7 +14,6 @@ Designed by Marcell Ban aka BxNxM
 #################################################################
 from re import search
 from json import load, dump
-from utime import sleep
 from Debug import DebugCfg, console_write, syslog
 from Files import OSPath, path_join, is_file
 from uos import remove, rename
@@ -142,7 +141,7 @@ class Config:
     @classmethod
     def _inject_default_conf(cls):
         # Load config and template
-        liveconf = cls.read_cfg_file(nosafe=True)
+        liveconf = cls.read_cfg_file()
         _persist = False
         # Remove obsolete keys from conf
         try:
@@ -166,43 +165,38 @@ class Config:
                         break
             if _persist:
                 # Only persist when migration cleanup removed keys or defaults are missing from the file.
-                cls.write_cfg_file()
-                console_write("[CONF] Save conf successful")
+                state = "successful" if cls.write_cfg_file() else "failed"
+                console_write(f"[CONF] Save conf {state}")
         except Exception as e:
             syslog(f"[ERR] Save (__inject) conf failed: {e}")
         finally:
             del liveconf
 
     @staticmethod
-    def read_cfg_file(nosafe=False):
-        conf = {}
-        while True:
+    def read_cfg_file():
+        if not is_file(Config.CONFIG_PATH):
+            return {}
+        try:
+            with open(Config.CONFIG_PATH, 'r') as f:
+                return load(f)
+        except Exception as e:
+            syslog(f'[ERR] read_cfg_file error: {e}')
             try:
-                with open(Config.CONFIG_PATH, 'r') as f:
-                    conf = load(f)
-                break
-            except Exception as e:
-                console_write(f"[CONF] read_cfg_file error {conf} (json): {e}")
-                # Write out initial config, if no config exists.
-                if nosafe:
-                    break
-                sleep(0.2)
-                syslog(f'[ERR] read_cfg_file error: {e}')
-        # Return config cache
-        return conf
+                rename(Config.CONFIG_PATH, f"{Config.CONFIG_PATH}.bad")
+                console_write(f"[CONF] Corrupted config moved: {Config.CONFIG_PATH}.bad")
+            except Exception as e2:
+                syslog(f'[ERR] read_cfg_file quarantine failed: {e2}')
+            return {}
 
     @staticmethod
     def write_cfg_file():
-        while True:
-            try:
-                # WRITE JSON CONFIG
-                with open(Config.CONFIG_PATH, 'w') as f:
-                    dump({key: value for key, value in Config.INSTANCE.items()}, f)
-                break
-            except Exception as e:
-                syslog(f'[ERR] write_cfg_file {Config.CONFIG_PATH} (json): {e}')
-            sleep(0.2)
-        return True
+        try:
+            with open(Config.CONFIG_PATH, 'w') as f:
+                dump({key: value for key, value in Config.INSTANCE.items()}, f)
+            return True
+        except Exception as e:
+            syslog(f'[ERR] write_cfg_file {Config.CONFIG_PATH}: {e}')
+            return False
 
     @staticmethod
     def type_handler(key, value):
@@ -251,16 +245,16 @@ class Config:
     def validate_pwd(password):
         """
         Validate appwd parameter
-        - webrepl password
+        - webrepl password (max 9 char)
         - micrOS auth password (Shell/WebCli)
-        - wifi access point password
+        - wifi access point password (WPA2-PSK)
         """
         # Check password rules
-        if 4 <= len(password) <= 9:
+        if 8 <= len(password) <= 9:
             if search(r"[A-Z]", password) and search(r"[a-z]", password):
                 if search(r"\d", password):
                     return True, ''
-        return False, 'Password must include [0-9] both [a-z][A-Z] and length between 4-9 char.'
+        return False, 'Password must include [0-9] both [a-z][A-Z] and length between 8-9 char.'
 
 
 #################################################################

{microsdevtoolkit-3.0.2 → microsdevtoolkit-3.0.4}/micrOS/source/Scheduler.py

@@ -43,7 +43,7 @@ def __cron_task_cache_manager(now_in_sec, sec_tolerant):
         tasktime_in_sec = int(str(taskid.split('|')[0]).split(':')[1])
         sec_diff = tasktime_in_sec - (now_in_sec - sec_tolerant)
         # Remove outdated cache registration
-        if sec_diff < 0 or sec_diff > 20:
+        if sec_diff < 0 or sec_diff > sec_tolerant * 2:
             LAST_CRON_TASKS.remove(LAST_CRON_TASKS[index])
 
 

{microsdevtoolkit-3.0.2 → microsdevtoolkit-3.0.4}/micrOS/source/Shell.py

@@ -25,7 +25,7 @@ from Debug import syslog
 
 class Shell:
     __slots__ = ['__devfid', '__auth_mode', '__hwuid', '__auth_ok', '__conf_mode']
-    MICROS_VERSION = '3.0.0-0'
+    MICROS_VERSION = '3.0.4-0'
 
     def __init__(self):
         """

microsdevtoolkit-3.0.4/micrOS/utests/test_config.py

@@ -0,0 +1,152 @@
+import importlib.util
+import json
+import sys
+import tempfile
+import types
+import unittest
+from itertools import count
+from pathlib import Path
+from unittest import mock
+
+
+def setUpModule():
+    print(f"== RUN {Path(__file__).name} ==")
+
+
+_LOAD_ID = count()
+
+
+class _ConfigStubEnv:
+    def __init__(self, root: Path):
+        self.root = root
+        self.config_dir = root / "config"
+        self.logs = []
+        self.console = []
+        self._saved = {}
+
+    def _resolve(self, path):
+        path = Path(path)
+        return path if path.is_absolute() else self.root / path
+
+    def install(self):
+        for name in ("Debug", "Files", "uos", "microIO"):
+            self._saved[name] = sys.modules.get(name)
+
+        env = self
+
+        debug_mod = types.ModuleType("Debug")
+
+        class DebugCfg:
+            DEBUG = True
+            init_calls = 0
+
+            @staticmethod
+            def init_pled():
+                DebugCfg.init_calls += 1
+
+        debug_mod.DebugCfg = DebugCfg
+        debug_mod.console_write = lambda msg, *_a, **_k: env.console.append(str(msg))
+        debug_mod.syslog = lambda msg, *_a, **_k: env.logs.append(str(msg))
+        sys.modules["Debug"] = debug_mod
+
+        files_mod = types.ModuleType("Files")
+
+        class OSPath:
+            CONFIG = str(env.config_dir)
+
+        def path_join(*parts):
+            path = "/".join(str(part).strip("/") for part in parts if part)
+            if parts and str(parts[0]).startswith("/"):
+                path = path if path.startswith("/") else "/" + path
+            return path
+
+        files_mod.OSPath = OSPath
+        files_mod.path_join = path_join
+        files_mod.is_file = lambda path: env._resolve(path).is_file()
+        sys.modules["Files"] = files_mod
+
+        uos_mod = types.ModuleType("uos")
+        uos_mod.remove = lambda path: env._resolve(path).unlink()
+        uos_mod.rename = lambda src, dst: env._resolve(src).rename(env._resolve(dst))
+        sys.modules["uos"] = uos_mod
+
+        microio_mod = types.ModuleType("microIO")
+        microio_mod.set_pinmap = None
+        sys.modules["microIO"] = microio_mod
+
+    def restore(self):
+        for name, module in self._saved.items():
+            if module is None:
+                sys.modules.pop(name, None)
+            else:
+                sys.modules[name] = module
+
+
+def _load_config_module(raw_config=None):
+    tempdir = tempfile.TemporaryDirectory()
+    root = Path(tempdir.name)
+    config_dir = root / "config"
+    config_dir.mkdir(parents=True, exist_ok=True)
+
+    config_path = config_dir / "node_config.json"
+    if raw_config is not None:
+        config_path.write_text(raw_config, encoding="utf-8")
+
+    env = _ConfigStubEnv(root)
+    env.install()
+    try:
+        here = Path(__file__).resolve()
+        config_py = (here.parent.parent / "source" / "Config.py").resolve()
+        module_name = f"micros_config_under_test_{next(_LOAD_ID)}"
+        spec = importlib.util.spec_from_file_location(module_name, str(config_py))
+        mod = importlib.util.module_from_spec(spec)
+        sys.modules[module_name] = mod
+        spec.loader.exec_module(mod)
+        return mod, env, tempdir, config_path
+    finally:
+        env.restore()
+
+
+class TestConfig(unittest.TestCase):
+    def test_init_bootstraps_missing_config(self):
+        mod, env, tempdir, config_path = _load_config_module()
+        self.addCleanup(tempdir.cleanup)
+
+        self.assertTrue(config_path.is_file())
+        self.assertEqual(mod.cfgget("devfid"), "node01")
+        self.assertFalse(any("read_cfg_file error" in msg for msg in env.logs))
+
+        persisted = json.loads(config_path.read_text(encoding="utf-8"))
+        self.assertEqual(persisted["devfid"], "node01")
+        self.assertEqual(persisted["appwd"], "ADmin123")
+
+    def test_init_quarantines_corrupted_config_and_regenerates_defaults(self):
+        raw_corrupt = '{"devfid": "broken"'
+        mod, env, tempdir, config_path = _load_config_module(raw_config=raw_corrupt)
+        self.addCleanup(tempdir.cleanup)
+
+        bad_path = config_path.with_name("node_config.json.bad")
+        self.assertTrue(bad_path.is_file())
+        self.assertEqual(bad_path.read_text(encoding="utf-8"), raw_corrupt)
+        self.assertEqual(mod.cfgget("devfid"), "node01")
+        self.assertTrue(any("read_cfg_file error" in msg for msg in env.logs))
+
+        persisted = json.loads(config_path.read_text(encoding="utf-8"))
+        self.assertEqual(persisted["devfid"], "node01")
+
+    def test_cfgput_keeps_runtime_value_and_logs_when_write_fails(self):
+        mod, env, tempdir, config_path = _load_config_module(raw_config='{"devfid": "orig"}')
+        self.addCleanup(tempdir.cleanup)
+
+        self.assertEqual(mod.cfgget("devfid"), "orig")
+        with mock.patch("builtins.open", side_effect=OSError("disk full")):
+            self.assertTrue(mod.cfgput("devfid", "updated"))
+        self.assertEqual(mod.cfgget("devfid"), "updated")
+        self.assertTrue(any("write_cfg_file" in msg for msg in env.logs))
+
+        persisted = json.loads(config_path.read_text(encoding="utf-8"))
+        self.assertEqual(persisted["devfid"], "orig")
+
+
+if __name__ == "__main__":
+    unittest.main(verbosity=2)

{microsdevtoolkit-3.0.2 → microsdevtoolkit-3.0.4}/micrOS/utests/test_scheduler.py

@@ -62,7 +62,7 @@ RUN_DAYS = 365
 # - scheduler sampling/tolerance window (deltasec)
 # - execution period (how frequently scheduler() is called)
 # - virtual time tick step
-EXEC_PERIOD_SEC = 5  # default 5 seconds
+EXEC_PERIOD_SEC = 30  # default 30 seconds
 
 # Provide sunrise/sunset times for tag resolution (Sun.TIME)
 SUN_TIME = {"sunrise": (6, 0, 0), "sunset": (18, 0, 0)}

{microsdevtoolkit-3.0.2 → microsdevtoolkit-3.0.4/micrOSDevToolKit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: micrOSDevToolKit
-Version: 3.0.2
+Version: 3.0.4
 Summary: Development and deployment environment for micrOS, the diy micropython automation OS (IoT)
 Home-page: https://github.com/BxNxM/micrOS
 Author: Marcell Ban

{microsdevtoolkit-3.0.2 → microsdevtoolkit-3.0.4}/micrOSDevToolKit.egg-info/SOURCES.txt

@@ -160,6 +160,7 @@ micrOS/source/web/uwidgets.js
 micrOS/source/web/uwidgets_pro.js
 micrOS/utests/__init__.py
 micrOS/utests/test_buffer.py
+micrOS/utests/test_config.py
 micrOS/utests/test_scheduler.py
 micrOS/utests/test_time.py
 micrOS/utests/test_urequests.py
@@ -178,8 +179,6 @@ toolkit/LM_to_compile.dat
 toolkit/MicrOSDevEnv.py
 toolkit/WebRepl.py
 toolkit/__init__.py
-toolkit/img_stream.html
-toolkit/index.html
 toolkit/micrOSdashboard.py
 toolkit/micrOSlint.py
 toolkit/socketClient.py
@@ -208,6 +207,9 @@ toolkit/dashboard_apps/_gyro_visualizer.py
 toolkit/dashboard_apps/_micPlotting.py
 toolkit/dashboard_apps/_presencePlotting.py
 toolkit/dashboard_apps/uLightDemo.py
+toolkit/gateway/gateway.css
+toolkit/gateway/img_stream.html
+toolkit/gateway/index.html
 toolkit/lib/LocalMachine.py
 toolkit/lib/MicrosFiles.py
 toolkit/lib/Repository.py

{microsdevtoolkit-3.0.2 → microsdevtoolkit-3.0.4}/setup.py

@@ -17,7 +17,7 @@ dependencies = ['adafruit-ampy', 'mpremote', 'esptool', 'ipaddress', 'netaddr',
 
 setuptools.setup(
     name='micrOSDevToolKit',
-    version='3.0.2',
+    version='3.0.4',
     author='Marcell Ban',
     author_email='miros.framework@gmail.com',
     description='Development and deployment environment for micrOS, the diy micropython automation OS (IoT)',

{microsdevtoolkit-3.0.2 → microsdevtoolkit-3.0.4}/toolkit/Gateway.py

@@ -3,12 +3,14 @@
 # using flask_restful
 import json
 import os
+import ipaddress
 from flask import Flask, jsonify, Response, make_response, request, send_file, abort
 from flask_restful import Resource, Api
 import threading
 import time
 import concurrent.futures
 MYPATH = os.path.dirname(__file__)
+WEBUI_PATH = os.path.join(MYPATH, 'gateway')
 import requests
 from io import BytesIO
 from socket import gethostbyname
@@ -35,6 +37,11 @@ API_URL_CACHE = ""
 # creating the flask app
 app = Flask(__name__)
 
+
+@app.route('/gateway.css')
+def gateway_css():
+    return send_file(os.path.join(WEBUI_PATH, 'gateway.css'), mimetype='text/css')
+
 # --------------------- AUTH BEGIN ------------------------- #
 ADDRESS_CACHE = {}
 try:
@@ -52,6 +59,8 @@ except Exception as e:
     print("[GW-AUTH][DISABLED] API_AUTH ENV VAR NOT FOUND.")
     __rest_usr_name, __rest_usr_pwd, ALLOWED_COUNTRY = None, None, []
 
+if (__rest_usr_name and __rest_usr_pwd) and BasicAuth is None:
+    raise RuntimeError("API_AUTH is configured, but flask_basicauth is not available")
 
 if BasicAuth is not None and (__rest_usr_name and __rest_usr_pwd):
     basic_auth = BasicAuth(app)
@@ -62,15 +71,16 @@ if BasicAuth is not None and (__rest_usr_name and __rest_usr_pwd):
     #app.config['BASIC_AUTH_PASSWORD'] = f'{__rest_usr_pwd}{datetime.now().day}'  # month-day (21)
 
     def _is_local_network():
-        # Define local network IP prefixes (adjust as needed)
-        local_network_prefixes = ['192.168.', '10.0.', '172.']
         #local_network_prefixes = []
         remote_ip = request.remote_addr
         print(f"\t[GW-AUTH] Check incoming IP address: {remote_ip}")
-        for prefix in local_network_prefixes:
-            if remote_ip.startswith(prefix):
-                print(f"\t\t[GW-AUTH] SKIP AUTH - LOCAL NETWORK: {prefix} match with {remote_ip}")
+        try:
+            remote_addr = ipaddress.ip_address(remote_ip)
+            if remote_addr.is_private or remote_addr.is_loopback:
+                print(f"\t\t[GW-AUTH] SKIP AUTH - LOCAL NETWORK: {remote_ip}")
                 return True, remote_ip
+        except ValueError:
+            print(f"\t\t[GW-AUTH] INVALID REMOTE IP: {remote_ip}")
         return False, remote_ip
 
 
@@ -142,7 +152,7 @@ class Hello(Resource):
     # is a GET request for this resource
 
     def get(self):
-        index_html = os.path.join(MYPATH, 'index.html')
+        index_html = os.path.join(WEBUI_PATH, 'index.html')
         try:
             with open(index_html, 'r') as file:
                 html = file.read()
@@ -185,6 +195,8 @@ class SendCmd(Resource):
         cmd_str = ' '.join(cmd_list)
 
         ip, port, fid, uid = socketClient.ConnectionData.select_device(device_tag=device)
+        if uid is None:
+            abort(404, description=f"Unknown device: {device}")
         device_detailed = (uid, ip, port, fid)
 
         print("[Gateway] Raw command params: --dev {} {}".format(uid, cmd_str))
@@ -322,7 +334,7 @@ class DeviceStatus(Resource):
 
             # Clean Alarms
             clean_alarms = DeviceStatus.CLEAN_MICROS_ALARMS
-            log_data = alarms.get('log', None)
+            log_data = alarms.get('log', None) if isinstance(alarms, dict) else None
             if clean_alarms and log_data and len(log_data) > 0:
                 _, _ = socketClient.run(['--dev', fuid.strip(), 'system alarms True'])
 
@@ -341,7 +353,7 @@ class DeviceStatus(Resource):
 
             # Get cpu temp
             _status4, cpu_temp = socketClient.run(['--dev', fuid.strip(), 'esp32 temp'])
-            if 'temp' in cpu_temp:
+            if isinstance(cpu_temp, str) and 'temp' in cpu_temp:
                 try:
                     cpu_temp = cpu_temp.split(":")[1].strip()
                 except:
@@ -352,6 +364,7 @@ class DeviceStatus(Resource):
         output_dev_struct = {}
         online_dev_cnt = 0
         device_struct = socketClient.ConnectionData.list_devices()
+        real_device_count = max(1, len(device_struct) - 2)
         dev_query_list = []
 
         # Start parallel status queries
@@ -362,7 +375,11 @@ class DeviceStatus(Resource):
 
         # Collect results from queries
         for query in dev_query_list:
-            node_info = query.result()
+            try:
+                node_info = query.result()
+            except Exception as e:
+                print(f"Node status worker error: {e}")
+                continue
 
             if node_info is None:
                 continue
@@ -372,7 +389,7 @@ class DeviceStatus(Resource):
             # Status calculation
             if status:
                 online_dev_cnt += 1
-                DeviceStatus.DEVS_AVAIL = round((online_dev_cnt / (len(device_struct)-2)) *100, 1)
+                DeviceStatus.DEVS_AVAIL = round((online_dev_cnt / real_device_count) * 100, 1)
                 status = 'HEALTHY'
             else:
                 status = 'UNHEALTHY'
@@ -574,7 +591,7 @@ class ImgStream(Resource):
     # is a GET request for this resource
 
     def get(self):
-        index_html = os.path.join(MYPATH, 'img_stream.html')
+        index_html = os.path.join(WEBUI_PATH, 'img_stream.html')
         try:
             with open(index_html, 'r') as file:
                 html = file.read()
@@ -620,6 +637,8 @@ api.add_resource(WebHook, '/webhooks', '/webhooks/<string:payload>', '/webhooks/
 
 
 def gateway(debug=True):
+    if (__rest_usr_name and __rest_usr_pwd) and BasicAuth is None:
+        raise RuntimeError("API_AUTH is set but flask_basicauth is unavailable. Refusing to start unsecured gateway.")
     global API_URL_CACHE
     API_URL_CACHE = f"http://{my_local_ip()}:5005"
     print("\n############### START MICROS GATEWAY ###############")