-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsync_test.go
More file actions
942 lines (875 loc) · 29.7 KB
/
sync_test.go
File metadata and controls
942 lines (875 loc) · 29.7 KB
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
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
package pin
import (
"archive/tar"
"bytes"
"compress/gzip"
"context"
"crypto/sha512"
"encoding/base64"
"encoding/json"
"maps"
"net/http"
"net/http/httptest"
"os"
"path/filepath"
"strings"
"testing"
"github.com/git-pkgs/pin/lock"
"github.com/git-pkgs/pin/pinfs"
"github.com/git-pkgs/pin/source/forge"
)
func makeTarball(files map[string]string) []byte {
var buf bytes.Buffer
gz := gzip.NewWriter(&buf)
tw := tar.NewWriter(gz)
for p, c := range files {
_ = tw.WriteHeader(&tar.Header{Name: "package/" + p, Mode: 0o644, Size: int64(len(c))})
_, _ = tw.Write([]byte(c))
}
_ = tw.Close()
_ = gz.Close()
return buf.Bytes()
}
func fakeNPM(t *testing.T, name, version string, pkgFiles map[string]string) *httptest.Server {
t.Helper()
pj, _ := json.Marshal(map[string]any{"name": name, "version": version, "main": "index.js"})
all := map[string]string{"package.json": string(pj)}
maps.Copy(all, pkgFiles)
tb := makeTarball(all)
h := sha512.Sum512(tb)
integrity := "sha512-" + base64.StdEncoding.EncodeToString(h[:])
mux := http.NewServeMux()
var srvURL string
mux.HandleFunc("/"+name+"/"+version, func(w http.ResponseWriter, r *http.Request) {
_ = json.NewEncoder(w).Encode(map[string]any{
"name": name,
"version": version,
"license": "MIT",
"dist": map[string]any{"tarball": srvURL + "/tarball.tgz", "integrity": integrity},
})
})
mux.HandleFunc("/tarball.tgz", func(w http.ResponseWriter, r *http.Request) {
_, _ = w.Write(tb)
})
srv := httptest.NewServer(mux)
srvURL = srv.URL
t.Cleanup(srv.Close)
return srv
}
func writeManifest(t *testing.T, dir, content string) {
t.Helper()
if err := os.WriteFile(filepath.Join(dir, DefaultManifest), []byte(content), 0o644); err != nil {
t.Fatal(err)
}
}
func TestSyncEndToEnd(t *testing.T) {
srv := fakeNPM(t, "demo", "1.2.3", map[string]string{
"dist/demo.min.js": "console.log('demo')",
"dist/demo.min.css": "body{}",
})
dir := t.TempDir()
writeManifest(t, dir, `out: "static/vendor"
assets:
- name: "demo"
version: "1.2.3"
files: ["dist/demo.min.js", "dist/demo.min.css"]
`)
res, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL})
if err != nil {
t.Fatalf("Sync: %v", err)
}
if len(res.Lock.Assets) != 2 {
t.Fatalf("lock assets = %d, want 2", len(res.Lock.Assets))
}
if len(res.Changes.Added) != 2 {
t.Errorf("Added = %d, want 2", len(res.Changes.Added))
}
for _, p := range []string{"static/vendor/demo/demo.min.js", "static/vendor/demo/demo.min.css"} {
if _, err := os.Stat(filepath.Join(dir, p)); err != nil {
t.Errorf("expected file %s on disk: %v", p, err)
}
}
lockBytes, err := os.ReadFile(filepath.Join(dir, DefaultLock))
if err != nil {
t.Fatalf("read pin.lock: %v", err)
}
if !strings.Contains(string(lockBytes), `"bomFormat": "CycloneDX"`) {
t.Error("pin.lock should be CycloneDX")
}
if _, err := lock.Read(bytes.NewReader(lockBytes)); err != nil {
t.Errorf("pin.lock not parseable: %v", err)
}
}
func TestSyncIdempotent(t *testing.T) {
srv := fakeNPM(t, "demo", "1.0.0", map[string]string{"dist/x.js": "x"})
dir := t.TempDir()
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "1.0.0"
files: ["dist/x.js"]
`)
first, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL})
if err != nil {
t.Fatal(err)
}
lock1, _ := os.ReadFile(filepath.Join(dir, DefaultLock))
second, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL})
if err != nil {
t.Fatal(err)
}
lock2, _ := os.ReadFile(filepath.Join(dir, DefaultLock))
if !bytes.Equal(lock1, lock2) {
t.Error("second sync produced different lockfile bytes")
}
info1, _ := os.Stat(filepath.Join(dir, DefaultLock))
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL}); err != nil {
t.Fatal(err)
}
info2, _ := os.Stat(filepath.Join(dir, DefaultLock))
if !info1.ModTime().Equal(info2.ModTime()) {
t.Error("third sync touched lockfile mtime despite identical bytes")
}
if len(first.Changes.Added) != 1 || len(second.Changes.Added) != 0 {
t.Errorf("first.Added = %d, second.Added = %d", len(first.Changes.Added), len(second.Changes.Added))
}
if len(second.Changes.Unchanged) != 1 {
t.Errorf("second.Unchanged = %d, want 1", len(second.Changes.Unchanged))
}
}
func TestSyncFrozen(t *testing.T) {
srv := fakeNPM(t, "demo", "1.0.0", map[string]string{"dist/x.js": "x"})
dir := t.TempDir()
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "1.0.0"
files: ["dist/x.js"]
`)
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL, Frozen: true}); err == nil {
t.Fatal("frozen sync with no lockfile should fail")
}
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL}); err != nil {
t.Fatal(err)
}
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL, Frozen: true}); err != nil {
t.Errorf("frozen sync after clean sync should succeed: %v", err)
}
}
func TestSyncOrphanRemoval(t *testing.T) {
srv := fakeNPM(t, "demo", "1.0.0", map[string]string{"dist/a.js": "a", "dist/b.js": "b"})
dir := t.TempDir()
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "1.0.0"
files: ["dist/a.js", "dist/b.js"]
`)
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL}); err != nil {
t.Fatal(err)
}
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "1.0.0"
files: ["dist/a.js"]
`)
res, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL})
if err != nil {
t.Fatal(err)
}
if len(res.Removed) != 1 || res.Removed[0] != "demo/b.js" {
t.Errorf("Removed = %v, want [demo/b.js]", res.Removed)
}
if _, err := os.Stat(filepath.Join(dir, "v/demo/b.js")); !os.IsNotExist(err) {
t.Error("orphan b.js should have been removed")
}
if _, err := os.Stat(filepath.Join(dir, "v/demo/a.js")); err != nil {
t.Error("a.js should still exist")
}
}
func TestSyncPrunesEmptyDirs(t *testing.T) {
srv := fakeNPM(t, "demo", "1.0.0", map[string]string{"dist/x.js": "x"})
dir := t.TempDir()
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "1.0.0"
files: ["dist/x.js"]
`)
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL}); err != nil {
t.Fatal(err)
}
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "1.0.0"
files: ["dist/x.js"]
`)
if err := os.RemoveAll(filepath.Join(dir, "v/demo")); err != nil {
t.Fatal(err)
}
_ = os.MkdirAll(filepath.Join(dir, "v/gone/nested"), 0o755)
_ = os.WriteFile(filepath.Join(dir, "pin.lock"), mustEncodeLock(t, &lock.Lock{
OutDir: "v",
Assets: []lock.Asset{{Name: "gone", Version: "1.0.0", PURL: "pkg:npm/gone@1.0.0", Path: "nested/y.js", Out: "gone/nested/y.js"}},
}), 0o644)
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL}); err != nil {
t.Fatal(err)
}
if _, err := os.Stat(filepath.Join(dir, "v/gone")); !os.IsNotExist(err) {
t.Error("empty 'gone' directory should have been pruned")
}
}
func mustEncodeLock(t *testing.T, l *lock.Lock) []byte {
t.Helper()
b, err := EncodeLock(l)
if err != nil {
t.Fatal(err)
}
return b
}
// TestSyncConcurrencyDeterministic asserts the lockfile bytes are
// independent of the resolve completion order: the same manifest with
// --concurrency=1 and --concurrency=8 produces the same lockfile.
// Combined with `go test -race`, this also catches data races in the
// per-entry resolve path.
func TestSyncConcurrencyDeterministic(t *testing.T) {
pkgs := []string{"alpha", "bravo", "charlie", "delta", "echo", "foxtrot", "golf", "hotel"}
mux := http.NewServeMux()
tarballs := map[string][]byte{}
sharedURL := ""
for _, name := range pkgs {
pj, _ := json.Marshal(map[string]any{"name": name, "version": "1.0.0", "main": "index.js"})
tb := makeTarball(map[string]string{
"package.json": string(pj),
"index.js": "module.exports='" + name + "'",
})
tarballs["/"+name+"/-/"+name+"-1.0.0.tgz"] = tb
h := sha512.Sum512(tb)
integrity := "sha512-" + base64.StdEncoding.EncodeToString(h[:])
n := name
mux.HandleFunc("/"+n+"/1.0.0", func(w http.ResponseWriter, _ *http.Request) {
_ = json.NewEncoder(w).Encode(map[string]any{
"name": n,
"version": "1.0.0",
"dist": map[string]any{"tarball": sharedURL + "/" + n + "/-/" + n + "-1.0.0.tgz", "integrity": integrity},
})
})
}
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
if tb, ok := tarballs[r.URL.Path]; ok {
_, _ = w.Write(tb)
return
}
http.NotFound(w, r)
})
sharedSrv := httptest.NewServer(mux)
sharedURL = sharedSrv.URL
t.Cleanup(sharedSrv.Close)
build := func(concurrency int) []byte {
dir := t.TempDir()
var mf strings.Builder
mf.WriteString("out: \"v\"\nassets:\n")
for _, name := range pkgs {
mf.WriteString(" - name: \"" + name + "\"\n version: \"1.0.0\"\n files: [\"index.js\"]\n")
}
writeManifest(t, dir, mf.String())
if _, err := Sync(context.Background(), SyncOptions{
Dir: dir,
RegistryURL: sharedURL,
Concurrency: concurrency,
}); err != nil {
t.Fatalf("Sync concurrency=%d: %v", concurrency, err)
}
b, err := os.ReadFile(filepath.Join(dir, DefaultLock))
if err != nil {
t.Fatal(err)
}
return b
}
serial := build(1)
parallel := build(8)
if !bytes.Equal(serial, parallel) {
t.Error("lockfile differs between --concurrency=1 and --concurrency=8 — resolves must be order-independent")
}
l, err := lock.Read(bytes.NewReader(parallel))
if err != nil {
t.Fatalf("lock.Read: %v", err)
}
if len(l.Assets) != len(pkgs) {
t.Errorf("got %d assets, want %d", len(l.Assets), len(pkgs))
}
}
func TestSyncNoFetch(t *testing.T) {
srv := fakeNPM(t, "demo", "1.0.0", map[string]string{"dist/x.js": "x"})
dir := t.TempDir()
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "1.0.0"
files: ["dist/x.js"]
`)
// First seed the vendored files + lockfile with a normal sync.
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL}); err != nil {
t.Fatalf("seed sync: %v", err)
}
srv.Close() // ensure --no-fetch cannot reach the registry
// Happy path: identical disk, identical lockfile, identical manifest.
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, NoFetch: true}); err != nil {
t.Errorf("--no-fetch on clean tree: %v", err)
}
// Tampered: an attacker edits a vendored file post-checkout. --no-fetch
// re-hashes and surfaces the drift.
if err := os.WriteFile(filepath.Join(dir, "v/demo/x.js"), []byte("tampered"), 0o644); err != nil {
t.Fatal(err)
}
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, NoFetch: true}); err == nil {
t.Error("--no-fetch should fail when a vendored file was tampered with")
}
}
func TestSyncNoFetchManifestDrift(t *testing.T) {
srv := fakeNPM(t, "demo", "1.0.0", map[string]string{"dist/x.js": "x"})
dir := t.TempDir()
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "1.0.0"
files: ["dist/x.js"]
`)
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL}); err != nil {
t.Fatal(err)
}
srv.Close()
// Manifest now references a version the lockfile doesn't have. --no-fetch
// must bail via the frozen check before any verification.
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "2.0.0"
files: ["dist/x.js"]
`)
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, NoFetch: true}); err == nil {
t.Error("--no-fetch should fail when manifest drifts ahead of the lockfile")
}
}
// fakeGitHub mirrors source/forge's test helper: stub /repos commits
// lookup + jsdelivr-style /gh/{owner}/{repo}@{sha}/ file fetches. The
// pin root sync test needs both endpoints on the same httptest server
// so we can wire them through SyncOptions.Forge in one go.
func fakeGitHub(t *testing.T, owner, repo, tag, sha string, files map[string]string) (api, cdn string) {
t.Helper()
apiMux := http.NewServeMux()
apiMux.HandleFunc("/repos/"+owner+"/"+repo+"/commits/"+tag, func(w http.ResponseWriter, _ *http.Request) {
_ = json.NewEncoder(w).Encode(map[string]string{"sha": sha})
})
apiSrv := httptest.NewServer(apiMux)
t.Cleanup(apiSrv.Close)
cdnMux := http.NewServeMux()
for path, content := range files {
p := "/gh/" + owner + "/" + repo + "@" + sha + "/" + path
body := content
cdnMux.HandleFunc(p, func(w http.ResponseWriter, _ *http.Request) {
_, _ = w.Write([]byte(body))
})
}
cdnSrv := httptest.NewServer(cdnMux)
t.Cleanup(cdnSrv.Close)
return apiSrv.URL, cdnSrv.URL
}
func TestSyncForgeEntry(t *testing.T) {
api, cdn := fakeGitHub(t, "highlightjs", "cdn-release", "11.11.1",
"abc123def4567890abc123def4567890abc12345",
map[string]string{
"build/highlight.min.js": "var hljs={}",
})
dir := t.TempDir()
writeManifest(t, dir, `out: "v"
assets:
- name: "highlight.js"
source: "github:highlightjs/cdn-release"
version: "11.11.1"
files: ["build/highlight.min.js"]
`)
res, err := Sync(context.Background(), SyncOptions{
Dir: dir,
Forge: forge.Options{
GitHubAPI: api,
JSDelivrCDN: cdn,
},
})
if err != nil {
t.Fatalf("forge Sync: %v", err)
}
if len(res.Lock.Assets) != 1 {
t.Fatalf("Lock.Assets = %d, want 1", len(res.Lock.Assets))
}
a := res.Lock.Assets[0]
if !strings.HasPrefix(a.PURL, "pkg:github/highlightjs/cdn-release@11.11.1") {
t.Errorf("PURL = %q, want pkg:github/... prefix", a.PURL)
}
if a.PackageIntegrity != "abc123def4567890abc123def4567890abc12345" {
t.Errorf("PackageIntegrity = %q, want the SHA", a.PackageIntegrity)
}
got, err := os.ReadFile(filepath.Join(dir, "v/highlightjs__cdn-release/highlight.min.js"))
if err != nil {
t.Fatalf("vendored file missing: %v", err)
}
if string(got) != "var hljs={}" {
t.Errorf("file bytes = %q", got)
}
}
// TestParallelAdds_MergeFriendly simulates two branches each running
// `pin add` on a different package. If branch A adds foo and branch B
// adds bar, the resulting lockfiles must converge to byte-identical
// output regardless of which branch's add ran first. That's what makes
// pin.lock survive `git merge` without conflict: assets sort by name,
// so two non-overlapping additions land at disjoint positions in the
// file.
func TestParallelAdds_MergeFriendly(t *testing.T) {
mux := http.NewServeMux()
tarballs := map[string][]byte{}
sharedURL := ""
for _, name := range []string{"foo", "bar", "common"} {
pj, _ := json.Marshal(map[string]any{"name": name, "version": "1.0.0", "main": "index.js"})
tb := makeTarball(map[string]string{
"package.json": string(pj),
"index.js": "module.exports='" + name + "'",
})
tarballs["/"+name+"/-/"+name+"-1.0.0.tgz"] = tb
h := sha512.Sum512(tb)
integrity := "sha512-" + base64.StdEncoding.EncodeToString(h[:])
n := name
mux.HandleFunc("/"+n+"/1.0.0", func(w http.ResponseWriter, _ *http.Request) {
_ = json.NewEncoder(w).Encode(map[string]any{
"name": n,
"version": "1.0.0",
"dist": map[string]any{"tarball": sharedURL + "/" + n + "/-/" + n + "-1.0.0.tgz", "integrity": integrity},
})
})
}
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
if tb, ok := tarballs[r.URL.Path]; ok {
_, _ = w.Write(tb)
return
}
http.NotFound(w, r)
})
srv := httptest.NewServer(mux)
sharedURL = srv.URL
t.Cleanup(srv.Close)
// Set up a base manifest+lockfile with one common asset, then on
// two divergent branches add foo and bar respectively.
makeBase := func(t *testing.T) string {
t.Helper()
dir := t.TempDir()
writeManifest(t, dir, `out: "v"
assets:
- name: "common"
version: "1.0.0"
files: ["index.js"]
`)
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL}); err != nil {
t.Fatal(err)
}
return dir
}
// Branch A: add foo to the base.
dirA := makeBase(t)
if _, err := Add(context.Background(), "foo@1.0.0", []string{"index.js"},
AddOptions{Dir: dirA, RegistryURL: srv.URL}); err != nil {
t.Fatalf("branch A add: %v", err)
}
// Branch B: add bar to the base.
dirB := makeBase(t)
if _, err := Add(context.Background(), "bar@1.0.0", []string{"index.js"},
AddOptions{Dir: dirB, RegistryURL: srv.URL}); err != nil {
t.Fatalf("branch B add: %v", err)
}
// Merge: a third tree with both foo and bar added (either order).
mergeOrder1 := makeBase(t)
for _, name := range []string{"foo", "bar"} {
if _, err := Add(context.Background(), name+"@1.0.0", []string{"index.js"},
AddOptions{Dir: mergeOrder1, RegistryURL: srv.URL}); err != nil {
t.Fatalf("merge order 1 add %s: %v", name, err)
}
}
mergeOrder2 := makeBase(t)
for _, name := range []string{"bar", "foo"} {
if _, err := Add(context.Background(), name+"@1.0.0", []string{"index.js"},
AddOptions{Dir: mergeOrder2, RegistryURL: srv.URL}); err != nil {
t.Fatalf("merge order 2 add %s: %v", name, err)
}
}
// Order independence: adds in either order produce identical bytes.
lock1, _ := os.ReadFile(filepath.Join(mergeOrder1, DefaultLock))
lock2, _ := os.ReadFile(filepath.Join(mergeOrder2, DefaultLock))
if !bytes.Equal(lock1, lock2) {
t.Error("lockfile bytes differ between add-order foo→bar and bar→foo")
}
mf1, _ := os.ReadFile(filepath.Join(mergeOrder1, DefaultManifest))
mf2, _ := os.ReadFile(filepath.Join(mergeOrder2, DefaultManifest))
if !bytes.Equal(mf1, mf2) {
t.Error("manifest bytes differ between add-order foo→bar and bar→foo")
}
// Disjoint-diff property: branch A's lockfile and branch B's
// lockfile each differ from the base only by additions. Lines
// belonging to the common asset must appear unchanged in both.
base, _ := os.ReadFile(filepath.Join(mergeOrder1, DefaultLock))
lockA, _ := os.ReadFile(filepath.Join(dirA, DefaultLock))
lockB, _ := os.ReadFile(filepath.Join(dirB, DefaultLock))
for ln := range strings.SplitSeq(string(base), "\n") {
if !strings.Contains(ln, "common") {
continue
}
if !strings.Contains(string(lockA), ln) {
t.Errorf("base line %q changed on branch A — common-asset lines should be stable", strings.TrimSpace(ln))
}
if !strings.Contains(string(lockB), ln) {
t.Errorf("base line %q changed on branch B — common-asset lines should be stable", strings.TrimSpace(ln))
}
}
}
// TestUpdate_FloatingRangeBumps asserts that `pin update` re-resolves
// a floating range to the highest currently-satisfying version even
// when the lockfile already has a (lower) satisfying version pinned.
// `pin sync` without UpdateAll is lock-is-sticky and leaves the older
// version in place.
func TestUpdate_FloatingRangeBumps(t *testing.T) {
srv := twoVersionRegistry(t, "demo")
dir := t.TempDir()
// Start with an exact pin so the first sync locks at 1.0.0.
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "1.0.0"
files: ["index.js"]
`)
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL}); err != nil {
t.Fatal(err)
}
lockPath := filepath.Join(dir, DefaultLock)
got, _ := os.ReadFile(lockPath)
if !strings.Contains(string(got), `pkg:npm/demo@1.0.0"`) {
t.Fatalf("first sync should lock at 1.0.0; lockfile:\n%s", got)
}
// Widen to a floating range. Plain Sync is sticky and keeps 1.0.0.
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "^1.0"
files: ["index.js"]
`)
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL}); err != nil {
t.Fatal(err)
}
got, _ = os.ReadFile(lockPath)
if !strings.Contains(string(got), `pkg:npm/demo@1.0.0"`) {
t.Errorf("plain Sync should keep 1.0.0 (lock-is-sticky); got:\n%s", got)
}
// UpdateAll bumps to the latest satisfying version.
if _, err := Sync(context.Background(), SyncOptions{
Dir: dir, RegistryURL: srv.URL, UpdateAll: true,
}); err != nil {
t.Fatal(err)
}
got, _ = os.ReadFile(lockPath)
if !strings.Contains(string(got), `pkg:npm/demo@1.5.0"`) {
t.Errorf("UpdateAll should bump to 1.5.0; lockfile:\n%s", got)
}
}
// twoVersionRegistry serves npm packument + version docs for {name}
// at versions 1.0.0 and 1.5.0, with 1.5.0 as `latest`.
func twoVersionRegistry(t *testing.T, name string) *httptest.Server {
t.Helper()
mux := http.NewServeMux()
tarballs := map[string][]byte{}
var sharedURL string
for _, v := range []string{"1.0.0", "1.5.0"} {
pj, _ := json.Marshal(map[string]any{"name": name, "version": v, "main": "index.js"})
tb := makeTarball(map[string]string{
"package.json": string(pj),
"index.js": "module.exports='" + name + "@" + v + "'",
})
tarballs["/"+name+"/-/"+name+"-"+v+".tgz"] = tb
h := sha512.Sum512(tb)
integrity := "sha512-" + base64.StdEncoding.EncodeToString(h[:])
ver := v
mux.HandleFunc("/"+name+"/"+ver, func(w http.ResponseWriter, _ *http.Request) {
_ = json.NewEncoder(w).Encode(map[string]any{
"name": name,
"version": ver,
"dist": map[string]any{"tarball": sharedURL + "/" + name + "/-/" + name + "-" + ver + ".tgz", "integrity": integrity},
})
})
}
mux.HandleFunc("/"+name, func(w http.ResponseWriter, _ *http.Request) {
_ = json.NewEncoder(w).Encode(map[string]any{
"name": name,
"dist-tags": map[string]string{"latest": "1.5.0"},
"versions": map[string]any{
"1.0.0": map[string]any{"name": name, "version": "1.0.0"},
"1.5.0": map[string]any{"name": name, "version": "1.5.0"},
},
})
})
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
if tb, ok := tarballs[r.URL.Path]; ok {
_, _ = w.Write(tb)
return
}
http.NotFound(w, r)
})
srv := httptest.NewServer(mux)
sharedURL = srv.URL
t.Cleanup(srv.Close)
return srv
}
// TestUpdate_ExactPinIsNoOp asserts `pin update` against a manifest
// with an exact-version pin is a no-op: the locked version stays at
// the named version regardless of what's in the registry.
func TestUpdate_ExactPinIsNoOp(t *testing.T) {
srv := fakeNPM(t, "demo", "1.0.0", map[string]string{"index.js": "x"})
dir := t.TempDir()
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "1.0.0"
files: ["index.js"]
`)
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL}); err != nil {
t.Fatal(err)
}
first, _ := os.ReadFile(filepath.Join(dir, DefaultLock))
if _, err := Sync(context.Background(), SyncOptions{
Dir: dir, RegistryURL: srv.URL, UpdateAll: true,
}); err != nil {
t.Fatal(err)
}
second, _ := os.ReadFile(filepath.Join(dir, DefaultLock))
if !bytes.Equal(first, second) {
t.Error("Update with an exact pin should be a no-op; lockfile changed")
}
}
// TestUpdate_NamedEntry exercises the Update slice path: only the
// named entries re-resolve, others stay sticky.
func TestUpdate_NamedEntry(t *testing.T) {
mux := http.NewServeMux()
tarballs := map[string][]byte{}
var sharedURL string
for _, name := range []string{"alpha", "beta"} {
for _, v := range []string{"1.0.0", "1.5.0"} {
pj, _ := json.Marshal(map[string]any{"name": name, "version": v, "main": "index.js"})
tb := makeTarball(map[string]string{
"package.json": string(pj),
"index.js": "module.exports='" + name + "@" + v + "'",
})
tarballs["/"+name+"/-/"+name+"-"+v+".tgz"] = tb
h := sha512.Sum512(tb)
integrity := "sha512-" + base64.StdEncoding.EncodeToString(h[:])
n, ver := name, v
mux.HandleFunc("/"+n+"/"+ver, func(w http.ResponseWriter, _ *http.Request) {
_ = json.NewEncoder(w).Encode(map[string]any{
"name": n,
"version": ver,
"dist": map[string]any{"tarball": sharedURL + "/" + n + "/-/" + n + "-" + ver + ".tgz", "integrity": integrity},
})
})
}
n := name
mux.HandleFunc("/"+n, func(w http.ResponseWriter, _ *http.Request) {
_ = json.NewEncoder(w).Encode(map[string]any{
"name": n,
"dist-tags": map[string]string{"latest": "1.5.0"},
"versions": map[string]any{
"1.0.0": map[string]any{"name": n, "version": "1.0.0"},
"1.5.0": map[string]any{"name": n, "version": "1.5.0"},
},
})
})
}
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
if tb, ok := tarballs[r.URL.Path]; ok {
_, _ = w.Write(tb)
return
}
http.NotFound(w, r)
})
srv := httptest.NewServer(mux)
sharedURL = srv.URL
t.Cleanup(srv.Close)
dir := t.TempDir()
// Start with both at exact 1.0.0 to seed the lockfile.
writeManifest(t, dir, `out: "v"
assets:
- name: "alpha"
version: "1.0.0"
files: ["index.js"]
- name: "beta"
version: "1.0.0"
files: ["index.js"]
`)
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL}); err != nil {
t.Fatal(err)
}
// Widen both to floating ranges. Sync stays sticky on both.
writeManifest(t, dir, `out: "v"
assets:
- name: "alpha"
version: "^1.0"
files: ["index.js"]
- name: "beta"
version: "^1.0"
files: ["index.js"]
`)
// Update only "alpha"; beta stays at 1.0.0.
if _, err := Sync(context.Background(), SyncOptions{
Dir: dir, RegistryURL: srv.URL, Update: []string{"alpha"},
}); err != nil {
t.Fatal(err)
}
got, _ := os.ReadFile(filepath.Join(dir, DefaultLock))
if !strings.Contains(string(got), `pkg:npm/alpha@1.5.0"`) {
t.Errorf("alpha should be bumped to 1.5.0; got:\n%s", got)
}
if !strings.Contains(string(got), `pkg:npm/beta@1.0.0"`) {
t.Errorf("beta should stay at 1.0.0 (not named in Update); got:\n%s", got)
}
}
// TestSync_StripSourcemap asserts that strip_sourcemap: true at the
// entry level removes sourceMappingURL directives from vendored
// scripts AND that the lockfile's integrity is for the stripped
// bytes — so verify on a clean checkout doesn't fail.
func TestSync_StripSourcemap(t *testing.T) {
srv := fakeNPM(t, "demo", "1.0.0", map[string]string{
"dist/x.js": "console.log(1);\n//# sourceMappingURL=x.js.map\n",
})
dir := t.TempDir()
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "1.0.0"
files: ["dist/x.js"]
strip_sourcemap: true
`)
if _, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL}); err != nil {
t.Fatal(err)
}
onDisk, err := os.ReadFile(filepath.Join(dir, "v/demo/x.js"))
if err != nil {
t.Fatal(err)
}
if strings.Contains(string(onDisk), "sourceMappingURL") {
t.Errorf("on-disk content still contains sourceMappingURL:\n%s", onDisk)
}
if want := "console.log(1);\n\n"; string(onDisk) != want {
t.Errorf("on-disk content = %q, want %q", onDisk, want)
}
// Verify reads the lockfile-recorded integrity and compares against
// the on-disk bytes. If strip recomputed integrity correctly, this
// passes; if integrity points at the pre-strip bytes, this fails.
vr, err := Verify(VerifyOptions{Dir: dir})
if err != nil {
t.Fatal(err)
}
if vr.Failed() {
t.Errorf("verify failed after strip — integrity not recomputed over stripped bytes: %+v", vr)
}
}
// TestSync_PerEntryRegistryURL exercises the `registry_url:` manifest
// field: pin should fetch this entry from the override registry while
// other entries (and SyncOptions.RegistryURL) keep pointing at the
// default. Two registries serve the same name@version with different
// bytes; the override must be the one we read.
func TestSync_PerEntryRegistryURL(t *testing.T) {
defaultReg := fakeNPM(t, "demo", "1.0.0", map[string]string{"dist/x.js": "default-bytes"})
privateReg := fakeNPM(t, "demo", "1.0.0", map[string]string{"dist/x.js": "private-bytes"})
dir := t.TempDir()
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "1.0.0"
files: ["dist/x.js"]
registry_url: "`+privateReg.URL+`"
`)
res, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: defaultReg.URL})
if err != nil {
t.Fatalf("Sync: %v", err)
}
if len(res.Lock.Assets) != 1 {
t.Fatalf("lock assets = %d, want 1", len(res.Lock.Assets))
}
got, err := os.ReadFile(filepath.Join(dir, "v/demo/x.js"))
if err != nil {
t.Fatal(err)
}
if string(got) != "private-bytes" {
t.Errorf("file contents = %q, want private-bytes — the override registry was ignored", got)
}
if !strings.Contains(res.Lock.Assets[0].PURL, "repository_url=") {
t.Errorf("lockfile purl %q should carry the repository_url qualifier", res.Lock.Assets[0].PURL)
}
}
func TestSync_FSWriterMemory(t *testing.T) {
srv := fakeNPM(t, "demo", "1.0.0", map[string]string{"dist/x.js": "console.log('x')"})
dir := t.TempDir()
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "1.0.0"
files: ["dist/x.js"]
`)
mem := pinfs.NewMemory()
res, err := Sync(context.Background(), SyncOptions{
Dir: dir,
RegistryURL: srv.URL,
FS: mem,
})
if err != nil {
t.Fatalf("Sync: %v", err)
}
if len(res.Lock.Assets) != 1 {
t.Errorf("res.Lock.Assets = %d, want 1", len(res.Lock.Assets))
}
// The asset bytes and the lockfile JSON should have landed in
// the in-memory writer, NOT on local disk.
got, ok := mem.Get("v/demo/x.js")
if !ok {
t.Fatalf("expected v/demo/x.js in memory; have %v", mem.Files())
}
if string(got) != "console.log('x')" {
t.Errorf("memory contents = %q, want %q", got, "console.log('x')")
}
if _, ok := mem.Get("pin.lock"); !ok {
t.Errorf("expected pin.lock in memory; have %v", mem.Files())
}
if _, err := os.Stat(filepath.Join(dir, "v/demo/x.js")); !os.IsNotExist(err) {
t.Errorf("FSWriter override should keep disk untouched: %v", err)
}
if _, err := os.Stat(filepath.Join(dir, DefaultLock)); !os.IsNotExist(err) {
t.Errorf("FSWriter override should keep disk untouched: %v", err)
}
}
func TestSyncDryRun(t *testing.T) {
srv := fakeNPM(t, "demo", "1.0.0", map[string]string{"dist/x.js": "x"})
dir := t.TempDir()
writeManifest(t, dir, `out: "v"
assets:
- name: "demo"
version: "1.0.0"
files: ["dist/x.js"]
`)
res, err := Sync(context.Background(), SyncOptions{Dir: dir, RegistryURL: srv.URL, DryRun: true})
if err != nil {
t.Fatal(err)
}
if len(res.Lock.Assets) != 1 {
t.Error("dry-run should still produce a lock model")
}
if _, err := os.Stat(filepath.Join(dir, DefaultLock)); !os.IsNotExist(err) {
t.Error("dry-run should not write pin.lock")
}
if _, err := os.Stat(filepath.Join(dir, "v/demo/x.js")); !os.IsNotExist(err) {
t.Error("dry-run should not write asset files")
}
}