Page MenuHomeSoftware Heritage
Files F8395784

db_testing.py
No OneTemporary
Actions

db_testing.py
View Options

# Copyright (C) 2015-2018 The Software Heritage developers
# See the AUTHORS file at the top-level directory of this distribution
# License: GNU General Public License version 3, or any later version
# See top-level LICENSE file for more information
import os
import glob
import subprocess
import psycopg2
from typing import Dict, Iterable, Optional, Tuple, Union
from swh.core.utils import numfile_sortkey as sortkey
DB_DUMP_TYPES = {".sql": "psql", ".dump": "pg_dump"} # type: Dict[str, str]
def swh_db_version(dbname_or_service):
"""Retrieve the swh version if any. In case of the db not initialized,
this returns None. Otherwise, this returns the db's version.
Args:
dbname_or_service (str): The db's name or service
Returns:
Optional[Int]: Either the db's version or None
"""
query = "select version from dbversion order by dbversion desc limit 1"
cmd = [
"psql",
"--tuples-only",
"--no-psqlrc",
"--quiet",
"-v",
"ON_ERROR_STOP=1",
"--command=%s" % query,
dbname_or_service,
]
try:
r = subprocess.run(
cmd, check=True, stdout=subprocess.PIPE, universal_newlines=True
)
result = int(r.stdout.strip())
except Exception: # db not initialized
result = None
return result
def pg_restore(dbname, dumpfile, dumptype="pg_dump"):
"""
Args:
dbname: name of the DB to restore into
dumpfile: path of the dump file
dumptype: one of 'pg_dump' (for binary dumps), 'psql' (for SQL dumps)
"""
assert dumptype in ["pg_dump", "psql"]
if dumptype == "pg_dump":
subprocess.check_call(
[
"pg_restore",
"--no-owner",
"--no-privileges",
"--dbname",
dbname,
dumpfile,
]
)
elif dumptype == "psql":
subprocess.check_call(
[
"psql",
"--quiet",
"--no-psqlrc",
"-v",
"ON_ERROR_STOP=1",
"-f",
dumpfile,
dbname,
]
)
def pg_dump(dbname, dumpfile):
subprocess.check_call(
["pg_dump", "--no-owner", "--no-privileges", "-Fc", "-f", dumpfile, dbname]
)
def pg_dropdb(dbname):
subprocess.check_call(["dropdb", dbname])
def pg_createdb(dbname, check=True):
"""Create a db. If check is True and the db already exists, this will
raise an exception (original behavior). If check is False and
the db already exists, this will fail silently. If the db does
not exist, the db will be created.
"""
subprocess.run(["createdb", dbname], check=check)
def db_create(dbname, dumps=None):
"""create the test DB and load the test data dumps into it
dumps is an iterable of couples (dump_file, dump_type).
context: setUpClass
"""
try:
pg_createdb(dbname)
except subprocess.CalledProcessError: # try recovering once, in case
pg_dropdb(dbname) # the db already existed
pg_createdb(dbname)
for dump, dtype in dumps:
pg_restore(dbname, dump, dtype)
return dbname
def db_destroy(dbname):
"""destroy the test DB
context: tearDownClass
"""
pg_dropdb(dbname)
def db_connect(dbname):
"""connect to the test DB and open a cursor
context: setUp
"""
conn = psycopg2.connect("dbname=" + dbname)
return {"conn": conn, "cursor": conn.cursor()}
def db_close(conn):
"""rollback current transaction and disconnect from the test DB
context: tearDown
"""
if not conn.closed:
conn.rollback()
conn.close()
class DbTestConn:
def __init__(self, dbname):
self.dbname = dbname
def __enter__(self):
self.db_setup = db_connect(self.dbname)
self.conn = self.db_setup["conn"]
self.cursor = self.db_setup["cursor"]
return self
def __exit__(self, *_):
db_close(self.conn)
class DbTestContext:
def __init__(self, name="softwareheritage-test", dumps=None):
self.dbname = name
self.dumps = dumps
def __enter__(self):
db_create(dbname=self.dbname, dumps=self.dumps)
return self
def __exit__(self, *_):
db_destroy(self.dbname)
class DbTestFixture:
"""Mix this in a test subject class to get DB testing support.
Use the class method add_db() to add a new database to be tested.
Using this will create a DbTestConn entry in the `test_db` dictionary for
all the tests, indexed by the name of the database.
Example:
class TestDb(DbTestFixture, unittest.TestCase):
@classmethod
def setUpClass(cls):
cls.add_db('db_name', DUMP)
super().setUpClass()
def setUp(self):
db = self.test_db['db_name']
print('conn: {}, cursor: {}'.format(db.conn, db.cursor))
To ensure test isolation, each test method of the test case class will
execute in its own connection, cursor, and transaction.
Note that if you want to define setup/teardown methods, you need to
explicitly call super() to ensure that the fixture setup/teardown methods
are invoked. Here is an example where all setup/teardown methods are
defined in a test case:
class TestDb(DbTestFixture, unittest.TestCase):
@classmethod
def setUpClass(cls):
# your add_db() calls here
super().setUpClass()
# your class setup code here
def setUp(self):
super().setUp()
# your instance setup code here
def tearDown(self):
# your instance teardown code here
super().tearDown()
@classmethod
def tearDownClass(cls):
# your class teardown code here
super().tearDownClass()
"""
_DB_DUMP_LIST = {} # type: Dict[str, Iterable[Tuple[str, str]]]
_DB_LIST = {} # type: Dict[str, DbTestContext]
DB_TEST_FIXTURE_IMPORTED = True
@classmethod
def add_db(cls, name="softwareheritage-test", dumps=None):
cls._DB_DUMP_LIST[name] = dumps
@classmethod
def setUpClass(cls):
for name, dumps in cls._DB_DUMP_LIST.items():
cls._DB_LIST[name] = DbTestContext(name, dumps)
cls._DB_LIST[name].__enter__()
super().setUpClass()
@classmethod
def tearDownClass(cls):
super().tearDownClass()
for name, context in cls._DB_LIST.items():
context.__exit__()
def setUp(self, *args, **kwargs):
self.test_db = {}
for name in self._DB_LIST.keys():
self.test_db[name] = DbTestConn(name)
self.test_db[name].__enter__()
super().setUp(*args, **kwargs)
def tearDown(self):
super().tearDown()
for name in self._DB_LIST.keys():
self.test_db[name].__exit__()
def reset_db_tables(self, name, excluded=None):
db = self.test_db[name]
conn = db.conn
cursor = db.cursor
cursor.execute(
"""SELECT table_name FROM information_schema.tables
WHERE table_schema = %s""",
("public",),
)
tables = set(table for (table,) in cursor.fetchall())
if excluded is not None:
tables -= set(excluded)
for table in tables:
cursor.execute("truncate table %s cascade" % table)
conn.commit()
class SingleDbTestFixture(DbTestFixture):
"""Simplified fixture like DbTest but that can only handle a single DB.
Gives access to shortcuts like self.cursor and self.conn.
DO NOT use this with other fixtures that need to access databases, like
StorageTestFixture.
The class can override the following class attributes:
TEST_DB_NAME: name of the DB used for testing
TEST_DB_DUMP: DB dump to be restored before running test methods; can
be set to None if no restore from dump is required.
If the dump file name endswith"
- '.sql' it will be loaded via psql,
- '.dump' it will be loaded via pg_restore.
Other file extensions will be ignored.
Can be a string or a list of strings; each path will be expanded
using glob pattern matching.
The test case class will then have the following attributes, accessible via
self:
dbname: name of the test database
conn: psycopg2 connection object
cursor: open psycopg2 cursor to the DB
"""
TEST_DB_NAME = "softwareheritage-test"
TEST_DB_DUMP = None # type: Optional[Union[str, Iterable[str]]]
@classmethod
def setUpClass(cls):
cls.dbname = cls.TEST_DB_NAME # XXX to kill?
dump_files = cls.TEST_DB_DUMP
if dump_files is None:
dump_files = []
elif isinstance(dump_files, str):
dump_files = [dump_files]
all_dump_files = []
for files in dump_files:
all_dump_files.extend(sorted(glob.glob(files), key=sortkey))
all_dump_files = [
(x, DB_DUMP_TYPES[os.path.splitext(x)[1]]) for x in all_dump_files
]
cls.add_db(name=cls.TEST_DB_NAME, dumps=all_dump_files)
super().setUpClass()
def setUp(self, *args, **kwargs):
super().setUp(*args, **kwargs)
db = self.test_db[self.TEST_DB_NAME]
self.conn = db.conn
self.cursor = db.cursor

File Metadata

Mime Type
text/x-python
Expires
Jun 4 2025, 7:44 PM (12 w, 5 d ago)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3374745

Event Timeline

About · Developer information · Legal