Merge branch '15583-no-count'
[arvados.git] / services / keepstore / keepstore_test.go
index e01b01363d4e2de2f77b854ea5789fb996276234..d1d380466ba5983d4a7752c95ff47cf3e9312a75 100644 (file)
@@ -1,7 +1,13 @@
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: AGPL-3.0
+
 package main
 
 import (
        "bytes"
+       "context"
+       "errors"
        "fmt"
        "io/ioutil"
        "os"
@@ -10,21 +16,27 @@ import (
        "sort"
        "strings"
        "testing"
+
+       "git.curoverse.com/arvados.git/sdk/go/arvadostest"
 )
 
-var TEST_BLOCK = []byte("The quick brown fox jumps over the lazy dog.")
-var TEST_HASH = "e4d909c290d0fb1ca068ffaddf22cbd0"
-var TEST_HASH_PUT_RESPONSE = "e4d909c290d0fb1ca068ffaddf22cbd0+44\n"
+var TestBlock = []byte("The quick brown fox jumps over the lazy dog.")
+var TestHash = "e4d909c290d0fb1ca068ffaddf22cbd0"
+var TestHashPutResp = "e4d909c290d0fb1ca068ffaddf22cbd0+44\n"
 
-var TEST_BLOCK_2 = []byte("Pack my box with five dozen liquor jugs.")
-var TEST_HASH_2 = "f15ac516f788aec4f30932ffb6395c39"
+var TestBlock2 = []byte("Pack my box with five dozen liquor jugs.")
+var TestHash2 = "f15ac516f788aec4f30932ffb6395c39"
 
-var TEST_BLOCK_3 = []byte("Now is the time for all good men to come to the aid of their country.")
-var TEST_HASH_3 = "eed29bbffbc2dbe5e5ee0bb71888e61f"
+var TestBlock3 = []byte("Now is the time for all good men to come to the aid of their country.")
+var TestHash3 = "eed29bbffbc2dbe5e5ee0bb71888e61f"
 
-// BAD_BLOCK is used to test collisions and corruption.
+// BadBlock is used to test collisions and corruption.
 // It must not match any test hashes.
-var BAD_BLOCK = []byte("The magic words are squeamish ossifrage.")
+var BadBlock = []byte("The magic words are squeamish ossifrage.")
+
+// Empty block
+var EmptyHash = "d41d8cd98f00b204e9800998ecf8427e"
+var EmptyBlock = []byte("")
 
 // TODO(twp): Tests still to be written
 //
@@ -55,17 +67,18 @@ func TestGetBlock(t *testing.T) {
        defer KeepVM.Close()
 
        vols := KeepVM.AllReadable()
-       if err := vols[1].Put(TEST_HASH, TEST_BLOCK); err != nil {
+       if err := vols[1].Put(context.Background(), TestHash, TestBlock); err != nil {
                t.Error(err)
        }
 
        // Check that GetBlock returns success.
-       result, err := GetBlock(TEST_HASH, false)
+       buf := make([]byte, BlockSize)
+       size, err := GetBlock(context.Background(), TestHash, buf, nil)
        if err != nil {
                t.Errorf("GetBlock error: %s", err)
        }
-       if fmt.Sprint(result) != fmt.Sprint(TEST_BLOCK) {
-               t.Errorf("expected %s, got %s", TEST_BLOCK, result)
+       if bytes.Compare(buf[:size], TestBlock) != 0 {
+               t.Errorf("got %v, expected %v", buf[:size], TestBlock)
        }
 }
 
@@ -80,9 +93,10 @@ func TestGetBlockMissing(t *testing.T) {
        defer KeepVM.Close()
 
        // Check that GetBlock returns failure.
-       result, err := GetBlock(TEST_HASH, false)
+       buf := make([]byte, BlockSize)
+       size, err := GetBlock(context.Background(), TestHash, buf, nil)
        if err != NotFoundError {
-               t.Errorf("Expected NotFoundError, got %v", result)
+               t.Errorf("Expected NotFoundError, got %v, err %v", buf[:size], err)
        }
 }
 
@@ -98,12 +112,13 @@ func TestGetBlockCorrupt(t *testing.T) {
        defer KeepVM.Close()
 
        vols := KeepVM.AllReadable()
-       vols[0].Put(TEST_HASH, BAD_BLOCK)
+       vols[0].Put(context.Background(), TestHash, BadBlock)
 
        // Check that GetBlock returns failure.
-       result, err := GetBlock(TEST_HASH, false)
+       buf := make([]byte, BlockSize)
+       size, err := GetBlock(context.Background(), TestHash, buf, nil)
        if err != DiskHashError {
-               t.Errorf("Expected DiskHashError, got %v (buf: %v)", err, result)
+               t.Errorf("Expected DiskHashError, got %v (buf: %v)", err, buf[:size])
        }
 }
 
@@ -122,18 +137,19 @@ func TestPutBlockOK(t *testing.T) {
        defer KeepVM.Close()
 
        // Check that PutBlock stores the data as expected.
-       if err := PutBlock(TEST_BLOCK, TEST_HASH); err != nil {
-               t.Fatalf("PutBlock: %v", err)
+       if n, err := PutBlock(context.Background(), TestBlock, TestHash); err != nil || n < 1 {
+               t.Fatalf("PutBlock: n %d err %v", n, err)
        }
 
        vols := KeepVM.AllReadable()
-       result, err := vols[1].Get(TEST_HASH)
+       buf := make([]byte, BlockSize)
+       n, err := vols[1].Get(context.Background(), TestHash, buf)
        if err != nil {
                t.Fatalf("Volume #0 Get returned error: %v", err)
        }
-       if string(result) != string(TEST_BLOCK) {
+       if string(buf[:n]) != string(TestBlock) {
                t.Fatalf("PutBlock stored '%s', Get retrieved '%s'",
-                       string(TEST_BLOCK), string(result))
+                       string(TestBlock), string(buf[:n]))
        }
 }
 
@@ -150,20 +166,21 @@ func TestPutBlockOneVol(t *testing.T) {
 
        vols := KeepVM.AllWritable()
        vols[0].(*MockVolume).Bad = true
+       vols[0].(*MockVolume).BadVolumeError = errors.New("Bad volume")
 
        // Check that PutBlock stores the data as expected.
-       if err := PutBlock(TEST_BLOCK, TEST_HASH); err != nil {
-               t.Fatalf("PutBlock: %v", err)
+       if n, err := PutBlock(context.Background(), TestBlock, TestHash); err != nil || n < 1 {
+               t.Fatalf("PutBlock: n %d err %v", n, err)
        }
 
-       result, err := GetBlock(TEST_HASH, false)
+       buf := make([]byte, BlockSize)
+       size, err := GetBlock(context.Background(), TestHash, buf, nil)
        if err != nil {
                t.Fatalf("GetBlock: %v", err)
        }
-       if string(result) != string(TEST_BLOCK) {
-               t.Error("PutBlock/GetBlock mismatch")
-               t.Fatalf("PutBlock stored '%s', GetBlock retrieved '%s'",
-                       string(TEST_BLOCK), string(result))
+       if bytes.Compare(buf[:size], TestBlock) != 0 {
+               t.Fatalf("PutBlock stored %+q, GetBlock retrieved %+q",
+                       TestBlock, buf[:size])
        }
 }
 
@@ -180,12 +197,12 @@ func TestPutBlockMD5Fail(t *testing.T) {
 
        // Check that PutBlock returns the expected error when the hash does
        // not match the block.
-       if err := PutBlock(BAD_BLOCK, TEST_HASH); err != RequestHashError {
-               t.Error("Expected RequestHashError, got %v", err)
+       if _, err := PutBlock(context.Background(), BadBlock, TestHash); err != RequestHashError {
+               t.Errorf("Expected RequestHashError, got %v", err)
        }
 
        // Confirm that GetBlock fails to return anything.
-       if result, err := GetBlock(TEST_HASH, false); err != NotFoundError {
+       if result, err := GetBlock(context.Background(), TestHash, make([]byte, BlockSize), nil); err != NotFoundError {
                t.Errorf("GetBlock succeeded after a corrupt block store (result = %s, err = %v)",
                        string(result), err)
        }
@@ -202,18 +219,19 @@ func TestPutBlockCorrupt(t *testing.T) {
        KeepVM = MakeTestVolumeManager(2)
        defer KeepVM.Close()
 
-       // Store a corrupted block under TEST_HASH.
+       // Store a corrupted block under TestHash.
        vols := KeepVM.AllWritable()
-       vols[0].Put(TEST_HASH, BAD_BLOCK)
-       if err := PutBlock(TEST_BLOCK, TEST_HASH); err != nil {
-               t.Errorf("PutBlock: %v", err)
+       vols[0].Put(context.Background(), TestHash, BadBlock)
+       if n, err := PutBlock(context.Background(), TestBlock, TestHash); err != nil || n < 1 {
+               t.Errorf("PutBlock: n %d err %v", n, err)
        }
 
-       // The block on disk should now match TEST_BLOCK.
-       if block, err := GetBlock(TEST_HASH, false); err != nil {
+       // The block on disk should now match TestBlock.
+       buf := make([]byte, BlockSize)
+       if size, err := GetBlock(context.Background(), TestHash, buf, nil); err != nil {
                t.Errorf("GetBlock: %v", err)
-       } else if bytes.Compare(block, TEST_BLOCK) != 0 {
-               t.Errorf("GetBlock returned: '%s'", string(block))
+       } else if bytes.Compare(buf[:size], TestBlock) != 0 {
+               t.Errorf("Got %+q, expected %+q", buf[:size], TestBlock)
        }
 }
 
@@ -225,9 +243,9 @@ func TestPutBlockCollision(t *testing.T) {
        defer teardown()
 
        // These blocks both hash to the MD5 digest cee9a457e790cf20d4bdaa6d69f01e41.
-       var b1 = []byte("\x0e0eaU\x9a\xa7\x87\xd0\x0b\xc6\xf7\x0b\xbd\xfe4\x04\xcf\x03e\x9epO\x854\xc0\x0f\xfbe\x9cL\x87@\xcc\x94/\xeb-\xa1\x15\xa3\xf4\x15\\\xbb\x86\x07Is\x86em}\x1f4\xa4 Y\xd7\x8fZ\x8d\xd1\xef")
-       var b2 = []byte("\x0e0eaU\x9a\xa7\x87\xd0\x0b\xc6\xf7\x0b\xbd\xfe4\x04\xcf\x03e\x9etO\x854\xc0\x0f\xfbe\x9cL\x87@\xcc\x94/\xeb-\xa1\x15\xa3\xf4\x15\xdc\xbb\x86\x07Is\x86em}\x1f4\xa4 Y\xd7\x8fZ\x8d\xd1\xef")
-       var locator = "cee9a457e790cf20d4bdaa6d69f01e41"
+       b1 := arvadostest.MD5CollisionData[0]
+       b2 := arvadostest.MD5CollisionData[1]
+       locator := arvadostest.MD5CollisionMD5
 
        // Prepare two test Keep volumes.
        KeepVM = MakeTestVolumeManager(2)
@@ -235,10 +253,10 @@ func TestPutBlockCollision(t *testing.T) {
 
        // Store one block, then attempt to store the other. Confirm that
        // PutBlock reported a CollisionError.
-       if err := PutBlock(b1, locator); err != nil {
+       if _, err := PutBlock(context.Background(), b1, locator); err != nil {
                t.Error(err)
        }
-       if err := PutBlock(b2, locator); err == nil {
+       if _, err := PutBlock(context.Background(), b2, locator); err == nil {
                t.Error("PutBlock did not report a collision")
        } else if err != CollisionError {
                t.Errorf("PutBlock returned %v", err)
@@ -260,36 +278,37 @@ func TestPutBlockTouchFails(t *testing.T) {
        // Store a block and then make the underlying volume bad,
        // so a subsequent attempt to update the file timestamp
        // will fail.
-       vols[0].Put(TEST_HASH, BAD_BLOCK)
-       old_mtime, err := vols[0].Mtime(TEST_HASH)
+       vols[0].Put(context.Background(), TestHash, BadBlock)
+       oldMtime, err := vols[0].Mtime(TestHash)
        if err != nil {
-               t.Fatalf("vols[0].Mtime(%s): %s\n", TEST_HASH, err)
+               t.Fatalf("vols[0].Mtime(%s): %s\n", TestHash, err)
        }
 
        // vols[0].Touch will fail on the next call, so the volume
        // manager will store a copy on vols[1] instead.
        vols[0].(*MockVolume).Touchable = false
-       if err := PutBlock(TEST_BLOCK, TEST_HASH); err != nil {
-               t.Fatalf("PutBlock: %v", err)
+       if n, err := PutBlock(context.Background(), TestBlock, TestHash); err != nil || n < 1 {
+               t.Fatalf("PutBlock: n %d err %v", n, err)
        }
        vols[0].(*MockVolume).Touchable = true
 
        // Now the mtime on the block on vols[0] should be unchanged, and
        // there should be a copy of the block on vols[1].
-       new_mtime, err := vols[0].Mtime(TEST_HASH)
+       newMtime, err := vols[0].Mtime(TestHash)
        if err != nil {
-               t.Fatalf("vols[0].Mtime(%s): %s\n", TEST_HASH, err)
+               t.Fatalf("vols[0].Mtime(%s): %s\n", TestHash, err)
        }
-       if !new_mtime.Equal(old_mtime) {
-               t.Errorf("mtime was changed on vols[0]:\nold_mtime = %v\nnew_mtime = %v\n",
-                       old_mtime, new_mtime)
+       if !newMtime.Equal(oldMtime) {
+               t.Errorf("mtime was changed on vols[0]:\noldMtime = %v\nnewMtime = %v\n",
+                       oldMtime, newMtime)
        }
-       result, err := vols[1].Get(TEST_HASH)
+       buf := make([]byte, BlockSize)
+       n, err := vols[1].Get(context.Background(), TestHash, buf)
        if err != nil {
                t.Fatalf("vols[1]: %v", err)
        }
-       if bytes.Compare(result, TEST_BLOCK) != 0 {
-               t.Errorf("new block does not match test block\nnew block = %v\n", result)
+       if bytes.Compare(buf[:n], TestBlock) != 0 {
+               t.Errorf("new block does not match test block\nnew block = %v\n", buf[:n])
        }
 }
 
@@ -309,7 +328,7 @@ func TestDiscoverTmpfs(t *testing.T) {
                }
        }
 
-       // Set up a bogus PROC_MOUNTS file.
+       // Set up a bogus ProcMounts file.
        f, err := ioutil.TempFile("", "keeptest")
        if err != nil {
                t.Fatal(err)
@@ -327,25 +346,25 @@ func TestDiscoverTmpfs(t *testing.T) {
                fmt.Fprintf(f, "tmpfs %s tmpfs %s 0 0\n", path.Dir(vol), opts)
        }
        f.Close()
-       PROC_MOUNTS = f.Name()
+       ProcMounts = f.Name()
 
-       var resultVols volumeSet
-       added := resultVols.Discover()
+       cfg := &Config{}
+       added := (&unixVolumeAdder{cfg}).Discover()
 
-       if added != len(resultVols) {
+       if added != len(cfg.Volumes) {
                t.Errorf("Discover returned %d, but added %d volumes",
-                       added, len(resultVols))
+                       added, len(cfg.Volumes))
        }
        if added != len(tempVols) {
                t.Errorf("Discover returned %d but we set up %d volumes",
                        added, len(tempVols))
        }
        for i, tmpdir := range tempVols {
-               if tmpdir != resultVols[i].(*UnixVolume).root {
+               if tmpdir != cfg.Volumes[i].(*UnixVolume).Root {
                        t.Errorf("Discover returned %s, expected %s\n",
-                               resultVols[i].(*UnixVolume).root, tmpdir)
+                               cfg.Volumes[i].(*UnixVolume).Root, tmpdir)
                }
-               if expectReadonly := i%2 == 1; expectReadonly != resultVols[i].(*UnixVolume).readonly {
+               if expectReadonly := i%2 == 1; expectReadonly != cfg.Volumes[i].(*UnixVolume).ReadOnly {
                        t.Errorf("Discover added %s with readonly=%v, should be %v",
                                tmpdir, !expectReadonly, expectReadonly)
                }
@@ -355,7 +374,7 @@ func TestDiscoverTmpfs(t *testing.T) {
 func TestDiscoverNone(t *testing.T) {
        defer teardown()
 
-       // Set up a bogus PROC_MOUNTS file with no Keep vols.
+       // Set up a bogus ProcMounts file with no Keep vols.
        f, err := ioutil.TempFile("", "keeptest")
        if err != nil {
                t.Fatal(err)
@@ -367,12 +386,12 @@ func TestDiscoverNone(t *testing.T) {
        fmt.Fprintln(f, "udev /dev devtmpfs opts 0 0")
        fmt.Fprintln(f, "devpts /dev/pts devpts opts 0 0")
        f.Close()
-       PROC_MOUNTS = f.Name()
+       ProcMounts = f.Name()
 
-       var resultVols volumeSet
-       added := resultVols.Discover()
-       if added != 0 || len(resultVols) != 0 {
-               t.Fatalf("got %d, %v; expected 0, []", added, resultVols)
+       cfg := &Config{}
+       added := (&unixVolumeAdder{cfg}).Discover()
+       if added != 0 || len(cfg.Volumes) != 0 {
+               t.Fatalf("got %d, %v; expected 0, []", added, cfg.Volumes)
        }
 }
 
@@ -388,23 +407,23 @@ func TestIndex(t *testing.T) {
        defer KeepVM.Close()
 
        vols := KeepVM.AllReadable()
-       vols[0].Put(TEST_HASH, TEST_BLOCK)
-       vols[1].Put(TEST_HASH_2, TEST_BLOCK_2)
-       vols[0].Put(TEST_HASH_3, TEST_BLOCK_3)
-       vols[0].Put(TEST_HASH+".meta", []byte("metadata"))
-       vols[1].Put(TEST_HASH_2+".meta", []byte("metadata"))
+       vols[0].Put(context.Background(), TestHash, TestBlock)
+       vols[1].Put(context.Background(), TestHash2, TestBlock2)
+       vols[0].Put(context.Background(), TestHash3, TestBlock3)
+       vols[0].Put(context.Background(), TestHash+".meta", []byte("metadata"))
+       vols[1].Put(context.Background(), TestHash2+".meta", []byte("metadata"))
 
        buf := new(bytes.Buffer)
        vols[0].IndexTo("", buf)
        vols[1].IndexTo("", buf)
-       index_rows := strings.Split(string(buf.Bytes()), "\n")
-       sort.Strings(index_rows)
-       sorted_index := strings.Join(index_rows, "\n")
-       expected := `^\n` + TEST_HASH + `\+\d+ \d+\n` +
-               TEST_HASH_3 + `\+\d+ \d+\n` +
-               TEST_HASH_2 + `\+\d+ \d+$`
-
-       match, err := regexp.MatchString(expected, sorted_index)
+       indexRows := strings.Split(string(buf.Bytes()), "\n")
+       sort.Strings(indexRows)
+       sortedIndex := strings.Join(indexRows, "\n")
+       expected := `^\n` + TestHash + `\+\d+ \d+\n` +
+               TestHash3 + `\+\d+ \d+\n` +
+               TestHash2 + `\+\d+ \d+$`
+
+       match, err := regexp.MatchString(expected, sortedIndex)
        if err == nil {
                if !match {
                        t.Errorf("IndexLocators returned:\n%s", string(buf.Bytes()))
@@ -420,8 +439,8 @@ func TestIndex(t *testing.T) {
 
 // MakeTestVolumeManager returns a RRVolumeManager with the specified
 // number of MockVolumes.
-func MakeTestVolumeManager(num_volumes int) VolumeManager {
-       vols := make([]Volume, num_volumes)
+func MakeTestVolumeManager(numVolumes int) VolumeManager {
+       vols := make([]Volume, numVolumes)
        for i := range vols {
                vols[i] = CreateMockVolume()
        }
@@ -430,8 +449,8 @@ func MakeTestVolumeManager(num_volumes int) VolumeManager {
 
 // teardown cleans up after each test.
 func teardown() {
-       data_manager_token = ""
-       enforce_permissions = false
-       PermissionSecret = nil
+       theConfig.systemAuthToken = ""
+       theConfig.RequireSignatures = false
+       theConfig.blobSigningKey = nil
        KeepVM = nil
 }