Plugin Configs (#32)

PluginVersion.configTemplate, PluginInstance.config, and tests of configurable plugins.

Author: dkolas

src/steamship/data/plugin_instance.py

@@ -1,4 +1,5 @@
 from dataclasses import dataclass
+from typing import Dict
 
 from steamship.base import Client, Request
 from steamship.base.response import Response
@@ -18,6 +19,7 @@ class CreatePluginInstanceRequest(Request):
     name: str = None
     handle: str = None
     upsert: bool = None
+    config: Dict[str, any] = None
 
 
 @dataclass
@@ -34,6 +36,7 @@ class PluginInstance:
     pluginId: str = None
     pluginVersionId: str = None
     userId: str = None
+    config: Dict[str, any] = None
     spaceId: str = None
 
     @staticmethod
@@ -48,6 +51,7 @@ def from_dict(d: any, client: Client = None) -> "PluginInstance":
             handle=d.get('handle', None),
             pluginId=d.get('pluginId', None),
             pluginVersionId=d.get('pluginVersionId', None),
+            config=d.get('config', None),
             userId=d.get('userId', None)
         )
 
@@ -60,7 +64,8 @@ def create(
             pluginVersionHandle: str = None,
             name: str = None,
             handle: str = None,
-            upsert: bool = None
+            upsert: bool = None,
+            config: Dict[str, any] = None
     ) -> Response[PluginInstance]:
         req = CreatePluginInstanceRequest(
             name=name,
@@ -69,7 +74,8 @@ def create(
             pluginHandle=pluginHandle,
             pluginVersionId=pluginVersionId,
             pluginVersionHandle=pluginVersionHandle,
-            upsert=upsert
+            upsert=upsert,
+            config=config
         )
 
         return client.post(

src/steamship/data/plugin_version.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import List
+from typing import List, Dict
 
 from steamship.base import Client, Request
 from steamship.base.response import Response
@@ -16,6 +16,7 @@ class CreatePluginVersionRequest(Request):
     handle: str = None
     upsert: bool = None
     type: str = 'file'
+    configTemplate: Dict[str, any] = None
 
 
 @dataclass
@@ -53,6 +54,7 @@ class PluginVersion:
     pluginId: str = None
     name: str = None
     handle: str = None
+    configTemplate: Dict[str, any] = None
 
     @staticmethod
     def from_dict(d: any, client: Client = None) -> "PluginVersion":
@@ -63,7 +65,8 @@ def from_dict(d: any, client: Client = None) -> "PluginVersion":
             client=client,
             id=d.get('id', None),
             name=d.get('name', None),
-            handle=d.get('handle', None)
+            handle=d.get('handle', None),
+            configTemplate=d.get('configTemplate', None)
         )
 
     @staticmethod
@@ -74,7 +77,8 @@ def create(
             name: str = None,
             filename: str = None,
             filebytes: bytes = None,
-            upsert: bool = None
+            upsert: bool = None,
+            configTemplate: Dict[str, any] = None
     ) -> Response[PluginVersion]:
 
         if filename is None and filebytes is None:
@@ -90,7 +94,8 @@ def create(
             name=name,
             handle=handle,
             pluginId=pluginId,
-            upsert=upsert
+            upsert=upsert,
+            configTemplate=configTemplate
         )
 
         return client.post(

tests/client/helpers.py

@@ -168,7 +168,7 @@ def deploy_app(py_name: str, versionConfigTemplate : Dict[str, any] = None, inst
 
 
 @contextlib.contextmanager
-def deploy_plugin(py_name: str, plugin_type: str):
+def deploy_plugin(py_name: str, plugin_type: str, versionConfigTemplate : Dict[str, any] = None, instanceConfig : Dict[str, any] = None):
     client = _steamship()
     name = _random_name()
     plugin = Plugin.create(client, name=name, description='test', type=plugin_type, transport="jsonOverHttp",
@@ -182,7 +182,8 @@ def deploy_plugin(py_name: str, plugin_type: str):
         client,
         "test-version",
         pluginId=plugin.id,
-        filebytes=zip_bytes
+        filebytes=zip_bytes,
+        configTemplate=versionConfigTemplate
     )
     # TODO: This is due to having to wait for the lambda to finish deploying.
     # TODO: We should update the task system to allow its .wait() to depend on this.
@@ -196,6 +197,7 @@ def deploy_plugin(py_name: str, plugin_type: str):
         client,
         pluginId=plugin.id,
         pluginVersionId=version.id,
+        config=instanceConfig
     )
     instance.wait()
     assert (instance.error is None)

tests/demo_apps/plugin_configurable_tagger.py

@@ -0,0 +1,39 @@
+import json
+
+from steamship import Block, DocTag, Tag
+from steamship.app import App, post, create_handler
+from steamship.plugin.tagger import Tagger
+from steamship.plugin.service import PluginResponse, PluginRequest
+from steamship.plugin.inputs.block_and_tag_plugin_input import BlockAndTagPluginInput
+from steamship.plugin.outputs.block_and_tag_plugin_output import BlockAndTagPluginOutput
+import re
+
+
+
+class TestParserPlugin(Tagger, App):
+    # For testing; mirrors TestConfigurableTagger in Swift
+
+    def run(self, request: PluginRequest[BlockAndTagPluginInput]) -> PluginResponse[BlockAndTagPluginOutput]:
+        tagKind = self.config['tagKind']
+        tagName = self.config['tagName']
+        tagValue = json.dumps({'numberValue':self.config['numberValue'], 'booleanValue':self.config['booleanValue']})
+
+        if request.data is not None:
+            file = request.data.file
+            tag = Tag.CreateRequest(kind=tagKind, name= tagName, value=tagValue)
+            if file.tags:
+                file.tags.append(tag)
+            else:
+                file.tags = [tag]
+            return PluginResponse(
+                data=BlockAndTagPluginOutput(file)
+            )
+
+    @post('tag')
+    def parse(self, **kwargs) -> dict:
+        parseRequest = Tagger.parse_request(request=kwargs)
+        parseResponse = self.run(parseRequest)
+        return Tagger.response_to_dict(parseResponse)
+
+
+handler = create_handler(TestParserPlugin)

tests/plugin/test_e2e_configurable_tagger.py

@@ -0,0 +1,77 @@
+import json
+
+from steamship import PluginInstance
+from ..client.helpers import deploy_plugin, _steamship
+from tests.client.operations.test_tag_file import parse_file
+
+__copyright__ = "Steamship"
+__license__ = "MIT"
+
+
+def test_e2e_parser():
+    client = _steamship()
+
+    configTemplate = {"tagKind": {"type":"string"},
+                    "tagName": {"type":"string"},
+                    "numberValue": {"type":"number"},
+                    "booleanValue": {"type":"boolean"}}
+    instanceConfig1 = {"tagKind": "testTagKind",
+                         "tagName": "testTagName",
+                        "numberValue": 3,
+                        "booleanValue": True}
+
+    with deploy_plugin("plugin_configurable_tagger.py", "tagger", versionConfigTemplate=configTemplate, instanceConfig=instanceConfig1) as (plugin, version, instance):
+        test_doc = "Hi there"
+        res = client.tag(doc=test_doc, pluginInstance=instance.handle)
+        res.wait()
+        assert (res.error is None)
+        assert (res.data is not None)
+        assert (len(res.data.file.blocks) == 1)
+        assert (res.data.file.blocks[0].text == test_doc)
+
+        #Validate configured content
+        assert (len(res.data.file.tags) == 1)
+        tag = res.data.file.tags[0]
+        assert (tag.name == instanceConfig1['tagName'])
+        assert (tag.kind == instanceConfig1['tagKind'])
+        tagValue = json.loads(tag.value)
+        assert (tagValue['numberValue'] == instanceConfig1['numberValue'])
+        assert (tagValue['booleanValue'] == instanceConfig1['booleanValue'])
+
+        instanceConfig2 = {"tagKind": "testTagKind2",
+                           "tagName": "testTagName2",
+                           "numberValue": 4,
+                           "booleanValue": False}
+
+        instance2 = PluginInstance.create(
+            client,
+            pluginId=plugin.id,
+            pluginVersionId=version.id,
+            config=instanceConfig2
+        )
+        instance2.wait()
+        assert (instance2.error is None)
+        assert (instance2.data is not None)
+        instance2 = instance2.data
+
+        res = client.tag(doc=test_doc, pluginInstance=instance2.handle)
+        res.wait()
+        assert (res.error is None)
+        assert (res.data is not None)
+        assert (len(res.data.file.blocks) == 1)
+        assert (res.data.file.blocks[0].text == test_doc)
+
+        # Validate configured content
+        assert (len(res.data.file.tags) == 1)
+        tag = res.data.file.tags[0]
+        assert (tag.name == instanceConfig2['tagName'])
+        assert (tag.kind == instanceConfig2['tagKind'])
+        tagValue = json.loads(tag.value)
+        assert (tagValue['numberValue'] == instanceConfig2['numberValue'])
+        assert (tagValue['booleanValue'] == instanceConfig2['booleanValue'])
+
+
+
+
+
+