feature(generator): connection options generator (#5171)

* feature(generator): connection options generator

Author: scotthart

generator/CMakeLists.txt

@@ -29,6 +29,8 @@ add_library(
     generator.h
     internal/codegen_utils.cc
     internal/codegen_utils.h
+    internal/connection_options_generator.cc
+    internal/connection_options_generator.h
     internal/descriptor_utils.cc
     internal/descriptor_utils.h
     internal/generator_interface.h

generator/generator_test.cc

@@ -76,6 +76,10 @@ TEST_F(GeneratorTest, BadCommandLineArgs) {
 }
 
 TEST_F(GeneratorTest, GenerateServicesSuccess) {
+  auto connection_options_header_output =
+      absl::make_unique<generator_testing::MockZeroCopyOutputStream>();
+  auto connection_options_cc_output =
+      absl::make_unique<generator_testing::MockZeroCopyOutputStream>();
   auto stub_header_output =
       absl::make_unique<generator_testing::MockZeroCopyOutputStream>();
   auto stub_cc_output =
@@ -100,6 +104,10 @@ TEST_F(GeneratorTest, GenerateServicesSuccess) {
   service_file.mutable_options()->set_cc_generic_services(false);
   const FileDescriptor* service_file_descriptor = pool.BuildFile(service_file);
 
+  EXPECT_CALL(*connection_options_header_output, Next(_, _))
+      .WillRepeatedly(Return(false));
+  EXPECT_CALL(*connection_options_cc_output, Next(_, _))
+      .WillRepeatedly(Return(false));
   EXPECT_CALL(*stub_header_output, Next(_, _)).WillRepeatedly(Return(false));
   EXPECT_CALL(*stub_cc_output, Next(_, _)).WillRepeatedly(Return(false));
   EXPECT_CALL(*logging_header_output, Next(_, _)).WillRepeatedly(Return(false));
@@ -113,6 +121,8 @@ TEST_F(GeneratorTest, GenerateServicesSuccess) {
       .WillRepeatedly(Return(false));
 
   EXPECT_CALL(*context_, Open(_))
+      .WillOnce(Return(connection_options_header_output.release()))
+      .WillOnce(Return(connection_options_cc_output.release()))
       .WillOnce(Return(stub_header_output.release()))
       .WillOnce(Return(stub_cc_output.release()))
       .WillOnce(Return(logging_header_output.release()))

generator/google_cloud_cpp_generator.bzl

@@ -19,6 +19,7 @@
 google_cloud_cpp_generator_hdrs = [
     "generator.h",
     "internal/codegen_utils.h",
+    "internal/connection_options_generator.h",
     "internal/descriptor_utils.h",
     "internal/generator_interface.h",
     "internal/logging_decorator_generator.h",
@@ -33,6 +34,7 @@ google_cloud_cpp_generator_hdrs = [
 google_cloud_cpp_generator_srcs = [
     "generator.cc",
     "internal/codegen_utils.cc",
+    "internal/connection_options_generator.cc",
     "internal/descriptor_utils.cc",
     "internal/logging_decorator_generator.cc",
     "internal/metadata_decorator_generator.cc",

generator/integration_tests/generator_integration_test.cc

@@ -136,7 +136,9 @@ TEST_P(GeneratorIntegrationTest, CompareGeneratedToGolden) {
 
 INSTANTIATE_TEST_SUITE_P(
     Generator, GeneratorIntegrationTest,
-    testing::Values("internal/database_admin_logging_decorator.gcpcxx.pb.h",
+    testing::Values("connection_options.gcpcxx.pb.h",
+                    "connection_options.gcpcxx.pb.cc",
+                    "internal/database_admin_logging_decorator.gcpcxx.pb.h",
                     "internal/database_admin_logging_decorator.gcpcxx.pb.cc",
                     "internal/database_admin_metadata_decorator.gcpcxx.pb.h",
                     "internal/database_admin_metadata_decorator.gcpcxx.pb.cc",

generator/integration_tests/golden/BUILD

@@ -21,8 +21,8 @@ load(":google_cloud_cpp_generator_golden_files.bzl", "google_cloud_cpp_generator
 filegroup(
     name = "golden_filegroup",
     srcs = [
-        "connection_options.cc",
-        "connection_options.h",
+        "connection_options.gcpcxx.pb.cc",
+        "connection_options.gcpcxx.pb.h",
         "version.cc",
         "version.h",
         "version_info.h",

generator/integration_tests/golden/CMakeLists.txt

@@ -16,8 +16,8 @@
 
 set(google_cloud_cpp_generator_golden_files
     # cmake-format: sort
-    connection_options.cc
-    connection_options.h
+    connection_options.gcpcxx.pb.cc
+    connection_options.gcpcxx.pb.h
     internal/database_admin_logging_decorator.gcpcxx.pb.cc
     internal/database_admin_logging_decorator.gcpcxx.pb.h
     internal/database_admin_metadata_decorator.gcpcxx.pb.cc
@@ -38,8 +38,8 @@ export_list_to_bazel("google_cloud_cpp_generator_golden_files.bzl"
 # Create a library from the where the golden code was copied to.
 add_library(
     google_cloud_cpp_generator_golden_lib # cmake-format: sort
-    connection_options.cc
-    connection_options.h
+    connection_options.gcpcxx.pb.cc
+    connection_options.gcpcxx.pb.h
     internal/database_admin_logging_decorator.gcpcxx.pb.cc
     internal/database_admin_logging_decorator.gcpcxx.pb.h
     internal/database_admin_metadata_decorator.gcpcxx.pb.cc
@@ -78,8 +78,11 @@ function (google_cloud_cpp_generator_define_golden_tests)
 
     set(google_cloud_cpp_generator_golden_tests
         # cmake-format: sort
-        golden_logging_decorator_test.cc golden_metadata_decorator_test.cc
-        golden_stub_factory_test.cc golden_stub_test.cc)
+        golden_connection_options_test.cc
+        golden_logging_decorator_test.cc
+        golden_metadata_decorator_test.cc
+        golden_stub_factory_test.cc
+        golden_stub_test.cc)
 
     # Export the list of unit tests to a .bzl file so we do not need to maintain
     # the list in two places.

generator/integration_tests/golden/connection_options.gcpcxx.pb.cc

@@ -0,0 +1,47 @@
+// Copyright 2020 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.
+
+// Generated by the Codegen C++ plugin.
+// If you make any local changes, they will be lost.
+// source: generator/integration_tests/test.proto
+
+#include "generator/integration_tests/golden/connection_options.gcpcxx.pb.h"
+#include "absl/strings/str_cat.h"
+#include "google/cloud/internal/compiler_info.h"
+#include <string>
+
+namespace google {
+namespace cloud {
+namespace golden {
+inline namespace GOLDEN_CLIENT_NS {
+
+std::string ConnectionOptionsTraits::default_endpoint() {
+  return "test.googleapis.com";
+}
+
+std::string ConnectionOptionsTraits::user_agent_prefix() {
+  return absl::StrCat("gcloud-cpp/",
+         VersionString(), " (",
+         google::cloud::internal::CompilerId(),  "-",
+         google::cloud::internal::CompilerVersion(), "; ",
+         google::cloud::internal::CompilerFeatures(), ")");
+}
+
+int ConnectionOptionsTraits::default_num_channels() { return 4; }
+
+}  // namespace GOLDEN_CLIENT_NS
+}  // namespace golden
+}  // namespace cloud
+}  // namespace google
+

generator/integration_tests/golden/connection_options.gcpcxx.pb.h

@@ -0,0 +1,44 @@
+// Copyright 2020 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.
+
+// Generated by the Codegen C++ plugin.
+// If you make any local changes, they will be lost.
+// source: generator/integration_tests/test.proto
+#ifndef GOOGLE_CLOUD_CPP_GENERATOR_INTEGRATION_TESTS_GOLDEN_CONNECTION_OPTIONS_GCPCXX_PB_H
+#define GOOGLE_CLOUD_CPP_GENERATOR_INTEGRATION_TESTS_GOLDEN_CONNECTION_OPTIONS_GCPCXX_PB_H
+
+#include "generator/integration_tests/golden/version.h"
+#include "google/cloud/connection_options.h"
+#include <string>
+
+namespace google {
+namespace cloud {
+namespace golden {
+inline namespace GOLDEN_CLIENT_NS {
+
+struct ConnectionOptionsTraits {
+  static std::string default_endpoint();
+  static std::string user_agent_prefix();
+  static int default_num_channels();
+};
+
+using ConnectionOptions =
+  google::cloud::ConnectionOptions<ConnectionOptionsTraits>;
+
+}  // namespace GOLDEN_CLIENT_NS
+}  // namespace golden
+}  // namespace cloud
+}  // namespace google
+
+#endif  // GOOGLE_CLOUD_CPP_GENERATOR_INTEGRATION_TESTS_GOLDEN_CONNECTION_OPTIONS_GCPCXX_PB_H

generator/integration_tests/golden/golden_connection_options_test.cc

@@ -0,0 +1,46 @@
+// Copyright 2020 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
+//
+//     http://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 "generator/integration_tests/golden/connection_options.gcpcxx.pb.h"
+#include <gmock/gmock.h>
+#include <memory>
+
+namespace google {
+namespace cloud {
+namespace golden {
+inline namespace GOLDEN_CLIENT_NS {
+namespace {
+
+using ::testing::HasSubstr;
+
+TEST(GoldenConnectionOptionsTest, DefaultEndpoint) {
+  ConnectionOptions options;
+  EXPECT_EQ("test.googleapis.com", options.endpoint());
+}
+
+TEST(GoldenConnectionOptionsTest, UserAgentPrefix) {
+  ConnectionOptions options;
+  EXPECT_THAT(options.user_agent_prefix(), HasSubstr("gcloud-cpp/v1.19.0"));
+}
+
+TEST(GoldenConnectionOptionsTest, DefaultNumChannels) {
+  ConnectionOptions options;
+  EXPECT_EQ(4, options.num_channels());
+}
+
+}  // namespace
+}  // namespace GOLDEN_CLIENT_NS
+}  // namespace golden
+}  // namespace cloud
+}  // namespace google

generator/integration_tests/golden/golden_stub_factory_test.cc

@@ -56,7 +56,7 @@ TEST_F(GoldenStubFactoryTest, DefaultStubWithoutLogging) {
 }
 
 TEST_F(GoldenStubFactoryTest, DefaultStubWithLogging) {
-  ConnectionOptions options;
+  golden::ConnectionOptions options;
   options.enable_tracing("rpc");
   auto default_stub = CreateDefaultDatabaseAdminStub(options);
   auto const log_lines = ClearLogLines();