tests: refactor systests to use pytest fixtures / idioms (#210)

Use pytest fixtures / idioms, rather than legacy setup / teardown.

Also, remove fossilized doctest setup code:

Closes #208.

Author: tseaver

packages/google-cloud-datastore/google/cloud/datastore/client.py

@@ -784,28 +784,6 @@ def do_something(entity):
 
         or manually page through results
 
-        .. testsetup:: query-page
-
-            import os
-            import uuid
-
-            from google.cloud import datastore
-            from tests.system.test_system import Config  # system tests
-
-            unique = os.getenv('CIRCLE_BUILD_NUM', str(uuid.uuid4())[0:8])
-            client = datastore.Client(namespace='ns{}'.format(unique))
-
-            key = client.key('_Doctest')
-            entity1 = datastore.Entity(key=key)
-            entity1['foo'] = 1337
-            entity2 = datastore.Entity(key=key)
-            entity2['foo'] = 42
-            Config.TO_DELETE.extend([entity1, entity2])
-            client.put_multi([entity1, entity2])
-
-            query = client.query(kind='_Doctest')
-            cursor = None
-
         .. doctest:: query-page
 
             >>> query_iter = query.fetch(start_cursor=cursor)

packages/google-cloud-datastore/google/cloud/datastore/entity.py

@@ -40,23 +40,6 @@ class Entity(dict):
     Use :meth:`~google.cloud.datastore.client.Client.get` to retrieve an
     existing entity:
 
-    .. testsetup:: entity-ctor
-
-        import os
-        import uuid
-
-        from google.cloud import datastore
-        from tests.system.test_system import Config  # system tests
-
-        unique = os.getenv('CIRCLE_BUILD_NUM', str(uuid.uuid4())[0:8])
-        client = datastore.Client(namespace='ns{}'.format(unique))
-        key = client.key('EntityKind', 1234, namespace='_Doctest')
-        entity = datastore.Entity(key=key)
-        entity['property'] = 'value'
-        Config.TO_DELETE.append(entity)
-
-        client.put(entity)
-
     .. doctest:: entity-ctor
 
         >>> client.get(key)

packages/google-cloud-datastore/google/cloud/datastore/transaction.py

@@ -41,26 +41,6 @@ class Transaction(Batch):
     operations (either ``insert`` or ``upsert``) into the same
     mutation, and execute those within a transaction:
 
-    .. testsetup:: txn-put-multi, txn-api
-
-        import os
-        import uuid
-
-        from google.cloud import datastore
-        from tests.system.test_system import Config  # system tests
-
-        unique = os.getenv('CIRCLE_BUILD_NUM', str(uuid.uuid4())[0:8])
-        client = datastore.Client(namespace='ns{}'.format(unique))
-        key1 = client.key('_Doctest')
-        entity1 = datastore.Entity(key=key1)
-        entity1['foo'] = 1337
-
-        key2 = client.key('_Doctest', 'abcd1234')
-        entity2 = datastore.Entity(key=key2)
-        entity2['foo'] = 42
-
-        Config.TO_DELETE.extend([entity1, entity2])
-
     .. doctest:: txn-put-multi
 
         >>> with client.transaction():
@@ -112,22 +92,6 @@ class SomeException(Exception):
         entities will not be available at save time!  That means, if you
         try:
 
-        .. testsetup:: txn-entity-key, txn-entity-key-after, txn-manual
-
-            import os
-            import uuid
-
-            from google.cloud import datastore
-            from tests.system.test_system import Config  # system tests
-
-            unique = os.getenv('CIRCLE_BUILD_NUM', str(uuid.uuid4())[0:8])
-            client = datastore.Client(namespace='ns{}'.format(unique))
-
-            def Entity(*args, **kwargs):
-                entity = datastore.Entity(*args, **kwargs)
-                Config.TO_DELETE.append(entity)
-                return entity
-
         .. doctest:: txn-entity-key
 
             >>> with client.transaction():

packages/google-cloud-datastore/tests/system/_helpers.py

@@ -0,0 +1,44 @@
+# 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 os
+
+from google.cloud import datastore
+from google.cloud.datastore.client import DATASTORE_DATASET
+from test_utils.system import unique_resource_id
+
+EMULATOR_DATASET = os.getenv(DATASTORE_DATASET)
+
+
+def unique_id(prefix, separator="-"):
+    return f"{prefix}{unique_resource_id(separator)}"
+
+
+_SENTINEL = object()
+
+
+def clone_client(base_client, namespace=_SENTINEL):
+    if namespace is _SENTINEL:
+        namespace = base_client.namespace
+
+    kwargs = {}
+    if EMULATOR_DATASET is None:
+        kwargs["credentials"] = base_client._credentials
+
+    return datastore.Client(
+        project=base_client.project,
+        namespace=namespace,
+        _http=base_client._http,
+        **kwargs,
+    )

packages/google-cloud-datastore/tests/system/conftest.py

@@ -0,0 +1,50 @@
+# 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 pytest
+import requests
+
+from google.cloud import datastore
+from . import _helpers
+
+
+@pytest.fixture(scope="session")
+def in_emulator():
+    return _helpers.EMULATOR_DATASET is not None
+
+
+@pytest.fixture(scope="session")
+def test_namespace():
+    return _helpers.unique_id("ns")
+
+
+@pytest.fixture(scope="session")
+def datastore_client(test_namespace):
+    if _helpers.EMULATOR_DATASET is not None:
+        http = requests.Session()  # Un-authorized.
+        return datastore.Client(
+            project=_helpers.EMULATOR_DATASET, namespace=test_namespace, _http=http,
+        )
+    else:
+        return datastore.Client(namespace=test_namespace)
+
+
+@pytest.fixture(scope="function")
+def entities_to_delete(datastore_client):
+    entities_to_delete = []
+
+    yield entities_to_delete
+
+    with datastore_client.transaction():
+        datastore_client.delete_multi(entities_to_delete)

packages/google-cloud-datastore/tests/system/test_allocate_reserve_ids.py

@@ -0,0 +1,61 @@
+# Copyright 2011 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 warnings
+
+
+def test_client_allocate_ids(datastore_client):
+    num_ids = 10
+    allocated_keys = datastore_client.allocate_ids(
+        datastore_client.key("Kind"), num_ids,
+    )
+    assert len(allocated_keys) == num_ids
+
+    unique_ids = set()
+    for key in allocated_keys:
+        unique_ids.add(key.id)
+        assert key.name is None
+        assert key.id is not None
+
+    assert len(unique_ids) == num_ids
+
+
+def test_client_reserve_ids_sequential(datastore_client):
+    num_ids = 10
+    key = datastore_client.key("Kind", 1234)
+
+    # Smoke test to make sure it doesn't blow up. No return value or
+    # verifiable side effect to verify.
+    datastore_client.reserve_ids_sequential(key, num_ids)
+
+
+def test_client_reserve_ids_deprecated(datastore_client):
+    num_ids = 10
+    key = datastore_client.key("Kind", 1234)
+
+    with warnings.catch_warnings(record=True) as warned:
+        datastore_client.reserve_ids(key, num_ids)
+
+    assert len(warned) == 1
+    assert warned[0].category is DeprecationWarning
+    assert "reserve_ids_sequential" in str(warned[0].message)
+
+
+def test_client_reserve_ids_multi(datastore_client):
+    key1 = datastore_client.key("Kind", 1234)
+    key2 = datastore_client.key("Kind", 1235)
+
+    # Smoke test to make sure it doesn't blow up. No return value or
+    # verifiable side effect to verify.
+    datastore_client.reserve_ids_multi([key1, key2])