cleanup: build install test in regular builds (#932)

The spanner_install_test.cc is a small program to verify our installed
libraries work correctly. It was only built by the "install" builds
(ci/kokoro/install/*), and this was error prone as we often forgot to
make changes to it.

With this change the program is built as part of the regular builds, and
then the install builds copy it outside the source tree to verify it
compiles outside it too.

Author: coryan

ci/kokoro/docker/build-in-docker-bazel-dependency.sh

@@ -52,7 +52,10 @@ if [[ -n "${BAZEL_CONFIG}" ]]; then
     bazel_args+=(--config "${BAZEL_CONFIG}")
 fi
 
-cd ci/test-install
+cp -r ci/test-install /var/tmp/test-install
+cp google/cloud/spanner/integration_tests/spanner_install_test.cc /var/tmp/test-install
+cd /var/tmp/test-install
+
 "${BAZEL_BIN}" build  "${bazel_args[@]}" \
     -- //...:all
 

ci/kokoro/install/Dockerfile.fedora

@@ -90,6 +90,7 @@ RUN cmake --build . --target install
 WORKDIR /home/build/test-install-cmake
 ENV LD_LIBRARY_PATH=/home/build/google-cloud-spanner-install/lib64
 COPY ci/test-install /home/build/test-install-cmake
+COPY google/cloud/spanner/integration_tests/spanner_install_test.cc /home/build/test-install-cmake
 RUN env -u PKG_CONFIG_PATH cmake \
     -DCMAKE_PREFIX_PATH=/home/build/google-cloud-spanner-install \
     -H. -B/o

ci/test-install/WORKSPACE

@@ -26,10 +26,12 @@ workspace(name = "com_github_googleapis_google_cloud_cpp_spanner_test_install")
 #     sha256 = "...",
 # )
 #
-# But we want to test that the *current* version is correct.
+
+# But we want to test that the *current* version is correct, the CI builds
+# always have the source in /v.
 local_repository(
     name = "com_github_googleapis_google_cloud_cpp_spanner",
-    path = "../..",
+    path = "/v",
 )
 
 load("@com_github_googleapis_google_cloud_cpp_spanner//bazel:google_cloud_cpp_spanner_deps.bzl", "google_cloud_cpp_spanner_deps")

cmake/GoogleCloudCppSpannerFunctions.cmake

@@ -0,0 +1,27 @@
+# ~~~
+# Copyright 2019 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.
+# ~~~
+
+function (google_cloud_cpp_test_name_to_target var fname)
+    string(REPLACE "/"
+                   "_"
+                   target
+                   ${fname})
+    string(REPLACE ".cc"
+                   ""
+                   target
+                   ${target})
+    set("${var}" "${target}" PARENT_SCOPE)
+endfunction ()

google/cloud/spanner/integration_tests/BUILD

@@ -17,6 +17,7 @@ package(default_visibility = ["//visibility:public"])
 licenses(["notice"])  # Apache 2.0
 
 load(":spanner_client_integration_tests.bzl", "spanner_client_integration_tests")
+load(":spanner_client_install_tests.bzl", "spanner_client_install_tests")
 
 [cc_test(
     name = "spanner_client_" + test.replace("/", "_").replace(".cc", ""),
@@ -32,3 +33,14 @@ load(":spanner_client_integration_tests.bzl", "spanner_client_integration_tests"
         "@com_google_googletest//:gtest",
     ],
 ) for test in spanner_client_integration_tests]
+
+[cc_test(
+    name = "spanner_client_" + test.replace("/", "_").replace(".cc", ""),
+    srcs = [test],
+    tags = ["integration-tests"],
+    deps = [
+        "//google/cloud/spanner:spanner_client",
+        "//google/cloud/spanner:spanner_client_testing",
+        "@com_github_googleapis_google_cloud_cpp//google/cloud:google_cloud_cpp_common",
+    ],
+) for test in spanner_client_install_tests]

google/cloud/spanner/integration_tests/CMakeLists.txt

@@ -16,6 +16,7 @@
 
 include(EnableClangTidy)
 include(EnableWerror)
+include(GoogleCloudCppSpannerFunctions)
 
 if (MSVC)
     # MSVC warns about using localtime(), this is a valuable warning, so we do
@@ -42,25 +43,21 @@ function (spanner_client_define_integration_tests)
         client_stress_test.cc
         instance_admin_integration_test.cc
         rpc_failure_threshold_integration_test.cc)
+    set(spanner_client_install_tests spanner_install_test.cc)
 
     # Export the list of unit tests to a .bzl file so we do not need to maintain
     # the list in two places.
     export_list_to_bazel("spanner_client_integration_tests.bzl"
                          "spanner_client_integration_tests")
+    export_list_to_bazel("spanner_client_install_tests.bzl"
+                         "spanner_client_install_tests")
 
     # Create a custom target so we can say "build all the tests"
     add_custom_target(spanner-client-integration-tests)
 
     # Generate a target for each unit test.
     foreach (fname ${spanner_client_integration_tests})
-        string(REPLACE "/"
-                       "_"
-                       target
-                       ${fname})
-        string(REPLACE ".cc"
-                       ""
-                       target
-                       ${target})
+        google_cloud_cpp_test_name_to_target(target "${fname}")
         add_executable(${target} ${fname})
         target_link_libraries(${target}
                               PRIVATE googleapis-c++::spanner_client
@@ -82,6 +79,21 @@ function (spanner_client_define_integration_tests)
         set_tests_properties(${target} PROPERTIES LABELS "integration-tests")
         add_dependencies(spanner-client-integration-tests ${target})
     endforeach ()
+
+    if (NOT GOOGLE_CLOUD_CPP_SPANNER_ENABLE_CXX_EXCEPTIONS)
+        return()
+    endif ()
+
+    foreach (fname ${spanner_client_install_tests})
+        google_cloud_cpp_test_name_to_target(target "${fname}")
+        add_executable(${target} ${fname})
+        target_link_libraries(${target} PRIVATE googleapis-c++::spanner_client)
+        google_cloud_cpp_add_clang_tidy(${target})
+        google_cloud_cpp_add_common_options(${target})
+
+        add_test(NAME ${target} COMMAND ${target})
+        set_tests_properties(${target} PROPERTIES LABELS "integration-tests")
+    endforeach ()
 endfunction ()
 
 # Only define the tests if testing is enabled. Package maintainers may not want

google/cloud/spanner/integration_tests/spanner_client_install_tests.bzl

@@ -0,0 +1,21 @@
+# Copyright 2019 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.
+#
+# DO NOT EDIT -- GENERATED BY CMake -- Change the CMakeLists.txt file if needed
+
+"""Automatically generated unit tests list - DO NOT EDIT."""
+
+spanner_client_install_tests = [
+    "spanner_install_test.cc",
+]

ci/test-install/spanner_install_test.cc renamed to google/cloud/spanner/integration_tests/spanner_install_test.cc

@@ -15,18 +15,19 @@
 #include "google/cloud/spanner/client.h"
 #include "google/cloud/spanner/database.h"
 #include "google/cloud/spanner/database_admin_client.h"
+#include "google/cloud/spanner/instance_admin_client.h"
 #include "google/cloud/internal/getenv.h"
 #include "google/cloud/internal/random.h"
 #include <functional>
 
 namespace spanner = google::cloud::spanner;
 
-std::function<void()> drop_database = []{};
+std::function<void()> drop_database = [] {};
 
 int main(int argc, char* argv[]) try {
   if (argc != 1) {
     std::string const cmd = argv[0];
-    auto last_slash = std::string(argv[0]).find_last_of("/");
+    auto last_slash = std::string(argv[0]).find_last_of('/');
     std::cerr << "Usage: " << cmd.substr(last_slash + 1) << "\n";
     return 1;
   }
@@ -38,28 +39,40 @@ int main(int argc, char* argv[]) try {
         "The GOOGLE_CLOUD_PROJECT environment variable should be set to a "
         "non-empty value");
   }
-  auto instance_id =
-      google::cloud::internal::GetEnv("GOOGLE_CLOUD_CPP_SPANNER_INSTANCE")
-          .value_or("");
-  if (project_id.empty()) {
-    throw std::runtime_error(
-        "The GOOGLE_CLOUD_CPP_SPANNER_INSTANCE environment variable should be "
-        "set to a non-empty value");
-  }
+
+  // This program is used to test the libraries after they are installed. We
+  // cannot use any of the functions in the testing support libraries as those
+  // do not get installed.
+  spanner::DatabaseAdminClient admin_client;
 
   auto generator = google::cloud::internal::MakeDefaultPRNG();
+
+  auto instance_id = [&project_id, &generator] {
+    spanner::InstanceAdminClient instance_admin{
+        spanner::MakeInstanceAdminConnection()};
+    std::vector<std::string> names;
+    for (auto instance : instance_admin.ListInstances(project_id, {})) {
+      if (!instance) throw std::runtime_error("Error reading instance list");
+      auto full_name = instance->name();
+      names.push_back(full_name.substr(full_name.rfind('/') + 1));
+    }
+    if (names.empty()) throw std::runtime_error("No instances in the project");
+
+    return names[std::uniform_int_distribution<std::size_t>(
+        0, names.size() - 1)(generator)];
+  }();
+
   auto database_id =
       "db-" + google::cloud::internal::Sample(
                   generator, 20, "abcdefghijlkmnopqrstuvwxyz0123456789");
 
-  namespace spanner = google::cloud::spanner;
   spanner::Database const database(project_id, instance_id, database_id);
+  std::cout << "Will run the test in database: " << database.FullName() << "\n";
 
   using google::cloud::future;
   using google::cloud::StatusOr;
 
   std::cout << "Creating database [" << database_id << "] " << std::flush;
-  spanner::DatabaseAdminClient admin_client;
   future<StatusOr<google::spanner::admin::database::v1::Database>>
       created_database =
           admin_client.CreateDatabase(database, {R"""(
@@ -76,21 +89,14 @@ int main(int argc, char* argv[]) try {
                         ) PRIMARY KEY (SingerId, AlbumId),
                         INTERLEAVE IN PARENT Singers ON DELETE CASCADE)"""});
 
-  int i = 0;
-  int const timeout = 120;
-  while (++i < timeout) {
+  for (;;) {
     auto status = created_database.wait_for(std::chrono::seconds(1));
     if (status == std::future_status::ready) break;
     std::cout << '.' << std::flush;
   }
-  if (i >= timeout) {
-    std::cout << " TIMEOUT\n";
-    throw std::runtime_error("Timeout while creating database");
-  }
   std::cout << " DONE\n";
 
-  StatusOr<google::spanner::admin::database::v1::Database> db =
-      created_database.get();
+  auto db = created_database.get();
   if (!db) throw std::runtime_error(db.status().message());
 
   drop_database = [admin_client, database]() mutable {

google/cloud/spanner/samples/CMakeLists.txt

@@ -16,18 +16,7 @@
 
 include(EnableClangTidy)
 include(EnableWerror)
-
-function (google_cloud_cpp_test_name_to_target var fname)
-    string(REPLACE "/"
-                   "_"
-                   target
-                   ${fname})
-    string(REPLACE ".cc"
-                   ""
-                   target
-                   ${target})
-    set("${var}" "${target}" PARENT_SCOPE)
-endfunction ()
+include(GoogleCloudCppSpannerFunctions)
 
 function (spanner_client_define_samples)
     set(spanner_client_integration_samples samples.cc)