Skip to content

Commit 5b86341

Browse files
committed
chore: added documentation about performing the Jakarta NoSQL TCK
Signed-off-by: Maximillian Arruda <[email protected]>
1 parent 7248bbe commit 5b86341

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.adoc

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1960,6 +1960,42 @@ class IntegrationSampleTest {
19601960
}
19611961
----
19621962

1963+
== Performing the Jakarta NoSQL TCK
1964+
1965+
To perform the Jakarta NoSQL TCK you should activate the `tck` profile. This profile will download the TCK and run it.
1966+
1967+
[IMPORTANT]
1968+
====
1969+
By default, the TCK will run in all modules that have the `tck.nosql.skip` property defined as `false`.
1970+
====
1971+
1972+
[source,bash]
1973+
----
1974+
mvn test -Ptck
1975+
----
1976+
1977+
To run the Jakarta NoSQL TCK only in a specific module, you can use the `-pl` option, for example:
1978+
1979+
[source,bash]
1980+
----
1981+
mvn test -Ptck -pl jnosql-mongodb
1982+
----
1983+
1984+
1985+
[IMPORTANT]
1986+
====
1987+
By default, activating the `tck` profile does not disable the execution of the default tests. To skip the default tests you can use `-DskipTests`. It will skip the unit tests and run only the TCK tests.
1988+
[source,bash]
1989+
----
1990+
mvn test -Ptck -DskipTests
1991+
----
1992+
====
1993+
1994+
The JNoSQL Database API implementations that support Jakarta NoSQL TCK execution already:
1995+
1996+
- link:#_mongodb[MongoDB]
1997+
1998+
19631999
== Want to Contribute a New Driver?
19642000

19652001
As an open-source project, you're free to create any driver, and you're welcome to join and participate in the process.

0 commit comments

Comments
 (0)