meerschaum 2.3.0.dev1__py3-none-any.whl → 2.3.0rc1__py3-none-any.whl

meerschaum/config/_shell.py

@@ -78,7 +78,7 @@ default_shell_config = {
         },
         'executor'       : {
             'rich'       : {
-                'style'  : 'gold1',
+                'style'  : 'yellow',
             },
         },
         'username'       : {

meerschaum/config/_version.py

@@ -2,4 +2,4 @@
 Specify the Meerschaum release version.
 """
 
-__version__ = "2.3.0.dev1"
+__version__ = "2.3.0rc1"

meerschaum/config/static/__init__.py

@@ -43,7 +43,9 @@ STATIC_CONFIG: Dict[str, Any] = {
         'webterm_job_name': '_webterm',
         'default_timeout': 600,
         'jobs': {
-            'stdin_message': 'MRSM_STDIN'
+            'stdin_message': 'MRSM_STDIN',
+            'stop_message': 'MRSM_STOP',
+            'metadata_cache_seconds': 5,
         },
     },
     'sql': {
@@ -68,6 +70,9 @@ STATIC_CONFIG: Dict[str, Any] = {
         'noask': 'MRSM_NOASK',
         'id': 'MRSM_SERVER_ID',
         'daemon_id': 'MRSM_DAEMON_ID',
+        'systemd_log_path': 'MRSM_SYSTEMD_LOG_PATH',
+        'systemd_stdin_path': 'MRSM_SYSTEMD_STDIN_PATH',
+        'systemd_result_path': 'MRSM_SYSTEMD_RESULT_PATH',
         'uri_regex': r'MRSM_([a-zA-Z0-9]*)_(\d*[a-zA-Z][a-zA-Z0-9-_+]*$)',
         'prefix': 'MRSM_',
     },

meerschaum/connectors/Connector.py

@@ -21,11 +21,11 @@ class Connector(metaclass=abc.ABCMeta):
     The base connector class to hold connection attributes.
     """
     def __init__(
-            self,
-            type: Optional[str] = None,
-            label: Optional[str] = None,
-            **kw: Any
-        ):
+        self,
+        type: Optional[str] = None,
+        label: Optional[str] = None,
+        **kw: Any
+    ):
         """
         Set the given keyword arguments as attributes.
 
@@ -101,7 +101,7 @@ class Connector(metaclass=abc.ABCMeta):
 
         ### load user config into self._attributes
         if self.type in conn_configs and self.label in conn_configs[self.type]:
-            self._attributes.update(conn_configs[self.type][self.label])
+            self._attributes.update(conn_configs[self.type][self.label] or {})
 
         ### load system config into self._sys_config
         ### (deep copy so future Connectors don't inherit changes)
@@ -200,7 +200,13 @@ class Connector(metaclass=abc.ABCMeta):
         _type = self.__dict__.get('type', None)
         if _type is None:
             import re
-            _type = re.sub(r'connector$', '', self.__class__.__name__.lower())
+            is_executor = self.__class__.__name__.lower().endswith('executor')
+            suffix_regex = (
+                r'connector$'
+                if not is_executor
+                else r'executor$'
+            )
+            _type = re.sub(suffix_regex, '', self.__class__.__name__.lower())
             self.__dict__['type'] = _type
         return _type
 

meerschaum/connectors/__init__.py

@@ -36,9 +36,9 @@ __all__ = (
 ### store connectors partitioned by
 ### type, label for reuse
 connectors: Dict[str, Dict[str, Connector]] = {
-    'api'   : {},
-    'sql'   : {},
-    'plugin': {},
+    'api'    : {},
+    'sql'    : {},
+    'plugin' : {},
 }
 instance_types: List[str] = ['sql', 'api']
 _locks: Dict[str, RLock] = {
@@ -127,10 +127,13 @@ def get_connector(
     global _loaded_plugin_connectors
     if isinstance(type, str) and not label and ':' in type:
         type, label = type.split(':', maxsplit=1)
+
     with _locks['_loaded_plugin_connectors']:
         if not _loaded_plugin_connectors:
             load_plugin_connectors()
+            _load_builtin_custom_connectors()
             _loaded_plugin_connectors = True
+
     if type is None and label is None:
         default_instance_keys = get_config('meerschaum', 'instance', patch=True)
         ### recursive call to get_connector
@@ -274,7 +277,7 @@ def is_connected(keys: str, **kw) -> bool:
         return False
 
 
-def make_connector(cls):
+def make_connector(cls, _is_executor: bool = False):
     """
     Register a class as a `Connector`.
     The `type` will be the lower case of the class name, without the suffix `connector`.
@@ -300,7 +303,12 @@ def make_connector(cls):
     >>> 
     """
     import re
-    typ = re.sub(r'connector$', '', cls.__name__.lower())
+    suffix_regex = (
+        r'connector$'
+        if not _is_executor
+        else r'executor$'
+    )
+    typ = re.sub(suffix_regex, '', cls.__name__.lower())
     with _locks['types']:
         types[typ] = cls
     with _locks['custom_types']:
@@ -363,3 +371,11 @@ def get_connector_plugin(
     )
     plugin = mrsm.Plugin(plugin_name)
     return plugin if plugin.is_installed() else None
+
+
+def _load_builtin_custom_connectors():
+    """
+    Import custom connectors decorated with `@make_connector` or `@make_executor`.
+    """
+    import meerschaum.jobs._SystemdExecutor
+    #  import meerschaum.jobs._LocalExecutor

meerschaum/connectors/api/APIConnector.py

@@ -88,6 +88,9 @@ class APIConnector(Connector):
         monitor_logs,
         monitor_logs_async,
         get_job_is_blocking_on_stdin,
+        get_job_began,
+        get_job_ended,
+        get_job_status,
     )
 
     def __init__(

meerschaum/connectors/api/_jobs.py

@@ -7,17 +7,21 @@ Manage jobs via the Meerschaum API.
 """
 
 import asyncio
+import time
+import json
 from datetime import datetime
 
 import meerschaum as mrsm
 from meerschaum.utils.typing import Dict, Any, SuccessTuple, List, Union, Callable
-from meerschaum.utils.jobs import Job
+from meerschaum.jobs import Job
 from meerschaum.config.static import STATIC_CONFIG
-from meerschaum.utils.warnings import warn
+from meerschaum.utils.warnings import warn, dprint
 
 JOBS_ENDPOINT: str = STATIC_CONFIG['api']['endpoints']['jobs']
 LOGS_ENDPOINT: str = STATIC_CONFIG['api']['endpoints']['logs']
 JOBS_STDIN_MESSAGE: str = STATIC_CONFIG['api']['jobs']['stdin_message']
+JOBS_STOP_MESSAGE: str = STATIC_CONFIG['api']['jobs']['stop_message']
+JOB_METADATA_CACHE_SECONDS: int = STATIC_CONFIG['api']['jobs']['metadata_cache_seconds']
 
 
 def get_jobs(self, debug: bool = False) -> Dict[str, Job]:
@@ -59,6 +63,20 @@ def get_job_metadata(self, name: str, debug: bool = False) -> Dict[str, Any]:
     """
     Return the metadata for a single job.
     """
+    now = time.perf_counter()
+    _job_metadata_cache = self.__dict__.get('_job_metadata_cache', None)
+    _job_metadata_timestamp = (
+        _job_metadata_cache.get(name, {}).get('timestamp', None)
+    ) if _job_metadata_cache is not None else None
+
+    if (
+        _job_metadata_timestamp is not None
+        and (now - _job_metadata_timestamp) < JOB_METADATA_CACHE_SECONDS
+    ):
+        if debug:
+            dprint(f"Returning cached metadata for job '{name}'.")
+        return _job_metadata_cache[name]['metadata']
+
     response = self.get(JOBS_ENDPOINT + f"/{name}", debug=debug)
     if not response:
         if debug:
@@ -70,8 +88,15 @@ def get_job_metadata(self, name: str, debug: bool = False) -> Dict[str, Any]:
             warn(f"Failed to get metadata for job '{name}':\n{msg}")
         return {}
 
-    return response.json()
+    metadata = response.json()
+    if _job_metadata_cache is None:
+        self._job_metadata_cache = {}
 
+    self._job_metadata_cache[name] = {
+        'timestamp': now,
+        'metadata': metadata,
+    }
+    return metadata
 
 def get_job_properties(self, name: str, debug: bool = False) -> Dict[str, Any]:
     """
@@ -80,6 +105,34 @@ def get_job_properties(self, name: str, debug: bool = False) -> Dict[str, Any]:
     metadata = self.get_job_metadata(name, debug=debug)
     return metadata.get('daemon', {}).get('properties', {})
 
+def get_job_status(self, name: str, debug: bool = False) -> str:
+    """
+    Return the job's status.
+    """
+    metadata = self.get_job_metadata(name, debug=debug)
+    return metadata.get('status', 'stopped')
+
+def get_job_began(self, name: str, debug: bool = False) -> str:
+    """
+    Return a job's `began` timestamp, if it exists.
+    """
+    properties = self.get_job_properties(name, debug=debug)
+    began_str = properties.get('daemon', {}).get('began', None)
+    if began_str is None:
+        return None
+
+    return began_str
+
+def get_job_ended(self, name: str, debug: bool = False) -> str:
+    """
+    Return a job's `ended` timestamp, if it exists.
+    """
+    properties = self.get_job_properties(name, debug=debug)
+    ended_str = properties.get('daemon', {}).get('ended', None)
+    if ended_str is None:
+        return None
+
+    return ended_str
 
 def get_job_exists(self, name: str, debug: bool = False) -> bool:
     """
@@ -191,17 +244,55 @@ async def monitor_logs_async(
     name: str,
     callback_function: Callable[[Any], Any],
     input_callback_function: Callable[[], str],
+    stop_callback_function: Callable[[SuccessTuple], str],
+    stop_on_exit: bool = False,
+    strip_timestamps: bool = False,
     accept_input: bool = True,
     debug: bool = False,
 ):
     """
     Monitor a job's log files and await a callback with the changes.
     """
+    from meerschaum.jobs import StopMonitoringLogs
+    from meerschaum.utils.formatting._jobs import strip_timestamp_from_line
+
     websockets, websockets_exceptions = mrsm.attempt_import('websockets', 'websockets.exceptions')
     protocol = 'ws' if self.URI.startswith('http://') else 'wss'
     port = self.port if 'port' in self.__dict__ else ''
     uri = f"{protocol}://{self.host}:{port}{LOGS_ENDPOINT}/{name}/ws"
 
+    async def _stdin_callback(client):
+        if input_callback_function is None:
+            return
+
+        if asyncio.iscoroutinefunction(input_callback_function):
+            data = await input_callback_function()
+        else:
+            data = input_callback_function()
+
+        await client.send(data)
+
+    async def _stop_callback(client):
+        try:
+            result = tuple(json.loads(await client.recv()))
+        except Exception as e:
+            warn(traceback.format_exc())
+            result = False, str(e)
+
+        if stop_callback_function is not None:
+            if asyncio.iscoroutinefunction(stop_callback_function):
+                await stop_callback_function(result)
+            else:
+                stop_callback_function(result)
+
+        if stop_on_exit:
+            raise StopMonitoringLogs
+
+    message_callbacks = {
+        JOBS_STDIN_MESSAGE: _stdin_callback,
+        JOBS_STOP_MESSAGE: _stop_callback,
+    }
+
     async with websockets.connect(uri) as websocket:
         try:
             await websocket.send(self.token or 'no-login')
@@ -211,28 +302,31 @@ async def monitor_logs_async(
         while True:
             try:
                 response = await websocket.recv()
-                if response == JOBS_STDIN_MESSAGE:
-                    if asyncio.iscoroutinefunction(input_callback_function):
-                        data = await input_callback_function()
-                    else:
-                        data = input_callback_function()
-
-                    await websocket.send(data)
+                callback = message_callbacks.get(response, None)
+                if callback is not None:
+                    await callback(websocket)
                     continue
 
+                if strip_timestamps:
+                    response = strip_timestamp_from_line(response)
+
                 if asyncio.iscoroutinefunction(callback_function):
                     await callback_function(response)
                 else:
                     callback_function(response)
-            except KeyboardInterrupt:
+            except (KeyboardInterrupt, StopMonitoringLogs):
                 await websocket.close()
                 break
 
+
 def monitor_logs(
     self,
     name: str,
     callback_function: Callable[[Any], Any],
     input_callback_function: Callable[[None], str],
+    stop_callback_function: Callable[[None], str],
+    stop_on_exit: bool = False,
+    strip_timestamps: bool = False,
     accept_input: bool = True,
     debug: bool = False,
 ):
@@ -244,6 +338,9 @@ def monitor_logs(
             name,
             callback_function,
             input_callback_function=input_callback_function,
+            stop_callback_function=stop_callback_function,
+            stop_on_exit=stop_on_exit,
+            strip_timestamps=strip_timestamps,
             accept_input=accept_input,
             debug=debug
         )

meerschaum/connectors/parse.py

@@ -87,19 +87,17 @@ def parse_connector_keys(
 
 
 def parse_instance_keys(
-        keys: Optional[str],
-        construct: bool = True,
-        as_tuple: bool = False,
-        **kw
-    ):
+    keys: Optional[str],
+    construct: bool = True,
+    as_tuple: bool = False,
+    **kw
+):
     """
     Parse the Meerschaum instance value into a Connector object.
     """
     from meerschaum.utils.warnings import warn
     from meerschaum.config import get_config
 
-    ### TODO Check for valid types? Not sure how to do that if construct = False.
-
     if keys is None:
         keys = get_config('meerschaum', 'instance')
     keys = str(keys)
@@ -120,25 +118,24 @@ def parse_repo_keys(keys: Optional[str] = None, **kw):
 
 
 def parse_executor_keys(keys: Optional[str] = None, **kw):
-    """Parse the executor keys into an APIConnector or None."""
+    """Parse the executor keys into an APIConnector or string."""
+    from meerschaum.jobs import get_executor_keys_from_context
     from meerschaum.config import get_config
     if keys is None:
-        keys = get_config('meerschaum', 'default_executor')
+        keys = get_executor_keys_from_context()
 
     if keys is None or keys == 'local':
         return 'local'
 
     keys = str(keys)
-    if ':' not in keys:
-        keys = 'api:' + keys
-
     return parse_connector_keys(keys, **kw)
 
 
 def is_valid_connector_keys(
     keys: str
 ) -> bool:
-    """Verify a connector_keys string references a valid connector.
+    """
+    Verify a connector_keys string references a valid connector.
     """
     try:
         success = parse_connector_keys(keys, construct=False) is not None

meerschaum/core/Pipe/_bootstrap.py

@@ -88,21 +88,29 @@ def bootstrap(
 
     try:
         if yes_no(
-            f"Would you like to edit the definition for {self}?", yes=yes, noask=noask
+            f"Would you like to edit the definition for {self}?",
+            yes=yes,
+            noask=noask,
+            default='n',
         ):
             edit_tuple = self.edit_definition(debug=debug)
             if not edit_tuple[0]:
                 return edit_tuple
 
-        if yes_no(f"Would you like to try syncing {self} now?", yes=yes, noask=noask):
+        if yes_no(
+            f"Would you like to try syncing {self} now?",
+            yes=yes,
+            noask=noask,
+            default='n',
+        ):
             sync_tuple = actions['sync'](
                 ['pipes'],
-                connector_keys = [self.connector_keys],
-                metric_keys = [self.metric_key],
-                location_keys = [self.location_key],
-                mrsm_instance = str(self.instance_connector),
-                debug = debug,
-                shell = shell,
+                connector_keys=[self.connector_keys],
+                metric_keys=[self.metric_key],
+                location_keys=[self.location_key],
+                mrsm_instance=str(self.instance_connector),
+                debug=debug,
+                shell=shell,
             )
             if not sync_tuple[0]:
                 return sync_tuple

meerschaum/jobs/_Executor.py

@@ -0,0 +1,69 @@
+#! /usr/bin/env python3
+# vim:fenc=utf-8
+
+"""
+Define the base class for a Job executor.
+"""
+
+from __future__ import annotations
+
+from abc import abstractmethod
+
+from meerschaum.connectors import Connector
+from meerschaum.utils.typing import List, Dict, SuccessTuple, TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from meerschaum.jobs import Job
+
+class Executor(Connector):
+    """
+    Define the methods for managing jobs.
+    """
+
+    @abstractmethod
+    def get_job_exists(self, name: str, debug: bool = False) -> bool:
+        """
+        Return whether a job exists.
+        """
+    
+    @abstractmethod
+    def get_jobs(self) -> Dict[str, Job]:
+        """
+        Return a dictionary of names -> Jobs.
+        """
+
+    @abstractmethod
+    def create_job(self, name: str, sysargs: List[str], debug: bool = False) -> SuccessTuple:
+        """
+        Create a new job.
+        """
+
+    @abstractmethod
+    def start_job(self, name: str, debug: bool = False) -> SuccessTuple:
+        """
+        Start a job.
+        """
+
+    @abstractmethod
+    def stop_job(self, name: str, debug: bool = False) -> SuccessTuple:
+        """
+        Stop a job.
+        """
+
+    @abstractmethod
+    def pause_job(self, name: str, debug: bool = False) -> SuccessTuple:
+        """
+        Pause a job.
+        """
+
+    @abstractmethod
+    def delete_job(self, name: str, debug: bool = False) -> SuccessTuple:
+        """
+        Delete a job.
+        """
+
+    @abstractmethod
+    def get_logs(self, name: str, debug: bool = False) -> str:
+        """
+        Return a job's log output.
+        """