standardised event construction and validation a bit more

core/correctness/validation.py

@@ -12,7 +12,8 @@ from typing import Any, _SpecialForm, Union, Tuple, get_origin, get_args
 
 from core.correctness.vars import VALID_PATH_CHARS, get_not_imp_msg, \
     EVENT_TYPE, EVENT_PATH, JOB_EVENT, JOB_TYPE, JOB_ID, JOB_PATTERN, \
-    JOB_RECIPE, JOB_RULE, JOB_STATUS, JOB_CREATE_TIME, EVENT_RULE
+    JOB_RECIPE, JOB_RULE, JOB_STATUS, JOB_CREATE_TIME, EVENT_RULE, \
+    WATCHDOG_BASE
 
 # Required keys in event dict
 EVENT_KEYS = {
@@ -23,6 +24,11 @@ EVENT_KEYS = {
     EVENT_RULE: Any
 }
 
+WATCHDOG_EVENT_KEYS = {
+    WATCHDOG_BASE: str,
+    **EVENT_KEYS
+}
+
 # Required keys in job dict
 JOB_KEYS = {
     JOB_TYPE: str,
@@ -254,3 +260,6 @@ def valid_event(event:dict[str,Any])->None:
 def valid_job(job:dict[str,Any])->None:
     """Check that a given dict expresses a meow job."""
     valid_meow_dict(job, "Job", JOB_KEYS)
+
+def valid_watchdog_event(event:dict[str,Any])->None:
+    valid_meow_dict(event, "Watchdog event", WATCHDOG_EVENT_KEYS)

core/functionality.py

@@ -20,7 +20,8 @@ from core.correctness.vars import CHAR_LOWERCASE, CHAR_UPPERCASE, \
     VALID_CHANNELS, HASH_BUFFER_SIZE, SHA256, DEBUG_WARNING, DEBUG_INFO, \
     EVENT_TYPE, EVENT_PATH, JOB_EVENT, JOB_TYPE, JOB_ID, JOB_PATTERN, \
     JOB_RECIPE, JOB_RULE, EVENT_RULE, JOB_STATUS, STATUS_QUEUED, \
-    JOB_CREATE_TIME, JOB_REQUIREMENTS
+    JOB_CREATE_TIME, JOB_REQUIREMENTS, WATCHDOG_BASE, WATCHDOG_HASH, \
+    EVENT_TYPE_WATCHDOG, JOB_TYPE_PYTHON
 
 # mig trigger keyword replacements
 KEYWORD_PATH = "{PATH}"
@@ -283,16 +284,45 @@ def replace_keywords(old_dict:dict[str,str], job_id:str, src_path:str,
 
         return new_dict
 
-def create_event(event_type:str, path:str, rule:Any, source:dict[Any,Any]={}
+def create_event(event_type:str, path:str, rule:Any, extras:dict[Any,Any]={}
         )->dict[Any,Any]:
     return {
-        **source, 
+        **extras, 
         EVENT_PATH: path, 
         EVENT_TYPE: event_type, 
         EVENT_RULE: rule
     }
 
-def create_job(job_type:str, event:dict[str,Any], source:dict[Any,Any]={}
+def create_watchdog_event(path:str, rule:Any, base:str, hash:str, 
+            extras:dict[Any,Any]={})->dict[Any,Any]:
+    return create_event(
+        EVENT_TYPE_WATCHDOG, 
+        path, 
+        rule,
+        extras={
+            **extras,
+            **{
+                WATCHDOG_HASH: hash,
+                WATCHDOG_BASE: base
+            }
+        }
+    )
+
+def create_fake_watchdog_event(path:str, rule:Any, base:str, 
+            extras:dict[Any,Any]={})->dict[Any,Any]:
+    return create_event(
+        EVENT_TYPE_WATCHDOG, 
+        path, 
+        rule,
+        extras={
+            **extras,
+            **{
+                WATCHDOG_BASE: base
+            }
+        }
+    )
+
+def create_job(job_type:str, event:dict[str,Any], extras:dict[Any,Any]={}
         )->dict[Any,Any]:
     job_dict = {
         #TODO compress event?
@@ -307,4 +337,4 @@ def create_job(job_type:str, event:dict[str,Any], source:dict[Any,Any]={}
         JOB_REQUIREMENTS: event[EVENT_RULE].recipe.requirements
     }
 
-    return {**source, **job_dict}
+    return {**extras, **job_dict}

core/meow.py

@@ -11,7 +11,7 @@ import inspect
 import sys
 
 from copy import deepcopy
-from typing import Any, Union
+from typing import Any, Union, Tuple
 
 from core.correctness.vars import VALID_RECIPE_NAME_CHARS, \
     VALID_PATTERN_NAME_CHARS, VALID_RULE_NAME_CHARS, VALID_CHANNELS, \
@@ -323,8 +323,7 @@ class BaseHandler:
             raise TypeError(msg)
         return object.__new__(cls)
 
-    # TODO also implement something like me from conductor
-    def valid_handle_criteria(self, event:dict[str,Any])->bool:
+    def valid_handle_criteria(self, event:dict[str,Any])->Tuple[bool,str]:
         """Function to determine given an event defintion, if this handler can 
         process it or not. Must be implemented by any child process."""
         pass
@@ -350,7 +349,7 @@ class BaseConductor:
             raise TypeError(msg)
         return object.__new__(cls)
 
-    def valid_execute_criteria(self, job:dict[str,Any])->bool:
+    def valid_execute_criteria(self, job:dict[str,Any])->Tuple[bool,str]:
         """Function to determine given an job defintion, if this conductor can 
         process it or not. Must be implemented by any child process."""
         pass

core/runner.py

@@ -10,13 +10,12 @@ import os
 import sys
 import threading
 
-from inspect import signature
 from multiprocessing import Pipe
 from random import randrange
 from typing import Any, Union
 
 from core.correctness.vars import DEBUG_WARNING, DEBUG_INFO, EVENT_TYPE, \
-    VALID_CHANNELS, JOB_TYPE, JOB_ID, META_FILE
+    VALID_CHANNELS, JOB_ID, META_FILE
 from core.correctness.validation import setup_debugging, check_type, \
     valid_list
 from core.functionality import  print_debug, wait, read_yaml
@@ -104,7 +103,7 @@ class MeowRunner:
                         valid_handlers = []
                         for handler in self.handlers:
                             try:
-                                valid = handler.valid_handle_criteria(event)
+                                valid, _ = handler.valid_handle_criteria(event)
                                 if valid:
                                     valid_handlers.append(handler)
                             except Exception as e:
@@ -155,7 +154,8 @@ class MeowRunner:
                         valid_conductors = []
                         for conductor in self.conductors:
                             try:
-                                valid = conductor.valid_execute_criteria(job)
+                                valid, _ = \
+                                    conductor.valid_execute_criteria(job)
                                 if valid:
                                     valid_conductors.append(conductor)
                             except Exception as e: