Skip to content

Commit 9623021

Browse files
DavidGregory084DavidGregory084
committed
Initial commit
0 parents  commit 9623021

18 files changed

+1059
-0
lines changed

‎.gitattributes

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#
2+
# https://help.github.com/articles/dealing-with-line-endings/
3+
#
4+
# Linux start script should use lf
5+
/gradlew text eol=lf
6+
7+
# These are Windows script files and should use crlf
8+
*.bat text eol=crlf
9+

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.gradle/
2+
.idea/
3+
.vscode/
4+
bin/
5+
build/

‎LICENSE

+202
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎README.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# pgtap-java
2+
3+
[![CI](https://github.com/opencastsoftware/pgtap-java/actions/workflows/ci.yml/badge.svg)](https://github.com/opencastsoftware/pgtap-java/actions/workflows/ci.yml)
4+
[![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)
5+
[![License](https://img.shields.io/github/license/opencastsoftware/pgtap-java?color=blue)](https://spdx.org/licenses/Apache-2.0.html)
6+
7+
A library for running [pgTAP](https://pgtap.org/) tests using [Testcontainers for Java](https://java.testcontainers.org/).
8+
9+
![A screenshot demonstrating pgTAP test results and descriptions displayed in the IntelliJ Run tool window](./images/example-tests.png)
10+
11+
## Installation
12+
13+
*pgtap-java* is published for Java 11 and above.
14+
15+
Gradle (build.gradle / build.gradle.kts):
16+
```kotlin
17+
testing {
18+
suites {
19+
val test by getting(JvmTestSuite::class) {
20+
dependencies {
21+
implementation("com.opencastsoftware:pgtap-java:0.1.0")
22+
}
23+
}
24+
}
25+
}
26+
```
27+
28+
Maven (pom.xml):
29+
```xml
30+
<dependency>
31+
<groupId>com.opencastsoftware</groupId>
32+
<artifactId>pgtap-java</artifactId>
33+
<version>0.1.0</version>
34+
<scope>test</scope>
35+
</dependency>
36+
```
37+
38+
## Usage
39+
40+
*pgtap-java* is intended for use with [JUnit 5](https://junit.org/junit5/) and [Testcontainers for Java](https://java.testcontainers.org/).
41+
42+
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.
43+
44+
`PgTapTest` requires 3 constructor parameters:
45+
46+
* `database: PostgreSQLContainer<?>` - a [Testcontainers PostgreSQL](https://java.testcontainers.org/modules/databases/postgres/) database container.
47+
* `pgTapTestPath: Path` - the path to your pgTAP `.sql` test files
48+
* `pgTapTmpPath: Path` - the path where the pgTAP `.sql` test files will be mounted inside the PostgreSQL container.
49+
50+
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.
51+
52+
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`.
53+
54+
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.
55+
56+
## Acknowlegements
57+
58+
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.
59+
60+
## License
61+
62+
All code in this repository is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE).

‎build.gradle.kts

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
plugins {
2+
`java-library`
3+
alias(libs.plugins.gradleJavaConventions)
4+
}
5+
6+
repositories { mavenCentral() }
7+
8+
group = "com.opencastsoftware"
9+
10+
description = "A library for running pgTAP tests using Testcontainers Java"
11+
12+
spotless { ratchetFrom("") }
13+
14+
java { toolchain.languageVersion.set(JavaLanguageVersion.of(11)) }
15+
16+
dependencies {
17+
api(platform(libs.testcontainersBom))
18+
api(libs.testcontainersPostgres)
19+
api(libs.junitJupiter)
20+
21+
implementation(libs.tap4j) { exclude("org.yaml", "snakeyaml") }
22+
}
23+
24+
mavenPublishing {
25+
coordinates("com.opencastsoftware", "pgtap-java", project.version.toString())
26+
27+
pom {
28+
name.set("pgtap-java")
29+
description.set(project.description)
30+
url.set("https://github.com/opencastsoftware/pgtap-java")
31+
inceptionYear.set("2024")
32+
licenses {
33+
license {
34+
name.set("The Apache License, Version 2.0")
35+
url.set("http://www.apache.org/licenses/LICENSE-2.0.txt")
36+
distribution.set("repo")
37+
}
38+
}
39+
organization {
40+
name.set("Opencast Software Europe Ltd")
41+
url.set("https://opencastsoftware.com")
42+
}
43+
developers {
44+
developer {
45+
id.set("DavidGregory084")
46+
name.set("David Gregory")
47+
organization.set("Opencast Software Europe Ltd")
48+
organizationUrl.set("https://opencastsoftware.com/")
49+
timezone.set("Europe/London")
50+
url.set("https://github.com/DavidGregory084")
51+
}
52+
}
53+
ciManagement {
54+
system.set("Github Actions")
55+
url.set("https://github.com/opencastsoftware/pgtap-java/actions")
56+
}
57+
issueManagement {
58+
system.set("GitHub")
59+
url.set("https://github.com/opencastsoftware/pgtap-java/issues")
60+
}
61+
scm {
62+
connection.set("scm:git:https://github.com/opencastsoftware/pgtap-java.git")
63+
developerConnection.set("scm:git:[email protected]:opencastsoftware/pgtap-java.git")
64+
url.set("https://github.com/opencastsoftware/pgtap-java")
65+
}
66+
}
67+
}
68+
69+
testing {
70+
suites {
71+
val test by
72+
getting(JvmTestSuite::class) {
73+
useJUnitJupiter(libs.versions.junit)
74+
dependencies {
75+
implementation(libs.testcontainersJunit)
76+
implementation(libs.flywayCore)
77+
implementation(libs.logback)
78+
runtimeOnly(libs.postgresql)
79+
}
80+
}
81+
}
82+
}
83+
84+
tasks.withType<JavaCompile> {
85+
// Target Java 11
86+
options.release.set(11)
87+
}

‎gradle.properties

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
org.gradle.parallel=true
2+
org.gradle.caching=true
3+

‎gradle/libs.versions.toml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
[versions]
2+
flyway = "9.22.1"
3+
gradleJavaConventions = "0.1.4"
4+
jacoco = "0.8.8"
5+
junit = "5.10.1"
6+
logback = "1.4.14"
7+
postgresql = "42.6.0"
8+
tap4j = "4.4.2"
9+
testcontainers = "1.19.3"
10+
11+
[libraries]
12+
flywayCore = { module = "org.flywaydb:flyway-core", version.ref = "flyway" }
13+
junitJupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit" }
14+
logback = { module = "ch.qos.logback:logback-classic", version.ref = "logback" }
15+
postgresql = { module = "org.postgresql:postgresql", version.ref = "postgresql" }
16+
tap4j = { module = "org.tap4j:tap4j", version.ref = "tap4j" }
17+
testcontainersBom = { module = "org.testcontainers:testcontainers-bom", version.ref = "testcontainers" }
18+
testcontainersJunit = { module = "org.testcontainers:junit-jupiter" }
19+
testcontainersPostgres = { module = "org.testcontainers:postgresql" }
20+
21+
[plugins]
22+
gradleJavaConventions = { id = "com.opencastsoftware.gradle.java-conventions", version.ref = "gradleJavaConventions" }

‎gradle/wrapper/gradle-wrapper.jar

42.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)