services/keepstore/handler_test.go

   1 // Tests for Keep HTTP handlers:
   2 //
   3 //     GetBlockHandler
   4 //     PutBlockHandler
   5 //     IndexHandler
   6 //
   7 // The HTTP handlers are responsible for enforcing permission policy,
   8 // so these tests must exercise all possible permission permutations.
   9
  10 package main
  11
  12 import (
  13         "bytes"
  14         "encoding/json"
  15         "fmt"
  16         "net/http"
  17         "net/http/httptest"
  18         "os"
  19         "regexp"
  20         "strings"
  21         "testing"
  22         "time"
  23 )
  24
  25 // A RequestTester represents the parameters for an HTTP request to
  26 // be issued on behalf of a unit test.
  27 type RequestTester struct {
  28         uri          string
  29         api_token    string
  30         method       string
  31         request_body []byte
  32 }
  33
  34 // Test GetBlockHandler on the following situations:
  35 //   - permissions off, unauthenticated request, unsigned locator
  36 //   - permissions on, authenticated request, signed locator
  37 //   - permissions on, authenticated request, unsigned locator
  38 //   - permissions on, unauthenticated request, signed locator
  39 //   - permissions on, authenticated request, expired locator
  40 //
  41 func TestGetHandler(t *testing.T) {
  42         defer teardown()
  43
  44         // Prepare two test Keep volumes. Our block is stored on the second volume.
  45         KeepVM = MakeTestVolumeManager(2)
  46         defer KeepVM.Quit()
  47
  48         vols := KeepVM.Volumes()
  49         if err := vols[0].Put(TEST_HASH, TEST_BLOCK); err != nil {
  50                 t.Error(err)
  51         }
  52
  53         // Create locators for testing.
  54         // Turn on permission settings so we can generate signed locators.
  55         enforce_permissions = true
  56         PermissionSecret = []byte(known_key)
  57         permission_ttl = time.Duration(300) * time.Second
  58
  59         var (
  60                 unsigned_locator  = "/" + TEST_HASH
  61                 valid_timestamp   = time.Now().Add(permission_ttl)
  62                 expired_timestamp = time.Now().Add(-time.Hour)
  63                 signed_locator    = "/" + SignLocator(TEST_HASH, known_token, valid_timestamp)
  64                 expired_locator   = "/" + SignLocator(TEST_HASH, known_token, expired_timestamp)
  65         )
  66
  67         // -----------------
  68         // Test unauthenticated request with permissions off.
  69         enforce_permissions = false
  70
  71         // Unauthenticated request, unsigned locator
  72         // => OK
  73         response := IssueRequest(
  74                 &RequestTester{
  75                         method: "GET",
  76                         uri:    unsigned_locator,
  77                 })
  78         ExpectStatusCode(t,
  79                 "Unauthenticated request, unsigned locator", http.StatusOK, response)
  80         ExpectBody(t,
  81                 "Unauthenticated request, unsigned locator",
  82                 string(TEST_BLOCK),
  83                 response)
  84         received_xbs := response.Header().Get("X-Block-Size")
  85         expected_xbs := fmt.Sprintf("%d", len(TEST_BLOCK))
  86         if received_xbs != expected_xbs {
  87                 t.Errorf("expected X-Block-Size %s, got %s", expected_xbs, received_xbs)
  88         }
  89
  90         // ----------------
  91         // Permissions: on.
  92         enforce_permissions = true
  93
  94         // Authenticated request, signed locator
  95         // => OK
  96         response = IssueRequest(&RequestTester{
  97                 method:    "GET",
  98                 uri:       signed_locator,
  99                 api_token: known_token,
 100         })
 101         ExpectStatusCode(t,
 102                 "Authenticated request, signed locator", http.StatusOK, response)
 103         ExpectBody(t,
 104                 "Authenticated request, signed locator", string(TEST_BLOCK), response)
 105         received_xbs = response.Header().Get("X-Block-Size")
 106         expected_xbs = fmt.Sprintf("%d", len(TEST_BLOCK))
 107         if received_xbs != expected_xbs {
 108                 t.Errorf("expected X-Block-Size %s, got %s", expected_xbs, received_xbs)
 109         }
 110
 111         // Authenticated request, unsigned locator
 112         // => PermissionError
 113         response = IssueRequest(&RequestTester{
 114                 method:    "GET",
 115                 uri:       unsigned_locator,
 116                 api_token: known_token,
 117         })
 118         ExpectStatusCode(t, "unsigned locator", PermissionError.HTTPCode, response)
 119
 120         // Unauthenticated request, signed locator
 121         // => PermissionError
 122         response = IssueRequest(&RequestTester{
 123                 method: "GET",
 124                 uri:    signed_locator,
 125         })
 126         ExpectStatusCode(t,
 127                 "Unauthenticated request, signed locator",
 128                 PermissionError.HTTPCode, response)
 129
 130         // Authenticated request, expired locator
 131         // => ExpiredError
 132         response = IssueRequest(&RequestTester{
 133                 method:    "GET",
 134                 uri:       expired_locator,
 135                 api_token: known_token,
 136         })
 137         ExpectStatusCode(t,
 138                 "Authenticated request, expired locator",
 139                 ExpiredError.HTTPCode, response)
 140 }
 141
 142 // Test PutBlockHandler on the following situations:
 143 //   - no server key
 144 //   - with server key, authenticated request, unsigned locator
 145 //   - with server key, unauthenticated request, unsigned locator
 146 //
 147 func TestPutHandler(t *testing.T) {
 148         defer teardown()
 149
 150         // Prepare two test Keep volumes.
 151         KeepVM = MakeTestVolumeManager(2)
 152         defer KeepVM.Quit()
 153
 154         // --------------
 155         // No server key.
 156
 157         // Unauthenticated request, no server key
 158         // => OK (unsigned response)
 159         unsigned_locator := "/" + TEST_HASH
 160         response := IssueRequest(
 161                 &RequestTester{
 162                         method:       "PUT",
 163                         uri:          unsigned_locator,
 164                         request_body: TEST_BLOCK,
 165                 })
 166
 167         ExpectStatusCode(t,
 168                 "Unauthenticated request, no server key", http.StatusOK, response)
 169         ExpectBody(t,
 170                 "Unauthenticated request, no server key",
 171                 TEST_HASH_PUT_RESPONSE, response)
 172
 173         // ------------------
 174         // With a server key.
 175
 176         PermissionSecret = []byte(known_key)
 177         permission_ttl = time.Duration(300) * time.Second
 178
 179         // When a permission key is available, the locator returned
 180         // from an authenticated PUT request will be signed.
 181
 182         // Authenticated PUT, signed locator
 183         // => OK (signed response)
 184         response = IssueRequest(
 185                 &RequestTester{
 186                         method:       "PUT",
 187                         uri:          unsigned_locator,
 188                         request_body: TEST_BLOCK,
 189                         api_token:    known_token,
 190                 })
 191
 192         ExpectStatusCode(t,
 193                 "Authenticated PUT, signed locator, with server key",
 194                 http.StatusOK, response)
 195         response_locator := strings.TrimSpace(response.Body.String())
 196         if !VerifySignature(response_locator, known_token) {
 197                 t.Errorf("Authenticated PUT, signed locator, with server key:\n"+
 198                         "response '%s' does not contain a valid signature",
 199                         response_locator)
 200         }
 201
 202         // Unauthenticated PUT, unsigned locator
 203         // => OK
 204         response = IssueRequest(
 205                 &RequestTester{
 206                         method:       "PUT",
 207                         uri:          unsigned_locator,
 208                         request_body: TEST_BLOCK,
 209                 })
 210
 211         ExpectStatusCode(t,
 212                 "Unauthenticated PUT, unsigned locator, with server key",
 213                 http.StatusOK, response)
 214         ExpectBody(t,
 215                 "Unauthenticated PUT, unsigned locator, with server key",
 216                 TEST_HASH_PUT_RESPONSE, response)
 217 }
 218
 219 // Test /index requests:
 220 //   - unauthenticated /index request
 221 //   - unauthenticated /index/prefix request
 222 //   - authenticated   /index request        | non-superuser
 223 //   - authenticated   /index/prefix request | non-superuser
 224 //   - authenticated   /index request        | superuser
 225 //   - authenticated   /index/prefix request | superuser
 226 //
 227 // The only /index requests that should succeed are those issued by the
 228 // superuser. They should pass regardless of the value of enforce_permissions.
 229 //
 230 func TestIndexHandler(t *testing.T) {
 231         defer teardown()
 232
 233         // Set up Keep volumes and populate them.
 234         // Include multiple blocks on different volumes, and
 235         // some metadata files (which should be omitted from index listings)
 236         KeepVM = MakeTestVolumeManager(2)
 237         defer KeepVM.Quit()
 238
 239         vols := KeepVM.Volumes()
 240         vols[0].Put(TEST_HASH, TEST_BLOCK)
 241         vols[1].Put(TEST_HASH_2, TEST_BLOCK_2)
 242         vols[0].Put(TEST_HASH+".meta", []byte("metadata"))
 243         vols[1].Put(TEST_HASH_2+".meta", []byte("metadata"))
 244
 245         data_manager_token = "DATA MANAGER TOKEN"
 246
 247         unauthenticated_req := &RequestTester{
 248                 method: "GET",
 249                 uri:    "/index",
 250         }
 251         authenticated_req := &RequestTester{
 252                 method:    "GET",
 253                 uri:       "/index",
 254                 api_token: known_token,
 255         }
 256         superuser_req := &RequestTester{
 257                 method:    "GET",
 258                 uri:       "/index",
 259                 api_token: data_manager_token,
 260         }
 261         unauth_prefix_req := &RequestTester{
 262                 method: "GET",
 263                 uri:    "/index/" + TEST_HASH[0:3],
 264         }
 265         auth_prefix_req := &RequestTester{
 266                 method:    "GET",
 267                 uri:       "/index/" + TEST_HASH[0:3],
 268                 api_token: known_token,
 269         }
 270         superuser_prefix_req := &RequestTester{
 271                 method:    "GET",
 272                 uri:       "/index/" + TEST_HASH[0:3],
 273                 api_token: data_manager_token,
 274         }
 275
 276         // -------------------------------------------------------------
 277         // Only the superuser should be allowed to issue /index requests.
 278
 279         // ---------------------------
 280         // enforce_permissions enabled
 281         // This setting should not affect tests passing.
 282         enforce_permissions = true
 283
 284         // unauthenticated /index request
 285         // => UnauthorizedError
 286         response := IssueRequest(unauthenticated_req)
 287         ExpectStatusCode(t,
 288                 "enforce_permissions on, unauthenticated request",
 289                 UnauthorizedError.HTTPCode,
 290                 response)
 291
 292         // unauthenticated /index/prefix request
 293         // => UnauthorizedError
 294         response = IssueRequest(unauth_prefix_req)
 295         ExpectStatusCode(t,
 296                 "permissions on, unauthenticated /index/prefix request",
 297                 UnauthorizedError.HTTPCode,
 298                 response)
 299
 300         // authenticated /index request, non-superuser
 301         // => UnauthorizedError
 302         response = IssueRequest(authenticated_req)
 303         ExpectStatusCode(t,
 304                 "permissions on, authenticated request, non-superuser",
 305                 UnauthorizedError.HTTPCode,
 306                 response)
 307
 308         // authenticated /index/prefix request, non-superuser
 309         // => UnauthorizedError
 310         response = IssueRequest(auth_prefix_req)
 311         ExpectStatusCode(t,
 312                 "permissions on, authenticated /index/prefix request, non-superuser",
 313                 UnauthorizedError.HTTPCode,
 314                 response)
 315
 316         // superuser /index request
 317         // => OK
 318         response = IssueRequest(superuser_req)
 319         ExpectStatusCode(t,
 320                 "permissions on, superuser request",
 321                 http.StatusOK,
 322                 response)
 323
 324         // ----------------------------
 325         // enforce_permissions disabled
 326         // Valid Request should still pass.
 327         enforce_permissions = false
 328
 329         // superuser /index request
 330         // => OK
 331         response = IssueRequest(superuser_req)
 332         ExpectStatusCode(t,
 333                 "permissions on, superuser request",
 334                 http.StatusOK,
 335                 response)
 336
 337         expected := `^` + TEST_HASH + `\+\d+ \d+\n` +
 338                 TEST_HASH_2 + `\+\d+ \d+\n$`
 339         match, _ := regexp.MatchString(expected, response.Body.String())
 340         if !match {
 341                 t.Errorf(
 342                         "permissions on, superuser request: expected %s, got:\n%s",
 343                         expected, response.Body.String())
 344         }
 345
 346         // superuser /index/prefix request
 347         // => OK
 348         response = IssueRequest(superuser_prefix_req)
 349         ExpectStatusCode(t,
 350                 "permissions on, superuser request",
 351                 http.StatusOK,
 352                 response)
 353
 354         expected = `^` + TEST_HASH + `\+\d+ \d+\n$`
 355         match, _ = regexp.MatchString(expected, response.Body.String())
 356         if !match {
 357                 t.Errorf(
 358                         "permissions on, superuser /index/prefix request: expected %s, got:\n%s",
 359                         expected, response.Body.String())
 360         }
 361 }
 362
 363 // TestDeleteHandler
 364 //
 365 // Cases tested:
 366 //
 367 //   With no token and with a non-data-manager token:
 368 //   * Delete existing block
 369 //     (test for 403 Forbidden, confirm block not deleted)
 370 //
 371 //   With data manager token:
 372 //
 373 //   * Delete existing block
 374 //     (test for 200 OK, response counts, confirm block deleted)
 375 //
 376 //   * Delete nonexistent block
 377 //     (test for 200 OK, response counts)
 378 //
 379 //   TODO(twp):
 380 //
 381 //   * Delete block on read-only and read-write volume
 382 //     (test for 200 OK, response with copies_deleted=1,
 383 //     copies_failed=1, confirm block deleted only on r/w volume)
 384 //
 385 //   * Delete block on read-only volume only
 386 //     (test for 200 OK, response with copies_deleted=0, copies_failed=1,
 387 //     confirm block not deleted)
 388 //
 389 func TestDeleteHandler(t *testing.T) {
 390         defer teardown()
 391
 392         // Set up Keep volumes and populate them.
 393         // Include multiple blocks on different volumes, and
 394         // some metadata files (which should be omitted from index listings)
 395         KeepVM = MakeTestVolumeManager(2)
 396         defer KeepVM.Quit()
 397
 398         vols := KeepVM.Volumes()
 399         vols[0].Put(TEST_HASH, TEST_BLOCK)
 400
 401         // Explicitly set the permission_ttl to 0 for these
 402         // tests, to ensure the MockVolume deletes the blocks
 403         // even though they have just been created.
 404         permission_ttl = time.Duration(0)
 405
 406         var user_token = "NOT DATA MANAGER TOKEN"
 407         data_manager_token = "DATA MANAGER TOKEN"
 408
 409         unauth_req := &RequestTester{
 410                 method: "DELETE",
 411                 uri:    "/" + TEST_HASH,
 412         }
 413
 414         user_req := &RequestTester{
 415                 method:    "DELETE",
 416                 uri:       "/" + TEST_HASH,
 417                 api_token: user_token,
 418         }
 419
 420         superuser_existing_block_req := &RequestTester{
 421                 method:    "DELETE",
 422                 uri:       "/" + TEST_HASH,
 423                 api_token: data_manager_token,
 424         }
 425
 426         superuser_nonexistent_block_req := &RequestTester{
 427                 method:    "DELETE",
 428                 uri:       "/" + TEST_HASH_2,
 429                 api_token: data_manager_token,
 430         }
 431
 432         // Unauthenticated request returns PermissionError.
 433         var response *httptest.ResponseRecorder
 434         response = IssueRequest(unauth_req)
 435         ExpectStatusCode(t,
 436                 "unauthenticated request",
 437                 PermissionError.HTTPCode,
 438                 response)
 439
 440         // Authenticated non-admin request returns PermissionError.
 441         response = IssueRequest(user_req)
 442         ExpectStatusCode(t,
 443                 "authenticated non-admin request",
 444                 PermissionError.HTTPCode,
 445                 response)
 446
 447         // Authenticated admin request for nonexistent block.
 448         type deletecounter struct {
 449                 Deleted int `json:"copies_deleted"`
 450                 Failed  int `json:"copies_failed"`
 451         }
 452         var response_dc, expected_dc deletecounter
 453
 454         response = IssueRequest(superuser_nonexistent_block_req)
 455         ExpectStatusCode(t,
 456                 "data manager request, nonexistent block",
 457                 http.StatusNotFound,
 458                 response)
 459
 460         // Authenticated admin request for existing block while never_delete is set.
 461         never_delete = true
 462         response = IssueRequest(superuser_existing_block_req)
 463         ExpectStatusCode(t,
 464                 "authenticated request, existing block, method disabled",
 465                 MethodDisabledError.HTTPCode,
 466                 response)
 467         never_delete = false
 468
 469         // Authenticated admin request for existing block.
 470         response = IssueRequest(superuser_existing_block_req)
 471         ExpectStatusCode(t,
 472                 "data manager request, existing block",
 473                 http.StatusOK,
 474                 response)
 475         // Expect response {"copies_deleted":1,"copies_failed":0}
 476         expected_dc = deletecounter{1, 0}
 477         json.NewDecoder(response.Body).Decode(&response_dc)
 478         if response_dc != expected_dc {
 479                 t.Errorf("superuser_existing_block_req\nexpected: %+v\nreceived: %+v",
 480                         expected_dc, response_dc)
 481         }
 482         // Confirm the block has been deleted
 483         _, err := vols[0].Get(TEST_HASH)
 484         var block_deleted = os.IsNotExist(err)
 485         if !block_deleted {
 486                 t.Error("superuser_existing_block_req: block not deleted")
 487         }
 488
 489         // A DELETE request on a block newer than permission_ttl should return
 490         // success but leave the block on the volume.
 491         vols[0].Put(TEST_HASH, TEST_BLOCK)
 492         permission_ttl = time.Duration(1) * time.Hour
 493
 494         response = IssueRequest(superuser_existing_block_req)
 495         ExpectStatusCode(t,
 496                 "data manager request, existing block",
 497                 http.StatusOK,
 498                 response)
 499         // Expect response {"copies_deleted":1,"copies_failed":0}
 500         expected_dc = deletecounter{1, 0}
 501         json.NewDecoder(response.Body).Decode(&response_dc)
 502         if response_dc != expected_dc {
 503                 t.Errorf("superuser_existing_block_req\nexpected: %+v\nreceived: %+v",
 504                         expected_dc, response_dc)
 505         }
 506         // Confirm the block has NOT been deleted.
 507         _, err = vols[0].Get(TEST_HASH)
 508         if err != nil {
 509                 t.Errorf("testing delete on new block: %s\n", err)
 510         }
 511 }
 512
 513 // TestPullHandler
 514 //
 515 // Test handling of the PUT /pull statement.
 516 //
 517 // Cases tested: syntactically valid and invalid pull lists, from the
 518 // data manager and from unprivileged users:
 519 //
 520 //   1. Valid pull list from an ordinary user
 521 //      (expected result: 401 Unauthorized)
 522 //
 523 //   2. Invalid pull request from an ordinary user
 524 //      (expected result: 401 Unauthorized)
 525 //
 526 //   3. Valid pull request from the data manager
 527 //      (expected result: 200 OK with request body "Received 3 pull
 528 //      requests"
 529 //
 530 //   4. Invalid pull request from the data manager
 531 //      (expected result: 400 Bad Request)
 532 //
 533 // Test that in the end, the pull manager received a good pull list with
 534 // the expected number of requests.
 535 //
 536 // TODO(twp): test concurrency: launch 100 goroutines to update the
 537 // pull list simultaneously.  Make sure that none of them return 400
 538 // Bad Request and that pullq.GetList() returns a valid list.
 539 //
 540 func TestPullHandler(t *testing.T) {
 541         defer teardown()
 542
 543         var user_token = "USER TOKEN"
 544         data_manager_token = "DATA MANAGER TOKEN"
 545
 546         good_json := []byte(`[
 547                 {
 548                         "locator":"locator_with_two_servers",
 549                         "servers":[
 550                                 "server1",
 551                                 "server2"
 552                         ]
 553                 },
 554                 {
 555                         "locator":"locator_with_no_servers",
 556                         "servers":[]
 557                 },
 558                 {
 559                         "locator":"",
 560                         "servers":["empty_locator"]
 561                 }
 562         ]`)
 563
 564         bad_json := []byte(`{ "key":"I'm a little teapot" }`)
 565
 566         type pullTest struct {
 567                 name          string
 568                 req           RequestTester
 569                 response_code int
 570                 response_body string
 571         }
 572         var testcases = []pullTest{
 573                 {
 574                         "Valid pull list from an ordinary user",
 575                         RequestTester{"/pull", user_token, "PUT", good_json},
 576                         http.StatusUnauthorized,
 577                         "Unauthorized\n",
 578                 },
 579                 {
 580                         "Invalid pull request from an ordinary user",
 581                         RequestTester{"/pull", user_token, "PUT", bad_json},
 582                         http.StatusUnauthorized,
 583                         "Unauthorized\n",
 584                 },
 585                 {
 586                         "Valid pull request from the data manager",
 587                         RequestTester{"/pull", data_manager_token, "PUT", good_json},
 588                         http.StatusOK,
 589                         "Received 3 pull requests\n",
 590                 },
 591                 {
 592                         "Invalid pull request from the data manager",
 593                         RequestTester{"/pull", data_manager_token, "PUT", bad_json},
 594                         http.StatusBadRequest,
 595                         "Bad Request\n",
 596                 },
 597         }
 598
 599         for _, tst := range testcases {
 600                 response := IssueRequest(&tst.req)
 601                 ExpectStatusCode(t, tst.name, tst.response_code, response)
 602                 ExpectBody(t, tst.name, tst.response_body, response)
 603         }
 604
 605         // The Keep pull manager should have received one good list with 3
 606         // requests on it.
 607         for i := 0; i < 3; i++ {
 608                 item := <-pullq.NextItem
 609                 if _, ok := item.(PullRequest); !ok {
 610                         t.Errorf("item %v could not be parsed as a PullRequest", item)
 611                 }
 612         }
 613
 614         expectChannelEmpty(t, pullq.NextItem)
 615 }
 616
 617 // TestTrashHandler
 618 //
 619 // Test cases:
 620 //
 621 // Cases tested: syntactically valid and invalid trash lists, from the
 622 // data manager and from unprivileged users:
 623 //
 624 //   1. Valid trash list from an ordinary user
 625 //      (expected result: 401 Unauthorized)
 626 //
 627 //   2. Invalid trash list from an ordinary user
 628 //      (expected result: 401 Unauthorized)
 629 //
 630 //   3. Valid trash list from the data manager
 631 //      (expected result: 200 OK with request body "Received 3 trash
 632 //      requests"
 633 //
 634 //   4. Invalid trash list from the data manager
 635 //      (expected result: 400 Bad Request)
 636 //
 637 // Test that in the end, the trash collector received a good list
 638 // trash list with the expected number of requests.
 639 //
 640 // TODO(twp): test concurrency: launch 100 goroutines to update the
 641 // pull list simultaneously.  Make sure that none of them return 400
 642 // Bad Request and that replica.Dump() returns a valid list.
 643 //
 644 func TestTrashHandler(t *testing.T) {
 645         defer teardown()
 646
 647         var user_token = "USER TOKEN"
 648         data_manager_token = "DATA MANAGER TOKEN"
 649
 650         good_json := []byte(`[
 651                 {
 652                         "locator":"block1",
 653                         "block_mtime":1409082153
 654                 },
 655                 {
 656                         "locator":"block2",
 657                         "block_mtime":1409082153
 658                 },
 659                 {
 660                         "locator":"block3",
 661                         "block_mtime":1409082153
 662                 }
 663         ]`)
 664
 665         bad_json := []byte(`I am not a valid JSON string`)
 666
 667         type trashTest struct {
 668                 name          string
 669                 req           RequestTester
 670                 response_code int
 671                 response_body string
 672         }
 673
 674         var testcases = []trashTest{
 675                 {
 676                         "Valid trash list from an ordinary user",
 677                         RequestTester{"/trash", user_token, "PUT", good_json},
 678                         http.StatusUnauthorized,
 679                         "Unauthorized\n",
 680                 },
 681                 {
 682                         "Invalid trash list from an ordinary user",
 683                         RequestTester{"/trash", user_token, "PUT", bad_json},
 684                         http.StatusUnauthorized,
 685                         "Unauthorized\n",
 686                 },
 687                 {
 688                         "Valid trash list from the data manager",
 689                         RequestTester{"/trash", data_manager_token, "PUT", good_json},
 690                         http.StatusOK,
 691                         "Received 3 trash requests\n",
 692                 },
 693                 {
 694                         "Invalid trash list from the data manager",
 695                         RequestTester{"/trash", data_manager_token, "PUT", bad_json},
 696                         http.StatusBadRequest,
 697                         "Bad Request\n",
 698                 },
 699         }
 700
 701         for _, tst := range testcases {
 702                 response := IssueRequest(&tst.req)
 703                 ExpectStatusCode(t, tst.name, tst.response_code, response)
 704                 ExpectBody(t, tst.name, tst.response_body, response)
 705         }
 706
 707         // The trash collector should have received one good list with 3
 708         // requests on it.
 709         for i := 0; i < 3; i++ {
 710                 item := <-trashq.NextItem
 711                 if _, ok := item.(TrashRequest); !ok {
 712                         t.Errorf("item %v could not be parsed as a TrashRequest", item)
 713                 }
 714         }
 715
 716         expectChannelEmpty(t, trashq.NextItem)
 717 }
 718
 719 // ====================
 720 // Helper functions
 721 // ====================
 722
 723 // IssueTestRequest executes an HTTP request described by rt, to a
 724 // REST router.  It returns the HTTP response to the request.
 725 func IssueRequest(rt *RequestTester) *httptest.ResponseRecorder {
 726         response := httptest.NewRecorder()
 727         body := bytes.NewReader(rt.request_body)
 728         req, _ := http.NewRequest(rt.method, rt.uri, body)
 729         if rt.api_token != "" {
 730                 req.Header.Set("Authorization", "OAuth2 "+rt.api_token)
 731         }
 732         loggingRouter := MakeLoggingRESTRouter()
 733         loggingRouter.ServeHTTP(response, req)
 734         return response
 735 }
 736
 737 // ExpectStatusCode checks whether a response has the specified status code,
 738 // and reports a test failure if not.
 739 func ExpectStatusCode(
 740         t *testing.T,
 741         testname string,
 742         expected_status int,
 743         response *httptest.ResponseRecorder) {
 744         if response.Code != expected_status {
 745                 t.Errorf("%s: expected status %s, got %+v",
 746                         testname, expected_status, response)
 747         }
 748 }
 749
 750 func ExpectBody(
 751         t *testing.T,
 752         testname string,
 753         expected_body string,
 754         response *httptest.ResponseRecorder) {
 755         if response.Body.String() != expected_body {
 756                 t.Errorf("%s: expected response body '%s', got %+v",
 757                         testname, expected_body, response)
 758         }
 759 }