Experimental cloud operations client

Fixes #522
temporalio · Jul 3, 2024 · 7ab59b5 · 7ab59b5
1 parent 38d9eef
commit 7ab59b5
Show file tree

Hide file tree

Showing 37 changed files with 7,790 additions and 7 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -18,6 +18,7 @@ jobs:
           - os: ubuntu-latest
             python: "3.12"
             docsTarget: true
+            cloudTestTarget: true
           - os: ubuntu-latest
             python: "3.8"
             protoCheckTarget: true
@@ -68,6 +69,13 @@ jobs:
       # Time skipping doesn't yet support ARM
       - if: ${{ !endsWith(matrix.os, '-arm') }}
         run: poe test -s -o log_cli_level=DEBUG --workflow-environment time-skipping
+      # Check cloud if proper target and not on fork
+      - if: ${{ matrix.cloudCheckTarget && (github.event.pull_request.head.repo.full_name == '' || github.event.pull_request.head.repo.full_name == 'temporalio/sdk-python') }}
+        run: poe test -s -o log_cli_level=DEBUG -k test_cloud_client
+        env:
+          TEMPORAL_CLIENT_CLOUD_API_KEY: ${{ secrets.TEMPORAL_CLIENT_CLOUD_API_KEY }}
+          TEMPORAL_CLIENT_CLOUD_API_VERSION: 2024-05-13-00
+          TEMPORAL_CLIENT_CLOUD_NAMESPACE: sdk-ci.a2dd6
 
       # Confirm protos are already generated properly with older protobuf
       # library and run test with that older version. We must downgrade protobuf

diff --git a/README.md b/README.md
@@ -1475,8 +1475,8 @@ protobuf code, you must be on Python <= 3.10, and then run `poetry add "protobuf
 generated via `poe gen-protos`. Tests can be run for protobuf version 3 by setting the `TEMPORAL_TEST_PROTO3` env var
 to `1` prior to running tests.
 
-Do not commit `poetry.lock` or `pyproject.toml` changes. To go back from this downgrade, restore `pyproject.toml` and
-run `poetry update protobuf grpcio-tools`.
+Do not commit `poetry.lock` or `pyproject.toml` changes. To go back from this downgrade, restore both of those files
+and run `poetry install --no-root --all extras`.
 
 For a less system-intrusive approach, you can (note this approach [may have a bug](https://github.com/temporalio/sdk-python/issues/543)):
 ```shell

diff --git a/scripts/gen_protos.py b/scripts/gen_protos.py
@@ -13,6 +13,7 @@
     base_dir / "temporalio" / "bridge" / "sdk-core" / "sdk-core-protos" / "protos"
 )
 api_proto_dir = proto_dir / "api_upstream"
+api_cloud_proto_dir = proto_dir / "api_cloud_upstream"
 core_proto_dir = proto_dir / "local"
 testsrv_proto_dir = proto_dir / "testsrv_upstream"
 test_proto_dir = base_dir / "tests"
@@ -155,6 +156,7 @@ def generate_protos(output_dir: Path):
             sys.executable,
             "-mgrpc_tools.protoc",
             f"--proto_path={api_proto_dir}",
+            f"--proto_path={api_cloud_proto_dir}",
             f"--proto_path={core_proto_dir}",
             f"--proto_path={testsrv_proto_dir}",
             f"--proto_path={health_proto_dir}",

diff --git a/temporalio/api/cloud/__init__.py b/temporalio/api/cloud/__init__.py
diff --git a/temporalio/api/cloud/cloudservice/__init__.py b/temporalio/api/cloud/cloudservice/__init__.py
diff --git a/temporalio/api/cloud/cloudservice/v1/__init__.py b/temporalio/api/cloud/cloudservice/v1/__init__.py
@@ -0,0 +1,157 @@
+from .request_response_pb2 import (
+    AddNamespaceRegionRequest,
+    AddNamespaceRegionResponse,
+    CreateApiKeyRequest,
+    CreateApiKeyResponse,
+    CreateNamespaceRequest,
+    CreateNamespaceResponse,
+    CreateServiceAccountRequest,
+    CreateServiceAccountResponse,
+    CreateUserGroupRequest,
+    CreateUserGroupResponse,
+    CreateUserRequest,
+    CreateUserResponse,
+    DeleteApiKeyRequest,
+    DeleteApiKeyResponse,
+    DeleteNamespaceRequest,
+    DeleteNamespaceResponse,
+    DeleteServiceAccountRequest,
+    DeleteServiceAccountResponse,
+    DeleteUserGroupRequest,
+    DeleteUserGroupResponse,
+    DeleteUserRequest,
+    DeleteUserResponse,
+    FailoverNamespaceRegionRequest,
+    FailoverNamespaceRegionResponse,
+    GetApiKeyRequest,
+    GetApiKeyResponse,
+    GetApiKeysRequest,
+    GetApiKeysResponse,
+    GetAsyncOperationRequest,
+    GetAsyncOperationResponse,
+    GetNamespaceRequest,
+    GetNamespaceResponse,
+    GetNamespacesRequest,
+    GetNamespacesResponse,
+    GetRegionRequest,
+    GetRegionResponse,
+    GetRegionsRequest,
+    GetRegionsResponse,
+    GetServiceAccountRequest,
+    GetServiceAccountResponse,
+    GetServiceAccountsRequest,
+    GetServiceAccountsResponse,
+    GetUserGroupRequest,
+    GetUserGroupResponse,
+    GetUserGroupsRequest,
+    GetUserGroupsResponse,
+    GetUserRequest,
+    GetUserResponse,
+    GetUsersRequest,
+    GetUsersResponse,
+    RenameCustomSearchAttributeRequest,
+    RenameCustomSearchAttributeResponse,
+    SetUserGroupNamespaceAccessRequest,
+    SetUserGroupNamespaceAccessResponse,
+    SetUserNamespaceAccessRequest,
+    SetUserNamespaceAccessResponse,
+    UpdateApiKeyRequest,
+    UpdateApiKeyResponse,
+    UpdateNamespaceRequest,
+    UpdateNamespaceResponse,
+    UpdateServiceAccountRequest,
+    UpdateServiceAccountResponse,
+    UpdateUserGroupRequest,
+    UpdateUserGroupResponse,
+    UpdateUserRequest,
+    UpdateUserResponse,
+)
+
+__all__ = [
+    "AddNamespaceRegionRequest",
+    "AddNamespaceRegionResponse",
+    "CreateApiKeyRequest",
+    "CreateApiKeyResponse",
+    "CreateNamespaceRequest",
+    "CreateNamespaceResponse",
+    "CreateServiceAccountRequest",
+    "CreateServiceAccountResponse",
+    "CreateUserGroupRequest",
+    "CreateUserGroupResponse",
+    "CreateUserRequest",
+    "CreateUserResponse",
+    "DeleteApiKeyRequest",
+    "DeleteApiKeyResponse",
+    "DeleteNamespaceRequest",
+    "DeleteNamespaceResponse",
+    "DeleteServiceAccountRequest",
+    "DeleteServiceAccountResponse",
+    "DeleteUserGroupRequest",
+    "DeleteUserGroupResponse",
+    "DeleteUserRequest",
+    "DeleteUserResponse",
+    "FailoverNamespaceRegionRequest",
+    "FailoverNamespaceRegionResponse",
+    "GetApiKeyRequest",
+    "GetApiKeyResponse",
+    "GetApiKeysRequest",
+    "GetApiKeysResponse",
+    "GetAsyncOperationRequest",
+    "GetAsyncOperationResponse",
+    "GetNamespaceRequest",
+    "GetNamespaceResponse",
+    "GetNamespacesRequest",
+    "GetNamespacesResponse",
+    "GetRegionRequest",
+    "GetRegionResponse",
+    "GetRegionsRequest",
+    "GetRegionsResponse",
+    "GetServiceAccountRequest",
+    "GetServiceAccountResponse",
+    "GetServiceAccountsRequest",
+    "GetServiceAccountsResponse",
+    "GetUserGroupRequest",
+    "GetUserGroupResponse",
+    "GetUserGroupsRequest",
+    "GetUserGroupsResponse",
+    "GetUserRequest",
+    "GetUserResponse",
+    "GetUsersRequest",
+    "GetUsersResponse",
+    "RenameCustomSearchAttributeRequest",
+    "RenameCustomSearchAttributeResponse",
+    "SetUserGroupNamespaceAccessRequest",
+    "SetUserGroupNamespaceAccessResponse",
+    "SetUserNamespaceAccessRequest",
+    "SetUserNamespaceAccessResponse",
+    "UpdateApiKeyRequest",
+    "UpdateApiKeyResponse",
+    "UpdateNamespaceRequest",
+    "UpdateNamespaceResponse",
+    "UpdateServiceAccountRequest",
+    "UpdateServiceAccountResponse",
+    "UpdateUserGroupRequest",
+    "UpdateUserGroupResponse",
+    "UpdateUserRequest",
+    "UpdateUserResponse",
+]
+
+# gRPC is optional
+try:
+    import grpc
+
+    from .service_pb2_grpc import (
+        CloudServiceServicer,
+        CloudServiceStub,
+        add_CloudServiceServicer_to_server,
+    )
+
+    __all__.extend(
+        [
+            "CloudServiceServicer",
+            "CloudServiceStub",
+            "add_CloudServiceServicer_to_server",
+        ]
+    )
+except ImportError:
+    pass