X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/0041395d00cda5ddeb488dae2d9fae7b6b437c9d..d137cbc6cfdcc541216e68d414c535626e4d8916:/services/keepstore/handler_test.go diff --git a/services/keepstore/handler_test.go b/services/keepstore/handler_test.go index 4ea4329bd3..7c17424ba5 100644 --- a/services/keepstore/handler_test.go +++ b/services/keepstore/handler_test.go @@ -54,11 +54,11 @@ func TestGetHandler(t *testing.T) { // Turn on permission settings so we can generate signed locators. enforcePermissions = true PermissionSecret = []byte(knownKey) - blob_signature_ttl = 300 * time.Second + blobSignatureTTL = 300 * time.Second var ( unsignedLocator = "/" + TestHash - validTimestamp = time.Now().Add(blob_signature_ttl) + validTimestamp = time.Now().Add(blobSignatureTTL) expiredTimestamp = time.Now().Add(-time.Hour) signedLocator = "/" + SignLocator(TestHash, knownToken, validTimestamp) expiredLocator = "/" + SignLocator(TestHash, knownToken, expiredTimestamp) @@ -176,7 +176,7 @@ func TestPutHandler(t *testing.T) { // With a server key. PermissionSecret = []byte(knownKey) - blob_signature_ttl = 300 * time.Second + blobSignatureTTL = 300 * time.Second // When a permission key is available, the locator returned // from an authenticated PUT request will be signed. @@ -220,7 +220,7 @@ func TestPutHandler(t *testing.T) { func TestPutAndDeleteSkipReadonlyVolumes(t *testing.T) { defer teardown() - data_manager_token = "fake-data-manager-token" + dataManagerToken = "fake-data-manager-token" vols := []*MockVolume{CreateMockVolume(), CreateMockVolume()} vols[0].Readonly = true KeepVM = MakeRRVolumeManager([]Volume{vols[0], vols[1]}) @@ -232,15 +232,15 @@ func TestPutAndDeleteSkipReadonlyVolumes(t *testing.T) { requestBody: TestBlock, }) defer func(orig bool) { - never_delete = orig - }(never_delete) - never_delete = false + neverDelete = orig + }(neverDelete) + neverDelete = false IssueRequest( &RequestTester{ method: "DELETE", uri: "/" + TestHash, requestBody: TestBlock, - apiToken: data_manager_token, + apiToken: dataManagerToken, }) type expect struct { volnum int @@ -291,7 +291,7 @@ func TestIndexHandler(t *testing.T) { vols[0].Put(TestHash+".meta", []byte("metadata")) vols[1].Put(TestHash2+".meta", []byte("metadata")) - data_manager_token = "DATA MANAGER TOKEN" + dataManagerToken = "DATA MANAGER TOKEN" unauthenticatedReq := &RequestTester{ method: "GET", @@ -305,7 +305,7 @@ func TestIndexHandler(t *testing.T) { superuserReq := &RequestTester{ method: "GET", uri: "/index", - apiToken: data_manager_token, + apiToken: dataManagerToken, } unauthPrefixReq := &RequestTester{ method: "GET", @@ -319,7 +319,17 @@ func TestIndexHandler(t *testing.T) { superuserPrefixReq := &RequestTester{ method: "GET", uri: "/index/" + TestHash[0:3], - apiToken: data_manager_token, + apiToken: dataManagerToken, + } + superuserNoSuchPrefixReq := &RequestTester{ + method: "GET", + uri: "/index/abcd", + apiToken: dataManagerToken, + } + superuserInvalidPrefixReq := &RequestTester{ + method: "GET", + uri: "/index/xyz", + apiToken: dataManagerToken, } // ------------------------------------------------------------- @@ -407,6 +417,26 @@ func TestIndexHandler(t *testing.T) { "permissions on, superuser /index/prefix request: expected %s, got:\n%s", expected, response.Body.String()) } + + // superuser /index/{no-such-prefix} request + // => OK + response = IssueRequest(superuserNoSuchPrefixReq) + ExpectStatusCode(t, + "permissions on, superuser request", + http.StatusOK, + response) + + if "\n" != response.Body.String() { + t.Errorf("Expected empty response for %s. Found %s", superuserNoSuchPrefixReq.uri, response.Body.String()) + } + + // superuser /index/{invalid-prefix} request + // => StatusBadRequest + response = IssueRequest(superuserInvalidPrefixReq) + ExpectStatusCode(t, + "permissions on, superuser request", + http.StatusBadRequest, + response) } // TestDeleteHandler @@ -447,15 +477,15 @@ func TestDeleteHandler(t *testing.T) { vols := KeepVM.AllWritable() vols[0].Put(TestHash, TestBlock) - // Explicitly set the blob_signature_ttl to 0 for these + // Explicitly set the blobSignatureTTL to 0 for these // tests, to ensure the MockVolume deletes the blocks // even though they have just been created. - blob_signature_ttl = time.Duration(0) + blobSignatureTTL = time.Duration(0) var userToken = "NOT DATA MANAGER TOKEN" - data_manager_token = "DATA MANAGER TOKEN" + dataManagerToken = "DATA MANAGER TOKEN" - never_delete = false + neverDelete = false unauthReq := &RequestTester{ method: "DELETE", @@ -471,13 +501,13 @@ func TestDeleteHandler(t *testing.T) { superuserExistingBlockReq := &RequestTester{ method: "DELETE", uri: "/" + TestHash, - apiToken: data_manager_token, + apiToken: dataManagerToken, } superuserNonexistentBlockReq := &RequestTester{ method: "DELETE", uri: "/" + TestHash2, - apiToken: data_manager_token, + apiToken: dataManagerToken, } // Unauthenticated request returns PermissionError. @@ -508,14 +538,14 @@ func TestDeleteHandler(t *testing.T) { http.StatusNotFound, response) - // Authenticated admin request for existing block while never_delete is set. - never_delete = true + // Authenticated admin request for existing block while neverDelete is set. + neverDelete = true response = IssueRequest(superuserExistingBlockReq) ExpectStatusCode(t, "authenticated request, existing block, method disabled", MethodDisabledError.HTTPCode, response) - never_delete = false + neverDelete = false // Authenticated admin request for existing block. response = IssueRequest(superuserExistingBlockReq) @@ -531,16 +561,17 @@ func TestDeleteHandler(t *testing.T) { expectedDc, responseDc) } // Confirm the block has been deleted - _, err := vols[0].Get(TestHash) + buf := make([]byte, BlockSize) + _, err := vols[0].Get(TestHash, buf) var blockDeleted = os.IsNotExist(err) if !blockDeleted { t.Error("superuserExistingBlockReq: block not deleted") } - // A DELETE request on a block newer than blob_signature_ttl + // A DELETE request on a block newer than blobSignatureTTL // should return success but leave the block on the volume. vols[0].Put(TestHash, TestBlock) - blob_signature_ttl = time.Hour + blobSignatureTTL = time.Hour response = IssueRequest(superuserExistingBlockReq) ExpectStatusCode(t, @@ -555,7 +586,7 @@ func TestDeleteHandler(t *testing.T) { expectedDc, responseDc) } // Confirm the block has NOT been deleted. - _, err = vols[0].Get(TestHash) + _, err = vols[0].Get(TestHash, buf) if err != nil { t.Errorf("testing delete on new block: %s\n", err) } @@ -592,7 +623,7 @@ func TestPullHandler(t *testing.T) { defer teardown() var userToken = "USER TOKEN" - data_manager_token = "DATA MANAGER TOKEN" + dataManagerToken = "DATA MANAGER TOKEN" pullq = NewWorkQueue() @@ -637,13 +668,13 @@ func TestPullHandler(t *testing.T) { }, { "Valid pull request from the data manager", - RequestTester{"/pull", data_manager_token, "PUT", goodJSON}, + RequestTester{"/pull", dataManagerToken, "PUT", goodJSON}, http.StatusOK, "Received 3 pull requests\n", }, { "Invalid pull request from the data manager", - RequestTester{"/pull", data_manager_token, "PUT", badJSON}, + RequestTester{"/pull", dataManagerToken, "PUT", badJSON}, http.StatusBadRequest, "", }, @@ -698,7 +729,7 @@ func TestTrashHandler(t *testing.T) { defer teardown() var userToken = "USER TOKEN" - data_manager_token = "DATA MANAGER TOKEN" + dataManagerToken = "DATA MANAGER TOKEN" trashq = NewWorkQueue() @@ -741,13 +772,13 @@ func TestTrashHandler(t *testing.T) { }, { "Valid trash list from the data manager", - RequestTester{"/trash", data_manager_token, "PUT", goodJSON}, + RequestTester{"/trash", dataManagerToken, "PUT", goodJSON}, http.StatusOK, "Received 3 trash requests\n", }, { "Invalid trash list from the data manager", - RequestTester{"/trash", data_manager_token, "PUT", badJSON}, + RequestTester{"/trash", dataManagerToken, "PUT", badJSON}, http.StatusBadRequest, "", }, @@ -784,7 +815,7 @@ func IssueRequest(rt *RequestTester) *httptest.ResponseRecorder { if rt.apiToken != "" { req.Header.Set("Authorization", "OAuth2 "+rt.apiToken) } - loggingRouter := MakeLoggingRESTRouter() + loggingRouter := MakeRESTRouter() loggingRouter.ServeHTTP(response, req) return response } @@ -883,6 +914,65 @@ func TestPutHandlerNoBufferleak(t *testing.T) { } } +type notifyingResponseRecorder struct { + *httptest.ResponseRecorder + closer chan bool +} + +func (r *notifyingResponseRecorder) CloseNotify() <-chan bool { + return r.closer +} + +func TestGetHandlerClientDisconnect(t *testing.T) { + defer func(was bool) { + enforcePermissions = was + }(enforcePermissions) + enforcePermissions = false + + defer func(orig *bufferPool) { + bufs = orig + }(bufs) + bufs = newBufferPool(1, BlockSize) + defer bufs.Put(bufs.Get(BlockSize)) + + KeepVM = MakeTestVolumeManager(2) + defer KeepVM.Close() + + if err := KeepVM.AllWritable()[0].Put(TestHash, TestBlock); err != nil { + t.Error(err) + } + + resp := ¬ifyingResponseRecorder{ + ResponseRecorder: httptest.NewRecorder(), + closer: make(chan bool, 1), + } + if _, ok := http.ResponseWriter(resp).(http.CloseNotifier); !ok { + t.Fatal("notifyingResponseRecorder is broken") + } + // If anyone asks, the client has disconnected. + resp.closer <- true + + ok := make(chan struct{}) + go func() { + req, _ := http.NewRequest("GET", fmt.Sprintf("/%s+%d", TestHash, len(TestBlock)), nil) + (&LoggingRESTRouter{MakeRESTRouter()}).ServeHTTP(resp, req) + ok <- struct{}{} + }() + + select { + case <-time.After(20 * time.Second): + t.Fatal("request took >20s, close notifier must be broken") + case <-ok: + } + + ExpectStatusCode(t, "client disconnect", http.StatusServiceUnavailable, resp.ResponseRecorder) + for i, v := range KeepVM.AllWritable() { + if calls := v.(*MockVolume).called["GET"]; calls != 0 { + t.Errorf("volume %d got %d calls, expected 0", i, calls) + } + } +} + // Invoke the GetBlockHandler a bunch of times to test for bufferpool resource // leak. func TestGetHandlerNoBufferleak(t *testing.T) { @@ -924,3 +1014,122 @@ func TestGetHandlerNoBufferleak(t *testing.T) { case <-ok: } } + +func TestPutReplicationHeader(t *testing.T) { + defer teardown() + + KeepVM = MakeTestVolumeManager(2) + defer KeepVM.Close() + + resp := IssueRequest(&RequestTester{ + method: "PUT", + uri: "/" + TestHash, + requestBody: TestBlock, + }) + if r := resp.Header().Get("X-Keep-Replicas-Stored"); r != "1" { + t.Errorf("Got X-Keep-Replicas-Stored: %q, expected %q", r, "1") + } +} + +func TestUntrashHandler(t *testing.T) { + defer teardown() + + // Set up Keep volumes + KeepVM = MakeTestVolumeManager(2) + defer KeepVM.Close() + vols := KeepVM.AllWritable() + vols[0].Put(TestHash, TestBlock) + + dataManagerToken = "DATA MANAGER TOKEN" + + // unauthenticatedReq => UnauthorizedError + unauthenticatedReq := &RequestTester{ + method: "PUT", + uri: "/untrash/" + TestHash, + } + response := IssueRequest(unauthenticatedReq) + ExpectStatusCode(t, + "Unauthenticated request", + UnauthorizedError.HTTPCode, + response) + + // notDataManagerReq => UnauthorizedError + notDataManagerReq := &RequestTester{ + method: "PUT", + uri: "/untrash/" + TestHash, + apiToken: knownToken, + } + + response = IssueRequest(notDataManagerReq) + ExpectStatusCode(t, + "Non-datamanager token", + UnauthorizedError.HTTPCode, + response) + + // datamanagerWithBadHashReq => StatusBadRequest + datamanagerWithBadHashReq := &RequestTester{ + method: "PUT", + uri: "/untrash/thisisnotalocator", + apiToken: dataManagerToken, + } + response = IssueRequest(datamanagerWithBadHashReq) + ExpectStatusCode(t, + "Bad locator in untrash request", + http.StatusBadRequest, + response) + + // datamanagerWrongMethodReq => StatusBadRequest + datamanagerWrongMethodReq := &RequestTester{ + method: "GET", + uri: "/untrash/" + TestHash, + apiToken: dataManagerToken, + } + response = IssueRequest(datamanagerWrongMethodReq) + ExpectStatusCode(t, + "Only PUT method is supported for untrash", + http.StatusBadRequest, + response) + + // datamanagerReq => StatusOK + datamanagerReq := &RequestTester{ + method: "PUT", + uri: "/untrash/" + TestHash, + apiToken: dataManagerToken, + } + response = IssueRequest(datamanagerReq) + ExpectStatusCode(t, + "", + http.StatusOK, + response) + expected := "Successfully untrashed on: [MockVolume],[MockVolume]" + if response.Body.String() != expected { + t.Errorf( + "Untrash response mismatched: expected %s, got:\n%s", + expected, response.Body.String()) + } +} + +func TestUntrashHandlerWithNoWritableVolumes(t *testing.T) { + defer teardown() + + // Set up readonly Keep volumes + vols := []*MockVolume{CreateMockVolume(), CreateMockVolume()} + vols[0].Readonly = true + vols[1].Readonly = true + KeepVM = MakeRRVolumeManager([]Volume{vols[0], vols[1]}) + defer KeepVM.Close() + + dataManagerToken = "DATA MANAGER TOKEN" + + // datamanagerReq => StatusOK + datamanagerReq := &RequestTester{ + method: "PUT", + uri: "/untrash/" + TestHash, + apiToken: dataManagerToken, + } + response := IssueRequest(datamanagerReq) + ExpectStatusCode(t, + "No writable volumes", + http.StatusNotFound, + response) +}