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
use crate::docker::Docker;
use crate::{
composition::Composition, DockerTestError, Network, OperationalContainer, PendingContainer,
};
use std::{
collections::{HashMap, HashSet},
sync::Arc,
};
use tokio::sync::RwLock;
#[derive(Default)]
pub struct InternalContainers {
inner: Arc<RwLock<HashMap<String, InternalContainer>>>,
}
/// Represent a single internal, managed container.
struct InternalContainer {
/// Current status of the container.
status: InternalStatus,
/// Represents a usage counter of the internal container.
///
/// This counter is incremented for each test that uses this internal container.
/// On test completion each test will decrement this counter and test which decrements it to 0
/// will perform the cleanup of the container.
completion_counter: u8,
}
/// Represents the different states of a internal container.
// NOTE: allowing this clippy warning in pending of refactor
#[allow(clippy::large_enum_variant)]
enum InternalStatus {
/// As tests execute concurrently other tests might have already executed the WaitFor
/// implementation and created a Operational container. However, as we do not want to alter our
/// pipeline of Composition -> PendingContainer -> OperationalContainer and start order logistics.
/// We store a clone of the pending container here such that tests can return a
/// clone of it if they are "behind" in the pipeline.
Operational(OperationalContainer, PendingContainer),
Pending(PendingContainer),
/// If a test utilizes the same managed internal container with other tests, and completes
/// the entire test including cleanup prior to other tests even registering their need for
/// the same managed internal container, then it will be cleaned up. This is to avoid
/// leaking the container on binary termination.
///
/// The remaining tests should create the container again during container creation.
/// This status is only set during container cleanup.
Cleaned,
/// Keeps the id of the failed container for cleanup purposes.
///
/// If the container failed to be created the id will be None as we have not container id yet
/// and no cleanup will be necessary.
/// If the container failed to be started, the id will be present and we will need
/// to remove the container.
Failed(DockerTestError, Option<String>),
}
impl InternalContainers {
pub async fn create(
&self,
composition: Composition,
client: &Docker,
network: Option<&str>,
network_setting: &Network,
) -> Result<PendingContainer, DockerTestError> {
let container = self
.create_internal_container_inner(composition, client, network, network_setting)
.await?;
Ok(container)
}
pub async fn start(
&self,
container: &PendingContainer,
) -> Result<OperationalContainer, DockerTestError> {
let mut map = self.inner.write().await;
// If we are the first test to try to start the container we are responsible for starting
// it and adding the OperationalContainer instance to the global map.
// We also keep the PendingContainer instance as other tests might not have reached this
// far in their pipeline and need a PendingContainer instance.
if let Some(c) = map.get_mut(&container.name) {
match &c.status {
InternalStatus::Failed(e, _) => Err(e.clone()),
InternalStatus::Operational(r, _) => Ok(r.clone()),
InternalStatus::Pending(p) => {
let cloned = p.clone();
let running = cloned.start_inner().await;
match running {
Ok(r) => {
c.status = InternalStatus::Operational(r.clone(), p.clone());
Ok(r)
}
Err(e) => {
c.status =
InternalStatus::Failed(e.clone(), Some(container.id.clone()));
Err(e)
}
}
}
// This should never occur as we set the completion_counter to 1 when
// we encounter a Cleaned container during creation, hence the container will never
// have it status set to Cleaned before this `Dockertest` instance has performed
// cleanup.
InternalStatus::Cleaned => Err(DockerTestError::Startup(
"encountered a cleaned container during startup".to_string(),
)),
}
} else {
Err(DockerTestError::Startup(
"tried to start a non-existing internal container".to_string(),
))
}
}
pub async fn cleanup(&self, client: &Docker, network: &str, to_cleanup: &HashSet<&str>) {
self.disconnect(client, network, to_cleanup).await;
let to_remove = self.decrement_completion_counters(to_cleanup).await;
for to_cleanup in to_remove {
client.remove_container(&to_cleanup).await;
}
}
async fn create_internal_container_inner(
&self,
composition: Composition,
client: &Docker,
network: Option<&str>,
network_setting: &Network,
) -> Result<PendingContainer, DockerTestError> {
let mut map = self.inner.write().await;
// If we are the first test to try to create this container we are responsible for
// container creation and inserting a InternalContainer in the global map with the
// PendingContainer instance.
// Static containers have to be apart of all the test networks such that they
// are reachable from all tests.
//
// When `Network::Singular/Network::External` is used only the first test needs to add it to the
// network.
if let Some(c) = map.get_mut(&composition.container_name) {
match &c.status {
InternalStatus::Pending(p) | InternalStatus::Operational(_, p) => {
// Only when the Isolated network mode is set do we need to add it to the
// network, as for External/Singular it will be added upon creation.
match (network, network_setting) {
(Some(n), Network::Isolated) => {
client.add_container_to_network(&p.id, n).await
}
_ => Ok(()),
}?;
c.completion_counter += 1;
Ok(p.clone())
}
InternalStatus::Failed(e, _) => {
c.completion_counter += 1;
Err(e.clone())
}
InternalStatus::Cleaned => {
let container = self
.create_internal_container_impl(&mut map, composition, client, network)
.await?;
// This is the same case as upon first container creation
if let Some(n) = network {
client.add_container_to_network(&container.id, n).await?;
}
Ok(container)
}
}
} else {
let container = self
.create_internal_container_impl(&mut map, composition, client, network)
.await?;
// First to create the container adds it to the network regardless of which network
// mode is set
if let Some(n) = network {
client.add_container_to_network(&container.id, n).await?;
}
Ok(container)
}
}
async fn create_internal_container_impl(
&self,
containers: &mut HashMap<String, InternalContainer>,
composition: Composition,
client: &Docker,
network: Option<&str>,
) -> Result<PendingContainer, DockerTestError> {
let container_name = composition.container_name.clone();
let pending = client.create_container_inner(composition, network).await;
match pending {
Ok(p) => {
let c = InternalContainer {
status: InternalStatus::Pending(p.clone()),
completion_counter: 1,
};
containers.insert(container_name, c);
Ok(p)
}
Err(e) => {
let c = InternalContainer {
status: InternalStatus::Failed(e.clone(), None),
completion_counter: 1,
};
containers.insert(container_name, c);
Err(e)
}
}
}
async fn disconnect(&self, client: &Docker, network: &str, to_cleanup: &HashSet<&str>) {
let map = self.inner.read().await;
for (_, container) in map.iter() {
if let InternalStatus::Operational(r, _) = &container.status {
if to_cleanup.contains(r.id()) {
client.disconnect_container(r.id(), network).await;
}
}
}
}
async fn decrement_completion_counters(&self, to_cleanup: &HashSet<&str>) -> Vec<String> {
let mut containers = self.inner.write().await;
let mut responsible_to_remove = Vec::new();
// We assume that if the container failed to be started the container id will be
// present on the Failure enum variant.
// This should be set by the start method.
for (_, container) in containers.iter_mut() {
if let Some(container_id) = container.status.container_id() {
if to_cleanup.contains(container_id) {
container.completion_counter -= 1;
if container.completion_counter == 0 {
responsible_to_remove.push(container_id.to_string());
container.status = InternalStatus::Cleaned;
}
}
}
}
responsible_to_remove
}
}
impl InternalStatus {
fn container_id(&self) -> Option<&str> {
match &self {
InternalStatus::Operational(_, r) => Some(r.id.as_str()),
InternalStatus::Pending(p) => Some(p.id.as_str()),
InternalStatus::Failed(_, container_id) => container_id.as_ref().map(|id| id.as_str()),
InternalStatus::Cleaned => None,
}
}
}