luciano/testcontainers-clj
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

8 - Corrected documentation

Browse source
This commit is contained in:
Tim Zöller 2020-08-05 22:37:43 +02:00
parent 5f6c9d21ad
commit 7e436715c0
1 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -68,7 +68,7 @@ Creates a testcontainers instance from a given Docker label and returns them
| `:exposed-ports` | Vector with ints, mandatory | All ports which should be exposed and mapped to a local port | | `:exposed-ports` | Vector with ints, mandatory | All ports which should be exposed and mapped to a local port |
| `:env-vars` | Map | A map with environment variables| | `:env-vars` | Map | A map with environment variables|
| `:command` | Vector with strings | The start command of the container| | `:command` | Vector with strings | The start command of the container|
| `:network` | | A map containing the configuration of a Docker Network (see: `init-network`)| | `:network` | Map | A map containing the configuration of a Docker Network (see: `init-network`)|
| `:network-aliases` | Map | A list of alias names for the container on the network | | `:network-aliases` | Map | A list of alias names for the container on the network |
#### Result: #### Result:
@ -105,7 +105,7 @@ Initializes a given Testcontainer, which was e.g. provided by a library
| `:exposed-ports` | Vector with ints, mandatory | All ports which should be exposed and mapped to a local port | | `:exposed-ports` | Vector with ints, mandatory | All ports which should be exposed and mapped to a local port |
| `:env-vars` | Map | A map with environment variables| | `:env-vars` | Map | A map with environment variables|
| `:command` | Vector with strings | The start command of the container| | `:command` | Vector with strings | The start command of the container|
| `:network` | | A map containing the configuration of a Docker Network (see: `init-network`)| | `:network` | Map | A map containing the configuration of a Docker Network (see: `init-network`)|
| `:network-aliases` | Map | A list of alias names for the container on the network | | `:network-aliases` | Map | A list of alias names for the container on the network |
#### Result: #### Result:
@ -121,12 +121,12 @@ Initializes a given Testcontainer, which was e.g. provided by a library
```clojure ```clojure
;; PostgreSQL container needs a separate library! This is not included. ;; PostgreSQL container needs a separate library! This is not included.
(create {:container (org.testcontainers.containers.PostgreSQLContainer) (init {:container (org.testcontainers.containers.PostgreSQLContainer)
:exposed-ports [80] :exposed-ports [80]
:env-vars {"MAGIC_NUMBER" "42"} :env-vars {"MAGIC_NUMBER" "42"}
:command ["/bin/sh" :command ["/bin/sh"
"-c" "-c"
"while true; do echo \"$MAGIC_NUMBER\" | nc -l -p 80; done"]}) "while true; do echo \"$MAGIC_NUMBER\" | nc -l -p 80; done"]})
``` ```
### create-from-docker-file ### create-from-docker-file
@ -140,7 +140,7 @@ Creates a testcontainer from a Dockerfile
| `:exposed-ports` | Vector with ints, mandatory | All ports which should be exposed and mapped to a local port | | `:exposed-ports` | Vector with ints, mandatory | All ports which should be exposed and mapped to a local port |
| `:env-vars` | Map | A map with environment variables| | `:env-vars` | Map | A map with environment variables|
| `:command` | Vector with strings | The start command of the container| | `:command` | Vector with strings | The start command of the container|
| `:network` | | A map containing the configuration of a Docker Network (see: `init-network`)| | `:network` | Map | A map containing the configuration of a Docker Network (see: `init-network`)|
| `:network-aliases` | Map | A list of alias names for the container on the network | | `:network-aliases` | Map | A list of alias names for the container on the network |
#### Result: #### Result:
@ -155,12 +155,12 @@ Creates a testcontainer from a Dockerfile
#### Example: #### Example:
```clojure ```clojure
(create {:docker-file "resources/Dockerfile" (create-from-docker-file {:docker-file "resources/Dockerfile"
:exposed-ports [5432] :exposed-ports [5432]
:env-vars {"MAGIC_NUMBER" "42"} :env-vars {"MAGIC_NUMBER" "42"}
:command ["/bin/sh" :command ["/bin/sh"
"-c" "-c"
"while true; do echo \"$MAGIC_NUMBER\" | nc -l -p 80; done"]}) "while true; do echo \"$MAGIC_NUMBER\" | nc -l -p 80; done"]})
``` ```
--- ---