omnata-plugin-runtime 0.2.88__py3-none-any.whl → 0.2.91__py3-none-any.whl

omnata_plugin_runtime/configuration.py

@@ -8,7 +8,7 @@ from typing import Any, List, Dict, Literal, Union, Optional
 from enum import Enum
 
 from abc import ABC
-from pydantic import BaseModel, Field  # pylint: disable=no-name-in-module
+from pydantic import BaseModel, Field, validator  # pylint: disable=no-name-in-module
 
 if tuple(sys.version_info[:2]) >= (3, 9):
     # Python 3.9 and above
@@ -530,6 +530,24 @@ class ConnectionConfigurationParameters(SubscriptableBaseModel):
     class Config:
         underscore_attrs_are_private = True
 
+    @validator("ngrok_tunnel_settings", always=True)
+    def validate_ngrok_tunnel_settings(cls, v: str, values: dict[str, Any]) -> Optional[NgrokTunnelSettings]:
+        """
+        A validator which picks out the ngrok tunnel configuration from the secrets and provides it as a typed object.
+        """
+        if "connection_secrets" in values:
+            connection_secrets:Dict[str, StoredConfigurationValue] = values["connection_secrets"]
+            if "ngrok_client_certificate" in connection_secrets and \
+                "ngrok_client_key" in connection_secrets and \
+                "ngrok_endpoint_host" in connection_secrets and \
+                "ngrok_endpoint_port" in connection_secrets:
+                return NgrokTunnelSettings(
+                    endpoint_host=connection_secrets["ngrok_endpoint_host"].value,
+                    endpoint_port=connection_secrets["ngrok_endpoint_port"].value,
+                    client_certificate=connection_secrets["ngrok_client_certificate"].value,
+                    client_key=connection_secrets["ngrok_client_key"].value
+                )
+        return None
 
     def get_connection_parameter(self, parameter_name: str) -> StoredConfigurationValue:
         """

omnata_plugin_runtime/forms.py

@@ -467,6 +467,9 @@ class NGrokMTLSTunnel(SubscriptableBaseModel):
     post_tunnel_fields_function: Union[
         Callable[[ConnectionConfigurationParameters], List[FormInputField]], str
     ]
+    @validator("post_tunnel_fields_function", always=True)
+    def function_name_convertor(cls, v) -> str:
+        return v.__name__ if isinstance(v, MethodType) else v
 
 class ConnectionMethod(SubscriptableBaseModel):
     """

omnata_plugin_runtime/plugin_entrypoints.py

@@ -21,7 +21,7 @@ from .configuration import (
     StoredConfigurationValue,
     StoredMappingValue,
 )
-from .forms import ConnectionMethod, FormOption
+from .forms import ConnectionMethod, FormInputField, FormOption
 from .logging import OmnataPluginLogHandler
 from .omnata_plugin import (
     SnowflakeBillingEvent,
@@ -403,6 +403,38 @@ class PluginEntrypoint:
                 logger.error(f"Error parsing secrets content for secret {other_secrets_name}: {str(exception)}")
                 raise ValueError("Error parsing secrets content:") from exception
         return connection_secrets
+    
+    def ngrok_post_tunnel_fields(
+        self,
+        connection_method: str,
+        connection_parameters: Dict,
+        oauth_secret_name: Optional[str],
+        other_secrets_name: Optional[str],
+        function_name: str,
+    ) -> List[FormInputField]:
+        logger.info("Entered ngrok_post_tunnel_fields method")
+        oauth_secret_name = normalise_nulls(oauth_secret_name)
+        other_secrets_name = normalise_nulls(other_secrets_name)
+        connection_secrets = self.get_secrets(oauth_secret_name, other_secrets_name)
+        connection_parameters = parse_obj_as(
+            Dict[str, StoredConfigurationValue], connection_parameters
+        )
+        parameters = ConnectionConfigurationParameters(
+            connection_method=connection_method,
+            connection_parameters=connection_parameters,
+            connection_secrets=connection_secrets
+        )
+        the_function = getattr(
+            self._plugin_instance,
+            function_name,
+        )
+        script_result = the_function(parameters)
+        if isinstance(script_result, List):
+            if len(script_result) > 0 and isinstance(script_result[0], BaseModel):
+                script_result = [r.dict() for r in script_result]
+        else:
+            raise ValueError(f"Expected a List from function {function_name}, got {type(script_result)}")
+        return script_result
 
     def network_addresses(self, method: str, connection_parameters: Dict) -> List[str]:
         logger.info("Entered network_addresses method")

{omnata_plugin_runtime-0.2.88.dist-info → omnata_plugin_runtime-0.2.91.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: omnata-plugin-runtime
-Version: 0.2.88
+Version: 0.2.91
 Summary: Classes and common runtime components for building and running Omnata Plugins
 Author: James Weakley
 Author-email: james.weakley@omnata.com

omnata_plugin_runtime-0.2.91.dist-info/RECORD

@@ -0,0 +1,12 @@
+omnata_plugin_runtime/__init__.py,sha256=w63LVME5nY-hQ4BBzfacy9kvTunwqHGs8iiSPGAX2ns,1214
+omnata_plugin_runtime/api.py,sha256=m8Yqw_lwSjN55ktN2AEgVSL1RYSbGWEvkE-M-GOEXdQ,6149
+omnata_plugin_runtime/configuration.py,sha256=oNOGhZjtPihIad631FgOju7UzyT4ZZTYAM2-7fjhZqI,34186
+omnata_plugin_runtime/forms.py,sha256=uxfYrsVPSDLxfc9SqzjhxkHCTqfBzAl1CM8y-5YRKP0,18372
+omnata_plugin_runtime/logging.py,sha256=bn7eKoNWvtuyTk7RTwBS9UARMtqkiICtgMtzq3KA2V0,3272
+omnata_plugin_runtime/omnata_plugin.py,sha256=vFHakGKCmqCLWMp7nn5Q1lL1Pst1KV4_YWUdz_LyYME,86770
+omnata_plugin_runtime/plugin_entrypoints.py,sha256=4ASzSL7mRWJ9uSqV31Zy8Oka5OIJI7JowzCX-boJkQc,25811
+omnata_plugin_runtime/rate_limiting.py,sha256=se6MftQI5NrVHaLb1hByPCgAESPQhkAgIG7KIU1clDU,16562
+omnata_plugin_runtime-0.2.91.dist-info/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
+omnata_plugin_runtime-0.2.91.dist-info/METADATA,sha256=nvDiuEJRSp6XcCL5562-jYu0FReD1Kk7_nL6c8OdB4A,1086
+omnata_plugin_runtime-0.2.91.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+omnata_plugin_runtime-0.2.91.dist-info/RECORD,,

omnata_plugin_runtime-0.2.88.dist-info/RECORD

@@ -1,12 +0,0 @@
-omnata_plugin_runtime/__init__.py,sha256=w63LVME5nY-hQ4BBzfacy9kvTunwqHGs8iiSPGAX2ns,1214
-omnata_plugin_runtime/api.py,sha256=m8Yqw_lwSjN55ktN2AEgVSL1RYSbGWEvkE-M-GOEXdQ,6149
-omnata_plugin_runtime/configuration.py,sha256=2GbAfM0RCtYNYaKJwNouq0cNZm-cuoAMU_5RbQ6TAFE,33051
-omnata_plugin_runtime/forms.py,sha256=oGZxDR93clcWKV8MtnLFGPc0DNwEox_2L3ZQUdiWWW4,18203
-omnata_plugin_runtime/logging.py,sha256=bn7eKoNWvtuyTk7RTwBS9UARMtqkiICtgMtzq3KA2V0,3272
-omnata_plugin_runtime/omnata_plugin.py,sha256=vFHakGKCmqCLWMp7nn5Q1lL1Pst1KV4_YWUdz_LyYME,86770
-omnata_plugin_runtime/plugin_entrypoints.py,sha256=cyWrgPOmjZEP3InT3MvcaRuYn9Bx_FNqexKe2vqEYlo,24409
-omnata_plugin_runtime/rate_limiting.py,sha256=se6MftQI5NrVHaLb1hByPCgAESPQhkAgIG7KIU1clDU,16562
-omnata_plugin_runtime-0.2.88.dist-info/LICENSE,sha256=IMF9i4xIpgCADf0U-V1cuf9HBmqWQd3qtI3FSuyW4zE,26526
-omnata_plugin_runtime-0.2.88.dist-info/METADATA,sha256=UcViqYrldowRAM3H_fQ297h-zFTjyWTUpuE8RAJoiKw,1086
-omnata_plugin_runtime-0.2.88.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-omnata_plugin_runtime-0.2.88.dist-info/RECORD,,