Skip to content

Commit

Permalink
Updated docs in mention minmum Docker version to run DB backed tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@milessabin
milessabin committed Nov 16, 2024
1 parent 5713e14 commit 6dc639c
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,16 @@ libraryDependencies += "org.typelevel" %% "grackle-doobie-oracle" % "0.22.0"
libraryDependencies += "org.typelevel" %% "grackle-doobie-mssql" % "0.22.0"
```

## Running tests for database backed mappings

Database backed mappings are tested against dockerized instances of Postgres, Oracle and SQL Server. This requires
Docker 2.20.2 or later to be installed and running on the test machine.

Running tests (eg. `rootJVM/test`) will automatically spin up the relevant containers, which will stay up and can be
reused across multiple tests runs, significantly speeding up the test cycle. I recommend running `allUp` initially, to
pull images and initialise databases, before running tests the first time. Note that Oracle in particular takes quite
a long time to initialise, so expect `allUp` to take several minutes to complete the first time around.

## Community

Grackle is proud to be a [Typelevel](https://typelevel.org/) project. We are committed to providing a friendly, safe
Expand Down
10 changes: 10 additions & 0 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,16 @@ libraryDependencies += "org.typelevel" %% "grackle-doobie-oracle" % "@VERSION@"
libraryDependencies += "org.typelevel" %% "grackle-doobie-mssql" % "@VERSION@"
```

## Running tests for database backed mappings

Database backed mappings are tested against dockerized instances of Postgres, Oracle and SQL Server. This requires
Docker 2.20.2 or later to be installed and running on the test machine.

Running tests (eg. `rootJVM/test`) will automatically spin up the relevant containers, which will stay up and can be
reused across multiple tests runs, significantly speeding up the test cycle. I recommend running `allUp` initially, to
pull images and initialise databases, before running tests the first time. Note that Oracle in particular takes quite
a long time to initialise, so expect `allUp` to take several minutes to complete the first time around.

## Community

Grackle is proud to be a [Typelevel](https://typelevel.org/) project. We are committed to providing a friendly, safe
Expand Down

0 comments on commit 6dc639c

Please sign in to comment.