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

use crate::error::OciSpecError;
use derive_builder::Builder;
use getset::{CopyGetters, Getters, MutGetters, Setters};
use serde::{Deserialize, Serialize};
use std::path::PathBuf;

#[derive(
    Builder,
    Clone,
    Debug,
    Default,
    Deserialize,
    Eq,
    MutGetters,
    Getters,
    Setters,
    PartialEq,
    Serialize,
)]
#[serde(rename_all = "camelCase")]
#[builder(
    default,
    pattern = "owned",
    setter(into, strip_option),
    build_fn(error = "OciSpecError")
)]
#[getset(get_mut = "pub", get = "pub", set = "pub")]
/// Hooks specifies a command that is run in the container at a particular
/// event in the lifecycle (setup and teardown) of a container.
pub struct Hooks {
    #[deprecated(
        note = "Prestart hooks were deprecated in favor of `createRuntime`, `createContainer` and `startContainer` hooks"
    )]
    #[serde(default, skip_serializing_if = "Option::is_none")]
    /// The `prestart` hooks MUST be called after the `start` operation is
    /// called but before the user-specified program command is
    /// executed.
    ///
    /// On Linux, for example, they are called after the container
    /// namespaces are created, so they provide an opportunity to
    /// customize the container (e.g. the network namespace could be
    /// specified in this hook).
    ///
    /// The `prestart` hooks' path MUST resolve in the runtime namespace.
    /// The `prestart` hooks MUST be executed in the runtime namespace.
    prestart: Option<Vec<Hook>>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    /// CreateRuntime is a list of hooks to be run after the container has
    /// been created but before `pivot_root` or any equivalent
    /// operation has been called. It is called in the Runtime
    /// Namespace.
    create_runtime: Option<Vec<Hook>>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    /// CreateContainer is a list of hooks to be run after the container has
    /// been created but before `pivot_root` or any equivalent
    /// operation has been called. It is called in the
    /// Container Namespace.
    create_container: Option<Vec<Hook>>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    /// StartContainer is a list of hooks to be run after the start
    /// operation is called but before the container process is
    /// started. It is called in the Container Namespace.
    start_container: Option<Vec<Hook>>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    /// Poststart is a list of hooks to be run after the container process
    /// is started. It is called in the Runtime Namespace.
    poststart: Option<Vec<Hook>>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    /// Poststop is a list of hooks to be run after the container process
    /// exits. It is called in the Runtime Namespace.
    poststop: Option<Vec<Hook>>,
}

#[derive(
    Builder,
    Clone,
    CopyGetters,
    Debug,
    Default,
    Deserialize,
    Eq,
    Getters,
    MutGetters,
    Setters,
    PartialEq,
    Serialize,
)]
#[builder(
    default,
    pattern = "owned",
    setter(into, strip_option),
    build_fn(error = "OciSpecError")
)]
/// Hook specifies a command that is run at a particular event in the
/// lifecycle of a container.
pub struct Hook {
    #[getset(get_mut = "pub", get = "pub", set = "pub")]
    /// Path to the binary to be executed. Following similar semantics to
    /// [IEEE Std 1003.1-2008 `execv`'s path](https://pubs.opengroup.org/onlinepubs/9699919799/functions/exec.html). This
    /// specification extends the IEEE standard in that path MUST be
    /// absolute.
    path: PathBuf,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[getset(get_mut = "pub", get = "pub", set = "pub")]
    /// Arguments used for the binary, including the binary name itself.
    /// Following the same semantics as [IEEE Std 1003.1-2008
    /// `execv`'s argv](https://pubs.opengroup.org/onlinepubs/9699919799/functions/exec.html).
    args: Option<Vec<String>>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[getset(get_mut = "pub", get = "pub", set = "pub")]
    /// Additional `key=value` environment variables. Following the same
    /// semantics as [IEEE Std 1003.1-2008's `environ`](https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html#tag_08_01).
    env: Option<Vec<String>>,

    #[serde(default, skip_serializing_if = "Option::is_none")]
    #[getset(get_mut = "pub", get_copy = "pub", set = "pub")]
    /// Timeout is the number of seconds before aborting the hook. If set,
    /// timeout MUST be greater than zero.
    timeout: Option<i64>,
}