proto_node 0.12.2

DEPRECATED: Node.js support for proto.
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
use proto_core::{
    Detector, Downloadable, Executable, Installable, Proto, Resolvable, Shimable, Tool,
};
use proto_node::{NodeDependencyManager, NodeDependencyManagerType};
use starbase_sandbox::create_empty_sandbox;
use std::env;
use std::path::Path;

mod node_depman {
    use super::*;

    #[tokio::test]
    async fn downloads_verifies_installs_npm() {
        let fixture = create_empty_sandbox();
        let proto = Proto::from(fixture.path());
        let mut tool = NodeDependencyManager::new(&proto, NodeDependencyManagerType::Npm);

        env::set_var("PROTO_ROOT", fixture.path().to_string_lossy().to_string());

        tool.setup("9.0.0").await.unwrap();

        env::remove_var("PROTO_ROOT");

        assert!(tool.get_install_dir().unwrap().exists());

        assert_eq!(
            tool.get_bin_path().unwrap(),
            &proto.tools_dir.join("npm/9.0.0/bin/npm-cli.js")
        );

        if cfg!(windows) {
            assert_eq!(
                tool.get_shim_path().unwrap(),
                &proto.tools_dir.join("npm\\9.0.0\\shims\\npm.ps1")
            );
            assert!(proto.bin_dir.join("npm.cmd").exists());
        } else {
            assert_eq!(
                tool.get_shim_path().unwrap(),
                &proto.tools_dir.join("npm/9.0.0/shims/npm")
            );
            assert!(proto.bin_dir.join("npm").exists());
        }

        // Also check node-gyp

        if cfg!(windows) {
            assert!(proto.bin_dir.join("node-gyp.cmd").exists());
        } else {
            assert!(proto.bin_dir.join("node-gyp").exists());
        }
    }

    #[tokio::test]
    async fn downloads_verifies_installs_pnpm() {
        let fixture = create_empty_sandbox();
        let proto = Proto::from(fixture.path());
        let mut tool = NodeDependencyManager::new(&proto, NodeDependencyManagerType::Pnpm);

        tool.setup("7.0.0").await.unwrap();

        assert!(tool.get_install_dir().unwrap().exists());

        assert_eq!(
            tool.get_bin_path().unwrap(),
            &proto.tools_dir.join("pnpm/7.0.0/bin/pnpm.cjs")
        );
    }

    #[tokio::test]
    async fn downloads_verifies_installs_yarn_classic() {
        let fixture = create_empty_sandbox();
        let proto = Proto::from(fixture.path());
        let mut tool = NodeDependencyManager::new(&proto, NodeDependencyManagerType::Yarn);

        tool.setup("1.22.0").await.unwrap();

        assert!(tool.get_install_dir().unwrap().exists());

        assert_eq!(
            tool.get_bin_path().unwrap(),
            &proto.tools_dir.join("yarn/1.22.0/bin/yarn.js")
        );
    }

    #[tokio::test]
    async fn downloads_verifies_installs_yarn_berry() {
        let fixture = create_empty_sandbox();
        let proto = Proto::from(fixture.path());
        let mut tool = NodeDependencyManager::new(&proto, NodeDependencyManagerType::Yarn);

        tool.setup("3.3.0").await.unwrap();

        assert!(tool.get_install_dir().unwrap().exists());

        assert_eq!(tool.get_resolved_version(), "1.22.19");
        assert_eq!(
            tool.get_bin_path().unwrap(),
            &proto.tools_dir.join("yarn/1.22.19/bin/yarn.js")
        );
    }

    fn create_depman(dir: &Path) -> NodeDependencyManager {
        let mut tool = NodeDependencyManager::new(Proto::from(dir), NodeDependencyManagerType::Npm);
        tool.version = Some("9.0.0".into());
        tool
    }

    mod detector {
        use super::*;

        #[tokio::test]
        async fn doesnt_match_if_no_json_file() {
            let fixture = create_empty_sandbox();
            let tool = create_depman(fixture.path());

            assert_eq!(
                tool.detect_version_from(fixture.path()).await.unwrap(),
                None
            );
        }

        #[tokio::test]
        async fn doesnt_match_if_no_field() {
            let fixture = create_empty_sandbox();

            fixture.create_file("package.json", r#"{}"#);

            let tool = create_depman(fixture.path());

            assert_eq!(
                tool.detect_version_from(fixture.path()).await.unwrap(),
                None
            );
        }

        #[tokio::test]
        async fn doesnt_match_if_diff_package_name() {
            let fixture = create_empty_sandbox();

            fixture.create_file("package.json", r#"{"packageManager":"yarn@1.2.3"}"#);

            let tool = create_depman(fixture.path());

            assert_eq!(
                tool.detect_version_from(fixture.path()).await.unwrap(),
                None
            );
        }

        #[tokio::test]
        async fn defaults_to_latest_version() {
            let fixture = create_empty_sandbox();

            fixture.create_file("package.json", r#"{"packageManager":"npm"}"#);

            let tool = create_depman(fixture.path());

            assert_eq!(
                tool.detect_version_from(fixture.path()).await.unwrap(),
                Some("latest".into())
            );
        }

        #[tokio::test]
        async fn matches_pm_partial_version() {
            let fixture = create_empty_sandbox();

            fixture.create_file("package.json", r#"{"packageManager":"npm@1"}"#);

            let tool = create_depman(fixture.path());

            assert_eq!(
                tool.detect_version_from(fixture.path()).await.unwrap(),
                Some("1".into())
            );
        }

        #[tokio::test]
        async fn matches_engines_partial_version() {
            let fixture = create_empty_sandbox();

            fixture.create_file("package.json", r#"{"engines":{"npm":"1.2"}}"#);

            let tool = create_depman(fixture.path());

            assert_eq!(
                tool.detect_version_from(fixture.path()).await.unwrap(),
                Some("1.2".into())
            );
        }

        #[tokio::test]
        async fn detects_npm() {
            let fixture = create_empty_sandbox();

            fixture.create_file("package.json", r#"{"packageManager":"npm@1.2.3"}"#);

            let tool = create_depman(fixture.path());

            assert_eq!(
                tool.detect_version_from(fixture.path()).await.unwrap(),
                Some("1.2.3".into())
            );
        }

        #[tokio::test]
        async fn detects_npm_from_engines() {
            let fixture = create_empty_sandbox();

            fixture.create_file("package.json", r#"{"engines":{"npm":"1.2.3"}}"#);

            let tool = create_depman(fixture.path());

            assert_eq!(
                tool.detect_version_from(fixture.path()).await.unwrap(),
                Some("1.2.3".into())
            );
        }

        #[tokio::test]
        async fn detects_pnpm() {
            let fixture = create_empty_sandbox();

            fixture.create_file("package.json", r#"{"packageManager":"pnpm@4.5.6"}"#);

            let proto = Proto::from(fixture.path());
            let tool = NodeDependencyManager::new(proto, NodeDependencyManagerType::Pnpm);

            assert_eq!(
                tool.detect_version_from(fixture.path()).await.unwrap(),
                Some("4.5.6".into())
            );
        }

        #[tokio::test]
        async fn detects_pnpm_from_engines() {
            let fixture = create_empty_sandbox();

            fixture.create_file("package.json", r#"{"engines":{"pnpm":"=4.5.6"}}"#);

            let proto = Proto::from(fixture.path());
            let tool = NodeDependencyManager::new(proto, NodeDependencyManagerType::Pnpm);

            assert_eq!(
                tool.detect_version_from(fixture.path()).await.unwrap(),
                Some("=4.5.6".into())
            );
        }

        #[tokio::test]
        async fn detects_yarn() {
            let fixture = create_empty_sandbox();

            fixture.create_file("package.json", r#"{"packageManager":"yarn@7.8.9"}"#);

            let proto = Proto::from(fixture.path());
            let tool = NodeDependencyManager::new(proto, NodeDependencyManagerType::Yarn);

            assert_eq!(
                tool.detect_version_from(fixture.path()).await.unwrap(),
                Some("7.8.9".into())
            );
        }

        #[tokio::test]
        async fn detects_yarn_from_engines() {
            let fixture = create_empty_sandbox();

            fixture.create_file("package.json", r#"{"engines":{"yarn":"7.8.9"}}"#);

            let proto = Proto::from(fixture.path());
            let tool = NodeDependencyManager::new(proto, NodeDependencyManagerType::Yarn);

            assert_eq!(
                tool.detect_version_from(fixture.path()).await.unwrap(),
                Some("7.8.9".into())
            );
        }
    }

    mod downloader {
        use super::*;

        #[tokio::test]
        async fn sets_path_to_temp() {
            let fixture = create_empty_sandbox();
            let tool = create_depman(fixture.path());

            assert_eq!(
                tool.get_download_path().unwrap(),
                Proto::from(fixture.path())
                    .temp_dir
                    .join("npm")
                    .join("v9.0.0.tgz")
            );
        }

        #[tokio::test]
        async fn downloads_to_temp() {
            let fixture = create_empty_sandbox();
            let tool = create_depman(fixture.path());

            let to_file = tool.get_download_path().unwrap();

            assert!(!to_file.exists());

            tool.download(&to_file, None).await.unwrap();

            assert!(to_file.exists());
        }

        #[tokio::test]
        async fn doesnt_download_if_file_exists() {
            let fixture = create_empty_sandbox();
            let tool = create_depman(fixture.path());

            let to_file = tool.get_download_path().unwrap();

            assert!(tool.download(&to_file, None).await.unwrap());
            assert!(!tool.download(&to_file, None).await.unwrap());
        }
    }

    mod resolver {
        use super::*;

        #[tokio::test]
        async fn resolve_latest() {
            let fixture = create_empty_sandbox();
            let mut tool = NodeDependencyManager::new(
                Proto::from(fixture.path()),
                NodeDependencyManagerType::Npm,
            );

            assert_ne!(tool.resolve_version("latest").await.unwrap(), "latest");
            assert_ne!(tool.get_resolved_version(), "latest");
        }

        #[tokio::test]
        async fn resolve_partial_version() {
            let fixture = create_empty_sandbox();
            let mut tool = NodeDependencyManager::new(
                Proto::from(fixture.path()),
                NodeDependencyManagerType::Npm,
            );

            assert_eq!(tool.resolve_version("6").await.unwrap(), "6.14.18");
        }

        #[tokio::test]
        async fn resolve_version_with_prefix() {
            let fixture = create_empty_sandbox();
            let mut tool = NodeDependencyManager::new(
                Proto::from(fixture.path()),
                NodeDependencyManagerType::Npm,
            );

            assert_eq!(tool.resolve_version("v9.0.0").await.unwrap(), "9.0.0");
        }

        #[tokio::test]
        async fn resolve_custom_dist() {
            let fixture = create_empty_sandbox();
            let mut tool = NodeDependencyManager::new(
                Proto::from(fixture.path()),
                NodeDependencyManagerType::Yarn,
            );

            assert_ne!(tool.resolve_version("berry").await.unwrap(), "berry");
        }

        #[tokio::test]
        async fn resolve_custom_alias() {
            let fixture = create_empty_sandbox();
            let mut tool = NodeDependencyManager::new(
                Proto::from(fixture.path()),
                NodeDependencyManagerType::Npm,
            );

            fixture.create_file(
                "tools/npm/manifest.json",
                r#"{"aliases":{"example":"9.0.0"}}"#,
            );

            assert_eq!(tool.resolve_version("example").await.unwrap(), "9.0.0");
        }

        #[tokio::test]
        async fn handles_npm() {
            let fixture = create_empty_sandbox();
            let mut tool = NodeDependencyManager::new(
                Proto::from(fixture.path()),
                NodeDependencyManagerType::Npm,
            );

            assert_eq!(tool.resolve_version("9.0.0").await.unwrap(), "9.0.0");
        }

        #[tokio::test]
        async fn handles_pnpm() {
            let fixture = create_empty_sandbox();
            let mut tool = NodeDependencyManager::new(
                Proto::from(fixture.path()),
                NodeDependencyManagerType::Pnpm,
            );

            assert_eq!(tool.resolve_version("7.0.0").await.unwrap(), "7.0.0");
        }

        #[tokio::test]
        async fn handles_yarn() {
            let fixture = create_empty_sandbox();
            let mut tool = NodeDependencyManager::new(
                Proto::from(fixture.path()),
                NodeDependencyManagerType::Yarn,
            );

            assert_eq!(tool.resolve_version("1.22.0").await.unwrap(), "1.22.0");
        }

        #[tokio::test]
        #[should_panic(expected = "VersionUnknownAlias(\"unknown\")")]
        async fn errors_invalid_alias() {
            let fixture = create_empty_sandbox();
            let mut tool = NodeDependencyManager::new(
                Proto::from(fixture.path()),
                NodeDependencyManagerType::Npm,
            );

            tool.resolve_version("unknown").await.unwrap();
        }

        #[tokio::test]
        #[should_panic(expected = "VersionResolveFailed(\"99.99.99\")")]
        async fn errors_invalid_version() {
            let fixture = create_empty_sandbox();
            let mut tool = NodeDependencyManager::new(
                Proto::from(fixture.path()),
                NodeDependencyManagerType::Npm,
            );

            tool.resolve_version("99.99.99").await.unwrap();
        }
    }
}