- Notifications
You must be signed in to change notification settings - Fork35
Testing framework for PostgreSQL and its extensions
License
postgrespro/testgres
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
PostgreSQL testing utility. Python 3.8+ is supported.
To installtestgres, run:
pip install testgresWe encourage you to usevirtualenv for your testing environment.
Note: by default testgres runs
initdb,pg_ctl,psqlprovided byPATH.
There are several ways to specify a custom postgres installation:
- export
PG_CONFIGenvironment variable pointing to thepg_configexecutable; - export
PG_BINenvironment variable pointing to the directory with executable files.
Example:
export PG_BIN=$HOME/pg_10/binpython my_tests.py
Here is an example of what you can do withtestgres:
# create a node with random name, port, etcwithtestgres.get_new_node()asnode:# run inidbnode.init()# start PostgreSQLnode.start()# execute a query in a default DBprint(node.execute('select 1'))# ... node stops and its files are about to be removed
There are four API methods for running queries:
| Command | Description |
|---|---|
node.psql(query, ...) | Runs query viapsql command and returns tuple(error code, stdout, stderr). |
node.safe_psql(query, ...) | Same aspsql() except that it returns onlystdout. If an error occurs during the execution, an exception will be thrown. |
node.execute(query, ...) | Connects to PostgreSQL usingpsycopg2 orpg8000 (depends on which one is installed in your system) and returns two-dimensional array with data. |
node.connect(dbname, ...) | Returns connection wrapper (NodeConnection) capable of running several queries within a single transaction. |
The last one is the most powerful: you can usebegin(isolation_level),commit() androllback():
withnode.connect()ascon:con.begin('serializable')print(con.execute('select %s',1))con.rollback()
By default,cleanup() removes all temporary files (DB files, logs etc) that were created by testgres' API methods.If you'd like to keep logs, executeconfigure_testgres(node_cleanup_full=False) before running any tests.
Note: context managers (aka
with) callstop()andcleanup()automatically.
testgres supportspython logging,which means that you can aggregate logs from several nodes into one file:
importlogging# write everything to /tmp/testgres.loglogging.basicConfig(filename='/tmp/testgres.log')# enable logging, and create two different nodestestgres.configure_testgres(use_python_logging=True)node1=testgres.get_new_node().init().start()node2=testgres.get_new_node().init().start()# execute a few queriesnode1.execute('select 1')node2.execute('select 2')# disable loggingtestgres.configure_testgres(use_python_logging=False)
Look attests/test_simple.py file for a complete example of the loggingconfiguration.
It's quite easy to create a backup and start a new replica:
withtestgres.get_new_node('master')asmaster:master.init().start()# create a backupwithmaster.backup()asbackup:# create and start a new replicareplica=backup.spawn_replica('replica').start()# catch up with master nodereplica.catchup()# execute a dummy queryprint(replica.execute('postgres','select 1'))
testgres is also capable of running benchmarks usingpgbench:
withtestgres.get_new_node('master')asmaster:# start a new nodemaster.init().start()# initialize default DB and run bench for 10 secondsres=master.pgbench_init(scale=2).pgbench_run(time=10)print(res)
It's often useful to extend default configuration provided bytestgres.
testgres hasdefault_conf() function that helps control some basicoptions. Theappend_conf() function can be used to add customlines to configuration lines:
ext_conf="shared_preload_libraries = 'postgres_fdw'"# initialize a new nodewithtestgres.get_new_node().init()asmaster:# ... do something ...# reset main config filemaster.default_conf(fsync=True,allow_streaming=True)# add a new config linemaster.append_conf('postgresql.conf',ext_conf)
Note thatdefault_conf() is called byinit() function; both of them overwritethe configuration file, which means that they should be called beforeappend_conf().
Testgres supports the creation of PostgreSQL nodes on a remote host. This is useful when you want to run distributed tests involving multiple nodes spread across different machines.
To use this feature, you need to use the RemoteOperations class. This feature is only supported with Linux.Here is an example of how you might set this up:
fromtestgresimportConnectionParams,RemoteOperations,TestgresConfig,get_remote_node# Set up connection paramsconn_params=ConnectionParams(host='your_host',# replace with your hostusername='user_name',# replace with your usernamessh_key='path_to_ssh_key'# replace with your SSH key path)os_ops=RemoteOperations(conn_params)# Add remote testgres config before testTestgresConfig.set_os_ops(os_ops=os_ops)# Proceed with your testdeftest_basic_query(self):withget_remote_node(conn_params=conn_params)asnode:node.init().start()res=node.execute('SELECT 1')self.assertEqual(res, [(1,)])
About
Testing framework for PostgreSQL and its extensions
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.