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

use actionoscope::Step;

#[test]
fn test_get_name_or_id_with_name() {
    // Given: A step with a name and no ID
    let step = Step {
        name: Some(String::from("Test Step")),
        id: None,
        uses: None,
        shell: None,
        working_directory: None,
        run: None,
    };

    // When: The method get_name_or_id is called
    let result = step.get_name_or_id();

    // Then: The result should be the step's name
    assert_eq!(result, "Test Step");
}

#[test]
fn test_get_name_or_id_with_id() {
    // Given: A step with an ID and no name
    let step = Step {
        name: None,
        id: Some(String::from("test_step")),
        uses: None,
        shell: None,
        working_directory: None,
        run: None,
    };

    // When: The method get_name_or_id is called
    let result = step.get_name_or_id();

    // Then: The result should be the step's ID
    assert_eq!(result, "test_step");
}

#[test]
fn test_get_name_or_id_with_name_and_id() {
    // Given: A step with both a name and an ID
    let step = Step {
        name: Some(String::from("Test Step")),
        id: Some(String::from("test_step")),
        uses: None,
        shell: None,
        working_directory: None,
        run: None,
    };

    // When: The method get_name_or_id is called
    let result = step.get_name_or_id();

    // Then: The result should be the step's name
    assert_eq!(result, "Test Step");
}

#[test]
fn test_get_name_or_id_with_none() {
    // Given: A step with neither a name nor an ID
    let step = Step {
        name: None,
        id: None,
        uses: None,
        shell: None,
        working_directory: None,
        run: None,
    };

    // When: The method get_name_or_id is called
    let result = step.get_name_or_id();

    // Then: The result should be "unknown"
    assert_eq!(result, "unknown");
}

#[test]
fn test_run_cmd_with_valid_command() {
    // Given: A step with a valid shell and run command
    let step = Step {
        name: Some(String::from("Test Step")),
        id: Some(String::from("test_step")),
        uses: None,
        shell: Some(String::from("echo")),
        working_directory: None,
        run: Some(String::from("Hello, world!")),
    };

    // When: The method run_cmd is called
    let result = step.run_cmd(None, None);

    // Then: The result should indicate success
    assert!(result.is_ok());
}

#[test]
fn test_run_cmd_with_invalid_command() {
    // Given: A step with an invalid shell command
    let step = Step {
        name: Some(String::from("Test Step")),
        id: Some(String::from("test_step")),
        uses: None,
        shell: Some(String::from("invalid_shell")),
        working_directory: None,
        run: Some(String::from("Hello, world!")),
    };

    // When: The method run_cmd is called
    let result = step.run_cmd(None, None);

    // Then: The result should indicate an error
    assert!(result.is_err());
}

#[test]
fn test_run_cmd_with_no_run_command() {
    // Given: A step with a shell but no run command
    let step = Step {
        name: Some(String::from("Test Step")),
        id: Some(String::from("test_step")),
        uses: None,
        shell: Some(String::from("echo")),
        working_directory: None,
        run: None,
    };

    // When: The method run_cmd is called
    let result = step.run_cmd(None, None);

    // Then: The result should indicate an error
    assert!(result.is_err());
}