gha-expression-proof 1.0.0

GitHub Actions expression evaluator and receipt generator for offline CI compatibility testing
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

use assert_cmd::Command;
use predicates::prelude::*;
use serde_json::{Value, json};
use tempfile::tempdir;

fn bin() -> Command {
    Command::cargo_bin("gha-expression-proof").unwrap()
}

#[test]
fn eval_reads_eventsmith_github_context() {
    let dir = tempdir().unwrap();
    let github_context = dir.path().join("github-context.json");
    std::fs::write(
        &github_context,
        serde_json::to_vec_pretty(&json!({
            "ref": "refs/heads/main",
            "ref_name": "main",
            "event_name": "issues",
            "event": {
                "issue": {
                    "labels": [
                        {"name": "bug"},
                        {"name": "help wanted"}
                    ]
                }
            }
        }))
        .unwrap(),
    )
    .unwrap();

    let assert = bin()
        .args([
            "eval",
            "--expr",
            "github.ref == 'refs/heads/main' && contains(github.event.issue.labels.*.name, 'BUG')",
            "--github-context",
            github_context.to_str().unwrap(),
            "--format",
            "json",
        ])
        .assert()
        .success();

    let receipt = serde_json::from_slice::<Value>(&assert.get_output().stdout).unwrap();
    assert_eq!(receipt["result"], true);
    assert_eq!(receipt["summary"]["failed"], 0);
    assert!(
        receipt["functions"]
            .as_array()
            .unwrap()
            .iter()
            .any(|v| v == "contains")
    );
}

#[test]
fn eval_supports_from_json_and_context_json() {
    let assert = bin()
        .args([
            "eval",
            "--expr",
            "fromJSON(env.time) > 2",
            "--context-json",
            r#"env={"time":"3"}"#,
            "--format",
            "json",
        ])
        .assert()
        .success();

    let receipt = serde_json::from_slice::<Value>(&assert.get_output().stdout).unwrap();
    assert_eq!(receipt["result"], true);
}

#[test]
fn template_interpolates_expressions() {
    let dir = tempdir().unwrap();
    let github_context = dir.path().join("github-context.json");
    std::fs::write(
        &github_context,
        serde_json::to_vec(&json!({
            "ref_name": "main",
            "sha": "2222222222222222222222222222222222222222"
        }))
        .unwrap(),
    )
    .unwrap();

    let assert = bin()
        .args([
            "template",
            "--template",
            "deploy-${{ github.ref_name }}-${{ github.sha }}",
            "--github-context",
            github_context.to_str().unwrap(),
            "--format",
            "json",
        ])
        .assert()
        .success();

    let receipt = serde_json::from_slice::<Value>(&assert.get_output().stdout).unwrap();
    assert_eq!(
        receipt["rendered"],
        "deploy-main-2222222222222222222222222222222222222222"
    );
}

#[test]
fn if_condition_applies_implicit_success() {
    let assert = bin()
        .args([
            "eval",
            "--expr",
            "github.ref == 'refs/heads/main'",
            "--context-json",
            r#"github={"ref":"refs/heads/main"}"#,
            "--if-condition",
            "--job-status",
            "failure",
            "--format",
            "json",
        ])
        .assert()
        .success();

    let receipt = serde_json::from_slice::<Value>(&assert.get_output().stdout).unwrap();
    assert_eq!(receipt["result"], false);
}

#[test]
fn hash_files_hashes_workspace_files() {
    let dir = tempdir().unwrap();
    std::fs::write(dir.path().join("package-lock.json"), "{}\n").unwrap();

    let assert = bin()
        .args([
            "eval",
            "--expr",
            "hashFiles('package-lock.json') != ''",
            "--workspace",
            dir.path().to_str().unwrap(),
            "--format",
            "json",
        ])
        .assert()
        .success();

    let receipt = serde_json::from_slice::<Value>(&assert.get_output().stdout).unwrap();
    assert_eq!(receipt["result"], true);
    assert_eq!(receipt["summary"]["failed"], 0);
}

#[test]
fn invalid_expression_fails_with_receipt() {
    bin()
        .args([
            "eval",
            "--expr",
            r#"github.ref == "main""#,
            "--format",
            "json",
        ])
        .assert()
        .failure()
        .stdout(predicate::str::contains("expression.syntax"));
}