2016-01-06 23:26:29 -05:00
|
|
|
# Copyright 2014-2016 OpenMarket Ltd
|
2014-08-12 22:32:18 -04:00
|
|
|
#
|
|
|
|
# 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.
|
|
|
|
|
2018-07-09 02:09:20 -04:00
|
|
|
from collections import OrderedDict
|
2022-12-09 12:36:32 -05:00
|
|
|
from typing import Generator
|
2023-11-07 09:34:23 -05:00
|
|
|
from unittest.mock import Mock, call, patch
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2018-07-09 02:09:20 -04:00
|
|
|
from twisted.internet import defer
|
2014-08-12 10:10:52 -04:00
|
|
|
|
|
|
|
from synapse.storage._base import SQLBaseStore
|
2020-08-05 16:38:57 -04:00
|
|
|
from synapse.storage.database import DatabasePool
|
2015-04-01 09:12:33 -04:00
|
|
|
from synapse.storage.engines import create_engine
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2018-07-09 02:09:20 -04:00
|
|
|
from tests import unittest
|
2021-12-21 11:12:05 -05:00
|
|
|
from tests.server import TestHomeServer
|
2023-11-07 09:34:23 -05:00
|
|
|
from tests.utils import USE_POSTGRES_FOR_TESTS, default_config
|
2018-07-09 02:09:20 -04:00
|
|
|
|
2014-08-12 10:10:52 -04:00
|
|
|
|
|
|
|
class SQLBaseStoreTestCase(unittest.TestCase):
|
2021-06-17 10:20:06 -04:00
|
|
|
"""Test the "simple" SQL generating methods in SQLBaseStore."""
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2022-12-09 12:36:32 -05:00
|
|
|
def setUp(self) -> None:
|
2023-11-07 09:34:23 -05:00
|
|
|
# This is the Twisted connection pool.
|
|
|
|
conn_pool = Mock(spec=["runInteraction", "runWithConnection"])
|
2014-08-12 10:10:52 -04:00
|
|
|
self.mock_txn = Mock()
|
2023-11-07 09:34:23 -05:00
|
|
|
if USE_POSTGRES_FOR_TESTS:
|
|
|
|
# To avoid testing psycopg2 itself, patch execute_batch/execute_values
|
|
|
|
# to assert how it is called.
|
|
|
|
from psycopg2 import extras
|
|
|
|
|
|
|
|
self.mock_execute_batch = Mock()
|
|
|
|
self.execute_batch_patcher = patch.object(
|
|
|
|
extras, "execute_batch", new=self.mock_execute_batch
|
|
|
|
)
|
|
|
|
self.execute_batch_patcher.start()
|
|
|
|
self.mock_execute_values = Mock()
|
|
|
|
self.execute_values_patcher = patch.object(
|
|
|
|
extras, "execute_values", new=self.mock_execute_values
|
|
|
|
)
|
|
|
|
self.execute_values_patcher.start()
|
|
|
|
|
|
|
|
self.mock_conn = Mock(
|
|
|
|
spec_set=[
|
|
|
|
"cursor",
|
|
|
|
"rollback",
|
|
|
|
"commit",
|
|
|
|
"closed",
|
|
|
|
"reconnect",
|
|
|
|
"set_session",
|
|
|
|
"encoding",
|
|
|
|
]
|
|
|
|
)
|
|
|
|
self.mock_conn.encoding = "UNICODE"
|
|
|
|
else:
|
|
|
|
self.mock_conn = Mock(spec_set=["cursor", "rollback", "commit"])
|
2015-04-08 11:57:14 -04:00
|
|
|
self.mock_conn.cursor.return_value = self.mock_txn
|
2023-11-07 09:34:23 -05:00
|
|
|
self.mock_txn.connection = self.mock_conn
|
2015-05-15 05:54:04 -04:00
|
|
|
self.mock_conn.rollback.return_value = None
|
2014-08-12 10:10:52 -04:00
|
|
|
# Our fake runInteraction just runs synchronously inline
|
|
|
|
|
2022-12-09 12:36:32 -05:00
|
|
|
def runInteraction(func, *args, **kwargs) -> defer.Deferred: # type: ignore[no-untyped-def]
|
2014-08-12 10:10:52 -04:00
|
|
|
return defer.succeed(func(self.mock_txn, *args, **kwargs))
|
2018-08-10 09:54:09 -04:00
|
|
|
|
2023-11-07 09:34:23 -05:00
|
|
|
conn_pool.runInteraction = runInteraction
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2022-12-09 12:36:32 -05:00
|
|
|
def runWithConnection(func, *args, **kwargs): # type: ignore[no-untyped-def]
|
2015-04-08 11:57:14 -04:00
|
|
|
return defer.succeed(func(self.mock_conn, *args, **kwargs))
|
2018-08-10 09:54:09 -04:00
|
|
|
|
2023-11-07 09:34:23 -05:00
|
|
|
conn_pool.runWithConnection = runWithConnection
|
2015-04-08 11:57:14 -04:00
|
|
|
|
2020-07-08 12:51:56 -04:00
|
|
|
config = default_config(name="test", parse=True)
|
2019-12-18 05:45:12 -05:00
|
|
|
hs = TestHomeServer("test", config=config)
|
|
|
|
|
2023-11-07 09:34:23 -05:00
|
|
|
if USE_POSTGRES_FOR_TESTS:
|
|
|
|
db_config = {"name": "psycopg2", "args": {}}
|
|
|
|
else:
|
|
|
|
db_config = {"name": "sqlite3"}
|
|
|
|
engine = create_engine(db_config)
|
|
|
|
|
2019-01-28 10:43:32 -05:00
|
|
|
fake_engine = Mock(wraps=engine)
|
2020-10-07 10:15:57 -04:00
|
|
|
fake_engine.in_transaction.return_value = False
|
2023-11-07 09:34:23 -05:00
|
|
|
fake_engine.module.OperationalError = engine.module.OperationalError
|
|
|
|
fake_engine.module.DatabaseError = engine.module.DatabaseError
|
|
|
|
fake_engine.module.IntegrityError = engine.module.IntegrityError
|
|
|
|
# Don't convert param style to make assertions easier.
|
|
|
|
fake_engine.convert_param_style = lambda sql: sql
|
|
|
|
# To fix isinstance(...) checks.
|
|
|
|
fake_engine.__class__ = engine.__class__ # type: ignore[assignment]
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2023-11-07 09:34:23 -05:00
|
|
|
db = DatabasePool(Mock(), Mock(config=db_config), fake_engine)
|
|
|
|
db._db_pool = conn_pool
|
2019-12-18 05:45:12 -05:00
|
|
|
|
2022-05-23 07:23:26 -04:00
|
|
|
self.datastore = SQLBaseStore(db, None, hs) # type: ignore[arg-type]
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2023-11-07 09:34:23 -05:00
|
|
|
def tearDown(self) -> None:
|
|
|
|
if USE_POSTGRES_FOR_TESTS:
|
|
|
|
self.execute_batch_patcher.stop()
|
|
|
|
self.execute_values_patcher.stop()
|
|
|
|
|
2014-08-12 10:10:52 -04:00
|
|
|
@defer.inlineCallbacks
|
2022-12-09 12:36:32 -05:00
|
|
|
def test_insert_1col(self) -> Generator["defer.Deferred[object]", object, None]:
|
2014-08-12 10:10:52 -04:00
|
|
|
self.mock_txn.rowcount = 1
|
|
|
|
|
2020-08-17 12:18:01 -04:00
|
|
|
yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_insert(
|
|
|
|
table="tablename", values={"columname": "Value"}
|
|
|
|
)
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
2023-11-07 09:34:23 -05:00
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
2016-02-19 10:34:38 -05:00
|
|
|
"INSERT INTO tablename (columname) VALUES(?)", ("Value",)
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
2022-12-09 12:36:32 -05:00
|
|
|
def test_insert_3cols(self) -> Generator["defer.Deferred[object]", object, None]:
|
2014-08-12 10:10:52 -04:00
|
|
|
self.mock_txn.rowcount = 1
|
|
|
|
|
2020-08-17 12:18:01 -04:00
|
|
|
yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_insert(
|
|
|
|
table="tablename",
|
|
|
|
# Use OrderedDict() so we can assert on the SQL generated
|
|
|
|
values=OrderedDict([("colA", 1), ("colB", 2), ("colC", 3)]),
|
|
|
|
)
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
2023-11-07 09:34:23 -05:00
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
2016-02-19 10:34:38 -05:00
|
|
|
"INSERT INTO tablename (colA, colB, colC) VALUES(?, ?, ?)", (1, 2, 3)
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
2023-11-07 09:34:23 -05:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_insert_many(self) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_insert_many(
|
|
|
|
table="tablename",
|
|
|
|
keys=(
|
|
|
|
"col1",
|
|
|
|
"col2",
|
|
|
|
),
|
|
|
|
values=[
|
|
|
|
(
|
|
|
|
"val1",
|
|
|
|
"val2",
|
|
|
|
),
|
|
|
|
("val3", "val4"),
|
|
|
|
],
|
|
|
|
desc="",
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
if USE_POSTGRES_FOR_TESTS:
|
|
|
|
self.mock_execute_values.assert_called_once_with(
|
|
|
|
self.mock_txn,
|
|
|
|
"INSERT INTO tablename (col1, col2) VALUES ?",
|
|
|
|
[("val1", "val2"), ("val3", "val4")],
|
|
|
|
template=None,
|
|
|
|
fetch=False,
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
self.mock_txn.executemany.assert_called_once_with(
|
|
|
|
"INSERT INTO tablename (col1, col2) VALUES(?, ?)",
|
|
|
|
[("val1", "val2"), ("val3", "val4")],
|
|
|
|
)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_insert_many_no_iterable(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_insert_many(
|
|
|
|
table="tablename",
|
|
|
|
keys=(
|
|
|
|
"col1",
|
|
|
|
"col2",
|
|
|
|
),
|
|
|
|
values=[],
|
|
|
|
desc="",
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
if USE_POSTGRES_FOR_TESTS:
|
2023-11-07 14:00:25 -05:00
|
|
|
self.mock_execute_values.assert_not_called()
|
2023-11-07 09:34:23 -05:00
|
|
|
else:
|
2023-11-07 14:00:25 -05:00
|
|
|
self.mock_txn.executemany.assert_not_called()
|
2023-11-07 09:34:23 -05:00
|
|
|
|
2014-08-12 10:10:52 -04:00
|
|
|
@defer.inlineCallbacks
|
2022-12-09 12:36:32 -05:00
|
|
|
def test_select_one_1col(self) -> Generator["defer.Deferred[object]", object, None]:
|
2014-08-12 10:10:52 -04:00
|
|
|
self.mock_txn.rowcount = 1
|
2017-03-23 13:53:49 -04:00
|
|
|
self.mock_txn.__iter__ = Mock(return_value=iter([("Value",)]))
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2020-08-26 07:19:32 -04:00
|
|
|
value = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_select_one_onecol(
|
|
|
|
table="tablename", keyvalues={"keycol": "TheKey"}, retcol="retcol"
|
|
|
|
)
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
2022-02-28 07:12:29 -05:00
|
|
|
self.assertEqual("Value", value)
|
2023-11-07 09:34:23 -05:00
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
2016-02-19 10:34:38 -05:00
|
|
|
"SELECT retcol FROM tablename WHERE keycol = ?", ["TheKey"]
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
2022-12-09 12:36:32 -05:00
|
|
|
def test_select_one_3col(self) -> Generator["defer.Deferred[object]", object, None]:
|
2014-08-12 10:10:52 -04:00
|
|
|
self.mock_txn.rowcount = 1
|
|
|
|
self.mock_txn.fetchone.return_value = (1, 2, 3)
|
|
|
|
|
2020-08-26 07:19:32 -04:00
|
|
|
ret = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_select_one(
|
|
|
|
table="tablename",
|
|
|
|
keyvalues={"keycol": "TheKey"},
|
|
|
|
retcols=["colA", "colB", "colC"],
|
|
|
|
)
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
2022-02-28 07:12:29 -05:00
|
|
|
self.assertEqual({"colA": 1, "colB": 2, "colC": 3}, ret)
|
2023-11-07 09:34:23 -05:00
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
2016-02-19 10:34:38 -05:00
|
|
|
"SELECT colA, colB, colC FROM tablename WHERE keycol = ?", ["TheKey"]
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
2022-12-09 12:36:32 -05:00
|
|
|
def test_select_one_missing(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
2014-08-12 10:10:52 -04:00
|
|
|
self.mock_txn.rowcount = 0
|
|
|
|
self.mock_txn.fetchone.return_value = None
|
|
|
|
|
2020-08-26 07:19:32 -04:00
|
|
|
ret = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_select_one(
|
|
|
|
table="tablename",
|
|
|
|
keyvalues={"keycol": "Not here"},
|
|
|
|
retcols=["colA"],
|
|
|
|
allow_none=True,
|
|
|
|
)
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
self.assertFalse(ret)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
2022-12-09 12:36:32 -05:00
|
|
|
def test_select_list(self) -> Generator["defer.Deferred[object]", object, None]:
|
2016-02-19 10:34:38 -05:00
|
|
|
self.mock_txn.rowcount = 3
|
2023-10-26 13:01:36 -04:00
|
|
|
self.mock_txn.fetchall.return_value = [(1,), (2,), (3,)]
|
2016-02-19 10:34:38 -05:00
|
|
|
self.mock_txn.description = (("colA", None, None, None, None, None, None),)
|
2014-08-12 10:10:52 -04:00
|
|
|
|
2020-08-27 07:08:38 -04:00
|
|
|
ret = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_select_list(
|
|
|
|
table="tablename", keyvalues={"keycol": "A set"}, retcols=["colA"]
|
|
|
|
)
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
2023-10-26 13:01:36 -04:00
|
|
|
self.assertEqual([(1,), (2,), (3,)], ret)
|
2023-11-07 09:34:23 -05:00
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
2016-02-19 10:34:38 -05:00
|
|
|
"SELECT colA FROM tablename WHERE keycol = ?", ["A set"]
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
2023-11-07 09:34:23 -05:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_select_many_batch(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
self.mock_txn.rowcount = 3
|
|
|
|
self.mock_txn.fetchall.side_effect = [[(1,), (2,)], [(3,)]]
|
|
|
|
|
|
|
|
ret = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_select_many_batch(
|
|
|
|
table="tablename",
|
|
|
|
column="col1",
|
|
|
|
iterable=("val1", "val2", "val3"),
|
|
|
|
retcols=("col2",),
|
|
|
|
keyvalues={"col3": "val4"},
|
|
|
|
batch_size=2,
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
self.mock_txn.execute.assert_has_calls(
|
|
|
|
[
|
|
|
|
call(
|
|
|
|
"SELECT col2 FROM tablename WHERE col1 = ANY(?) AND col3 = ?",
|
|
|
|
[["val1", "val2"], "val4"],
|
|
|
|
),
|
|
|
|
call(
|
|
|
|
"SELECT col2 FROM tablename WHERE col1 = ANY(?) AND col3 = ?",
|
|
|
|
[["val3"], "val4"],
|
|
|
|
),
|
|
|
|
],
|
|
|
|
)
|
|
|
|
self.assertEqual([(1,), (2,), (3,)], ret)
|
|
|
|
|
|
|
|
def test_select_many_no_iterable(self) -> None:
|
|
|
|
self.mock_txn.rowcount = 3
|
|
|
|
self.mock_txn.fetchall.side_effect = [(1,), (2,)]
|
|
|
|
|
|
|
|
ret = self.datastore.db_pool.simple_select_many_txn(
|
|
|
|
self.mock_txn,
|
|
|
|
table="tablename",
|
|
|
|
column="col1",
|
|
|
|
iterable=(),
|
|
|
|
retcols=("col2",),
|
|
|
|
keyvalues={"col3": "val4"},
|
|
|
|
)
|
|
|
|
|
|
|
|
self.mock_txn.execute.assert_not_called()
|
|
|
|
self.assertEqual([], ret)
|
|
|
|
|
2014-08-12 10:10:52 -04:00
|
|
|
@defer.inlineCallbacks
|
2022-12-09 12:36:32 -05:00
|
|
|
def test_update_one_1col(self) -> Generator["defer.Deferred[object]", object, None]:
|
2014-08-12 10:10:52 -04:00
|
|
|
self.mock_txn.rowcount = 1
|
|
|
|
|
2020-08-27 07:08:38 -04:00
|
|
|
yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_update_one(
|
|
|
|
table="tablename",
|
|
|
|
keyvalues={"keycol": "TheKey"},
|
|
|
|
updatevalues={"columnname": "New Value"},
|
|
|
|
)
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
2023-11-07 09:34:23 -05:00
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
2016-02-19 10:34:38 -05:00
|
|
|
"UPDATE tablename SET columnname = ? WHERE keycol = ?",
|
|
|
|
["New Value", "TheKey"],
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
2022-12-09 12:36:32 -05:00
|
|
|
def test_update_one_4cols(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
2014-08-12 10:10:52 -04:00
|
|
|
self.mock_txn.rowcount = 1
|
|
|
|
|
2020-08-27 07:08:38 -04:00
|
|
|
yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_update_one(
|
|
|
|
table="tablename",
|
|
|
|
keyvalues=OrderedDict([("colA", 1), ("colB", 2)]),
|
|
|
|
updatevalues=OrderedDict([("colC", 3), ("colD", 4)]),
|
|
|
|
)
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
2023-11-07 09:34:23 -05:00
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
2016-02-19 10:34:38 -05:00
|
|
|
"UPDATE tablename SET colC = ?, colD = ? WHERE" " colA = ? AND colB = ?",
|
|
|
|
[3, 4, 1, 2],
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
2023-11-07 09:34:23 -05:00
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_update_many(self) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_update_many(
|
|
|
|
table="tablename",
|
|
|
|
key_names=("col1", "col2"),
|
|
|
|
key_values=[("val1", "val2")],
|
|
|
|
value_names=("col3",),
|
|
|
|
value_values=[("val3",)],
|
|
|
|
desc="",
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
if USE_POSTGRES_FOR_TESTS:
|
|
|
|
self.mock_execute_batch.assert_called_once_with(
|
|
|
|
self.mock_txn,
|
|
|
|
"UPDATE tablename SET col3 = ? WHERE col1 = ? AND col2 = ?",
|
|
|
|
[("val3", "val1", "val2"), ("val3", "val1", "val2")],
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
self.mock_txn.executemany.assert_called_once_with(
|
|
|
|
"UPDATE tablename SET col3 = ? WHERE col1 = ? AND col2 = ?",
|
|
|
|
[("val3", "val1", "val2"), ("val3", "val1", "val2")],
|
|
|
|
)
|
|
|
|
|
|
|
|
# key_values and value_values must be the same length.
|
|
|
|
with self.assertRaises(ValueError):
|
|
|
|
yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_update_many(
|
|
|
|
table="tablename",
|
|
|
|
key_names=("col1", "col2"),
|
|
|
|
key_values=[("val1", "val2")],
|
|
|
|
value_names=("col3",),
|
|
|
|
value_values=[],
|
|
|
|
desc="",
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
2023-11-07 14:00:25 -05:00
|
|
|
def test_update_many_no_iterable(
|
2023-11-07 09:34:23 -05:00
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_update_many(
|
|
|
|
table="tablename",
|
|
|
|
key_names=("col1", "col2"),
|
|
|
|
key_values=[],
|
|
|
|
value_names=("col3",),
|
|
|
|
value_values=[],
|
|
|
|
desc="",
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
if USE_POSTGRES_FOR_TESTS:
|
2023-11-07 14:00:25 -05:00
|
|
|
self.mock_execute_batch.assert_not_called()
|
2023-11-07 09:34:23 -05:00
|
|
|
else:
|
2023-11-07 14:00:25 -05:00
|
|
|
self.mock_txn.executemany.assert_not_called()
|
2023-11-07 09:34:23 -05:00
|
|
|
|
2014-08-12 10:10:52 -04:00
|
|
|
@defer.inlineCallbacks
|
2022-12-09 12:36:32 -05:00
|
|
|
def test_delete_one(self) -> Generator["defer.Deferred[object]", object, None]:
|
2014-08-12 10:10:52 -04:00
|
|
|
self.mock_txn.rowcount = 1
|
|
|
|
|
2020-08-27 07:41:01 -04:00
|
|
|
yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_delete_one(
|
|
|
|
table="tablename", keyvalues={"keycol": "Go away"}
|
|
|
|
)
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
|
|
|
|
2023-11-07 09:34:23 -05:00
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
2016-02-19 10:34:38 -05:00
|
|
|
"DELETE FROM tablename WHERE keycol = ?", ["Go away"]
|
2014-08-12 10:10:52 -04:00
|
|
|
)
|
2023-11-07 09:34:23 -05:00
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_delete_many(self) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
self.mock_txn.rowcount = 2
|
|
|
|
|
|
|
|
result = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_delete_many(
|
|
|
|
table="tablename",
|
|
|
|
column="col1",
|
|
|
|
iterable=("val1", "val2"),
|
|
|
|
keyvalues={"col2": "val3"},
|
|
|
|
desc="",
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
|
|
|
"DELETE FROM tablename WHERE col1 = ANY(?) AND col2 = ?",
|
|
|
|
[["val1", "val2"], "val3"],
|
|
|
|
)
|
|
|
|
self.assertEqual(result, 2)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_delete_many_no_iterable(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
result = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_delete_many(
|
|
|
|
table="tablename",
|
|
|
|
column="col1",
|
|
|
|
iterable=(),
|
|
|
|
keyvalues={"col2": "val3"},
|
|
|
|
desc="",
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
self.mock_txn.execute.assert_not_called()
|
|
|
|
self.assertEqual(result, 0)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_delete_many_no_keyvalues(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
self.mock_txn.rowcount = 2
|
|
|
|
|
|
|
|
result = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_delete_many(
|
|
|
|
table="tablename",
|
|
|
|
column="col1",
|
|
|
|
iterable=("val1", "val2"),
|
|
|
|
keyvalues={},
|
|
|
|
desc="",
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
|
|
|
"DELETE FROM tablename WHERE col1 = ANY(?)", [["val1", "val2"]]
|
|
|
|
)
|
|
|
|
self.assertEqual(result, 2)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_upsert(self) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
self.mock_txn.rowcount = 1
|
|
|
|
|
|
|
|
result = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_upsert(
|
|
|
|
table="tablename",
|
|
|
|
keyvalues={"columnname": "oldvalue"},
|
|
|
|
values={"othercol": "newvalue"},
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
|
|
|
"INSERT INTO tablename (columnname, othercol) VALUES (?, ?) ON CONFLICT (columnname) DO UPDATE SET othercol=EXCLUDED.othercol",
|
|
|
|
["oldvalue", "newvalue"],
|
|
|
|
)
|
|
|
|
self.assertTrue(result)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_upsert_no_values(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
self.mock_txn.rowcount = 1
|
|
|
|
|
|
|
|
result = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_upsert(
|
|
|
|
table="tablename",
|
|
|
|
keyvalues={"columnname": "value"},
|
|
|
|
values={},
|
|
|
|
insertion_values={"columnname": "value"},
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
|
|
|
"INSERT INTO tablename (columnname) VALUES (?) ON CONFLICT (columnname) DO NOTHING",
|
|
|
|
["value"],
|
|
|
|
)
|
|
|
|
self.assertTrue(result)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_upsert_with_insertion(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
self.mock_txn.rowcount = 1
|
|
|
|
|
|
|
|
result = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_upsert(
|
|
|
|
table="tablename",
|
|
|
|
keyvalues={"columnname": "oldvalue"},
|
|
|
|
values={"othercol": "newvalue"},
|
|
|
|
insertion_values={"thirdcol": "insertionval"},
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
|
|
|
"INSERT INTO tablename (columnname, thirdcol, othercol) VALUES (?, ?, ?) ON CONFLICT (columnname) DO UPDATE SET othercol=EXCLUDED.othercol",
|
|
|
|
["oldvalue", "insertionval", "newvalue"],
|
|
|
|
)
|
|
|
|
self.assertTrue(result)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_upsert_with_where(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
self.mock_txn.rowcount = 1
|
|
|
|
|
|
|
|
result = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_upsert(
|
|
|
|
table="tablename",
|
|
|
|
keyvalues={"columnname": "oldvalue"},
|
|
|
|
values={"othercol": "newvalue"},
|
|
|
|
where_clause="thirdcol IS NULL",
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
|
|
|
"INSERT INTO tablename (columnname, othercol) VALUES (?, ?) ON CONFLICT (columnname) WHERE thirdcol IS NULL DO UPDATE SET othercol=EXCLUDED.othercol",
|
|
|
|
["oldvalue", "newvalue"],
|
|
|
|
)
|
|
|
|
self.assertTrue(result)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_upsert_many(self) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_upsert_many(
|
|
|
|
table="tablename",
|
|
|
|
key_names=["keycol1", "keycol2"],
|
|
|
|
key_values=[["keyval1", "keyval2"], ["keyval3", "keyval4"]],
|
|
|
|
value_names=["valuecol3"],
|
|
|
|
value_values=[["val5"], ["val6"]],
|
|
|
|
desc="",
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
if USE_POSTGRES_FOR_TESTS:
|
|
|
|
self.mock_execute_values.assert_called_once_with(
|
|
|
|
self.mock_txn,
|
|
|
|
"INSERT INTO tablename (keycol1, keycol2, valuecol3) VALUES ? ON CONFLICT (keycol1, keycol2) DO UPDATE SET valuecol3=EXCLUDED.valuecol3",
|
|
|
|
[("keyval1", "keyval2", "val5"), ("keyval3", "keyval4", "val6")],
|
|
|
|
template=None,
|
|
|
|
fetch=False,
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
self.mock_txn.executemany.assert_called_once_with(
|
|
|
|
"INSERT INTO tablename (keycol1, keycol2, valuecol3) VALUES (?, ?, ?) ON CONFLICT (keycol1, keycol2) DO UPDATE SET valuecol3=EXCLUDED.valuecol3",
|
|
|
|
[("keyval1", "keyval2", "val5"), ("keyval3", "keyval4", "val6")],
|
|
|
|
)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_upsert_many_no_values(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_upsert_many(
|
|
|
|
table="tablename",
|
|
|
|
key_names=["columnname"],
|
|
|
|
key_values=[["oldvalue"]],
|
|
|
|
value_names=[],
|
|
|
|
value_values=[],
|
|
|
|
desc="",
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
if USE_POSTGRES_FOR_TESTS:
|
|
|
|
self.mock_execute_values.assert_called_once_with(
|
|
|
|
self.mock_txn,
|
|
|
|
"INSERT INTO tablename (columnname) VALUES ? ON CONFLICT (columnname) DO NOTHING",
|
|
|
|
[("oldvalue",)],
|
|
|
|
template=None,
|
|
|
|
fetch=False,
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
self.mock_txn.executemany.assert_called_once_with(
|
|
|
|
"INSERT INTO tablename (columnname) VALUES (?) ON CONFLICT (columnname) DO NOTHING",
|
|
|
|
[("oldvalue",)],
|
|
|
|
)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_upsert_emulated_no_values_exists(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
self.datastore.db_pool._unsafe_to_upsert_tables.add("tablename")
|
|
|
|
|
|
|
|
self.mock_txn.fetchall.return_value = [(1,)]
|
|
|
|
|
|
|
|
result = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_upsert(
|
|
|
|
table="tablename",
|
|
|
|
keyvalues={"columnname": "value"},
|
|
|
|
values={},
|
|
|
|
insertion_values={"columnname": "value"},
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
if USE_POSTGRES_FOR_TESTS:
|
|
|
|
self.mock_txn.execute.assert_has_calls(
|
|
|
|
[
|
|
|
|
call("LOCK TABLE tablename in EXCLUSIVE MODE", ()),
|
|
|
|
call("SELECT 1 FROM tablename WHERE columnname = ?", ["value"]),
|
|
|
|
]
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
|
|
|
"SELECT 1 FROM tablename WHERE columnname = ?", ["value"]
|
|
|
|
)
|
|
|
|
self.assertFalse(result)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_upsert_emulated_no_values_not_exists(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
self.datastore.db_pool._unsafe_to_upsert_tables.add("tablename")
|
|
|
|
|
|
|
|
self.mock_txn.fetchall.return_value = []
|
|
|
|
self.mock_txn.rowcount = 1
|
|
|
|
|
|
|
|
result = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_upsert(
|
|
|
|
table="tablename",
|
|
|
|
keyvalues={"columnname": "value"},
|
|
|
|
values={},
|
|
|
|
insertion_values={"columnname": "value"},
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
self.mock_txn.execute.assert_has_calls(
|
|
|
|
[
|
|
|
|
call(
|
|
|
|
"SELECT 1 FROM tablename WHERE columnname = ?",
|
|
|
|
["value"],
|
|
|
|
),
|
|
|
|
call("INSERT INTO tablename (columnname) VALUES (?)", ["value"]),
|
|
|
|
],
|
|
|
|
)
|
|
|
|
self.assertTrue(result)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_upsert_emulated_with_insertion_exists(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
self.datastore.db_pool._unsafe_to_upsert_tables.add("tablename")
|
|
|
|
|
|
|
|
self.mock_txn.rowcount = 1
|
|
|
|
|
|
|
|
result = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_upsert(
|
|
|
|
table="tablename",
|
|
|
|
keyvalues={"columnname": "oldvalue"},
|
|
|
|
values={"othercol": "newvalue"},
|
|
|
|
insertion_values={"thirdcol": "insertionval"},
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
if USE_POSTGRES_FOR_TESTS:
|
|
|
|
self.mock_txn.execute.assert_has_calls(
|
|
|
|
[
|
|
|
|
call("LOCK TABLE tablename in EXCLUSIVE MODE", ()),
|
|
|
|
call(
|
|
|
|
"UPDATE tablename SET othercol = ? WHERE columnname = ?",
|
|
|
|
["newvalue", "oldvalue"],
|
|
|
|
),
|
|
|
|
]
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
|
|
|
"UPDATE tablename SET othercol = ? WHERE columnname = ?",
|
|
|
|
["newvalue", "oldvalue"],
|
|
|
|
)
|
|
|
|
self.assertTrue(result)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_upsert_emulated_with_insertion_not_exists(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
self.datastore.db_pool._unsafe_to_upsert_tables.add("tablename")
|
|
|
|
|
|
|
|
self.mock_txn.rowcount = 0
|
|
|
|
|
|
|
|
result = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_upsert(
|
|
|
|
table="tablename",
|
|
|
|
keyvalues={"columnname": "oldvalue"},
|
|
|
|
values={"othercol": "newvalue"},
|
|
|
|
insertion_values={"thirdcol": "insertionval"},
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
self.mock_txn.execute.assert_has_calls(
|
|
|
|
[
|
|
|
|
call(
|
|
|
|
"UPDATE tablename SET othercol = ? WHERE columnname = ?",
|
|
|
|
["newvalue", "oldvalue"],
|
|
|
|
),
|
|
|
|
call(
|
|
|
|
"INSERT INTO tablename (columnname, othercol, thirdcol) VALUES (?, ?, ?)",
|
|
|
|
["oldvalue", "newvalue", "insertionval"],
|
|
|
|
),
|
|
|
|
]
|
|
|
|
)
|
|
|
|
self.assertTrue(result)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_upsert_emulated_with_where(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
self.datastore.db_pool._unsafe_to_upsert_tables.add("tablename")
|
|
|
|
|
|
|
|
self.mock_txn.rowcount = 1
|
|
|
|
|
|
|
|
result = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_upsert(
|
|
|
|
table="tablename",
|
|
|
|
keyvalues={"columnname": "oldvalue"},
|
|
|
|
values={"othercol": "newvalue"},
|
|
|
|
where_clause="thirdcol IS NULL",
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
if USE_POSTGRES_FOR_TESTS:
|
|
|
|
self.mock_txn.execute.assert_has_calls(
|
|
|
|
[
|
|
|
|
call("LOCK TABLE tablename in EXCLUSIVE MODE", ()),
|
|
|
|
call(
|
|
|
|
"UPDATE tablename SET othercol = ? WHERE columnname = ? AND thirdcol IS NULL",
|
|
|
|
["newvalue", "oldvalue"],
|
|
|
|
),
|
|
|
|
]
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
|
|
|
"UPDATE tablename SET othercol = ? WHERE columnname = ? AND thirdcol IS NULL",
|
|
|
|
["newvalue", "oldvalue"],
|
|
|
|
)
|
|
|
|
self.assertTrue(result)
|
|
|
|
|
|
|
|
@defer.inlineCallbacks
|
|
|
|
def test_upsert_emulated_with_where_no_values(
|
|
|
|
self,
|
|
|
|
) -> Generator["defer.Deferred[object]", object, None]:
|
|
|
|
self.datastore.db_pool._unsafe_to_upsert_tables.add("tablename")
|
|
|
|
|
|
|
|
self.mock_txn.rowcount = 1
|
|
|
|
|
|
|
|
result = yield defer.ensureDeferred(
|
|
|
|
self.datastore.db_pool.simple_upsert(
|
|
|
|
table="tablename",
|
|
|
|
keyvalues={"columnname": "oldvalue"},
|
|
|
|
values={},
|
|
|
|
where_clause="thirdcol IS NULL",
|
|
|
|
)
|
|
|
|
)
|
|
|
|
|
|
|
|
if USE_POSTGRES_FOR_TESTS:
|
|
|
|
self.mock_txn.execute.assert_has_calls(
|
|
|
|
[
|
|
|
|
call("LOCK TABLE tablename in EXCLUSIVE MODE", ()),
|
|
|
|
call(
|
|
|
|
"SELECT 1 FROM tablename WHERE columnname = ? AND thirdcol IS NULL",
|
|
|
|
["oldvalue"],
|
|
|
|
),
|
|
|
|
]
|
|
|
|
)
|
|
|
|
else:
|
|
|
|
self.mock_txn.execute.assert_called_once_with(
|
|
|
|
"SELECT 1 FROM tablename WHERE columnname = ? AND thirdcol IS NULL",
|
|
|
|
["oldvalue"],
|
|
|
|
)
|
|
|
|
self.assertFalse(result)
|