X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/c0f9c128aabb366435d751a3ea1a63b76c177f5b..8a27fe370239ecb8e50d53f46b45ed61203a35ca:/services/keepstore/pull_worker_test.go diff --git a/services/keepstore/pull_worker_test.go b/services/keepstore/pull_worker_test.go index 37d83b3280..2626e66d88 100644 --- a/services/keepstore/pull_worker_test.go +++ b/services/keepstore/pull_worker_test.go @@ -1,59 +1,61 @@ -package main +// Copyright (C) The Arvados Authors. All rights reserved. +// +// SPDX-License-Identifier: AGPL-3.0 + +package keepstore import ( "bytes" + "context" "errors" - "git.curoverse.com/arvados.git/sdk/go/arvadosclient" - "git.curoverse.com/arvados.git/sdk/go/keepclient" - . "gopkg.in/check.v1" "io" + "io/ioutil" "net/http" - "testing" "time" + + "git.arvados.org/arvados.git/sdk/go/arvados" + "git.arvados.org/arvados.git/sdk/go/keepclient" + "github.com/prometheus/client_golang/prometheus" + . "gopkg.in/check.v1" + check "gopkg.in/check.v1" ) -type PullWorkerTestSuite struct{} +var _ = Suite(&PullWorkerTestSuite{}) + +type PullWorkerTestSuite struct { + cluster *arvados.Cluster + handler *handler -// Gocheck boilerplate -func TestPullWorker(t *testing.T) { - TestingT(t) + testPullLists map[string]string + readContent string + readError error + putContent []byte + putError error } -// Gocheck boilerplate -var _ = Suite(&PullWorkerTestSuite{}) +func (s *PullWorkerTestSuite) SetUpTest(c *C) { + s.cluster = testCluster(c) + s.cluster.Volumes = map[string]arvados.Volume{ + "zzzzz-nyw5e-000000000000000": {Driver: "mock"}, + "zzzzz-nyw5e-111111111111111": {Driver: "mock"}, + } + s.cluster.Collections.BlobReplicateConcurrency = 1 -var testPullLists map[string]string -var readContent string -var readError error -var putContent []byte -var putError error -var currentTestData PullWorkerTestData + s.handler = &handler{} + c.Assert(s.handler.setup(context.Background(), s.cluster, "", prometheus.NewRegistry(), testServiceURL), check.IsNil) -func (s *PullWorkerTestSuite) SetUpTest(c *C) { - readContent = "" - readError = nil - putContent = []byte("") - putError = nil + s.readContent = "" + s.readError = nil + s.putContent = []byte{} + s.putError = nil // When a new pull request arrives, the old one will be overwritten. // This behavior is verified using these two maps in the - // "TestPullWorker_pull_list_with_two_items_latest_replacing_old" - testPullLists = make(map[string]string) + // "TestPullWorkerPullList_with_two_items_latest_replacing_old" + s.testPullLists = make(map[string]string) } -// Since keepstore does not come into picture in tests, -// we need to explicitly start the goroutine in tests. -func RunTestPullWorker(c *C) { - arv, err := arvadosclient.MakeArvadosClient() - c.Assert(err, Equals, nil) - keepClient, err := keepclient.MakeKeepClient(&arv) - c.Assert(err, Equals, nil) - - pullq = NewWorkQueue() - go RunPullWorker(pullq, keepClient) -} - -var first_pull_list = []byte(`[ +var firstPullList = []byte(`[ { "locator":"acbd18db4cc2f85cedef654fccc4a4d8+3", "servers":[ @@ -68,7 +70,7 @@ var first_pull_list = []byte(`[ } ]`) -var second_pull_list = []byte(`[ +var secondPullList = []byte(`[ { "locator":"73feffa4b7f6bb68e44cf984c85f6e88+3", "servers":[ @@ -79,171 +81,161 @@ var second_pull_list = []byte(`[ ]`) type PullWorkerTestData struct { - name string - req RequestTester - response_code int - response_body string - read_content string - read_error bool - put_error bool + name string + req RequestTester + responseCode int + responseBody string + readContent string + readError bool + putError bool } -func (s *PullWorkerTestSuite) TestPullWorker_pull_list_with_two_locators(c *C) { - defer teardown() +// Ensure MountUUID in a pull list is correctly translated to a Volume +// argument passed to writePulledBlock(). +func (s *PullWorkerTestSuite) TestSpecifyMountUUID(c *C) { + defer func(f func(*RRVolumeManager, Volume, []byte, string) error) { + writePulledBlock = f + }(writePulledBlock) + pullq := s.handler.Handler.(*router).pullq + + for _, spec := range []struct { + sendUUID string + expectVolume Volume + }{ + { + sendUUID: "", + expectVolume: nil, + }, + { + sendUUID: s.handler.volmgr.Mounts()[0].UUID, + expectVolume: s.handler.volmgr.Mounts()[0].Volume, + }, + } { + writePulledBlock = func(_ *RRVolumeManager, v Volume, _ []byte, _ string) error { + c.Check(v, Equals, spec.expectVolume) + return nil + } + + resp := IssueRequest(s.handler, &RequestTester{ + uri: "/pull", + apiToken: s.cluster.SystemRootToken, + method: "PUT", + requestBody: []byte(`[{ + "locator":"acbd18db4cc2f85cedef654fccc4a4d8+3", + "servers":["server_1","server_2"], + "mount_uuid":"` + spec.sendUUID + `"}]`), + }) + c.Assert(resp.Code, Equals, http.StatusOK) + expectEqualWithin(c, time.Second, 0, func() interface{} { + st := pullq.Status() + return st.InProgress + st.Queued + }) + } +} - data_manager_token = "DATA MANAGER TOKEN" +func (s *PullWorkerTestSuite) TestPullWorkerPullList_with_two_locators(c *C) { testData := PullWorkerTestData{ - name: "TestPullWorker_pull_list_with_two_locators", - req: RequestTester{"/pull", data_manager_token, "PUT", first_pull_list}, - response_code: http.StatusOK, - response_body: "Received 2 pull requests\n", - read_content: "hello", - read_error: false, - put_error: false, + name: "TestPullWorkerPullList_with_two_locators", + req: RequestTester{"/pull", s.cluster.SystemRootToken, "PUT", firstPullList, ""}, + responseCode: http.StatusOK, + responseBody: "Received 2 pull requests\n", + readContent: "hello", + readError: false, + putError: false, } - performTest(testData, c) + s.performTest(testData, c) } -func (s *PullWorkerTestSuite) TestPullWorker_pull_list_with_one_locator(c *C) { - defer teardown() - - data_manager_token = "DATA MANAGER TOKEN" +func (s *PullWorkerTestSuite) TestPullWorkerPullList_with_one_locator(c *C) { testData := PullWorkerTestData{ - name: "TestPullWorker_pull_list_with_one_locator", - req: RequestTester{"/pull", data_manager_token, "PUT", second_pull_list}, - response_code: http.StatusOK, - response_body: "Received 1 pull requests\n", - read_content: "hola", - read_error: false, - put_error: false, + name: "TestPullWorkerPullList_with_one_locator", + req: RequestTester{"/pull", s.cluster.SystemRootToken, "PUT", secondPullList, ""}, + responseCode: http.StatusOK, + responseBody: "Received 1 pull requests\n", + readContent: "hola", + readError: false, + putError: false, } - performTest(testData, c) + s.performTest(testData, c) } func (s *PullWorkerTestSuite) TestPullWorker_error_on_get_one_locator(c *C) { - defer teardown() - - data_manager_token = "DATA MANAGER TOKEN" testData := PullWorkerTestData{ - name: "TestPullWorker_error_on_get_one_locator", - req: RequestTester{"/pull", data_manager_token, "PUT", second_pull_list}, - response_code: http.StatusOK, - response_body: "Received 1 pull requests\n", - read_content: "unused", - read_error: true, - put_error: false, + name: "TestPullWorker_error_on_get_one_locator", + req: RequestTester{"/pull", s.cluster.SystemRootToken, "PUT", secondPullList, ""}, + responseCode: http.StatusOK, + responseBody: "Received 1 pull requests\n", + readContent: "unused", + readError: true, + putError: false, } - performTest(testData, c) + s.performTest(testData, c) } func (s *PullWorkerTestSuite) TestPullWorker_error_on_get_two_locators(c *C) { - defer teardown() - - data_manager_token = "DATA MANAGER TOKEN" testData := PullWorkerTestData{ - name: "TestPullWorker_error_on_get_two_locators", - req: RequestTester{"/pull", data_manager_token, "PUT", first_pull_list}, - response_code: http.StatusOK, - response_body: "Received 2 pull requests\n", - read_content: "unused", - read_error: true, - put_error: false, + name: "TestPullWorker_error_on_get_two_locators", + req: RequestTester{"/pull", s.cluster.SystemRootToken, "PUT", firstPullList, ""}, + responseCode: http.StatusOK, + responseBody: "Received 2 pull requests\n", + readContent: "unused", + readError: true, + putError: false, } - performTest(testData, c) + s.performTest(testData, c) } func (s *PullWorkerTestSuite) TestPullWorker_error_on_put_one_locator(c *C) { - defer teardown() - - data_manager_token = "DATA MANAGER TOKEN" testData := PullWorkerTestData{ - name: "TestPullWorker_error_on_put_one_locator", - req: RequestTester{"/pull", data_manager_token, "PUT", second_pull_list}, - response_code: http.StatusOK, - response_body: "Received 1 pull requests\n", - read_content: "hello hello", - read_error: false, - put_error: true, + name: "TestPullWorker_error_on_put_one_locator", + req: RequestTester{"/pull", s.cluster.SystemRootToken, "PUT", secondPullList, ""}, + responseCode: http.StatusOK, + responseBody: "Received 1 pull requests\n", + readContent: "hello hello", + readError: false, + putError: true, } - performTest(testData, c) + s.performTest(testData, c) } func (s *PullWorkerTestSuite) TestPullWorker_error_on_put_two_locators(c *C) { - defer teardown() - - data_manager_token = "DATA MANAGER TOKEN" - testData := PullWorkerTestData{ - name: "TestPullWorker_error_on_put_two_locators", - req: RequestTester{"/pull", data_manager_token, "PUT", first_pull_list}, - response_code: http.StatusOK, - response_body: "Received 2 pull requests\n", - read_content: "hello again", - read_error: false, - put_error: true, - } - - performTest(testData, c) -} - -// When a new pull request arrives, the old one is replaced. This test -// is used to check that behavior by first putting an item on the queue, -// and then performing the test. Thus the "testPullLists" has two entries; -// however, processedPullLists will see only the newest item in the list. -func (s *PullWorkerTestSuite) TestPullWorker_pull_list_with_two_items_latest_replacing_old(c *C) { - defer teardown() - - var firstInput = []int{1} - pullq = NewWorkQueue() - pullq.ReplaceQueue(makeTestWorkList(firstInput)) - testPullLists["Added_before_actual_test_item"] = string(1) - - data_manager_token = "DATA MANAGER TOKEN" testData := PullWorkerTestData{ - name: "TestPullWorker_pull_list_with_two_items_latest_replacing_old", - req: RequestTester{"/pull", data_manager_token, "PUT", second_pull_list}, - response_code: http.StatusOK, - response_body: "Received 1 pull requests\n", - read_content: "hola de nuevo", - read_error: false, - put_error: false, + name: "TestPullWorker_error_on_put_two_locators", + req: RequestTester{"/pull", s.cluster.SystemRootToken, "PUT", firstPullList, ""}, + responseCode: http.StatusOK, + responseBody: "Received 2 pull requests\n", + readContent: "hello again", + readError: false, + putError: true, } - performTest(testData, c) + s.performTest(testData, c) } // In this case, the item will not be placed on pullq -func (s *PullWorkerTestSuite) TestPullWorker_invalid_data_manager_token(c *C) { - defer teardown() - - data_manager_token = "DATA MANAGER TOKEN" - +func (s *PullWorkerTestSuite) TestPullWorker_invalidToken(c *C) { testData := PullWorkerTestData{ - name: "TestPullWorker_pull_list_with_two_locators", - req: RequestTester{"/pull", "invalid_data_manager_token", "PUT", first_pull_list}, - response_code: http.StatusUnauthorized, - response_body: "Unauthorized\n", - read_content: "hello", - read_error: false, - put_error: false, + name: "TestPullWorkerPullList_with_two_locators", + req: RequestTester{"/pull", "invalidToken", "PUT", firstPullList, ""}, + responseCode: http.StatusUnauthorized, + responseBody: "Unauthorized\n", + readContent: "hello", + readError: false, + putError: false, } - performTest(testData, c) + s.performTest(testData, c) } -func performTest(testData PullWorkerTestData, c *C) { - KeepVM = MakeTestVolumeManager(2) - defer KeepVM.Close() - - RunTestPullWorker(c) - defer pullq.Close() +func (s *PullWorkerTestSuite) performTest(testData PullWorkerTestData, c *C) { + pullq := s.handler.Handler.(*router).pullq - currentTestData = testData - testPullLists[testData.name] = testData.response_body + s.testPullLists[testData.name] = testData.responseBody processedPullLists := make(map[string]string) @@ -252,83 +244,72 @@ func performTest(testData PullWorkerTestData, c *C) { GetContent = orig }(GetContent) GetContent = func(signedLocator string, keepClient *keepclient.KeepClient) (reader io.ReadCloser, contentLength int64, url string, err error) { - c.Assert(getStatusItem("PullQueue", "InProgress"), Equals, float64(1)) - processedPullLists[testData.name] = testData.response_body - if testData.read_error { + c.Assert(getStatusItem(s.handler, "PullQueue", "InProgress"), Equals, float64(1)) + processedPullLists[testData.name] = testData.responseBody + if testData.readError { err = errors.New("Error getting data") - readError = err - return nil, 0, "", err - } else { - readContent = testData.read_content - cb := &ClosingBuffer{bytes.NewBufferString(testData.read_content)} - var rc io.ReadCloser - rc = cb - return rc, int64(len(testData.read_content)), "", nil + s.readError = err + return } + s.readContent = testData.readContent + reader = ioutil.NopCloser(bytes.NewBufferString(testData.readContent)) + contentLength = int64(len(testData.readContent)) + return } - // Override PutContent to mock PutBlock functionality - defer func(orig func([]byte, string) error) { PutContent = orig }(PutContent) - PutContent = func(content []byte, locator string) (err error) { - if testData.put_error { - err = errors.New("Error putting data") - putError = err - return err - } else { - putContent = content - return nil + // Override writePulledBlock to mock PutBlock functionality + defer func(orig func(*RRVolumeManager, Volume, []byte, string) error) { writePulledBlock = orig }(writePulledBlock) + writePulledBlock = func(_ *RRVolumeManager, v Volume, content []byte, locator string) error { + if testData.putError { + s.putError = errors.New("Error putting data") + return s.putError } + s.putContent = content + return nil } - c.Assert(getStatusItem("PullQueue", "InProgress"), Equals, float64(0)) - c.Assert(getStatusItem("PullQueue", "Queued"), Equals, float64(0)) + c.Check(getStatusItem(s.handler, "PullQueue", "InProgress"), Equals, float64(0)) + c.Check(getStatusItem(s.handler, "PullQueue", "Queued"), Equals, float64(0)) + c.Check(getStatusItem(s.handler, "Version"), Not(Equals), "") - response := IssueRequest(&testData.req) - c.Assert(response.Code, Equals, testData.response_code) - c.Assert(response.Body.String(), Equals, testData.response_body) + response := IssueRequest(s.handler, &testData.req) + c.Assert(response.Code, Equals, testData.responseCode) + c.Assert(response.Body.String(), Equals, testData.responseBody) expectEqualWithin(c, time.Second, 0, func() interface{} { st := pullq.Status() return st.InProgress + st.Queued }) - if testData.name == "TestPullWorker_pull_list_with_two_items_latest_replacing_old" { - c.Assert(len(testPullLists), Equals, 2) + if testData.name == "TestPullWorkerPullList_with_two_items_latest_replacing_old" { + c.Assert(len(s.testPullLists), Equals, 2) c.Assert(len(processedPullLists), Equals, 1) - c.Assert(testPullLists["Added_before_actual_test_item"], NotNil) - c.Assert(testPullLists["TestPullWorker_pull_list_with_two_items_latest_replacing_old"], NotNil) - c.Assert(processedPullLists["TestPullWorker_pull_list_with_two_items_latest_replacing_old"], NotNil) + c.Assert(s.testPullLists["Added_before_actual_test_item"], NotNil) + c.Assert(s.testPullLists["TestPullWorkerPullList_with_two_items_latest_replacing_old"], NotNil) + c.Assert(processedPullLists["TestPullWorkerPullList_with_two_items_latest_replacing_old"], NotNil) } else { - if testData.response_code == http.StatusOK { - c.Assert(len(testPullLists), Equals, 1) + if testData.responseCode == http.StatusOK { + c.Assert(len(s.testPullLists), Equals, 1) c.Assert(len(processedPullLists), Equals, 1) - c.Assert(testPullLists[testData.name], NotNil) + c.Assert(s.testPullLists[testData.name], NotNil) } else { - c.Assert(len(testPullLists), Equals, 1) + c.Assert(len(s.testPullLists), Equals, 1) c.Assert(len(processedPullLists), Equals, 0) } } - if testData.read_error { - c.Assert(readError, NotNil) - } else if testData.response_code == http.StatusOK { - c.Assert(readError, IsNil) - c.Assert(readContent, Equals, testData.read_content) - if testData.put_error { - c.Assert(putError, NotNil) + if testData.readError { + c.Assert(s.readError, NotNil) + } else if testData.responseCode == http.StatusOK { + c.Assert(s.readError, IsNil) + c.Assert(s.readContent, Equals, testData.readContent) + if testData.putError { + c.Assert(s.putError, NotNil) } else { - c.Assert(putError, IsNil) - c.Assert(string(putContent), Equals, testData.read_content) + c.Assert(s.putError, IsNil) + c.Assert(string(s.putContent), Equals, testData.readContent) } } expectChannelEmpty(c, pullq.NextItem) } - -type ClosingBuffer struct { - *bytes.Buffer -} - -func (cb *ClosingBuffer) Close() (err error) { - return -}