Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update readme #1636

Closed
wants to merge 1 commit into from
Closed

doc: update readme #1636

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions spring-data-jdbc/README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ If you are new to Spring Data JDBC read the following two articles https://sprin
There are also examples in the https://github.com/spring-projects/spring-data-examples/tree/master/jdbc[Spring Data Examples] project.

A very good source of information is the source code in this repository.
Especially the integration tests (if you are reading this on github, type `t` and then `IntegrationTests.java`)
Especially the integration tests (if you are reading this on GitHub, type `t` and then `IntegrationTests.java`)

We are keeping an eye on the (soon to be created) https://stackoverflow.com/questions/tagged/spring-data-jdbc[spring-data-jdbc tag on stackoverflow].
We are keeping an eye on the https://stackoverflow.com/questions/tagged/spring-data-jdbc[spring-data-jdbc tag on Stack Overflow].

If you think you found a bug, or have a feature request please https://github.com/spring-projects/spring-data-jdbc/issues[create a ticket in our issue tracker].
If you think you found a bug, or have a feature request, please https://github.com/spring-projects/spring-data-jdbc/issues[create a ticket in our issue tracker].

== Execute Tests

Expand All @@ -44,7 +44,7 @@ This will execute unit tests and integration tests using an in-memory database.

=== Running tests with a real database

In order to run the integration tests against a specific database you need to have a local Docker installation available, and then execute.
In order to run the integration tests against a specific database, you need to have a local Docker installation available, and then execute.

[source]
----
Expand All @@ -53,16 +53,16 @@ mvn test -Dspring.profiles.active=<databasetype>

This will also execute the unit tests.

Currently the following _databasetypes_ are available:
Currently, the following _databasetypes_ are available:

* hsql (default, does not require a running database)
* mysql
* postgres
* mariadb
* mssql

Testing with Microsoft SQL Server requires you to accept the EULA of the Microsoft SQL Server Docker image, so the build may download and run it for you.
In order to accept the EULA please add a file named `container-license-acceptance.txt` to the classpath, i.e. `src/test/resources` with the content:
Testing with Microsoft SQL Server requires you to accept the EULA of the Microsoft SQL Server Docker image so that the build may download and run it for you.
In order to accept the EULA, please add a file named `container-license-acceptance.txt` to the classpath, i.e. `src/test/resources` with the content:

```
microsoft/mssql-server-linux:2017-CU6
Expand All @@ -75,4 +75,4 @@ microsoft/mssql-server-linux:2017-CU6
mvn test -Pall-dbs
----

This will execute the unit tests, and all the integration tests with all the databases we currently support for testing. Running the integration-tests depends on Docker.
This will execute the unit tests and all the integration tests with all the databases we currently support for testing. Running the integration-tests depends on Docker.
Loading