13579: Document ManagementToken. Add information about trash behavior.
[arvados.git] / services / keepstore / pull_worker_integration_test.go
index 27c8fcdc3a197367bb883eef07bdcc562e7b133e..c06bbe05c4b2ecde56efa2143f88382b19205235 100644 (file)
+// Copyright (C) The Arvados Authors. All rights reserved.
+//
+// SPDX-License-Identifier: AGPL-3.0
+
 package main
 
 import (
-       "crypto/tls"
+       "bytes"
+       "errors"
+       "io"
+       "io/ioutil"
+       "os"
+       "strings"
+       "testing"
+
        "git.curoverse.com/arvados.git/sdk/go/arvadosclient"
        "git.curoverse.com/arvados.git/sdk/go/arvadostest"
        "git.curoverse.com/arvados.git/sdk/go/keepclient"
-       "net/http"
-       "os"
-       "testing"
 )
 
-type PullWorkIntegrationTestData struct {
-       Name    string
-       Locator string
-       Content string
-}
-
-func TestPullWorkerIntegration_GetLocator(t *testing.T) {
-       arvadostest.StartAPI()
-       arvadostest.StartKeep()
+var keepClient *keepclient.KeepClient
 
-       testData := PullWorkIntegrationTestData{
-               Name:    "TestPullWorkerIntegration_GetLocator",
-               Locator: "5d41402abc4b2a76b9719d911017c592",
-               Content: "hello",
-       }
-
-       performPullWorkerIntegrationTest(testData, t)
+type PullWorkIntegrationTestData struct {
+       Name     string
+       Locator  string
+       Content  string
+       GetError string
 }
 
-func performPullWorkerIntegrationTest(testData PullWorkIntegrationTestData, t *testing.T) {
+func SetupPullWorkerIntegrationTest(t *testing.T, testData PullWorkIntegrationTestData, wantData bool) PullRequest {
        os.Setenv("ARVADOS_API_HOST_INSECURE", "true")
 
-       PermissionSecret = []byte("abc123")
+       // start api and keep servers
+       arvadostest.StartAPI()
+       arvadostest.StartKeep(2, false)
+       keepclient.RefreshServiceDiscovery()
 
+       // make arvadosclient
        arv, err := arvadosclient.MakeArvadosClient()
        if err != nil {
-               t.Error("Error creating arv")
+               t.Fatalf("Error creating arv: %s", err)
        }
 
-       client := &http.Client{Transport: &http.Transport{
-               TLSClientConfig: &tls.Config{InsecureSkipVerify: true}}}
-
-       keepClient := keepclient.KeepClient{
-               Arvados:       &arv,
-               Want_replicas: 2,
-               Using_proxy:   true,
-               Client:        client,
+       // keep client
+       keepClient, err = keepclient.MakeKeepClient(arv)
+       if err != nil {
+               t.Fatalf("error creating KeepClient: %s", err)
        }
+       keepClient.Want_replicas = 1
 
-       random_token := GenerateRandomApiToken()
-       keepClient.Arvados.ApiToken = random_token
-
-       if err != nil {
-               t.Error("Error creating keepclient")
+       // discover keep services
+       var servers []string
+       for _, host := range keepClient.LocalRoots() {
+               servers = append(servers, host)
        }
 
-       pullq = NewWorkQueue()
-       go RunPullWorker(pullq, keepClient)
+       // Put content if the test needs it
+       if wantData {
+               locator, _, err := keepClient.PutB([]byte(testData.Content))
+               if err != nil {
+                       t.Errorf("Error putting test data in setup for %s %s %v", testData.Content, locator, err)
+               }
+               if locator == "" {
+                       t.Errorf("No locator found after putting test data")
+               }
+       }
 
-       servers := make([]string, 1)
-       servers[0] = "https://" + os.Getenv("ARVADOS_API_HOST") + "/arvados/v1/keep_services"
+       // Create pullRequest for the test
        pullRequest := PullRequest{
                Locator: testData.Locator,
                Servers: servers,
        }
+       return pullRequest
+}
+
+// Do a get on a block that is not existing in any of the keep servers.
+// Expect "block not found" error.
+func TestPullWorkerIntegration_GetNonExistingLocator(t *testing.T) {
+       testData := PullWorkIntegrationTestData{
+               Name:     "TestPullWorkerIntegration_GetLocator",
+               Locator:  "5d41402abc4b2a76b9719d911017c592",
+               Content:  "hello",
+               GetError: "Block not found",
+       }
+
+       pullRequest := SetupPullWorkerIntegrationTest(t, testData, false)
+       defer arvadostest.StopAPI()
+       defer arvadostest.StopKeep(2)
+
+       performPullWorkerIntegrationTest(testData, pullRequest, t)
+}
+
+// Do a get on a block that exists on one of the keep servers.
+// The setup method will create this block before doing the get.
+func TestPullWorkerIntegration_GetExistingLocator(t *testing.T) {
+       testData := PullWorkIntegrationTestData{
+               Name:     "TestPullWorkerIntegration_GetLocator",
+               Locator:  "5d41402abc4b2a76b9719d911017c592",
+               Content:  "hello",
+               GetError: "",
+       }
 
-       PullItemAndProcess(pullRequest, random_token, keepClient)
+       pullRequest := SetupPullWorkerIntegrationTest(t, testData, true)
+       defer arvadostest.StopAPI()
+       defer arvadostest.StopKeep(2)
+
+       performPullWorkerIntegrationTest(testData, pullRequest, t)
+}
 
-       // Override PutContent to mock PutBlock functionality
-       PutContent = func(content []byte, locator string) (err error) {
-               // do nothing
-               return
+// Perform the test.
+// The test directly invokes the "PullItemAndProcess" rather than
+// putting an item on the pullq so that the errors can be verified.
+func performPullWorkerIntegrationTest(testData PullWorkIntegrationTestData, pullRequest PullRequest, t *testing.T) {
+
+       // 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 string(content) != testData.Content {
+                       t.Errorf("writePulledBlock invoked with unexpected data. Expected: %s; Found: %s", testData.Content, content)
+               }
        }
 
-       pullq.Close()
-       pullq = nil
+       // 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) {
+               if testData.GetError != "" {
+                       return nil, 0, "", errors.New(testData.GetError)
+               }
+               rdr := ioutil.NopCloser(bytes.NewBufferString(testData.Content))
+               return rdr, int64(len(testData.Content)), "", nil
+       }
+
+       err := PullItemAndProcess(pullRequest, keepClient)
+
+       if len(testData.GetError) > 0 {
+               if (err == nil) || (!strings.Contains(err.Error(), testData.GetError)) {
+                       t.Errorf("Got error %v, expected %v", err, testData.GetError)
+               }
+       } else {
+               if err != nil {
+                       t.Errorf("Got error %v, expected nil", err)
+               }
+       }
 }