chore: migrate code from googleapis/python-datastore

datastore/samples/snippets/requirements-test.txt

@@ -0,0 +1,7 @@
+backoff===1.11.1; python_version < "3.7"
+backoff==2.2.1; python_version >= "3.7"
+pytest===7.4.3; python_version == '3.7'
+pytest===8.3.5; python_version == '3.8'
+pytest===8.4.2; python_version == '3.9'
+pytest==9.0.2; python_version >= '3.10'
+flaky==3.8.1

datastore/samples/snippets/requirements.txt

@@ -0,0 +1 @@
+google-cloud-datastore==2.23.0

datastore/samples/snippets/schedule-export/README.md

@@ -0,0 +1,5 @@
+# Scheduling Datastore exports with Cloud Functions and Cloud Scheduler
+
+This sample application demonstrates how to schedule exports of your Datastore entities. To deploy this sample, see:
+
+[Scheduling exports](https://cloud.google.com/datastore/docs/schedule-export)

datastore/samples/snippets/schedule-export/main.py

@@ -0,0 +1,57 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import base64
+import json
+import os
+
+from google.cloud import datastore_admin_v1
+
+project_id = os.environ.get("GCP_PROJECT")
+client = datastore_admin_v1.DatastoreAdminClient()
+
+
+def datastore_export(event, context):
+    """Triggers a Datastore export from a Cloud Scheduler job.
+
+    Args:
+        event (dict): event[data] must contain a json object encoded in
+            base-64. Cloud Scheduler encodes payloads in base-64 by default.
+            Object must include a 'bucket' value and can include 'kinds'
+            and 'namespaceIds' values.
+        context (google.cloud.functions.Context): The Cloud Functions event
+            metadata.
+    """
+    if "data" in event:
+        # Triggered via Cloud Scheduler, decode the inner data field of the json payload.
+        json_data = json.loads(base64.b64decode(event["data"]).decode("utf-8"))
+    else:
+        # Otherwise, for instance if triggered via the Cloud Console on a Cloud Function, the event is the data.
+        json_data = event
+
+    bucket = json_data["bucket"]
+    entity_filter = datastore_admin_v1.EntityFilter()
+
+    if "kinds" in json_data:
+        entity_filter.kinds = json_data["kinds"]
+
+    if "namespaceIds" in json_data:
+        entity_filter.namespace_ids = json_data["namespaceIds"]
+
+    export_request = datastore_admin_v1.ExportEntitiesRequest(
+        project_id=project_id, output_url_prefix=bucket, entity_filter=entity_filter
+    )
+    operation = client.export_entities(request=export_request)
+    response = operation.result()
+    print(response)

datastore/samples/snippets/schedule-export/requirements-test.txt

@@ -0,0 +1,2 @@
+pytest===8.4.2; python_version == '3.9'
+pytest==9.0.2; python_version >= '3.10'

datastore/samples/snippets/schedule-export/requirements.txt

@@ -0,0 +1 @@
+google-cloud-datastore==2.23.0

datastore/samples/snippets/schedule-export/schedule_export_test.py

@@ -0,0 +1,73 @@
+# Copyright 2019 Google LLC All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import base64
+from unittest.mock import Mock
+
+import main
+
+mock_context = Mock()
+mock_context.event_id = "617187464135194"
+mock_context.timestamp = "2020-04-15T22:09:03.761Z"
+
+
+def test_datastore_export(capsys):
+    # Test an export without an entity filter
+    bucket = "gs://my-bucket"
+    json_string = '{{ "bucket": "{bucket}" }}'.format(bucket=bucket)
+
+    # Encode data like Cloud Scheduler
+    data = bytes(json_string, "utf-8")
+    data_encoded = base64.b64encode(data)
+    event = {"data": data_encoded}
+
+    # Mock the Datastore service
+    mockDatastore = Mock()
+    main.client = mockDatastore
+
+    # Call tested function
+    main.datastore_export(event, mock_context)
+    out, err = capsys.readouterr()
+    export_args = mockDatastore.export_entities.call_args[1]
+    # Assert request includes test values
+    assert export_args["request"].output_url_prefix == bucket
+
+
+def test_datastore_export_entity_filter(capsys):
+    # Test an export with an entity filter
+    bucket = "gs://my-bucket"
+    kinds = "Users,Tasks"
+    namespaceIds = "Customer831,Customer157"
+    json_string = '{{ "bucket": "{bucket}", "kinds": "{kinds}", "namespaceIds": "{namespaceIds}" }}'.format(
+        bucket=bucket, kinds=kinds, namespaceIds=namespaceIds
+    )
+
+    # Encode data like Cloud Scheduler
+    data = bytes(json_string, "utf-8")
+    data_encoded = base64.b64encode(data)
+    event = {"data": data_encoded}
+
+    # Mock the Datastore service
+    mockDatastore = Mock()
+    main.client = mockDatastore
+
+    # Call tested function
+    main.datastore_export(event, mock_context)
+    out, err = capsys.readouterr()
+    export_args = mockDatastore.export_entities.call_args[1]
+    # Assert request includes test values
+
+    assert export_args["request"].output_url_prefix == bucket
+    assert export_args["request"].entity_filter.kinds == kinds
+    assert export_args["request"].entity_filter.namespace_ids == namespaceIds