dockerfile 0.2.1

A Rust library for dynamically generating Dockerfiles.
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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
use std::{
    borrow::Cow,
    convert,
    fmt,
};

/// The `ADD` instruction copies new files, directories or remote file URLs from `<src>` and adds
/// them to the filesystem of the image at the path `<dest>`.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#add).
pub struct Add(Cow<'static, str>);

impl Add {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Add(val.into())
    }
}

impl fmt::Display for Add {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "ADD {}\n", &self.0)
    }
}

/// The `ARG` instruction defines a variable that users can pass at build-time to the builder with
/// the `docker build` command using the `--build-arg <varname>=<value>` flag.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#arg).
pub struct Arg(Cow<'static, str>);

impl Arg {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Arg(val.into())
    }
}

impl fmt::Display for Arg {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "ARG {}\n", &self.0)
    }
}

/// The main purpose of a `CMD` is to provide defaults for an executing container.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#cmd).
pub struct Cmd(Cow<'static, str>);

impl Cmd {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Cmd(val.into())
    }
}

impl fmt::Display for Cmd {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "CMD {}\n", &self.0)
    }
}

/// The `COPY` instruction copies new files or directories from `<src>` and adds them to the
/// filesystem of the container at the path `<dest>`.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#copy).
pub struct Copy(Cow<'static, str>);

impl Copy {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Copy(val.into())
    }
}

impl fmt::Display for Copy {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "COPY {}\n", &self.0)
    }
}

/// Parser directives are optional, and affect the way in which subsequent lines in a `Dockerfile`
/// are handled.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#parser-directives).
pub struct Directive(Cow<'static, str>);

impl Directive {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Directive(val.into())
    }
}

impl fmt::Display for Directive {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "# {}\n", &self.0)
    }
}

/// An `ENTRYPOINT` allows you to configure a container that will run as an executable.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#entrypoint).
pub struct Entrypoint(Cow<'static, str>);

impl Entrypoint {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Entrypoint(val.into())
    }
}

impl fmt::Display for Entrypoint {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "ENTRYPOINT {}\n", &self.0)
    }
}

/// The `ENV` instruction sets the environment variable `<key>` to the value `<value>`.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#env).
pub struct Env(Cow<'static, str>);

impl Env {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Env(val.into())
    }
}

impl fmt::Display for Env {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "ENV {}\n", &self.0)
    }
}

/// The `EXPOSE` instruction informs Docker that the container listens on the specified network
/// ports at runtime.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#expose).
pub struct Expose(Cow<'static, str>);

impl Expose {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Expose(val.into())
    }
}

impl fmt::Display for Expose {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "EXPOSE {}\n", &self.0)
    }
}

/// The `FROM` instruction initializes a new build stage and sets the base image for subsequent
/// instructions.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#from).
pub struct From(Cow<'static, str>);

impl From {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        From(val.into())
    }
}

impl fmt::Display for From {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "FROM {}\n", &self.0)
    }
}

/// The `HEALTHCHECK` instruction tells Docker how to test a container to check that it is still
/// working.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#healthcheck).
pub struct Healthcheck(Cow<'static, str>);

impl Healthcheck {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Healthcheck(val.into())
    }
}

impl fmt::Display for Healthcheck {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "HEALTHCHECK {}\n", &self.0)
    }
}

/// The `LABEL` instruction adds metadata to an image.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#label).
pub struct Label(Cow<'static, str>);

impl Label {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Label(val.into())
    }
}

impl fmt::Display for Label {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "LABEL {}\n", &self.0)
    }
}

/// The `ONBUILD` instruction adds to the image a trigger instruction to be executed at a later
/// time, when the image is used as the base for another build. The trigger will be executed in
/// the context of the downstream build, as if it had been inserted immediately after the `FROM`
/// instruction in the downstream `Dockerfile`.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#onbuild).
pub struct Onbuild(Cow<'static, str>);

impl Onbuild {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Onbuild(val.into())
    }
}

impl fmt::Display for Onbuild {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "ONBUILD {}\n", &self.0)
    }
}

/// The `RUN` instruction will execute any commands in a new layer on top of the current image and
/// commit the results.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#run).
pub struct Run(Cow<'static, str>);

impl Run {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Run(val.into())
    }
}

impl fmt::Display for Run {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "RUN {}\n", &self.0)
    }
}

/// The `SHELL` instruction allows the default shell used for the shell form of commands to be
/// overridden.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#shell).
pub struct Shell(Cow<'static, str>);

impl Shell {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Shell(val.into())
    }
}

impl fmt::Display for Shell {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "SHELL {}\n", &self.0)
    }
}

/// The `STOPSIGNAL` instruction sets the system call signal that will be sent to the container
/// to exit.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#stopsignal).
pub struct Stopsignal(Cow<'static, str>);

impl Stopsignal {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Stopsignal(val.into())
    }
}

impl fmt::Display for Stopsignal {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "STOPSIGNAL {}\n", &self.0)
    }
}

/// The `USER` instruction sets the user name (or UID) and optionally the user group (or GID) to
/// use when running the image and for any `RUN`, `CMD` and `ENTRYPOINT` instructions that follow
/// it in the `Dockerfile`.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#user).
pub struct User(Cow<'static, str>);

impl User {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        User(val.into())
    }
}

impl fmt::Display for User {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "USER {}\n", &self.0)
    }
}

/// The `VOLUME` instruction creates a mount point with the specified name and marks it as holding
/// externally mounted volumes from native host or other containers.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#volume).
pub struct Volume(Cow<'static, str>);

impl Volume {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Volume(val.into())
    }
}

impl fmt::Display for Volume {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "VOLUME {}\n", &self.0)
    }
}

/// The `WORKDIR` instruction sets the working directory for any `RUN`, `CMD`, `ENTRYPOINT`,
/// `COPY` and `ADD` instructions that follow it in the `Dockerfile`.
///
/// [See the docs here](https://docs.docker.com/engine/reference/builder/#workdir).
pub struct Workdir(Cow<'static, str>);

impl Workdir {
    pub fn new<T: Into<Cow<'static, str>>>(val: T) -> Self {
        Workdir(val.into())
    }
}

impl fmt::Display for Workdir {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "WORKDIR {}\n", &self.0)
    }
}

//////////////////////////////////////////////////////////////////////////////////////////////////
// Instruction Enum //////////////////////////////////////////////////////////////////////////////

/// An enum representing all of the different types of Dockerfile instructions available.
///
/// This should be the full list according to the latest
/// [Dockerfile spec here](https://docs.docker.com/engine/reference/builder/). If you notice any
/// missing instructions, please
/// [open an issue here](https://github.com/thedodd/dockerfile/issues/new).
pub enum Instruction {
    Add(Add),
    Arg(Arg),
    Cmd(Cmd),
    Copy(Copy),
    Directive(Directive),
    Entrypoint(Entrypoint),
    Env(Env),
    Expose(Expose),
    From(From),
    Healthcheck(Healthcheck),
    Label(Label),
    Onbuild(Onbuild),
    Run(Run),
    Shell(Shell),
    Stopsignal(Stopsignal),
    User(User),
    Volume(Volume),
    Workdir(Workdir),
}

impl fmt::Display for Instruction {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match self {
            Instruction::Add(inst) => write!(f, "{}", inst),
            Instruction::Arg(inst) => write!(f, "{}", inst),
            Instruction::Cmd(inst) => write!(f, "{}", inst),
            Instruction::Copy(inst) => write!(f, "{}", inst),
            Instruction::Directive(inst) => write!(f, "{}", inst),
            Instruction::Entrypoint(inst) => write!(f, "{}", inst),
            Instruction::Env(inst) => write!(f, "{}", inst),
            Instruction::Expose(inst) => write!(f, "{}", inst),
            Instruction::From(inst) => write!(f, "{}", inst),
            Instruction::Healthcheck(inst) => write!(f, "{}", inst),
            Instruction::Label(inst) => write!(f, "{}", inst),
            Instruction::Onbuild(inst) => write!(f, "{}", inst),
            Instruction::Run(inst) => write!(f, "{}", inst),
            Instruction::Shell(inst) => write!(f, "{}", inst),
            Instruction::Stopsignal(inst) => write!(f, "{}", inst),
            Instruction::User(inst) => write!(f, "{}", inst),
            Instruction::Volume(inst) => write!(f, "{}", inst),
            Instruction::Workdir(inst) => write!(f, "{}", inst),
        }
    }
}

impl convert::From<Add> for Instruction {
    fn from(inst: Add) -> Self {

        Instruction::Add(inst)
    }
}
impl convert::From<Arg> for Instruction {
    fn from(inst: Arg) -> Self {

        Instruction::Arg(inst)
    }
}
impl convert::From<Cmd> for Instruction {
    fn from(inst: Cmd) -> Self {

        Instruction::Cmd(inst)
    }
}
impl convert::From<Copy> for Instruction {
    fn from(inst: Copy) -> Self {

        Instruction::Copy(inst)
    }
}
impl convert::From<Directive> for Instruction {
    fn from(inst: Directive) -> Self {

        Instruction::Directive(inst)
    }
}
impl convert::From<Entrypoint> for Instruction {
    fn from(inst: Entrypoint) -> Self {

        Instruction::Entrypoint(inst)
    }
}
impl convert::From<Env> for Instruction {
    fn from(inst: Env) -> Self {

        Instruction::Env(inst)
    }
}
impl convert::From<Expose> for Instruction {
    fn from(inst: Expose) -> Self {

        Instruction::Expose(inst)
    }
}
impl convert::From<From> for Instruction {
    fn from(inst: From) -> Self {

        Instruction::From(inst)
    }
}
impl convert::From<Healthcheck> for Instruction {
    fn from(inst: Healthcheck) -> Self {

        Instruction::Healthcheck(inst)
    }
}
impl convert::From<Label> for Instruction {
    fn from(inst: Label) -> Self {

        Instruction::Label(inst)
    }
}
impl convert::From<Onbuild> for Instruction {
    fn from(inst: Onbuild) -> Self {

        Instruction::Onbuild(inst)
    }
}
impl convert::From<Run> for Instruction {
    fn from(inst: Run) -> Self {

        Instruction::Run(inst)
    }
}
impl convert::From<Shell> for Instruction {
    fn from(inst: Shell) -> Self {

        Instruction::Shell(inst)
    }
}
impl convert::From<Stopsignal> for Instruction {
    fn from(inst: Stopsignal) -> Self {

        Instruction::Stopsignal(inst)
    }
}
impl convert::From<User> for Instruction {
    fn from(inst: User) -> Self {

        Instruction::User(inst)
    }
}
impl convert::From<Volume> for Instruction {
    fn from(inst: Volume) -> Self {

        Instruction::Volume(inst)
    }
}
impl convert::From<Workdir> for Instruction {
    fn from(inst: Workdir) -> Self {

        Instruction::Workdir(inst)
    }
}