pinner 0.0.6

Secure CI/CD workflows by pinning mutable tags to immutable SHA-1 hashes. A high-performance Rust CLI that preserves YAML formatting and comments. Supports GitHub, GitLab, Bitbucket, Forgejo, and Docker image pinning.
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

use clap::Parser;
use mockito::Server;
use pinner::providers::{UnifiedProvider, UnifiedProviderConfig};
use pinner::{run, Cli, OciRegistryProvider};
use std::fs;
use tempfile::tempdir;

#[tokio::test]
async fn test_full_pin_cycle() {
    let mut github_server = Server::new_async().await;
    let _m1 = github_server
        .mock("GET", "/repos/actions/checkout/commits/v3")
        .with_status(200)
        .with_body(r#"{"sha":"hashv3"}"#)
        .create_async()
        .await;

    let dir = tempdir().unwrap();
    let workflows = dir.path().join(".github/workflows");
    fs::create_dir_all(&workflows).unwrap();
    let wf_path = workflows.join("ci.yml");
    fs::write(&wf_path, "uses: actions/checkout@v3").unwrap();

    let cli = Cli::try_parse_from([
        "pinner",
        "--github-url",
        &github_server.url(),
        "--workflows",
        workflows.to_str().unwrap(),
        "--yes",
        "pin",
    ])
    .unwrap();

    let provider = UnifiedProvider::new(UnifiedProviderConfig {
        github_url: cli.github_url.clone(),
        github_token: cli.github_token.clone(),
        bitbucket_url: cli.bitbucket_url.clone(),
        bitbucket_token: cli.bitbucket_token.clone(),
        gitlab_url: cli.gitlab_url.clone(),
        gitlab_token: cli.gitlab_token.clone(),
        forgejo_url: cli.forgejo_url.clone(),
        forgejo_token: cli.forgejo_token.clone(),
    });
    let registry = OciRegistryProvider::new(None, None);

    run(cli, provider, registry, vec![workflows]).await.unwrap();

    let content = fs::read_to_string(wf_path).unwrap();
    assert!(content.contains("actions/checkout@hashv3 # v3"));
}

#[tokio::test]
async fn test_verify_command() {
    let dir = tempdir().unwrap();
    let workflows = dir.path().join(".github/workflows");
    fs::create_dir_all(&workflows).unwrap();

    // Unpinned
    let unpinned_path = workflows.join("unpinned.yml");
    fs::write(&unpinned_path, "uses: actions/checkout@v3").unwrap();

    let cli = Cli::try_parse_from([
        "pinner",
        "--workflows",
        workflows.to_str().unwrap(),
        "verify",
    ])
    .unwrap();

    let provider = UnifiedProvider::new(UnifiedProviderConfig::default());
    let registry = OciRegistryProvider::new(None, None);

    let res = run(
        cli,
        provider.clone(),
        registry.clone(),
        vec![workflows.clone()],
    )
    .await;
    assert!(res.is_err());

    // Pinned
    fs::write(
        workflows.join("pinned.yml"),
        "uses: actions/checkout@a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
    )
    .unwrap();
    fs::remove_file(unpinned_path).unwrap();

    let cli = Cli::try_parse_from([
        "pinner",
        "--workflows",
        workflows.to_str().unwrap(),
        "verify",
    ])
    .unwrap();

    run(cli, provider, registry, vec![workflows]).await.unwrap();
}

#[tokio::test]
async fn test_verify_false_positive() {
    let dir = tempdir().unwrap();
    let workflows = dir.path().join(".github/workflows");
    fs::create_dir_all(&workflows).unwrap();

    let yaml = r#"
name: Release
on:
  push:
    tags:
      - 'v*'

jobs:
  build:
    strategy:
      matrix:
        include:
          - target: aarch64-unknown-linux-gnu
            os: ubuntu-latest
            build-tool: cargo-zigbuild
          - target: aarch64-apple-darwin
            os: macos-latest
            build-tool: cargo
    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2 # v4
      - name: Build
        run: echo building for ${{ matrix.target }}
"#;

    fs::write(workflows.join("release.yml"), yaml).unwrap();

    let cli = Cli::try_parse_from([
        "pinner",
        "--workflows",
        workflows.to_str().unwrap(),
        "verify",
    ])
    .unwrap();

    let provider = UnifiedProvider::new(UnifiedProviderConfig::default());
    let registry = OciRegistryProvider::new(None, None);

    run(cli, provider, registry, vec![workflows]).await.unwrap();
}

#[tokio::test]
async fn test_github_url_env() {
    let mut server = Server::new_async().await;
    let _m = server
        .mock("GET", "/repos/o/r/commits/v1")
        .with_status(200)
        .with_body(r#"{"sha":"h"}"#)
        .create_async()
        .await;

    let dir = tempdir().unwrap();
    let f = dir.path().join("f.yml");
    fs::write(&f, "uses: o/r@v1").unwrap();

    std::env::set_var("GITHUB_URL", server.url());

    let cli = Cli::try_parse_from(["pinner", "--workflows", f.to_str().unwrap(), "--yes", "pin"])
        .unwrap();

    let provider = UnifiedProvider::new(UnifiedProviderConfig {
        github_url: cli.github_url.clone(),
        ..Default::default()
    });
    let registry = OciRegistryProvider::new(None, None);

    run(cli, provider, registry, vec![f.clone()]).await.unwrap();

    assert!(fs::read_to_string(&f).unwrap().contains("o/r@h"));
    std::env::remove_var("GITHUB_URL");
}

#[tokio::test]
async fn test_upgrade_command() {
    let mut github_server = Server::new_async().await;
    let _m1 = github_server
        .mock("GET", "/repos/actions/checkout/releases/latest")
        .with_status(200)
        .with_body(r#"{"tag_name":"v4"}"#)
        .create_async()
        .await;
    let _m2 = github_server
        .mock("GET", "/repos/actions/checkout/commits/v4")
        .with_status(200)
        .with_body(r#"{"sha":"hashv4"}"#)
        .create_async()
        .await;

    let dir = tempdir().unwrap();
    let wf = dir.path().join("ci.yml");
    fs::write(&wf, "uses: actions/checkout@v3").unwrap();

    let cli = Cli::try_parse_from([
        "pinner",
        "--github-url",
        &github_server.url(),
        "--workflows",
        wf.to_str().unwrap(),
        "--yes",
        "upgrade",
    ])
    .unwrap();

    let provider = UnifiedProvider::new(UnifiedProviderConfig {
        github_url: cli.github_url.clone(),
        ..Default::default()
    });
    let registry = OciRegistryProvider::new(None, None);

    run(cli, provider, registry, vec![wf.clone()])
        .await
        .unwrap();

    let content = fs::read_to_string(&wf).unwrap();
    assert!(content.contains("actions/checkout@hashv4 # v4"));
}

#[tokio::test]
async fn test_set_command() {
    let dir = tempdir().unwrap();
    let wf = dir.path().join("ci.yml");
    fs::write(&wf, "uses: actions/checkout@v3").unwrap();

    let cli = Cli::try_parse_from([
        "pinner",
        "--workflows",
        wf.to_str().unwrap(),
        "--yes",
        "set",
        "actions/checkout",
        "fixedhash",
    ])
    .unwrap();

    let provider = UnifiedProvider::new(UnifiedProviderConfig::default());
    let registry = OciRegistryProvider::new(None, None);

    run(cli, provider, registry, vec![wf.clone()])
        .await
        .unwrap();

    let content = fs::read_to_string(&wf).unwrap();
    assert!(content.contains("actions/checkout@fixedhash"));
}

#[tokio::test]
async fn test_install_hook_command() {
    let dir = tempdir().unwrap();
    let original_dir = std::env::current_dir().unwrap();
    std::env::set_current_dir(dir.path()).unwrap();

    // Create a mock .git directory
    fs::create_dir(".git").unwrap();

    let cli = Cli::try_parse_from(["pinner", "install-hook"]).unwrap();
    let provider = UnifiedProvider::new(UnifiedProviderConfig::default());
    let registry = OciRegistryProvider::new(None, None);

    run(cli, provider, registry, vec![]).await.unwrap();

    assert!(dir.path().join(".git/hooks/pre-commit").exists());

    std::env::set_current_dir(original_dir).unwrap();
}

#[tokio::test]
async fn test_generate_completion_command() {
    let cli = Cli::try_parse_from(["pinner", "generate-completion", "bash"]).unwrap();
    let provider = UnifiedProvider::new(UnifiedProviderConfig::default());
    let registry = OciRegistryProvider::new(None, None);

    // This command currently returns Ok(()) in pinner::run and is handled in main.rs
    // But we still want to cover the match arm in pinner::run
    run(cli, provider, registry, vec![]).await.unwrap();
}