ci(gha): enable minimal integration tests (#13855)

coryan · web-flow · commit 77bbdeb50e8a · 2024-03-27T12:28:09.000Z
Add new tests to `google/cloud/storage` that do some minimal RPCs
(write, read, and delete an object). These are intended to run as part
of the GitHub Action builds. I chose storage for these tests because
storage uses both REST and gRPC.
diff --git a/.github/workflows/macos-bazel.yml b/.github/workflows/macos-bazel.yml
@@ -37,3 +37,4 @@ jobs:
       run: ci/gha/builds/macos-bazel.sh
     env:
       BAZEL_REMOTE_CACHE: https://storage.googleapis.com/cloud-cpp-gha-cache/bazel-cache/${{ matrix.os }}
+      GHA_TEST_BUCKET: "gcs-grpc-team-cloud-cpp-testing-bucket"
diff --git a/.github/workflows/macos-cmake.yml b/.github/workflows/macos-cmake.yml
@@ -128,3 +128,4 @@ jobs:
       SCCACHE_GCS_RW_MODE: READ_WRITE
       SCCACHE_IGNORE_SERVER_IO_ERROR: 1
       VCPKG_BINARY_SOURCES: x-gcs,gs://cloud-cpp-gha-cache/vcpkg-cache/${{ matrix.os }},readwrite
+      GHA_TEST_BUCKET: "gcs-grpc-team-cloud-cpp-testing-bucket"
diff --git a/.github/workflows/windows-bazel.yml b/.github/workflows/windows-bazel.yml
@@ -55,3 +55,4 @@ jobs:
         ci/gha/builds/windows-bazel.sh ${{ matrix.compilation_mode }}
     env:
       BAZEL_REMOTE_CACHE: https://storage.googleapis.com/cloud-cpp-gha-cache/bazel-cache/${{ matrix.msvc }}/${{ matrix.compilation_mode }}
+      GHA_TEST_BUCKET: "gcs-grpc-team-cloud-cpp-testing-bucket"
diff --git a/.github/workflows/windows-cmake.yml b/.github/workflows/windows-cmake.yml
@@ -134,3 +134,4 @@ jobs:
       SCCACHE_IGNORE_SERVER_IO_ERROR: 1
       VCPKG_BINARY_SOURCES: x-gcs,gs://cloud-cpp-gha-cache/vcpkg-cache/${{ matrix.msvc }},readwrite
       VCPKG_TRIPLET: ${{ matrix.arch }}-windows
+      GHA_TEST_BUCKET: "gcs-grpc-team-cloud-cpp-testing-bucket"
diff --git a/ci/gha/builds/lib/bazel.sh b/ci/gha/builds/lib/bazel.sh
@@ -76,6 +76,18 @@ function bazel::msvc_args() {
   printf "%s\n" "${args[@]}"
 }
 
+# Outputs a list of args to use with integration tests
+function bazel::integration_test_args() {
+  local args=(
+    --flaky_test_attempts=3
+    --test_tag_filters=integration-test-gha
+    --test_env=GOOGLE_CLOUD_CPP_STORAGE_TEST_BUCKET_NAME="${GHA_TEST_BUCKET:-}"
+    --test_env=GOOGLE_APPLICATION_CREDENTIALS="${GOOGLE_APPLICATION_CREDENTIALS:-}"
+    --test_env=HOME="${HOME:-}"
+  )
+  printf "%s\n" "${args[@]}"
+}
+
 # Bazel downloads all the dependencies of a project, as well as a number of
 # development tools during startup. In automated builds these downloads fail
 # from time to time due to transient network problems. Running `bazel fetch` at
diff --git a/ci/gha/builds/macos-bazel.sh b/ci/gha/builds/macos-bazel.sh
@@ -17,19 +17,27 @@
 set -euo pipefail
 
 source "$(dirname "$0")/../../lib/init.sh"
-source module ci/gha/builds/lib/bazel.sh
 source module ci/gha/builds/lib/macos.sh
+# Define the os::* functions used in bazel.sh
+source module ci/gha/builds/lib/bazel.sh
 source module ci/lib/io.sh
 
 # Usage: macos-bazel.sh
 
 mapfile -t args < <(bazel::common_args)
 mapfile -t test_args < <(bazel::test_args)
-# Do not run the integration tests
-test_args+=(--test_tag_filters=-integration-test)
-TIMEFORMAT="==> 🕑 bazel test done in %R seconds"
+mapfile -t integration_test_args < <(bazel::integration_test_args)
 
+TIMEFORMAT="==> 🕑 bazel test done in %R seconds"
 io::log_h1 "Starting Build"
 time {
-  io::run bazelisk "${args[@]}" test "${test_args[@]}" //...
+  io::run bazelisk "${args[@]}" test "${test_args[@]}" --test_tag_filters=-integration-test //...
 }
+
+TIMEFORMAT="==> 🕑 Storage integration tests done in %R seconds"
+if [[ -n "${GHA_TEST_BUCKET:-}" ]]; then
+  time {
+    io::run bazelisk "${args[@]}" test "${test_args[@]}" "${integration_test_args[@]}" \
+      //google/cloud/storage/tests/...
+  }
+fi
diff --git a/ci/gha/builds/macos-cmake.sh b/ci/gha/builds/macos-cmake.sh
@@ -51,3 +51,12 @@ TIMEFORMAT="==> 🕑 CMake test done in %R seconds"
 time {
   io::run ctest "${ctest_args[@]}" --test-dir cmake-out -LE integration-test
 }
+
+TIMEFORMAT="==> 🕑 Storage integration tests done in %R seconds"
+if [[ -n "${GHA_TEST_BUCKET:-}" ]]; then
+  time {
+    export GOOGLE_CLOUD_CPP_STORAGE_TEST_BUCKET_NAME="${GHA_TEST_BUCKET}"
+    io::run ctest "${ctest_args[@]}" --repeat until-pass:3 \
+      --test-dir cmake-out -L integration-test-gha
+  }
+fi
diff --git a/ci/gha/builds/windows-bazel.sh b/ci/gha/builds/windows-bazel.sh
@@ -17,6 +17,7 @@
 set -euo pipefail
 
 source "$(dirname "$0")/../../lib/init.sh"
+# Define the os::* functions used in bazel.sh
 source module ci/gha/builds/lib/windows.sh
 source module ci/gha/builds/lib/bazel.sh
 
@@ -27,12 +28,11 @@ mapfile -t args < <(bazel::common_args)
 mapfile -t test_args < <(bazel::test_args)
 mapfile -t msvc_args < <(bazel::msvc_args)
 test_args+=("${msvc_args[@]}")
-# Do not run the integration tests
-test_args+=(--test_tag_filters=-integration-test)
 if [[ $# -gt 1 ]]; then
   test_args+=("--compilation_mode=${1}")
   shift
 fi
+mapfile -t integration_test_args < <(bazel::integration_test_args)
 
 if [[ -z "${VCINSTALLDIR}" ]]; then
   echo "ERROR: Missing VCINSTALLDIR, this is needed to configure Bazel+MSVC"
@@ -43,7 +43,18 @@ export BAZEL_VC="${VCINSTALLDIR}"
 io::log_h1 "Starting Build"
 TIMEFORMAT="==> 🕑 bazel test done in %R seconds"
 time {
-  # Always run //google/cloud:status_test in case the list of targets has
-  # no unit tests.
-  io::run bazelisk "${args[@]}" test "${test_args[@]}" -- //...
+  io::run bazelisk "${args[@]}" test "${test_args[@]}" --test_tag_filters=-integration-test -- //...
 }
+
+TIMEFORMAT="==> 🕑 Storage integration tests done in %R seconds"
+if [[ -n "${GHA_TEST_BUCKET:-}" ]]; then
+  time {
+    # gRPC requires a local roots.pem on Windows
+    #   https://github.com/grpc/grpc/issues/16571
+    curl -fsSL -o "${HOME}/roots.pem" https://pki.google.com/roots.pem
+
+    io::run bazelisk "${args[@]}" test "${test_args[@]}" "${integration_test_args[@]}" \
+      --test_env=GRPC_DEFAULT_SSL_ROOTS_FILE_PATH="${HOME}/roots.pem" \
+      //google/cloud/storage/tests/...
+  }
+fi
diff --git a/ci/gha/builds/windows-cmake.sh b/ci/gha/builds/windows-cmake.sh
@@ -67,12 +67,23 @@ fi
 
 TIMEFORMAT="==> 🕑 CMake build done in %R seconds"
 time {
-  # Always run //google/cloud:status_test in case the list of targets has
-  # no unit tests.
   io::run cmake --build "${CMAKE_OUT}"
 }
 
 TIMEFORMAT="==> 🕑 CMake test done in %R seconds"
 time {
   io::run ctest "${ctest_args[@]}" --test-dir "${CMAKE_OUT}" -LE integration-test
 }
+
+TIMEFORMAT="==> 🕑 Storage integration tests done in %R seconds"
+if [[ -n "${GHA_TEST_BUCKET:-}" ]]; then
+  time {
+    # gRPC requires a local roots.pem on Windows
+    #   https://github.com/grpc/grpc/issues/16571
+    curl -fsSL -o "${HOME}/roots.pem" https://pki.google.com/roots.pem
+    export GRPC_DEFAULT_SSL_ROOTS_FILE_PATH="${HOME}/roots.pem"
+
+    export GOOGLE_CLOUD_CPP_STORAGE_TEST_BUCKET_NAME="${GHA_TEST_BUCKET}"
+    io::run ctest "${ctest_args[@]}" --test-dir "${CMAKE_OUT}" -L integration-test-gha
+  }
+fi
diff --git a/google/cloud/storage/tests/BUILD.bazel b/google/cloud/storage/tests/BUILD.bazel
@@ -54,7 +54,7 @@ VARIATIONS = {
     tags = [
         "integration-test",
         "integration-test-" + v_label,
-    ],
+    ] + (["integration-test-gha"] if test.startswith("smoke_test") else []),
     deps = [
         ":storage_conformance_tests_cc_proto",
         "//:common",
diff --git a/google/cloud/storage/tests/CMakeLists.txt b/google/cloud/storage/tests/CMakeLists.txt
@@ -65,6 +65,9 @@ set(storage_client_integration_tests
     slow_reader_chunk_integration_test.cc
     slow_reader_stream_integration_test.cc
     small_reads_integration_test.cc
+    smoke_test_async.cc
+    smoke_test_grpc.cc
+    smoke_test_rest.cc
     storage_include_test.cc
     thread_integration_test.cc
     tracing_integration_test.cc)
@@ -117,6 +120,14 @@ foreach (fname IN LISTS storage_client_integration_tests)
                              "integration-test;integration-test-emulator")
     google_cloud_cpp_add_common_options(${target})
 endforeach ()
+foreach (target IN ITEMS storage_smoke_test_async storage_smoke_test_grpc
+                         storage_smoke_test_rest)
+    set_tests_properties(
+        ${target}
+        PROPERTIES
+            LABELS
+            "integration-test;integration-test-emulator;integration-test-gha")
+endforeach ()
 
 # We just know that these tests need to be run against production.
 foreach (fname IN LISTS storage_client_integration_tests_production)
diff --git a/google/cloud/storage/tests/smoke_test_async.cc b/google/cloud/storage/tests/smoke_test_async.cc
@@ -0,0 +1,73 @@
+// 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.
+
+#if GOOGLE_CLOUD_CPP_STORAGE_HAVE_GRPC
+
+#include "google/cloud/storage/async/client.h"
+#include "google/cloud/storage/testing/random_names.h"
+#include "google/cloud/internal/getenv.h"
+#include "google/cloud/internal/random.h"
+#include "google/cloud/testing_util/status_matchers.h"
+#include <gmock/gmock.h>
+#include <tuple>
+#include <utility>
+
+namespace google {
+namespace cloud {
+namespace storage_experimental {
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
+namespace {
+
+using ::google::cloud::internal::GetEnv;
+
+TEST(SmokeTest, Grpc) {
+  auto const bucket_name =
+      GetEnv("GOOGLE_CLOUD_CPP_STORAGE_TEST_BUCKET_NAME").value_or("");
+  if (bucket_name.empty()) GTEST_SKIP();
+
+  auto client = google::cloud::storage_experimental::AsyncClient();
+  auto gen = google::cloud::internal::MakeDefaultPRNG();
+  auto object_name = google::cloud::storage::testing::MakeRandomObjectName(gen);
+
+  auto insert = client
+                    .InsertObject(bucket_name, object_name, "Hello World!",
+                                  storage::IfGenerationMatch(0))
+                    .get();
+  ASSERT_STATUS_OK(insert);
+  auto metadata = *insert;
+
+  auto payload =
+      client
+          .ReadObjectRange(bucket_name, metadata.name(), 0, 1024,
+                           storage::Generation(metadata.generation()))
+          .get();
+  ASSERT_STATUS_OK(payload);
+  std::string contents;
+  for (auto v : payload->contents()) contents += std::string(v);
+  EXPECT_EQ(contents, "Hello World!");
+
+  auto deleted = client
+                     .DeleteObject(metadata.bucket(), metadata.name(),
+                                   storage::Generation(metadata.generation()))
+                     .get();
+  EXPECT_STATUS_OK(deleted);
+}
+
+}  // namespace
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
+}  // namespace storage_experimental
+}  // namespace cloud
+}  // namespace google
+
+#endif  // GOOGLE_CLOUD_CPP_STORAGE_HAVE_GRPC
diff --git a/google/cloud/storage/tests/smoke_test_grpc.cc b/google/cloud/storage/tests/smoke_test_grpc.cc
@@ -0,0 +1,67 @@
+// 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.
+
+#if GOOGLE_CLOUD_CPP_STORAGE_HAVE_GRPC
+
+#include "google/cloud/storage/client.h"
+#include "google/cloud/storage/grpc_plugin.h"
+#include "google/cloud/storage/testing/random_names.h"
+#include "google/cloud/internal/getenv.h"
+#include "google/cloud/internal/random.h"
+#include "google/cloud/testing_util/status_matchers.h"
+#include <gmock/gmock.h>
+
+namespace google {
+namespace cloud {
+namespace storage {
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
+namespace {
+
+using ::google::cloud::internal::GetEnv;
+
+TEST(SmokeTest, Grpc) {
+  auto const bucket_name =
+      GetEnv("GOOGLE_CLOUD_CPP_STORAGE_TEST_BUCKET_NAME").value_or("");
+  if (bucket_name.empty()) GTEST_SKIP();
+
+  auto client = google::cloud::storage_experimental::DefaultGrpcClient(
+      google::cloud::Options{}.set<storage_experimental::GrpcPluginOption>(
+          "metadata"));
+  auto gen = google::cloud::internal::MakeDefaultPRNG();
+  auto object_name = google::cloud::storage::testing::MakeRandomObjectName(gen);
+
+  auto writer =
+      client.WriteObject(bucket_name, object_name, IfGenerationMatch(0));
+  writer << "Hello World!";
+  writer.Close();
+  ASSERT_STATUS_OK(writer.metadata());
+  auto metadata = *writer.metadata();
+
+  auto reader = client.ReadObject(bucket_name, metadata.name(),
+                                  Generation(metadata.generation()));
+  std::string contents{std::istreambuf_iterator<char>{reader}, {}};
+  EXPECT_FALSE(reader.bad());
+  EXPECT_EQ(contents, "Hello World!");
+  auto deleted = client.DeleteObject(metadata.bucket(), metadata.name(),
+                                     Generation(metadata.generation()));
+  EXPECT_STATUS_OK(deleted);
+}
+
+}  // namespace
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
+}  // namespace storage
+}  // namespace cloud
+}  // namespace google
+
+#endif  // GOOGLE_CLOUD_CPP_STORAGE_HAVE_GRPC
diff --git a/google/cloud/storage/tests/smoke_test_rest.cc b/google/cloud/storage/tests/smoke_test_rest.cc
@@ -0,0 +1,60 @@
+// 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 "google/cloud/storage/client.h"
+#include "google/cloud/storage/testing/random_names.h"
+#include "google/cloud/internal/getenv.h"
+#include "google/cloud/internal/random.h"
+#include "google/cloud/testing_util/status_matchers.h"
+#include <gmock/gmock.h>
+
+namespace google {
+namespace cloud {
+namespace storage {
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
+namespace {
+
+using ::google::cloud::internal::GetEnv;
+
+TEST(SmokeTest, Rest) {
+  auto const bucket_name =
+      GetEnv("GOOGLE_CLOUD_CPP_STORAGE_TEST_BUCKET_NAME").value_or("");
+  if (bucket_name.empty()) GTEST_SKIP();
+
+  auto client = google::cloud::storage::Client();
+  auto gen = google::cloud::internal::MakeDefaultPRNG();
+  auto object_name = google::cloud::storage::testing::MakeRandomObjectName(gen);
+
+  auto writer =
+      client.WriteObject(bucket_name, object_name, IfGenerationMatch(0));
+  writer << "Hello World!";
+  writer.Close();
+  ASSERT_STATUS_OK(writer.metadata());
+  auto metadata = *writer.metadata();
+
+  auto reader = client.ReadObject(bucket_name, metadata.name(),
+                                  Generation(metadata.generation()));
+  std::string contents{std::istreambuf_iterator<char>{reader}, {}};
+  EXPECT_FALSE(reader.bad());
+  EXPECT_EQ(contents, "Hello World!");
+  auto deleted = client.DeleteObject(metadata.bucket(), metadata.name(),
+                                     Generation(metadata.generation()));
+  EXPECT_STATUS_OK(deleted);
+}
+
+}  // namespace
+GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
+}  // namespace storage
+}  // namespace cloud
+}  // namespace google
diff --git a/google/cloud/storage/tests/storage_client_integration_tests.bzl b/google/cloud/storage/tests/storage_client_integration_tests.bzl
