X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/2ae40cbbb77f0843662628732b9ca7679a369749..f1ee0cb2f85c4ea988700da2e3957565b6861ad5:/services/keepstore/pull_worker_test.go diff --git a/services/keepstore/pull_worker_test.go b/services/keepstore/pull_worker_test.go index 820f951568..7b5077c1a7 100644 --- a/services/keepstore/pull_worker_test.go +++ b/services/keepstore/pull_worker_test.go @@ -1,314 +1,316 @@ +// Copyright (C) The Arvados Authors. All rights reserved. +// +// SPDX-License-Identifier: AGPL-3.0 + package main import ( "bytes" "errors" + "io" + "io/ioutil" + "net/http" + "time" + "git.curoverse.com/arvados.git/sdk/go/arvadosclient" "git.curoverse.com/arvados.git/sdk/go/keepclient" . "gopkg.in/check.v1" - "io" - "net/http" - "testing" ) -type PullWorkerTestSuite struct{} - -// Gocheck boilerplate -func TestPullWorker(t *testing.T) { - TestingT(t) -} - -// Gocheck boilerplate var _ = Suite(&PullWorkerTestSuite{}) -var testPullLists map[string]string -var processedPullLists map[string]string -var readContent string -var readError error -var putContent []byte -var putError error -var currentTestData PullWorkerTestData +type PullWorkerTestSuite struct { + testPullLists map[string]string + readContent string + readError error + putContent []byte + putError error +} func (s *PullWorkerTestSuite) SetUpTest(c *C) { - readContent = "" - readError = nil - putContent = []byte("") - putError = nil + theConfig.systemAuthToken = "arbitrary data manager token" + 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) - processedPullLists = 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) + KeepVM = MakeTestVolumeManager(2) + // Normally the pull queue and workers are started by main() + // -- tests need to set up their own. + arv, err := arvadosclient.MakeArvadosClient() + c.Assert(err, IsNil) + keepClient, err := keepclient.MakeKeepClient(arv) + c.Assert(err, IsNil) pullq = NewWorkQueue() go RunPullWorker(pullq, keepClient) } -var first_pull_list = []byte(`[ +func (s *PullWorkerTestSuite) TearDownTest(c *C) { + KeepVM.Close() + KeepVM = nil + pullq.Close() + pullq = nil + teardown() + theConfig = DefaultConfig() + theConfig.Start() +} + +var firstPullList = []byte(`[ { - "locator":"locator1", + "locator":"acbd18db4cc2f85cedef654fccc4a4d8+3", "servers":[ "server_1", "server_2" ] - }, - { - "locator":"locator2", + },{ + "locator":"37b51d194a7513e45b56f6524f2d51f2+3", "servers":[ "server_3" ] } ]`) -var second_pull_list = []byte(`[ +var secondPullList = []byte(`[ { - "locator":"locator3", + "locator":"73feffa4b7f6bb68e44cf984c85f6e88+3", "servers":[ "server_1", - "server_2" + "server_2" ] } ]`) 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(Volume, []byte, string)) { + writePulledBlock = f + }(writePulledBlock) + + for _, spec := range []struct { + sendUUID string + expectVolume Volume + }{ + { + sendUUID: "", + expectVolume: nil, + }, + { + sendUUID: KeepVM.Mounts()[0].UUID, + expectVolume: KeepVM.Mounts()[0].volume, + }, + } { + writePulledBlock = func(v Volume, _ []byte, _ string) { + c.Check(v, Equals, spec.expectVolume) + } + + resp := IssueRequest(&RequestTester{ + uri: "/pull", + apiToken: theConfig.systemAuthToken, + 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", theConfig.systemAuthToken, "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", theConfig.systemAuthToken, "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", theConfig.systemAuthToken, "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", theConfig.systemAuthToken, "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", theConfig.systemAuthToken, "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, + name: "TestPullWorker_error_on_put_two_locators", + req: RequestTester{"/pull", theConfig.systemAuthToken, "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) } -// 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" +// In this case, the item will not be placed on pullq +func (s *PullWorkerTestSuite) TestPullWorker_invalidToken(c *C) { 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: "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) { - RunTestPullWorker(c) +func (s *PullWorkerTestSuite) performTest(testData PullWorkerTestData, c *C) { + s.testPullLists[testData.name] = testData.responseBody - currentTestData = testData - testPullLists[testData.name] = testData.response_body + processedPullLists := make(map[string]string) // Override GetContent to mock keepclient Get functionality - GetContent = func(signedLocator string, keepClient keepclient.KeepClient) ( - reader io.ReadCloser, contentLength int64, url string, err error) { - - processedPullLists[testData.name] = testData.response_body - if testData.read_error { + defer func(orig func(string, *keepclient.KeepClient) (io.ReadCloser, int64, string, error)) { + 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.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 - 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(Volume, []byte, string)) { writePulledBlock = orig }(writePulledBlock) + writePulledBlock = func(v Volume, content []byte, locator string) { + if testData.putError { + s.putError = errors.New("Error putting data") + return } + s.putContent = content } - response := IssueRequest(&testData.req) - c.Assert(testData.response_code, Equals, response.Code) - c.Assert(testData.response_body, Equals, response.Body.String()) + c.Check(getStatusItem("PullQueue", "InProgress"), Equals, float64(0)) + c.Check(getStatusItem("PullQueue", "Queued"), Equals, float64(0)) + c.Check(getStatusItem("Version"), Not(Equals), "") - expectWorkerChannelEmpty(c, pullq.NextItem) + response := IssueRequest(&testData.req) + c.Assert(response.Code, Equals, testData.responseCode) + c.Assert(response.Body.String(), Equals, testData.responseBody) - pullq.Close() + 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 { - c.Assert(len(testPullLists), Equals, 1) - c.Assert(len(processedPullLists), Equals, 1) - c.Assert(testPullLists[testData.name], NotNil) - } - - if testData.read_error { - c.Assert(readError, NotNil) - } else { - c.Assert(readError, IsNil) - c.Assert(readContent, Equals, testData.read_content) - if testData.put_error { - c.Assert(putError, NotNil) + if testData.responseCode == http.StatusOK { + c.Assert(len(s.testPullLists), Equals, 1) + c.Assert(len(processedPullLists), Equals, 1) + c.Assert(s.testPullLists[testData.name], NotNil) } else { - c.Assert(putError, IsNil) - c.Assert(string(putContent), Equals, testData.read_content) + c.Assert(len(s.testPullLists), Equals, 1) + c.Assert(len(processedPullLists), Equals, 0) } } -} - -type ClosingBuffer struct { - *bytes.Buffer -} - -func (cb *ClosingBuffer) Close() (err error) { - return -} - -func expectWorkerChannelEmpty(c *C, workerChannel <-chan interface{}) { - select { - case item := <-workerChannel: - c.Fatalf("Received value (%v) from channel that was expected to be empty", item) - default: + 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(s.putError, IsNil) + c.Assert(string(s.putContent), Equals, testData.readContent) + } } -} -func expectWorkerChannelNotEmpty(c *C, workerChannel <-chan interface{}) { - select { - case item := <-workerChannel: - c.Fatalf("Received value (%v) from channel that was expected to be empty", item) - default: - } + expectChannelEmpty(c, pullq.NextItem) }