Refactor the multi-host salt install page.
[arvados.git] / services / keepstore / pull_worker_test.go
index 0bdb886b95558669dc8dfcbf69b08f7c94c15b5e..2626e66d8898745b9f29c42d9beda9ee580626a4 100644 (file)
-package main
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: AGPL-3.0
+
+package keepstore
 
 import (
+       "bytes"
+       "context"
        "errors"
+       "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"
 )
 
-func TestPullWorker(t *testing.T) {
-       defer teardown()
+var _ = Suite(&PullWorkerTestSuite{})
+
+type PullWorkerTestSuite struct {
+       cluster *arvados.Cluster
+       handler *handler
+
+       testPullLists map[string]string
+       readContent   string
+       readError     error
+       putContent    []byte
+       putError      error
+}
+
+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
+
+       s.handler = &handler{}
+       c.Assert(s.handler.setup(context.Background(), s.cluster, "", prometheus.NewRegistry(), testServiceURL), check.IsNil)
 
-       // Since keepstore does not come into picture in tests,
-       // we need to explicitly start the goroutine in tests.
-       go RunPullWorker(pullq.NextItem)
+       s.readContent = ""
+       s.readError = nil
+       s.putContent = []byte{}
+       s.putError = nil
 
-       data_manager_token = "DATA MANAGER TOKEN"
+       // When a new pull request arrives, the old one will be overwritten.
+       // This behavior is verified using these two maps in the
+       // "TestPullWorkerPullList_with_two_items_latest_replacing_old"
+       s.testPullLists = make(map[string]string)
+}
 
-       first_pull_list := []byte(`[
+var firstPullList = []byte(`[
                {
-                       "locator":"locator1_to_verify_first_pull_list",
+                       "locator":"acbd18db4cc2f85cedef654fccc4a4d8+3",
                        "servers":[
                                "server_1",
                                "server_2"
                        ]
-               },
-    {
-                       "locator":"locator2_to_verify_first_pull_list",
+               },{
+                       "locator":"37b51d194a7513e45b56f6524f2d51f2+3",
                        "servers":[
-                               "server_1"
+                               "server_3"
                        ]
                }
        ]`)
 
-       second_pull_list := []byte(`[
+var secondPullList = []byte(`[
                {
-                       "locator":"locator_to_verify_second_pull_list",
+                       "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
-       }
-       var testcases = []PullWorkerTestData{
-               {
-                       "Pull request 1 from the data manager in worker",
-                       RequestTester{"/pull", data_manager_token, "PUT", first_pull_list},
-                       http.StatusOK,
-                       "Received 2 pull requests\n",
-                       "hello",
-                       false,
-                       false,
-               },
-               {
-                       "Pull request 2 from the data manager in worker",
-                       RequestTester{"/pull", data_manager_token, "PUT", second_pull_list},
-                       http.StatusOK,
-                       "Received 1 pull requests\n",
-                       "hola",
-                       false,
-                       false,
-               },
+type PullWorkerTestData struct {
+       name         string
+       req          RequestTester
+       responseCode int
+       responseBody string
+       readContent  string
+       readError    bool
+       putError     bool
+}
+
+// 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
+       }{
                {
-                       "Pull request with error on get",
-                       RequestTester{"/pull", data_manager_token, "PUT", second_pull_list},
-                       http.StatusOK,
-                       "Received 1 pull requests\n",
-                       "unused",
-                       true,
-                       false,
+                       sendUUID:     "",
+                       expectVolume: nil,
                },
                {
-                       "Pull request with error on put",
-                       RequestTester{"/pull", data_manager_token, "PUT", second_pull_list},
-                       http.StatusOK,
-                       "Received 1 pull requests\n",
-                       "unused",
-                       false,
-                       true,
+                       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
+               })
+       }
+}
+
+func (s *PullWorkerTestSuite) TestPullWorkerPullList_with_two_locators(c *C) {
+       testData := PullWorkerTestData{
+               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,
        }
 
-       for _, testData := range testcases {
-               // Override GetContent to mock keepclient functionality
-               GetContent = func(addr string, locator string) ([]byte, error) {
-                       if testData.read_error {
-                               return nil, errors.New("Error getting data")
-                       } else {
-                               return []byte(testData.read_content), nil
-                       }
+       s.performTest(testData, c)
+}
+
+func (s *PullWorkerTestSuite) TestPullWorkerPullList_with_one_locator(c *C) {
+       testData := PullWorkerTestData{
+               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,
+       }
+
+       s.performTest(testData, c)
+}
+
+func (s *PullWorkerTestSuite) TestPullWorker_error_on_get_one_locator(c *C) {
+       testData := PullWorkerTestData{
+               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,
+       }
+
+       s.performTest(testData, c)
+}
+
+func (s *PullWorkerTestSuite) TestPullWorker_error_on_get_two_locators(c *C) {
+       testData := PullWorkerTestData{
+               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,
+       }
+
+       s.performTest(testData, c)
+}
+
+func (s *PullWorkerTestSuite) TestPullWorker_error_on_put_one_locator(c *C) {
+       testData := PullWorkerTestData{
+               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,
+       }
+
+       s.performTest(testData, c)
+}
+
+func (s *PullWorkerTestSuite) TestPullWorker_error_on_put_two_locators(c *C) {
+       testData := PullWorkerTestData{
+               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,
+       }
+
+       s.performTest(testData, c)
+}
+
+// In this case, the item will not be placed on pullq
+func (s *PullWorkerTestSuite) TestPullWorker_invalidToken(c *C) {
+       testData := PullWorkerTestData{
+               name:         "TestPullWorkerPullList_with_two_locators",
+               req:          RequestTester{"/pull", "invalidToken", "PUT", firstPullList, ""},
+               responseCode: http.StatusUnauthorized,
+               responseBody: "Unauthorized\n",
+               readContent:  "hello",
+               readError:    false,
+               putError:     false,
+       }
+
+       s.performTest(testData, c)
+}
+
+func (s *PullWorkerTestSuite) performTest(testData PullWorkerTestData, c *C) {
+       pullq := s.handler.Handler.(*router).pullq
+
+       s.testPullLists[testData.name] = testData.responseBody
+
+       processedPullLists := make(map[string]string)
+
+       // Override GetContent to mock keepclient Get functionality
+       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(s.handler, "PullQueue", "InProgress"), Equals, float64(1))
+               processedPullLists[testData.name] = testData.responseBody
+               if testData.readError {
+                       err = errors.New("Error getting data")
+                       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 {
-                               return errors.New("Error putting data")
-                       } else {
-                               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.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)
-               ExpectStatusCode(t, testData.name, testData.response_code, response)
-               ExpectBody(t, testData.name, testData.response_body, response)
+       response := IssueRequest(s.handler, &testData.req)
+       c.Assert(response.Code, Equals, testData.responseCode)
+       c.Assert(response.Body.String(), Equals, testData.responseBody)
 
-               // give the channel a second to read and process all pull list entries
-               time.Sleep(1000 * time.Millisecond)
+       expectEqualWithin(c, time.Second, 0, func() interface{} {
+               st := pullq.Status()
+               return st.InProgress + st.Queued
+       })
 
-               expectChannelEmpty(t, pullq.NextItem)
+       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(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.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(len(s.testPullLists), Equals, 1)
+                       c.Assert(len(processedPullLists), Equals, 0)
+               }
        }
+
+       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)
+               }
+       }
+
+       expectChannelEmpty(c, pullq.NextItem)
 }