actionoscope 0.2.0

Actionoscope is a CLI tool to run steps from a GitHub Actions workflow locally.
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

use assert_cmd::Command;
use predicates::prelude::*;
use std::fs::File;
use std::io::Write;
use std::path::PathBuf;

mod file_utils;
mod test_context;

use crate::file_utils::rm_file;
use file_utils::create_temp_directory;
use test_context::TearDownTestContext;

const APP_NAME: &str = "actionoscope";
const TEST_FILE_NAME: &str = "test_workflow.yml";

fn create_clean_up_test_workflow_file(file_path: PathBuf) -> impl FnOnce() {
    move || {
        rm_file(&file_path, true).expect("Failed to remove test workflow file");
    }
}

#[test]
fn test_run_single_step() {
    // Given: A temporary directory and a test workflow file are set up
    let tmp_path = create_temp_directory("test_run_single_step")
        .expect("Failed to create temporary directory for test");
    let file_path = tmp_path.join(TEST_FILE_NAME);
    let clean_up_fn = create_clean_up_test_workflow_file(file_path.clone());
    setup_test_workflow(file_path.clone());

    // When: The command to run a single step is executed
    let mut cmd = Command::cargo_bin(APP_NAME).unwrap();
    cmd.arg("run")
        .arg("--workflow-file")
        .arg(&file_path)
        .arg("--job")
        .arg("test_job")
        .arg("--step")
        .arg("step1");

    // Then: The command should succeed and contain the expected output
    cmd.assert()
        .success()
        .stdout(predicate::str::contains("Running step name/id 'Step 1'"));

    let _ = TearDownTestContext::new(clean_up_fn);
}

#[test]
fn test_run_single_step_invalid_job() {
    // Given: A temporary directory and a test workflow file are set up
    let tmp_path = create_temp_directory("test_run_single_step_invalid_job")
        .expect("Failed to create temporary directory for test");
    let file_path = tmp_path.join(TEST_FILE_NAME);
    let clean_up_fn = create_clean_up_test_workflow_file(file_path.clone());
    setup_test_workflow(file_path.clone());

    // When: The command to run a single step with an invalid job is executed
    let mut cmd = Command::cargo_bin(APP_NAME).unwrap();
    cmd.arg("run")
        .arg("--workflow-file")
        .arg(&file_path)
        .arg("--job")
        .arg("invalid_job")
        .arg("--step")
        .arg("step1");

    // Then: The command should fail
    cmd.assert().failure();

    let _ = TearDownTestContext::new(clean_up_fn);
}

#[test]
fn test_run_single_step_invalid_step() {
    // Given: A temporary directory and a test workflow file are set up
    let tmp_path = create_temp_directory("test_run_single_step_invalid_step")
        .expect("Failed to create temporary directory for test");
    let file_path = tmp_path.join(TEST_FILE_NAME);
    let clean_up_fn = create_clean_up_test_workflow_file(file_path.clone());
    setup_test_workflow(file_path.clone());

    // When: The command to run an invalid step is executed
    let mut cmd = Command::cargo_bin(APP_NAME).unwrap();
    cmd.arg("run")
        .arg("--workflow-file")
        .arg(&file_path)
        .arg("--job")
        .arg("test_job")
        .arg("--step")
        .arg("invalid_step");

    // Then: The command should fail
    cmd.assert().failure();

    let _ = TearDownTestContext::new(clean_up_fn);
}

#[test]
fn test_run_all_steps_since_invalid_step() {
    // Given: A temporary directory and a test workflow file are set up
    let tmp_path = create_temp_directory("test_run_all_steps_since_invalid_step")
        .expect("Failed to create temporary directory for test");
    let file_path = tmp_path.join(TEST_FILE_NAME);
    let clean_up_fn = create_clean_up_test_workflow_file(file_path.clone());
    setup_test_workflow(file_path.clone());

    // When: The command to run all steps since an invalid step is executed
    let mut cmd = Command::cargo_bin(APP_NAME).unwrap();
    cmd.arg("run")
        .arg("--workflow-file")
        .arg(&file_path)
        .arg("--job")
        .arg("test_job")
        .arg("--from-step")
        .arg("invalid_step");

    // Then: The command should fail
    cmd.assert().failure();

    let _ = TearDownTestContext::new(clean_up_fn);
}

#[test]
fn test_run_all_steps_since() {
    // Given: A temporary directory and a test workflow file are set up
    let tmp_path = create_temp_directory("test_run_all_steps_since")
        .expect("Failed to create temporary directory for test");
    let file_path = tmp_path.join(TEST_FILE_NAME);
    let clean_up_fn = create_clean_up_test_workflow_file(file_path.clone());
    setup_test_workflow(file_path.clone());

    // When: The command to run all steps since a specific step is executed
    let mut cmd = Command::cargo_bin(APP_NAME).unwrap();
    cmd.arg("run")
        .arg("--workflow-file")
        .arg(&file_path)
        .arg("--job")
        .arg("test_job")
        .arg("--from-step")
        .arg("step2");

    // Then: The command should succeed and contain the expected output
    cmd.assert()
        .success()
        .stdout(predicate::str::contains("Running step name/id 'Step 2'"))
        .stdout(predicate::str::contains("Running step name/id 'Step 3'"));

    let _ = TearDownTestContext::new(clean_up_fn);
}

#[test]
fn test_run_all_steps_except_skip_steps() {
    // Given: A temporary directory and a test workflow file are set up
    let tmp_path = create_temp_directory("test_run_all_steps_except_skip_steps")
        .expect("Failed to create temporary directory for test");
    let file_path = tmp_path.join(TEST_FILE_NAME);
    let clean_up_fn = create_clean_up_test_workflow_file(file_path.clone());
    setup_test_workflow(file_path.clone());

    // When: The command to run all steps except skipped steps is executed
    let mut cmd = Command::cargo_bin(APP_NAME).unwrap();
    cmd.arg("run")
        .arg("--workflow-file")
        .arg(&file_path)
        .arg("--job")
        .arg("test_job")
        .arg("--skip-step")
        .arg("step2")
        .arg("--skip-step")
        .arg("step4");

    // Then: The command should succeed and contain the expected output
    cmd.assert()
        .success()
        .stdout(predicate::str::contains("Running step name/id 'Step 1'"))
        .stdout(predicate::str::contains("Running step name/id 'Step 3'"));

    let _ = TearDownTestContext::new(clean_up_fn);
}

fn setup_test_workflow(file_path: PathBuf) {
    let workflow_content: &str = r#"
    name: Test Workflow
    on:
      push:
        branches:
          - main
    jobs:
      test_job:
        runs-on: ubuntu-latest
        steps:
          - name: Step 1
            id: step1
            run: echo "Step 1"
          - name: Step 2
            id: step2
            run: echo "Step 2"
          - name: Step 3
            id: step3
            run: echo "Step 3"
          - name: Step 4
            id: step4
            run: echo "Step 4"
    "#;
    let mut file = File::create(&file_path).expect("Failed to create file");
    writeln!(file, "{}", workflow_content).expect("Failed to write to file");
}