impl(bigquery): Project Stub and StubFactory (#11616)

Author: jsrinnn

google/cloud/bigquery/bigquery_rest.cmake

@@ -79,6 +79,10 @@ add_library(
     v2/minimal/internal/project_request.h
     v2/minimal/internal/project_response.cc
     v2/minimal/internal/project_response.h
+    v2/minimal/internal/project_rest_stub.cc
+    v2/minimal/internal/project_rest_stub.h
+    v2/minimal/internal/project_rest_stub_factory.cc
+    v2/minimal/internal/project_rest_stub_factory.h
     v2/minimal/internal/rest_stub_utils.cc
     v2/minimal/internal/rest_stub_utils.h
     v2/minimal/internal/table.cc
@@ -229,6 +233,7 @@ function (bigquery_rest_define_tests)
         v2/minimal/internal/job_test.cc
         v2/minimal/internal/project_request_test.cc
         v2/minimal/internal/project_response_test.cc
+        v2/minimal/internal/project_rest_stub_test.cc
         v2/minimal/internal/project_test.cc
         v2/minimal/internal/rest_stub_utils_test.cc
         v2/minimal/internal/table_client_test.cc

google/cloud/bigquery/bigquery_rest_unit_tests.bzl

@@ -41,6 +41,7 @@ bigquery_rest_unit_tests = [
     "v2/minimal/internal/job_test.cc",
     "v2/minimal/internal/project_request_test.cc",
     "v2/minimal/internal/project_response_test.cc",
+    "v2/minimal/internal/project_rest_stub_test.cc",
     "v2/minimal/internal/project_test.cc",
     "v2/minimal/internal/rest_stub_utils_test.cc",
     "v2/minimal/internal/table_client_test.cc",

google/cloud/bigquery/google_cloud_cpp_bigquery_rest.bzl

@@ -51,6 +51,8 @@ google_cloud_cpp_bigquery_rest_hdrs = [
     "v2/minimal/internal/project.h",
     "v2/minimal/internal/project_request.h",
     "v2/minimal/internal/project_response.h",
+    "v2/minimal/internal/project_rest_stub.h",
+    "v2/minimal/internal/project_rest_stub_factory.h",
     "v2/minimal/internal/rest_stub_utils.h",
     "v2/minimal/internal/table.h",
     "v2/minimal/internal/table_client.h",
@@ -101,6 +103,8 @@ google_cloud_cpp_bigquery_rest_srcs = [
     "v2/minimal/internal/project.cc",
     "v2/minimal/internal/project_request.cc",
     "v2/minimal/internal/project_response.cc",
+    "v2/minimal/internal/project_rest_stub.cc",
+    "v2/minimal/internal/project_rest_stub_factory.cc",
     "v2/minimal/internal/rest_stub_utils.cc",
     "v2/minimal/internal/table.cc",
     "v2/minimal/internal/table_client.cc",

google/cloud/bigquery/v2/minimal/internal/project_rest_stub.cc

@@ -0,0 +1,41 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "google/cloud/bigquery/v2/minimal/internal/project_rest_stub.h"
+#include "google/cloud/bigquery/v2/minimal/internal/rest_stub_utils.h"
+#include "google/cloud/status_or.h"
+
+namespace google {
+namespace cloud {
+namespace bigquery_v2_minimal_internal {
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
+
+ProjectRestStub::~ProjectRestStub() = default;
+
+StatusOr<ListProjectsResponse> DefaultProjectRestStub::ListProjects(
+    rest_internal::RestContext& rest_context,
+    ListProjectsRequest const& request) {
+  // Prepare the RestRequest from ListProjectsRequest.
+  auto rest_request =
+      PrepareRestRequest<ListProjectsRequest>(rest_context, request);
+
+  // Call the rest stub and parse the RestResponse.
+  return ParseFromRestResponse<ListProjectsResponse>(
+      rest_stub_->Get(rest_context, std::move(*rest_request)));
+}
+
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
+}  // namespace bigquery_v2_minimal_internal
+}  // namespace cloud
+}  // namespace google

google/cloud/bigquery/v2/minimal/internal/project_rest_stub.h

@@ -0,0 +1,58 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGQUERY_V2_MINIMAL_INTERNAL_PROJECT_REST_STUB_H
+#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGQUERY_V2_MINIMAL_INTERNAL_PROJECT_REST_STUB_H
+
+#include "google/cloud/bigquery/v2/minimal/internal/project_request.h"
+#include "google/cloud/bigquery/v2/minimal/internal/project_response.h"
+#include "google/cloud/internal/rest_client.h"
+#include "google/cloud/status_or.h"
+#include "google/cloud/version.h"
+#include <memory>
+
+namespace google {
+namespace cloud {
+namespace bigquery_v2_minimal_internal {
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
+
+class ProjectRestStub {
+ public:
+  virtual ~ProjectRestStub() = 0;
+
+  virtual StatusOr<ListProjectsResponse> ListProjects(
+      rest_internal::RestContext& rest_context,
+      ListProjectsRequest const& request) = 0;
+};
+
+class DefaultProjectRestStub : public ProjectRestStub {
+ public:
+  explicit DefaultProjectRestStub(
+      std::unique_ptr<rest_internal::RestClient> rest_stub)
+      : rest_stub_(std::move(rest_stub)) {}
+
+  StatusOr<ListProjectsResponse> ListProjects(
+      rest_internal::RestContext& rest_context,
+      ListProjectsRequest const& request) override;
+
+ private:
+  std::unique_ptr<rest_internal::RestClient> rest_stub_;
+};
+
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
+}  // namespace bigquery_v2_minimal_internal
+}  // namespace cloud
+}  // namespace google
+
+#endif  // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGQUERY_V2_MINIMAL_INTERNAL_PROJECT_REST_STUB_H

google/cloud/bigquery/v2/minimal/internal/project_rest_stub_factory.cc

@@ -0,0 +1,46 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "google/cloud/bigquery/v2/minimal/internal/project_rest_stub_factory.h"
+#include "google/cloud/common_options.h"
+#include "google/cloud/credentials.h"
+#include "google/cloud/internal/algorithm.h"
+#include "google/cloud/internal/unified_rest_credentials.h"
+#include "google/cloud/log.h"
+
+namespace google {
+namespace cloud {
+namespace bigquery_v2_minimal_internal {
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
+
+std::shared_ptr<ProjectRestStub> CreateDefaultProjectRestStub(
+    Options const& opts) {
+  Options local_opts = opts;
+  if (!local_opts.has<UnifiedCredentialsOption>()) {
+    local_opts.set<UnifiedCredentialsOption>(MakeGoogleDefaultCredentials());
+  }
+
+  auto curl_rest_client = rest_internal::MakePooledRestClient(
+      opts.get<EndpointOption>(), local_opts);
+
+  std::shared_ptr<ProjectRestStub> stub =
+      std::make_shared<DefaultProjectRestStub>(std::move(curl_rest_client));
+
+  return stub;
+}
+
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
+}  // namespace bigquery_v2_minimal_internal
+}  // namespace cloud
+}  // namespace google

google/cloud/bigquery/v2/minimal/internal/project_rest_stub_factory.h

@@ -0,0 +1,36 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGQUERY_V2_MINIMAL_INTERNAL_PROJECT_REST_STUB_FACTORY_H
+#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGQUERY_V2_MINIMAL_INTERNAL_PROJECT_REST_STUB_FACTORY_H
+
+#include "google/cloud/bigquery/v2/minimal/internal/project_rest_stub.h"
+#include "google/cloud/options.h"
+#include "google/cloud/version.h"
+#include <memory>
+
+namespace google {
+namespace cloud {
+namespace bigquery_v2_minimal_internal {
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
+
+std::shared_ptr<ProjectRestStub> CreateDefaultProjectRestStub(
+    Options const& opts);
+
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
+}  // namespace bigquery_v2_minimal_internal
+}  // namespace cloud
+}  // namespace google
+
+#endif  // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGQUERY_V2_MINIMAL_INTERNAL_PROJECT_REST_STUB_FACTORY_H

google/cloud/bigquery/v2/minimal/internal/project_rest_stub_test.cc

@@ -0,0 +1,123 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "google/cloud/bigquery/v2/minimal/internal/project_rest_stub.h"
+#include "google/cloud/bigquery/v2/minimal/testing/project_test_utils.h"
+#include "google/cloud/common_options.h"
+#include "google/cloud/internal/http_payload.h"
+#include "google/cloud/internal/make_status.h"
+#include "google/cloud/internal/rest_response.h"
+#include "google/cloud/testing_util/mock_http_payload.h"
+#include "google/cloud/testing_util/mock_rest_client.h"
+#include "google/cloud/testing_util/mock_rest_response.h"
+#include "google/cloud/testing_util/status_matchers.h"
+#include <gmock/gmock.h>
+
+namespace google {
+namespace cloud {
+namespace bigquery_v2_minimal_internal {
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
+
+namespace rest = ::google::cloud::rest_internal;
+using ::google::cloud::rest_internal::HttpStatusCode;
+using ::google::cloud::testing_util::MakeMockHttpPayloadSuccess;
+using ::google::cloud::testing_util::MockHttpPayload;
+using ::google::cloud::testing_util::MockRestClient;
+using ::google::cloud::testing_util::MockRestResponse;
+using ::google::cloud::testing_util::StatusIs;
+using ::testing::_;
+using ::testing::An;
+using ::testing::ByMove;
+using ::testing::Return;
+
+ListProjectsRequest MakeListProjectsRequest() {
+  ListProjectsRequest request;
+  request.set_max_results(10).set_page_token("pg-123");
+  return request;
+}
+TEST(ProjectStubTest, ListProjectsSuccess) {
+  std::string payload =
+      bigquery_v2_minimal_testing::MakeListProjectsResponseJsonText();
+  auto mock_response = std::make_unique<MockRestResponse>();
+
+  EXPECT_CALL(*mock_response, StatusCode)
+      .WillRepeatedly(Return(HttpStatusCode::kOk));
+  EXPECT_CALL(*mock_response, Headers)
+      .WillRepeatedly(Return(std::multimap<std::string, std::string>()));
+  EXPECT_CALL(std::move(*mock_response), ExtractPayload)
+      .WillOnce(Return(ByMove(MakeMockHttpPayloadSuccess(payload))));
+
+  auto mock_rest_client = std::make_unique<MockRestClient>();
+  EXPECT_CALL(*mock_rest_client, Get(_, An<rest::RestRequest const&>()))
+      .WillOnce(Return(ByMove(
+          std::unique_ptr<rest::RestResponse>(std::move(mock_response)))));
+
+  auto request = MakeListProjectsRequest();
+
+  rest_internal::RestContext context;
+  DefaultProjectRestStub rest_stub(std::move(mock_rest_client));
+
+  auto result = rest_stub.ListProjects(context, std::move(request));
+  ASSERT_STATUS_OK(result);
+
+  auto const projects = result->projects;
+  ASSERT_EQ(projects.size(), 1);
+
+  auto expected = bigquery_v2_minimal_testing::MakeProject();
+
+  EXPECT_EQ(result->http_response.http_status_code, HttpStatusCode::kOk);
+  bigquery_v2_minimal_testing::AssertEquals(expected, projects[0]);
+}
+
+TEST(ProjectStubTest, ListProjectsRestClientError) {
+  auto mock_rest_client = std::make_unique<MockRestClient>();
+  EXPECT_CALL(*mock_rest_client, Get(_, An<rest::RestRequest const&>()))
+      .WillOnce(
+          Return(rest::AsStatus(HttpStatusCode::kInternalServerError, "")));
+
+  auto request = MakeListProjectsRequest();
+
+  rest_internal::RestContext context;
+  DefaultProjectRestStub rest_stub(std::move(mock_rest_client));
+
+  auto response = rest_stub.ListProjects(context, std::move(request));
+  EXPECT_THAT(response, StatusIs(StatusCode::kUnavailable));
+}
+
+TEST(ProjectStubTest, ListProjectsRestResponseError) {
+  auto mock_payload = std::make_unique<MockHttpPayload>();
+  auto mock_response = std::make_unique<MockRestResponse>();
+  EXPECT_CALL(*mock_response, StatusCode)
+      .WillRepeatedly(Return(HttpStatusCode::kBadRequest));
+  EXPECT_CALL(std::move(*mock_response), ExtractPayload)
+      .WillOnce(Return(std::move(mock_payload)));
+
+  auto mock_rest_client = std::make_unique<MockRestClient>();
+  EXPECT_CALL(*mock_rest_client, Get(_, An<rest::RestRequest const&>()))
+      .WillOnce(Return(ByMove(
+          std::unique_ptr<rest::RestResponse>(std::move(mock_response)))));
+
+  auto request = MakeListProjectsRequest();
+
+  rest_internal::RestContext context;
+  DefaultProjectRestStub rest_stub(std::move(mock_rest_client));
+
+  auto response = rest_stub.ListProjects(context, std::move(request));
+
+  EXPECT_THAT(response, StatusIs(StatusCode::kInvalidArgument));
+}
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
+}  // namespace bigquery_v2_minimal_internal
+}  // namespace cloud
+}  // namespace google