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
|
//
// Copyright (c) 2020-2021 science+computing ag and other contributors
//
// This program and the accompanying materials are made
// available under the terms of the Eclipse Public License 2.0
// which is available at https://www.eclipse.org/legal/epl-2.0/
//
// SPDX-License-Identifier: EPL-2.0
//
use std::collections::HashMap;
use anyhow::anyhow;
use anyhow::Context;
use anyhow::Error;
use anyhow::Result;
use getset::Getters;
use log::{debug, trace, warn};
use tokio::stream::StreamExt;
use uuid::Uuid;
use crate::config::Configuration;
use crate::filestore::MergedStores;
use crate::job::Job;
use crate::job::JobResource;
use crate::package::Package;
use crate::package::ParseDependency;
use crate::package::Script;
use crate::package::ScriptBuilder;
use crate::source::SourceCache;
use crate::source::SourceEntry;
use crate::util::docker::ImageName;
use crate::util::EnvironmentVariableName;
/// A job configuration that can be run. All inputs are clear here.
#[derive(Debug, Getters)]
pub struct RunnableJob {
#[getset(get = "pub")]
uuid: Uuid,
#[getset(get = "pub")]
package: Package,
#[getset(get = "pub")]
image: ImageName,
#[getset(get = "pub")]
source_cache: SourceCache,
#[getset(get = "pub")]
script: Script,
#[getset(get = "pub")]
resources: Vec<JobResource>,
}
impl RunnableJob {
pub async fn build_from_job(
job: Job,
merged_stores: &MergedStores,
source_cache: &SourceCache,
config: &Configuration,
) -> Result<Self> {
trace!("Preparing build dependencies");
let resources = {
let mut resources = job
.package()
.dependencies()
.build()
.iter()
.map(|dep| Self::build_resource(dep, merged_stores))
.chain({
job.package()
.dependencies()
.runtime()
.iter()
.map(|dep| Self::build_resource(dep, merged_stores))
})
.collect::<futures::stream::FuturesUnordered<_>>()
.collect::<Result<Vec<JobResource>>>()
.await?;
resources.extend({
job.resources()
.iter()
.filter(|jr| jr.env().is_some())
.cloned()
});
resources
};
if config.containers().check_env_names() {
debug!("Checking environment if all variables are allowed!");
let _ = Self::env_resources(job.resources(), job.package().environment().as_ref())
.into_iter()
.inspect(|(name, _)| debug!("Checking: {}", name))
.try_for_each(|(name, _)| {
if !config.containers().allowed_env().contains(&name) {
Err(anyhow!("Environment variable name not allowed: {}", name))
} else {
Ok(())
}
})
.with_context(|| {
anyhow!(
"Checking allowed variables for package {} {}",
job.package().name(),
job.package().version()
)
})
.context("Checking allowed variable names")?;
} else {
debug!("Environment checking disabled");
}
let script = ScriptBuilder::new(&job.script_shebang).build(
&job.package,
&job.script_phases,
*config.strict_script_interpolation(),
)?;
Ok(RunnableJob {
uuid: job.uuid,
package: job.package,
image: job.image,
resources,
source_cache: source_cache.clone(),
script,
})
}
pub fn package_sources(&self) -> Vec<SourceEntry> {
self.source_cache.sources_for(&self.package())
}
pub fn environment(&self) -> Vec<(EnvironmentVariableName, String)> {
Self::env_resources(&self.resources, self.package().environment().as_ref())
}
/// Helper function to collect a list of resources and the result of package.environment() into
/// a Vec of environment variables
fn env_resources(
resources: &[JobResource],
pkgenv: Option<&HashMap<EnvironmentVariableName, String>>,
) -> Vec<(EnvironmentVariableName, String)> {
let iter = resources
.iter()
.filter_map(JobResource::env)
.map(|(k, v)| (k.clone(), v.clone()));
if let Some(hm) = pkgenv {
iter.chain(hm.iter().map(|(k, v)| (k.clone(), v.clone())))
.collect()
} else {
iter.collect()
}
}
pub fn package_environment(&self) -> Vec<(String, String)> {
vec![
(
String::from("BUTIDO_PACKAGE_NAME"),
self.package().name().clone().to_string(),
),
(
String::from("BUTIDO_PACKAGE_VERSION"),
self.package().version().clone().to_string(),
),
(
String::from("BUTIDO_PACKAGE_VERSION_IS_SEMVER"),
String::from(if *self.package().version_is_semver() {
"true"
} else {
"false"
}),
),
]
}
async fn build_resource(
dep: &dyn ParseDependency,
merged_stores: &MergedStores,
) -> Result<JobResource> {
let (name, vers) = dep.parse_as_name_and_version()?;
trace!("Copying dep: {:?} {:?}", name, vers);
let mut a = merged_stores
.get_artifact_by_name_and_version(&name, &vers)
.await?;
if a.is_empty() {
Err(anyhow!("Cannot find dependency: {:?} {:?}", name, vers))
.context("Building a runnable job")
.map_err(Error::from)
} else {
a.sort();
let a_len = a.len();
let found_dependency = a.into_iter().next().unwrap(); // save by above check
if a_len > 1 {
warn!("Found more than one dependency for {:?} {:?}", name, vers);
warn!("Using: {:?}", found_dependency);
warn!("Please investigate, this might be a BUG");
}
Ok(JobResource::Artifact(found_dependency))
}
}
}
|
