canvas 0.12.0__py3-none-any.whl → 0.13.1__py3-none-any.whl

plugin_runner/tests/test_plugin_installer.py

@@ -0,0 +1,118 @@
+import json
+import tarfile
+import tempfile
+from pathlib import Path
+from unittest.mock import MagicMock
+
+from pytest_mock import MockerFixture
+
+import settings
+from plugin_runner.plugin_installer import (
+    PluginAttributes,
+    _extract_rows_to_dict,
+    download_plugin,
+    install_plugins,
+    uninstall_plugin,
+)
+
+
+def _create_tarball(name: str) -> Path:
+    # Create a temporary tarball file
+    temp_dir = tempfile.mkdtemp()
+    tarball_path = Path(temp_dir) / f"{name}.tar.gz"
+
+    # Add some files to the tarball
+    with tarfile.open(tarball_path, "w:gz") as tar:
+        for i in range(3):
+            file_path = Path(temp_dir) / f"file{i}.txt"
+            file_path.write_text(f"Content of file {i}")
+            tar.add(file_path, arcname=f"file{i}.txt")
+
+    # Return a Path handle to the tarball
+    return tarball_path
+
+
+def test_extract_rows_to_dict() -> None:
+    """Test that database rows can be extracted to a dictionary with secrets appropriately attributed to plugin."""
+    rows = [
+        {
+            "name": "plugin1",
+            "version": "1.0",
+            "package": "package1",
+            "key": "key1",
+            "value": "value1",
+        },
+        {
+            "name": "plugin1",
+            "version": "1.0",
+            "package": "package1",
+            "key": "key2",
+            "value": "value2",
+        },
+        {"name": "plugin2", "version": "2.0", "package": "package2", "key": None, "value": None},
+    ]
+
+    expected_output = {
+        "plugin1": {
+            "version": "1.0",
+            "package": "package1",
+            "secrets": {"key1": "value1", "key2": "value2"},
+        },
+        "plugin2": {
+            "version": "2.0",
+            "package": "package2",
+            "secrets": {},
+        },
+    }
+
+    result = _extract_rows_to_dict(rows)
+    assert result == expected_output
+
+
+def test_plugin_installation_from_tarball(mocker: MockerFixture) -> None:
+    """Test that plugins can be installed from tarballs."""
+    mock_plugins = {
+        "plugin1": PluginAttributes(
+            version="1.0", package="plugins/plugin1.tar.gz", secrets={"key1": "value1"}
+        ),
+        "plugin2": PluginAttributes(
+            version="1.0", package="plugins/plugin2.tar", secrets={"key2": "value2"}
+        ),
+    }
+
+    tarball_1 = _create_tarball("plugin1")
+    tarball_2 = _create_tarball("plugin2")
+
+    mocker.patch("plugin_runner.plugin_installer.enabled_plugins", return_value=mock_plugins)
+    mocker.patch(
+        "plugin_runner.plugin_installer.download_plugin", side_effect=[tarball_1, tarball_2]
+    )
+
+    install_plugins()
+    assert Path("plugin_runner/tests/data/plugins/plugin1").exists()
+    assert Path("plugin_runner/tests/data/plugins/plugin1/SECRETS.json").exists()
+    with open("plugin_runner/tests/data/plugins/plugin1/SECRETS.json") as f:
+        assert json.load(f) == mock_plugins["plugin1"]["secrets"]
+    assert Path("plugin_runner/tests/data/plugins/plugin2").exists()
+    assert Path("plugin_runner/tests/data/plugins/plugin2/SECRETS.json").exists()
+    with open("plugin_runner/tests/data/plugins/plugin2/SECRETS.json") as f:
+        assert json.load(f) == mock_plugins["plugin2"]["secrets"]
+
+    uninstall_plugin("plugin1")
+    uninstall_plugin("plugin2")
+    assert not Path("plugin_runner/tests/data/plugins/plugin1").exists()
+    assert not Path("plugin_runner/tests/data/plugins/plugin2").exists()
+
+
+def test_download(mocker: MockerFixture) -> None:
+    """Test that the plugin package can be written to disk, mocking out S3."""
+    mock_s3_client = MagicMock()
+    mocker.patch("boto3.client", return_value=mock_s3_client)
+
+    plugin_package = "plugins/plugin1.tar.gz"
+    with download_plugin(plugin_package) as plugin_path:
+        assert plugin_path.exists()
+
+    mock_s3_client.download_fileobj.assert_called_once_with(
+        "canvas-client-media", f"{settings.CUSTOMER_IDENTIFIER}/{plugin_package}", mocker.ANY
+    )

plugin_runner/tests/test_plugin_runner.py

@@ -9,7 +9,7 @@ from canvas_generated.messages.effects_pb2 import EffectType
 from canvas_generated.messages.plugins_pb2 import ReloadPluginsRequest
 from canvas_sdk.events import EventRequest, EventType
 from plugin_runner.plugin_runner import (
-    EVENT_PROTOCOL_MAP,
+    EVENT_HANDLER_MAP,
     LOADED_PLUGINS,
     PluginRunner,
     load_plugins,
@@ -144,10 +144,10 @@ def test_remove_plugin_should_be_removed_from_loaded_plugins(setup_test_plugin:
 @pytest.mark.parametrize("setup_test_plugin", ["example_plugin"], indirect=True)
 def test_load_plugins_should_refresh_event_protocol_map(setup_test_plugin: Path) -> None:
     """Test that the event protocol map is refreshed when loading plugins."""
-    assert EVENT_PROTOCOL_MAP == {}
+    assert EVENT_HANDLER_MAP == {}
     load_plugins()
-    assert EventType.Name(EventType.UNKNOWN) in EVENT_PROTOCOL_MAP
-    assert EVENT_PROTOCOL_MAP[EventType.Name(EventType.UNKNOWN)] == [
+    assert EventType.Name(EventType.UNKNOWN) in EVENT_HANDLER_MAP
+    assert EVENT_HANDLER_MAP[EventType.Name(EventType.UNKNOWN)] == [
         "example_plugin:example_plugin.protocols.my_protocol:Protocol"
     ]
 

plugin_runner/tests/test_sandbox.py

@@ -100,7 +100,7 @@ print("Hello, Sandbox!")
 
 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, module_name="os.a")
+    sandbox_module_a = Sandbox(source_code=SOURCE_CODE_MODULE_OS, namespace="os.a")
     result = sandbox_module_a.execute()
 
     assert "os" in result
@@ -108,6 +108,6 @@ def test_sandbox_module_name_imports_within_package() -> None:
 
 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, module_name="module.a")
+    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.execute()

settings.py

@@ -2,16 +2,18 @@ import os
 import sys
 
 from dotenv import load_dotenv
-from env_tools import env_to_bool
+from env_tools import env_to_bool, get_enforcement_context
 
 from canvas_sdk.utils.db import get_database_dict_from_url
 
+require_env, enforce_required_envs = get_enforcement_context()
+
 load_dotenv()
 
 ENV = os.getenv("ENV", "development")
 IS_PRODUCTION = ENV == "production"
 IS_TESTING = env_to_bool("IS_TESTING", "pytest" in sys.argv[0] or sys.argv[0] == "-c")
-
+CUSTOMER_IDENTIFIER = require_env("CUSTOMER_IDENTIFIER")
 
 INTEGRATION_TEST_URL = os.getenv("INTEGRATION_TEST_URL")
 INTEGRATION_TEST_CLIENT_ID = os.getenv("INTEGRATION_TEST_CLIENT_ID")
@@ -66,3 +68,4 @@ PLUGIN_DIRECTORY = os.getenv(
 MANIFEST_FILE_NAME = "CANVAS_MANIFEST.json"
 
 SECRETS_FILE_NAME = "SECRETS.json"
+enforce_required_envs()