X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/6c14ca8fe128f4db3bafe4edd1cc5551bc85e1ef..55b5ec75a3f6c9154778c8836a99db37e3250abf:/services/keepstore/trash_worker_test.go diff --git a/services/keepstore/trash_worker_test.go b/services/keepstore/trash_worker_test.go index dee8f174c1..4e20c3feb4 100644 --- a/services/keepstore/trash_worker_test.go +++ b/services/keepstore/trash_worker_test.go @@ -1,11 +1,17 @@ -package main +// Copyright (C) The Arvados Authors. All rights reserved. +// +// SPDX-License-Identifier: AGPL-3.0 + +package keepstore import ( "container/list" - "git.curoverse.com/arvados.git/sdk/go/arvadosclient" - "log" - "testing" + "context" "time" + + "git.arvados.org/arvados.git/sdk/go/ctxlog" + "github.com/prometheus/client_golang/prometheus" + check "gopkg.in/check.v1" ) type TrashWorkerTestData struct { @@ -17,13 +23,14 @@ type TrashWorkerTestData struct { Block2 []byte BlockMtime2 int64 - CreateData bool - CreateInVolume1 bool - UseDelayToCreate bool + CreateData bool + CreateInVolume1 bool - UseDefaultTrashTime bool + UseTrashLifeTime bool + DifferentMtimes bool - DeleteLocator string + DeleteLocator string + SpecifyMountUUID bool ExpectLocator1 bool ExpectLocator2 bool @@ -32,7 +39,8 @@ type TrashWorkerTestData struct { /* Delete block that does not exist in any of the keep volumes. Expect no errors. */ -func TestTrashWorkerIntegration_GetNonExistingLocator(t *testing.T) { +func (s *HandlerSuite) TestTrashWorkerIntegration_GetNonExistingLocator(c *check.C) { + s.cluster.Collections.BlobTrash = true testData := TrashWorkerTestData{ Locator1: "5d41402abc4b2a76b9719d911017c592", Block1: []byte("hello"), @@ -47,241 +55,314 @@ func TestTrashWorkerIntegration_GetNonExistingLocator(t *testing.T) { ExpectLocator1: false, ExpectLocator2: false, } - performTrashWorkerTest(testData, t) + s.performTrashWorkerTest(c, testData) } /* Delete a block that exists on volume 1 of the keep servers. Expect the second locator in volume 2 to be unaffected. */ -func TestTrashWorkerIntegration_LocatorInVolume1(t *testing.T) { +func (s *HandlerSuite) TestTrashWorkerIntegration_LocatorInVolume1(c *check.C) { + s.cluster.Collections.BlobTrash = true testData := TrashWorkerTestData{ - Locator1: TEST_HASH, - Block1: TEST_BLOCK, + Locator1: TestHash, + Block1: TestBlock, - Locator2: TEST_HASH_2, - Block2: TEST_BLOCK_2, + Locator2: TestHash2, + Block2: TestBlock2, CreateData: true, - DeleteLocator: TEST_HASH, // first locator + DeleteLocator: TestHash, // first locator ExpectLocator1: false, ExpectLocator2: true, } - performTrashWorkerTest(testData, t) + s.performTrashWorkerTest(c, testData) } /* Delete a block that exists on volume 2 of the keep servers. Expect the first locator in volume 1 to be unaffected. */ -func TestTrashWorkerIntegration_LocatorInVolume2(t *testing.T) { +func (s *HandlerSuite) TestTrashWorkerIntegration_LocatorInVolume2(c *check.C) { + s.cluster.Collections.BlobTrash = true testData := TrashWorkerTestData{ - Locator1: TEST_HASH, - Block1: TEST_BLOCK, + Locator1: TestHash, + Block1: TestBlock, - Locator2: TEST_HASH_2, - Block2: TEST_BLOCK_2, + Locator2: TestHash2, + Block2: TestBlock2, CreateData: true, - DeleteLocator: TEST_HASH_2, // locator 2 + DeleteLocator: TestHash2, // locator 2 ExpectLocator1: true, ExpectLocator2: false, } - performTrashWorkerTest(testData, t) + s.performTrashWorkerTest(c, testData) } /* Delete a block with matching mtime for locator in both volumes. Expect locator to be deleted from both volumes. */ -func TestTrashWorkerIntegration_LocatorInBothVolumes(t *testing.T) { +func (s *HandlerSuite) TestTrashWorkerIntegration_LocatorInBothVolumes(c *check.C) { + s.cluster.Collections.BlobTrash = true testData := TrashWorkerTestData{ - Locator1: TEST_HASH, - Block1: TEST_BLOCK, + Locator1: TestHash, + Block1: TestBlock, - Locator2: TEST_HASH, - Block2: TEST_BLOCK, + Locator2: TestHash, + Block2: TestBlock, CreateData: true, - DeleteLocator: TEST_HASH, + DeleteLocator: TestHash, ExpectLocator1: false, ExpectLocator2: false, } - performTrashWorkerTest(testData, t) + s.performTrashWorkerTest(c, testData) } /* Same locator with different Mtimes exists in both volumes. Delete the second and expect the first to be still around. */ -func TestTrashWorkerIntegration_MtimeMatchesForLocator1ButNotForLocator2(t *testing.T) { +func (s *HandlerSuite) TestTrashWorkerIntegration_MtimeMatchesForLocator1ButNotForLocator2(c *check.C) { + s.cluster.Collections.BlobTrash = true testData := TrashWorkerTestData{ - Locator1: TEST_HASH, - Block1: TEST_BLOCK, + Locator1: TestHash, + Block1: TestBlock, - Locator2: TEST_HASH, - Block2: TEST_BLOCK, + Locator2: TestHash, + Block2: TestBlock, - CreateData: true, - UseDelayToCreate: true, + CreateData: true, + DifferentMtimes: true, - DeleteLocator: TEST_HASH, + DeleteLocator: TestHash, ExpectLocator1: true, ExpectLocator2: false, } - performTrashWorkerTest(testData, t) + s.performTrashWorkerTest(c, testData) +} + +// Delete a block that exists on both volumes with matching mtimes, +// but specify a MountUUID in the request so it only gets deleted from +// the first volume. +func (s *HandlerSuite) TestTrashWorkerIntegration_SpecifyMountUUID(c *check.C) { + s.cluster.Collections.BlobTrash = true + testData := TrashWorkerTestData{ + Locator1: TestHash, + Block1: TestBlock, + + Locator2: TestHash, + Block2: TestBlock, + + CreateData: true, + + DeleteLocator: TestHash, + SpecifyMountUUID: true, + + ExpectLocator1: true, + ExpectLocator2: true, + } + s.performTrashWorkerTest(c, testData) } /* Two different locators in volume 1. Delete one of them. Expect the other unaffected. */ -func TestTrashWorkerIntegration_TwoDifferentLocatorsInVolume1(t *testing.T) { +func (s *HandlerSuite) TestTrashWorkerIntegration_TwoDifferentLocatorsInVolume1(c *check.C) { + s.cluster.Collections.BlobTrash = true testData := TrashWorkerTestData{ - Locator1: TEST_HASH, - Block1: TEST_BLOCK, + Locator1: TestHash, + Block1: TestBlock, - Locator2: TEST_HASH_2, - Block2: TEST_BLOCK_2, + Locator2: TestHash2, + Block2: TestBlock2, CreateData: true, CreateInVolume1: true, - DeleteLocator: TEST_HASH, // locator 1 + DeleteLocator: TestHash, // locator 1 ExpectLocator1: false, ExpectLocator2: true, } - performTrashWorkerTest(testData, t) + s.performTrashWorkerTest(c, testData) } -/* Allow defaultTrashLifetime to be used. Thus, the newly created block - will not be deleted becuase its Mtime is within the trash life time. +/* Allow default Trash Life time to be used. Thus, the newly created block + will not be deleted because its Mtime is within the trash life time. */ -func TestTrashWorkerIntegration_SameLocatorInTwoVolumesWithDefaultTrashLifeTime(t *testing.T) { +func (s *HandlerSuite) TestTrashWorkerIntegration_SameLocatorInTwoVolumesWithDefaultTrashLifeTime(c *check.C) { + s.cluster.Collections.BlobTrash = true testData := TrashWorkerTestData{ - Locator1: TEST_HASH, - Block1: TEST_BLOCK, + Locator1: TestHash, + Block1: TestBlock, - Locator2: TEST_HASH_2, - Block2: TEST_BLOCK_2, + Locator2: TestHash2, + Block2: TestBlock2, CreateData: true, CreateInVolume1: true, - UseDefaultTrashTime: true, + UseTrashLifeTime: true, - DeleteLocator: TEST_HASH, // locator 1 + DeleteLocator: TestHash, // locator 1 - // Since defaultTrashLifetime is in effect, block won't be deleted. + // Since trash life time is in effect, block won't be deleted. ExpectLocator1: true, ExpectLocator2: true, } - performTrashWorkerTest(testData, t) + s.performTrashWorkerTest(c, testData) } -/* Perform the test */ -func performTrashWorkerTest(testData TrashWorkerTestData, t *testing.T) { - // Create Keep Volumes - KeepVM = MakeTestVolumeManager(2) +/* Delete a block with matching mtime for locator in both volumes, but EnableDelete is false, + so block won't be deleted. +*/ +func (s *HandlerSuite) TestTrashWorkerIntegration_DisabledDelete(c *check.C) { + s.cluster.Collections.BlobTrash = false + testData := TrashWorkerTestData{ + Locator1: TestHash, + Block1: TestBlock, + + Locator2: TestHash, + Block2: TestBlock, + + CreateData: true, + + DeleteLocator: TestHash, + + ExpectLocator1: true, + ExpectLocator2: true, + } + s.performTrashWorkerTest(c, testData) +} - // Delete from volume will not take place if the block MTime is within permission_ttl - permission_ttl = time.Duration(1) * time.Second +/* Perform the test */ +func (s *HandlerSuite) performTrashWorkerTest(c *check.C, testData TrashWorkerTestData) { + c.Assert(s.handler.setup(context.Background(), s.cluster, "", prometheus.NewRegistry(), testServiceURL), check.IsNil) + // Replace the router's trashq -- which the worker goroutines + // started by setup() are now receiving from -- with a new + // one, so we can see what the handler sends to it. + trashq := NewWorkQueue() + s.handler.Handler.(*router).trashq = trashq // Put test content - vols := KeepVM.Volumes() + mounts := s.handler.volmgr.AllWritable() if testData.CreateData { - vols[0].Put(testData.Locator1, testData.Block1) - vols[0].Put(testData.Locator1+".meta", []byte("metadata")) - - // One of the tests deletes a locator with different Mtimes in two different volumes - if testData.UseDelayToCreate { - time.Sleep(1 * time.Second) - } + mounts[0].Put(context.Background(), testData.Locator1, testData.Block1) + mounts[0].Put(context.Background(), testData.Locator1+".meta", []byte("metadata")) if testData.CreateInVolume1 { - vols[0].Put(testData.Locator2, testData.Block2) - vols[0].Put(testData.Locator2+".meta", []byte("metadata")) + mounts[0].Put(context.Background(), testData.Locator2, testData.Block2) + mounts[0].Put(context.Background(), testData.Locator2+".meta", []byte("metadata")) } else { - vols[1].Put(testData.Locator2, testData.Block2) - vols[1].Put(testData.Locator2+".meta", []byte("metadata")) + mounts[1].Put(context.Background(), testData.Locator2, testData.Block2) + mounts[1].Put(context.Background(), testData.Locator2+".meta", []byte("metadata")) } } + oldBlockTime := time.Now().Add(-s.cluster.Collections.BlobSigningTTL.Duration() - time.Minute) + // Create TrashRequest for the test trashRequest := TrashRequest{ Locator: testData.DeleteLocator, - BlockMtime: time.Now().Unix(), + BlockMtime: oldBlockTime.UnixNano(), + } + if testData.SpecifyMountUUID { + trashRequest.MountUUID = s.handler.volmgr.Mounts()[0].UUID } - - // delay by permission_ttl to allow deletes to work - time.Sleep(1 * time.Second) // Run trash worker and put the trashRequest on trashq trashList := list.New() trashList.PushBack(trashRequest) - trashq = NewWorkQueue() - // Trash worker would not delete block if its Mtime is within defaultTrashLifetime - // Hence, we will have to bypass it to allow the deletion to succeed. - if !testData.UseDefaultTrashTime { - go RunTrashWorker(nil, trashq) - } else { - arv, err := arvadosclient.MakeArvadosClient() - if err != nil { - log.Fatalf("Error setting up arvados client %s", err.Error()) + if !testData.UseTrashLifeTime { + // Trash worker would not delete block if its Mtime is + // within trash life time. Back-date the block to + // allow the deletion to succeed. + for _, mnt := range mounts { + mnt.Volume.(*MockVolume).Timestamps[testData.DeleteLocator] = oldBlockTime + if testData.DifferentMtimes { + oldBlockTime = oldBlockTime.Add(time.Second) + } } - go RunTrashWorker(&arv, trashq) } + go RunTrashWorker(s.handler.volmgr, ctxlog.TestLogger(c), s.cluster, trashq) + // Install gate so all local operations block until we say go + gate := make(chan struct{}) + for _, mnt := range mounts { + mnt.Volume.(*MockVolume).Gate = gate + } + + assertStatusItem := func(k string, expect float64) { + if v := getStatusItem(s.handler, "TrashQueue", k); v != expect { + c.Errorf("Got %s %v, expected %v", k, v, expect) + } + } + + assertStatusItem("InProgress", 0) + assertStatusItem("Queued", 0) + + listLen := trashList.Len() trashq.ReplaceQueue(trashList) - time.Sleep(10 * time.Millisecond) // give a moment to finish processing the list + + // Wait for worker to take request(s) + expectEqualWithin(c, time.Second, listLen, func() interface{} { return trashq.Status().InProgress }) + + // Ensure status.json also reports work is happening + assertStatusItem("InProgress", float64(1)) + assertStatusItem("Queued", float64(listLen-1)) + + // Let worker proceed + close(gate) + + // Wait for worker to finish + expectEqualWithin(c, time.Second, 0, func() interface{} { return trashq.Status().InProgress }) // Verify Locator1 to be un/deleted as expected - data, _ := GetBlock(testData.Locator1, false) + buf := make([]byte, BlockSize) + size, err := GetBlock(context.Background(), s.handler.volmgr, testData.Locator1, buf, nil) if testData.ExpectLocator1 { - if len(data) == 0 { - t.Errorf("Expected Locator1 to be still present: %s", testData.Locator1) + if size == 0 || err != nil { + c.Errorf("Expected Locator1 to be still present: %s", testData.Locator1) } } else { - if len(data) > 0 { - t.Errorf("Expected Locator1 to be deleted: %s", testData.Locator1) + if size > 0 || err == nil { + c.Errorf("Expected Locator1 to be deleted: %s", testData.Locator1) } } // Verify Locator2 to be un/deleted as expected if testData.Locator1 != testData.Locator2 { - data, _ = GetBlock(testData.Locator2, false) + size, err = GetBlock(context.Background(), s.handler.volmgr, testData.Locator2, buf, nil) if testData.ExpectLocator2 { - if len(data) == 0 { - t.Errorf("Expected Locator2 to be still present: %s", testData.Locator2) + if size == 0 || err != nil { + c.Errorf("Expected Locator2 to be still present: %s", testData.Locator2) } } else { - if len(data) > 0 { - t.Errorf("Expected Locator2 to be deleted: %s", testData.Locator2) + if size > 0 || err == nil { + c.Errorf("Expected Locator2 to be deleted: %s", testData.Locator2) } } } - // One test used the same locator in two different volumes but with different Mtime values - // Hence let's verify that only one volume has it and the other is deleted - if (testData.ExpectLocator1) && - (testData.Locator1 == testData.Locator2) { + // The DifferentMtimes test puts the same locator in two + // different volumes, but only one copy has an Mtime matching + // the trash request. + if testData.DifferentMtimes { locatorFoundIn := 0 - for _, volume := range KeepVM.Volumes() { - if _, err := volume.Get(testData.Locator1); err == nil { + for _, volume := range s.handler.volmgr.AllReadable() { + buf := make([]byte, BlockSize) + if _, err := volume.Get(context.Background(), testData.Locator1, buf); err == nil { locatorFoundIn = locatorFoundIn + 1 } } - if locatorFoundIn != 1 { - t.Errorf("Expected locator to be found in only one volume after deleting. But found: %s", locatorFoundIn) - } + c.Check(locatorFoundIn, check.Equals, 1) } - - // Done - trashq.Close() - KeepVM.Quit() }