gopkg/pgx
2
0
Fork 0
Code Activity

Improve testing / contributing instructions

Browse Source 
* Extract CONTRIBUTING.md
* Add instructions and scripts to setup standalone PostgreSQL server
  that tests the various connection and authentication types.
This commit is contained in:
Jack Christensen
2022-10-29 17:14:09 -05:00
parent 1ec3816a20
commit 55b5067ddd
9 changed files with 158 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pgconn/README.md
+1 -25
View File
@@ -26,28 +26,4 @@ if err != nil {
## Testing
The pgconn tests require a PostgreSQL database. It will connect to the database specified in the `PGX_TEST_DATABASE`
environment variable. The `PGX_TEST_DATABASE` environment variable can be a URL or DSN. In addition, the standard `PG*`
environment variables will be respected. Consider using [direnv](https://github.com/direnv/direnv) to simplify
environment variable handling.
### Example Test Environment
Connect to your PostgreSQL server and run:
```
create database pgx_test;
```
Now you can run the tests:
```bash
PGX_TEST_DATABASE="host=/var/run/postgresql dbname=pgx_test" go test ./...
```
### Connection and Authentication Tests
Pgconn supports multiple connection types and means of authentication. These tests are optional. They
will only run if the appropriate environment variable is set. Run `go test -v | grep SKIP` to see if any tests are being
skipped. Most developers will not need to enable these tests. See `ci/setup_test.bash` for an example set up if you need change
authentication code.
See CONTRIBUTING.md for setup instructions.