feat(apikeys): generate library (#9699)

BUILD.bazel

@@ -21,6 +21,8 @@ exports_files([
 ])
 
 EXPERIMENTAL_LIBRARIES = [
+    # Introduced circa 2022-08-17
+    "apikeys",
     # Introduced circa 2022-07-22
     "beyondcorp",
     # Introduced circa 2022-07-12

CHANGELOG.md

@@ -126,6 +126,14 @@ may elicit a deprecation warning. See [#9086] for more details.
 
 ## v2.2.0 - TBD
 
+### New Libraries
+
+We are introducing new client libraries for GCP services. While we do not
+anticipate any API changes to these libraries before declaring them GA, we are
+releasing them early in case they elicit some feedback that requires changes.
+
+* [API Keys](/google/cloud/apikeys/README.md)
+
 ### [Storage](/google/cloud/storage/README.md)
 
 * We have a new implementation for HTTP requests. This new implementation

ci/etc/expected_install_directories

@@ -2,6 +2,8 @@
 ./include
 ./include/google
 ./include/google/api
+./include/google/api/apikeys
+./include/google/api/apikeys/v2
 ./include/google/api/servicecontrol
 ./include/google/api/servicecontrol/v1
 ./include/google/api/servicemanagement
@@ -30,6 +32,9 @@
 ./include/google/cloud/apigeeconnect/internal
 ./include/google/cloud/apigeeconnect/mocks
 ./include/google/cloud/apigeeconnect/v1
+./include/google/cloud/apikeys
+./include/google/cloud/apikeys/internal
+./include/google/cloud/apikeys/mocks
 ./include/google/cloud/appengine
 ./include/google/cloud/appengine/internal
 ./include/google/cloud/appengine/mocks
@@ -437,6 +442,7 @@
 ./lib64/cmake/google_cloud_cpp_accesscontextmanager
 ./lib64/cmake/google_cloud_cpp_apigateway
 ./lib64/cmake/google_cloud_cpp_apigeeconnect
+./lib64/cmake/google_cloud_cpp_apikeys
 ./lib64/cmake/google_cloud_cpp_appengine
 ./lib64/cmake/google_cloud_cpp_artifactregistry
 ./lib64/cmake/google_cloud_cpp_asset

ci/etc/full_feature_list

@@ -2,6 +2,7 @@ accessapproval
 accesscontextmanager
 apigateway
 apigeeconnect
+apikeys
 appengine
 artifactregistry
 asset

external/googleapis/protodeps/apikeys.deps

@@ -0,0 +1,7 @@
+@com_google_googleapis//google/api:annotations_proto
+@com_google_googleapis//google/api:client_proto
+@com_google_googleapis//google/api:field_behavior_proto
+@com_google_googleapis//google/api:http_proto
+@com_google_googleapis//google/api:resource_proto
+@com_google_googleapis//google/longrunning:operations_proto
+@com_google_googleapis//google/rpc:status_proto

external/googleapis/protolists/apikeys.list

@@ -0,0 +1,2 @@
+@com_google_googleapis//google/api/apikeys/v2:apikeys.proto
+@com_google_googleapis//google/api/apikeys/v2:resources.proto

external/googleapis/update_libraries.sh

@@ -24,6 +24,7 @@ declare -A -r LIBRARIES=(
   )"
   ["apigateway"]="@com_google_googleapis//google/cloud/apigateway/v1:apigateway_cc_grpc"
   ["apigeeconnect"]="@com_google_googleapis//google/cloud/apigeeconnect/v1:apigeeconnect_cc_grpc"
+  ["apikeys"]="@com_google_googleapis//google/api/apikeys/v2:apikeys_cc_grpc"
   ["appengine"]="$(
     printf ",%s" \
       "@com_google_googleapis//google/appengine/v1:appengine_cc_grpc" \

generator/generator_config.textproto

@@ -47,6 +47,14 @@ service {
   retryable_status_codes: ["kUnavailable", "kUnknown"]
 }
 
+# API Keys
+service {
+  service_proto_path: "google/api/apikeys/v2/apikeys.proto"
+  product_path: "google/cloud/apikeys"
+  initial_copyright_year: "2022"
+  retryable_status_codes: ["kUnavailable"]
+}
+
 # App Engine Admin
 service {
   service_proto_path: "google/appengine/v1/appengine.proto"

google/cloud/apikeys/BUILD.bazel

@@ -0,0 +1,59 @@
+# Copyright 2022 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.
+
+package(default_visibility = ["//visibility:private"])
+
+licenses(["notice"])  # Apache 2.0
+
+SOURCE_GLOB = "**/*.cc"
+
+MOCK_SOURCE_GLOB = "mocks/*.cc"
+
+HEADER_GLOB = "**/*.h"
+
+MOCK_HEADER_GLOB = "mocks/*.h"
+
+cc_library(
+    name = "google_cloud_cpp_apikeys",
+    srcs = glob(
+        include = [SOURCE_GLOB],
+        exclude = [MOCK_SOURCE_GLOB],
+    ),
+    hdrs = glob(
+        include = [HEADER_GLOB],
+        exclude = [MOCK_HEADER_GLOB],
+    ),
+    visibility = ["//:__pkg__"],
+    deps = [
+        "//:common",
+        "//:grpc_utils",
+        "@com_google_googleapis//google/api/apikeys/v2:apikeys_cc_grpc",
+    ],
+)
+
+cc_library(
+    name = "google_cloud_cpp_apikeys_mocks",
+    srcs = glob(
+        include = [MOCK_SOURCE_GLOB],
+    ),
+    hdrs = glob(
+        include = [MOCK_HEADER_GLOB],
+    ),
+    visibility = ["//:__pkg__"],
+    deps = [
+        ":google_cloud_cpp_apikeys",
+        "//:common",
+        "//:grpc_utils",
+    ],
+)

google/cloud/apikeys/CMakeLists.txt

@@ -0,0 +1,182 @@
+# ~~~
+# Copyright 2022 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(GoogleapisConfig)
+set(DOXYGEN_PROJECT_NAME "API Keys API C++ Client")
+set(DOXYGEN_PROJECT_BRIEF "A C++ Client Library for the API Keys API")
+set(DOXYGEN_PROJECT_NUMBER "${PROJECT_VERSION} (Experimental)")
+set(DOXYGEN_EXCLUDE_SYMBOLS "internal" "apikeys_internal" "apikeys_testing"
+                            "examples")
+set(DOXYGEN_EXAMPLE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/quickstart)
+
+# Creates the proto headers needed by doxygen.
+set(GOOGLE_CLOUD_CPP_DOXYGEN_DEPS google-cloud-cpp::apikeys_protos)
+
+include(GoogleCloudCppCommon)
+
+set(EXTERNAL_GOOGLEAPIS_SOURCE
+    "${PROJECT_BINARY_DIR}/external/googleapis/src/googleapis_download")
+find_path(PROTO_INCLUDE_DIR google/protobuf/descriptor.proto)
+if (PROTO_INCLUDE_DIR)
+    list(INSERT PROTOBUF_IMPORT_DIRS 0 "${PROTO_INCLUDE_DIR}")
+endif ()
+
+include(CompileProtos)
+google_cloud_cpp_load_protolist(
+    proto_list
+    "${PROJECT_SOURCE_DIR}/external/googleapis/protolists/apikeys.list")
+google_cloud_cpp_load_protodeps(
+    proto_deps
+    "${PROJECT_SOURCE_DIR}/external/googleapis/protodeps/apikeys.deps")
+google_cloud_cpp_grpcpp_library(
+    google_cloud_cpp_apikeys_protos # cmake-format: sort
+    ${proto_list} PROTO_PATH_DIRECTORIES "${EXTERNAL_GOOGLEAPIS_SOURCE}"
+    "${PROTO_INCLUDE_DIR}")
+external_googleapis_set_version_and_alias(apikeys_protos)
+target_link_libraries(google_cloud_cpp_apikeys_protos PUBLIC ${proto_deps})
+
+file(
+    GLOB source_files
+    RELATIVE "${CMAKE_CURRENT_SOURCE_DIR}"
+    "*.h" "*.cc" "internal/*.h" "internal/*.cc")
+list(SORT source_files)
+add_library(google_cloud_cpp_apikeys ${source_files})
+target_include_directories(
+    google_cloud_cpp_apikeys
+    PUBLIC $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}>
+           $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}>
+           $<INSTALL_INTERFACE:include>)
+target_link_libraries(
+    google_cloud_cpp_apikeys
+    PUBLIC google-cloud-cpp::grpc_utils google-cloud-cpp::common
+           google-cloud-cpp::apikeys_protos)
+google_cloud_cpp_add_common_options(google_cloud_cpp_apikeys)
+set_target_properties(
+    google_cloud_cpp_apikeys
+    PROPERTIES EXPORT_NAME google-cloud-cpp::experimental-apikeys
+               VERSION "${PROJECT_VERSION}"
+               SOVERSION "${PROJECT_VERSION_MAJOR}")
+target_compile_options(google_cloud_cpp_apikeys
+                       PUBLIC ${GOOGLE_CLOUD_CPP_EXCEPTIONS_FLAG})
+
+add_library(google-cloud-cpp::experimental-apikeys ALIAS
+            google_cloud_cpp_apikeys)
+
+# 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/*.h")
+list(SORT relative_mock_files)
+set(mock_files)
+foreach (file IN LISTS relative_mock_files)
+    list(APPEND mock_files "${CMAKE_CURRENT_SOURCE_DIR}/${file}")
+endforeach ()
+add_library(google_cloud_cpp_apikeys_mocks INTERFACE)
+target_sources(google_cloud_cpp_apikeys_mocks INTERFACE ${mock_files})
+target_link_libraries(
+    google_cloud_cpp_apikeys_mocks
+    INTERFACE google-cloud-cpp::experimental-apikeys GTest::gmock_main
+              GTest::gmock GTest::gtest)
+set_target_properties(
+    google_cloud_cpp_apikeys_mocks
+    PROPERTIES EXPORT_NAME google-cloud-cpp::experimental-apikeys_mocks)
+target_include_directories(
+    google_cloud_cpp_apikeys_mocks
+    INTERFACE $<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}>
+              $<BUILD_INTERFACE:${PROJECT_BINARY_DIR}>
+              $<INSTALL_INTERFACE:include>)
+target_compile_options(google_cloud_cpp_apikeys_mocks
+                       INTERFACE ${GOOGLE_CLOUD_CPP_EXCEPTIONS_FLAG})
+
+include(CTest)
+if (BUILD_TESTING)
+    add_executable(apikeys_quickstart "quickstart/quickstart.cc")
+    target_link_libraries(apikeys_quickstart
+                          PRIVATE google-cloud-cpp::experimental-apikeys)
+    google_cloud_cpp_add_common_options(apikeys_quickstart)
+    add_test(
+        NAME apikeys_quickstart
+        COMMAND cmake -P "${PROJECT_SOURCE_DIR}/cmake/quickstart-runner.cmake"
+                $<TARGET_FILE:apikeys_quickstart> GOOGLE_CLOUD_PROJECT)
+    set_tests_properties(apikeys_quickstart
+                         PROPERTIES LABELS "integration-test;quickstart")
+endif ()
+
+# 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_apikeys-targets
+    DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/google_cloud_cpp_apikeys"
+    COMPONENT google_cloud_cpp_development)
+
+# Install the libraries and headers in the locations determined by
+# GNUInstallDirs
+install(
+    TARGETS google_cloud_cpp_apikeys google_cloud_cpp_apikeys_protos
+    EXPORT google_cloud_cpp_apikeys-targets
+    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+            COMPONENT google_cloud_cpp_runtime
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+            COMPONENT google_cloud_cpp_runtime
+            NAMELINK_SKIP
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+            COMPONENT google_cloud_cpp_development)
+# With CMake-3.12 and higher we could avoid this separate command (and the
+# duplication).
+install(
+    TARGETS google_cloud_cpp_apikeys google_cloud_cpp_apikeys_protos
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+            COMPONENT google_cloud_cpp_development
+            NAMELINK_ONLY
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
+            COMPONENT google_cloud_cpp_development)
+
+google_cloud_cpp_install_proto_library_protos("google_cloud_cpp_apikeys_protos"
+                                              "${EXTERNAL_GOOGLEAPIS_SOURCE}")
+google_cloud_cpp_install_proto_library_headers(
+    "google_cloud_cpp_apikeys_protos")
+google_cloud_cpp_install_headers("google_cloud_cpp_apikeys"
+                                 "include/google/cloud/apikeys")
+google_cloud_cpp_install_headers("google_cloud_cpp_apikeys_mocks"
+                                 "include/google/cloud/apikeys")
+
+google_cloud_cpp_add_pkgconfig(
+    apikeys "The API Keys API C++ Client Library"
+    "Provides C++ APIs to use the API Keys API." "google_cloud_cpp_grpc_utils"
+    " google_cloud_cpp_common" " google_cloud_cpp_apikeys_protos")
+
+# Create and install the CMake configuration files.
+include(CMakePackageConfigHelpers)
+configure_file("config.cmake.in" "google_cloud_cpp_apikeys-config.cmake" @ONLY)
+write_basic_package_version_file(
+    "google_cloud_cpp_apikeys-config-version.cmake"
+    VERSION ${PROJECT_VERSION}
+    COMPATIBILITY ExactVersion)
+
+install(
+    FILES
+        "${CMAKE_CURRENT_BINARY_DIR}/google_cloud_cpp_apikeys-config.cmake"
+        "${CMAKE_CURRENT_BINARY_DIR}/google_cloud_cpp_apikeys-config-version.cmake"
+    DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/google_cloud_cpp_apikeys"
+    COMPONENT google_cloud_cpp_development)
+
+external_googleapis_install_pc("google_cloud_cpp_apikeys_protos")