cleanup(cmake): REGAPIC helper (#14894)

Author: dbolduc

cmake/GoogleCloudCppLibrary.cmake

@@ -108,6 +108,7 @@ function (google_cloud_cpp_add_library_protos library)
     # Create and install the CMake configuration files.
     include(CMakePackageConfigHelpers)
     set(GOOGLE_CLOUD_CPP_CONFIG_LIBRARY "${library_target}")
+    set(GOOGLE_CLOUD_CPP_TRANSPORT "grpc_utils")
     configure_file("${PROJECT_SOURCE_DIR}/cmake/templates/config.cmake.in"
                    "${library_target}-config.cmake" @ONLY)
     write_basic_package_version_file(
@@ -148,7 +149,7 @@ endfunction ()
 function (google_cloud_cpp_add_gapic_library library display_name)
     cmake_parse_arguments(
         _opt
-        "EXPERIMENTAL;TRANSITION"
+        "EXPERIMENTAL;TRANSITION;REST_TRANSPORT"
         ""
         "ADDITIONAL_PROTO_LISTS;BACKWARDS_COMPAT_PROTO_TARGETS;CROSS_LIB_DEPS;SERVICE_DIRS;SHARED_PROTO_DEPS"
         ${ARGN})
@@ -167,6 +168,10 @@ function (google_cloud_cpp_add_gapic_library library display_name)
     if (_opt_EXPERIMENTAL)
         set(library_alias "${experimental_alias}")
     endif ()
+    set(transport "grpc_utils")
+    if (_opt_REST_TRANSPORT)
+        set(transport "rest_protobuf_internal")
+    endif ()
 
     include(GoogleapisConfig)
     set(DOXYGEN_PROJECT_NAME "${display_name} C++ Client")
@@ -241,7 +246,7 @@ function (google_cloud_cpp_add_gapic_library library display_name)
                $<INSTALL_INTERFACE:include>)
     target_link_libraries(
         ${library_target}
-        PUBLIC google-cloud-cpp::grpc_utils google-cloud-cpp::common
+        PUBLIC google-cloud-cpp::${transport} google-cloud-cpp::common
                google-cloud-cpp::${library}_protos ${shared_proto_dep_targets})
     google_cloud_cpp_add_common_options(${library_target})
     set_target_properties(
@@ -300,13 +305,14 @@ function (google_cloud_cpp_add_gapic_library library display_name)
         ${library}
         "The ${display_name} C++ Client Library"
         "Provides C++ APIs to use the ${display_name}"
-        "google_cloud_cpp_grpc_utils"
+        "google_cloud_cpp_${transport}"
         "${protos_target}"
         ${shared_proto_dep_targets})
 
     # Create and install the CMake configuration files.
     include(CMakePackageConfigHelpers)
     set(GOOGLE_CLOUD_CPP_CONFIG_LIBRARY "${library_target}")
+    set(GOOGLE_CLOUD_CPP_TRANSPORT "${transport}")
     foreach (lib IN LISTS _opt_CROSS_LIB_DEPS _opt_SHARED_PROTO_DEPS)
         list(APPEND find_dependencies
              "find_dependency(google_cloud_cpp_${lib})")

cmake/templates/config.cmake.in

@@ -13,11 +13,7 @@
 # limitations under the License.
 
 include(CMakeFindDependencyMacro)
-# google_cloud_cpp_googleapis finds both gRPC and Protobuf, no need to load them here.
-find_dependency(google_cloud_cpp_googleapis)
-find_dependency(google_cloud_cpp_common)
-find_dependency(google_cloud_cpp_grpc_utils)
-find_dependency(absl)
+find_dependency(google_cloud_cpp_@GOOGLE_CLOUD_CPP_TRANSPORT@)
 @GOOGLE_CLOUD_CPP_ADDITIONAL_FIND_DEPENDENCIES@
 
 include("${CMAKE_CURRENT_LIST_DIR}/@[email protected]")

google/cloud/bigquerycontrol/CMakeLists.txt

@@ -16,172 +16,9 @@
 
 include(GoogleCloudCppLibrary)
 
-include(GoogleapisConfig)
-set(DOXYGEN_PROJECT_NAME "Cloud BigQuery Control API C++ Client")
-set(DOXYGEN_PROJECT_BRIEF
-    "A C++ Client Library for the Cloud BigQuery Control API")
-set(DOXYGEN_PROJECT_NUMBER "${PROJECT_VERSION} (Experimental)")
-set(DOXYGEN_EXCLUDE_SYMBOLS "internal")
-set(DOXYGEN_EXAMPLE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/quickstart)
-
-unset(mocks_globs)
-unset(source_globs)
-set(service_dirs "v2/")
-foreach (dir IN LISTS service_dirs)
-    string(REPLACE "/" "_" ns "${dir}")
-    list(APPEND source_globs "${dir}*.h" "${dir}internal/*.h"
-         "${dir}internal/*_sources.cc")
-    list(APPEND mocks_globs "${dir}mocks/*.h")
-    list(APPEND DOXYGEN_EXAMPLE_PATH
-         "${CMAKE_CURRENT_SOURCE_DIR}/${dir}samples")
-    list(APPEND DOXYGEN_EXCLUDE_SYMBOLS "bigquerycontrol_${ns}internal")
-endforeach ()
-
-include(GoogleCloudCppDoxygen)
-google_cloud_cpp_doxygen_targets("bigquerycontrol" DEPENDS cloud-docs
-                                 google-cloud-cpp::bigquery_v2_protos)
-
-include(GoogleCloudCppCommon)
-
-include(CompileProtos)
-google_cloud_cpp_find_proto_include_dir(PROTO_INCLUDE_DIR)
-google_cloud_cpp_load_protolist(
-    proto_list
-    "${PROJECT_SOURCE_DIR}/external/googleapis/protolists/bigquerycontrol.list")
-google_cloud_cpp_load_protodeps(
-    proto_deps
-    "${PROJECT_SOURCE_DIR}/external/googleapis/protodeps/bigquerycontrol.deps")
-google_cloud_cpp_proto_library(
-    google_cloud_cpp_bigquery_v2_protos # cmake-format: sort
-    ${proto_list} PROTO_PATH_DIRECTORIES "${EXTERNAL_GOOGLEAPIS_SOURCE}"
-    "${PROTO_INCLUDE_DIR}")
-external_googleapis_set_version_and_alias(bigquery_v2_protos)
-target_link_libraries(google_cloud_cpp_bigquery_v2_protos PUBLIC ${proto_deps})
-
-file(
-    GLOB source_files
-    RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}"
-    ${source_globs})
-list(SORT source_files)
-add_library(google_cloud_cpp_bigquerycontrol ${source_files})
-target_include_directories(
-    google_cloud_cpp_bigquerycontrol
-    PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}>
-           $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}>
-           $<INSTALL_INTERFACE:include>)
-target_link_libraries(
-    google_cloud_cpp_bigquerycontrol
-    PUBLIC google-cloud-cpp::grpc_utils
-           google-cloud-cpp::common
-           google-cloud-cpp::rest_internal
-           google-cloud-cpp::rest_protobuf_internal
-           google-cloud-cpp::bigquery_v2_protos)
-google_cloud_cpp_add_common_options(google_cloud_cpp_bigquerycontrol)
-set_target_properties(
-    google_cloud_cpp_bigquerycontrol
-    PROPERTIES EXPORT_NAME google-cloud-cpp::experimental-bigquerycontrol
-               VERSION "${PROJECT_VERSION}"
-               SOVERSION "${PROJECT_VERSION_MAJOR}")
-target_compile_options(google_cloud_cpp_bigquerycontrol
-                       PUBLIC ${GOOGLE_CLOUD_CPP_EXCEPTIONS_FLAG})
-
-add_library(google-cloud-cpp::experimental-bigquerycontrol ALIAS
-            google_cloud_cpp_bigquerycontrol)
-
-# Get the destination directories based on the GNU recommendations.
-include(GNUInstallDirs)
-
-# Export the CMake targets to make it easy to create configuration files.
-install(
-    EXPORT google_cloud_cpp_bigquerycontrol-targets
-    DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/google_cloud_cpp_bigquerycontrol"
-    COMPONENT google_cloud_cpp_development)
-
-# Install the libraries and headers in the locations determined by
-# GNUInstallDirs
-install(
-    TARGETS google_cloud_cpp_bigquerycontrol google_cloud_cpp_bigquery_v2_protos
-    EXPORT google_cloud_cpp_bigquerycontrol-targets
-    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
-            COMPONENT google_cloud_cpp_runtime
-    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-            COMPONENT google_cloud_cpp_runtime
-            NAMELINK_COMPONENT google_cloud_cpp_development
-    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-            COMPONENT google_cloud_cpp_development)
-
-google_cloud_cpp_install_proto_library_protos(
-    "google_cloud_cpp_bigquery_v2_protos" "${EXTERNAL_GOOGLEAPIS_SOURCE}")
-google_cloud_cpp_install_proto_library_headers(
-    "google_cloud_cpp_bigquery_v2_protos")
-google_cloud_cpp_install_headers("google_cloud_cpp_bigquerycontrol"
-                                 "include/google/cloud/bigquerycontrol")
-
-google_cloud_cpp_add_pkgconfig(
-    bigquerycontrol
-    "The Cloud BigQuery Control API C++ Client Library"
-    "Provides C++ APIs to use the Cloud BigQuery Control API."
-    "google_cloud_cpp_rest_internal"
-    "google_cloud_cpp_rest_protobuf_internal"
-    "google_cloud_cpp_grpc_utils"
-    "google_cloud_cpp_common"
-    "google_cloud_cpp_bigquery_v2_protos")
-
-# Create and install the CMake configuration files.
-include(CMakePackageConfigHelpers)
-configure_file("config.cmake.in"
-               "google_cloud_cpp_bigquerycontrol-config.cmake" @ONLY)
-write_basic_package_version_file(
-    "google_cloud_cpp_bigquerycontrol-config-version.cmake"
-    VERSION ${PROJECT_VERSION}
-    COMPATIBILITY ExactVersion)
-
-install(
-    FILES
-        "${CMAKE_CURRENT_BINARY_DIR}/google_cloud_cpp_bigquerycontrol-config.cmake"
-        "${CMAKE_CURRENT_BINARY_DIR}/google_cloud_cpp_bigquerycontrol-config-version.cmake"
-    DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/google_cloud_cpp_bigquerycontrol"
-    COMPONENT google_cloud_cpp_development)
-
-external_googleapis_install_pc("google_cloud_cpp_bigquery_v2_protos")
-
-if (GOOGLE_CLOUD_CPP_WITH_MOCKS)
-    # Create a header-only library for the mocks. We use a CMake `INTERFACE`
-    # library for these, a regular library would not work on macOS (where the
-    # library needs at least one .o file). Unfortunately INTERFACE libraries are
-    # a bit weird in that they need absolute paths for their sources.
-    file(
-        GLOB relative_mock_files
-        RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}"
-        ${mocks_globs})
-    list(SORT relative_mock_files)
-    set(mock_files)
-    foreach (file IN LISTS relative_mock_files)
-        # We use a generator expression per the recommendation in:
-        # https://stackoverflow.com/a/62465051
-        list(APPEND mock_files
-             "$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/${file}>")
-    endforeach ()
-    add_library(google_cloud_cpp_bigquerycontrol_mocks INTERFACE)
-    target_sources(google_cloud_cpp_bigquerycontrol_mocks
-                   INTERFACE ${mock_files})
-    target_link_libraries(
-        google_cloud_cpp_bigquerycontrol_mocks
-        INTERFACE google-cloud-cpp::experimental-bigquerycontrol GTest::gmock
-                  GTest::gtest)
-    set_target_properties(
-        google_cloud_cpp_bigquerycontrol_mocks
-        PROPERTIES EXPORT_NAME google-cloud-cpp::bigquerycontrol_mocks)
-    target_include_directories(
-        google_cloud_cpp_bigquerycontrol_mocks
-        INTERFACE $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}>
-                  $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}>
-                  $<INSTALL_INTERFACE:include>)
-    target_compile_options(google_cloud_cpp_bigquerycontrol_mocks
-                           INTERFACE ${GOOGLE_CLOUD_CPP_EXCEPTIONS_FLAG})
-
-    google_cloud_cpp_install_mocks(bigquerycontrol "Cloud BigQuery V2 API")
-endif ()
+google_cloud_cpp_add_gapic_library(
+    bigquerycontrol "Cloud BigQuery Control API" EXPERIMENTAL REST_TRANSPORT
+    SERVICE_DIRS "v2/")
 
 if (BUILD_TESTING AND GOOGLE_CLOUD_CPP_ENABLE_CXX_EXCEPTIONS)
     add_executable(bigquerycontrol_quickstart "quickstart/quickstart.cc")
@@ -198,12 +35,3 @@ if (BUILD_TESTING AND GOOGLE_CLOUD_CPP_ENABLE_CXX_EXCEPTIONS)
 endif ()
 
 add_subdirectory(integration_tests)
-
-# google-cloud-cpp::experimental-bigquerycontrol must be defined before we can
-# add the samples.
-foreach (dir IN LISTS service_dirs)
-    if (BUILD_TESTING AND GOOGLE_CLOUD_CPP_ENABLE_CXX_EXCEPTIONS)
-        google_cloud_cpp_add_samples_relative("experimental-bigquerycontrol"
-                                              "${dir}samples/")
-    endif ()
-endforeach ()

google/cloud/bigquerycontrol/config.cmake.in

@@ -78,7 +78,9 @@ google_cloud_cpp_add_pkgconfig(
     rest_protobuf_internal
     "REST/Protobuf Utilities for the Google Cloud C++ Client Library"
     "Provides REST and Protobuf Utilities for the Google Cloud C++ Client Library."
-    "google_cloud_cpp_common")
+    "google_cloud_cpp_common"
+    "google_cloud_cpp_grpc_utils"
+    "google_cloud_cpp_rest_internal")
 
 # Create and install the CMake configuration files.
 configure_file("config-rest-protobuf.cmake.in"

google/cloud/google_cloud_cpp_rest_protobuf_internal.cmake

@@ -348,6 +348,7 @@ google_cloud_cpp_add_pkgconfig(
 # Create and install the CMake configuration files.
 include(CMakePackageConfigHelpers)
 set(GOOGLE_CLOUD_CPP_CONFIG_LIBRARY "pubsub")
+set(GOOGLE_CLOUD_CPP_TRANSPORT "grpc_utils")
 configure_file("${PROJECT_SOURCE_DIR}/cmake/templates/config.cmake.in"
                "google_cloud_cpp_pubsub-config.cmake" @ONLY)
 write_basic_package_version_file(

google/cloud/pubsub/CMakeLists.txt

@@ -334,6 +334,7 @@ google_cloud_cpp_add_pkgconfig(
 # Create and install the CMake configuration files.
 include(CMakePackageConfigHelpers)
 set(GOOGLE_CLOUD_CPP_CONFIG_LIBRARY "spanner")
+set(GOOGLE_CLOUD_CPP_TRANSPORT "grpc_utils")
 configure_file("${PROJECT_SOURCE_DIR}/cmake/templates/config.cmake.in"
                "google_cloud_cpp_spanner-config.cmake" @ONLY)
 write_basic_package_version_file(