Merge branch 'master' into wtsi-hgi-8087-arv-cli-request-body-from-file
[arvados.git] / services / keepstore / volume_generic_test.go
index 7580a202594426173ca14d54d9fda8c523171e30..f8fe0d0ebce719c6c823fe9caa9fcce12324eb49 100644 (file)
@@ -76,6 +76,9 @@ func DoGenericVolumeTests(t TB, factory TestableVolumeFactory) {
        testPutConcurrent(t, factory)
 
        testPutFullBlock(t, factory)
+
+       testTrashUntrash(t, factory)
+       testTrashEmptyTrashUntrash(t, factory)
 }
 
 // Put a test block, get it and verify content
@@ -86,14 +89,13 @@ func testGet(t TB, factory TestableVolumeFactory) {
 
        v.PutRaw(TestHash, TestBlock)
 
-       buf, err := v.Get(TestHash)
+       buf := make([]byte, BlockSize)
+       n, err := v.Get(TestHash, buf)
        if err != nil {
                t.Fatal(err)
        }
 
-       bufs.Put(buf)
-
-       if bytes.Compare(buf, TestBlock) != 0 {
+       if bytes.Compare(buf[:n], TestBlock) != 0 {
                t.Errorf("expected %s, got %s", string(TestBlock), string(buf))
        }
 }
@@ -104,7 +106,8 @@ func testGetNoSuchBlock(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
 
-       if _, err := v.Get(TestHash2); err == nil {
+       buf := make([]byte, BlockSize)
+       if _, err := v.Get(TestHash2, buf); err == nil {
                t.Errorf("Expected error while getting non-existing block %v", TestHash2)
        }
 }
@@ -205,24 +208,22 @@ func testPutBlockWithDifferentContent(t TB, factory TestableVolumeFactory, testH
        v.PutRaw(testHash, testDataA)
 
        putErr := v.Put(testHash, testDataB)
-       buf, getErr := v.Get(testHash)
+       buf := make([]byte, BlockSize)
+       n, getErr := v.Get(testHash, buf)
        if putErr == nil {
                // Put must not return a nil error unless it has
                // overwritten the existing data.
-               if bytes.Compare(buf, testDataB) != 0 {
-                       t.Errorf("Put succeeded but Get returned %+q, expected %+q", buf, testDataB)
+               if bytes.Compare(buf[:n], testDataB) != 0 {
+                       t.Errorf("Put succeeded but Get returned %+q, expected %+q", buf[:n], testDataB)
                }
        } else {
                // It is permissible for Put to fail, but it must
                // leave us with either the original data, the new
                // data, or nothing at all.
-               if getErr == nil && bytes.Compare(buf, testDataA) != 0 && bytes.Compare(buf, testDataB) != 0 {
-                       t.Errorf("Put failed but Get returned %+q, which is neither %+q nor %+q", buf, testDataA, testDataB)
+               if getErr == nil && bytes.Compare(buf[:n], testDataA) != 0 && bytes.Compare(buf[:n], testDataB) != 0 {
+                       t.Errorf("Put failed but Get returned %+q, which is neither %+q nor %+q", buf[:n], testDataA, testDataB)
                }
        }
-       if getErr == nil {
-               bufs.Put(buf)
-       }
 }
 
 // Put and get multiple blocks
@@ -250,34 +251,32 @@ func testPutMultipleBlocks(t TB, factory TestableVolumeFactory) {
                t.Errorf("Got err putting block %q: %q, expected nil", TestBlock3, err)
        }
 
-       data, err := v.Get(TestHash)
+       data := make([]byte, BlockSize)
+       n, err := v.Get(TestHash, data)
        if err != nil {
                t.Error(err)
        } else {
-               if bytes.Compare(data, TestBlock) != 0 {
-                       t.Errorf("Block present, but got %+q, expected %+q", data, TestBlock)
+               if bytes.Compare(data[:n], TestBlock) != 0 {
+                       t.Errorf("Block present, but got %+q, expected %+q", data[:n], TestBlock)
                }
-               bufs.Put(data)
        }
 
-       data, err = v.Get(TestHash2)
+       n, err = v.Get(TestHash2, data)
        if err != nil {
                t.Error(err)
        } else {
-               if bytes.Compare(data, TestBlock2) != 0 {
-                       t.Errorf("Block present, but got %+q, expected %+q", data, TestBlock2)
+               if bytes.Compare(data[:n], TestBlock2) != 0 {
+                       t.Errorf("Block present, but got %+q, expected %+q", data[:n], TestBlock2)
                }
-               bufs.Put(data)
        }
 
-       data, err = v.Get(TestHash3)
+       n, err = v.Get(TestHash3, data)
        if err != nil {
                t.Error(err)
        } else {
-               if bytes.Compare(data, TestBlock3) != 0 {
-                       t.Errorf("Block present, but to %+q, expected %+q", data, TestBlock3)
+               if bytes.Compare(data[:n], TestBlock3) != 0 {
+                       t.Errorf("Block present, but to %+q, expected %+q", data[:n], TestBlock3)
                }
-               bufs.Put(data)
        }
 }
 
@@ -420,17 +419,15 @@ func testDeleteNewBlock(t TB, factory TestableVolumeFactory) {
 
        v.Put(TestHash, TestBlock)
 
-       if err := v.Delete(TestHash); err != nil {
+       if err := v.Trash(TestHash); err != nil {
                t.Error(err)
        }
-       data, err := v.Get(TestHash)
+       data := make([]byte, BlockSize)
+       n, err := v.Get(TestHash, data)
        if err != nil {
                t.Error(err)
-       } else {
-               if bytes.Compare(data, TestBlock) != 0 {
-                       t.Errorf("Got data %+q, expected %+q", data, TestBlock)
-               }
-               bufs.Put(data)
+       } else if bytes.Compare(data[:n], TestBlock) != 0 {
+               t.Errorf("Got data %+q, expected %+q", data[:n], TestBlock)
        }
 }
 
@@ -449,12 +446,34 @@ func testDeleteOldBlock(t TB, factory TestableVolumeFactory) {
        v.Put(TestHash, TestBlock)
        v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
 
-       if err := v.Delete(TestHash); err != nil {
+       if err := v.Trash(TestHash); err != nil {
                t.Error(err)
        }
-       if _, err := v.Get(TestHash); err == nil || !os.IsNotExist(err) {
+       data := make([]byte, BlockSize)
+       if _, err := v.Get(TestHash, data); err == nil || !os.IsNotExist(err) {
                t.Errorf("os.IsNotExist(%v) should have been true", err)
        }
+
+       _, err := v.Mtime(TestHash)
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       err = v.Compare(TestHash, TestBlock)
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       indexBuf := new(bytes.Buffer)
+       v.IndexTo("", indexBuf)
+       if strings.Contains(string(indexBuf.Bytes()), TestHash) {
+               t.Fatalf("Found trashed block in IndexTo")
+       }
+
+       err = v.Touch(TestHash)
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
 }
 
 // Calling Delete() for a block that does not exist should result in error.
@@ -463,7 +482,7 @@ func testDeleteNoSuchBlock(t TB, factory TestableVolumeFactory) {
        v := factory(t)
        defer v.Teardown()
 
-       if err := v.Delete(TestHash2); err == nil {
+       if err := v.Trash(TestHash2); err == nil {
                t.Errorf("Expected error when attempting to delete a non-existing block")
        }
 }
@@ -511,9 +530,10 @@ func testUpdateReadOnly(t TB, factory TestableVolumeFactory) {
        }
 
        v.PutRaw(TestHash, TestBlock)
+       buf := make([]byte, BlockSize)
 
        // Get from read-only volume should succeed
-       _, err := v.Get(TestHash)
+       _, err := v.Get(TestHash, buf)
        if err != nil {
                t.Errorf("got err %v, expected nil", err)
        }
@@ -523,7 +543,7 @@ func testUpdateReadOnly(t TB, factory TestableVolumeFactory) {
        if err == nil {
                t.Errorf("Expected error when putting block in a read-only volume")
        }
-       _, err = v.Get(TestHash2)
+       _, err = v.Get(TestHash2, buf)
        if err == nil {
                t.Errorf("Expected error when getting block whose put in read-only volume failed")
        }
@@ -535,7 +555,7 @@ func testUpdateReadOnly(t TB, factory TestableVolumeFactory) {
        }
 
        // Delete a block from a read-only volume should result in error
-       err = v.Delete(TestHash)
+       err = v.Trash(TestHash)
        if err == nil {
                t.Errorf("Expected error when deleting block from a read-only volume")
        }
@@ -558,45 +578,45 @@ func testGetConcurrent(t TB, factory TestableVolumeFactory) {
        v.PutRaw(TestHash3, TestBlock3)
 
        sem := make(chan int)
-       go func(sem chan int) {
-               buf, err := v.Get(TestHash)
+       go func() {
+               buf := make([]byte, BlockSize)
+               n, err := v.Get(TestHash, buf)
                if err != nil {
                        t.Errorf("err1: %v", err)
                }
-               bufs.Put(buf)
-               if bytes.Compare(buf, TestBlock) != 0 {
-                       t.Errorf("buf should be %s, is %s", string(TestBlock), string(buf))
+               if bytes.Compare(buf[:n], TestBlock) != 0 {
+                       t.Errorf("buf should be %s, is %s", string(TestBlock), string(buf[:n]))
                }
                sem <- 1
-       }(sem)
+       }()
 
-       go func(sem chan int) {
-               buf, err := v.Get(TestHash2)
+       go func() {
+               buf := make([]byte, BlockSize)
+               n, err := v.Get(TestHash2, buf)
                if err != nil {
                        t.Errorf("err2: %v", err)
                }
-               bufs.Put(buf)
-               if bytes.Compare(buf, TestBlock2) != 0 {
-                       t.Errorf("buf should be %s, is %s", string(TestBlock2), string(buf))
+               if bytes.Compare(buf[:n], TestBlock2) != 0 {
+                       t.Errorf("buf should be %s, is %s", string(TestBlock2), string(buf[:n]))
                }
                sem <- 1
-       }(sem)
+       }()
 
-       go func(sem chan int) {
-               buf, err := v.Get(TestHash3)
+       go func() {
+               buf := make([]byte, BlockSize)
+               n, err := v.Get(TestHash3, buf)
                if err != nil {
                        t.Errorf("err3: %v", err)
                }
-               bufs.Put(buf)
-               if bytes.Compare(buf, TestBlock3) != 0 {
-                       t.Errorf("buf should be %s, is %s", string(TestBlock3), string(buf))
+               if bytes.Compare(buf[:n], TestBlock3) != 0 {
+                       t.Errorf("buf should be %s, is %s", string(TestBlock3), string(buf[:n]))
                }
                sem <- 1
-       }(sem)
+       }()
 
        // Wait for all goroutines to finish
-       for done := 0; done < 3; {
-               done += <-sem
+       for done := 0; done < 3; done++ {
+               <-sem
        }
 }
 
@@ -636,36 +656,34 @@ func testPutConcurrent(t TB, factory TestableVolumeFactory) {
        }(sem)
 
        // Wait for all goroutines to finish
-       for done := 0; done < 3; {
-               done += <-sem
+       for done := 0; done < 3; done++ {
+               <-sem
        }
 
        // Double check that we actually wrote the blocks we expected to write.
-       buf, err := v.Get(TestHash)
+       buf := make([]byte, BlockSize)
+       n, err := v.Get(TestHash, buf)
        if err != nil {
                t.Errorf("Get #1: %v", err)
        }
-       bufs.Put(buf)
-       if bytes.Compare(buf, TestBlock) != 0 {
-               t.Errorf("Get #1: expected %s, got %s", string(TestBlock), string(buf))
+       if bytes.Compare(buf[:n], TestBlock) != 0 {
+               t.Errorf("Get #1: expected %s, got %s", string(TestBlock), string(buf[:n]))
        }
 
-       buf, err = v.Get(TestHash2)
+       n, err = v.Get(TestHash2, buf)
        if err != nil {
                t.Errorf("Get #2: %v", err)
        }
-       bufs.Put(buf)
-       if bytes.Compare(buf, TestBlock2) != 0 {
-               t.Errorf("Get #2: expected %s, got %s", string(TestBlock2), string(buf))
+       if bytes.Compare(buf[:n], TestBlock2) != 0 {
+               t.Errorf("Get #2: expected %s, got %s", string(TestBlock2), string(buf[:n]))
        }
 
-       buf, err = v.Get(TestHash3)
+       n, err = v.Get(TestHash3, buf)
        if err != nil {
                t.Errorf("Get #3: %v", err)
        }
-       bufs.Put(buf)
-       if bytes.Compare(buf, TestBlock3) != 0 {
-               t.Errorf("Get #3: expected %s, got %s", string(TestBlock3), string(buf))
+       if bytes.Compare(buf[:n], TestBlock3) != 0 {
+               t.Errorf("Get #3: expected %s, got %s", string(TestBlock3), string(buf[:n]))
        }
 }
 
@@ -686,13 +704,284 @@ func testPutFullBlock(t TB, factory TestableVolumeFactory) {
        if err != nil {
                t.Fatal(err)
        }
-       rdata, err := v.Get(hash)
+       buf := make([]byte, BlockSize)
+       n, err := v.Get(hash, buf)
        if err != nil {
                t.Error(err)
+       }
+       if bytes.Compare(buf[:n], wdata) != 0 {
+               t.Error("buf %+q != wdata %+q", buf[:n], wdata)
+       }
+}
+
+// With trashLifetime != 0, perform:
+// Trash an old block - which either raises ErrNotImplemented or succeeds
+// Untrash -  which either raises ErrNotImplemented or succeeds
+// Get - which must succeed
+func testTrashUntrash(t TB, factory TestableVolumeFactory) {
+       v := factory(t)
+       defer v.Teardown()
+       defer func() {
+               trashLifetime = 0 * time.Second
+       }()
+
+       trashLifetime = 3600 * time.Second
+
+       // put block and backdate it
+       v.PutRaw(TestHash, TestBlock)
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
+
+       buf := make([]byte, BlockSize)
+       n, err := v.Get(TestHash, buf)
+       if err != nil {
+               t.Fatal(err)
+       }
+       if bytes.Compare(buf[:n], TestBlock) != 0 {
+               t.Errorf("Got data %+q, expected %+q", buf[:n], TestBlock)
+       }
+
+       // Trash
+       err = v.Trash(TestHash)
+       if v.Writable() == false {
+               if err != MethodDisabledError {
+                       t.Fatal(err)
+               }
+       } else if err != nil {
+               if err != ErrNotImplemented {
+                       t.Fatal(err)
+               }
        } else {
-               defer bufs.Put(rdata)
+               _, err = v.Get(TestHash, buf)
+               if err == nil || !os.IsNotExist(err) {
+                       t.Errorf("os.IsNotExist(%v) should have been true", err)
+               }
+
+               // Untrash
+               err = v.Untrash(TestHash)
+               if err != nil {
+                       t.Fatal(err)
+               }
+       }
+
+       // Get the block - after trash and untrash sequence
+       n, err = v.Get(TestHash, buf)
+       if err != nil {
+               t.Fatal(err)
        }
-       if bytes.Compare(rdata, wdata) != 0 {
-               t.Error("rdata != wdata")
+       if bytes.Compare(buf[:n], TestBlock) != 0 {
+               t.Errorf("Got data %+q, expected %+q", buf[:n], TestBlock)
+       }
+}
+
+func testTrashEmptyTrashUntrash(t TB, factory TestableVolumeFactory) {
+       v := factory(t)
+       defer v.Teardown()
+       defer func(orig time.Duration) {
+               trashLifetime = orig
+       }(trashLifetime)
+
+       checkGet := func() error {
+               buf := make([]byte, BlockSize)
+               n, err := v.Get(TestHash, buf)
+               if err != nil {
+                       return err
+               }
+               if bytes.Compare(buf[:n], TestBlock) != 0 {
+                       t.Fatalf("Got data %+q, expected %+q", buf[:n], TestBlock)
+               }
+
+               _, err = v.Mtime(TestHash)
+               if err != nil {
+                       return err
+               }
+
+               err = v.Compare(TestHash, TestBlock)
+               if err != nil {
+                       return err
+               }
+
+               indexBuf := new(bytes.Buffer)
+               v.IndexTo("", indexBuf)
+               if !strings.Contains(string(indexBuf.Bytes()), TestHash) {
+                       return os.ErrNotExist
+               }
+
+               return nil
+       }
+
+       // First set: EmptyTrash before reaching the trash deadline.
+
+       trashLifetime = 1 * time.Hour
+
+       v.PutRaw(TestHash, TestBlock)
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
+
+       err := checkGet()
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       // Trash the block
+       err = v.Trash(TestHash)
+       if err == MethodDisabledError || err == ErrNotImplemented {
+               // Skip the trash tests for read-only volumes, and
+               // volume types that don't support trashLifetime>0.
+               return
+       }
+
+       err = checkGet()
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       err = v.Touch(TestHash)
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       v.EmptyTrash()
+
+       // Even after emptying the trash, we can untrash our block
+       // because the deadline hasn't been reached.
+       err = v.Untrash(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       err = checkGet()
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       err = v.Touch(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       // Because we Touch'ed, need to backdate again for next set of tests
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
+
+       // Untrash should fail if the only block in the trash has
+       // already been untrashed.
+       err = v.Untrash(TestHash)
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       // The failed Untrash should not interfere with our
+       // already-untrashed copy.
+       err = checkGet()
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       // Second set: EmptyTrash after the trash deadline has passed.
+
+       trashLifetime = 1 * time.Nanosecond
+
+       err = v.Trash(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+       err = checkGet()
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       // Even though 1ns has passed, we can untrash because we
+       // haven't called EmptyTrash yet.
+       err = v.Untrash(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+       err = checkGet()
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       // Trash it again, and this time call EmptyTrash so it really
+       // goes away.
+       // (In Azure volumes, un/trash changes Mtime, so first backdate again)
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
+       err = v.Trash(TestHash)
+       err = checkGet()
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+       // EmptryTrash
+       v.EmptyTrash()
+
+       // Untrash won't find it
+       err = v.Untrash(TestHash)
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       // Get block won't find it
+       err = checkGet()
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       // Third set: If the same data block gets written again after
+       // being trashed, and then the trash gets emptied, the newer
+       // un-trashed copy doesn't get deleted along with it.
+
+       v.PutRaw(TestHash, TestBlock)
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
+
+       trashLifetime = time.Nanosecond
+       err = v.Trash(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+       err = checkGet()
+       if err == nil || !os.IsNotExist(err) {
+               t.Fatalf("os.IsNotExist(%v) should have been true", err)
+       }
+
+       v.PutRaw(TestHash, TestBlock)
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
+
+       // EmptyTrash should not delete the untrashed copy.
+       v.EmptyTrash()
+       err = checkGet()
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       // Fourth set: If the same data block gets trashed twice with
+       // different deadlines A and C, and then the trash is emptied
+       // at intermediate time B (A < B < C), it is still possible to
+       // untrash the block whose deadline is "C".
+
+       v.PutRaw(TestHash, TestBlock)
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
+
+       trashLifetime = time.Nanosecond
+       err = v.Trash(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       v.PutRaw(TestHash, TestBlock)
+       v.TouchWithDate(TestHash, time.Now().Add(-2*blobSignatureTTL))
+
+       trashLifetime = time.Hour
+       err = v.Trash(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+
+       // EmptyTrash should not prevent us from recovering the
+       // time.Hour ("C") trash
+       v.EmptyTrash()
+       err = v.Untrash(TestHash)
+       if err != nil {
+               t.Fatal(err)
+       }
+       err = checkGet()
+       if err != nil {
+               t.Fatal(err)
        }
 }