gx 0.8.5

CLI to manage Github Actions dependencies
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

//! Override resolution and pruning for composite-action step locations, which carry
//! a step index but no job.

use super::*;
use crate::domain::action::identity::{ActionId, Version};
use crate::domain::file::actions::Located as LocatedAction;
use crate::domain::file::site::{Id, JobId, Origin, Scope, Slot, StepIndex, WorkflowPath};
use std::collections::HashMap;

const ACTION_FILE: &str = ".github/actions/setup/action.yml";

fn composite_loc(step: u16) -> Id {
    Id {
        file: WorkflowPath::new(ACTION_FILE),
        slot: Slot::CompositeStep {
            step: StepIndex::from(step),
        },
    }
}

fn located_at(loc: Id) -> LocatedAction {
    use crate::domain::action::uses_ref::ParsedRef;
    use crate::domain::file::actions::WorkflowAction;
    LocatedAction {
        action: WorkflowAction {
            id: ActionId::from("actions/checkout"),
            reference: ParsedRef::Ref(Version::from("v4")),
        },
        site: loc,
        origin: Origin::default(),
    }
}

#[test]
fn composite_step_override_applies() {
    let overrides = vec![ActionOverride {
        workflow: WorkflowPath::new(ACTION_FILE),
        scope: Scope::CompositeStep {
            step: StepIndex::from(0_u16),
        },
        version: Specifier::parse("^3"),
    }];

    assert_eq!(
        resolve_version(&overrides, &composite_loc(0)),
        Some(&Specifier::parse("^3"))
    );
}

#[test]
fn composite_step_override_wins_over_file_level() {
    let overrides = vec![
        ActionOverride {
            workflow: WorkflowPath::new(ACTION_FILE),
            scope: Scope::File,
            version: Specifier::parse("^2"),
        },
        ActionOverride {
            workflow: WorkflowPath::new(ACTION_FILE),
            scope: Scope::CompositeStep {
                step: StepIndex::from(1_u16),
            },
            version: Specifier::parse("^3"),
        },
    ];

    assert_eq!(
        resolve_version(&overrides, &composite_loc(1)),
        Some(&Specifier::parse("^3"))
    );
    // A step with no matching step-override falls back to the file-level one.
    assert_eq!(
        resolve_version(&overrides, &composite_loc(0)),
        Some(&Specifier::parse("^2"))
    );
}

#[test]
fn job_bearing_override_is_unaffected_by_the_file_step_tier() {
    let overrides = vec![ActionOverride {
        workflow: WorkflowPath::new(".github/workflows/ci.yml"),
        scope: Scope::JobStep {
            job: JobId::from("build"),
            step: StepIndex::from(0_u16),
        },
        version: Specifier::parse("^3"),
    }];

    let workflow_loc = Id {
        file: WorkflowPath::new(".github/workflows/ci.yml"),
        slot: Slot::WorkflowStep {
            job: JobId::from("build"),
            step: StepIndex::from(0_u16),
        },
    };
    assert_eq!(
        resolve_version(&overrides, &workflow_loc),
        Some(&Specifier::parse("^3"))
    );
}

#[test]
fn composite_step_override_survives_while_its_step_exists() {
    let mut map: HashMap<ActionId, Vec<ActionOverride>> = HashMap::new();
    map.insert(
        ActionId::from("actions/checkout"),
        vec![ActionOverride {
            workflow: WorkflowPath::new(ACTION_FILE),
            scope: Scope::CompositeStep {
                step: StepIndex::from(0_u16),
            },
            version: Specifier::parse("^3"),
        }],
    );

    prune_stale(&mut map, &[located_at(composite_loc(0))]);

    assert_eq!(
        map.get(&ActionId::from("actions/checkout")).map(Vec::len),
        Some(1)
    );
}

#[test]
fn composite_step_override_is_pruned_when_its_step_is_gone() {
    let mut map: HashMap<ActionId, Vec<ActionOverride>> = HashMap::new();
    map.insert(
        ActionId::from("actions/checkout"),
        vec![ActionOverride {
            workflow: WorkflowPath::new(ACTION_FILE),
            scope: Scope::CompositeStep {
                step: StepIndex::from(5_u16),
            },
            version: Specifier::parse("^3"),
        }],
    );

    // The file still exists and still holds step 0 — but not step 5.
    prune_stale(&mut map, &[located_at(composite_loc(0))]);

    // prune_stale drops the key entirely once its last override is pruned.
    assert!(
        !map.contains_key(&ActionId::from("actions/checkout")),
        "an override naming a step that no longer exists must be pruned"
    );
}