Skip to content

Latest commit

 

History

History
142 lines (92 loc) · 4.92 KB

README.md

File metadata and controls

142 lines (92 loc) · 4.92 KB
Raw

PGJDBC Test VM

What is the PGJDBC Test VM?

A Vagrant configuration for spinning up a VM with multiple PostgreSQL installations for testing the PostgreSQL JDBC driver.

How do I use it?

Clone this repo. Make sure you have Vagrant installed.

To startup the VM:

$ vagrant up

The first time you start it up it will update the OS and install everything. This takes a couple of minutes. After that it does not do any updates on startup and should startup quickly.

To shutdown the VM:

$ vagrant halt

To destroy the VM:

$ vagrant destroy

How do I connect to the version X.Y PostgreSQL server?

Once the VM is started the port forwarding will make it act like the PostgreSQL servers are installed on your desktop and available at the forwarded ports. If you have psql installed then just specify the port number for the server you'd like to connect to.

For example to connect to the "test" database on the 9.3 server as the user "test" (change the host IP address):

$ PGPASSWORD=test psql -h localhost -p 10093 -U test -d test
psql (11.1 (Ubuntu 11.1-1.pgdg18.04+1), server 9.3.25)
SSL connection (protocol: TLSv1.2, cipher: ECDHE-RSA-AES256-GCM-SHA384, bits: 256, compression: off)
Type "help" for help.

test=>

The password for the "test" user is "test".

The bin/ directory contains a wrapper for psql that connects to the test database for a given PostgreSQL version:

$ bin/psql 10
psql (11.1 (Ubuntu 11.1-1.pgdg18.04+1), server 10.6 (Ubuntu 10.6-1.pgdg18.04+1))
SSL connection (protocol: TLSv1.2, cipher: ECDHE-RSA-AES256-GCM-SHA384, bits: 256, compression: off)
Type "help" for help.

test=>

How do I use it to test the JDBC driver?

  1. Clone the PostgreSQL JDBC driver.

  2. Add a build.local.properties file and add

server=localhost
port=10011
privilegedUser=test_super
privilegedPassword=test

Change the port numbers to point to the version of PostgreSQL you want to test against (ex: 10010 for v10)

Note: To test against a different version of PostgreSQL just change the port. For example using 10096 would test against version 9.6.

  1. Build and test the JDBC driver using mvn:

    $ mvn clean compile test

To run the SSL related tests copy the file ssltest.properties to ssltest.local.properties and enable the SSL test property.

**Note:** The test VM uses the same SSL certificates in certdir as the pgjdbc repo.

What does it do?

When it is first started up the VM:

  1. Setups up a base VM with Ubuntu 18.04
  2. Adds the PostgreSQL Global Development Group (PGDG) apt repo
  3. Updates all packages
  4. Installs postgresql-${PG_VERSION} and postgresql-contrib-${PG_VERSION}
  5. Updates the postgresql.conf file to change listen_address = '*'
  6. Updates pg_hba.conf to allow inbound connections required by pgjdbc tests.
  7. Copies the SSL config files (root.crt, server.crt, and server.key)
  8. Creates sample users and databases matching those used by pgjdbc.
  9. Installs the sslinfo and hstore extensions (via CREATE EXTENSION ...)

This is done for each version of PostgreSQL that is installed (see next section for versions).

The Vagrantfile also sets up port forwarding for each PostgreSQL installation to your local machine.

What versions of PostgreSQL does it install?

On first boot it installs every version of PostgreSQL available in the apt repos.

  • 9.3 - mapped to port 10093
  • 9.4 - mapped to port 10094
  • 9.5 - mapped to port 10095
  • 9.6 - mapped to port 10096
  • 10 - mapped to port 10010
  • 11 - mapped to port 10011
  • 12 - mapped to port 10012
  • 13 - mapped to port 10013

In general PostgreSQL version X.Y is mapped to port 100XY.

The bootstrap script for the VM analyzes the available set of packages to determine which ones to install. The script itself should not need to be updated as new versions are released however the port forwarding would need to be updated to reflect them.

What databases and users does it setup?

A test user (with name "test" and password "test") and the databases listed below are created for each PostgreSQL version that is installed. This matches up with the default configuration of the JDBC drivers build.properties and build.xml files.

The following databases are created (each is used somewhere in the JDBC driver tests):

  1. test
  2. hostdb
  3. hostssldb
  4. hostnossldb
  5. hostsslcertdb
  6. certdb

Why did you make this?

I was adding some SSL related tests to the driver and getting an environment to test it was non-trivial. It seemed like a good idea to automate it.

VMs are great for testing and it makes it much easier for someone new to get involved in adding to a project.

Why isn't this part of the driver project itself?

Hopefully it will be.

Can I use this? What license is it?

Yes. See LICENSE for details.