PyPI - canvas - Versions diffs - 0.14.0__py3-none-any.whl → 0.16.0__py3-none-any.whl - Mend

canvas 0.14.0py3-none-any.whl → 0.16.0py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of canvas might be problematic. Click here for more details.

Files changed (88) hide show

plugin_runner/tests/fixtures/plugins/test_render_template/protocols/my_protocol.py ADDED Viewed

@@ -0,0 +1,43 @@
+from canvas_sdk.effects import Effect, EffectType
+from canvas_sdk.events import EventType
+from canvas_sdk.protocols import BaseProtocol
+from canvas_sdk.templates import render_to_string
+class ValidTemplate(BaseProtocol):
+    """You should put a helpful description of this protocol's behavior here."""
+    RESPONDS_TO = [EventType.Name(EventType.UNKNOWN)]
+    def compute(self) -> list[Effect]:
+        """This method gets called when an event of the type RESPONDS_TO is fired."""
+        return [
+            Effect(type=EffectType.LOG, payload=render_to_string("templates/template.html", None))
+        ]
+class InvalidTemplate(BaseProtocol):
+    """You should put a helpful description of this protocol's behavior here."""
+    RESPONDS_TO = [EventType.Name(EventType.UNKNOWN)]
+    def compute(self) -> list[Effect]:
+        """This method gets called when an event of the type RESPONDS_TO is fired."""
+        return [
+            Effect(type=EffectType.LOG, payload=render_to_string("templates/template1.html", None))
+        ]
+class ForbiddenTemplate(BaseProtocol):
+    """You should put a helpful description of this protocol's behavior here."""
+    RESPONDS_TO = [EventType.Name(EventType.UNKNOWN)]
+    def compute(self) -> list[Effect]:
+        """This method gets called when an event of the type RESPONDS_TO is fired."""
+        return [
+            Effect(
+                type=EffectType.LOG,
+                payload=render_to_string("../../templates/template.html", None),
+            )
+        ]

plugin_runner/tests/fixtures/plugins/test_render_template/templates/template.html ADDED Viewed

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Title</title>
+  </head>
+  <body>
+  </body>
+</html>

plugin_runner/tests/test_application.py CHANGED Viewed

@@ -6,7 +6,7 @@ from canvas_sdk.events import Event, EventRequest, EventType
 from canvas_sdk.handlers.application import Application
-class TestApplication(Application):
+class ExampleApplication(Application):
     """A concrete implementation of the Application class for testing."""
     def on_open(self) -> Effect:
@@ -15,9 +15,9 @@ class TestApplication(Application):
 @pytest.fixture
-def app_instance(event: Event) -> TestApplication:
+def app_instance(event: Event) -> ExampleApplication:
     """Provide an instance of the TestApplication with a mocked event."""
-    app = TestApplication(event)
+    app = ExampleApplication(event)
     return app
@@ -25,7 +25,7 @@ def test_compute_event_not_targeted() -> None:
     """Test that compute filters out events not targeted for the app."""
     request = EventRequest(type=EventType.APPLICATION__ON_OPEN, target="some_identifier")
     event = Event(request)
-    app = TestApplication(event)
+    app = ExampleApplication(event)
     result = app.compute()
@@ -36,10 +36,10 @@ def test_compute_event_targeted() -> None:
     """Test that compute processes events targeted for the app."""
     request = EventRequest(
         type=EventType.APPLICATION__ON_OPEN,
-        target=f"{TestApplication.__module__}:{TestApplication.__qualname__}",
+        target=f"{ExampleApplication.__module__}:{ExampleApplication.__qualname__}",
     )
     event = Event(request)
-    app = TestApplication(event)
+    app = ExampleApplication(event)
     result = app.compute()
     assert len(result) == 1, "Expected a single effect if the event target is the app identifier"
@@ -48,13 +48,13 @@ def test_compute_event_targeted() -> None:
 def test_identifier_property() -> None:
     """Test the identifier property of the Application class."""
-    expected_identifier = f"{TestApplication.__module__}:{TestApplication.__qualname__}"
+    expected_identifier = f"{ExampleApplication.__module__}:{ExampleApplication.__qualname__}"
     request = EventRequest(
         type=EventType.APPLICATION__ON_OPEN,
-        target=f"{TestApplication.__module__}:{TestApplication.__qualname__}",
+        target=f"{ExampleApplication.__module__}:{ExampleApplication.__qualname__}",
     )
     event = Event(request)
-    app = TestApplication(event)
+    app = ExampleApplication(event)
     assert app.identifier == expected_identifier, "The identifier property is incorrect"

plugin_runner/tests/test_plugin_installer.py CHANGED Viewed

@@ -83,8 +83,19 @@ def test_plugin_installation_from_tarball(mocker: MockerFixture) -> None:
     tarball_2 = _create_tarball("plugin2")
     mocker.patch("plugin_runner.plugin_installer.enabled_plugins", return_value=mock_plugins)
+    def mock_download_plugin(package: str) -> MagicMock:
+        mock_context = mocker.Mock()
+        if package == "plugins/plugin1.tar.gz":
+            mock_context.__enter__ = mocker.Mock(return_value=tarball_1)
+        elif package == "plugins/plugin2.tar":
+            mock_context.__enter__ = mocker.Mock(return_value=tarball_2)
+        mock_context.__exit__ = mocker.Mock(return_value=None)
+        return mock_context
     mocker.patch(
-        "plugin_runner.plugin_installer.download_plugin", side_effect=[tarball_1, tarball_2]
+        "plugin_runner.plugin_installer.download_plugin",
+        side_effect=mock_download_plugin,
     )
     install_plugins()

plugin_runner/tests/test_plugin_runner.py CHANGED Viewed

@@ -1,5 +1,5 @@
+import logging
 import shutil
-from collections.abc import Generator
 from pathlib import Path
 from unittest.mock import MagicMock, patch
@@ -7,50 +7,16 @@ import pytest
 from canvas_generated.messages.effects_pb2 import EffectType
 from canvas_generated.messages.plugins_pb2 import ReloadPluginsRequest
-from canvas_sdk.events import EventRequest, EventType
+from canvas_sdk.events import Event, EventRequest, EventType
 from plugin_runner.plugin_runner import (
     EVENT_HANDLER_MAP,
     LOADED_PLUGINS,
     PluginRunner,
+    load_or_reload_plugin,
     load_plugins,
-    sandbox_from_package,
 )
-@pytest.fixture
-def setup_test_plugin(request: pytest.FixtureRequest) -> Generator[Path, None, None]:
-    """Copies a specified plugin from the fixtures directory to the data directory
-    and removes it after the test.
-    Parameters:
-    - request.param: The name of the plugin package to copy.
-    Yields:
-    - Path to the copied plugin directory.
-    """
-    # Define base directories
-    base_dir = Path("./plugin_runner/tests")
-    fixture_plugin_dir = base_dir / "fixtures" / "plugins"
-    data_plugin_dir = base_dir / "data" / "plugins"
-    # The plugin name should be passed as a parameter to the fixture
-    plugin_name = request.param  # Expected to be a str
-    src_plugin_path = fixture_plugin_dir / plugin_name
-    dest_plugin_path = data_plugin_dir / plugin_name
-    # Ensure the data plugin directory exists
-    data_plugin_dir.mkdir(parents=True, exist_ok=True)
-    # Copy the specific plugin from fixtures to data
-    try:
-        shutil.copytree(src_plugin_path, dest_plugin_path)
-        yield dest_plugin_path  # Provide the path to the test
-    finally:
-        # Cleanup: remove data/plugins directory after the test
-        if dest_plugin_path.exists():
-            shutil.rmtree(dest_plugin_path)
 @pytest.fixture
 def plugin_runner() -> PluginRunner:
     """Fixture to initialize PluginRunner with mocks."""
@@ -59,11 +25,9 @@ def plugin_runner() -> PluginRunner:
     return runner
-@pytest.mark.parametrize("setup_test_plugin", ["example_plugin"], indirect=True)
-def test_load_plugins_with_valid_plugin(setup_test_plugin: Path) -> None:
+@pytest.mark.parametrize("install_test_plugin", ["example_plugin"], indirect=True)
+def test_load_plugins_with_valid_plugin(install_test_plugin: Path, load_test_plugins: None) -> None:
     """Test loading plugins with a valid plugin."""
-    load_plugins()
     assert "example_plugin:example_plugin.protocols.my_protocol:Protocol" in LOADED_PLUGINS
     assert (
         LOADED_PLUGINS["example_plugin:example_plugin.protocols.my_protocol:Protocol"]["active"]
@@ -72,12 +36,11 @@ def test_load_plugins_with_valid_plugin(setup_test_plugin: Path) -> None:
 @pytest.mark.asyncio
-@pytest.mark.parametrize("setup_test_plugin", ["test_module_imports_plugin"], indirect=True)
+@pytest.mark.parametrize("install_test_plugin", ["test_module_imports_plugin"], indirect=True)
 async def test_load_plugins_with_plugin_that_imports_other_modules_within_plugin_package(
-    setup_test_plugin: Path, plugin_runner: PluginRunner
+    install_test_plugin: Path, plugin_runner: PluginRunner, load_test_plugins: None
 ) -> None:
     """Test loading plugins with a valid plugin that imports other modules within the current plugin package."""
-    load_plugins()
     assert (
         "test_module_imports_plugin:test_module_imports_plugin.protocols.my_protocol:Protocol"
         in LOADED_PLUGINS
@@ -102,7 +65,7 @@ async def test_load_plugins_with_plugin_that_imports_other_modules_within_plugin
 @pytest.mark.parametrize(
-    "setup_test_plugin",
+    "install_test_plugin",
     [
         "test_module_imports_outside_plugin_v1",
         "test_module_imports_outside_plugin_v2",
@@ -111,18 +74,108 @@ async def test_load_plugins_with_plugin_that_imports_other_modules_within_plugin
     indirect=True,
 )
 def test_load_plugins_with_plugin_that_imports_other_modules_outside_plugin_package(
-    setup_test_plugin: Path,
+    install_test_plugin: Path, caplog: pytest.LogCaptureFixture
 ) -> None:
     """Test loading plugins with an invalid plugin that imports other modules outside the current plugin package."""
-    with pytest.raises(ImportError, match="is not an allowed import"):
-        sandbox_from_package(setup_test_plugin)
+    with caplog.at_level(logging.ERROR):
+        load_or_reload_plugin(install_test_plugin)
+    assert any(
+        "Error importing module" in record.message for record in caplog.records
+    ), "log.error() was not called with the expected message."
+@pytest.mark.parametrize(
+    "install_test_plugin",
+    [
+        "test_module_forbidden_imports_plugin",
+    ],
+    indirect=True,
+)
+def test_load_plugins_with_plugin_that_imports_forbidden_modules(
+    install_test_plugin: Path, caplog: pytest.LogCaptureFixture
+) -> None:
+    """Test loading plugins with an invalid plugin that imports forbidden modules."""
+    with caplog.at_level(logging.ERROR):
+        load_or_reload_plugin(install_test_plugin)
+    assert any(
+        "Error importing module" in record.message for record in caplog.records
+    ), "log.error() was not called with the expected message."
-@pytest.mark.parametrize("setup_test_plugin", ["example_plugin"], indirect=True)
-def test_reload_plugin(setup_test_plugin: Path) -> None:
+@pytest.mark.parametrize(
+    "install_test_plugin",
+    [
+        "test_module_forbidden_imports_runtime_plugin",
+    ],
+    indirect=True,
+)
+def test_load_plugins_with_plugin_that_imports_forbidden_modules_at_runtime(
+    install_test_plugin: Path,
+) -> None:
+    """Test loading plugins with an invalid plugin that imports forbidden modules at runtime."""
+    with pytest.raises(ImportError, match="is not an allowed import."):
+        load_or_reload_plugin(install_test_plugin)
+        class_handler = LOADED_PLUGINS[
+            "test_module_forbidden_imports_runtime_plugin:test_module_forbidden_imports_runtime_plugin.protocols.my_protocol:Protocol"
+        ]["class"]
+        class_handler(Event(EventRequest(type=EventType.UNKNOWN))).compute()
+@pytest.mark.parametrize(
+    "install_test_plugin",
+    [
+        "test_implicit_imports_plugin",
+    ],
+    indirect=True,
+)
+def test_plugin_that_implicitly_imports_allowed_modules(
+    install_test_plugin: Path, caplog: pytest.LogCaptureFixture
+) -> None:
+    """Test loading plugins with a plugin that implicitly imports allowed modules."""
+    with caplog.at_level(logging.INFO):
+        load_or_reload_plugin(install_test_plugin)
+        class_handler = LOADED_PLUGINS[
+            "test_implicit_imports_plugin:test_implicit_imports_plugin.protocols.my_protocol:Allowed"
+        ]["class"]
+        class_handler(Event(EventRequest(type=EventType.UNKNOWN))).compute()
+    assert any(
+        "Hello, World!" in record.message for record in caplog.records
+    ), "log.info() with Template.render() was not called."
+@pytest.mark.parametrize(
+    "install_test_plugin",
+    [
+        "test_implicit_imports_plugin",
+    ],
+    indirect=True,
+)
+def test_plugin_that_implicitly_imports_forbidden_modules(
+    install_test_plugin: Path, caplog: pytest.LogCaptureFixture
+) -> None:
+    """Test loading plugins with an invalid plugin that implicitly imports forbidden modules."""
+    with (
+        caplog.at_level(logging.INFO),
+        pytest.raises(ImportError, match="'os' is not an allowed import."),
+    ):
+        load_or_reload_plugin(install_test_plugin)
+        class_handler = LOADED_PLUGINS[
+            "test_implicit_imports_plugin:test_implicit_imports_plugin.protocols.my_protocol:Forbidden"
+        ]["class"]
+        class_handler(Event(EventRequest(type=EventType.UNKNOWN))).compute()
+    assert (
+        any("os list dir" in record.message for record in caplog.records) is False
+    ), "log.info() with os.listdir() was called."
+@pytest.mark.parametrize("install_test_plugin", ["example_plugin"], indirect=True)
+def test_reload_plugin(install_test_plugin: Path, load_test_plugins: None) -> None:
     """Test reloading a plugin."""
     load_plugins()
-    load_plugins()
     assert "example_plugin:example_plugin.protocols.my_protocol:Protocol" in LOADED_PLUGINS
     assert (
@@ -131,18 +184,22 @@ def test_reload_plugin(setup_test_plugin: Path) -> None:
     )
-@pytest.mark.parametrize("setup_test_plugin", ["example_plugin"], indirect=True)
-def test_remove_plugin_should_be_removed_from_loaded_plugins(setup_test_plugin: Path) -> None:
+@pytest.mark.parametrize("install_test_plugin", ["example_plugin"], indirect=True)
+def test_remove_plugin_should_be_removed_from_loaded_plugins(
+    install_test_plugin: Path, load_test_plugins: None
+) -> None:
     """Test removing a plugin."""
-    load_plugins()
     assert "example_plugin:example_plugin.protocols.my_protocol:Protocol" in LOADED_PLUGINS
-    shutil.rmtree(setup_test_plugin)
+    shutil.rmtree(install_test_plugin)
     load_plugins()
     assert "example_plugin:example_plugin.protocols.my_protocol:Protocol" not in LOADED_PLUGINS
-@pytest.mark.parametrize("setup_test_plugin", ["example_plugin"], indirect=True)
-def test_load_plugins_should_refresh_event_protocol_map(setup_test_plugin: Path) -> None:
+@pytest.mark.parametrize("install_test_plugin", ["example_plugin"], indirect=True)
+@pytest.mark.parametrize("load_test_plugins", [None], indirect=True)
+def test_load_plugins_should_refresh_event_protocol_map(
+    load_test_plugins: None, install_test_plugin: Path
+) -> None:
     """Test that the event protocol map is refreshed when loading plugins."""
     assert EVENT_HANDLER_MAP == {}
     load_plugins()
@@ -153,13 +210,11 @@ def test_load_plugins_should_refresh_event_protocol_map(setup_test_plugin: Path)
 @pytest.mark.asyncio
-@pytest.mark.parametrize("setup_test_plugin", ["example_plugin"], indirect=True)
+@pytest.mark.parametrize("install_test_plugin", ["example_plugin"], indirect=True)
 async def test_handle_plugin_event_returns_expected_result(
-    setup_test_plugin: Path, plugin_runner: PluginRunner
+    install_test_plugin: Path, plugin_runner: PluginRunner, load_test_plugins: None
 ) -> None:
     """Test that HandleEvent successfully calls the relevant plugins and returns the expected result."""
-    load_plugins()
     event = EventRequest(type=EventType.UNKNOWN)
     result = []
@@ -174,11 +229,11 @@ async def test_handle_plugin_event_returns_expected_result(
 @pytest.mark.asyncio
-@pytest.mark.parametrize("setup_test_plugin", ["example_plugin"], indirect=True)
-async def test_reload_plugins_event_handler_successfully_loads_plugins(
-    setup_test_plugin: Path, plugin_runner: PluginRunner
+@pytest.mark.parametrize("install_test_plugin", ["example_plugin"], indirect=True)
+async def test_reload_plugins_event_handler_successfully_publishes_message(
+    install_test_plugin: Path, plugin_runner: PluginRunner
 ) -> None:
-    """Test ReloadPlugins Event handler successfully loads plugins."""
+    """Test ReloadPlugins Event handler successfully publishes a message with restart action."""
     with patch("plugin_runner.plugin_runner.publish_message", MagicMock()) as mock_publish_message:
         request = ReloadPluginsRequest()
@@ -190,4 +245,42 @@ async def test_reload_plugins_event_handler_successfully_loads_plugins(
     assert len(result) == 1
     assert result[0].success is True
-    assert "example_plugin:example_plugin.protocols.my_protocol:Protocol" in LOADED_PLUGINS
+@pytest.mark.asyncio
+@pytest.mark.parametrize("install_test_plugin", ["test_module_imports_plugin"], indirect=True)
+async def test_changes_to_plugin_modules_should_be_reflected_after_reload(
+    install_test_plugin: Path, load_test_plugins: None, plugin_runner: PluginRunner
+) -> None:
+    """Test that changes to plugin modules are reflected after reloading the plugin."""
+    event = EventRequest(type=EventType.UNKNOWN)
+    result = []
+    async for response in plugin_runner.HandleEvent(event, None):
+        result.append(response)
+    assert len(result) == 1
+    assert result[0].success is True
+    assert len(result[0].effects) == 1
+    assert result[0].effects[0].type == EffectType.LOG
+    assert result[0].effects[0].payload == "Successfully imported!"
+    NEW_CODE = """
+def import_me() -> str:
+    return "Successfully changed!"
+"""
+    file_path = install_test_plugin / "other_module" / "base.py"
+    file_path.write_text(NEW_CODE, encoding="utf-8")
+    # Reload the plugin
+    load_plugins()
+    result = []
+    async for response in plugin_runner.HandleEvent(event, None):
+        result.append(response)
+    assert len(result) == 1
+    assert result[0].success is True
+    assert len(result[0].effects) == 1
+    assert result[0].effects[0].type == EffectType.LOG
+    assert result[0].effects[0].payload == "Successfully changed!"

plugin_runner/tests/test_sandbox.py CHANGED Viewed

@@ -1,6 +1,6 @@
 import pytest
-from plugin_runner.sandbox import Sandbox
+from plugin_runner.sandbox import FORBIDDEN_ASSIGNMENTS, Sandbox
 # Sample code strings for testing various scenarios
 VALID_CODE = """
@@ -28,11 +28,23 @@ CODE_WITH_FORBIDDEN_FUNC_NAME = """
 builtins = {}
 """
-SOURCE_CODE_MODULE_OS = """
-import os
-result = os.listdir('.')
+SOURCE_CODE_MODULE = """
+import module.b
+result = module.b
 """
+CODE_WITH_FORBIDDEN_ASSIGNMENTS = [
+    code
+    for var in FORBIDDEN_ASSIGNMENTS
+    for code in [
+        f"{var} = 'test'",
+        f"test = {var} = 'test'",
+        f"test = {var} = test2 = 'test'",
+        f"(a, (b, c), (d, ({var}, f))) = (1, (2, 3), (4, (5, 6)))",
+        f"(a, (b, c), (d, [{var}, f])) = (1, (2, 3), (4, [5, 6]))",
+    ]
+]
 def test_valid_code_execution() -> None:
     """Test execution of valid code in the sandbox."""
@@ -69,6 +81,14 @@ def test_forbidden_name() -> None:
         sandbox.execute()
+@pytest.mark.parametrize("code", CODE_WITH_FORBIDDEN_ASSIGNMENTS)
+def test_forbidden_assignment(code: str) -> None:
+    """Test that forbidden assignments are blocked by Transformer."""
+    sandbox = Sandbox(code)
+    with pytest.raises(RuntimeError, match="Code is invalid"):
+        sandbox.execute()
 def test_code_with_warnings() -> None:
     """Test that the sandbox captures warnings for restricted names or usage."""
     code_with_warning = """
@@ -110,16 +130,8 @@ print("Hello, Sandbox!")
     assert "Hello, Sandbox!" in scope["_print"].txt, "Print output should be captured."
-def test_sandbox_module_name_imports_within_package() -> None:
-    """Test that modules within the same package can be imported."""
-    sandbox_module_a = Sandbox(source_code=SOURCE_CODE_MODULE_OS, namespace="os.a")
-    result = sandbox_module_a.execute()
-    assert "os" in result
 def test_sandbox_denies_module_name_import_outside_package() -> None:
     """Test that modules outside the root package cannot be imported."""
-    sandbox_module_a = Sandbox(source_code=SOURCE_CODE_MODULE_OS, namespace="module.a")
-    with pytest.raises(ImportError, match="os' is not an allowed import."):
+    sandbox_module_a = Sandbox(source_code=SOURCE_CODE_MODULE, namespace="other_module.a")
+    with pytest.raises(ImportError, match="module.b' is not an allowed import."):
         sandbox_module_a.execute()

settings.py CHANGED Viewed

@@ -19,7 +19,9 @@ INTEGRATION_TEST_CLIENT_SECRET = os.getenv("INTEGRATION_TEST_CLIENT_SECRET")
 GRAPHQL_ENDPOINT = os.getenv("GRAPHQL_ENDPOINT", "http://localhost:8000/plugins-graphql")
-INSTALLED_APPS = ["canvas_sdk"]
+INSTALLED_APPS = [
+    "canvas_sdk.v1",
+]
 SECRET_KEY = os.getenv(
     "SECRET_KEY",
@@ -70,3 +72,13 @@ PLUGIN_DIRECTORY = os.getenv(
 MANIFEST_FILE_NAME = "CANVAS_MANIFEST.json"
 SECRETS_FILE_NAME = "SECRETS.json"
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": False,
+        "OPTIONS": {},
+    },
+]

canvas_sdk/models/__init__.py DELETED Viewed

@@ -1,8 +0,0 @@
-# ruff: noqa
-# register all models in the app so they can be used with apps.get_model()
-from canvas_sdk.v1.data.command import Command
-from canvas_sdk.v1.data.condition import Condition
-from canvas_sdk.v1.data.note import Note
-from canvas_sdk.v1.data.patient import Patient
-from canvas_sdk.v1.data.user import CanvasUser
-from canvas_sdk.v1.data.questionnaire import Interview

{canvas-0.14.0.dist-info → canvas-0.16.0.dist-info}/WHEEL RENAMED Viewed

File without changes

{canvas-0.14.0.dist-info → canvas-0.16.0.dist-info}/entry_points.txt RENAMED Viewed

File without changes

canvas 0.14.0__py3-none-any.whl → 0.16.0__py3-none-any.whl

Potentially problematic release.

canvas 0.14.0py3-none-any.whl → 0.16.0py3-none-any.whl