cleepcli 1.45.1__tar.gz → 1.48.0__tar.gz

{cleepcli-1.45.1 → cleepcli-1.48.0}/MANIFEST.in

@@ -7,3 +7,4 @@ include setup.cfg
 include MANIFEST.in
 recursive-include bin *
 recursive-include cleepcli *.py
+recursive-include cleepcli/systemd *

{cleepcli-1.45.1/cleepcli.egg-info → cleepcli-1.48.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cleepcli
-Version: 1.45.1
+Version: 1.48.0
 Summary: Cleep-cli helps developers to build great Cleep applications from command line.
 Home-page: https://github.com/CleepDevice/cleep-cli
 Author: Tanguy Bonneau
@@ -42,7 +42,7 @@ This utility helps developers to build Cleep applications providing some useful
     - `coreget` to clone or pull official Cleep repository.
     - `coredocs` to generate core documentation in HTML format.
     - `coresync` to synchronize sources from repository to execution folders.
-    - `coretests` to perform core tests suite.
+    - `coretests` to perform core unit tests suite (`--functional` for real OS binary tests on device / OS migration).
     - `coretestscov` to display last core tests code coverage report.
     - `cpuprof` to run CPU profiler on application execution instance.
     - `memprof` to run memory profiler on application execution instance.
@@ -52,7 +52,7 @@ This utility helps developers to build Cleep applications providing some useful
     - `moddelete` to delete installed files of a module.
     - `moddocs` to generate module documentation.
     - `modsync` to synchronize sources from module folder to execution folders.
-    - `modtests` to execute module tests.
+    - `modtests` to execute module unit tests (`--functional` for real OS/device tests).
     - `modtestscov` to display last module tests code coverage report.
     - `modbuild` to create application package (.zip)
     - `modcheckback` to check app backend (python files structure and content)
@@ -61,7 +61,9 @@ This utility helps developers to build Cleep applications providing some useful
     - `modcheckscripts` to check app scripts files
     - `modcheckcode` to check backend code quality (run pylint)
 - Watch commands:
-    - `watch` to watch for repository filesystem changes and automatically update files on execution folders. It also restart backend or/and frontend according to changes.
+    - `watch` to watch for repository filesystem changes and automatically update files on execution folders. It also restart backend or/and frontend according to changes (catch-up sync on start).
+    - `watchsvc` to install/enable/disable/restart the durable `cleep-watch` systemd unit (runs `watch` outside `cleep.service`).
+    - `syncall` to force a one-shot sync of core + all modules (same catch-up as watch start).
 - Misc commands:
     - `version` to get cleep-cli version
 
@@ -85,9 +87,23 @@ Execute this command to get help on this cli:
 
 ## Watch usage
 
-Launch `watch` cli command to monitor changes on "/root/cleep-dev" directory after getting official Cleep repository using `coreget` command.
+Preferred: let the CLI own the durable systemd unit:
 
-Then open your favorite editor on your development computer, configure a remote sync plugin to push local changes on your raspberry pi then cleep-cli will synchronize sources on Cleep execution environment and restart application automatically.
+```
+cleep-cli watchsvc install
+cleep-cli watchsvc enable
+```
+
+The unit runs `cleep-cli watch`, survives `systemctl restart cleep`, and on each start performs a catch-up `syncall` so files written while the watcher was down are applied.
+
+Manual one-shot resync (when the UI looks stale):
+
+```
+cleep-cli syncall
+cleep-cli watchsvc restart   # catch-up again + resume watch
+```
+
+You can still run `cleep-cli watch` in a terminal for debugging. Push sources to `/root/cleep-dev` (CleepDesktop developer sync or SFTP); the watcher copies them into the execution folders and restarts backend/frontend as needed.
 
 ### Paths
 

{cleepcli-1.45.1 → cleepcli-1.48.0}/README.md

@@ -6,7 +6,7 @@ This utility helps developers to build Cleep applications providing some useful
     - `coreget` to clone or pull official Cleep repository.
     - `coredocs` to generate core documentation in HTML format.
     - `coresync` to synchronize sources from repository to execution folders.
-    - `coretests` to perform core tests suite.
+    - `coretests` to perform core unit tests suite (`--functional` for real OS binary tests on device / OS migration).
     - `coretestscov` to display last core tests code coverage report.
     - `cpuprof` to run CPU profiler on application execution instance.
     - `memprof` to run memory profiler on application execution instance.
@@ -16,7 +16,7 @@ This utility helps developers to build Cleep applications providing some useful
     - `moddelete` to delete installed files of a module.
     - `moddocs` to generate module documentation.
     - `modsync` to synchronize sources from module folder to execution folders.
-    - `modtests` to execute module tests.
+    - `modtests` to execute module unit tests (`--functional` for real OS/device tests).
     - `modtestscov` to display last module tests code coverage report.
     - `modbuild` to create application package (.zip)
     - `modcheckback` to check app backend (python files structure and content)
@@ -25,7 +25,9 @@ This utility helps developers to build Cleep applications providing some useful
     - `modcheckscripts` to check app scripts files
     - `modcheckcode` to check backend code quality (run pylint)
 - Watch commands:
-    - `watch` to watch for repository filesystem changes and automatically update files on execution folders. It also restart backend or/and frontend according to changes.
+    - `watch` to watch for repository filesystem changes and automatically update files on execution folders. It also restart backend or/and frontend according to changes (catch-up sync on start).
+    - `watchsvc` to install/enable/disable/restart the durable `cleep-watch` systemd unit (runs `watch` outside `cleep.service`).
+    - `syncall` to force a one-shot sync of core + all modules (same catch-up as watch start).
 - Misc commands:
     - `version` to get cleep-cli version
 
@@ -49,9 +51,23 @@ Execute this command to get help on this cli:
 
 ## Watch usage
 
-Launch `watch` cli command to monitor changes on "/root/cleep-dev" directory after getting official Cleep repository using `coreget` command.
+Preferred: let the CLI own the durable systemd unit:
 
-Then open your favorite editor on your development computer, configure a remote sync plugin to push local changes on your raspberry pi then cleep-cli will synchronize sources on Cleep execution environment and restart application automatically.
+```
+cleep-cli watchsvc install
+cleep-cli watchsvc enable
+```
+
+The unit runs `cleep-cli watch`, survives `systemctl restart cleep`, and on each start performs a catch-up `syncall` so files written while the watcher was down are applied.
+
+Manual one-shot resync (when the UI looks stale):
+
+```
+cleep-cli syncall
+cleep-cli watchsvc restart   # catch-up again + resume watch
+```
+
+You can still run `cleep-cli watch` in a terminal for debugging. Push sources to `/root/cleep-dev` (CleepDesktop developer sync or SFTP); the watcher copies them into the execution folders and restarts backend/frontend as needed.
 
 ### Paths
 

{cleepcli-1.45.1 → cleepcli-1.48.0}/bin/ccli

@@ -17,6 +17,7 @@ from cleepcli.git import Git
 from cleepcli.module import Module
 from cleepcli.file import File
 from cleepcli.watch import CleepWatchdog
+from cleepcli.watchsvc import WatchService
 from cleepcli.test import Test, is_file_coverage_valid
 from cleepcli.package import Package
 from cleepcli.docs import Docs
@@ -108,18 +109,31 @@ def coresync():
         sys.exit(1)
     logging.info('Done')
 
+@core.command()
+def syncall():
+    """
+    Synchronize core and all modules from /root/cleep-dev to execution folders.
+
+    Same catch-up used when cleep-watch.service starts. Safe one-shot resync when
+    the UI looks stale: run this, then reload the device page.
+    """
+    f = File()
+    if not f.sync_all():
+        sys.exit(1)
+
 @core.command()
 @click.option('--coverage', is_flag=True, help='Display coverage report.')
 @click.option('--output', is_flag=True, help='Display tests output.')
 @click.option('--xml', is_flag=True, default=False, help='Use xml reporting instead of default one (report).')
 @click.option('--quiet', is_flag=True, default=True, help='Display or not coverage warnings.')
 @click.option('-p', '--pattern', default=None, help='Run tests on specified file pattern only')
-def coretests(coverage, output, xml, quiet, pattern):
+@click.option('--functional', is_flag=True, help='Run functional tests (real OS binaries) instead of unit tests.')
+def coretests(coverage, output, xml, quiet, pattern, functional):
     """
     Execute core tests
     """
     m = Test()
-    res = m.core_tests(coverage, output, xml, quiet, pattern)
+    res = m.core_tests(coverage, output, xml, quiet, pattern, functional=functional)
 
     if not res:
         sys.exit(1)
@@ -357,9 +371,13 @@ def watchdog():
 @click.option('--quiet', is_flag=True, help='Disable logging.')
 @click.option('--loglevel', default=logging.INFO, help='Logging level (10=DEBUG, 20=INFO, 30=WARN, 40=ERROR).')
 @click.option('--rpc-url', default='https://127.0.0.1:443', help='Cleep RPC url (ex https://ip|host:port')
-def watch(quiet, loglevel, rpc_url):
+@click.option('--skip-catchup', is_flag=True, help='Do not syncall before watching (not recommended).')
+def watch(quiet, loglevel, rpc_url, skip_catchup):
     """
-    Start watchdog that monitors filesystem changes on Cleep sources
+    Start watchdog that monitors filesystem changes on Cleep sources.
+
+    Prefer managing the durable unit with watchsvc (survives Cleep restarts).
+    On start, syncs core + all modules once unless --skip-catchup is set.
     """
     if logging.getLogger().getEffectiveLevel() == logging.DEBUG:
         # do not overwrite root logger level if configured to DEBUG (dev mode)
@@ -368,13 +386,51 @@ def watch(quiet, loglevel, rpc_url):
         logging.disable(logging.CRITICAL)
     else:
         logging.getLogger().setLevel(loglevel)
-        
-    w = CleepWatchdog(rpc_url)
+
+    w = CleepWatchdog(rpc_url, catch_up=not skip_catchup)
     res = w.watch()
 
     if not res:
         sys.exit(1)
 
+@watchdog.command('watchsvc')
+@click.argument(
+    'action',
+    type=click.Choice(
+        ['install', 'uninstall', 'enable', 'disable', 'start', 'stop', 'restart', 'status']
+    ),
+)
+def watchsvc_cmd(action):
+    """
+    Manage the durable cleep-watch systemd unit.
+
+    ACTION is one of: install, uninstall, enable, disable, start, stop, restart, status.
+
+    The unit runs ``cleep-cli watch`` outside of cleep.service. Typical setup::
+
+        cleep-cli watchsvc install
+        cleep-cli watchsvc enable
+    """
+    svc = WatchService()
+    handlers = {
+        'install': svc.install,
+        'uninstall': svc.uninstall,
+        'enable': svc.enable,
+        'disable': svc.disable,
+        'start': svc.start,
+        'stop': svc.stop,
+        'restart': svc.restart,
+    }
+    if action == 'status':
+        status = svc.status()
+        logging.info(status)
+        if status != 'active':
+            sys.exit(1)
+        return
+
+    if not handlers[action]():
+        sys.exit(1)
+
 @click.group()
 def test():
     pass
@@ -385,7 +441,8 @@ def test():
 @click.option('--coverage', is_flag=True, help='Display coverage report.')
 @click.option('--copyto', help='Copy .coverage file to specified dir.')
 @click.option('-p', '--pattern', help='Execute tests matching pattern.')
-def modtests(ctx, module, coverage, copyto, pattern):
+@click.option('--functional', is_flag=True, help='Run functional tests (real OS/device) instead of unit tests.')
+def modtests(ctx, module, coverage, copyto, pattern, functional):
     """
     Execute module tests
     """
@@ -393,7 +450,7 @@ def modtests(ctx, module, coverage, copyto, pattern):
     ctx.invoke(modsync, module=module)
 
     m = Test()
-    res = m.module_tests(module, coverage, copyto, pattern)
+    res = m.module_tests(module, coverage, copyto, pattern, functional=functional)
 
     if not res:
         sys.exit(1)

{cleepcli-1.45.1 → cleepcli-1.48.0}/bin/cleep-cli

@@ -17,6 +17,7 @@ from cleepcli.git import Git
 from cleepcli.module import Module
 from cleepcli.file import File
 from cleepcli.watch import CleepWatchdog
+from cleepcli.watchsvc import WatchService
 from cleepcli.test import Test, is_file_coverage_valid
 from cleepcli.package import Package
 from cleepcli.docs import Docs
@@ -108,18 +109,31 @@ def coresync():
         sys.exit(1)
     logging.info('Done')
 
+@core.command()
+def syncall():
+    """
+    Synchronize core and all modules from /root/cleep-dev to execution folders.
+
+    Same catch-up used when cleep-watch.service starts. Safe one-shot resync when
+    the UI looks stale: run this, then reload the device page.
+    """
+    f = File()
+    if not f.sync_all():
+        sys.exit(1)
+
 @core.command()
 @click.option('--coverage', is_flag=True, help='Display coverage report.')
 @click.option('--output', is_flag=True, help='Display tests output.')
 @click.option('--xml', is_flag=True, default=False, help='Use xml reporting instead of default one (report).')
 @click.option('--quiet', is_flag=True, default=True, help='Display or not coverage warnings.')
 @click.option('-p', '--pattern', default=None, help='Run tests on specified file pattern only')
-def coretests(coverage, output, xml, quiet, pattern):
+@click.option('--functional', is_flag=True, help='Run functional tests (real OS binaries) instead of unit tests.')
+def coretests(coverage, output, xml, quiet, pattern, functional):
     """
     Execute core tests
     """
     m = Test()
-    res = m.core_tests(coverage, output, xml, quiet, pattern)
+    res = m.core_tests(coverage, output, xml, quiet, pattern, functional=functional)
 
     if not res:
         sys.exit(1)
@@ -357,9 +371,13 @@ def watchdog():
 @click.option('--quiet', is_flag=True, help='Disable logging.')
 @click.option('--loglevel', default=logging.INFO, help='Logging level (10=DEBUG, 20=INFO, 30=WARN, 40=ERROR).')
 @click.option('--rpc-url', default='https://127.0.0.1:443', help='Cleep RPC url (ex https://ip|host:port')
-def watch(quiet, loglevel, rpc_url):
+@click.option('--skip-catchup', is_flag=True, help='Do not syncall before watching (not recommended).')
+def watch(quiet, loglevel, rpc_url, skip_catchup):
     """
-    Start watchdog that monitors filesystem changes on Cleep sources
+    Start watchdog that monitors filesystem changes on Cleep sources.
+
+    Prefer managing the durable unit with watchsvc (survives Cleep restarts).
+    On start, syncs core + all modules once unless --skip-catchup is set.
     """
     if logging.getLogger().getEffectiveLevel() == logging.DEBUG:
         # do not overwrite root logger level if configured to DEBUG (dev mode)
@@ -368,13 +386,51 @@ def watch(quiet, loglevel, rpc_url):
         logging.disable(logging.CRITICAL)
     else:
         logging.getLogger().setLevel(loglevel)
-        
-    w = CleepWatchdog(rpc_url)
+
+    w = CleepWatchdog(rpc_url, catch_up=not skip_catchup)
     res = w.watch()
 
     if not res:
         sys.exit(1)
 
+@watchdog.command('watchsvc')
+@click.argument(
+    'action',
+    type=click.Choice(
+        ['install', 'uninstall', 'enable', 'disable', 'start', 'stop', 'restart', 'status']
+    ),
+)
+def watchsvc_cmd(action):
+    """
+    Manage the durable cleep-watch systemd unit.
+
+    ACTION is one of: install, uninstall, enable, disable, start, stop, restart, status.
+
+    The unit runs ``cleep-cli watch`` outside of cleep.service. Typical setup::
+
+        cleep-cli watchsvc install
+        cleep-cli watchsvc enable
+    """
+    svc = WatchService()
+    handlers = {
+        'install': svc.install,
+        'uninstall': svc.uninstall,
+        'enable': svc.enable,
+        'disable': svc.disable,
+        'start': svc.start,
+        'stop': svc.stop,
+        'restart': svc.restart,
+    }
+    if action == 'status':
+        status = svc.status()
+        logging.info(status)
+        if status != 'active':
+            sys.exit(1)
+        return
+
+    if not handlers[action]():
+        sys.exit(1)
+
 @click.group()
 def test():
     pass
@@ -385,7 +441,8 @@ def test():
 @click.option('--coverage', is_flag=True, help='Display coverage report.')
 @click.option('--copyto', help='Copy .coverage file to specified dir.')
 @click.option('-p', '--pattern', help='Execute tests matching pattern.')
-def modtests(ctx, module, coverage, copyto, pattern):
+@click.option('--functional', is_flag=True, help='Run functional tests (real OS/device) instead of unit tests.')
+def modtests(ctx, module, coverage, copyto, pattern, functional):
     """
     Execute module tests
     """
@@ -393,7 +450,7 @@ def modtests(ctx, module, coverage, copyto, pattern):
     ctx.invoke(modsync, module=module)
 
     m = Test()
-    res = m.module_tests(module, coverage, copyto, pattern)
+    res = m.module_tests(module, coverage, copyto, pattern, functional=functional)
 
     if not res:
         sys.exit(1)

{cleepcli-1.45.1 → cleepcli-1.48.0}/cleepcli/check.py

@@ -1497,6 +1497,50 @@ overgeneral-exceptions=Exception
         """
         return self._check_module_tree(module_name, "asset")
 
+    def check_firmwares(self, module_name):
+        """
+        Validate optional ``firmwares/`` zip+sidecar ``.manifest`` pairs and list
+        files for packaging (see ``cleep.libs.internals.firmware_manifest``).
+
+        Returns:
+            dict: errors / warnings / files (same shape as check_scripts)
+        """
+        if not os.path.exists(os.path.join(config.MODULES_DST, module_name)):
+            raise Exception('Module "%s" does not exist' % module_name)
+
+        firmwares_path = os.path.join(config.MODULES_SRC, module_name, "firmwares")
+        out = {
+            "errors": [],
+            "warnings": [],
+            "files": [],
+        }
+        if not os.path.isdir(firmwares_path):
+            return out
+
+        try:
+            from cleep.libs.internals.firmware_manifest import (
+                FirmwareManifestError,
+                scan_firmwares_dir,
+            )
+        except ImportError:
+            out["errors"].append(
+                "Unable to import cleep.libs.internals.firmware_manifest "
+                "(is Cleep core available on PYTHONPATH?)"
+            )
+            return out
+
+        try:
+            scan_firmwares_dir(firmwares_path)
+        except FirmwareManifestError as error:
+            out["errors"].append(str(error))
+            return out
+
+        # Include valid pairs in the package file list
+        tree = self._check_module_tree(module_name, "firmwares")
+        out["files"] = tree["files"]
+        out["warnings"] = tree["warnings"]
+        return out
+
     def check_tests(self, module_name):
         """
         Check test files

{cleepcli-1.45.1 → cleepcli-1.48.0}/cleepcli/file.py

@@ -60,6 +60,51 @@ rsync -av "%(REPO_DIR)s/medias/sounds" "%(MEDIA_DST)s/sounds/" --delete
 
         return True
 
+    def list_modules(self):
+        """
+        List module folder names under MODULES_SRC (skips hidden dirs).
+
+        Returns:
+            list: sorted module names
+        """
+        if not os.path.isdir(config.MODULES_SRC):
+            return []
+        names = []
+        try:
+            for name in os.listdir(config.MODULES_SRC):
+                if name.startswith("."):
+                    continue
+                path = os.path.join(config.MODULES_SRC, name)
+                if os.path.isdir(path):
+                    names.append(name)
+        except OSError as error:
+            self.logger.error("Unable to list modules: %s", error)
+            return []
+        return sorted(names)
+
+    def sync_all(self):
+        """
+        Synchronize core and every module from REPO_DIR to execution folders.
+
+        Used as watch catch-up on start and by the ``syncall`` CLI command so a
+        full resync is always one explicit action away.
+
+        Returns:
+            bool: True if every sync succeeded
+        """
+        self.logger.info("Synchronizing core sources...")
+        if not self.core_sync():
+            return False
+
+        modules = self.list_modules()
+        for module_name in modules:
+            self.logger.info('Synchronizing module "%s" sources...', module_name)
+            if not self.module_sync(module_name):
+                return False
+
+        self.logger.info("Sync all done (%d module(s))", len(modules))
+        return True
+
     def module_sync(self, module_name, backend=True, frontend=True, scripts=True):
         """
         Copy specified module content to valid execution location

{cleepcli-1.45.1 → cleepcli-1.48.0}/cleepcli/module.py

@@ -488,6 +488,8 @@ pytest_plugins = ('cleep.libs.tests.fixtures',)
 pythonpath = .
 testpaths = tests
 python_files = test_*.py
+markers =
+    functional: real OS/device tests (CLEEP_FUNCTIONAL_TESTS / modtests --functional)
 """
     DOCS_CONF_PY = """# -*- coding: utf-8 -*-
 import os, sys

{cleepcli-1.45.1 → cleepcli-1.48.0}/cleepcli/package.py

@@ -516,6 +516,12 @@ sha256sum $DEB > $SHA256
                 "Error in asset/. Fix it before packaging application: %s"
                 % data_asset["errors"]
             )
+        data_firmwares = check.check_firmwares(module_name)
+        if len(data_firmwares["errors"]) > 0:
+            raise Exception(
+                "Error in firmwares/. Fix it before packaging application: %s"
+                % data_firmwares["errors"]
+            )
         data_tests = check.check_tests(module_name)
         if len(data_tests["errors"]) > 0:
             raise Exception(
@@ -629,6 +635,10 @@ sha256sum $DEB > $SHA256
         for a_file in data_asset["files"]:
             archive.write(a_file["fullpath"], a_file["path"])
 
+        # add firmwares/ (zip + sidecar .manifest; installer copies to APP_FIRMWARE)
+        for a_file in data_firmwares["files"]:
+            archive.write(a_file["fullpath"], a_file["path"])
+
         # add module.json
         archive.write(module_json, "module.json")
 

cleepcli-1.48.0/cleepcli/systemd/cleep-watch.service

@@ -0,0 +1,18 @@
+[Unit]
+Description=Cleep development source watcher (cleep-cli watch)
+Documentation=https://github.com/CleepDevice/cleep-cli
+# Independent from cleep.service so backend restarts do not kill the watcher
+# mid-sync (Desktop writes would otherwise be missed until the next edit).
+After=network-online.target
+Wants=network-online.target
+
+[Service]
+Type=simple
+ExecStart=/usr/local/bin/cleep-cli watch --loglevel=20
+Restart=always
+RestartSec=3
+# Allow a long catch-up sync on start before the main loop
+TimeoutStartSec=180
+
+[Install]
+WantedBy=multi-user.target