sdk/go/manifest/manifest_test.go

   1 package manifest
   2
   3 import (
   4         "io/ioutil"
   5         "reflect"
   6         "regexp"
   7         "runtime"
   8         "testing"
   9
  10         "git.curoverse.com/arvados.git/sdk/go/arvadostest"
  11         "git.curoverse.com/arvados.git/sdk/go/blockdigest"
  12 )
  13
  14 func getStackTrace() string {
  15         buf := make([]byte, 1000)
  16         bytesWritten := runtime.Stack(buf, false)
  17         return "Stack Trace:\n" + string(buf[:bytesWritten])
  18 }
  19
  20 func expectFromChannel(t *testing.T, c <-chan string, expected string) {
  21         actual, ok := <-c
  22         if !ok {
  23                 t.Fatalf("Expected to receive %s but channel was closed. %s",
  24                         expected,
  25                         getStackTrace())
  26         }
  27         if actual != expected {
  28                 t.Fatalf("Expected %s but got %s instead. %s",
  29                         expected,
  30                         actual,
  31                         getStackTrace())
  32         }
  33 }
  34
  35 func expectChannelClosed(t *testing.T, c <-chan interface{}) {
  36         received, ok := <-c
  37         if ok {
  38                 t.Fatalf("Expected channel to be closed, but received %v instead. %s",
  39                         received,
  40                         getStackTrace())
  41         }
  42 }
  43
  44 func expectEqual(t *testing.T, actual interface{}, expected interface{}) {
  45         if actual != expected {
  46                 t.Fatalf("Expected %v but received %v instead. %s",
  47                         expected,
  48                         actual,
  49                         getStackTrace())
  50         }
  51 }
  52
  53 func expectStringSlicesEqual(t *testing.T, actual []string, expected []string) {
  54         if len(actual) != len(expected) {
  55                 t.Fatalf("Expected %v (length %d), but received %v (length %d) instead. %s", expected, len(expected), actual, len(actual), getStackTrace())
  56         }
  57         for i := range actual {
  58                 if actual[i] != expected[i] {
  59                         t.Fatalf("Expected %v but received %v instead (first disagreement at position %d). %s", expected, actual, i, getStackTrace())
  60                 }
  61         }
  62 }
  63
  64 func expectManifestStream(t *testing.T, actual ManifestStream, expected ManifestStream) {
  65         expectEqual(t, actual.StreamName, expected.StreamName)
  66         expectStringSlicesEqual(t, actual.Blocks, expected.Blocks)
  67         expectStringSlicesEqual(t, actual.FileTokens, expected.FileTokens)
  68 }
  69
  70 func expectBlockLocator(t *testing.T, actual blockdigest.BlockLocator, expected blockdigest.BlockLocator) {
  71         expectEqual(t, actual.Digest, expected.Digest)
  72         expectEqual(t, actual.Size, expected.Size)
  73         expectStringSlicesEqual(t, actual.Hints, expected.Hints)
  74 }
  75
  76 func TestParseManifestStreamSimple(t *testing.T) {
  77         m := parseManifestStream(". 365f83f5f808896ec834c8b595288735+2310+K@qr1hi+Af0c9a66381f3b028677411926f0be1c6282fe67c@542b5ddf 0:2310:qr1hi-8i9sb-ienvmpve1a0vpoi.log.txt")
  78         expectManifestStream(t, m, ManifestStream{StreamName: ".",
  79                 Blocks:     []string{"365f83f5f808896ec834c8b595288735+2310+K@qr1hi+Af0c9a66381f3b028677411926f0be1c6282fe67c@542b5ddf"},
  80                 FileTokens: []string{"0:2310:qr1hi-8i9sb-ienvmpve1a0vpoi.log.txt"}})
  81 }
  82
  83 func TestParseBlockLocatorSimple(t *testing.T) {
  84         b, err := ParseBlockLocator("365f83f5f808896ec834c8b595288735+2310+K@qr1hi+Af0c9a66381f3b028677411926f0be1c6282fe67c@542b5ddf")
  85         if err != nil {
  86                 t.Fatalf("Unexpected error parsing block locator: %v", err)
  87         }
  88         d, err := blockdigest.FromString("365f83f5f808896ec834c8b595288735")
  89         if err != nil {
  90                 t.Fatalf("Unexpected error during FromString for block locator: %v", err)
  91         }
  92         expectBlockLocator(t, blockdigest.BlockLocator{b.Digest, b.Size, b.Hints},
  93                 blockdigest.BlockLocator{Digest: d,
  94                         Size: 2310,
  95                         Hints: []string{"K@qr1hi",
  96                                 "Af0c9a66381f3b028677411926f0be1c6282fe67c@542b5ddf"}})
  97 }
  98
  99 func TestStreamIterShortManifestWithBlankStreams(t *testing.T) {
 100         content, err := ioutil.ReadFile("testdata/short_manifest")
 101         if err != nil {
 102                 t.Fatalf("Unexpected error reading manifest from file: %v", err)
 103         }
 104         manifest := Manifest{Text: string(content)}
 105         streamIter := manifest.StreamIter()
 106
 107         firstStream := <-streamIter
 108         expectManifestStream(t,
 109                 firstStream,
 110                 ManifestStream{StreamName: ".",
 111                         Blocks:     []string{"b746e3d2104645f2f64cd3cc69dd895d+15693477+E2866e643690156651c03d876e638e674dcd79475@5441920c"},
 112                         FileTokens: []string{"0:15893477:chr10_band0_s0_e3000000.fj"}})
 113
 114         received, ok := <-streamIter
 115         if ok {
 116                 t.Fatalf("Expected streamIter to be closed, but received %v instead.",
 117                         received)
 118         }
 119 }
 120
 121 func TestBlockIterLongManifest(t *testing.T) {
 122         content, err := ioutil.ReadFile("testdata/long_manifest")
 123         if err != nil {
 124                 t.Fatalf("Unexpected error reading manifest from file: %v", err)
 125         }
 126         manifest := Manifest{Text: string(content)}
 127         blockChannel := manifest.BlockIterWithDuplicates()
 128
 129         firstBlock := <-blockChannel
 130         d, err := blockdigest.FromString("b746e3d2104645f2f64cd3cc69dd895d")
 131         if err != nil {
 132                 t.Fatalf("Unexpected error during FromString for block: %v", err)
 133         }
 134         expectBlockLocator(t,
 135                 firstBlock,
 136                 blockdigest.BlockLocator{Digest: d,
 137                         Size:  15693477,
 138                         Hints: []string{"E2866e643690156651c03d876e638e674dcd79475@5441920c"}})
 139         blocksRead := 1
 140         var lastBlock blockdigest.BlockLocator
 141         for lastBlock = range blockChannel {
 142                 blocksRead++
 143         }
 144         expectEqual(t, blocksRead, 853)
 145
 146         d, err = blockdigest.FromString("f9ce82f59e5908d2d70e18df9679b469")
 147         if err != nil {
 148                 t.Fatalf("Unexpected error during FromString for block: %v", err)
 149         }
 150         expectBlockLocator(t,
 151                 lastBlock,
 152                 blockdigest.BlockLocator{Digest: d,
 153                         Size:  31367794,
 154                         Hints: []string{"E53f903684239bcc114f7bf8ff9bd6089f33058db@5441920c"}})
 155 }
 156
 157 func TestUnescape(t *testing.T) {
 158         for _, testCase := range [][]string{
 159                 {`\040`, ` `},
 160                 {`\009`, `\009`},
 161                 {`\\\040\\`, `\ \`},
 162                 {`\\040\`, `\040\`},
 163         } {
 164                 in := testCase[0]
 165                 expect := testCase[1]
 166                 got := UnescapeName(in)
 167                 if expect != got {
 168                         t.Errorf("For '%s' got '%s' instead of '%s'", in, got, expect)
 169                 }
 170         }
 171 }
 172
 173 type fsegtest struct {
 174         mt   string        // manifest text
 175         f    string        // filename
 176         want []FileSegment // segments should be received on channel
 177 }
 178
 179 func TestFileSegmentIterByName(t *testing.T) {
 180         mt := arvadostest.PathologicalManifest
 181         for _, testCase := range []fsegtest{
 182                 {mt: mt, f: "zzzz", want: nil},
 183                 // This case is too sensitive: it would be acceptable
 184                 // (even preferable) to return only one empty segment.
 185                 {mt: mt, f: "foo/zero", want: []FileSegment{{"d41d8cd98f00b204e9800998ecf8427e+0", 0, 0}, {"d41d8cd98f00b204e9800998ecf8427e+0", 0, 0}}},
 186                 {mt: mt, f: "zero@0", want: []FileSegment{{"d41d8cd98f00b204e9800998ecf8427e+0", 0, 0}}},
 187                 {mt: mt, f: "zero@1", want: []FileSegment{{"d41d8cd98f00b204e9800998ecf8427e+0", 0, 0}}},
 188                 {mt: mt, f: "zero@4", want: []FileSegment{{"d41d8cd98f00b204e9800998ecf8427e+0", 0, 0}}},
 189                 {mt: mt, f: "zero@9", want: []FileSegment{{"d41d8cd98f00b204e9800998ecf8427e+0", 0, 0}}},
 190                 {mt: mt, f: "f", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 0, 1}}},
 191                 {mt: mt, f: "ooba", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 1, 2}, {"37b51d194a7513e45b56f6524f2d51f2+3", 0, 2}}},
 192                 {mt: mt, f: "overlapReverse/o", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 2, 1}}},
 193                 {mt: mt, f: "overlapReverse/oo", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 1, 2}}},
 194                 {mt: mt, f: "overlapReverse/ofoo", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 2, 1}, {"acbd18db4cc2f85cedef654fccc4a4d8+3", 0, 3}}},
 195                 {mt: mt, f: "foo bar/baz", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 0, 3}}},
 196                 // This case is too sensitive: it would be better to
 197                 // omit the empty segment.
 198                 {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}}},
 199                 {mt: mt, f: "segmented/oof", want: []FileSegment{{"acbd18db4cc2f85cedef654fccc4a4d8+3", 1, 2}, {"acbd18db4cc2f85cedef654fccc4a4d8+3", 0, 1}}},
 200         } {
 201                 m := Manifest{Text: testCase.mt}
 202                 var got []FileSegment
 203                 for fs := range m.FileSegmentIterByName(testCase.f) {
 204                         got = append(got, *fs)
 205                 }
 206                 if !reflect.DeepEqual(got, testCase.want) {
 207                         t.Errorf("For %#v:\n got  %#v\n want %#v", testCase.f, got, testCase.want)
 208                 }
 209         }
 210 }
 211
 212 func TestBlockIterWithBadManifest(t *testing.T) {
 213         testCases := [][]string{
 214                 {"badstream acbd18db4cc2f85cedef654fccc4a4d8+3 0:1:file1.txt", "Invalid stream name: badstream"},
 215                 {"/badstream acbd18db4cc2f85cedef654fccc4a4d8+3 0:1:file1.txt", "Invalid stream name: /badstream"},
 216                 {". acbd18db4cc2f85cedef654fccc4a4d8+3 file1.txt", "Invalid file token: file1.txt"},
 217                 {". acbd18db4cc2f85cedef654fccc4a4+3 0:1:file1.txt", "No block locators found"},
 218                 {". acbd18db4cc2f85cedef654fccc4a4d8 0:1:file1.txt", "No block locators found"},
 219                 {". acbd18db4cc2f85cedef654fccc4a4d8+3 0:1:file1.txt file2.txt 1:2:file3.txt", "Invalid file token: file2.txt"},
 220                 {". acbd18db4cc2f85cedef654fccc4a4d8+3 0:1:file1.txt. bcde18db4cc2f85cedef654fccc4a4d8+3 1:2:file3.txt", "Invalid file token: bcde18db4cc2f85cedef654fccc4a4d8.*"},
 221                 {". acbd18db4cc2f85cedef654fccc4a4d8+3 0:1:file1.txt\n. acbd18db4cc2f85cedef654fccc4a4d8+3 ::file2.txt\n", "Invalid file token: ::file2.txt"},
 222                 {". acbd18db4cc2f85cedef654fccc4a4d8+3 bcde18db4cc2f85cedef654fccc4a4d8+3\n", "No file tokens found"},
 223                 {". acbd18db4cc2f85cedef654fccc4a4d8+3 ", "Invalid file token"},
 224                 {". acbd18db4cc2f85cedef654fccc4a4d8+3", "No file tokens found"},
 225                 {". 0:1:file1.txt\n", "No block locators found"},
 226                 {".\n", "No block locators found"},
 227         }
 228
 229         for _, testCase := range testCases {
 230                 manifest := Manifest{Text: string(testCase[0])}
 231                 blockChannel := manifest.BlockIterWithDuplicates()
 232
 233                 for block := range blockChannel {
 234                         _ = block
 235                 }
 236
 237                 // completed reading from blockChannel; now check for errors
 238                 if manifest.Err == nil {
 239                         t.Fatalf("Expected error")
 240                 }
 241
 242                 matched, _ := regexp.MatchString(testCase[1], manifest.Err.Error())
 243                 if !matched {
 244                         t.Fatalf("Expected error not found. Expected: %v; Found: %v", testCase[1], manifest.Err.Error())
 245                 }
 246         }
 247 }