gha-runner 0.2.0

Run Github Actions workflows locally or on a custom backend
Documentation
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
use std::mem;

use linked_hash_map::LinkedHashMap;
use serde_yaml::{Number, Value};

use crate::contexts::*;
use crate::expressions::*;
use crate::{RunnerError, RunnerErrorKind};

#[derive(Clone)]
/// The Value has already been expanded.
pub struct Strategy(pub Value);

/// The Value has already been expanded.
#[derive(Clone)]
pub struct Matrix(pub Value);

#[derive(Clone)]
/// The Value has already been expanded.
pub struct Job(pub Value);

#[derive(Clone, Debug)]
/// The Value has already been expanded.
pub struct Step(pub Value);

/// The Value has already been expanded (actually we assume the whole Workflow
/// is never an expression.)
pub struct Workflow(pub Value);

/// Converts the YAML value to a string-keyed map, expanding
/// the values in the map before passing them to the processing function `f`.
fn to_string_map<'a, F, V, C: ContextResolver<'a>>(
    context: &'a C,
    yaml: Value,
    mut f: F,
) -> Result<LinkedHashMap<String, V>, RunnerError>
where
    F: FnMut(&C, Value) -> Result<V, RunnerError>,
{
    if let Value::Mapping(m) = yaml {
        let mut ret = LinkedHashMap::new();
        for (k, v) in m {
            if let Value::String(s) = k {
                ret.insert(s, f(context, expand(context, v)?)?);
            } else {
                return Err(RunnerErrorKind::TypeMismatch {
                    expected: "string key".to_string(),
                    got: v,
                }
                .error(context));
            }
        }
        return Ok(ret);
    }
    Err(RunnerErrorKind::TypeMismatch {
        expected: "mapping".to_string(),
        got: yaml,
    }
    .error(context))
}

fn num_to_string(n: Number) -> String {
    if let Some(v) = n.as_i64() {
        v.to_string()
    } else if let Some(v) = n.as_u64() {
        v.to_string()
    } else {
        panic!("Unsupported number {:?}", n);
    }
}

fn to_string<'a>(context: &impl ContextResolver<'a>, yaml: Value) -> Result<String, RunnerError> {
    Ok(match yaml {
        Value::String(s) => s,
        Value::Bool(b) => b.to_string(),
        Value::Number(n) => num_to_string(n),
        yaml => {
            return Err(RunnerErrorKind::TypeMismatch {
                expected: "string".to_string(),
                got: yaml,
            }
            .error(context));
        }
    })
}

fn to_string_opt<'a>(
    context: &impl ContextResolver<'a>,
    yaml: Option<Value>,
) -> Result<Option<String>, RunnerError> {
    if let Some(yaml) = yaml {
        Ok(Some(to_string(context, yaml)?))
    } else {
        Ok(None)
    }
}

/// Takes the field value and also applies expansion.
fn take_field<'a, C: ContextResolver<'a>>(
    resolver: &'a C,
    value: &mut Value,
    field_name: &'static str,
) -> Result<Option<Value>, RunnerError> {
    if let Some(mapping) = value.as_mapping_mut() {
        let key = Value::String(field_name.to_string());
        if let Some(val) = mapping.remove(&key) {
            return expand(resolver, val).map(Some);
        }
        return Ok(None);
    }
    Err(RunnerErrorKind::TypeMismatch {
        expected: "mapping".to_string(),
        got: value.clone(),
    }
    .into())
}

/// Clone the field value and also applies expansion.
fn take_required_field<'a, C: ContextResolver<'a>>(
    resolver: &'a C,
    value: &mut Value,
    field_name: &'static str,
) -> Result<Value, RunnerError> {
    if let Some(ret) = take_field(resolver, value, field_name)? {
        Ok(ret)
    } else {
        Err(RunnerErrorKind::RequiredFieldMissing {
            field_name,
            got: value.clone(),
        }
        .into())
    }
}

/// Clone the field value and also applies expansion.
fn clone_field<'a, C: ContextResolver<'a>>(
    resolver: &'a C,
    value: &Value,
    field_name: &'static str,
) -> Result<Option<Value>, RunnerError> {
    if let Some(mapping) = value.as_mapping() {
        let key = Value::String(field_name.to_string());
        if let Some(val) = mapping.get(&key) {
            return expand(resolver, val.clone()).map(Some);
        }
        return Ok(None);
    }
    Err(RunnerErrorKind::TypeMismatch {
        expected: "mapping".to_string(),
        got: value.clone(),
    }
    .error(resolver))
}

/// Clone the field value and also applies expansion.
fn clone_required_field<'a, C: ContextResolver<'a>>(
    resolver: &'a C,
    value: &Value,
    field_name: &'static str,
) -> Result<Value, RunnerError> {
    if let Some(ret) = clone_field(resolver, value, field_name)? {
        Ok(ret)
    } else {
        Err(RunnerErrorKind::RequiredFieldMissing {
            field_name,
            got: value.clone(),
        }
        .error(resolver))
    }
}

impl Workflow {
    pub fn take_name(&mut self, context: &RootContext) -> Result<Option<String>, RunnerError> {
        to_string_opt(context, take_field(context, &mut self.0, "name")?)
    }
    pub fn take_env(
        &mut self,
        context: &RootContext,
    ) -> Result<LinkedHashMap<String, String>, RunnerError> {
        if let Some(yaml) = take_field(context, &mut self.0, "env")? {
            to_string_map(context, yaml, to_string)
        } else {
            Ok(LinkedHashMap::new())
        }
    }
    pub fn take_jobs(
        &mut self,
        context: &RootContext,
    ) -> Result<LinkedHashMap<String, Job>, RunnerError> {
        if let Some(yaml) = take_field(context, &mut self.0, "jobs")? {
            to_string_map(context, yaml, |_, v| Ok(Job(v)))
        } else {
            Ok(LinkedHashMap::new())
        }
    }
}

impl Matrix {
    pub fn take_keys<'a>(
        &mut self,
        context: &'a JobContext<'a>,
    ) -> Result<LinkedHashMap<String, Vec<Value>>, RunnerError> {
        if let Some(mapping) = self.0.as_mapping_mut() {
            let mut ret = LinkedHashMap::new();
            let all = mem::take(mapping);
            for (k, v) in all {
                if let Value::String(s) = k {
                    if s == "include" {
                        mapping.insert(Value::String(s), v);
                        continue;
                    }
                    let expanded = expand(context, v)?;
                    if let Value::Sequence(seq) = expanded {
                        ret.insert(s, seq);
                    } else {
                        return Err(RunnerErrorKind::TypeMismatch {
                            expected: "matrix list of values".to_string(),
                            got: expanded,
                        }
                        .error(context));
                    }
                } else {
                    return Err(RunnerErrorKind::TypeMismatch {
                        expected: "string key".to_string(),
                        got: v,
                    }
                    .error(context));
                }
            }
            return Ok(ret);
        }
        Err(RunnerErrorKind::TypeMismatch {
            expected: "mapping".to_string(),
            got: self.0.clone(),
        }
        .error(context))
    }
    pub fn take_include(
        &mut self,
        context: &JobContext,
    ) -> Result<Vec<LinkedHashMap<String, Value>>, RunnerError> {
        if let Some(include) = take_field(context, &mut self.0, "include")? {
            if let Value::Sequence(seq) = include {
                let mut ret = Vec::new();
                for v in seq {
                    ret.push(to_string_map(context, v, |_, v| Ok(v))?);
                }
                Ok(ret)
            } else {
                Err(RunnerErrorKind::TypeMismatch {
                    expected: "sequence of includes".to_string(),
                    got: include,
                }
                .error(context))
            }
        } else {
            Ok(Vec::new())
        }
    }
}

impl Strategy {
    pub fn take_matrix(&mut self, context: &JobContext) -> Result<Option<Matrix>, RunnerError> {
        take_field(context, &mut self.0, "matrix").map(|v| v.map(Matrix))
    }
}

impl Step {
    pub fn take_name_pre(
        &mut self,
        context: &PreStepContext,
    ) -> Result<Option<String>, RunnerError> {
        take_field(context, &mut self.0, "name").and_then(|v| to_string_opt(context, v))
    }
    pub fn take_name(&mut self, context: &StepContext) -> Result<Option<String>, RunnerError> {
        take_field(context, &mut self.0, "name").and_then(|v| to_string_opt(context, v))
    }
    pub fn take_uses(&mut self, context: &StepContext) -> Result<Option<String>, RunnerError> {
        take_field(context, &mut self.0, "uses").and_then(|v| to_string_opt(context, v))
    }
    pub fn take_run(&mut self, context: &StepContext) -> Result<Option<String>, RunnerError> {
        take_field(context, &mut self.0, "run").and_then(|v| to_string_opt(context, v))
    }
    pub fn take_shell(&mut self, context: &StepContext) -> Result<Option<String>, RunnerError> {
        take_field(context, &mut self.0, "shell").and_then(|v| to_string_opt(context, v))
    }
    pub fn take_working_directory(
        &mut self,
        context: &StepContext,
    ) -> Result<Option<String>, RunnerError> {
        take_field(context, &mut self.0, "working-directory")
            .and_then(|v| to_string_opt(context, v))
    }
    pub fn take_env(
        &mut self,
        context: &StepContext,
    ) -> Result<LinkedHashMap<String, String>, RunnerError> {
        if let Some(yaml) = take_field(context, &mut self.0, "env")? {
            to_string_map(context, yaml, to_string)
        } else {
            Ok(LinkedHashMap::new())
        }
    }
    pub fn take_env_pre(
        &mut self,
        context: &PreStepContext,
    ) -> Result<LinkedHashMap<String, String>, RunnerError> {
        if let Some(yaml) = take_field(context, &mut self.0, "env")? {
            to_string_map(context, yaml, to_string)
        } else {
            Ok(LinkedHashMap::new())
        }
    }
    pub fn take_with(
        &mut self,
        context: &StepContext,
    ) -> Result<LinkedHashMap<String, String>, RunnerError> {
        if let Some(yaml) = take_field(context, &mut self.0, "with")? {
            to_string_map(context, yaml, to_string)
        } else {
            Ok(LinkedHashMap::new())
        }
    }
}

impl Job {
    pub fn take_strategy(&mut self, context: &JobContext) -> Result<Option<Strategy>, RunnerError> {
        take_field(context, &mut self.0, "strategy").map(|v| v.map(Strategy))
    }
    pub fn clone_env(
        &self,
        context: &JobPostStrategyContext,
    ) -> Result<LinkedHashMap<String, String>, RunnerError> {
        if let Some(yaml) = clone_field(context, &self.0, "env")? {
            to_string_map(context, yaml, to_string)
        } else {
            Ok(LinkedHashMap::new())
        }
    }
    pub fn clone_name(
        &self,
        context: &JobPostStrategyContext,
    ) -> Result<Option<String>, RunnerError> {
        if let Some(yaml) = clone_field(context, &self.0, "name")? {
            Ok(Some(to_string(context, yaml)?))
        } else {
            Ok(None)
        }
    }
    pub fn clone_runs_on(
        &self,
        context: &JobPostStrategyContext,
    ) -> Result<Vec<String>, RunnerError> {
        let yaml = clone_required_field(context, &self.0, "runs-on")?;
        Ok(match yaml {
            Value::String(s) => vec![s],
            Value::Sequence(seq) => {
                let mut ret = Vec::new();
                for v in seq {
                    ret.push(to_string(context, v)?);
                }
                ret
            }
            _ => {
                return Err(RunnerErrorKind::TypeMismatch {
                    expected: "String or array of strings".to_string(),
                    got: yaml,
                }
                .error(context))
            }
        })
    }
    pub fn clone_steps(&self, context: &JobPostStrategyContext) -> Result<Vec<Step>, RunnerError> {
        let yaml = clone_required_field(context, &self.0, "steps")?;
        Ok(if let Value::Sequence(seq) = yaml {
            seq.into_iter().map(Step).collect()
        } else {
            return Err(RunnerErrorKind::TypeMismatch {
                expected: "Array of steps".to_string(),
                got: yaml,
            }
            .error(context));
        })
    }
}

// action.yml data

/// The Value has already been expanded
pub struct Input(pub Value);

impl Input {
    pub fn take_default(&mut self, context: &ActionContext) -> Result<Option<String>, RunnerError> {
        if let Some(yaml) = take_field(context, &mut self.0, "default")? {
            Ok(Some(to_string(context, yaml)?))
        } else {
            Ok(None)
        }
    }
}

/// The Value has already been expanded
pub struct Runs(pub Value);

impl Runs {
    pub fn take_using(&mut self, context: &ActionContext) -> Result<String, RunnerError> {
        take_required_field(context, &mut self.0, "using").and_then(|v| to_string(context, v))
    }
    pub fn take_main(&mut self, context: &ActionContext) -> Result<String, RunnerError> {
        take_required_field(context, &mut self.0, "main").and_then(|v| to_string(context, v))
    }
    pub fn take_pre(&mut self, context: &ActionContext) -> Result<Option<String>, RunnerError> {
        take_field(context, &mut self.0, "pre").and_then(|v| to_string_opt(context, v))
    }
}

/// The Value has already been expanded (actually we assume the whole Action
/// is never an expression.)
pub struct Action(pub Value);

impl Action {
    pub fn take_inputs(
        &mut self,
        context: &ActionContext,
    ) -> Result<LinkedHashMap<String, Input>, RunnerError> {
        if let Some(mut inputs) = take_field(context, &mut self.0, "inputs")? {
            if let Some(mapping) = inputs.as_mapping_mut() {
                let mut ret = LinkedHashMap::new();
                let all = mem::take(mapping);
                for (k, v) in all {
                    if let Value::String(s) = k {
                        ret.insert(s, Input(v));
                    } else {
                        return Err(RunnerErrorKind::TypeMismatch {
                            expected: "string key".to_string(),
                            got: v,
                        }
                        .error(context));
                    }
                }
                return Ok(ret);
            }
            Err(RunnerErrorKind::TypeMismatch {
                expected: "mapping".to_string(),
                got: self.0.clone(),
            }
            .error(context))
        } else {
            Ok(LinkedHashMap::new())
        }
    }
    pub fn take_runs(&mut self, context: &ActionContext) -> Result<Runs, RunnerError> {
        take_required_field(context, &mut self.0, "runs").map(Runs)
    }
}