{"id":23594218,"url":"https://github.com/opencastsoftware/pgtap-java","last_synced_at":"2025-11-04T15:30:27.833Z","repository":{"id":220372650,"uuid":"751470971","full_name":"opencastsoftware/pgtap-java","owner":"opencastsoftware","description":"A library for running pgTAP tests using Testcontainers for Java","archived":false,"fork":false,"pushed_at":"2025-01-30T16:19:09.000Z","size":617,"stargazers_count":1,"open_issues_count":8,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-30T17:28:11.017Z","etag":null,"topics":["java","pgtap","postgres","postgresql","tap","test-anything-protocol","testcontainers","testcontainers-java"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opencastsoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-01T17:15:24.000Z","updated_at":"2024-12-21T22:33:29.000Z","dependencies_parsed_at":"2024-02-20T17:59:24.410Z","dependency_job_id":"a797815c-1a63-4f58-8ef8-dc404d9bcb5f","html_url":"https://github.com/opencastsoftware/pgtap-java","commit_stats":null,"previous_names":["opencastsoftware/pgtap-java"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencastsoftware%2Fpgtap-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencastsoftware%2Fpgtap-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencastsoftware%2Fpgtap-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opencastsoftware%2Fpgtap-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opencastsoftware","download_url":"https://codeload.github.com/opencastsoftware/pgtap-java/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239435017,"owners_count":19638043,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java","pgtap","postgres","postgresql","tap","test-anything-protocol","testcontainers","testcontainers-java"],"created_at":"2024-12-27T09:16:20.977Z","updated_at":"2025-11-04T15:30:27.777Z","avatar_url":"https://github.com/opencastsoftware.png","language":"Java","readme":"# pgtap-java\n\n[![CI](https://github.com/opencastsoftware/pgtap-java/actions/workflows/ci.yml/badge.svg)](https://github.com/opencastsoftware/pgtap-java/actions/workflows/ci.yml)\n[![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)\n[![License](https://img.shields.io/github/license/opencastsoftware/pgtap-java?color=blue)](https://spdx.org/licenses/Apache-2.0.html)\n\nA library for running [pgTAP](https://pgtap.org/) tests using [Testcontainers for Java](https://java.testcontainers.org/).\n\n![A screenshot demonstrating pgTAP test results and descriptions displayed in the IntelliJ Run tool window](./images/example-tests.png)\n\n## Installation\n\n*pgtap-java* is published for Java 11 and above.\n\nGradle (build.gradle / build.gradle.kts):\n```kotlin\ntesting {\n    suites {\n        val test by getting(JvmTestSuite::class) {\n            dependencies {\n                implementation(\"com.opencastsoftware:pgtap-java:0.1.0\")\n            }\n        }\n    }\n}\n```\n\nMaven (pom.xml):\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.opencastsoftware\u003c/groupId\u003e\n    \u003cartifactId\u003epgtap-java\u003c/artifactId\u003e\n    \u003cversion\u003e0.1.0\u003c/version\u003e\n    \u003cscope\u003etest\u003c/scope\u003e\n\u003c/dependency\u003e\n```\n\n## Usage\n\n*pgtap-java* is intended for use with [JUnit 5](https://junit.org/junit5/) and [Testcontainers for Java](https://java.testcontainers.org/).\n\nIn 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.\n\n`PgTapTest` requires 3 constructor parameters:\n\n* `database: PostgreSQLContainer\u003c?\u003e` - 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.\n* `pgTapTestPath: Path` - the path to your pgTAP `.sql` test files\n* `pgTapTmpPath: Path` - the path where the pgTAP `.sql` test files will be mounted inside the PostgreSQL container.\n \nIn 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.\n\nIt doesn't matter precisely what `pgTapTmpPath` you use, as long as you use the same path in the constructor of `PgTapTest` and with `withCopyFileToContainer`.\n\nSee [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.\n\n## Acknowlegements\n\nThis 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.\n\n## License\n\nAll code in this repository is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopencastsoftware%2Fpgtap-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopencastsoftware%2Fpgtap-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopencastsoftware%2Fpgtap-java/lists"}