1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: Apache-2.0
15 "git.arvados.org/arvados.git/sdk/go/arvadostest"
16 "git.arvados.org/arvados.git/sdk/go/blockdigest"
20 func TestGocheck(t *testing.T) { TestingT(t) }
22 var _ = Suite(&suite{})
26 func getStackTrace() string {
27 buf := make([]byte, 1000)
28 bytesWritten := runtime.Stack(buf, false)
29 return "Stack Trace:\n" + string(buf[:bytesWritten])
32 func expectFromChannel(t *testing.T, c <-chan string, expected string) {
35 t.Fatalf("Expected to receive %s but channel was closed. %s",
39 if actual != expected {
40 t.Fatalf("Expected %s but got %s instead. %s",
47 func expectChannelClosed(t *testing.T, c <-chan interface{}) {
50 t.Fatalf("Expected channel to be closed, but received %v instead. %s",
56 func expectEqual(t *testing.T, actual interface{}, expected interface{}) {
57 if actual != expected {
58 t.Fatalf("Expected %v but received %v instead. %s",
65 func expectStringSlicesEqual(t *testing.T, actual []string, expected []string) {
66 if len(actual) != len(expected) {
67 t.Fatalf("Expected %v (length %d), but received %v (length %d) instead. %s", expected, len(expected), actual, len(actual), getStackTrace())
69 for i := range actual {
70 if actual[i] != expected[i] {
71 t.Fatalf("Expected %v but received %v instead (first disagreement at position %d). %s", expected, actual, i, getStackTrace())
76 func expectFileStreamSegmentsEqual(t *testing.T, actual []FileStreamSegment, expected []FileStreamSegment) {
77 if !reflect.DeepEqual(actual, expected) {
78 t.Fatalf("Expected %v but received %v instead. %s", expected, actual, getStackTrace())
82 func expectManifestStream(t *testing.T, actual ManifestStream, expected ManifestStream) {
83 expectEqual(t, actual.StreamName, expected.StreamName)
84 expectStringSlicesEqual(t, actual.Blocks, expected.Blocks)
85 expectFileStreamSegmentsEqual(t, actual.FileStreamSegments, expected.FileStreamSegments)
88 func expectBlockLocator(t *testing.T, actual blockdigest.BlockLocator, expected blockdigest.BlockLocator) {
89 expectEqual(t, actual.Digest, expected.Digest)
90 expectEqual(t, actual.Size, expected.Size)
91 expectStringSlicesEqual(t, actual.Hints, expected.Hints)
94 func TestParseManifestStreamSimple(t *testing.T) {
95 m := parseManifestStream(". 365f83f5f808896ec834c8b595288735+2310+K@qr1hi+Af0c9a66381f3b028677411926f0be1c6282fe67c@542b5ddf 0:2310:qr1hi-8i9sb-ienvmpve1a0vpoi.log.txt")
96 expectManifestStream(t, m, ManifestStream{StreamName: ".",
97 Blocks: []string{"365f83f5f808896ec834c8b595288735+2310+K@qr1hi+Af0c9a66381f3b028677411926f0be1c6282fe67c@542b5ddf"},
98 FileStreamSegments: []FileStreamSegment{{0, 2310, "qr1hi-8i9sb-ienvmpve1a0vpoi.log.txt"}}})
101 func TestParseBlockLocatorSimple(t *testing.T) {
102 b, err := ParseBlockLocator("365f83f5f808896ec834c8b595288735+2310+K@qr1hi+Af0c9a66381f3b028677411926f0be1c6282fe67c@542b5ddf")
104 t.Fatalf("Unexpected error parsing block locator: %v", err)
106 d, err := blockdigest.FromString("365f83f5f808896ec834c8b595288735")
108 t.Fatalf("Unexpected error during FromString for block locator: %v", err)
110 expectBlockLocator(t, blockdigest.BlockLocator{b.Digest, b.Size, b.Hints},
111 blockdigest.BlockLocator{Digest: d,
113 Hints: []string{"K@qr1hi",
114 "Af0c9a66381f3b028677411926f0be1c6282fe67c@542b5ddf"}})
117 func TestStreamIterShortManifestWithBlankStreams(t *testing.T) {
118 content, err := ioutil.ReadFile("testdata/short_manifest")
120 t.Fatalf("Unexpected error reading manifest from file: %v", err)
122 manifest := Manifest{Text: string(content)}
123 streamIter := manifest.StreamIter()
125 firstStream := <-streamIter
126 expectManifestStream(t,
128 ManifestStream{StreamName: ".",
129 Blocks: []string{"b746e3d2104645f2f64cd3cc69dd895d+15693477+E2866e643690156651c03d876e638e674dcd79475@5441920c"},
130 FileStreamSegments: []FileStreamSegment{{0, 15693477, "chr10_band0_s0_e3000000.fj"}}})
132 received, ok := <-streamIter
134 t.Fatalf("Expected streamIter to be closed, but received %v instead.",
139 func TestBlockIterLongManifest(t *testing.T) {
140 content, err := ioutil.ReadFile("testdata/long_manifest")
142 t.Fatalf("Unexpected error reading manifest from file: %v", err)
144 manifest := Manifest{Text: string(content)}
145 blockChannel := manifest.BlockIterWithDuplicates()
147 firstBlock := <-blockChannel
148 d, err := blockdigest.FromString("b746e3d2104645f2f64cd3cc69dd895d")
150 t.Fatalf("Unexpected error during FromString for block: %v", err)
152 expectBlockLocator(t,
154 blockdigest.BlockLocator{Digest: d,
156 Hints: []string{"E2866e643690156651c03d876e638e674dcd79475@5441920c"}})
158 var lastBlock blockdigest.BlockLocator
159 for lastBlock = range blockChannel {
162 expectEqual(t, blocksRead, 853)
164 d, err = blockdigest.FromString("f9ce82f59e5908d2d70e18df9679b469")
166 t.Fatalf("Unexpected error during FromString for block: %v", err)
168 expectBlockLocator(t,
170 blockdigest.BlockLocator{Digest: d,
172 Hints: []string{"E53f903684239bcc114f7bf8ff9bd6089f33058db@5441920c"}})
175 func TestUnescape(t *testing.T) {
176 for _, testCase := range [][]string{
183 expect := testCase[1]
184 got := UnescapeName(in)
186 t.Errorf("For '%s' got '%s' instead of '%s'", in, got, expect)
191 type fsegtest struct {
192 mt string // manifest text
194 want []FileSegment // segments should be received on channel
197 func TestFileSegmentIterByName(t *testing.T) {
198 mt := arvadostest.PathologicalManifest
199 for _, testCase := range []fsegtest{
200 {mt: mt, f: "zzzz", want: nil},
201 // This case is too sensitive: it would be acceptable
202 // (even preferable) to return only one empty segment.
203 {mt: mt, f: "foo/zero", want: []FileSegment{{"d41d8cd98f00b204e9800998ecf8427e+0", 0, 0}, {"d41d8cd98f00b204e9800998ecf8427e+0", 0, 0}}},
204 {mt: mt, f: "zero@0", want: []FileSegment{{"d41d8cd98f00b204e9800998ecf8427e+0", 0, 0}}},
205 {mt: mt, f: "zero@1", want: []FileSegment{{"d41d8cd98f00b204e9800998ecf8427e+0", 0, 0}}},
206 {mt: mt, f: "zero@4", want: []FileSegment{{"d41d8cd98f00b204e9800998ecf8427e+0", 0, 0}}},
207 {mt: mt, f: "zero@9", want: []FileSegment{{"d41d8cd98f00b204e9800998ecf8427e+0", 0, 0}}},
208 {mt: mt, f: "f", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 0, 1}}},
209 {mt: mt, f: "ooba", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 1, 2}, {"37b51d194a7513e45b56f6524f2d51f2+3", 0, 2}}},
210 {mt: mt, f: "overlapReverse/o", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 2, 1}}},
211 {mt: mt, f: "overlapReverse/oo", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 1, 2}}},
212 {mt: mt, f: "overlapReverse/ofoo", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 2, 1}, {"acbd18db4cc2f85cedef654fccc4a4d8+3", 0, 3}}},
213 {mt: mt, f: "foo bar/baz", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 0, 3}}},
214 // This case is too sensitive: it would be better to
215 // omit the empty segment.
216 {mt: mt, f: "segmented/frob", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 0, 1}, {"37b51d194a7513e45b56f6524f2d51f2+3", 2, 1}, {"acbd18db4cc2f85cedef654fccc4a4d8+3", 1, 1}, {"d41d8cd98f00b204e9800998ecf8427e+0", 0, 0}, {"37b51d194a7513e45b56f6524f2d51f2+3", 0, 1}}},
217 {mt: mt, f: "segmented/oof", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 1, 2}, {"acbd18db4cc2f85cedef654fccc4a4d8+3", 0, 1}}},
219 m := Manifest{Text: testCase.mt}
220 var got []FileSegment
221 for fs := range m.FileSegmentIterByName(testCase.f) {
222 got = append(got, *fs)
224 if !reflect.DeepEqual(got, testCase.want) {
225 t.Errorf("For %#v:\n got %#v\n want %#v", testCase.f, got, testCase.want)
230 func TestBlockIterWithBadManifest(t *testing.T) {
231 testCases := [][]string{
232 {"badstream acbd18db4cc2f85cedef654fccc4a4d8+3 0:1:file1.txt", "Invalid stream name: badstream"},
233 {"/badstream acbd18db4cc2f85cedef654fccc4a4d8+3 0:1:file1.txt", "Invalid stream name: /badstream"},
234 {". acbd18db4cc2f85cedef654fccc4a4d8+3 file1.txt", "Invalid file token: file1.txt"},
235 {". acbd18db4cc2f85cedef654fccc4a4+3 0:1:file1.txt", "No block locators found"},
236 {". acbd18db4cc2f85cedef654fccc4a4d8 0:1:file1.txt", "No block locators found"},
237 {". acbd18db4cc2f85cedef654fccc4a4d8+3 0:1:file1.txt file2.txt 1:2:file3.txt", "Invalid file token: file2.txt"},
238 {". acbd18db4cc2f85cedef654fccc4a4d8+3 0:1:file1.txt. bcde18db4cc2f85cedef654fccc4a4d8+3 1:2:file3.txt", "Invalid file token: bcde18db4cc2f85cedef654fccc4a4d8.*"},
239 {". acbd18db4cc2f85cedef654fccc4a4d8+3 0:1:file1.txt\n. acbd18db4cc2f85cedef654fccc4a4d8+3 ::file2.txt\n", "Invalid file token: ::file2.txt"},
240 {". acbd18db4cc2f85cedef654fccc4a4d8+3 bcde18db4cc2f85cedef654fccc4a4d8+3\n", "No file tokens found"},
241 {". acbd18db4cc2f85cedef654fccc4a4d8+3 ", "Invalid file token"},
242 {". acbd18db4cc2f85cedef654fccc4a4d8+3", "No file tokens found"},
243 {". 0:1:file1.txt\n", "No block locators found"},
244 {".\n", "No block locators found"},
247 for _, testCase := range testCases {
248 manifest := Manifest{Text: string(testCase[0])}
249 blockChannel := manifest.BlockIterWithDuplicates()
251 for block := range blockChannel {
255 // completed reading from blockChannel; now check for errors
256 if manifest.Err == nil {
257 t.Fatalf("Expected error")
260 matched, _ := regexp.MatchString(testCase[1], manifest.Err.Error())
262 t.Fatalf("Expected error not found. Expected: %v; Found: %v", testCase[1], manifest.Err.Error())
267 func TestNormalizeManifest(t *testing.T) {
268 m1 := Manifest{Text: `. 5348b82a029fd9e971a811ce1f71360b+43 0:43:md5sum.txt
269 . 085c37f02916da1cad16f93c54d899b7+41 0:41:md5sum.txt
270 . 8b22da26f9f433dea0a10e5ec66d73ba+43 0:43:md5sum.txt
272 expectEqual(t, m1.Extract(".", ".").Text,
273 `. 5348b82a029fd9e971a811ce1f71360b+43 085c37f02916da1cad16f93c54d899b7+41 8b22da26f9f433dea0a10e5ec66d73ba+43 0:127:md5sum.txt
276 m2 := Manifest{Text: `. 204e43b8a1185621ca55a94839582e6f+67108864 b9677abbac956bd3e86b1deb28dfac03+67108864 fc15aff2a762b13f521baf042140acec+67108864 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:227212247:var-GS000016015-ASM.tsv.bz2
278 expectEqual(t, m2.Extract(".", ".").Text, m2.Text)
280 m3 := Manifest{Text: `. 5348b82a029fd9e971a811ce1f71360b+43 3:40:md5sum.txt
281 . 085c37f02916da1cad16f93c54d899b7+41 0:41:md5sum.txt
282 . 8b22da26f9f433dea0a10e5ec66d73ba+43 0:43:md5sum.txt
284 expectEqual(t, m3.Extract(".", ".").Text, `. 5348b82a029fd9e971a811ce1f71360b+43 085c37f02916da1cad16f93c54d899b7+41 8b22da26f9f433dea0a10e5ec66d73ba+43 3:124:md5sum.txt
286 expectEqual(t, m3.Extract("/md5sum.txt", "/wiggle.txt").Text, `. 5348b82a029fd9e971a811ce1f71360b+43 085c37f02916da1cad16f93c54d899b7+41 8b22da26f9f433dea0a10e5ec66d73ba+43 3:124:wiggle.txt
289 m4 := Manifest{Text: `. 204e43b8a1185621ca55a94839582e6f+67108864 0:3:foo/bar
290 ./zzz 204e43b8a1185621ca55a94839582e6f+67108864 0:999:zzz
291 ./foo 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:bar
294 expectEqual(t, m4.Extract(".", ".").Text,
295 `./foo 204e43b8a1185621ca55a94839582e6f+67108864 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:bar 67108864:3:bar
296 ./zzz 204e43b8a1185621ca55a94839582e6f+67108864 0:999:zzz
299 expectEqual(t, m4.Extract("./foo", ".").Text, ". 204e43b8a1185621ca55a94839582e6f+67108864 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:bar 67108864:3:bar\n")
300 expectEqual(t, m4.Extract("./foo", "./baz").Text, "./baz 204e43b8a1185621ca55a94839582e6f+67108864 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:bar 67108864:3:bar\n")
301 expectEqual(t, m4.Extract("./foo/bar", ".").Text, ". 204e43b8a1185621ca55a94839582e6f+67108864 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:bar 67108864:3:bar\n")
302 expectEqual(t, m4.Extract("./foo/bar", "./baz").Text, ". 204e43b8a1185621ca55a94839582e6f+67108864 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:baz 67108864:3:baz\n")
303 expectEqual(t, m4.Extract("./foo/bar", "./quux/").Text, "./quux 204e43b8a1185621ca55a94839582e6f+67108864 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:bar 67108864:3:bar\n")
304 expectEqual(t, m4.Extract("./foo/bar", "./quux/baz").Text, "./quux 204e43b8a1185621ca55a94839582e6f+67108864 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:baz 67108864:3:baz\n")
305 expectEqual(t, m4.Extract(".", ".").Text, `./foo 204e43b8a1185621ca55a94839582e6f+67108864 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:bar 67108864:3:bar
306 ./zzz 204e43b8a1185621ca55a94839582e6f+67108864 0:999:zzz
308 expectEqual(t, m4.Extract(".", "./zip").Text, `./zip/foo 204e43b8a1185621ca55a94839582e6f+67108864 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:bar 67108864:3:bar
309 ./zip/zzz 204e43b8a1185621ca55a94839582e6f+67108864 0:999:zzz
312 expectEqual(t, m4.Extract("foo/.//bar/../../zzz/", "/waz/").Text, `./waz 204e43b8a1185621ca55a94839582e6f+67108864 0:999:zzz
315 m5 := Manifest{Text: `. 204e43b8a1185621ca55a94839582e6f+67108864 0:3:foo/bar
316 ./zzz 204e43b8a1185621ca55a94839582e6f+67108864 0:999:zzz
317 ./foo 204e43b8a1185621ca55a94839582e6f+67108864 3:3:bar
319 expectEqual(t, m5.Extract(".", ".").Text,
320 `./foo 204e43b8a1185621ca55a94839582e6f+67108864 0:6:bar
321 ./zzz 204e43b8a1185621ca55a94839582e6f+67108864 0:999:zzz
324 m8 := Manifest{Text: `./a\040b\040c 59ca0efa9f5633cb0371bbc0355478d8+13 0:13:hello\040world.txt
326 expectEqual(t, m8.Extract(".", ".").Text, m8.Text)
328 m9 := Manifest{Text: ". acbd18db4cc2f85cedef654fccc4a4d8+40 0:10:one 20:10:two 10:10:one 30:10:two\n"}
329 expectEqual(t, m9.Extract("", "").Text, ". acbd18db4cc2f85cedef654fccc4a4d8+40 0:20:one 20:20:two\n")
331 m10 := Manifest{Text: ". acbd18db4cc2f85cedef654fccc4a4d8+40 0:10:one 20:10:two 10:10:one 30:10:two\n"}
332 expectEqual(t, m10.Extract("./two", "./three").Text, ". acbd18db4cc2f85cedef654fccc4a4d8+40 20:20:three\n")
334 m11 := Manifest{Text: arvadostest.PathologicalManifest}
335 expectEqual(t, m11.Extract(".", ".").Text, `. acbd18db4cc2f85cedef654fccc4a4d8+3 37b51d194a7513e45b56f6524f2d51f2+3 73feffa4b7f6bb68e44cf984c85f6e88+3+Z+K@xyzzy 0:1:f 1:4:ooba 5:1:r 5:4:rbaz 0:0:zero@0 0:0:zero@1 0:0:zero@4 0:0:zero@9
336 ./foo acbd18db4cc2f85cedef654fccc4a4d8+3 0:3:foo 0:3:foo 0:0:zero
337 ./foo\040bar acbd18db4cc2f85cedef654fccc4a4d8+3 0:3:baz 0:3:baz\040waz
338 ./overlapReverse acbd18db4cc2f85cedef654fccc4a4d8+3 2:1:o 2:1:ofoo 0:3:ofoo 1:2:oo
339 ./segmented acbd18db4cc2f85cedef654fccc4a4d8+3 37b51d194a7513e45b56f6524f2d51f2+3 0:1:frob 5:1:frob 1:1:frob 3:1:frob 1:2:oof 0:1:oof
342 m12 := Manifest{Text: `./foo 204e43b8a1185621ca55a94839582e6f+67108864 0:3:bar
343 ./zzz 204e43b8a1185621ca55a94839582e6f+67108864 0:999:zzz
344 ./foo/baz 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:bar
347 expectEqual(t, m12.Extract("./foo", ".").Text, `. 204e43b8a1185621ca55a94839582e6f+67108864 0:3:bar
348 ./baz 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:bar
350 expectEqual(t, m12.Extract("./foo", "./blub").Text, `./blub 204e43b8a1185621ca55a94839582e6f+67108864 0:3:bar
351 ./blub/baz 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:bar
353 expectEqual(t, m12.Extract("./foo", "./blub/").Text, `./blub 204e43b8a1185621ca55a94839582e6f+67108864 0:3:bar
354 ./blub/baz 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:bar
356 expectEqual(t, m12.Extract("./foo/", "./blub/").Text, `./blub 204e43b8a1185621ca55a94839582e6f+67108864 0:3:bar
357 ./blub/baz 323d2a3ce20370c4ca1d3462a344f8fd+25885655 0:3:bar
360 m13 := Manifest{Text: `foo 204e43b8a1185621ca55a94839582e6f+67108864 0:3:bar
363 expectEqual(t, m13.Extract(".", ".").Text, ``)
364 expectEqual(t, m13.Extract(".", ".").Err.Error(), "Invalid stream name: foo")
366 m14 := Manifest{Text: `./foo 204e43b8a1185621ca55a94839582e6f+67108864 67108863:3:bar
369 expectEqual(t, m14.Extract(".", ".").Text, ``)
370 expectEqual(t, m14.Extract(".", ".").Err.Error(), "File segment 67108863:3:bar extends past end of stream 67108864")
372 m15 := Manifest{Text: `./foo 204e43b8a1185621ca55a94839582e6f+67108864 0:3bar
375 expectEqual(t, m15.Extract(".", ".").Text, ``)
376 expectEqual(t, m15.Extract(".", ".").Err.Error(), "Invalid file token: 0:3bar")
379 func (s *suite) TestExtractFromLargeManifest(c *C) {
380 m := Manifest{Text: arvadostest.FakeManifest(200, 200, 2, 4<<20)}
381 fmt.Println(m.Extract("./dir77/file88", "./extracted").Text)
384 func TestFirstBlock(t *testing.T) {
386 expectEqual(t, firstBlock([]uint64{1, 2, 3, 4}, 3), 2)
387 expectEqual(t, firstBlock([]uint64{1, 2, 3, 4, 5, 6}, 4), 3)