https://github.com/opencastsoftware/pgtap-java

A library for running pgTAP tests using Testcontainers for Java
https://github.com/opencastsoftware/pgtap-java

Last synced: 28 days ago
JSON representation

A library for running pgTAP tests using Testcontainers for Java

• Host: GitHub
• URL: https://github.com/opencastsoftware/pgtap-java
• Owner: opencastsoftware
• License: apache-2.0
• Created: 2024-02-01T17:15:24.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-12-18T07:52:45.000Z (about 1 month ago)
• Last Synced: 2024-12-18T08:31:23.553Z (about 1 month ago)
• Language: Java
• Size: 568 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pgtap-java

[![CI](https://github.com/opencastsoftware/pgtap-java/actions/workflows/ci.yml/badge.svg)](https://github.com/opencastsoftware/pgtap-java/actions/workflows/ci.yml)

[![Maven Central](https://img.shields.io/maven-central/v/com.opencastsoftware/pgtap-java)](https://search.maven.org/search?q=g%3Acom.opencastsoftware+AND+a%3Apgtap-java)

[![License](https://img.shields.io/github/license/opencastsoftware/pgtap-java?color=blue)](https://spdx.org/licenses/Apache-2.0.html)

A library for running [pgTAP](https://pgtap.org/) tests using [Testcontainers for Java](https://java.testcontainers.org/).

![A screenshot demonstrating pgTAP test results and descriptions displayed in the IntelliJ Run tool window](./images/example-tests.png)

## Installation

*pgtap-java* is published for Java 11 and above.

Gradle (build.gradle / build.gradle.kts):

```kotlin

testing {

    suites {

        val test by getting(JvmTestSuite::class) {

            dependencies {

                implementation("com.opencastsoftware:pgtap-java:0.1.0")

            }

        }

    }

}

```

Maven (pom.xml):

```xml

    com.opencastsoftware

    pgtap-java

    0.1.0

    test

```

## Usage

*pgtap-java* is intended for use with [JUnit 5](https://junit.org/junit5/) and [Testcontainers for Java](https://java.testcontainers.org/).

In order to run pgTAP tests with *pgtap-java*, you must extend the [PgTapTest](./src/main/java/com/opencastsoftware/pgtap/PgTapTest.java) abstract class provided by this library.

`PgTapTest` requires 3 constructor parameters:

* `database: PostgreSQLContainer>` - a [Testcontainers PostgreSQL](https://java.testcontainers.org/modules/databases/postgres/) database container. This container image must have pgTAP preinstalled. See our [postgres-with-pgtap](https://github.com/opencastsoftware/postgres-with-pgtap/blob/main/Containerfile) Containerfile for an example of how you can do that.

* `pgTapTestPath: Path` - the path to your pgTAP `.sql` test files

* `pgTapTmpPath: Path` - the path where the pgTAP `.sql` test files will be mounted inside the PostgreSQL container.

 

In order for your tests to run, you should use [withCopyFileToContainer](https://javadoc.io/static/org.testcontainers/testcontainers/1.19.4/org/testcontainers/containers/GenericContainer.html#withCopyFileToContainer-org.testcontainers.utility.MountableFile-java.lang.String-) to mount the `pgTapTestsPath` at `pgTapTmpPath` in your `database` container.

It doesn't matter precisely what `pgTapTmpPath` you use, as long as you use the same path in the constructor of `PgTapTest` and with `withCopyFileToContainer`.

See [ExampleTest](./src/test/java/com/opencastsoftware/pgtap/ExampleTest.java) for an end-to-end example that uses Flyway migrations to set up a test database.

## Acknowlegements

This project wouldn't exist without the work of [theory](https://github.com/theory), [rnorth](https://github.com/rnorth) and the many pgTAP and Testcontainers contributors.

## License

All code in this repository is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE).