wip: load schemas for settings and rule definition

samples/python/myplugin/main.py

@@ -1,6 +1,6 @@
 # Copyright (c) 2023 LogCraft, SAS.
 # SPDX-License-Identifier: MPL-2.0
-
+import os
 from typing import Optional
 
 # bindings generated by `componentize-py`
@@ -28,13 +28,35 @@ def load(self) -> Metadata:
         """
         return Metadata("my-plugin", "0.1.0", "LogCraft", "This is a famous plugin")
 
+    def _load_package_file(self, filename: str) -> str:
+        """
+        This is a helper function to load a file from the package directory.
+        This is used by the `settings` and `schema` functions.
+        """
+        filepath = os.path.join(os.path.dirname(__file__), 'package', filename)
+
+        with open(filepath, 'r') as f:
+            return f.read()
+
     # func() -> string;
     def settings(self) -> str:
-        return  "OK"
+        """
+        `lgc plugins settings my-plugin` will call this function to get the settings of the plugin.
+        """
+        try:
+            return self._load_package_file('settings.k')
+        except Exception as e:
+            raise Err(str(e))
 
     # func() -> string;
     def schema(self) -> str:
-        return  "OK"
+        """
+        `lgc plugins schema my-plugin` will call this function to get the schema of the plugin.
+        """
+        try:
+            return self._load_package_file('rule.k')
+        except Exception as e:
+            raise Err(str(e))
 
     # func(config: string, name: string, params: string) -> result<option<string>, string>;
     def create(self, config: str, name: str, params: str) -> Result[Optional[str], str]:
@@ -55,6 +77,8 @@ def delete(self, config: str, name: str, params: str) -> Optional[str]:
     # ping: func(config: string) -> result<bool, string>;
     def ping(self, config: str) -> int:
         """
+        `lgc services ping` will call this function to check if the service is up and running.
+
         This is a sample implementation of the `ping` function that sends a GET request
         to `https://google.fr` and returns the status code, or an error if the request
         fails.

samples/python/myplugin/package/rule.k

@@ -0,0 +1,75 @@
+# Copyright (c) 2023 LogCraft, SAS.
+# SPDX-License-Identifier: MPL-2.0
+
+schema Rule:
+  """Splunk Detection Rule
+
+  Attributes
+  ----------
+  app: str, required
+    Application name
+  """
+  app: str
+  savedsearch: SavedSearch
+
+schema SavedSearch:
+  """Splunk Saved Search
+  cron_schedule: str, optional
+    Valid values: cron string.
+  disabled: bool, optional
+    Indicates if the saved search is enabled. Defaults to false.
+  dispatch_buckets: int, optional
+    The maximum number of timeline buckets. Defaults to 0.
+  display_view: str, optional
+    Defines the default UI view name (not label) in which to load the results.
+  is_scheduled: bool, optional
+    Whether this search is to be run on a schedule.
+  is_visible: bool, optional
+    Specifies whether this saved search should be listed in the visible saved search list. Defaults to true.
+  max_concurrent: int, optional
+    The maximum number of concurrent instances of this search the scheduler is allowed to run. Defaults to 1.
+  realtime_schedule: bool, optional
+    Controls the way the scheduler computes the next execution time of a scheduled search.
+  request_ui_dispatch_app: str, optional
+    Specifies a field used by Splunk Web to denote the app this search should be dispatched in.
+  request_ui_dispatch_view: str, optional
+    Specifies a field used by Splunk Web to denote the view this search should be displayed in.
+  restart_on_searchpeer_add: bool, optional
+    Specifies whether to restart a real-time search managed by the scheduler when a search peer becomes available for this saved search. Defaults to true.
+  run_on_startup: bool, optional
+    Specifies whether to restart a real-time search managed by the scheduler when a search peer becomes available for this saved search. Defaults to true.
+  schedule_window: str, optional
+    Time window (in minutes) during which the search has lower priority. Defaults to 0.
+  schedule_priority: str, optional
+    Raises the scheduling priority of the named search.
+  search: str, optional
+    Required when creating a new search.
+  vsid: str, optional
+    Defines the viewstate id associated with the UI view listed in 'displayview'.
+  workload_pool: str, optional
+    Specifies the new workload pool where the existing running search will be placed.
+  action: any, optional
+    Enable or disable an alert action.
+  dispatch: any, optional
+    Wildcard argument that accepts any dispatch related argument.
+  """
+  cron_schedule?: str
+  description?: str
+  disabled?: bool
+  dispatch_buckets?: int
+  display_view?: str
+  is_scheduled?: bool
+  is_visible?: bool
+  max_concurrent?: int
+  realtime_schedule?: bool
+  request_ui_dispatch_app?: str
+  request_ui_dispatch_view?: str
+  restart_on_searchpeer_add?: bool
+  run_on_startup?: bool
+  schedule_window?: str
+  schedule_priority?: str
+  search?: str
+  vsid?: str
+  workload_pool?: str
+  action?: any
+  dispatch?: any

samples/python/myplugin/package/settings.k

@@ -0,0 +1,35 @@
+# Copyright (c) 2023 LogCraft, SAS.
+# SPDX-License-Identifier: MPL-2.0
+
+import regex
+
+schema Configuration:
+  """Splunk Configuration
+
+  Attributes
+  ----------
+  endpoint: str, required
+    Splunk URL
+  authorization_scheme: str, required
+    Authorization scheme
+  authorization: str, required
+    Authorization
+  timeout: int, optional
+    Timeout in seconds
+  """
+  # Mandatory Parameters
+
+  # Splunk URL
+  endpoint: str = 'https://splunk_endpoint:8089'
+  # Authorization scheme
+  authorization_scheme: AuthorizationScheme = "Bearer"
+  # Authorization
+  @info(sensitive="true")
+  authorization: str = "base64_encoded_token"
+  # Timeout
+  timeout?: int = 60
+
+  check:
+    regex.match(endpoint, "^https?://"), "Incorrect endpoint, must start with http:// or https://."
+
+type AuthorizationScheme = "Bearer" | "Basic"