1
1
# dgoss
2
2
3
- dgoss is a convenience wrapper around goss that aims to bring the simplicity of goss to docker containers.
3
+ dgoss is a convenience wrapper around goss that aims to bring the simplicity of goss to containers.
4
4
5
5
## Examples and Tutorials
6
6
7
7
* [ blog tutorial] ( https://medium.com/@aelsabbahy/tutorial-how-to-test-your-docker-image-in-half-a-second-bbd13e06a4a9 ) -
8
8
Introduction to dgoss tutorial
9
9
* [ video tutorial] ( https://youtu.be/PEHz5EnZ-FM ) - Same as above, but in video format
10
10
* [ dgoss-examples] ( https://github.com/aelsabbahy/dgoss-examples ) - Repo containing examples of using dgoss to validate
11
- docker images
11
+ container images
12
12
13
13
## Installation
14
14
@@ -45,9 +45,10 @@ dgoss run ...
45
45
46
46
### Run
47
47
48
- Run is used to validate a docker container.
48
+ Run is used to validate a container.
49
49
It expects a ` ./goss.yaml ` file to exist in the directory it was invoked from.
50
- In most cases one can just substitute the docker command for the dgoss command, for example:
50
+ In most cases one can just substitute the runtime command (` docker ` or ` podman ` )
51
+ for the dgoss command, for example:
51
52
52
53
** run:**
53
54
@@ -61,13 +62,13 @@ In most cases one can just substitute the docker command for the dgoss command,
61
62
62
63
* Run the container with the flags you specified.
63
64
* Stream the containers log output into the container as ` /goss/docker_output.log `
64
- * This allows writing tests or waits against the docker output
65
+ * This allows writing tests or waits against the container output
65
66
* (optional) Run ` goss ` with ` $GOSS_WAIT_OPTS ` if ` ./goss_wait.yaml ` file exists in the current dir
66
67
* Run ` goss ` with ` $GOSS_OPTS ` using ` ./goss.yaml `
67
68
68
69
### Edit
69
70
70
- Edit will launch a docker container, install goss, and drop the user into an interactive shell.
71
+ Edit will launch a container, install goss, and drop the user into an interactive shell.
71
72
Once the user quits the interactive shell, any ` goss.yaml ` or ` goss_wait.yaml ` are copied out into the current directory.
72
73
This allows the user to leverage the ` goss add|autoadd ` commands to write tests as they would on a regular machine.
73
74
@@ -117,18 +118,18 @@ directory `DGOSS_TEMP_DIR`. (Default: `''`)
117
118
#### GOSS_VARS
118
119
119
120
The name of the variables file relative to ` GOSS_FILES_PATH ` to copy into the
120
- docker container and use for valiation (i.e. ` dgoss run ` ) and copy out of the
121
- docker container when writing tests (i.e. ` dgoss edit ` ). If set, the
121
+ container and use for valiation (i.e. ` dgoss run ` ) and copy out of the
122
+ container when writing tests (i.e. ` dgoss edit ` ). If set, the
122
123
` --vars ` flag is passed to ` goss validate ` commands inside the container.
123
124
If unset (or empty), the ` --vars ` flag is omitted, which is the normal behavior.
124
125
(Default: ` '' ` ).
125
126
126
127
#### GOSS_FILES_STRATEGY
127
128
128
- Strategy used for copying goss files into the docker container. If set to ` 'mount' ` a volume with goss files is mounted
129
+ Strategy used for copying goss files into the container. If set to ` 'mount' ` a volume with goss files is mounted
129
130
and log output is streamed into the container as ` /goss/docker_output.log ` file. Other strategy is ` 'cp' ` which uses
130
- ` 'docker cp' ` command to copy goss files into docker container. With the ` 'cp' ` strategy you lose the ability to write
131
- tests or waits against the docker output. The ` 'cp' ` strategy is required especially when docker daemon is not on the
131
+ ` 'docker cp' ` command to copy goss files into container. With the ` 'cp' ` strategy you lose the ability to write
132
+ tests or waits against the container output. The ` 'cp' ` strategy is required especially when container daemon is not on the
132
133
local machine.
133
134
(Default ` 'mount' ` )
134
135
0 commit comments