Skip to content

Commit 924140f

Browse files
committed
docs: enhance documentation readme
Signed-off-by: Otavio Santana <[email protected]>
1 parent bfacbf3 commit 924140f

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

tck/README.adoc

+34-2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ The Jakarta NoSQL Technology Compatibility Kit (TCK) is a suite of tests designe
77

88
Any Jakarta NoSQL module must pass this test suite to be considered compliant with the Jakarta NoSQL standards.
99

10+
== Software Requirements
11+
12+
To run the Jakarta NoSQL TCK, the following software must be installed:
13+
14+
- **Java Development Kit (JDK)**: Jakarta NoSQL requires at least JDK 17 or later.
15+
- **Apache Maven**: Required to build and execute the test suite.
16+
- **A compatible NoSQL database**: The TCK needs a NoSQL database that conforms to the Jakarta NoSQL API. Ensure the database is running and accessible before executing the tests.
1017

1118
== Dependencies
1219

@@ -92,7 +99,7 @@ com.example.MyTemplateSupplier
9299

93100
- **Database Lifecycle:**
94101

95-
The `TemplateSupplier` is not responsible for managing the database's Lifecycle. The database is expected to be already running when the `Template` instance is created and returned. The `TemplateSupplier` is only responsible for setting up the `Template` with the necessary configuration to interact with the database.
102+
The `TemplateSupplier` is not responsible for managing the database's lifecycle. The database is expected to be already running when the `Template` instance is created and returned. The `TemplateSupplier` is only responsible for setting up the `Template` with the necessary configuration to interact with the database.
96103

97104
- **Template Initialization:**
98105

@@ -102,9 +109,34 @@ com.example.MyTemplateSupplier
102109

103110
=== Example SPI File
104111

105-
Here is how the `META-INF/services/jakarta.nosql.tck.TemplateSupplier` file should look:
112+
Here is how the `META-INF/services/ee.jakarta.tck.nosql.TemplateSupplier` file should look:
106113

107114
[source]
108115
----
109116
com.example.MyTemplateSupplier
110117
----
118+
119+
== Running the Jakarta NoSQL TCK
120+
121+
To execute the Jakarta NoSQL TCK tests and validate the compatibility of an implementation:
122+
123+
1. Ensure that your NoSQL database is running and accessible.
124+
2. Add the required dependencies to your project.
125+
3. Implement and register the `TemplateSupplier` to provide a configured `Template` instance.
126+
4. Use Apache Maven to run the tests with the following command:
127+
128+
[source,bash]
129+
----
130+
mvn clean test
131+
----
132+
133+
This command will execute the test suite and verify whether the Jakarta NoSQL implementation is compliant with the specification.
134+
135+
== Reporting Issues and Filing Challenges
136+
137+
If you encounter any issues while running the Jakarta NoSQL TCK, you can file a challenge or report a bug:
138+
139+
- **Jakarta NoSQL GitHub Repository**: https://github.com/jakartaee/nosql
140+
- **Jakarta NoSQL Mailing List**: Check the Jakarta EE community resources for discussions and support.
141+
142+
Ensure to provide detailed information about the issue, including the database configuration, the implementation under test, and relevant stack traces.

0 commit comments

Comments
 (0)