feat: install/export mock libraries (#13538)

Author: dbolduc

ci/cloudbuild/builds/cmake-install.sh

@@ -151,7 +151,6 @@ expected_dirs+=(
   ./lib64/cmake/google_cloud_cpp_mocks
   ./lib64/cmake/google_cloud_cpp_oauth2
   ./lib64/cmake/google_cloud_cpp_opentelemetry
-  ./lib64/cmake/google_cloud_cpp_pubsub_mocks
   ./lib64/cmake/google_cloud_cpp_rest_internal
   ./lib64/cmake/google_cloud_cpp_rest_protobuf_internal
   ./lib64/cmake/google_cloud_cpp_storage_grpc_mocks

ci/etc/expected_install_directories

@@ -1190,130 +1190,252 @@
 ./lib64
 ./lib64/cmake
 ./lib64/cmake/google_cloud_cpp_accessapproval
+./lib64/cmake/google_cloud_cpp_accessapproval_mocks
 ./lib64/cmake/google_cloud_cpp_accesscontextmanager
+./lib64/cmake/google_cloud_cpp_accesscontextmanager_mocks
 ./lib64/cmake/google_cloud_cpp_advisorynotifications
+./lib64/cmake/google_cloud_cpp_advisorynotifications_mocks
 ./lib64/cmake/google_cloud_cpp_aiplatform
+./lib64/cmake/google_cloud_cpp_aiplatform_mocks
 ./lib64/cmake/google_cloud_cpp_alloydb
+./lib64/cmake/google_cloud_cpp_alloydb_mocks
 ./lib64/cmake/google_cloud_cpp_apigateway
+./lib64/cmake/google_cloud_cpp_apigateway_mocks
 ./lib64/cmake/google_cloud_cpp_apigeeconnect
+./lib64/cmake/google_cloud_cpp_apigeeconnect_mocks
 ./lib64/cmake/google_cloud_cpp_apikeys
+./lib64/cmake/google_cloud_cpp_apikeys_mocks
 ./lib64/cmake/google_cloud_cpp_appengine
+./lib64/cmake/google_cloud_cpp_appengine_mocks
 ./lib64/cmake/google_cloud_cpp_artifactregistry
+./lib64/cmake/google_cloud_cpp_artifactregistry_mocks
 ./lib64/cmake/google_cloud_cpp_asset
+./lib64/cmake/google_cloud_cpp_asset_mocks
 ./lib64/cmake/google_cloud_cpp_assuredworkloads
+./lib64/cmake/google_cloud_cpp_assuredworkloads_mocks
 ./lib64/cmake/google_cloud_cpp_automl
+./lib64/cmake/google_cloud_cpp_automl_mocks
 ./lib64/cmake/google_cloud_cpp_baremetalsolution
+./lib64/cmake/google_cloud_cpp_baremetalsolution_mocks
 ./lib64/cmake/google_cloud_cpp_batch
+./lib64/cmake/google_cloud_cpp_batch_mocks
 ./lib64/cmake/google_cloud_cpp_beyondcorp
+./lib64/cmake/google_cloud_cpp_beyondcorp_mocks
 ./lib64/cmake/google_cloud_cpp_bigquery
+./lib64/cmake/google_cloud_cpp_bigquery_mocks
 ./lib64/cmake/google_cloud_cpp_bigtable
 ./lib64/cmake/google_cloud_cpp_billing
+./lib64/cmake/google_cloud_cpp_billing_mocks
 ./lib64/cmake/google_cloud_cpp_binaryauthorization
+./lib64/cmake/google_cloud_cpp_binaryauthorization_mocks
 ./lib64/cmake/google_cloud_cpp_certificatemanager
+./lib64/cmake/google_cloud_cpp_certificatemanager_mocks
 ./lib64/cmake/google_cloud_cpp_channel
+./lib64/cmake/google_cloud_cpp_channel_mocks
 ./lib64/cmake/google_cloud_cpp_cloudbuild
+./lib64/cmake/google_cloud_cpp_cloudbuild_mocks
 ./lib64/cmake/google_cloud_cpp_cloudquotas
+./lib64/cmake/google_cloud_cpp_cloudquotas_mocks
 ./lib64/cmake/google_cloud_cpp_commerce
+./lib64/cmake/google_cloud_cpp_commerce_mocks
 ./lib64/cmake/google_cloud_cpp_composer
+./lib64/cmake/google_cloud_cpp_composer_mocks
 ./lib64/cmake/google_cloud_cpp_compute
 ./lib64/cmake/google_cloud_cpp_confidentialcomputing
+./lib64/cmake/google_cloud_cpp_confidentialcomputing_mocks
 ./lib64/cmake/google_cloud_cpp_config
+./lib64/cmake/google_cloud_cpp_config_mocks
 ./lib64/cmake/google_cloud_cpp_connectors
+./lib64/cmake/google_cloud_cpp_connectors_mocks
 ./lib64/cmake/google_cloud_cpp_contactcenterinsights
+./lib64/cmake/google_cloud_cpp_contactcenterinsights_mocks
 ./lib64/cmake/google_cloud_cpp_container
+./lib64/cmake/google_cloud_cpp_container_mocks
 ./lib64/cmake/google_cloud_cpp_containeranalysis
+./lib64/cmake/google_cloud_cpp_containeranalysis_mocks
 ./lib64/cmake/google_cloud_cpp_contentwarehouse
+./lib64/cmake/google_cloud_cpp_contentwarehouse_mocks
 ./lib64/cmake/google_cloud_cpp_datacatalog
+./lib64/cmake/google_cloud_cpp_datacatalog_mocks
 ./lib64/cmake/google_cloud_cpp_datafusion
+./lib64/cmake/google_cloud_cpp_datafusion_mocks
 ./lib64/cmake/google_cloud_cpp_datamigration
+./lib64/cmake/google_cloud_cpp_datamigration_mocks
 ./lib64/cmake/google_cloud_cpp_dataplex
+./lib64/cmake/google_cloud_cpp_dataplex_mocks
 ./lib64/cmake/google_cloud_cpp_dataproc
+./lib64/cmake/google_cloud_cpp_dataproc_mocks
 ./lib64/cmake/google_cloud_cpp_datastore
+./lib64/cmake/google_cloud_cpp_datastore_mocks
 ./lib64/cmake/google_cloud_cpp_datastream
+./lib64/cmake/google_cloud_cpp_datastream_mocks
 ./lib64/cmake/google_cloud_cpp_deploy
+./lib64/cmake/google_cloud_cpp_deploy_mocks
 ./lib64/cmake/google_cloud_cpp_dialogflow_cx
+./lib64/cmake/google_cloud_cpp_dialogflow_cx_mocks
 ./lib64/cmake/google_cloud_cpp_dialogflow_es
+./lib64/cmake/google_cloud_cpp_dialogflow_es_mocks
 ./lib64/cmake/google_cloud_cpp_discoveryengine
+./lib64/cmake/google_cloud_cpp_discoveryengine_mocks
 ./lib64/cmake/google_cloud_cpp_dlp
+./lib64/cmake/google_cloud_cpp_dlp_mocks
 ./lib64/cmake/google_cloud_cpp_documentai
+./lib64/cmake/google_cloud_cpp_documentai_mocks
 ./lib64/cmake/google_cloud_cpp_domains
+./lib64/cmake/google_cloud_cpp_domains_mocks
 ./lib64/cmake/google_cloud_cpp_edgecontainer
+./lib64/cmake/google_cloud_cpp_edgecontainer_mocks
 ./lib64/cmake/google_cloud_cpp_edgenetwork
+./lib64/cmake/google_cloud_cpp_edgenetwork_mocks
 ./lib64/cmake/google_cloud_cpp_essentialcontacts
+./lib64/cmake/google_cloud_cpp_essentialcontacts_mocks
 ./lib64/cmake/google_cloud_cpp_eventarc
+./lib64/cmake/google_cloud_cpp_eventarc_mocks
 ./lib64/cmake/google_cloud_cpp_filestore
+./lib64/cmake/google_cloud_cpp_filestore_mocks
 ./lib64/cmake/google_cloud_cpp_functions
+./lib64/cmake/google_cloud_cpp_functions_mocks
 ./lib64/cmake/google_cloud_cpp_gkebackup
+./lib64/cmake/google_cloud_cpp_gkebackup_mocks
 ./lib64/cmake/google_cloud_cpp_gkehub
+./lib64/cmake/google_cloud_cpp_gkehub_mocks
 ./lib64/cmake/google_cloud_cpp_gkemulticloud
+./lib64/cmake/google_cloud_cpp_gkemulticloud_mocks
 ./lib64/cmake/google_cloud_cpp_iam
+./lib64/cmake/google_cloud_cpp_iam_mocks
 ./lib64/cmake/google_cloud_cpp_iap
+./lib64/cmake/google_cloud_cpp_iap_mocks
 ./lib64/cmake/google_cloud_cpp_ids
+./lib64/cmake/google_cloud_cpp_ids_mocks
 ./lib64/cmake/google_cloud_cpp_kms
+./lib64/cmake/google_cloud_cpp_kms_mocks
 ./lib64/cmake/google_cloud_cpp_language
+./lib64/cmake/google_cloud_cpp_language_mocks
 ./lib64/cmake/google_cloud_cpp_logging
+./lib64/cmake/google_cloud_cpp_logging_mocks
 ./lib64/cmake/google_cloud_cpp_managedidentities
+./lib64/cmake/google_cloud_cpp_managedidentities_mocks
 ./lib64/cmake/google_cloud_cpp_memcache
+./lib64/cmake/google_cloud_cpp_memcache_mocks
 ./lib64/cmake/google_cloud_cpp_metastore
+./lib64/cmake/google_cloud_cpp_metastore_mocks
 ./lib64/cmake/google_cloud_cpp_migrationcenter
+./lib64/cmake/google_cloud_cpp_migrationcenter_mocks
 ./lib64/cmake/google_cloud_cpp_monitoring
+./lib64/cmake/google_cloud_cpp_monitoring_mocks
 ./lib64/cmake/google_cloud_cpp_netapp
+./lib64/cmake/google_cloud_cpp_netapp_mocks
 ./lib64/cmake/google_cloud_cpp_networkconnectivity
+./lib64/cmake/google_cloud_cpp_networkconnectivity_mocks
 ./lib64/cmake/google_cloud_cpp_networkmanagement
+./lib64/cmake/google_cloud_cpp_networkmanagement_mocks
 ./lib64/cmake/google_cloud_cpp_networksecurity
+./lib64/cmake/google_cloud_cpp_networksecurity_mocks
 ./lib64/cmake/google_cloud_cpp_networkservices
+./lib64/cmake/google_cloud_cpp_networkservices_mocks
 ./lib64/cmake/google_cloud_cpp_notebooks
+./lib64/cmake/google_cloud_cpp_notebooks_mocks
 ./lib64/cmake/google_cloud_cpp_optimization
+./lib64/cmake/google_cloud_cpp_optimization_mocks
 ./lib64/cmake/google_cloud_cpp_orgpolicy
+./lib64/cmake/google_cloud_cpp_orgpolicy_mocks
 ./lib64/cmake/google_cloud_cpp_osconfig
+./lib64/cmake/google_cloud_cpp_osconfig_mocks
 ./lib64/cmake/google_cloud_cpp_oslogin
+./lib64/cmake/google_cloud_cpp_oslogin_mocks
 ./lib64/cmake/google_cloud_cpp_policysimulator
+./lib64/cmake/google_cloud_cpp_policysimulator_mocks
 ./lib64/cmake/google_cloud_cpp_policytroubleshooter
+./lib64/cmake/google_cloud_cpp_policytroubleshooter_mocks
 ./lib64/cmake/google_cloud_cpp_privateca
+./lib64/cmake/google_cloud_cpp_privateca_mocks
 ./lib64/cmake/google_cloud_cpp_profiler
+./lib64/cmake/google_cloud_cpp_profiler_mocks
 ./lib64/cmake/google_cloud_cpp_pubsub
+./lib64/cmake/google_cloud_cpp_pubsub_mocks
 ./lib64/cmake/google_cloud_cpp_pubsublite
 ./lib64/cmake/google_cloud_cpp_rapidmigrationassessment
+./lib64/cmake/google_cloud_cpp_rapidmigrationassessment_mocks
 ./lib64/cmake/google_cloud_cpp_recaptchaenterprise
+./lib64/cmake/google_cloud_cpp_recaptchaenterprise_mocks
 ./lib64/cmake/google_cloud_cpp_recommender
+./lib64/cmake/google_cloud_cpp_recommender_mocks
 ./lib64/cmake/google_cloud_cpp_redis
+./lib64/cmake/google_cloud_cpp_redis_mocks
 ./lib64/cmake/google_cloud_cpp_resourcemanager
+./lib64/cmake/google_cloud_cpp_resourcemanager_mocks
 ./lib64/cmake/google_cloud_cpp_resourcesettings
+./lib64/cmake/google_cloud_cpp_resourcesettings_mocks
 ./lib64/cmake/google_cloud_cpp_retail
+./lib64/cmake/google_cloud_cpp_retail_mocks
 ./lib64/cmake/google_cloud_cpp_run
+./lib64/cmake/google_cloud_cpp_run_mocks
 ./lib64/cmake/google_cloud_cpp_scheduler
+./lib64/cmake/google_cloud_cpp_scheduler_mocks
 ./lib64/cmake/google_cloud_cpp_secretmanager
+./lib64/cmake/google_cloud_cpp_secretmanager_mocks
 ./lib64/cmake/google_cloud_cpp_securesourcemanager
+./lib64/cmake/google_cloud_cpp_securesourcemanager_mocks
 ./lib64/cmake/google_cloud_cpp_securitycenter
+./lib64/cmake/google_cloud_cpp_securitycenter_mocks
 ./lib64/cmake/google_cloud_cpp_servicecontrol
+./lib64/cmake/google_cloud_cpp_servicecontrol_mocks
 ./lib64/cmake/google_cloud_cpp_servicedirectory
+./lib64/cmake/google_cloud_cpp_servicedirectory_mocks
 ./lib64/cmake/google_cloud_cpp_servicehealth
+./lib64/cmake/google_cloud_cpp_servicehealth_mocks
 ./lib64/cmake/google_cloud_cpp_servicemanagement
+./lib64/cmake/google_cloud_cpp_servicemanagement_mocks
 ./lib64/cmake/google_cloud_cpp_serviceusage
+./lib64/cmake/google_cloud_cpp_serviceusage_mocks
 ./lib64/cmake/google_cloud_cpp_shell
+./lib64/cmake/google_cloud_cpp_shell_mocks
 ./lib64/cmake/google_cloud_cpp_spanner
 ./lib64/cmake/google_cloud_cpp_speech
+./lib64/cmake/google_cloud_cpp_speech_mocks
 ./lib64/cmake/google_cloud_cpp_sql
 ./lib64/cmake/google_cloud_cpp_storage
 ./lib64/cmake/google_cloud_cpp_storagecontrol
+./lib64/cmake/google_cloud_cpp_storagecontrol_mocks
 ./lib64/cmake/google_cloud_cpp_storageinsights
+./lib64/cmake/google_cloud_cpp_storageinsights_mocks
 ./lib64/cmake/google_cloud_cpp_storagetransfer
+./lib64/cmake/google_cloud_cpp_storagetransfer_mocks
 ./lib64/cmake/google_cloud_cpp_support
+./lib64/cmake/google_cloud_cpp_support_mocks
 ./lib64/cmake/google_cloud_cpp_talent
+./lib64/cmake/google_cloud_cpp_talent_mocks
 ./lib64/cmake/google_cloud_cpp_tasks
+./lib64/cmake/google_cloud_cpp_tasks_mocks
 ./lib64/cmake/google_cloud_cpp_telcoautomation
+./lib64/cmake/google_cloud_cpp_telcoautomation_mocks
 ./lib64/cmake/google_cloud_cpp_texttospeech
+./lib64/cmake/google_cloud_cpp_texttospeech_mocks
 ./lib64/cmake/google_cloud_cpp_timeseriesinsights
+./lib64/cmake/google_cloud_cpp_timeseriesinsights_mocks
 ./lib64/cmake/google_cloud_cpp_tpu
+./lib64/cmake/google_cloud_cpp_tpu_mocks
 ./lib64/cmake/google_cloud_cpp_trace
+./lib64/cmake/google_cloud_cpp_trace_mocks
 ./lib64/cmake/google_cloud_cpp_translate
+./lib64/cmake/google_cloud_cpp_translate_mocks
 ./lib64/cmake/google_cloud_cpp_video
+./lib64/cmake/google_cloud_cpp_video_mocks
 ./lib64/cmake/google_cloud_cpp_videointelligence
+./lib64/cmake/google_cloud_cpp_videointelligence_mocks
 ./lib64/cmake/google_cloud_cpp_vision
+./lib64/cmake/google_cloud_cpp_vision_mocks
 ./lib64/cmake/google_cloud_cpp_vmmigration
+./lib64/cmake/google_cloud_cpp_vmmigration_mocks
 ./lib64/cmake/google_cloud_cpp_vmwareengine
+./lib64/cmake/google_cloud_cpp_vmwareengine_mocks
 ./lib64/cmake/google_cloud_cpp_vpcaccess
+./lib64/cmake/google_cloud_cpp_vpcaccess_mocks
 ./lib64/cmake/google_cloud_cpp_webrisk
+./lib64/cmake/google_cloud_cpp_webrisk_mocks
 ./lib64/cmake/google_cloud_cpp_websecurityscanner
+./lib64/cmake/google_cloud_cpp_websecurityscanner_mocks
 ./lib64/cmake/google_cloud_cpp_workflows
+./lib64/cmake/google_cloud_cpp_workflows_mocks
 ./lib64/cmake/google_cloud_cpp_workstations
+./lib64/cmake/google_cloud_cpp_workstations_mocks

ci/verify_current_targets/CMakeLists.txt

@@ -27,6 +27,7 @@ set(ga_libraries
     bigquery
     bigtable
     iam
+    iam_mocks
     logging
     opentelemetry
     pubsub

cmake/GoogleCloudCppLibrary.cmake

@@ -264,7 +264,10 @@ function (google_cloud_cpp_add_gapic_library library display_name)
     list(SORT relative_mock_files)
     set(mock_files)
     foreach (file IN LISTS relative_mock_files)
-        list(APPEND mock_files "${CMAKE_CURRENT_SOURCE_DIR}/${file}")
+        # 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(${mocks_target} INTERFACE)
     target_sources(${mocks_target} INTERFACE ${mock_files})
@@ -306,8 +309,6 @@ function (google_cloud_cpp_add_gapic_library library display_name)
 
     google_cloud_cpp_install_headers("${library_target}"
                                      "include/google/cloud/${library}")
-    google_cloud_cpp_install_headers("${mocks_target}"
-                                     "include/google/cloud/${library}")
 
     google_cloud_cpp_add_pkgconfig(
         ${library}
@@ -348,6 +349,37 @@ function (google_cloud_cpp_add_gapic_library library display_name)
         DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${library_target}"
         COMPONENT google_cloud_cpp_development)
 
+    # Install mocks
+    install(
+        EXPORT ${mocks_target}-targets
+        DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${mocks_target}"
+        COMPONENT google_cloud_cpp_development)
+    install(
+        TARGETS ${mocks_target}
+        EXPORT ${mocks_target}-targets
+        COMPONENT google_cloud_cpp_development)
+
+    google_cloud_cpp_install_headers("${mocks_target}"
+                                     "include/google/cloud/${library}")
+
+    google_cloud_cpp_add_pkgconfig(
+        ${library}_mocks "${display_name} Mocks"
+        "Mocks for the ${display_name} C++ Client Library" "${library_target}"
+        "gmock_main")
+
+    configure_file("${PROJECT_SOURCE_DIR}/cmake/templates/mocks-config.cmake.in"
+                   "${mocks_target}-config.cmake" @ONLY)
+    write_basic_package_version_file(
+        "${mocks_target}-config-version.cmake"
+        VERSION ${PROJECT_VERSION}
+        COMPATIBILITY ExactVersion)
+
+    install(
+        FILES "${CMAKE_CURRENT_BINARY_DIR}/${mocks_target}-config.cmake"
+              "${CMAKE_CURRENT_BINARY_DIR}/${mocks_target}-config-version.cmake"
+        DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${mocks_target}"
+        COMPONENT google_cloud_cpp_development)
+
     # ${library_alias} must be defined before we can add the samples.
     if (BUILD_TESTING AND GOOGLE_CLOUD_CPP_ENABLE_CXX_EXCEPTIONS)
         foreach (dir IN LISTS _opt_SERVICE_DIRS)

cmake/templates/mocks-config.cmake.in

@@ -0,0 +1,19 @@
+# Copyright 2024 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(CMakeFindDependencyMacro)
+find_dependency(@GOOGLE_CLOUD_CPP_CONFIG_LIBRARY@)
+find_dependency(GTest)
+
+include("${CMAKE_CURRENT_LIST_DIR}/@GOOGLE_CLOUD_CPP_CONFIG_LIBRARY@_mocks-targets.cmake")

generator/standalone_main.cc

@@ -20,6 +20,7 @@
 #include "generator/internal/scaffold_generator.h"
 #include "google/cloud/internal/absl_str_cat_quiet.h"
 #include "google/cloud/internal/absl_str_join_quiet.h"
+#include "google/cloud/internal/algorithm.h"
 #include "google/cloud/log.h"
 #include "google/cloud/status_or.h"
 #include "absl/flags/flag.h"
@@ -166,6 +167,13 @@ int WriteInstallDirectories(
     }
     auto const lib = LibraryName(product_path);
     install_directories.push_back("./lib64/cmake/google_cloud_cpp_" + lib);
+    // TODO(#5782) - install mocks in libs with handwritten CMakeLists.txt
+    auto const handwritten_cmake = std::set<std::string>{
+        {"bigtable", "compute", "pubsublite", "spanner", "sql", "storage"}};
+    if (!google::cloud::internal::Contains(handwritten_cmake, lib)) {
+      install_directories.push_back("./lib64/cmake/google_cloud_cpp_" + lib +
+                                    "_mocks");
+    }
   }
   std::sort(install_directories.begin(), install_directories.end());
   auto end =