scriptlets support (#39)

* change return signature

* - cli better help formatter
- fix docs
- luxos-run: fix typo in tear down flag

* new luxminer module

* iminer: relax --range flag allowing file path without using @

* iminer: call teardown if present on completion of luxos-run

* iminer: support log downloading

* iminer: adds is_ramping function, get_profile and Log parser

* iminer: update requirements

* iminer: version bump

* iminer: add new db flag

* removed comment

* cleanup

Author: cav71

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "luxos"
-version = "0.2.2"
+version = "0.2.3"
 description = "The all encompassing LuxOS python library."
 readme = "README.md"
 license = { text = "MIT" }  # TODO I don't think this is a MIT??

src/luxos/asyncops.py

@@ -341,7 +341,7 @@ async def rexec(
     timeout: float | None = None,
     retry: int | None = None,
     retry_delay: float | None = None,
-) -> dict[str, Any] | None:
+) -> dict[str, Any]:
     """
     Send a command to a host.
 
@@ -442,6 +442,7 @@ async def rexec(
         await logoff(host, port, sid)
     if isinstance(failure, Exception):
         raise failure
+    return {}
 
 
 @contextlib.asynccontextmanager

src/luxos/cli/flags.py

@@ -107,6 +107,8 @@ def type_range(txt: str) -> Sequence[tuple[str, int | None]]:
     path = None
     if txt.startswith("@") and not (path := Path(txt[1:])).exists():
         raise argparse.ArgumentTypeError(f"file not found {path}")
+    if Path(txt).exists():
+        path = Path(txt)
 
     if path:
         with contextlib.suppress(RuntimeError, DataParsingError):
@@ -160,6 +162,48 @@ def validate(self, txt) -> None | datetime.time:
         raise argparse.ArgumentTypeError(f"failed conversion into HH:MM for '{txt}'")
 
 
+class type_database(ArgumentTypeBase):
+    """
+    Validate a type as a database string (sqlalchemy)
+
+    Raises:
+        argparse.ArgumentTypeError: on an invalid input.
+
+    Returns:
+        datetime.time or None
+
+    Example:
+        file.py::
+
+            parser.add_argument("-x", type=type_database)
+            options = parser.parse_args()
+            ...
+
+            assert options.x == sqlalchemy.Engine
+
+
+        shell::
+
+            file.py -x sqlite:///foobar.db
+            file.py -x postgresql+psycopg2://<user>:<password>@<host>/<db>
+    """
+
+    def validate(self, txt) -> Any:
+        if not txt:
+            return None
+
+        from sqlalchemy import create_engine
+        from sqlalchemy.engine.url import make_url
+        from sqlalchemy.exc import ArgumentError
+
+        with contextlib.suppress(ArgumentError):
+            url = make_url(txt)
+            return create_engine(url)
+        raise argparse.ArgumentTypeError(
+            f"wrong sqlalchemy url format '{txt}' (eg. sqlite:///filename.db)"
+        )
+
+
 def add_arguments_rexec(parser: LuxosParserBase):
     """adds the rexec timing for timeout/retries/delays
 

src/luxos/cli/v1.py

@@ -101,7 +101,6 @@ def main(parser: argparse.ArgumentParser):
 from pathlib import Path
 from typing import Any, Callable
 
-from .. import text
 from . import flags
 from .shared import ArgumentTypeBase, LuxosParserBase
 
@@ -189,7 +188,9 @@ def parse_args(self, args=None, namespace=None):
     @classmethod
     def get_parser(cls, modules: list[types.ModuleType], **kwargs):
         class Formatter(
-            argparse.ArgumentDefaultsHelpFormatter, argparse.RawTextHelpFormatter
+            argparse.RawTextHelpFormatter,
+            argparse.RawDescriptionHelpFormatter,
+            argparse.ArgumentDefaultsHelpFormatter,
         ):
             pass
 
@@ -217,9 +218,7 @@ def setup(
     description, _, epilog = (
         (function.__doc__ or module.__doc__ or "").strip().partition("\n")
     )
-    # markdown
-    # epilog = text.md(f"# {description}\n{epilog}")
-    epilog = text.md(f"{description}\n{epilog}")
+    epilog = f"{description}\n{'-'*len(description)}\n{epilog}"
     description = ""
 
     kwargs = {}

src/luxos/scripts/luxos_run.py

@@ -1,32 +1,34 @@
 """Script to issue commands to miner(s)
 
-This tool is designed to issue a simple command (with parameters) to a set of miners
-defined on the command line (--range/--range_start/--range-end) or in a file (yaml/csv).
-
-It loads a `script` file and execute across all the defined miners.
+This tool is designed to run commands to a set of miners defined on the command
+line using the --range flag (either an ip address or a file prefixed with @.
 
 Eg.
-```shell
 
-# my-script.py
-from luxos import asyncops
-async def main(host: str, port: int):
-    res = await asyncops.rexec(host, port, "version")
-    return asyncops.validate(host, port, res, "VERSION")[0]
+    # my-script.py
+    from luxos import asyncops
+    async def main(host: str, port: int):
+        res = await asyncops.rexec(host, port, "version")
+        return asyncops.validate(res, "VERSION", 1, 1)
 
-# in the cli
-$> luxos-run --range 127.0.0.1 my-script.py --json
-```
+    # in the cli
+    $> luxos-run --range 127.0.0.1 --json my-script.py
 
+NOTE:
+  1. you can use multiple --range flags
+  2. you can pass to --range flag a file (csv or yaml) using --range @file.csv
+  3. ranges can specify a ip-start:ip-end
 """
 
 from __future__ import annotations
 
 import argparse
 import asyncio
+import inspect
 import json
 import logging
 import pickle
+import sys
 from pathlib import Path
 
 from luxos import misc, text, utils
@@ -48,14 +50,14 @@ def add_arguments(parser: cli.LuxosParserBase) -> None:
         default="main",
     )
     parser.add_argument(
-        "-t", "--tear-donw", dest="teardown", help="script tear down function"
+        "-t", "--teardown", dest="teardown", help="script tear down function"
     )
     parser.add_argument("-n", "--batch", type=int, help="limit parallel executions")
     parser.add_argument(
         "--list", action="store_true", help="just display the machine to run script"
     )
 
-    group = parser.add_mutually_exclusive_group(required=True)
+    group = parser.add_mutually_exclusive_group()
     group.add_argument("--json", action="store_true", help="json output")
     group.add_argument("--pickle", type=Path, help="pickle output")
 
@@ -73,6 +75,11 @@ async def main(args: argparse.Namespace):
         for address in args.addresses:
             print(address)
         return
+
+    # prepend the script dir to pypath
+    log.debug("inserting %s in PYTHONPATH", args.script.parent)
+    sys.path.insert(0, str(args.script.parent))
+
     module = misc.loadmod(args.script)
 
     entrypoint = getattr(module, args.entrypoint, None)
@@ -81,10 +88,14 @@ async def main(args: argparse.Namespace):
         return
 
     teardown = None
-    if args.teardown:
+    if args.teardown == "":
+        pass
+    elif args.teardown:
         if not hasattr(module, args.teardown):
             args.error(f"no tear down function {args.teardown} in {args.script}")
         teardown = getattr(module, args.teardown, None)
+    elif hasattr(module, "teardown"):
+        teardown = getattr(module, "teardown")
 
     result = {}
 
@@ -111,14 +122,18 @@ def callback(result):
         else:
             result[data.address] = data.data
 
+    if teardown:
+        if "result" in inspect.signature(teardown).parameters:
+            newresult = teardown(result)
+        else:
+            newresult = teardown()
+        result = newresult or result
+
     if args.json:
         print(json.dumps(result, indent=2))
     if args.pickle:
         args.pickle.write_bytes(pickle.dumps(result))
 
-    if teardown:
-        teardown()
-
 
 def run():
     asyncio.run(main())

src/luxos/syncops.py

@@ -216,7 +216,7 @@ def rexec(
     timeout: float | None = None,
     retry: int | None = None,
     retry_delay: float | None = None,
-) -> dict[str, Any] | None:
+) -> dict[str, Any]:
     parameters = parameters_to_list(parameters)
 
     timeout = TIMEOUT if timeout is None else timeout
@@ -287,6 +287,7 @@ def rexec(
         logoff(host, port, sid)
     if isinstance(failure, Exception):
         raise failure
+    return {}
 
 
 # !!! LEGACY CODE BELOW !!!

tests/requirements.txt

@@ -1,6 +1,7 @@
 asyncpg
 build
 httpx
+humanize
 lxml
 mypy
 myst-parser
@@ -20,6 +21,7 @@ sphinx-book-theme
 sphinx-markdown-parser
 sphinx-design
 tqdm
+types-python-dateutil
 types-pyyaml
 types-tqdm