perl-module-resolution 0.12.2

Deterministic and secure Perl module resolution for workspace and @INC search
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

//! Edge-case integration tests for perl-module-resolution.
//!
//! Covers scenarios missing from the existing test suite:
//! - Deeply nested module names
//! - Multiple workspace folders with precedence
//! - Multiple include paths with priority ordering
//! - System @INC enabled with successful resolution
//! - Modules with underscores and numbers in names
//! - Empty module name edge case

use perl_module_resolution::{ModuleUriResolution, resolve_module_path, resolve_module_uri};
use std::path::PathBuf;
use std::time::Duration;

// ---------------------------------------------------------------------------
// resolve_module_path: deeply nested module
// ---------------------------------------------------------------------------

#[test]
fn path_resolves_deeply_nested_module() -> Result<(), Box<dyn std::error::Error>> {
    let temp = tempfile::tempdir()?;
    let root = temp.path().to_path_buf();
    let deep = root.join("lib").join("A").join("B").join("C").join("D.pm");

    std::fs::create_dir_all(deep.parent().ok_or("no parent")?)?;
    std::fs::write(&deep, "package A::B::C::D; 1;")?;

    let resolved = resolve_module_path(&root, "A::B::C::D", &["lib".to_string()]);
    assert_eq!(resolved, Some(root.join("lib").join("A/B/C/D.pm")));
    Ok(())
}

// ---------------------------------------------------------------------------
// resolve_module_path: multiple include paths respect priority
// ---------------------------------------------------------------------------

#[test]
fn path_first_include_path_wins() -> Result<(), Box<dyn std::error::Error>> {
    let temp = tempfile::tempdir()?;
    let root = temp.path().to_path_buf();

    let first = root.join("first_lib").join("My").join("Mod.pm");
    let second = root.join("second_lib").join("My").join("Mod.pm");

    std::fs::create_dir_all(first.parent().ok_or("no parent")?)?;
    std::fs::create_dir_all(second.parent().ok_or("no parent")?)?;
    std::fs::write(&first, "package My::Mod; 'first';")?;
    std::fs::write(&second, "package My::Mod; 'second';")?;

    let resolved =
        resolve_module_path(&root, "My::Mod", &["first_lib".to_string(), "second_lib".to_string()]);

    assert_eq!(resolved, Some(first));
    Ok(())
}

// ---------------------------------------------------------------------------
// resolve_module_path: module with underscores and numbers
// ---------------------------------------------------------------------------

#[test]
fn path_resolves_module_with_underscores_and_numbers() -> Result<(), Box<dyn std::error::Error>> {
    let temp = tempfile::tempdir()?;
    let root = temp.path().to_path_buf();
    let module_file = root.join("lib").join("Foo_Bar").join("Baz123.pm");

    std::fs::create_dir_all(module_file.parent().ok_or("no parent")?)?;
    std::fs::write(&module_file, "package Foo_Bar::Baz123; 1;")?;

    let resolved = resolve_module_path(&root, "Foo_Bar::Baz123", &["lib".to_string()]);
    assert_eq!(resolved, Some(module_file));
    Ok(())
}

// ---------------------------------------------------------------------------
// resolve_module_path: empty module name returns lib fallback path
// ---------------------------------------------------------------------------

#[test]
fn path_empty_module_name_returns_fallback() -> Result<(), Box<dyn std::error::Error>> {
    let temp = tempfile::tempdir()?;
    let root = temp.path().to_path_buf();

    let resolved = resolve_module_path(&root, "", &[]);
    // Empty name should still produce a path (the lib fallback) without panicking
    assert!(resolved.is_some());
    Ok(())
}

// ---------------------------------------------------------------------------
// resolve_module_uri: multiple workspace folders
// ---------------------------------------------------------------------------

#[test]
fn uri_resolves_from_second_workspace_folder() -> Result<(), Box<dyn std::error::Error>> {
    let temp = tempfile::tempdir()?;
    let ws1 = temp.path().join("workspace1");
    let ws2 = temp.path().join("workspace2");

    std::fs::create_dir_all(ws1.join("lib"))?;
    // Module only exists in workspace2
    let module_file = ws2.join("lib").join("Only").join("Here.pm");
    std::fs::create_dir_all(module_file.parent().ok_or("no parent")?)?;
    std::fs::write(&module_file, "package Only::Here; 1;")?;

    let ws1_uri = url::Url::from_file_path(&ws1).map_err(|()| "failed to create URI")?.to_string();
    let ws2_uri = url::Url::from_file_path(&ws2).map_err(|()| "failed to create URI")?.to_string();

    let result = resolve_module_uri(
        "Only::Here",
        &[],
        &[ws1_uri, ws2_uri],
        &["lib".to_string()],
        false,
        &[],
        Duration::from_millis(200),
    );

    match result {
        ModuleUriResolution::Resolved(uri) => {
            assert!(uri.contains("workspace2"), "should resolve from workspace2");
            assert!(uri.ends_with("Only/Here.pm"));
        }
        other => return Err(format!("expected Resolved, got {other:?}").into()),
    }

    Ok(())
}

// ---------------------------------------------------------------------------
// resolve_module_uri: system @INC enabled with successful resolution
// ---------------------------------------------------------------------------

#[test]
fn uri_system_inc_enabled_resolves_module() -> Result<(), Box<dyn std::error::Error>> {
    let temp = tempfile::tempdir()?;
    let system_dir = temp.path().join("perl5_lib");
    let module_file = system_dir.join("Sys").join("Module.pm");

    std::fs::create_dir_all(module_file.parent().ok_or("no parent")?)?;
    std::fs::write(&module_file, "package Sys::Module; 1;")?;

    let result = resolve_module_uri(
        "Sys::Module",
        &[],
        &[],
        &["lib".to_string()],
        true,
        &[PathBuf::from(&system_dir)],
        Duration::from_millis(200),
    );

    match result {
        ModuleUriResolution::Resolved(uri) => {
            assert!(uri.contains("Sys/Module.pm") || uri.contains("Sys%2FModule.pm"));
        }
        other => return Err(format!("expected Resolved via system INC, got {other:?}").into()),
    }

    Ok(())
}

// ---------------------------------------------------------------------------
// resolve_module_uri: system @INC disabled does NOT search system paths
// ---------------------------------------------------------------------------

#[test]
fn uri_system_inc_disabled_skips_system_paths() -> Result<(), Box<dyn std::error::Error>> {
    let temp = tempfile::tempdir()?;
    let system_dir = temp.path().join("perl5_lib");
    let module_file = system_dir.join("Hidden").join("Module.pm");

    std::fs::create_dir_all(module_file.parent().ok_or("no parent")?)?;
    std::fs::write(&module_file, "package Hidden::Module; 1;")?;

    let result = resolve_module_uri(
        "Hidden::Module",
        &[],
        &[],
        &["lib".to_string()],
        false,
        &[PathBuf::from(&system_dir)],
        Duration::from_millis(200),
    );

    assert_eq!(result, ModuleUriResolution::NotFound);
    Ok(())
}

// ---------------------------------------------------------------------------
// resolve_module_uri: deeply nested module across workspace + include
// ---------------------------------------------------------------------------

#[test]
fn uri_resolves_deeply_nested_module() -> Result<(), Box<dyn std::error::Error>> {
    let temp = tempfile::tempdir()?;
    let workspace = temp.path().join("ws");
    let deep = workspace.join("custom_lib").join("X").join("Y").join("Z").join("W.pm");

    std::fs::create_dir_all(deep.parent().ok_or("no parent")?)?;
    std::fs::write(&deep, "package X::Y::Z::W; 1;")?;

    let ws_uri =
        url::Url::from_file_path(&workspace).map_err(|()| "failed to create URI")?.to_string();

    let result = resolve_module_uri(
        "X::Y::Z::W",
        &[],
        &[ws_uri],
        &["custom_lib".to_string()],
        false,
        &[],
        Duration::from_millis(200),
    );

    match result {
        ModuleUriResolution::Resolved(uri) => {
            assert!(uri.contains("X/Y/Z/W.pm"));
        }
        other => return Err(format!("expected Resolved for deep module, got {other:?}").into()),
    }

    Ok(())
}

// ---------------------------------------------------------------------------
// resolve_module_uri: multiple include paths with priority
// ---------------------------------------------------------------------------

#[test]
fn uri_first_include_path_wins() -> Result<(), Box<dyn std::error::Error>> {
    let temp = tempfile::tempdir()?;
    let workspace = temp.path().join("ws");

    let first = workspace.join("alpha_lib").join("Prio").join("Test.pm");
    let second = workspace.join("beta_lib").join("Prio").join("Test.pm");

    std::fs::create_dir_all(first.parent().ok_or("no parent")?)?;
    std::fs::create_dir_all(second.parent().ok_or("no parent")?)?;
    std::fs::write(&first, "package Prio::Test; 'alpha';")?;
    std::fs::write(&second, "package Prio::Test; 'beta';")?;

    let ws_uri =
        url::Url::from_file_path(&workspace).map_err(|()| "failed to create URI")?.to_string();

    let result = resolve_module_uri(
        "Prio::Test",
        &[],
        &[ws_uri],
        &["alpha_lib".to_string(), "beta_lib".to_string()],
        false,
        &[],
        Duration::from_millis(200),
    );

    match result {
        ModuleUriResolution::Resolved(uri) => {
            assert!(uri.contains("alpha_lib"), "first include path should win, got: {uri}");
        }
        other => return Err(format!("expected Resolved, got {other:?}").into()),
    }

    Ok(())
}

// ---------------------------------------------------------------------------
// resolve_module_uri: open document takes precedence over filesystem
// ---------------------------------------------------------------------------

#[test]
fn uri_open_document_takes_precedence_over_filesystem() -> Result<(), Box<dyn std::error::Error>> {
    let temp = tempfile::tempdir()?;
    let workspace = temp.path().join("ws");
    let on_disk = workspace.join("lib").join("Dup").join("Mod.pm");

    std::fs::create_dir_all(on_disk.parent().ok_or("no parent")?)?;
    std::fs::write(&on_disk, "package Dup::Mod; 1;")?;

    let ws_uri =
        url::Url::from_file_path(&workspace).map_err(|()| "failed to create URI")?.to_string();
    let open_doc = "file:///tmp/editor-buffer/lib/Dup/Mod.pm".to_string();

    let result = resolve_module_uri(
        "Dup::Mod",
        std::slice::from_ref(&open_doc),
        &[ws_uri],
        &["lib".to_string()],
        false,
        &[],
        Duration::from_millis(200),
    );

    assert_eq!(result, ModuleUriResolution::Resolved(open_doc));
    Ok(())
}