Add tests for new Spanner Graph snippets

bharadwajvr · bharadwajvr · commit b4cb3a2c70a5 · 2024-08-09T09:59:08.000-07:00
diff --git a/samples/samples/graph_snippets.py b/samples/samples/graph_snippets.py
@@ -30,8 +30,7 @@
 # [START spanner_create_database_with_property_graph]
 def create_database_with_property_graph(instance_id, database_id):
     """Creates a database, tables and a property graph for sample data."""
-    from google.cloud.spanner_admin_database_v1.types import \
-        spanner_database_admin
+    from google.cloud.spanner_admin_database_v1.types import spanner_database_admin
 
     spanner_client = spanner.Client()
     database_admin_api = spanner_client.database_admin_api
@@ -104,8 +103,7 @@ def create_database_with_property_graph(instance_id, database_id):
 def update_allow_commit_timestamps(instance_id, database_id):
     """Alters table column(s) to support commit timestamps."""
 
-    from google.cloud.spanner_admin_database_v1.types import \
-        spanner_database_admin
+    from google.cloud.spanner_admin_database_v1.types import spanner_database_admin
 
     spanner_client = spanner.Client()
     database_admin_api = spanner_client.database_admin_api
@@ -117,7 +115,8 @@ def update_allow_commit_timestamps(instance_id, database_id):
         statements=[
             """ALTER TABLE AccountTransferAccount
                  ALTER COLUMN create_time
-                 SET OPTIONS (allow_commit_timestamp = true)"""],
+                 SET OPTIONS (allow_commit_timestamp = true)"""
+        ],
     )
 
     operation = database_admin_api.update_database_ddl(request)
@@ -147,42 +146,42 @@ def insert_data(instance_id, database_id):
             table="Account",
             columns=("id", "create_time", "is_blocked", "nick_name"),
             values=[
-                (7, '2020-01-10T06:22:20.12Z', False, "Vacation Fund"),
-                (16, '2020-01-27T17:55:09.12Z', True, "Vacation Fund"),
-                (20, '2020-02-18T05:44:20.12Z', False, "Rainy Day Fund")
+                (7, "2020-01-10T06:22:20.12Z", False, "Vacation Fund"),
+                (16, "2020-01-27T17:55:09.12Z", True, "Vacation Fund"),
+                (20, "2020-02-18T05:44:20.12Z", False, "Rainy Day Fund"),
             ],
         )
 
         batch.insert(
             table="Person",
             columns=("id", "name", "birthday", "country", "city"),
             values=[
-                (1, "Alex", '1991-12-21T00:00:00.12Z', "Australia"," Adelaide"),
-                (2, "Dana", '1980-10-31T00:00:00.12Z',"Czech_Republic", "Moravia"),
-                (3, "Lee", '1986-12-07T00:00:00.12Z', "India", "Kollam")
+                (1, "Alex", "1991-12-21T00:00:00.12Z", "Australia", " Adelaide"),
+                (2, "Dana", "1980-10-31T00:00:00.12Z", "Czech_Republic", "Moravia"),
+                (3, "Lee", "1986-12-07T00:00:00.12Z", "India", "Kollam"),
             ],
         )
 
         batch.insert(
             table="AccountTransferAccount",
             columns=("id", "to_id", "amount", "create_time", "order_number"),
             values=[
-                (7, 16, 300.0, '2020-08-29T15:28:58.12Z', "304330008004315"),
-                (7, 16, 100.0, '2020-10-04T16:55:05.12Z', "304120005529714"),
-                (16, 20, 300.0, '2020-09-25T02:36:14.12Z', "103650009791820"),
-                (20, 7, 500.0, '2020-10-04T16:55:05.12Z', "304120005529714"),
-                (20, 16, 200.0, '2020-10-17T03:59:40.12Z', "302290001255747")
+                (7, 16, 300.0, "2020-08-29T15:28:58.12Z", "304330008004315"),
+                (7, 16, 100.0, "2020-10-04T16:55:05.12Z", "304120005529714"),
+                (16, 20, 300.0, "2020-09-25T02:36:14.12Z", "103650009791820"),
+                (20, 7, 500.0, "2020-10-04T16:55:05.12Z", "304120005529714"),
+                (20, 16, 200.0, "2020-10-17T03:59:40.12Z", "302290001255747"),
             ],
         )
 
         batch.insert(
             table="PersonOwnAccount",
             columns=("id", "account_id", "create_time"),
             values=[
-                (1, 7, '2020-01-10T06:22:20.12Z'),
-                (2, 20, '2020-01-27T17:55:09.12Z'),
-                (3, 16, '2020-02-18T05:44:20.12Z')
-            ]
+                (1, 7, "2020-01-10T06:22:20.12Z"),
+                (2, 20, "2020-01-27T17:55:09.12Z"),
+                (3, 16, "2020-02-18T05:44:20.12Z"),
+            ],
         )
 
     print("Inserted data.")
@@ -207,7 +206,7 @@ def insert_accounts(transaction):
             "INSERT INTO Account (id, create_time, is_blocked) "
             "  VALUES"
             "    (1, CAST('2000-08-10 08:18:48.463959-07:52' AS TIMESTAMP), false),"
-            "    (2, CAST('2000-08-12 08:18:48.463959-07:52' AS TIMESTAMP), true)"
+            "    (2, CAST('2000-08-12 07:13:16.463959-03:41' AS TIMESTAMP), true)"
         )
 
         print("{} record(s) inserted into Account.".format(row_ct))
@@ -216,8 +215,8 @@ def insert_transfers(transaction):
         row_ct = transaction.execute_update(
             "INSERT INTO AccountTransferAccount (id, to_id, create_time, amount) "
             "  VALUES"
-            "    (1, 2, PENDING_COMMIT_TIMESTAMP(), 100),"
-            "    (1, 1, PENDING_COMMIT_TIMESTAMP(), 200) "
+            "    (1, 2, CAST('2000-09-11 03:11:18.463959-06:36' AS TIMESTAMP), 100),"
+            "    (1, 1, CAST('2000-09-12 04:09:34.463959-05:12' AS TIMESTAMP), 200) "
         )
 
         print("{} record(s) inserted into AccountTransferAccount.".format(row_ct))
@@ -244,14 +243,14 @@ def update_accounts(transaction):
             "UPDATE Account SET is_blocked = false WHERE id = 2"
         )
 
-        print("{} record(s) updated.".format(row_ct))
+        print("{} Account record(s) updated.".format(row_ct))
 
     def update_transfers(transaction):
         row_ct = transaction.execute_update(
             "UPDATE AccountTransferAccount SET amount = 300 WHERE id = 1 AND to_id = 2"
         )
 
-        print("{} record(s) updated.".format(row_ct))
+        print("{} AccountTransferAccount record(s) updated.".format(row_ct))
 
     database.run_in_transaction(update_accounts)
     database.run_in_transaction(update_transfers)
@@ -279,7 +278,7 @@ def update_accounts(transaction):
             "  RETURN b.id}"
         )
 
-        print("{} record(s) updated.".format(row_ct))
+        print("{} Account record(s) updated.".format(row_ct))
 
     database.run_in_transaction(update_accounts)
 
@@ -351,14 +350,12 @@ def delete_transfers(transaction):
             "DELETE FROM AccountTransferAccount WHERE id = 1 AND to_id = 2"
         )
 
-        print("{} record(s) deleted.".format(row_ct))
+        print("{} AccountTransferAccount record(s) deleted.".format(row_ct))
 
     def delete_accounts(transaction):
-        row_ct = transaction.execute_update(
-            "DELETE FROM Account WHERE id = 2"
-        )
+        row_ct = transaction.execute_update("DELETE FROM Account WHERE id = 2")
 
-        print("{} record(s) deleted.".format(row_ct))
+        print("{} Account record(s) deleted.".format(row_ct))
 
     database.run_in_transaction(delete_transfers)
     database.run_in_transaction(delete_accounts)
@@ -415,14 +412,18 @@ def delete_data(instance_id, database_id):
     subparsers = parser.add_subparsers(dest="command")
     subparsers.add_parser(
         "create_database_with_property_graph",
-        help=create_database_with_property_graph.__doc__)
-    subparsers.add_parser("update_allow_commit_timestamps",
-                          help=update_allow_commit_timestamps.__doc__)
+        help=create_database_with_property_graph.__doc__,
+    )
+    subparsers.add_parser(
+        "update_allow_commit_timestamps", help=update_allow_commit_timestamps.__doc__
+    )
     subparsers.add_parser("insert_data", help=insert_data.__doc__)
     subparsers.add_parser("insert_data_with_dml", help=insert_data_with_dml.__doc__)
     subparsers.add_parser("update_data_with_dml", help=update_data_with_dml.__doc__)
-    subparsers.add_parser("update_data_with_graph_query_in_dml",
-                          help=update_data_with_graph_query_in_dml.__doc__)
+    subparsers.add_parser(
+        "update_data_with_graph_query_in_dml",
+        help=update_data_with_graph_query_in_dml.__doc__,
+    )
     subparsers.add_parser("query_data", help=query_data.__doc__)
     subparsers.add_parser(
         "query_data_with_parameter", help=query_data_with_parameter.__doc__
diff --git a/samples/samples/graph_snippets_test.py b/samples/samples/graph_snippets_test.py
@@ -0,0 +1,214 @@
+# Copyright 2024 Google, Inc.
+#
+# 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 time
+import uuid
+import pytest
+
+from google.api_core import exceptions
+
+from google.cloud import spanner
+from google.cloud.spanner_admin_database_v1.types.common import DatabaseDialect
+from test_utils.retry import RetryErrors
+
+import graph_snippets
+
+retry_429 = RetryErrors(exceptions.ResourceExhausted, delay=15)
+
+CREATE_TABLE_PERSON = """\
+CREATE TABLE Person (
+    id               INT64 NOT NULL,
+    name             STRING(MAX),
+    birthday         TIMESTAMP,
+    country          STRING(MAX),
+    city             STRING(MAX),
+) PRIMARY KEY (id)
+"""
+
+CREATE_TABLE_ACCOUNT = """\
+            CREATE TABLE Account (
+            id               INT64 NOT NULL,
+            create_time      TIMESTAMP,
+            is_blocked       BOOL,
+            nick_name        STRING(MAX),
+        ) PRIMARY KEY (id)
+"""
+
+CREATE_TABLE_PERSON_OWN_ACCOUNT = """\
+CREATE TABLE PersonOwnAccount (
+            id               INT64 NOT NULL,
+            account_id       INT64 NOT NULL,
+            create_time      TIMESTAMP,
+            FOREIGN KEY (account_id)
+                REFERENCES Account (id)
+        ) PRIMARY KEY (id, account_id),
+        INTERLEAVE IN PARENT Person ON DELETE CASCADE
+"""
+
+CREATE_TABLE_ACCOUNT_TRANSFER_ACCOUNT = """\
+CREATE TABLE AccountTransferAccount (
+            id               INT64 NOT NULL,
+            to_id            INT64 NOT NULL,
+            amount           FLOAT64,
+            create_time      TIMESTAMP NOT NULL,
+            order_number     STRING(MAX),
+            FOREIGN KEY (to_id) REFERENCES Account (id)
+        ) PRIMARY KEY (id, to_id, create_time),
+        INTERLEAVE IN PARENT Account ON DELETE CASCADE
+"""
+
+CREATE_PROPERTY_GRAPH = """
+CREATE OR REPLACE PROPERTY GRAPH FinGraph
+            NODE TABLES (Account, Person)
+            EDGE TABLES (
+                PersonOwnAccount
+                    SOURCE KEY(id) REFERENCES Person(id)
+                    DESTINATION KEY(account_id) REFERENCES Account(id)
+                    LABEL Owns,
+                AccountTransferAccount
+                    SOURCE KEY(id) REFERENCES Account(id)
+                    DESTINATION KEY(to_id) REFERENCES Account(id)
+                    LABEL Transfers)
+"""
+
+
+@pytest.fixture(scope="module")
+def sample_name():
+    return "snippets"
+
+
+@pytest.fixture(scope="module")
+def database_dialect():
+    """Spanner dialect to be used for this sample.
+
+    The dialect is used to initialize the dialect for the database.
+    It can either be GoogleStandardSql or PostgreSql.
+    """
+    return DatabaseDialect.GOOGLE_STANDARD_SQL
+
+
+@pytest.fixture(scope="module")
+def database_id():
+    return f"test-db-{uuid.uuid4().hex[:10]}"
+
+
+@pytest.fixture(scope="module")
+def create_database_id():
+    return f"create-db-{uuid.uuid4().hex[:10]}"
+
+
+@pytest.fixture(scope="module")
+def database_ddl():
+    """Sequence of DDL statements used to set up the database.
+
+    Sample testcase modules can override as needed.
+    """
+    return [
+        CREATE_TABLE_PERSON,
+        CREATE_TABLE_ACCOUNT,
+        CREATE_TABLE_PERSON_OWN_ACCOUNT,
+        CREATE_TABLE_ACCOUNT_TRANSFER_ACCOUNT,
+        CREATE_PROPERTY_GRAPH,
+    ]
+
+
+def test_create_database_explicit(sample_instance, create_database_id):
+    graph_snippets.create_database_with_property_graph(
+        sample_instance.instance_id, create_database_id
+    )
+    database = sample_instance.database(create_database_id)
+    database.drop()
+
+
+@pytest.mark.dependency(name="insert_data")
+def test_insert_data(capsys, instance_id, sample_database):
+    graph_snippets.insert_data(instance_id, sample_database.database_id)
+    out, _ = capsys.readouterr()
+    assert "Inserted data" in out
+
+
+@pytest.mark.dependency(depends=["insert_data"])
+def test_query_data(capsys, instance_id, sample_database):
+    graph_snippets.query_data(instance_id, sample_database.database_id)
+    out, _ = capsys.readouterr()
+    assert (
+        "sender: Dana, receiver: Alex, amount: 500.0, transfer_at: 2020-10-04 16:55:05.120000+00:00"
+        in out
+    )
+    assert (
+        "sender: Lee, receiver: Dana, amount: 300.0, transfer_at: 2020-09-25 02:36:14.120000+00:00"
+        in out
+    )
+    assert (
+        "sender: Alex, receiver: Lee, amount: 300.0, transfer_at: 2020-08-29 15:28:58.120000+00:00"
+        in out
+    )
+    assert (
+        "sender: Alex, receiver: Lee, amount: 100.0, transfer_at: 2020-10-04 16:55:05.120000+00:00"
+        in out
+    )
+    assert (
+        "sender: Dana, receiver: Lee, amount: 200.0, transfer_at: 2020-10-17 03:59:40.120000+00:00"
+        in out
+    )
+
+
+@pytest.mark.dependency(depends=["insert_data"])
+def test_query_data_with_parameter(capsys, instance_id, sample_database):
+    graph_snippets.query_data_with_parameter(instance_id, sample_database.database_id)
+    out, _ = capsys.readouterr()
+    assert (
+        "sender: Dana, receiver: Alex, amount: 500.0, transfer_at: 2020-10-04 16:55:05.120000+00:00"
+        in out
+    )
+
+
+@pytest.mark.dependency(name="insert_data_with_dml", depends=["insert_data"])
+def test_insert_data_with_dml(capsys, instance_id, sample_database):
+    graph_snippets.insert_data_with_dml(instance_id, sample_database.database_id)
+    out, _ = capsys.readouterr()
+    assert "2 record(s) inserted into Account." in out
+    assert "2 record(s) inserted into AccountTransferAccount." in out
+
+
+@pytest.mark.dependency(name="update_data_with_dml", depends=["insert_data_with_dml"])
+def test_update_data_with_dml(capsys, instance_id, sample_database):
+    graph_snippets.update_data_with_dml(instance_id, sample_database.database_id)
+    out, _ = capsys.readouterr()
+    assert "1 Account record(s) updated." in out
+    assert "1 AccountTransferAccount record(s) updated." in out
+
+
+@pytest.mark.dependency(depends=["update_data_with_dml"])
+def test_update_data_with_graph_query_in_dml(capsys, instance_id, sample_database):
+    graph_snippets.update_data_with_graph_query_in_dml(
+        instance_id, sample_database.database_id
+    )
+    out, _ = capsys.readouterr()
+    assert "2 Account record(s) updated." in out
+
+
+@pytest.mark.dependency(depends=["update_data_with_dml"])
+def test_delete_data_with_graph_query_in_dml(capsys, instance_id, sample_database):
+    graph_snippets.delete_data_with_dml(instance_id, sample_database.database_id)
+    out, _ = capsys.readouterr()
+    assert "1 AccountTransferAccount record(s) deleted." in out
+    assert "1 Account record(s) deleted." in out
+
+
+@pytest.mark.dependency(depends=["insert_data"])
+def test_delete_data_with_graph_query_in_dml(capsys, instance_id, sample_database):
+    graph_snippets.delete_data(instance_id, sample_database.database_id)
+    out, _ = capsys.readouterr()
+    assert "Deleted data." in out
