crossplane-function-sdk-python 0.2.0__tar.gz → 0.3.0__tar.gz

{crossplane_function_sdk_python-0.2.0 → crossplane_function_sdk_python-0.3.0}/.github/workflows/ci.yml

@@ -119,7 +119,7 @@ jobs:
           path: "dist"
 
       - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.8.11
+        uses: pypa/gh-action-pypi-publish@v1.9.0
         with:
           # Note that this is currently being pushed to the 'crossplane' PyPI
           # user (not org). See @negz if you need access - PyPI requires 2FA to
@@ -149,7 +149,7 @@ jobs:
         run: hatch run docs:pdoc -d google crossplane/function -o docs
 
       - name: Setup Pages
-        uses: actions/configure-pages@v4
+        uses: actions/configure-pages@v5
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

{crossplane_function_sdk_python-0.2.0 → crossplane_function_sdk_python-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: crossplane-function-sdk-python
-Version: 0.2.0
+Version: 0.3.0
 Summary: The Python SDK for Crossplane composition functions
 Project-URL: Documentation, https://github.com/crossplane/function-sdk-python#readme
 Project-URL: Issues, https://github.com/crossplane/function-sdk-python/issues

{crossplane_function_sdk_python-0.2.0 → crossplane_function_sdk_python-0.3.0}/crossplane/function/__version__.py

@@ -15,4 +15,4 @@
 """The version of function-sdk-python."""
 
 # This is set at build time, using "hatch version"
-__version__ = "0.2.0"
+__version__ = "0.3.0"

{crossplane_function_sdk_python-0.2.0 → crossplane_function_sdk_python-0.3.0}/crossplane/function/proto/v1beta1/run_function.proto

@@ -69,6 +69,24 @@ message RunFunctionRequest {
   // did not exist, Crossplane sets the map key to an empty Resources message to
   // indicate that it attempted to satisfy the request.
   map<string, Resources> extra_resources = 6;
+
+  // Optional credentials that this Function may use to communicate with an
+  // external system.
+  map <string, Credentials> credentials = 7;
+}
+
+// Credentials that a Function may use to communicate with an external system.
+message Credentials {
+  // Source of the credentials.
+  oneof source {
+    // Credential data loaded by Crossplane, for example from a Secret.
+    CredentialData credential_data = 1;
+  }
+}
+
+// CredentialData loaded by Crossplane, for example from a Secret.
+message CredentialData {
+  map<string, bytes> data = 1;
 }
 
 // Resources represents the state of several Crossplane resources.
@@ -238,4 +256,4 @@ enum Severity {
   // Normal results are emitted as normal events and debug logs associated
   // with the composite resource.
   SEVERITY_NORMAL = 3;
-}
+}

crossplane_function_sdk_python-0.3.0/crossplane/function/proto/v1beta1/run_function_pb2.py

@@ -0,0 +1,86 @@
+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: crossplane/function/proto/v1beta1/run_function.proto
+# Protobuf Python Version: 4.25.1
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import descriptor_pool as _descriptor_pool
+from google.protobuf import symbol_database as _symbol_database
+from google.protobuf.internal import builder as _builder
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+from google.protobuf import struct_pb2 as google_dot_protobuf_dot_struct__pb2
+from google.protobuf import duration_pb2 as google_dot_protobuf_dot_duration__pb2
+
+
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n4crossplane/function/proto/v1beta1/run_function.proto\x12\x1e\x61piextensions.fn.proto.v1beta1\x1a\x1cgoogle/protobuf/struct.proto\x1a\x1egoogle/protobuf/duration.proto\"\xb0\x05\n\x12RunFunctionRequest\x12\x39\n\x04meta\x18\x01 \x01(\x0b\x32+.apiextensions.fn.proto.v1beta1.RequestMeta\x12\x37\n\x08observed\x18\x02 \x01(\x0b\x32%.apiextensions.fn.proto.v1beta1.State\x12\x36\n\x07\x64\x65sired\x18\x03 \x01(\x0b\x32%.apiextensions.fn.proto.v1beta1.State\x12+\n\x05input\x18\x04 \x01(\x0b\x32\x17.google.protobuf.StructH\x00\x88\x01\x01\x12-\n\x07\x63ontext\x18\x05 \x01(\x0b\x32\x17.google.protobuf.StructH\x01\x88\x01\x01\x12_\n\x0f\x65xtra_resources\x18\x06 \x03(\x0b\x32\x46.apiextensions.fn.proto.v1beta1.RunFunctionRequest.ExtraResourcesEntry\x12X\n\x0b\x63redentials\x18\x07 \x03(\x0b\x32\x43.apiextensions.fn.proto.v1beta1.RunFunctionRequest.CredentialsEntry\x1a`\n\x13\x45xtraResourcesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x38\n\x05value\x18\x02 \x01(\x0b\x32).apiextensions.fn.proto.v1beta1.Resources:\x02\x38\x01\x1a_\n\x10\x43redentialsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12:\n\x05value\x18\x02 \x01(\x0b\x32+.apiextensions.fn.proto.v1beta1.Credentials:\x02\x38\x01\x42\x08\n\x06_inputB\n\n\x08_context\"b\n\x0b\x43redentials\x12I\n\x0f\x63redential_data\x18\x01 \x01(\x0b\x32..apiextensions.fn.proto.v1beta1.CredentialDataH\x00\x42\x08\n\x06source\"\x85\x01\n\x0e\x43redentialData\x12\x46\n\x04\x64\x61ta\x18\x01 \x03(\x0b\x32\x38.apiextensions.fn.proto.v1beta1.CredentialData.DataEntry\x1a+\n\tDataEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\x0c:\x02\x38\x01\"D\n\tResources\x12\x37\n\x05items\x18\x01 \x03(\x0b\x32(.apiextensions.fn.proto.v1beta1.Resource\"\xc1\x02\n\x13RunFunctionResponse\x12:\n\x04meta\x18\x01 \x01(\x0b\x32,.apiextensions.fn.proto.v1beta1.ResponseMeta\x12\x36\n\x07\x64\x65sired\x18\x02 \x01(\x0b\x32%.apiextensions.fn.proto.v1beta1.State\x12\x37\n\x07results\x18\x03 \x03(\x0b\x32&.apiextensions.fn.proto.v1beta1.Result\x12-\n\x07\x63ontext\x18\x04 \x01(\x0b\x32\x17.google.protobuf.StructH\x00\x88\x01\x01\x12\x42\n\x0crequirements\x18\x05 \x01(\x0b\x32,.apiextensions.fn.proto.v1beta1.RequirementsB\n\n\x08_context\"\x1a\n\x0bRequestMeta\x12\x0b\n\x03tag\x18\x01 \x01(\t\"\xd2\x01\n\x0cRequirements\x12Y\n\x0f\x65xtra_resources\x18\x01 \x03(\x0b\x32@.apiextensions.fn.proto.v1beta1.Requirements.ExtraResourcesEntry\x1ag\n\x13\x45xtraResourcesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12?\n\x05value\x18\x02 \x01(\x0b\x32\x30.apiextensions.fn.proto.v1beta1.ResourceSelector:\x02\x38\x01\"\x99\x01\n\x10ResourceSelector\x12\x13\n\x0b\x61pi_version\x18\x01 \x01(\t\x12\x0c\n\x04kind\x18\x02 \x01(\t\x12\x14\n\nmatch_name\x18\x03 \x01(\tH\x00\x12\x43\n\x0cmatch_labels\x18\x04 \x01(\x0b\x32+.apiextensions.fn.proto.v1beta1.MatchLabelsH\x00\x42\x07\n\x05match\"\x85\x01\n\x0bMatchLabels\x12G\n\x06labels\x18\x01 \x03(\x0b\x32\x37.apiextensions.fn.proto.v1beta1.MatchLabels.LabelsEntry\x1a-\n\x0bLabelsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"P\n\x0cResponseMeta\x12\x0b\n\x03tag\x18\x01 \x01(\t\x12+\n\x03ttl\x18\x02 \x01(\x0b\x32\x19.google.protobuf.DurationH\x00\x88\x01\x01\x42\x06\n\x04_ttl\"\xe9\x01\n\x05State\x12;\n\tcomposite\x18\x01 \x01(\x0b\x32(.apiextensions.fn.proto.v1beta1.Resource\x12G\n\tresources\x18\x02 \x03(\x0b\x32\x34.apiextensions.fn.proto.v1beta1.State.ResourcesEntry\x1aZ\n\x0eResourcesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x37\n\x05value\x18\x02 \x01(\x0b\x32(.apiextensions.fn.proto.v1beta1.Resource:\x02\x38\x01\"\x82\x02\n\x08Resource\x12)\n\x08resource\x18\x01 \x01(\x0b\x32\x17.google.protobuf.Struct\x12[\n\x12\x63onnection_details\x18\x02 \x03(\x0b\x32?.apiextensions.fn.proto.v1beta1.Resource.ConnectionDetailsEntry\x12\x34\n\x05ready\x18\x03 \x01(\x0e\x32%.apiextensions.fn.proto.v1beta1.Ready\x1a\x38\n\x16\x43onnectionDetailsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\x0c:\x02\x38\x01\"U\n\x06Result\x12:\n\x08severity\x18\x01 \x01(\x0e\x32(.apiextensions.fn.proto.v1beta1.Severity\x12\x0f\n\x07message\x18\x02 \x01(\t*?\n\x05Ready\x12\x15\n\x11READY_UNSPECIFIED\x10\x00\x12\x0e\n\nREADY_TRUE\x10\x01\x12\x0f\n\x0bREADY_FALSE\x10\x02*c\n\x08Severity\x12\x18\n\x14SEVERITY_UNSPECIFIED\x10\x00\x12\x12\n\x0eSEVERITY_FATAL\x10\x01\x12\x14\n\x10SEVERITY_WARNING\x10\x02\x12\x13\n\x0fSEVERITY_NORMAL\x10\x03\x32\x91\x01\n\x15\x46unctionRunnerService\x12x\n\x0bRunFunction\x12\x32.apiextensions.fn.proto.v1beta1.RunFunctionRequest\x1a\x33.apiextensions.fn.proto.v1beta1.RunFunctionResponse\"\x00\x62\x06proto3')
+
+_globals = globals()
+_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
+_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'crossplane.function.proto.v1beta1.run_function_pb2', _globals)
+if _descriptor._USE_C_DESCRIPTORS == False:
+  DESCRIPTOR._options = None
+  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._options = None
+  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._serialized_options = b'8\001'
+  _globals['_RUNFUNCTIONREQUEST_CREDENTIALSENTRY']._options = None
+  _globals['_RUNFUNCTIONREQUEST_CREDENTIALSENTRY']._serialized_options = b'8\001'
+  _globals['_CREDENTIALDATA_DATAENTRY']._options = None
+  _globals['_CREDENTIALDATA_DATAENTRY']._serialized_options = b'8\001'
+  _globals['_REQUIREMENTS_EXTRARESOURCESENTRY']._options = None
+  _globals['_REQUIREMENTS_EXTRARESOURCESENTRY']._serialized_options = b'8\001'
+  _globals['_MATCHLABELS_LABELSENTRY']._options = None
+  _globals['_MATCHLABELS_LABELSENTRY']._serialized_options = b'8\001'
+  _globals['_STATE_RESOURCESENTRY']._options = None
+  _globals['_STATE_RESOURCESENTRY']._serialized_options = b'8\001'
+  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._options = None
+  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._serialized_options = b'8\001'
+  _globals['_READY']._serialized_start=2670
+  _globals['_READY']._serialized_end=2733
+  _globals['_SEVERITY']._serialized_start=2735
+  _globals['_SEVERITY']._serialized_end=2834
+  _globals['_RUNFUNCTIONREQUEST']._serialized_start=151
+  _globals['_RUNFUNCTIONREQUEST']._serialized_end=839
+  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._serialized_start=624
+  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._serialized_end=720
+  _globals['_RUNFUNCTIONREQUEST_CREDENTIALSENTRY']._serialized_start=722
+  _globals['_RUNFUNCTIONREQUEST_CREDENTIALSENTRY']._serialized_end=817
+  _globals['_CREDENTIALS']._serialized_start=841
+  _globals['_CREDENTIALS']._serialized_end=939
+  _globals['_CREDENTIALDATA']._serialized_start=942
+  _globals['_CREDENTIALDATA']._serialized_end=1075
+  _globals['_CREDENTIALDATA_DATAENTRY']._serialized_start=1032
+  _globals['_CREDENTIALDATA_DATAENTRY']._serialized_end=1075
+  _globals['_RESOURCES']._serialized_start=1077
+  _globals['_RESOURCES']._serialized_end=1145
+  _globals['_RUNFUNCTIONRESPONSE']._serialized_start=1148
+  _globals['_RUNFUNCTIONRESPONSE']._serialized_end=1469
+  _globals['_REQUESTMETA']._serialized_start=1471
+  _globals['_REQUESTMETA']._serialized_end=1497
+  _globals['_REQUIREMENTS']._serialized_start=1500
+  _globals['_REQUIREMENTS']._serialized_end=1710
+  _globals['_REQUIREMENTS_EXTRARESOURCESENTRY']._serialized_start=1607
+  _globals['_REQUIREMENTS_EXTRARESOURCESENTRY']._serialized_end=1710
+  _globals['_RESOURCESELECTOR']._serialized_start=1713
+  _globals['_RESOURCESELECTOR']._serialized_end=1866
+  _globals['_MATCHLABELS']._serialized_start=1869
+  _globals['_MATCHLABELS']._serialized_end=2002
+  _globals['_MATCHLABELS_LABELSENTRY']._serialized_start=1957
+  _globals['_MATCHLABELS_LABELSENTRY']._serialized_end=2002
+  _globals['_RESPONSEMETA']._serialized_start=2004
+  _globals['_RESPONSEMETA']._serialized_end=2084
+  _globals['_STATE']._serialized_start=2087
+  _globals['_STATE']._serialized_end=2320
+  _globals['_STATE_RESOURCESENTRY']._serialized_start=2230
+  _globals['_STATE_RESOURCESENTRY']._serialized_end=2320
+  _globals['_RESOURCE']._serialized_start=2323
+  _globals['_RESOURCE']._serialized_end=2581
+  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._serialized_start=2525
+  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._serialized_end=2581
+  _globals['_RESULT']._serialized_start=2583
+  _globals['_RESULT']._serialized_end=2668
+  _globals['_FUNCTIONRUNNERSERVICE']._serialized_start=2837
+  _globals['_FUNCTIONRUNNERSERVICE']._serialized_end=2982
+# @@protoc_insertion_point(module_scope)

{crossplane_function_sdk_python-0.2.0 → crossplane_function_sdk_python-0.3.0}/crossplane/function/proto/v1beta1/run_function_pb2.pyi

@@ -29,7 +29,7 @@ SEVERITY_WARNING: Severity
 SEVERITY_NORMAL: Severity
 
 class RunFunctionRequest(_message.Message):
-    __slots__ = ("meta", "observed", "desired", "input", "context", "extra_resources")
+    __slots__ = ("meta", "observed", "desired", "input", "context", "extra_resources", "credentials")
     class ExtraResourcesEntry(_message.Message):
         __slots__ = ("key", "value")
         KEY_FIELD_NUMBER: _ClassVar[int]
@@ -37,19 +37,47 @@ class RunFunctionRequest(_message.Message):
         key: str
         value: Resources
         def __init__(self, key: _Optional[str] = ..., value: _Optional[_Union[Resources, _Mapping]] = ...) -> None: ...
+    class CredentialsEntry(_message.Message):
+        __slots__ = ("key", "value")
+        KEY_FIELD_NUMBER: _ClassVar[int]
+        VALUE_FIELD_NUMBER: _ClassVar[int]
+        key: str
+        value: Credentials
+        def __init__(self, key: _Optional[str] = ..., value: _Optional[_Union[Credentials, _Mapping]] = ...) -> None: ...
     META_FIELD_NUMBER: _ClassVar[int]
     OBSERVED_FIELD_NUMBER: _ClassVar[int]
     DESIRED_FIELD_NUMBER: _ClassVar[int]
     INPUT_FIELD_NUMBER: _ClassVar[int]
     CONTEXT_FIELD_NUMBER: _ClassVar[int]
     EXTRA_RESOURCES_FIELD_NUMBER: _ClassVar[int]
+    CREDENTIALS_FIELD_NUMBER: _ClassVar[int]
     meta: RequestMeta
     observed: State
     desired: State
     input: _struct_pb2.Struct
     context: _struct_pb2.Struct
     extra_resources: _containers.MessageMap[str, Resources]
-    def __init__(self, meta: _Optional[_Union[RequestMeta, _Mapping]] = ..., observed: _Optional[_Union[State, _Mapping]] = ..., desired: _Optional[_Union[State, _Mapping]] = ..., input: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ..., context: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ..., extra_resources: _Optional[_Mapping[str, Resources]] = ...) -> None: ...
+    credentials: _containers.MessageMap[str, Credentials]
+    def __init__(self, meta: _Optional[_Union[RequestMeta, _Mapping]] = ..., observed: _Optional[_Union[State, _Mapping]] = ..., desired: _Optional[_Union[State, _Mapping]] = ..., input: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ..., context: _Optional[_Union[_struct_pb2.Struct, _Mapping]] = ..., extra_resources: _Optional[_Mapping[str, Resources]] = ..., credentials: _Optional[_Mapping[str, Credentials]] = ...) -> None: ...
+
+class Credentials(_message.Message):
+    __slots__ = ("credential_data",)
+    CREDENTIAL_DATA_FIELD_NUMBER: _ClassVar[int]
+    credential_data: CredentialData
+    def __init__(self, credential_data: _Optional[_Union[CredentialData, _Mapping]] = ...) -> None: ...
+
+class CredentialData(_message.Message):
+    __slots__ = ("data",)
+    class DataEntry(_message.Message):
+        __slots__ = ("key", "value")
+        KEY_FIELD_NUMBER: _ClassVar[int]
+        VALUE_FIELD_NUMBER: _ClassVar[int]
+        key: str
+        value: bytes
+        def __init__(self, key: _Optional[str] = ..., value: _Optional[bytes] = ...) -> None: ...
+    DATA_FIELD_NUMBER: _ClassVar[int]
+    data: _containers.ScalarMap[str, bytes]
+    def __init__(self, data: _Optional[_Mapping[str, bytes]] = ...) -> None: ...
 
 class Resources(_message.Message):
     __slots__ = ("items",)

{crossplane_function_sdk_python-0.2.0 → crossplane_function_sdk_python-0.3.0}/crossplane/function/resource.py

@@ -106,3 +106,24 @@ def get_condition(resource: structpb.Struct, typ: str) -> Condition:
         return condition
 
     return unknown
+
+
+@dataclasses.dataclass
+class Credentials:
+    """Credentials."""
+
+    type: str
+    data: dict
+
+
+def get_credentials(req: structpb.Struct, name: str) -> Credentials:
+    """Get the supplied credentials."""
+    empty = Credentials(type="data", data={})
+    if "credentials" not in req:
+        return empty
+    if name not in req["credentials"]:
+        return empty
+    return Credentials(
+        type=req["credentials"][name]["type"],
+        data=struct_to_dict(req["credentials"][name]["data"]),
+    )

{crossplane_function_sdk_python-0.2.0 → crossplane_function_sdk_python-0.3.0}/crossplane/function/runtime.py

@@ -82,6 +82,9 @@ def serve(
     If insecure is true requests will be served insecurely, even if credentials
     are supplied.
     """
+    # Define the loop before the server so everything uses the same loop.
+    loop = asyncio.get_event_loop()
+
     server = grpc.aio.server()
 
     grpcv1beta1.add_FunctionRunnerServiceServicer_to_server(function, server)
@@ -104,7 +107,6 @@ def serve(
         await server.start()
         await server.wait_for_termination()
 
-    loop = asyncio.get_event_loop()
     try:
         loop.run_until_complete(start())
     finally:

{crossplane_function_sdk_python-0.2.0 → crossplane_function_sdk_python-0.3.0}/pyproject.toml

@@ -32,13 +32,13 @@ validate-bump = false                       # Allow going from 0.0.0.dev0+x to 0
 [tool.hatch.envs.default]
 type = "virtual"
 path = ".venv-default"
-dependencies = ["ipython==8.21.0"]
+dependencies = ["ipython==8.26.0"]
 
 [tool.hatch.envs.generate]
 type = "virtual"
 detached = true
 path = ".venv-generate"
-dependencies = ["grpcio-tools==1.60.1"]
+dependencies = ["grpcio-tools==1.65.4"]
 
 [tool.hatch.envs.generate.scripts]
 protoc = "python -m grpc_tools.protoc --proto_path=. --python_out=. --pyi_out=. --grpc_python_out=. crossplane/function/proto/v1beta1/run_function.proto"
@@ -47,7 +47,7 @@ protoc = "python -m grpc_tools.protoc --proto_path=. --python_out=. --pyi_out=.
 type = "virtual"
 detached = true
 path = ".venv-lint"
-dependencies = ["ruff==0.2.2"]
+dependencies = ["ruff==0.5.7"]
 
 [tool.hatch.envs.lint.scripts]
 check = "ruff check crossplane tests && ruff format --diff crossplane tests"
@@ -73,7 +73,7 @@ packages = ["crossplane"]
 [tool.ruff]
 target-version = "py311"
 exclude = ["crossplane/function/proto/*"]
-select = [
+lint.select = [
   "A",
   "ARG",
   "ASYNC",
@@ -103,12 +103,12 @@ select = [
   "W",
   "YTT",
 ]
-ignore = ["ISC001"] # Ruff warns this is incompatible with ruff format.
+lint.ignore = ["ISC001"] # Ruff warns this is incompatible with ruff format.
 
 [tool.ruff.lint.per-file-ignores]
 "tests/*" = ["D"] # Don't require docstrings for tests.
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 known-first-party = ["crossplane"]
 
 [tool.ruff.lint.pydocstyle]

{crossplane_function_sdk_python-0.2.0 → crossplane_function_sdk_python-0.3.0}/tests/test_resource.py

@@ -122,6 +122,49 @@ class TestResource(unittest.TestCase):
                 dataclasses.asdict(case.want), dataclasses.asdict(got), "-want, +got"
             )
 
+    def test_get_credentials(self) -> None:
+        @dataclasses.dataclass
+        class TestCase:
+            reason: str
+            req: structpb.Struct
+            name: str
+            want: resource.Credentials
+
+        cases = [
+            TestCase(
+                reason="Return the specified credentials if they exist.",
+                req=resource.dict_to_struct(
+                    {"credentials": {"test": {"type": "data", "data": {"foo": "bar"}}}}
+                ),
+                name="test",
+                want=resource.Credentials(type="data", data={"foo": "bar"}),
+            ),
+            TestCase(
+                reason="Return empty credentials if no credentials section exists.",
+                req=resource.dict_to_struct({}),
+                name="test",
+                want=resource.Credentials(type="data", data={}),
+            ),
+            TestCase(
+                reason="Return empty credentials if the specified name does not exist.",
+                req=resource.dict_to_struct(
+                    {
+                        "credentials": {
+                            "nottest": {"type": "data", "data": {"foo": "bar"}}
+                        }
+                    }
+                ),
+                name="test",
+                want=resource.Credentials(type="data", data={}),
+            ),
+        ]
+
+        for case in cases:
+            got = resource.get_credentials(case.req, case.name)
+            self.assertEqual(
+                dataclasses.asdict(case.want), dataclasses.asdict(got), "-want, +got"
+            )
+
 
 if __name__ == "__main__":
     unittest.main()

crossplane_function_sdk_python-0.2.0/crossplane/function/proto/v1beta1/run_function_pb2.py

@@ -1,74 +0,0 @@
-# -*- coding: utf-8 -*-
-# Generated by the protocol buffer compiler.  DO NOT EDIT!
-# source: crossplane/function/proto/v1beta1/run_function.proto
-# Protobuf Python Version: 4.25.0
-"""Generated protocol buffer code."""
-from google.protobuf import descriptor as _descriptor
-from google.protobuf import descriptor_pool as _descriptor_pool
-from google.protobuf import symbol_database as _symbol_database
-from google.protobuf.internal import builder as _builder
-# @@protoc_insertion_point(imports)
-
-_sym_db = _symbol_database.Default()
-
-
-from google.protobuf import struct_pb2 as google_dot_protobuf_dot_struct__pb2
-from google.protobuf import duration_pb2 as google_dot_protobuf_dot_duration__pb2
-
-
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n4crossplane/function/proto/v1beta1/run_function.proto\x12\x1e\x61piextensions.fn.proto.v1beta1\x1a\x1cgoogle/protobuf/struct.proto\x1a\x1egoogle/protobuf/duration.proto\"\xf5\x03\n\x12RunFunctionRequest\x12\x39\n\x04meta\x18\x01 \x01(\x0b\x32+.apiextensions.fn.proto.v1beta1.RequestMeta\x12\x37\n\x08observed\x18\x02 \x01(\x0b\x32%.apiextensions.fn.proto.v1beta1.State\x12\x36\n\x07\x64\x65sired\x18\x03 \x01(\x0b\x32%.apiextensions.fn.proto.v1beta1.State\x12+\n\x05input\x18\x04 \x01(\x0b\x32\x17.google.protobuf.StructH\x00\x88\x01\x01\x12-\n\x07\x63ontext\x18\x05 \x01(\x0b\x32\x17.google.protobuf.StructH\x01\x88\x01\x01\x12_\n\x0f\x65xtra_resources\x18\x06 \x03(\x0b\x32\x46.apiextensions.fn.proto.v1beta1.RunFunctionRequest.ExtraResourcesEntry\x1a`\n\x13\x45xtraResourcesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x38\n\x05value\x18\x02 \x01(\x0b\x32).apiextensions.fn.proto.v1beta1.Resources:\x02\x38\x01\x42\x08\n\x06_inputB\n\n\x08_context\"D\n\tResources\x12\x37\n\x05items\x18\x01 \x03(\x0b\x32(.apiextensions.fn.proto.v1beta1.Resource\"\xc1\x02\n\x13RunFunctionResponse\x12:\n\x04meta\x18\x01 \x01(\x0b\x32,.apiextensions.fn.proto.v1beta1.ResponseMeta\x12\x36\n\x07\x64\x65sired\x18\x02 \x01(\x0b\x32%.apiextensions.fn.proto.v1beta1.State\x12\x37\n\x07results\x18\x03 \x03(\x0b\x32&.apiextensions.fn.proto.v1beta1.Result\x12-\n\x07\x63ontext\x18\x04 \x01(\x0b\x32\x17.google.protobuf.StructH\x00\x88\x01\x01\x12\x42\n\x0crequirements\x18\x05 \x01(\x0b\x32,.apiextensions.fn.proto.v1beta1.RequirementsB\n\n\x08_context\"\x1a\n\x0bRequestMeta\x12\x0b\n\x03tag\x18\x01 \x01(\t\"\xd2\x01\n\x0cRequirements\x12Y\n\x0f\x65xtra_resources\x18\x01 \x03(\x0b\x32@.apiextensions.fn.proto.v1beta1.Requirements.ExtraResourcesEntry\x1ag\n\x13\x45xtraResourcesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12?\n\x05value\x18\x02 \x01(\x0b\x32\x30.apiextensions.fn.proto.v1beta1.ResourceSelector:\x02\x38\x01\"\x99\x01\n\x10ResourceSelector\x12\x13\n\x0b\x61pi_version\x18\x01 \x01(\t\x12\x0c\n\x04kind\x18\x02 \x01(\t\x12\x14\n\nmatch_name\x18\x03 \x01(\tH\x00\x12\x43\n\x0cmatch_labels\x18\x04 \x01(\x0b\x32+.apiextensions.fn.proto.v1beta1.MatchLabelsH\x00\x42\x07\n\x05match\"\x85\x01\n\x0bMatchLabels\x12G\n\x06labels\x18\x01 \x03(\x0b\x32\x37.apiextensions.fn.proto.v1beta1.MatchLabels.LabelsEntry\x1a-\n\x0bLabelsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"P\n\x0cResponseMeta\x12\x0b\n\x03tag\x18\x01 \x01(\t\x12+\n\x03ttl\x18\x02 \x01(\x0b\x32\x19.google.protobuf.DurationH\x00\x88\x01\x01\x42\x06\n\x04_ttl\"\xe9\x01\n\x05State\x12;\n\tcomposite\x18\x01 \x01(\x0b\x32(.apiextensions.fn.proto.v1beta1.Resource\x12G\n\tresources\x18\x02 \x03(\x0b\x32\x34.apiextensions.fn.proto.v1beta1.State.ResourcesEntry\x1aZ\n\x0eResourcesEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\x37\n\x05value\x18\x02 \x01(\x0b\x32(.apiextensions.fn.proto.v1beta1.Resource:\x02\x38\x01\"\x82\x02\n\x08Resource\x12)\n\x08resource\x18\x01 \x01(\x0b\x32\x17.google.protobuf.Struct\x12[\n\x12\x63onnection_details\x18\x02 \x03(\x0b\x32?.apiextensions.fn.proto.v1beta1.Resource.ConnectionDetailsEntry\x12\x34\n\x05ready\x18\x03 \x01(\x0e\x32%.apiextensions.fn.proto.v1beta1.Ready\x1a\x38\n\x16\x43onnectionDetailsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\x0c:\x02\x38\x01\"U\n\x06Result\x12:\n\x08severity\x18\x01 \x01(\x0e\x32(.apiextensions.fn.proto.v1beta1.Severity\x12\x0f\n\x07message\x18\x02 \x01(\t*?\n\x05Ready\x12\x15\n\x11READY_UNSPECIFIED\x10\x00\x12\x0e\n\nREADY_TRUE\x10\x01\x12\x0f\n\x0bREADY_FALSE\x10\x02*c\n\x08Severity\x12\x18\n\x14SEVERITY_UNSPECIFIED\x10\x00\x12\x12\n\x0eSEVERITY_FATAL\x10\x01\x12\x14\n\x10SEVERITY_WARNING\x10\x02\x12\x13\n\x0fSEVERITY_NORMAL\x10\x03\x32\x91\x01\n\x15\x46unctionRunnerService\x12x\n\x0bRunFunction\x12\x32.apiextensions.fn.proto.v1beta1.RunFunctionRequest\x1a\x33.apiextensions.fn.proto.v1beta1.RunFunctionResponse\"\x00\x62\x06proto3')
-
-_globals = globals()
-_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
-_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'crossplane.function.proto.v1beta1.run_function_pb2', _globals)
-if _descriptor._USE_C_DESCRIPTORS == False:
-  DESCRIPTOR._options = None
-  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._options = None
-  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._serialized_options = b'8\001'
-  _globals['_REQUIREMENTS_EXTRARESOURCESENTRY']._options = None
-  _globals['_REQUIREMENTS_EXTRARESOURCESENTRY']._serialized_options = b'8\001'
-  _globals['_MATCHLABELS_LABELSENTRY']._options = None
-  _globals['_MATCHLABELS_LABELSENTRY']._serialized_options = b'8\001'
-  _globals['_STATE_RESOURCESENTRY']._options = None
-  _globals['_STATE_RESOURCESENTRY']._serialized_options = b'8\001'
-  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._options = None
-  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._serialized_options = b'8\001'
-  _globals['_READY']._serialized_start=2247
-  _globals['_READY']._serialized_end=2310
-  _globals['_SEVERITY']._serialized_start=2312
-  _globals['_SEVERITY']._serialized_end=2411
-  _globals['_RUNFUNCTIONREQUEST']._serialized_start=151
-  _globals['_RUNFUNCTIONREQUEST']._serialized_end=652
-  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._serialized_start=534
-  _globals['_RUNFUNCTIONREQUEST_EXTRARESOURCESENTRY']._serialized_end=630
-  _globals['_RESOURCES']._serialized_start=654
-  _globals['_RESOURCES']._serialized_end=722
-  _globals['_RUNFUNCTIONRESPONSE']._serialized_start=725
-  _globals['_RUNFUNCTIONRESPONSE']._serialized_end=1046
-  _globals['_REQUESTMETA']._serialized_start=1048
-  _globals['_REQUESTMETA']._serialized_end=1074
-  _globals['_REQUIREMENTS']._serialized_start=1077
-  _globals['_REQUIREMENTS']._serialized_end=1287
-  _globals['_REQUIREMENTS_EXTRARESOURCESENTRY']._serialized_start=1184
-  _globals['_REQUIREMENTS_EXTRARESOURCESENTRY']._serialized_end=1287
-  _globals['_RESOURCESELECTOR']._serialized_start=1290
-  _globals['_RESOURCESELECTOR']._serialized_end=1443
-  _globals['_MATCHLABELS']._serialized_start=1446
-  _globals['_MATCHLABELS']._serialized_end=1579
-  _globals['_MATCHLABELS_LABELSENTRY']._serialized_start=1534
-  _globals['_MATCHLABELS_LABELSENTRY']._serialized_end=1579
-  _globals['_RESPONSEMETA']._serialized_start=1581
-  _globals['_RESPONSEMETA']._serialized_end=1661
-  _globals['_STATE']._serialized_start=1664
-  _globals['_STATE']._serialized_end=1897
-  _globals['_STATE_RESOURCESENTRY']._serialized_start=1807
-  _globals['_STATE_RESOURCESENTRY']._serialized_end=1897
-  _globals['_RESOURCE']._serialized_start=1900
-  _globals['_RESOURCE']._serialized_end=2158
-  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._serialized_start=2102
-  _globals['_RESOURCE_CONNECTIONDETAILSENTRY']._serialized_end=2158
-  _globals['_RESULT']._serialized_start=2160
-  _globals['_RESULT']._serialized_end=2245
-  _globals['_FUNCTIONRUNNERSERVICE']._serialized_start=2414
-  _globals['_FUNCTIONRUNNERSERVICE']._serialized_end=2559
-# @@protoc_insertion_point(module_scope)