ci: make super build configuration more consistent (#107)

Some CMake configuration options were not consistently used in the super
build, including `CMAKE_BUILD_TYPE`, `BUILD_SHARED_LIBS`,
`CMAKE_CXX_COMPILER`, and `CMAKE_C_COMPILER`. In this change
I refactored all of these parameters to a function and pass them to each
sub-project.

I also made some cosmetic changes as I am planning to use these files as
templates for all the other repositories.

Author: coryan

ci/kokoro/docker/build.sh

@@ -103,6 +103,8 @@ elif [[ "${BUILD_NAME}" = "ubsan" ]]; then
   in_docker_script="ci/kokoro/docker/build-in-docker-bazel.sh"
 elif [[ "${BUILD_NAME}" = "cmake-super" ]]; then
   export CMAKE_SOURCE_DIR="super"
+  export BUILD_TYPE=Release
+  export CMAKE_FLAGS=-DBUILD_SHARED_LIBS=ON
   # Note that the integration tests are run by default. This is the opposite of
   # what spanner does where RUN_INTEGRATION_TESTS is explicitly set to yes.
   export RUN_INTEGRATION_TESTS="no"

super/CMakeLists.txt

@@ -28,16 +28,15 @@ include(external/googleapis)
 include(external/googletest)
 
 include(ExternalProjectHelper)
-set_external_project_prefix_vars()
-
 set_external_project_build_parallel_level(PARALLEL)
+set_external_project_vars()
 
-set(GOOGLE_CLOUD_CPP_DEPENDENCIES_LIST grpc_project googleapis_project
-                                       googletest_project)
+set(GOOGLE_CLOUD_CPP_DEPENDENCIES_LIST grpc-project googleapis-project
+                                       googletest-project)
 
 include(ExternalProject)
 ExternalProject_Add(
-    google_cloud_cpp_project
+    google-cloud-cpp-project
     DEPENDS ${GOOGLE_CLOUD_CPP_DEPENDENCIES_LIST}
     EXCLUDE_FROM_ALL OFF
     PREFIX "${CMAKE_BINARY_DIR}/build/google-cloud-cpp"
@@ -46,7 +45,7 @@ ExternalProject_Add(
         SOURCE_DIR
         "${GOOGLE_CLOUD_CPP_ROOT}"
     LIST_SEPARATOR |
-    CMAKE_ARGS -G${CMAKE_GENERATOR}
+    CMAKE_ARGS ${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CMAKE_FLAGS}
                -DCMAKE_PREFIX_PATH=${GOOGLE_CLOUD_CPP_PREFIX_PATH}
                -DCMAKE_INSTALL_RPATH=${GOOGLE_CLOUD_CPP_INSTALL_RPATH}
                -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>

super/ExternalProjectHelper.cmake

@@ -43,7 +43,7 @@ function (set_external_project_build_parallel_level var_name)
     endif ()
 endfunction ()
 
-function (set_external_project_prefix_vars)
+function (set_external_project_vars)
     set(GOOGLE_CLOUD_CPP_INSTALL_RPATH "<INSTALL_DIR>/lib;<INSTALL_DIR>/lib64")
 
     # On Linux, using an RPATH that is neither an absolute or relative path is
@@ -54,6 +54,17 @@ function (set_external_project_prefix_vars)
             "\\\$ORIGIN/../lib;\\\$ORIGIN/../lib64")
     endif ()
 
+    set(GOOGLE_CLOUD_CPP_PREFIX_PATH
+        "${CMAKE_PREFIX_PATH}" "${GOOGLE_CLOUD_CPP_EXTERNAL_PREFIX}"
+        "<INSTALL_DIR>")
+
+    set(GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CMAKE_FLAGS
+        ${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CCACHE}
+        -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
+        -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
+        -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
+        -DBUILD_SHARED_LIBS=${BUILD_SHARED_LIBS})
+
     # When passing a semi-colon delimited list to ExternalProject_Add, we need
     # to escape the semi-colon. Quoting does not work and escaping the semi-
     # colon does not seem to work (see https://reviews.llvm.org/D40257). A
@@ -64,15 +75,17 @@ function (set_external_project_prefix_vars)
     # character in CMake.
     string(REPLACE ";" "|" GOOGLE_CLOUD_CPP_INSTALL_RPATH
                    "${GOOGLE_CLOUD_CPP_INSTALL_RPATH}")
-
-    set(GOOGLE_CLOUD_CPP_PREFIX_PATH "${CMAKE_PREFIX_PATH};<INSTALL_DIR>")
     string(REPLACE ";" "|" GOOGLE_CLOUD_CPP_PREFIX_PATH
                    "${GOOGLE_CLOUD_CPP_PREFIX_PATH}")
 
+    set(GOOGLE_CLOUD_CPP_INSTALL_RPATH
+        "${GOOGLE_CLOUD_CPP_INSTALL_RPATH}"
+        PARENT_SCOPE)
     set(GOOGLE_CLOUD_CPP_PREFIX_PATH
         "${GOOGLE_CLOUD_CPP_PREFIX_PATH}"
         PARENT_SCOPE)
-    set(GOOGLE_CLOUD_CPP_PREFIX_RPATH
-        "${GOOGLE_CLOUD_CPP_PREFIX_RPATH}"
+    set(GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CMAKE_FLAGS
+        "${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CMAKE_FLAGS}"
         PARENT_SCOPE)
+
 endfunction ()

super/external/c-ares.cmake

@@ -16,7 +16,7 @@
 
 include(ExternalProjectHelper)
 
-if (NOT TARGET c_ares_project)
+if (NOT TARGET c-ares-project)
     # Give application developers a hook to configure the version and hash
     # downloaded from GitHub.
     set(GOOGLE_CLOUD_CPP_C_ARES_URL
@@ -25,23 +25,20 @@ if (NOT TARGET c_ares_project)
         "62dd12f0557918f89ad6f5b759f0bf4727174ae9979499f5452c02be38d9d3e8")
 
     set_external_project_build_parallel_level(PARALLEL)
-
-    set_external_project_prefix_vars()
+    set_external_project_vars()
 
     include(ExternalProject)
     ExternalProject_Add(
-        c_ares_project
+        c-ares-project
         EXCLUDE_FROM_ALL ON
         PREFIX "${CMAKE_BINARY_DIR}/external/c-ares"
         INSTALL_DIR "${GOOGLE_CLOUD_CPP_EXTERNAL_PREFIX}"
         URL ${GOOGLE_CLOUD_CPP_C_ARES_URL}
         URL_HASH SHA256=${GOOGLE_CLOUD_CPP_C_ARES_SHA256}
         LIST_SEPARATOR |
-        CMAKE_ARGS ${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CCACHE}
-                   -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-                   -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-                   -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
+        CMAKE_ARGS ${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CMAKE_FLAGS}
                    -DCMAKE_PREFIX_PATH=${GOOGLE_CLOUD_CPP_PREFIX_PATH}
+                   -DCMAKE_INSTALL_RPATH=${GOOGLE_CLOUD_CPP_INSTALL_RPATH}
                    -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
         BUILD_COMMAND ${CMAKE_COMMAND} --build <BINARY_DIR> ${PARALLEL}
         LOG_DOWNLOAD ON

super/external/googleapis.cmake

@@ -19,7 +19,7 @@ find_package(Threads REQUIRED)
 
 include(external/grpc)
 
-if (NOT TARGET googleapis_project)
+if (NOT TARGET googleapis-project)
     # Give application developers a hook to configure the version and hash
     # downloaded from GitHub.
     set(GOOGLE_CLOUD_CPP_GOOGLEAPIS_URL
@@ -28,13 +28,12 @@ if (NOT TARGET googleapis_project)
         "f1443a10c545114b19fe9dc352568cb03b588813b12cc5db8780b64ae9a09ce1")
 
     set_external_project_build_parallel_level(PARALLEL)
-
-    set_external_project_prefix_vars()
+    set_external_project_vars()
 
     include(ExternalProject)
     ExternalProject_Add(
-        googleapis_project
-        DEPENDS grpc_project
+        googleapis-project
+        DEPENDS grpc-project
         EXCLUDE_FROM_ALL ON
         PREFIX "${CMAKE_BINARY_DIR}/external/googleapis"
         INSTALL_DIR "${GOOGLE_CLOUD_CPP_EXTERNAL_PREFIX}"
@@ -44,14 +43,10 @@ if (NOT TARGET googleapis_project)
         CONFIGURE_COMMAND
             ${CMAKE_COMMAND}
             -G${CMAKE_GENERATOR}
-            ${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CCACHE}
-            -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-            -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-            -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-            -DBUILD_SHARED_LIBS=${BUILD_SHARED_LIBS}
-            -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
+            ${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CMAKE_FLAGS}
             -DCMAKE_PREFIX_PATH=${GOOGLE_CLOUD_CPP_PREFIX_PATH}
             -DCMAKE_INSTALL_RPATH=${GOOGLE_CLOUD_CPP_INSTALL_RPATH}
+            -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
             -H<SOURCE_DIR>
             -B<BINARY_DIR>
         BUILD_COMMAND ${CMAKE_COMMAND} --build <BINARY_DIR> ${PARALLEL}

super/external/googletest.cmake

@@ -16,7 +16,7 @@
 
 include(ExternalProjectHelper)
 
-if (NOT TARGET googletest_project)
+if (NOT TARGET googletest-project)
     # Give application developers a hook to configure the version and hash
     # downloaded from GitHub.
     set(GOOGLE_CLOUD_CPP_GOOGLETEST_URL
@@ -25,24 +25,20 @@ if (NOT TARGET googletest_project)
         "9dc9157a9a1551ec7a7e43daea9a694a0bb5fb8bec81235d8a1e6ef64c716dcb")
 
     set_external_project_build_parallel_level(PARALLEL)
-
-    set_external_project_prefix_vars()
+    set_external_project_vars()
 
     include(ExternalProject)
     ExternalProject_Add(
-        googletest_project
+        googletest-project
         EXCLUDE_FROM_ALL ON
         PREFIX "${CMAKE_BINARY_DIR}/external/googletest"
         INSTALL_DIR "${GOOGLE_CLOUD_CPP_EXTERNAL_PREFIX}"
         URL ${GOOGLE_CLOUD_CPP_GOOGLETEST_URL}
         URL_HASH SHA256=${GOOGLE_CLOUD_CPP_GOOGLETEST_SHA256}
         LIST_SEPARATOR |
-        CMAKE_ARGS ${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CCACHE}
-                   -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-                   -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-                   -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-                   -DBUILD_SHARED_LIBS=${BUILD_SHARED_LIBS}
+        CMAKE_ARGS ${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CMAKE_FLAGS}
                    -DCMAKE_PREFIX_PATH=${GOOGLE_CLOUD_CPP_PREFIX_PATH}
+                   -DCMAKE_INSTALL_RPATH=${GOOGLE_CLOUD_CPP_INSTALL_RPATH}
                    -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
         BUILD_COMMAND ${CMAKE_COMMAND} --build <BINARY_DIR> ${PARALLEL}
         LOG_DOWNLOAD ON

super/external/grpc.cmake

@@ -19,7 +19,7 @@ include(external/c-ares)
 include(external/ssl)
 include(external/protobuf)
 
-if (NOT TARGET grpc_project)
+if (NOT TARGET grpc-project)
     # Give application developers a hook to configure the version and hash
     # downloaded from GitHub.
     set(GOOGLE_CLOUD_CPP_GRPC_URL
@@ -28,27 +28,22 @@ if (NOT TARGET grpc_project)
         "c84b3fa140fcd6cce79b3f9de6357c5733a0071e04ca4e65ba5f8d306f10f033")
 
     set_external_project_build_parallel_level(PARALLEL)
-
-    set_external_project_prefix_vars()
+    set_external_project_vars()
 
     include(ExternalProject)
     ExternalProject_Add(
-        grpc_project
-        DEPENDS c_ares_project protobuf_project ssl_project
+        grpc-project
+        DEPENDS c-ares-project protobuf-project ssl-project
         EXCLUDE_FROM_ALL ON
         PREFIX "${CMAKE_BINARY_DIR}/external/grpc"
         INSTALL_DIR "${GOOGLE_CLOUD_CPP_EXTERNAL_PREFIX}"
         URL ${GOOGLE_CLOUD_CPP_GRPC_URL}
         URL_HASH SHA256=${GOOGLE_CLOUD_CPP_GRPC_SHA256}
         LIST_SEPARATOR |
-        CMAKE_ARGS ${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CCACHE}
-                   -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-                   -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-                   -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-                   -DBUILD_SHARED_LIBS=${BUILD_SHARED_LIBS}
+        CMAKE_ARGS ${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CMAKE_FLAGS}
                    -DCMAKE_PREFIX_PATH=${GOOGLE_CLOUD_CPP_PREFIX_PATH}
-                   -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
                    -DCMAKE_INSTALL_RPATH=${GOOGLE_CLOUD_CPP_INSTALL_RPATH}
+                   -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
                    -DgRPC_BUILD_TESTS=OFF
                    -DgRPC_ZLIB_PROVIDER=package
                    -DgRPC_SSL_PROVIDER=package

super/external/protobuf.cmake

@@ -19,7 +19,7 @@ find_package(Threads REQUIRED)
 include(ExternalProjectHelper)
 include(external/zlib)
 
-if (NOT TARGET protobuf_project)
+if (NOT TARGET protobuf-project)
     # Give application developers a hook to configure the version and hash
     # downloaded from GitHub.
     set(GOOGLE_CLOUD_CPP_PROTOBUF_URL
@@ -28,13 +28,12 @@ if (NOT TARGET protobuf_project)
         "98e615d592d237f94db8bf033fba78cd404d979b0b70351a9e5aaff725398357")
 
     set_external_project_build_parallel_level(PARALLEL)
-
-    set_external_project_prefix_vars()
+    set_external_project_vars()
 
     include(ExternalProject)
     ExternalProject_Add(
-        protobuf_project
-        DEPENDS zlib_project
+        protobuf-project
+        DEPENDS zlib-project
         EXCLUDE_FROM_ALL ON
         PREFIX "${CMAKE_BINARY_DIR}/external/protobuf"
         INSTALL_DIR "${GOOGLE_CLOUD_CPP_EXTERNAL_PREFIX}"
@@ -44,14 +43,10 @@ if (NOT TARGET protobuf_project)
         CONFIGURE_COMMAND
             ${CMAKE_COMMAND}
             -G${CMAKE_GENERATOR}
-            ${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CCACHE}
-            -DCMAKE_BUILD_TYPE=Debug
-            -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-            -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-            -DBUILD_SHARED_LIBS=${BUILD_SHARED_LIBS}
-            -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
+            ${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CMAKE_FLAGS}
             -DCMAKE_PREFIX_PATH=${GOOGLE_CLOUD_CPP_PREFIX_PATH}
             -DCMAKE_INSTALL_RPATH=${GOOGLE_CLOUD_CPP_INSTALL_RPATH}
+            -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
             # Protobuf installs using `CMAKE_INSTALL_LIBDIR`, as it should,
             # which expands to `lib` or `lib64`. But hard-codes RPATH to
             # `$ORIGIN/../lib`, so change the default `LIBDIR` to something that

super/external/ssl.cmake

@@ -14,13 +14,13 @@
 # limitations under the License.
 # ~~~
 
-if (NOT TARGET ssl_project)
+if (NOT TARGET ssl-project)
     # For OpenSSL we don't really support external projects. OpenSSL build
     # system is notoriously finicky. Use vcpkg on Windows, or install OpenSSL
     # using your operating system packages instead.
     #
     # This file is here to simplify the definition of external projects, such as
     # curl and gRPC, that depend on a SSL library.
-    add_custom_target(ssl_project)
     find_package(OpenSSL REQUIRED)
+    add_custom_target(ssl-project)
 endif ()

super/external/zlib.cmake

@@ -14,7 +14,7 @@
 # limitations under the License.
 # ~~~
 
-if (NOT TARGET zlib_project)
+if (NOT TARGET zlib-project)
     # Give application developers a hook to configure the version and hash
     # downloaded from GitHub.
     set(GOOGLE_CLOUD_CPP_ZLIB_URL
@@ -23,24 +23,20 @@ if (NOT TARGET zlib_project)
         "629380c90a77b964d896ed37163f5c3a34f6e6d897311f1df2a7016355c45eff")
 
     set_external_project_build_parallel_level(PARALLEL)
-
-    set_external_project_prefix_vars()
+    set_external_project_vars()
 
     include(ExternalProject)
     ExternalProject_Add(
-        zlib_project
+        zlib-project
         EXCLUDE_FROM_ALL ON
         PREFIX "${CMAKE_BINARY_DIR}/external/zlib"
         INSTALL_DIR "${GOOGLE_CLOUD_CPP_EXTERNAL_PREFIX}"
         URL ${GOOGLE_CLOUD_CPP_ZLIB_URL}
         URL_HASH SHA256=${GOOGLE_CLOUD_CPP_ZLIB_SHA256}
         LIST_SEPARATOR |
-        CMAKE_ARGS ${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CCACHE}
-                   -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-                   -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER}
-                   -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER}
-                   -DBUILD_SHARED_LIBS=${BUILD_SHARED_LIBS}
+        CMAKE_ARGS ${GOOGLE_CLOUD_CPP_EXTERNAL_PROJECT_CMAKE_FLAGS}
                    -DCMAKE_PREFIX_PATH=${GOOGLE_CLOUD_CPP_PREFIX_PATH}
+                   -DCMAKE_INSTALL_RPATH=${GOOGLE_CLOUD_CPP_INSTALL_RPATH}
                    -DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>
         BUILD_COMMAND ${CMAKE_COMMAND} --build <BINARY_DIR> ${PARALLEL}
         LOG_DOWNLOAD ON