socket-patch-core 3.1.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
//! Integration coverage for `crawlers::maven_crawler`. Drives
//! branches the apply-CLI suite doesn't exercise: pom-marker
//! detection, gradle marker detection, m2_repo_path env-var
//! resolution, walkdir-based scanning.

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

use std::path::Path;

use serial_test::serial;
use socket_patch_core::crawlers::types::CrawlerOptions;
use socket_patch_core::crawlers::MavenCrawler;
use socket_patch_core::crawlers::maven_crawler::parse_pom_group_artifact_version;

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

/// Stage a maven m2-layout package: <repo>/<group/path>/<artifact>/<version>/
/// with a minimal pom.xml.
async fn stage_maven_pkg(repo: &Path, group: &str, artifact: &str, version: &str) -> std::path::PathBuf {
    let group_path = group.replace('.', "/");
    let pkg_dir = repo.join(group_path).join(artifact).join(version);
    tokio::fs::create_dir_all(&pkg_dir).await.unwrap();
    let pom = format!(
        r#"<?xml version="1.0"?>
<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>{group}</groupId>
  <artifactId>{artifact}</artifactId>
  <version>{version}</version>
</project>"#
    );
    tokio::fs::write(pkg_dir.join(format!("{artifact}-{version}.pom")), pom).await.unwrap();
    pkg_dir
}

// ── parse_pom_group_artifact_version ───────────────────────────

#[test]
fn parse_pom_well_formed_extracts_coordinates() {
    let pom = r#"<?xml version="1.0"?>
<project>
  <groupId>org.apache.commons</groupId>
  <artifactId>commons-lang3</artifactId>
  <version>3.12.0</version>
</project>"#;
    let result = parse_pom_group_artifact_version(pom);
    assert_eq!(
        result,
        Some((
            "org.apache.commons".to_string(),
            "commons-lang3".to_string(),
            "3.12.0".to_string()
        ))
    );
}

#[test]
fn parse_pom_missing_groupId_returns_none() {
    let pom = r#"<?xml version="1.0"?>
<project>
  <artifactId>commons-lang3</artifactId>
  <version>3.12.0</version>
</project>"#;
    assert_eq!(parse_pom_group_artifact_version(pom), None);
}

#[test]
fn parse_pom_missing_version_returns_none() {
    let pom = r#"<?xml version="1.0"?>
<project>
  <groupId>org.apache.commons</groupId>
  <artifactId>commons-lang3</artifactId>
</project>"#;
    assert_eq!(parse_pom_group_artifact_version(pom), None);
}

#[test]
fn parse_pom_malformed_xml_returns_none() {
    let pom = "this is not XML at all";
    assert_eq!(parse_pom_group_artifact_version(pom), None);
}

#[test]
fn parse_pom_empty_string_returns_none() {
    assert_eq!(parse_pom_group_artifact_version(""), None);
}

/// Parent block supplies groupId when the project block doesn't —
/// exercise the `in_parent` arm that records `parent_group_id` and the
/// final `group_id.or(parent_group_id)` fallback (maven_crawler.rs:124).
#[test]
fn parse_pom_parent_groupid_fallback() {
    let pom = r#"<?xml version="1.0"?>
<project>
  <parent>
    <groupId>com.example.parent</groupId>
    <artifactId>parent-pom</artifactId>
    <version>1.0.0</version>
  </parent>
  <artifactId>child-module</artifactId>
  <version>2.0.0</version>
</project>"#;
    let result = parse_pom_group_artifact_version(pom);
    assert_eq!(
        result,
        Some((
            "com.example.parent".to_string(),
            "child-module".to_string(),
            "2.0.0".to_string()
        ))
    );
}

/// Top-level `<groupId>${env.GROUP_ID}</groupId>` is a property
/// reference — the parser must bail out instead of treating the
/// literal placeholder as a value (line 100).
#[test]
fn parse_pom_property_reference_groupid_returns_none() {
    let pom = r#"<?xml version="1.0"?>
<project>
  <groupId>${env.GROUP_ID}</groupId>
  <artifactId>commons-lang3</artifactId>
  <version>3.12.0</version>
</project>"#;
    assert_eq!(parse_pom_group_artifact_version(pom), None);
}

#[test]
fn parse_pom_property_reference_artifactid_returns_none() {
    let pom = r#"<?xml version="1.0"?>
<project>
  <groupId>org.apache</groupId>
  <artifactId>${env.ART}</artifactId>
  <version>3.12.0</version>
</project>"#;
    assert_eq!(parse_pom_group_artifact_version(pom), None);
}

#[test]
fn parse_pom_property_reference_version_returns_none() {
    let pom = r#"<?xml version="1.0"?>
<project>
  <groupId>org.apache</groupId>
  <artifactId>commons-lang3</artifactId>
  <version>${revision}</version>
</project>"#;
    assert_eq!(parse_pom_group_artifact_version(pom), None);
}

/// `<parent><groupId>${prop}</groupId></parent>` is a parent property
/// reference — must NOT be accepted as a fallback groupId (line 86-87
/// skip arm).
#[test]
fn parse_pom_missing_artifactId_returns_none() {
    let pom = r#"<?xml version="1.0"?>
<project>
  <groupId>org.apache.commons</groupId>
  <version>3.12.0</version>
</project>"#;
    assert_eq!(parse_pom_group_artifact_version(pom), None);
}

/// An XML element rendered across two lines (open on one, close on
/// another) — `extract_xml_value` returns None for both, the parser
/// can't extract a value, and the function returns None. Drives
/// `extract_xml_value` line 16 (close-tag not found on same line).
#[test]
fn parse_pom_split_tag_returns_none() {
    let pom = r#"<?xml version="1.0"?>
<project>
  <groupId>org.apache
  </groupId>
  <artifactId>commons-lang3</artifactId>
  <version>3.12.0</version>
</project>"#;
    // groupId line doesn't have a closing tag — extract returns None.
    // Without top-level groupId and no <parent>, the function returns None.
    assert_eq!(parse_pom_group_artifact_version(pom), None);
}

/// `MavenCrawler::default()` should forward to `new()`.
#[test]
fn maven_crawler_default_and_new_construct_cleanly() {
    let _a = MavenCrawler::default();
    let _b = MavenCrawler::new();
}

/// `m2_repo_path` falls through to `$HOME/.m2/repository` when neither
/// MAVEN_REPO_LOCAL nor M2_HOME is set. We can't exercise this directly
/// (private fn) but can drive it via `get_maven_repo_paths` with a
/// build.gradle marker and both env vars cleared. The crawler should
/// then point at the staged `<HOME>/.m2/repository`.
#[tokio::test]
#[serial]
async fn get_maven_repo_paths_home_dot_m2_fallback() {
    let tmp = tempfile::tempdir().unwrap();
    let m2 = tmp.path().join(".m2").join("repository");
    tokio::fs::create_dir_all(&m2).await.unwrap();
    tokio::fs::write(tmp.path().join("pom.xml"), b"<project/>").await.unwrap();

    let prev_local = std::env::var("MAVEN_REPO_LOCAL").ok();
    let prev_m2 = std::env::var("M2_HOME").ok();
    let prev_home = std::env::var("HOME").ok();
    std::env::remove_var("MAVEN_REPO_LOCAL");
    std::env::remove_var("M2_HOME");
    std::env::set_var("HOME", tmp.path());

    let crawler = MavenCrawler;
    let paths = crawler.get_maven_repo_paths(&options_at(tmp.path())).await.unwrap();

    if let Some(v) = prev_local {
        std::env::set_var("MAVEN_REPO_LOCAL", v);
    }
    if let Some(v) = prev_m2 {
        std::env::set_var("M2_HOME", v);
    }
    if let Some(v) = prev_home {
        std::env::set_var("HOME", v);
    } else {
        std::env::remove_var("HOME");
    }

    assert!(
        paths.iter().any(|p| p == &m2),
        "HOME/.m2/repository fallback must be discovered; got {paths:?}"
    );
}

/// `get_maven_repo_paths(global=true)` with a real m2 layout under
/// MAVEN_REPO_LOCAL returns just that repo (lines 205-208).
#[tokio::test]
#[serial]
async fn get_maven_repo_paths_global_mode_with_maven_repo_local() {
    let tmp = tempfile::tempdir().unwrap();
    let repo = tmp.path().join("custom-m2");
    tokio::fs::create_dir_all(&repo).await.unwrap();

    let prev = std::env::var("MAVEN_REPO_LOCAL").ok();
    std::env::set_var("MAVEN_REPO_LOCAL", &repo);

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

    if let Some(v) = prev {
        std::env::set_var("MAVEN_REPO_LOCAL", v);
    } else {
        std::env::remove_var("MAVEN_REPO_LOCAL");
    }

    assert_eq!(paths, vec![repo]);
}

/// `get_maven_repo_paths(global=true)` with no env vars set and no
/// HOME/.m2 either — `is_dir` check fails and the crawler returns
/// empty (line 209).
#[tokio::test]
#[serial]
async fn get_maven_repo_paths_global_mode_no_m2_returns_empty() {
    let tmp = tempfile::tempdir().unwrap();
    let prev_local = std::env::var("MAVEN_REPO_LOCAL").ok();
    let prev_m2 = std::env::var("M2_HOME").ok();
    let prev_home = std::env::var("HOME").ok();
    std::env::remove_var("MAVEN_REPO_LOCAL");
    std::env::remove_var("M2_HOME");
    std::env::set_var("HOME", tmp.path()); // No .m2/ inside

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

    if let Some(v) = prev_local {
        std::env::set_var("MAVEN_REPO_LOCAL", v);
    }
    if let Some(v) = prev_m2 {
        std::env::set_var("M2_HOME", v);
    }
    if let Some(v) = prev_home {
        std::env::set_var("HOME", v);
    } else {
        std::env::remove_var("HOME");
    }

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

/// `find_by_purls` for a version directory that contains a non-`.pom`
/// file but no `.pom` — exercise the `has_pom_file` return-false arm
/// (line 405) via verify_maven_at_path.
#[tokio::test]
async fn find_by_purls_version_dir_without_pom_returns_empty() {
    let tmp = tempfile::tempdir().unwrap();
    let group_path = "org/apache/commons";
    let pkg_dir = tmp.path().join(group_path).join("commons-lang3").join("3.12.0");
    tokio::fs::create_dir_all(&pkg_dir).await.unwrap();
    // Put a non-.pom file in there — has_pom_file must reject.
    tokio::fs::write(pkg_dir.join("commons-lang3-3.12.0.jar"), b"fake jar").await.unwrap();

    let crawler = MavenCrawler;
    let result = crawler
        .find_by_purls(
            tmp.path(),
            &["pkg:maven/org.apache.commons/commons-lang3@3.12.0".to_string()],
        )
        .await
        .unwrap();
    assert!(result.is_empty(), "missing .pom must skip the package");
}

#[test]
fn parse_pom_parent_property_reference_groupid_skipped() {
    let pom = r#"<?xml version="1.0"?>
<project>
  <parent>
    <groupId>${env.PARENT_GROUP}</groupId>
    <artifactId>parent-pom</artifactId>
    <version>1.0.0</version>
  </parent>
  <artifactId>child-module</artifactId>
  <version>2.0.0</version>
</project>"#;
    // No top-level groupId and the parent's is a property ref → bail.
    assert_eq!(parse_pom_group_artifact_version(pom), None);
}

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

#[tokio::test]
async fn find_by_purls_finds_package_in_m2_layout() {
    let tmp = tempfile::tempdir().unwrap();
    let pkg_dir =
        stage_maven_pkg(tmp.path(), "org.apache.commons", "commons-lang3", "3.12.0").await;

    let crawler = MavenCrawler;
    let purl = "pkg:maven/org.apache.commons/commons-lang3@3.12.0";
    let result = crawler
        .find_by_purls(tmp.path(), &[purl.to_string()])
        .await
        .unwrap();
    assert_eq!(result.len(), 1);
    assert_eq!(result.get(purl).unwrap().path, pkg_dir);
}

#[tokio::test]
async fn find_by_purls_no_match_returns_empty() {
    let tmp = tempfile::tempdir().unwrap();
    let crawler = MavenCrawler;
    let result = crawler
        .find_by_purls(
            tmp.path(),
            &["pkg:maven/com.example/missing@1.0.0".to_string()],
        )
        .await
        .unwrap();
    assert!(result.is_empty());
}

#[tokio::test]
async fn find_by_purls_invalid_purl_skipped() {
    let tmp = tempfile::tempdir().unwrap();
    let crawler = MavenCrawler;
    let result = crawler
        .find_by_purls(
            tmp.path(),
            &["pkg:not-maven/foo@1.0".to_string()],
        )
        .await
        .unwrap();
    assert!(result.is_empty());
}

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

#[tokio::test]
async fn crawl_all_discovers_packages_in_repo() {
    let tmp = tempfile::tempdir().unwrap();
    stage_maven_pkg(tmp.path(), "org.apache.commons", "commons-lang3", "3.12.0").await;
    stage_maven_pkg(tmp.path(), "com.google.guava", "guava", "32.1.3-jre").await;

    let crawler = MavenCrawler;
    let opts = CrawlerOptions {
        cwd: tmp.path().to_path_buf(),
        global: true,
        global_prefix: Some(tmp.path().to_path_buf()),
        batch_size: 100,
    };
    let result = crawler.crawl_all(&opts).await;
    assert!(result.len() >= 2, "must discover both packages; got {result:?}");
}

#[tokio::test]
async fn crawl_all_with_empty_repo_returns_empty() {
    let tmp = tempfile::tempdir().unwrap();
    let crawler = MavenCrawler;
    let opts = CrawlerOptions {
        cwd: tmp.path().to_path_buf(),
        global: true,
        global_prefix: Some(tmp.path().to_path_buf()),
        batch_size: 100,
    };
    let result = crawler.crawl_all(&opts).await;
    assert!(result.is_empty());
}

// ── get_maven_repo_paths ───────────────────────────────────────

#[tokio::test]
async fn get_maven_repo_paths_with_global_prefix_returns_only_prefix() {
    let tmp = tempfile::tempdir().unwrap();
    let crawler = MavenCrawler;
    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_maven_repo_paths(&opts).await.unwrap();
    assert_eq!(paths, vec![tmp.path().to_path_buf()]);
}

#[tokio::test]
#[serial]
async fn get_maven_repo_paths_no_marker_returns_empty() {
    let tmp = tempfile::tempdir().unwrap();
    // No pom.xml, no build.gradle — not a Java project.
    let crawler = MavenCrawler;
    let paths = crawler.get_maven_repo_paths(&options_at(tmp.path())).await.unwrap();
    assert!(paths.is_empty(), "non-Java dir must return empty paths");
}

#[tokio::test]
#[serial]
async fn get_maven_repo_paths_with_pom_xml_returns_repo() {
    let tmp = tempfile::tempdir().unwrap();
    tokio::fs::write(tmp.path().join("pom.xml"), b"<project/>").await.unwrap();
    let repo = tempfile::tempdir().unwrap();
    let prev = std::env::var("MAVEN_REPO_LOCAL").ok();
    std::env::set_var("MAVEN_REPO_LOCAL", repo.path());

    let crawler = MavenCrawler;
    let paths = crawler.get_maven_repo_paths(&options_at(tmp.path())).await.unwrap();

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

    assert!(paths.iter().any(|p| p == repo.path()));
}

#[tokio::test]
#[serial]
async fn get_maven_repo_paths_with_build_gradle_returns_repo() {
    let tmp = tempfile::tempdir().unwrap();
    tokio::fs::write(tmp.path().join("build.gradle"), b"plugins {}").await.unwrap();
    let repo = tempfile::tempdir().unwrap();
    let prev = std::env::var("MAVEN_REPO_LOCAL").ok();
    std::env::set_var("MAVEN_REPO_LOCAL", repo.path());

    let crawler = MavenCrawler;
    let paths = crawler.get_maven_repo_paths(&options_at(tmp.path())).await.unwrap();

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

    assert!(paths.iter().any(|p| p == repo.path()));
}

#[tokio::test]
#[serial]
async fn get_maven_repo_paths_with_build_gradle_kts_returns_repo() {
    let tmp = tempfile::tempdir().unwrap();
    tokio::fs::write(tmp.path().join("build.gradle.kts"), b"plugins {}").await.unwrap();
    let repo = tempfile::tempdir().unwrap();
    let prev = std::env::var("MAVEN_REPO_LOCAL").ok();
    std::env::set_var("MAVEN_REPO_LOCAL", repo.path());

    let crawler = MavenCrawler;
    let paths = crawler.get_maven_repo_paths(&options_at(tmp.path())).await.unwrap();

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

    assert!(paths.iter().any(|p| p == repo.path()));
}

#[tokio::test]
#[serial]
async fn get_maven_repo_paths_m2_home_fallback() {
    let tmp = tempfile::tempdir().unwrap();
    tokio::fs::write(tmp.path().join("pom.xml"), b"<project/>").await.unwrap();
    let m2_home = tempfile::tempdir().unwrap();
    let repo_dir = m2_home.path().join("repository");
    tokio::fs::create_dir(&repo_dir).await.unwrap();
    let prev_maven_repo = std::env::var("MAVEN_REPO_LOCAL").ok();
    let prev_m2 = std::env::var("M2_HOME").ok();
    std::env::remove_var("MAVEN_REPO_LOCAL");
    std::env::set_var("M2_HOME", m2_home.path());

    let crawler = MavenCrawler;
    let paths = crawler.get_maven_repo_paths(&options_at(tmp.path())).await.unwrap();

    std::env::remove_var("M2_HOME");
    if let Some(v) = prev_maven_repo {
        std::env::set_var("MAVEN_REPO_LOCAL", v);
    }
    if let Some(v) = prev_m2 {
        std::env::set_var("M2_HOME", v);
    }

    assert!(
        paths.iter().any(|p| p == &repo_dir),
        "M2_HOME/repository fallback must work; got {paths:?}"
    );
}