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
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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
// Integration tests for the tidy module — exercises plan() and apply_workflow_patches()

use super::{Error as TidyError, apply_workflow_patches, plan};
use crate::domain::action::identity::{ActionId, CommitDate, CommitSha, Repository, Version};
use crate::domain::action::resolved::{Commit, ResolvedRef};
use crate::domain::action::spec::Spec;
use crate::domain::action::specifier::Specifier;
use crate::domain::action::uses_ref::RefType;
use crate::domain::lock::Lock;
use crate::domain::manifest::Manifest;
use crate::infra::lock;
use crate::infra::manifest;
use crate::infra::workflow_scan::FileScanner as FileWorkflowScanner;
use crate::infra::workflow_update::WorkflowWriter;
use std::fs;

#[test]
fn tidy_error_resolution_failed_displays_specs() {
    let err = TidyError::ResolutionFailed {
        count: 2,
        specs: "actions/checkout: token required\n  actions/setup-node: timeout".to_owned(),
    };
    assert_eq!(
        err.to_string(),
        "failed to resolve 2 action(s):\n  actions/checkout: token required\n  actions/setup-node: timeout"
    );
}

#[derive(Clone, Copy)]
struct NoopRegistry;
impl crate::domain::resolution::VersionRegistry for NoopRegistry {
    fn lookup_sha(
        &self,
        _id: &ActionId,
        _version: &Version,
    ) -> Result<crate::domain::action::resolved::Commit, crate::domain::resolution::Error> {
        Err(crate::domain::resolution::Error::AuthRequired {
            forge: crate::domain::resolution::Forge::GitHub,
        })
    }
    fn all_tags(&self, _id: &ActionId) -> Result<Vec<Version>, crate::domain::resolution::Error> {
        Err(crate::domain::resolution::Error::AuthRequired {
            forge: crate::domain::resolution::Forge::GitHub,
        })
    }
    fn describe_sha(
        &self,
        _id: &ActionId,
        _sha: &CommitSha,
    ) -> Result<crate::domain::resolution::ShaDescription, crate::domain::resolution::Error> {
        Err(crate::domain::resolution::Error::AuthRequired {
            forge: crate::domain::resolution::Forge::GitHub,
        })
    }
}

/// Bug #1 + #2: when workflows have a minority version (e.g. windows.yml uses
/// `actions/checkout@v5` while all others use SHA-pinned `v6.0.1`), tidy must:
///   1. Record the minority version as an override in the manifest (Bug #1 / init)
///   2. Not overwrite windows.yml with the v6.0.1 SHA (Bug #2 / tidy)
#[test]
fn tidy_records_minority_version_as_override_and_does_not_overwrite_file() {
    // ---- Setup temp repo ----
    let temp_dir = tempfile::TempDir::new().unwrap();
    let repo_root = temp_dir.path();
    let workflows_dir = repo_root.join(".github").join("workflows");
    fs::create_dir_all(&workflows_dir).unwrap();
    let github_dir = repo_root.join(".github");

    // Most workflows: actions/checkout pinned to SHA with v6.0.1 comment
    let sha_workflow = "on: pull_request
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
";
    fs::write(workflows_dir.join("ci.yml"), sha_workflow).unwrap();
    fs::write(workflows_dir.join("build.yml"), sha_workflow).unwrap();
    fs::write(workflows_dir.join("release.yml"), sha_workflow).unwrap();

    // windows.yml: plain tag @v5 (minority)
    let windows_workflow = "on: pull_request
jobs:
  test_windows:
    runs-on: windows-2025
    steps:
      - uses: actions/checkout@v5
";
    fs::write(workflows_dir.join("windows.yml"), windows_workflow).unwrap();

    // ---- Run tidy with empty manifest (simulates `gx init`) ----
    let manifest_path = github_dir.join("gx.toml");
    let lock_path = github_dir.join("gx.lock");

    // Pre-seed lock with both versions already resolved (simulates a pre-existing lock)
    let mut seeded_lock = Lock::default();
    seeded_lock.set(
        &Spec::new(
            ActionId::from("actions/checkout"),
            Specifier::from_v1("v6.0.1"),
        ),
        ResolvedRef::Tag(Version::from("v6.0.1")),
        Commit {
            sha: CommitSha::from("8e8c483db84b4bee98b60c0593521ed34d9990e8"),
            repository: Repository::from("actions/checkout"),
            ref_type: Some(RefType::Tag),
            date: CommitDate::from("2026-01-01T00:00:00Z"),
        },
    );
    seeded_lock.set(
        &Spec::new(ActionId::from("actions/checkout"), Specifier::from_v1("v5")),
        ResolvedRef::Tag(Version::from("v5")),
        Commit {
            sha: CommitSha::from("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"),
            repository: Repository::from("actions/checkout"),
            ref_type: Some(RefType::Tag),
            date: CommitDate::from("2026-01-01T00:00:00Z"),
        },
    );
    let lock_store = lock::Store::new(&lock_path);
    lock_store.save(&seeded_lock).unwrap();

    // Load manifest and lock
    let manifest = manifest::parse(&manifest_path).unwrap().value; // empty on first run
    let lock = lock_store.load().unwrap();
    let scanner = FileWorkflowScanner::new(repo_root);
    let updater = WorkflowWriter::new(repo_root);

    let tidy_plan = plan(&manifest, &lock, &NoopRegistry, &scanner, |_| {}).unwrap();

    // Apply the plan
    crate::infra::manifest::create(&manifest_path, &tidy_plan.manifest).unwrap();
    lock_store.save(&tidy_plan.lock).unwrap();
    apply_workflow_patches(&updater, &tidy_plan.workflows).unwrap();

    // ---- Assert: manifest has global v6.0.1 + override for windows.yml v5 ----
    let saved_manifest = manifest::parse(&manifest_path).unwrap().value;

    assert_eq!(
        saved_manifest.get(&ActionId::from("actions/checkout")),
        Some(&Specifier::from_v1("v6.0.1")),
        "Global version should be v6.0.1 (dominant)"
    );

    let overrides = saved_manifest.overrides_for(&ActionId::from("actions/checkout"));
    assert!(
        !overrides.is_empty(),
        "Bug #1: Expected an override for actions/checkout v5 in windows.yml, got none"
    );

    let windows_override = overrides
        .iter()
        .find(|o| o.workflow.as_str().ends_with("windows.yml"));
    assert!(
        windows_override.is_some(),
        "Override must be scoped to windows.yml"
    );
    assert_eq!(
        windows_override.unwrap().version,
        Specifier::from_v1("v5"),
        "Override version must be v5"
    );

    // ---- Assert: windows.yml was NOT overwritten with the v6.0.1 SHA ----
    let windows_content = fs::read_to_string(workflows_dir.join("windows.yml")).unwrap();
    assert!(
        windows_content.contains("actions/checkout@"),
        "windows.yml should still reference actions/checkout"
    );
    assert!(
        !windows_content.contains("8e8c483db84b4bee98b60c0593521ed34d9990e8"),
        "Bug #2: windows.yml was overwritten with the v6.0.1 SHA — it must use the v5 ref, not v6.0.1.\nGot:\n{windows_content}"
    );
}

/// Manifest authority: manifest v4 must survive even when workflows have a stale SHA
/// pointing at v3. The manifest is the source of truth for existing actions; tidy must
/// never downgrade it from workflow state.
#[test]
fn manifest_authority_not_overwritten_by_workflow_sha() {
    let temp_dir = tempfile::TempDir::new().unwrap();
    let repo_root = temp_dir.path();
    let workflows_dir = repo_root.join(".github").join("workflows");
    fs::create_dir_all(&workflows_dir).unwrap();

    // Workflow pins to a SHA that actually belongs to v3
    let workflow = "on: push
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa # v3
";
    fs::write(workflows_dir.join("ci.yml"), workflow).unwrap();

    // Manifest already tracks actions/checkout at v4 (user's intent)
    let mut manifest = Manifest::default();
    manifest.set(ActionId::from("actions/checkout"), Specifier::from_v1("v4"));

    // Pre-seed lock so tidy doesn't need to resolve
    let mut lock = Lock::default();
    lock.set(
        &Spec::new(ActionId::from("actions/checkout"), Specifier::from_v1("v4")),
        ResolvedRef::Tag(Version::from("v4")),
        Commit {
            sha: CommitSha::from("bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"),
            repository: Repository::from("actions/checkout"),
            ref_type: Some(RefType::Tag),
            date: CommitDate::from("2026-01-01T00:00:00Z"),
        },
    );

    let scanner = FileWorkflowScanner::new(repo_root);

    let tidy_plan = plan(&manifest, &lock, &NoopRegistry, &scanner, |_| {}).unwrap();

    // Manifest diff must NOT change checkout's version — v4 is preserved
    assert!(
        !tidy_plan
            .manifest
            .updated
            .iter()
            .any(|(id, _)| id == &ActionId::from("actions/checkout")),
        "Manifest v4 must not be overwritten by workflow SHA pointing to v3"
    );
    assert!(
        !tidy_plan
            .manifest
            .removed
            .contains(&ActionId::from("actions/checkout")),
        "Manifest should not remove actions/checkout"
    );
}

// ========== Step 8: tidy::plan() tests ==========

#[test]
fn plan_empty_workflows_returns_empty_plan() {
    let temp_dir = tempfile::TempDir::new().unwrap();
    let repo_root = temp_dir.path();
    // Create .github/workflows dir but no workflow files
    let workflows_dir = repo_root.join(".github").join("workflows");
    fs::create_dir_all(&workflows_dir).unwrap();

    let manifest = Manifest::default();
    let lock = Lock::default();
    let scanner = FileWorkflowScanner::new(repo_root);

    let result = plan(&manifest, &lock, &NoopRegistry, &scanner, |_| {}).unwrap();
    assert!(result.is_empty(), "Plan for empty workflows must be empty");
}

#[test]
fn plan_one_new_action_produces_added_entries() {
    let temp_dir = tempfile::TempDir::new().unwrap();
    let repo_root = temp_dir.path();
    let workflows_dir = repo_root.join(".github").join("workflows");
    fs::create_dir_all(&workflows_dir).unwrap();

    let sha = "abc123def456789012345678901234567890abcd";
    let workflow = format!(
        "on: push\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@{sha} # v4\n"
    );
    fs::write(workflows_dir.join("ci.yml"), &workflow).unwrap();

    // Pre-seed lock so plan doesn't need to resolve via registry
    let mut lock = Lock::default();
    lock.set(
        &Spec::new(ActionId::from("actions/checkout"), Specifier::from_v1("v4")),
        ResolvedRef::Tag(Version::from("v4")),
        Commit {
            sha: CommitSha::from(sha),
            repository: Repository::from("actions/checkout"),
            ref_type: Some(RefType::Tag),
            date: CommitDate::from("2026-01-01T00:00:00Z"),
        },
    );

    let manifest = Manifest::default(); // empty — action is "new"
    let scanner = FileWorkflowScanner::new(repo_root);

    let result = plan(&manifest, &lock, &NoopRegistry, &scanner, |_| {}).unwrap();

    // Manifest should have added action
    assert!(
        result.manifest.added.iter().any(|(id, v)| {
            id == &ActionId::from("actions/checkout") && v == &Specifier::from_v1("v4")
        }),
        "Plan must include actions/checkout@v4 in manifest.added, got: {:?}",
        result.manifest.added
    );
    assert!(result.manifest.removed.is_empty());
}

#[test]
fn plan_removed_action_produces_removed_entries() {
    let temp_dir = tempfile::TempDir::new().unwrap();
    let repo_root = temp_dir.path();
    let workflows_dir = repo_root.join(".github").join("workflows");
    fs::create_dir_all(&workflows_dir).unwrap();

    // Workflow only has setup-node, not checkout
    let workflow = "on: push\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/setup-node@aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa # v3\n";
    fs::write(workflows_dir.join("ci.yml"), workflow).unwrap();

    // Manifest has both checkout and setup-node
    let mut manifest = Manifest::default();
    manifest.set(ActionId::from("actions/checkout"), Specifier::from_v1("v4"));
    manifest.set(
        ActionId::from("actions/setup-node"),
        Specifier::from_v1("v3"),
    );

    // Pre-seed lock for both
    let mut lock = Lock::default();
    lock.set(
        &Spec::new(ActionId::from("actions/checkout"), Specifier::from_v1("v4")),
        ResolvedRef::Tag(Version::from("v4")),
        Commit {
            sha: CommitSha::from("bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb"),
            repository: Repository::from("actions/checkout"),
            ref_type: Some(RefType::Tag),
            date: CommitDate::from("2026-01-01T00:00:00Z"),
        },
    );
    lock.set(
        &Spec::new(
            ActionId::from("actions/setup-node"),
            Specifier::from_v1("v3"),
        ),
        ResolvedRef::Tag(Version::from("v3")),
        Commit {
            sha: CommitSha::from("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"),
            repository: Repository::from("actions/setup-node"),
            ref_type: Some(RefType::Tag),
            date: CommitDate::from("2026-01-01T00:00:00Z"),
        },
    );

    let scanner = FileWorkflowScanner::new(repo_root);

    let result = plan(&manifest, &lock, &NoopRegistry, &scanner, |_| {}).unwrap();

    // checkout should be removed from manifest
    assert!(
        result
            .manifest
            .removed
            .contains(&ActionId::from("actions/checkout")),
        "Plan must include actions/checkout in manifest.removed, got: {:?}",
        result.manifest.removed
    );
    // setup-node should NOT be removed
    assert!(
        !result
            .manifest
            .removed
            .contains(&ActionId::from("actions/setup-node")),
    );
    // Lock should also have checkout removed
    assert!(
        result
            .lock_changes
            .removed
            .iter()
            .any(|k| k.id == ActionId::from("actions/checkout")),
        "Plan must include actions/checkout in lock.removed, got: {:?}",
        result.lock_changes.removed
    );
}

#[test]
fn plan_everything_in_sync_returns_empty_plan() {
    let temp_dir = tempfile::TempDir::new().unwrap();
    let repo_root = temp_dir.path();
    let workflows_dir = repo_root.join(".github").join("workflows");
    fs::create_dir_all(&workflows_dir).unwrap();

    let sha = "bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb";
    let workflow = format!(
        "on: push\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@{sha} # v4\n"
    );
    fs::write(workflows_dir.join("ci.yml"), &workflow).unwrap();

    // Manifest already has checkout@v4
    let mut manifest = Manifest::default();
    manifest.set(ActionId::from("actions/checkout"), Specifier::from_v1("v4"));

    // Lock already has the entry fully populated
    let mut lock = Lock::default();
    lock.set(
        &Spec::new(ActionId::from("actions/checkout"), Specifier::from_v1("v4")),
        ResolvedRef::Tag(Version::from("v4")),
        Commit {
            sha: CommitSha::from(sha),
            repository: Repository::from("actions/checkout"),
            ref_type: Some(RefType::Tag),
            date: CommitDate::from("2026-01-01T00:00:00Z"),
        },
    );

    let scanner = FileWorkflowScanner::new(repo_root);

    let result = plan(&manifest, &lock, &NoopRegistry, &scanner, |_| {}).unwrap();

    // Everything is in sync — plan should have no manifest/lock changes
    assert!(
        result.manifest.added.is_empty(),
        "No manifest additions expected, got: {:?}",
        result.manifest.added
    );
    assert!(
        result.manifest.removed.is_empty(),
        "No manifest removals expected, got: {:?}",
        result.manifest.removed
    );
    assert!(
        result.lock_changes.added.is_empty(),
        "No lock additions expected, got: {:?}",
        result.lock_changes.added
    );
    assert!(
        result.lock_changes.removed.is_empty(),
        "No lock removals expected, got: {:?}",
        result.lock_changes.removed
    );
}