socket-patch-core 3.2.0

Core library for socket-patch: manifest, hash, crawlers, patch engine, API client
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
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
//! Integration coverage for `crawlers::composer_crawler`. Drives
//! branches the apply-CLI suite skips: get_vendor_paths discovery,
//! find_by_purls happy path, crawl_all via installed.json parsing,
//! malformed installed.json variants.

#![cfg(feature = "composer")]

use std::path::Path;

use socket_patch_core::crawlers::composer_crawler::parse_composer_home_output;
use socket_patch_core::crawlers::types::CrawlerOptions;
use socket_patch_core::crawlers::ComposerCrawler;

#[test]
fn parse_composer_home_output_well_formed() {
    let p = parse_composer_home_output("/Users/foo/.composer\n").unwrap();
    assert_eq!(p, std::path::PathBuf::from("/Users/foo/.composer"));
}

#[test]
fn parse_composer_home_output_empty_returns_none() {
    assert_eq!(parse_composer_home_output(""), None);
    assert_eq!(parse_composer_home_output("   \n  "), None);
}

const ORG_PURL: &str = "pkg:composer/monolog/monolog@3.5.0";

fn options_at(root: &Path) -> CrawlerOptions {
    CrawlerOptions {
        cwd: root.to_path_buf(),
        global: false,
        global_prefix: None,
        batch_size: 100,
    }
}

/// Stage a composer vendor layout: <root>/vendor/<vendor>/<name>/
/// with `vendor/composer/installed.json` listing it.
async fn stage_composer_project(root: &Path, vendor_name: &str, pkg_name: &str, version: &str) {
    let vendor = root.join("vendor");
    let pkg = vendor.join(vendor_name).join(pkg_name);
    tokio::fs::create_dir_all(&pkg).await.unwrap();

    // composer/installed.json — what the crawler reads.
    let installed_dir = vendor.join("composer");
    tokio::fs::create_dir_all(&installed_dir).await.unwrap();
    let installed_json = format!(
        r#"{{
  "packages": [
    {{
      "name": "{vendor_name}/{pkg_name}",
      "version": "{version}",
      "version_normalized": "{version}.0"
    }}
  ]
}}"#
    );
    tokio::fs::write(installed_dir.join("installed.json"), installed_json)
        .await
        .unwrap();

    // composer.json marker on the project root.
    tokio::fs::write(root.join("composer.json"), b"{}")
        .await
        .unwrap();
}

// ── find_by_purls ──────────────────────────────────────────────

#[tokio::test]
async fn find_by_purls_finds_package_in_vendor() {
    let tmp = tempfile::tempdir().unwrap();
    stage_composer_project(tmp.path(), "monolog", "monolog", "3.5.0").await;

    let crawler = ComposerCrawler;
    let result = crawler
        .find_by_purls(&tmp.path().join("vendor"), &[ORG_PURL.to_string()])
        .await
        .unwrap();
    assert_eq!(result.len(), 1);
    let pkg = result.get(ORG_PURL).unwrap();
    assert_eq!(
        pkg.path,
        tmp.path().join("vendor").join("monolog").join("monolog")
    );
}

#[tokio::test]
async fn find_by_purls_no_installed_json_returns_empty() {
    let tmp = tempfile::tempdir().unwrap();
    let vendor = tmp.path().join("vendor");
    tokio::fs::create_dir(&vendor).await.unwrap();

    let crawler = ComposerCrawler;
    let result = crawler
        .find_by_purls(&vendor, &[ORG_PURL.to_string()])
        .await
        .unwrap();
    assert!(result.is_empty());
}

#[tokio::test]
async fn find_by_purls_invalid_purl_skipped() {
    let tmp = tempfile::tempdir().unwrap();
    stage_composer_project(tmp.path(), "monolog", "monolog", "3.5.0").await;

    let crawler = ComposerCrawler;
    let result = crawler
        .find_by_purls(
            &tmp.path().join("vendor"),
            &["pkg:not-composer/foo@1.0".to_string()],
        )
        .await
        .unwrap();
    assert!(result.is_empty());
}

#[tokio::test]
async fn find_by_purls_version_mismatch_returns_empty() {
    let tmp = tempfile::tempdir().unwrap();
    stage_composer_project(tmp.path(), "monolog", "monolog", "3.5.0").await;

    let crawler = ComposerCrawler;
    let result = crawler
        .find_by_purls(
            &tmp.path().join("vendor"),
            &["pkg:composer/monolog/monolog@99.99.99".to_string()],
        )
        .await
        .unwrap();
    assert!(result.is_empty(), "version mismatch must skip");
}

// ── crawl_all ─────────────────────────────────────────────────

#[tokio::test]
async fn crawl_all_via_installed_json_returns_packages() {
    let tmp = tempfile::tempdir().unwrap();
    stage_composer_project(tmp.path(), "monolog", "monolog", "3.5.0").await;

    let crawler = ComposerCrawler;
    let opts = CrawlerOptions {
        cwd: tmp.path().to_path_buf(),
        global: true,
        global_prefix: Some(tmp.path().join("vendor")),
        batch_size: 100,
    };
    let result = crawler.crawl_all(&opts).await;
    assert_eq!(result.len(), 1);
    assert_eq!(result[0].name, "monolog");
    assert_eq!(result[0].namespace.as_deref(), Some("monolog"));
}

#[tokio::test]
async fn crawl_all_with_corrupt_installed_json_returns_empty() {
    let tmp = tempfile::tempdir().unwrap();
    let vendor = tmp.path().join("vendor");
    let composer = vendor.join("composer");
    tokio::fs::create_dir_all(&composer).await.unwrap();
    tokio::fs::write(composer.join("installed.json"), b"{ this is not json")
        .await
        .unwrap();
    tokio::fs::write(tmp.path().join("composer.json"), b"{}")
        .await
        .unwrap();

    let crawler = ComposerCrawler;
    let opts = CrawlerOptions {
        cwd: tmp.path().to_path_buf(),
        global: true,
        global_prefix: Some(vendor),
        batch_size: 100,
    };
    let result = crawler.crawl_all(&opts).await;
    assert!(result.is_empty(), "corrupt JSON must yield empty crawl");
}

// ── get_vendor_paths ──────────────────────────────────────────

#[tokio::test]
async fn get_vendor_paths_with_global_prefix_passthrough() {
    let tmp = tempfile::tempdir().unwrap();
    let crawler = ComposerCrawler;
    let opts = CrawlerOptions {
        cwd: tmp.path().to_path_buf(),
        global: true,
        global_prefix: Some(tmp.path().to_path_buf()),
        batch_size: 100,
    };
    let paths = crawler.get_vendor_paths(&opts).await.unwrap();
    assert_eq!(paths, vec![tmp.path().to_path_buf()]);
}

#[tokio::test]
async fn get_vendor_paths_local_no_vendor_returns_empty() {
    let tmp = tempfile::tempdir().unwrap();
    let crawler = ComposerCrawler;
    let paths = crawler
        .get_vendor_paths(&options_at(tmp.path()))
        .await
        .unwrap();
    assert!(paths.is_empty());
}

#[tokio::test]
async fn get_vendor_paths_local_no_installed_json_returns_empty() {
    let tmp = tempfile::tempdir().unwrap();
    let vendor = tmp.path().join("vendor");
    tokio::fs::create_dir(&vendor).await.unwrap();
    // vendor exists but no installed.json inside.
    tokio::fs::write(tmp.path().join("composer.json"), b"{}")
        .await
        .unwrap();

    let crawler = ComposerCrawler;
    let paths = crawler
        .get_vendor_paths(&options_at(tmp.path()))
        .await
        .unwrap();
    assert!(
        paths.is_empty(),
        "vendor without installed.json must not match"
    );
}

#[tokio::test]
async fn get_vendor_paths_local_no_composer_marker_returns_empty() {
    let tmp = tempfile::tempdir().unwrap();
    let vendor = tmp.path().join("vendor");
    let composer = vendor.join("composer");
    tokio::fs::create_dir_all(&composer).await.unwrap();
    tokio::fs::write(composer.join("installed.json"), b"{\"packages\":[]}")
        .await
        .unwrap();
    // No composer.json or composer.lock on the project root.

    let crawler = ComposerCrawler;
    let paths = crawler
        .get_vendor_paths(&options_at(tmp.path()))
        .await
        .unwrap();
    assert!(
        paths.is_empty(),
        "no composer.json must mean not-a-PHP-project"
    );
}

#[tokio::test]
async fn get_vendor_paths_local_full_setup_returns_vendor() {
    let tmp = tempfile::tempdir().unwrap();
    let vendor = tmp.path().join("vendor");
    let composer = vendor.join("composer");
    tokio::fs::create_dir_all(&composer).await.unwrap();
    tokio::fs::write(composer.join("installed.json"), b"{\"packages\":[]}")
        .await
        .unwrap();
    tokio::fs::write(tmp.path().join("composer.json"), b"{}")
        .await
        .unwrap();

    let crawler = ComposerCrawler;
    let paths = crawler
        .get_vendor_paths(&options_at(tmp.path()))
        .await
        .unwrap();
    assert_eq!(paths, vec![vendor]);
}

// ── global mode discovery ──────────────────────────────────────

/// `get_vendor_paths(global=true, global_prefix=None)` falls through to
/// `get_global_vendor_paths` which checks `COMPOSER_HOME` env var.
/// Stubbing it to a fixture root with `<root>/vendor/` populated must
/// surface that path.
#[tokio::test]
#[serial_test::serial]
async fn get_vendor_paths_global_via_composer_home_env() {
    let tmp = tempfile::tempdir().unwrap();
    let composer_home = tmp.path();
    let vendor = composer_home.join("vendor");
    tokio::fs::create_dir_all(&vendor).await.unwrap();

    let prev_composer = std::env::var("COMPOSER_HOME").ok();
    std::env::set_var("COMPOSER_HOME", composer_home);

    let crawler = ComposerCrawler;
    let opts = CrawlerOptions {
        cwd: tmp.path().to_path_buf(),
        global: true,
        global_prefix: None,
        batch_size: 100,
    };
    let paths = crawler.get_vendor_paths(&opts).await.unwrap();

    std::env::remove_var("COMPOSER_HOME");
    if let Some(v) = prev_composer {
        std::env::set_var("COMPOSER_HOME", v);
    }

    assert!(
        paths.iter().any(|p| p == &vendor),
        "COMPOSER_HOME-derived vendor dir must be returned; got {paths:?}"
    );
}

/// COMPOSER_HOME unset + HOME pointing at a tempdir with `.composer/`
/// must fall through to the HOME/.composer platform default.
#[tokio::test]
#[serial_test::serial]
async fn get_vendor_paths_global_via_home_dot_composer_fallback() {
    let tmp = tempfile::tempdir().unwrap();
    let dot_composer = tmp.path().join(".composer");
    let vendor = dot_composer.join("vendor");
    tokio::fs::create_dir_all(&vendor).await.unwrap();
    // Stub PATH to a binary-free tempdir so `composer global config
    // home` can't short-circuit the HOME-based fallback on CI runners
    // where composer is installed.
    let empty_path = tempfile::tempdir().unwrap();

    let prev_composer = std::env::var("COMPOSER_HOME").ok();
    let prev_home = std::env::var("HOME").ok();
    let prev_path = std::env::var("PATH").ok();
    std::env::remove_var("COMPOSER_HOME");
    std::env::set_var("HOME", tmp.path());
    std::env::set_var("PATH", empty_path.path());

    let crawler = ComposerCrawler;
    let opts = CrawlerOptions {
        cwd: tmp.path().to_path_buf(),
        global: true,
        global_prefix: None,
        batch_size: 100,
    };
    let paths = crawler.get_vendor_paths(&opts).await.unwrap();

    if let Some(v) = prev_composer {
        std::env::set_var("COMPOSER_HOME", v);
    }
    if let Some(v) = prev_home {
        std::env::set_var("HOME", v);
    } else {
        std::env::remove_var("HOME");
    }
    if let Some(v) = prev_path {
        std::env::set_var("PATH", v);
    } else {
        std::env::remove_var("PATH");
    }

    assert!(
        paths.iter().any(|p| p == &vendor),
        "HOME/.composer fallback vendor dir must be returned; got {paths:?}"
    );
}

/// HOME with `.config/composer/` but no `.composer/` exercises the
/// second candidate in the platform-default list.
///
/// PATH is stubbed to a binary-free tempdir so `composer global
/// config home` can't short-circuit the fallback chain — on CI
/// runners that have composer installed, the shell-out would
/// otherwise return a real home outside our test tempdir.
#[tokio::test]
#[serial_test::serial]
async fn get_vendor_paths_global_via_home_xdg_config_composer_fallback() {
    let tmp = tempfile::tempdir().unwrap();
    let xdg = tmp.path().join(".config").join("composer");
    let vendor = xdg.join("vendor");
    tokio::fs::create_dir_all(&vendor).await.unwrap();
    let empty_path = tempfile::tempdir().unwrap();

    let prev_composer = std::env::var("COMPOSER_HOME").ok();
    let prev_home = std::env::var("HOME").ok();
    let prev_path = std::env::var("PATH").ok();
    std::env::remove_var("COMPOSER_HOME");
    std::env::set_var("HOME", tmp.path());
    std::env::set_var("PATH", empty_path.path());

    let crawler = ComposerCrawler;
    let opts = CrawlerOptions {
        cwd: tmp.path().to_path_buf(),
        global: true,
        global_prefix: None,
        batch_size: 100,
    };
    let paths = crawler.get_vendor_paths(&opts).await.unwrap();

    if let Some(v) = prev_composer {
        std::env::set_var("COMPOSER_HOME", v);
    }
    if let Some(v) = prev_home {
        std::env::set_var("HOME", v);
    } else {
        std::env::remove_var("HOME");
    }
    if let Some(v) = prev_path {
        std::env::set_var("PATH", v);
    } else {
        std::env::remove_var("PATH");
    }

    assert!(
        paths.iter().any(|p| p == &vendor),
        "HOME/.config/composer fallback vendor dir must be returned; got {paths:?}"
    );
}

/// `get_composer_home` returns `None` when COMPOSER_HOME is unset,
/// `composer` is not on PATH, and HOME points at a tempdir without
/// either `.composer/` or `.config/composer/`. Covers the L194-207
/// shell-out failure path (via PATH stubbing) plus the final L226
/// `None` arm.
#[tokio::test]
#[serial_test::serial]
async fn get_vendor_paths_global_no_composer_no_home_layout_returns_empty() {
    let tmp = tempfile::tempdir().unwrap();
    let empty_path = tempfile::tempdir().unwrap();

    let prev_composer = std::env::var("COMPOSER_HOME").ok();
    let prev_home = std::env::var("HOME").ok();
    let prev_path = std::env::var("PATH").ok();
    std::env::remove_var("COMPOSER_HOME");
    // HOME is set, but the temp HOME has no .composer / .config/composer.
    std::env::set_var("HOME", tmp.path());
    // PATH stubbed so the composer CLI cannot be spawned.
    std::env::set_var("PATH", empty_path.path());

    let crawler = ComposerCrawler;
    let opts = CrawlerOptions {
        cwd: tmp.path().to_path_buf(),
        global: true,
        global_prefix: None,
        batch_size: 100,
    };
    let paths = crawler.get_vendor_paths(&opts).await.unwrap();

    if let Some(v) = prev_composer {
        std::env::set_var("COMPOSER_HOME", v);
    }
    if let Some(v) = prev_home {
        std::env::set_var("HOME", v);
    } else {
        std::env::remove_var("HOME");
    }
    if let Some(v) = prev_path {
        std::env::set_var("PATH", v);
    } else {
        std::env::remove_var("PATH");
    }

    assert!(
        paths.is_empty(),
        "no composer source anywhere must yield empty; got {paths:?}"
    );
}

#[path = "common/mod.rs"]
mod common;

/// `read_installed_json` short-circuits when the file can't be read —
/// chmod 000 the installed.json and assert the crawler returns empty
/// rather than panicking.
#[cfg(unix)]
#[tokio::test]
async fn find_by_purls_handles_unreadable_installed_json() {
    if common::uid_is_root() {
        eprintln!("SKIP: chmod 000 is a no-op under root");
        return;
    }
    let tmp = tempfile::tempdir().unwrap();
    let vendor = tmp.path().join("vendor");
    let composer = vendor.join("composer");
    tokio::fs::create_dir_all(&composer).await.unwrap();
    let installed = composer.join("installed.json");
    tokio::fs::write(&installed, r#"{"packages":[]}"#)
        .await
        .unwrap();
    common::chmod_unreadable(&installed);

    let crawler = ComposerCrawler;
    let result = crawler
        .find_by_purls(&vendor, &[ORG_PURL.to_string()])
        .await
        .unwrap();
    common::chmod_readable(&installed);

    assert!(
        result.is_empty(),
        "unreadable installed.json must yield empty"
    );
}

/// `crawl_all` should dedup packages discovered across multiple
/// vendor paths sharing the same installed package — exercises the
/// `seen.contains` early-continue arm.
#[tokio::test]
async fn crawl_all_dedups_across_vendor_paths() {
    let tmp = tempfile::tempdir().unwrap();
    let custom_vendor = tmp.path().join("custom-vendor");
    let composer_dir = custom_vendor.join("composer");
    tokio::fs::create_dir_all(&composer_dir).await.unwrap();
    let pkg_dir = custom_vendor.join("monolog").join("monolog");
    tokio::fs::create_dir_all(&pkg_dir).await.unwrap();
    let installed = r#"{"packages":[{"name":"monolog/monolog","version":"3.5.0"},{"name":"monolog/monolog","version":"3.5.0"}]}"#;
    tokio::fs::write(composer_dir.join("installed.json"), installed)
        .await
        .unwrap();
    tokio::fs::write(tmp.path().join("composer.json"), b"{}")
        .await
        .unwrap();

    let crawler = ComposerCrawler;
    let opts = CrawlerOptions {
        cwd: tmp.path().to_path_buf(),
        global: true,
        global_prefix: Some(custom_vendor),
        batch_size: 100,
    };
    let result = crawler.crawl_all(&opts).await;
    assert_eq!(
        result.len(),
        1,
        "duplicates inside installed.json must dedup"
    );
}

#[tokio::test]
async fn get_vendor_paths_local_with_lock_marker_also_works() {
    let tmp = tempfile::tempdir().unwrap();
    let vendor = tmp.path().join("vendor");
    let composer = vendor.join("composer");
    tokio::fs::create_dir_all(&composer).await.unwrap();
    tokio::fs::write(composer.join("installed.json"), b"{\"packages\":[]}")
        .await
        .unwrap();
    tokio::fs::write(tmp.path().join("composer.lock"), b"{}")
        .await
        .unwrap();

    let crawler = ComposerCrawler;
    let paths = crawler
        .get_vendor_paths(&options_at(tmp.path()))
        .await
        .unwrap();
    assert_eq!(paths, vec![vendor]);
}