3f7226709f
SDK support for tool secrets (stored and managed by the engine): - [x] New `requires_secrets=` option in the `@tool` decorator - [x] Internal plumbing in the catalog and `ToolContext` - [x] Full test coverage of all added code - [x] Bumped minor version (new feature) This PR can be merged without waiting for Engine changes, because it is additive only (no breaking changes). After this is merged, I will open another PR to update existing toolkits that will benefit from this feature!
72 lines
2.3 KiB
Python
72 lines
2.3 KiB
Python
import pytest
|
|
|
|
from arcade.core.schema import ToolAuthorizationContext, ToolContext, ToolSecretItem
|
|
|
|
|
|
def test_get_auth_token_or_empty_with_token():
|
|
expected_token = "test_token" # noqa: S105
|
|
auth_context = ToolAuthorizationContext(token=expected_token)
|
|
tool_context = ToolContext(authorization=auth_context)
|
|
|
|
actual_token = tool_context.get_auth_token_or_empty()
|
|
|
|
assert actual_token == expected_token
|
|
|
|
|
|
def test_get_auth_token_or_empty_without_token():
|
|
auth_context = ToolAuthorizationContext(token=None)
|
|
tool_context = ToolContext(authorization=auth_context)
|
|
|
|
assert tool_context.get_auth_token_or_empty() == ""
|
|
|
|
|
|
def test_get_auth_token_or_empty_no_authorization():
|
|
tool_context = ToolContext(authorization=None)
|
|
|
|
assert tool_context.get_auth_token_or_empty() == ""
|
|
|
|
|
|
def test_get_secret_valid():
|
|
key = "my_key"
|
|
val = "secret_value"
|
|
secrets = [ToolSecretItem(key=key, value=val)]
|
|
tool_context = ToolContext(secrets=secrets)
|
|
|
|
# When the secret exists, get_secret should return its value.
|
|
actual_secret = tool_context.get_secret(key)
|
|
assert actual_secret == val
|
|
|
|
|
|
def test_get_secret_with_case_insensitive_key():
|
|
key = "my_key"
|
|
val = "secret_value"
|
|
secrets = [ToolSecretItem(key=key, value=val)]
|
|
tool_context = ToolContext(secrets=secrets)
|
|
|
|
assert tool_context.get_secret(key.upper()) == val
|
|
assert tool_context.get_secret(key.lower()) == val
|
|
|
|
|
|
def test_get_secret_key_not_found():
|
|
key = "nonexistent_key"
|
|
secrets = [ToolSecretItem(key="other_key", value="another_secret")]
|
|
tool_context = ToolContext(secrets=secrets)
|
|
|
|
# When the key is not found, get_secret should raise a ValueError.
|
|
with pytest.raises(ValueError, match=f"Secret {key} not found in context."):
|
|
tool_context.get_secret(key)
|
|
|
|
|
|
def test_get_secret_when_secrets_is_none():
|
|
tool_context = ToolContext(secrets=None)
|
|
|
|
# When no secrets dictionary is provided, get_secret should raise a ValueError.
|
|
with pytest.raises(ValueError, match="Secrets not found in context."):
|
|
tool_context.get_secret("missing_key")
|
|
|
|
|
|
def test_get_secret_with_empty_key():
|
|
tool_context = ToolContext(secrets=[])
|
|
|
|
with pytest.raises(ValueError, match="Secret key ID passed to get_secret cannot be empty."):
|
|
tool_context.get_secret("")
|