test: add unit test to confirm absence of pageToken param in listBuckets request, which causes the 1000+ buckets infinite pagination loop

Author: eliekozah

google/cloud/storage/internal/rest/stub.cc

@@ -183,6 +183,9 @@ StatusOr<ListBucketsResponse> RestStub::ListBuckets(
   if (!headers.ok()) return headers;
   request.AddOptionsToHttpRequest(builder);
   builder.AddQueryParameter("project", request.project_id());
+  if (!request.page_token().empty()) {
+    builder.AddQueryParameter("pageToken", request.page_token());
+  }
   return ParseFromRestResponse<ListBucketsResponse>(
       storage_rest_client_->Get(context, std::move(builder).BuildRequest()));
 }

google/cloud/storage/internal/rest/stub_test.cc

@@ -39,6 +39,7 @@ using ::testing::Contains;
 using ::testing::ElementsAre;
 using ::testing::Eq;
 using ::testing::HasSubstr;
+using ::testing::IsTrue;
 using ::testing::Matcher;
 using ::testing::Pair;
 using ::testing::ResultOf;
@@ -193,6 +194,48 @@ TEST(RestStubTest, CreateBucket) {
               StatusIs(PermanentError().code(), PermanentError().message()));
 }
 
+TEST(RestStubTest, ListBucketsIncludesPageTokenWhenPresentInRequest) {
+  auto mock = std::make_shared<MockRestClient>();
+  std::string expected_token = "test-page-token";
+  ListBucketsRequest request("test-project-id");
+  request.set_page_token(expected_token);
+
+  EXPECT_CALL(*mock,
+              Get(ExpectedContext(),
+                  ResultOf(
+                      "request parameters contain expected pageToken",
+                      [](RestRequest const& r) { return r.parameters(); },
+                      Contains(Pair("pageToken", expected_token)))))
+      .WillOnce(Return(PermanentError()));
+
+  auto tested = std::make_unique<RestStub>(Options{}, mock, mock);
+  auto context = TestContext();
+  tested->ListBuckets(context, TestOptions(), request);
+}
+
+TEST(RestStubTest, ListBucketsOmitsPageTokenWhenEmptyInRequest) {
+  auto mock = std::make_shared<MockRestClient>();
+  ListBucketsRequest request("test-project-id");
+
+  EXPECT_CALL(*mock, Get(ExpectedContext(),
+                         ResultOf(
+                             "request parameters do not contain 'pageToken'",
+                             [](RestRequest const& r) {
+                               for (auto const& param : r.parameters()) {
+                                 if (param.first == "pageToken") {
+                                   return false;
+                                 }
+                               }
+                               return true;
+                             },
+                             IsTrue())))
+      .WillOnce(Return(PermanentError()));
+
+  auto tested = std::make_unique<RestStub>(Options{}, mock, mock);
+  auto context = TestContext();
+  tested->ListBuckets(context, TestOptions(), request);
+}
+
 TEST(RestStubTest, GetBucketMetadata) {
   auto mock = std::make_shared<MockRestClient>();
   EXPECT_CALL(*mock, Get(ExpectedContext(), ExpectedRequest()))

google/cloud/storage/tests/CMakeLists.txt

@@ -16,6 +16,7 @@
 
 set(storage_client_integration_tests
     # cmake-format : sort
+    elie_test.cc
     async_client_integration_test.cc
     auto_finalize_integration_test.cc
     bucket_integration_test.cc

google/cloud/storage/tests/storage_client_integration_tests.bzl

@@ -26,6 +26,7 @@ storage_client_integration_tests = [
     "curl_sign_blob_integration_test.cc",
     "decompressive_transcoding_integration_test.cc",
     "default_object_acl_integration_test.cc",
+    "elie_test.cc",
     "error_injection_integration_test.cc",
     "error_parsing_integration_test.cc",
     "grpc_bucket_metadata_integration_test.cc",