1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
|
#+TITLE: Making docker-compose easier with wdocker
#+DATE: 2016-02-21
#+COLESLAW_TAGS: wdocker docker docker-compose
#+OPTIONS: num:nil
* Introduction
[[https://github.com/babab/wdocker][wdocker]] is a little utility written by a [[https://benjamin.althu.es][friend]] and former colleague
of mine. It allows you to define commands for it in a
~Dockerfile~. He wrote it because he used a lot of composite
commands when writing docker images like:
#+BEGIN_SRC sh
docker stop CONTAINER && docker rm CONTAINER && docker rmi IMAGE && \
docker build -t IMAGE && docker run --name CONTAINER IMAGE
#+END_SRC
By using wdocker to define a command he can greatly simplify his own
workflow. Let's call it rebuild:
#+BEGIN_SRC dockerfile
#wd# container = CONTAINER
#wd# image = IMAGE
#wd# stop = docker stop {container}
#wd# rm = docker rm {container}
#wd# rmi = docker rmi {container}
#wd# build = docker build -t {image}
#wd# run = docker run --name {container} {image}
#wd# rebuild: {stop} && {rm} && {rmi} && {build} && {run}
FROM ubuntu
# ...
#+END_SRC
Now he can use the following command instead of the list presented
before:
: wdocker rebuild
* Syntax
wdocker has very simple syntax. You can define variables and
commands:
: #wd# variable = value
: #wd# command: program
Variables can be used by putting them in braces, including in other
variables, as you've seen in the first example.
: #wd# variable = -l
: #wd# list: ls {variable}
This would run =ls -l= when the command =wdocker list= is called.
As you can see you're not limited to using docker in your wdocker
commands. This property is what allows me to use wdocker in my
workflow.
* Combining with docker-compose
I started using docker not too long ago at work to develop our
projects in. This is nice because it allows me to completely isolate
my development environments. Since we have a few processes running
together a single docker image isn't a great option, so I use
docker-compose to define and combine the containers I need.
As a side-effect this requires me to write long commands to do
something like run rspec tests:
: docker-compose run --rm -e RACK_ENV=test -e RAILS_ENV=test \
: container bundle exec rspec
The alternative is defining a specialized test container with a
bogus entry command (such as ~true~) and use that, which would still
make the command:
: docker-compose run --rm test-container bundle exec rspec
Instead I can define a wdocker command in the ~Dockerfile~ used to
build the containers used:
#+BEGIN_SRC dockerfile
#wd# rspec: docker-compose run --rm -e RACK_ENV=test -e RAILS_ENV=test container bundle exec rspec
FROM ruby
#...
#+END_SRC
Now I can run the following, much shorter, command to run the rspec
tests:
: wdocker rspec
We also use cucumber for some other tests, which is even longer to
type in, adding the ~cucumber~ command is easy:
#+BEGIN_SRC dockerfile
#wd# rspec: docker-compose run --rm -e RACK_ENV=test -e RAILS_ENV=test container bundle exec rspec
#wd# cucumber: docker-compose run --rm -e RACK_ENV=test -e RAILS_ENV=test container bundle exec cucumber
FROM ruby
# ...
#+END_SRC
Now I can run =wdocker cucumber= as well.
The latest git version of wdocker passes any arguments after the
command name directly to the command to be executed. So if I need to
run tests in a single spec file I can just do:
: wdocker rspec spec/models/mymodel_spec.rb
We have two commands defined now that are 90% the same. I always use
the ~--rm~ switch to remove the started container after it's done, I
don't want a lot of containers piling up. I also always have to use
~bundle exec~ to run commands, since the containers don't use rvm or
add the script directories to ~$PATH~. We can extract them to some
variables:
#+BEGIN_SRC dockerfile
#wd# run = docker-compose run --rm
#wd# exec = bundle exec
#wd# test = -e RACK_ENV=test -e RAILS_ENV=test
#wd# rspec: {run} {test} container {exec} rspec
#wd# cucumber: {run} {test} container {exec} cucumber
FROM ruby
# ...
#+END_SRC
Right now these commands always use the ~container~ service defined
in ~docker-compose.yml~. I could add it to the ~run~ command, but I
might need to run some commands on another container, but I can
define another variable:
#+BEGIN_SRC dockerfile
#wd# run = docker-compose run --rm
#wd# test = -e RACK_ENV=test -e RAILS_ENV=test
#wd# run-test-container = {run} {test} container
#wd# exec = bundle exec
#wd# rspec: {run-test-container} {exec} rspec
#wd# cucumber: {run-test-container} {exec} cucumber
FROM ruby
# ...
#+END_SRC
Now you also see that variables can be nested in other variables.
If you ever forget what you defined or if the mix of commands and
variables becomes too much for you, you can call the wdocker command
without arguments to see the commands you defined and the shell
commands they'll run.
|
