test(bigtable): clarify which admin integration tests run, and when (#7518)

Author: dbolduc

ci/kokoro/macos/builds/bazel.sh

@@ -109,7 +109,6 @@ if should_run_integration_tests; then
     "--test_env=GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_A=${GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_A}"
     "--test_env=GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_B=${GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_B}"
     "--test_env=GOOGLE_CLOUD_CPP_BIGTABLE_TEST_SERVICE_ACCOUNT=${GOOGLE_CLOUD_CPP_BIGTABLE_TEST_SERVICE_ACCOUNT}"
-    "--test_env=ENABLE_BIGTABLE_ADMIN_INTEGRATION_TESTS=${ENABLE_BIGTABLE_ADMIN_INTEGRATION_TESTS:-no}"
 
     # Storage
     "--test_env=GOOGLE_CLOUD_CPP_STORAGE_TEST_BUCKET_NAME=${GOOGLE_CLOUD_CPP_STORAGE_TEST_BUCKET_NAME}"

ci/kokoro/windows/build-bazel.ps1

@@ -167,10 +167,6 @@ if (Integration-Tests-Enabled) {
         }
     }
     ${env:GRPC_DEFAULT_SSL_ROOTS_FILE_PATH}="${env:KOKORO_GFILE_DIR}/roots.pem"
-    $enable_bigtable_admin_integration_tests="no"
-    if (Test-Path env:ENABLE_BIGTABLE_ADMIN_INTEGRATION_TESTS) {
-        $enable_bigtable_admin_integration_tests=${env:ENABLE_BIGTABLE_ADMIN_INTEGRATION_TESTS}
-    }
 
     $integration_flags=@(
         # Common configuration
@@ -188,7 +184,6 @@ if (Integration-Tests-Enabled) {
         "--test_env=GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_A=${env:GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_A}",
         "--test_env=GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_B=${env:GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_B}",
         "--test_env=GOOGLE_CLOUD_CPP_BIGTABLE_TEST_SERVICE_ACCOUNT=${env:GOOGLE_CLOUD_CPP_BIGTABLE_TEST_SERVICE_ACCOUNT}",
-        "--test_env=ENABLE_BIGTABLE_ADMIN_INTEGRATION_TESTS=${enable_bigtable_admin_integration_tests}",
 
         # Storage
         "--test_env=GOOGLE_CLOUD_CPP_STORAGE_TEST_BUCKET_NAME=${env:GOOGLE_CLOUD_CPP_STORAGE_TEST_BUCKET_NAME}",

google/cloud/bigtable/ci/run_integration_tests_emulator_cmake.sh

@@ -36,8 +36,6 @@ ctest_args=("$@")
 export CBT_INSTANCE_ADMIN_EMULATOR_CMD="${BINARY_DIR}/google/cloud/bigtable/tests/instance_admin_emulator"
 source module /google/cloud/bigtable/tools/run_emulator_utils.sh
 
-export ENABLE_BIGTABLE_ADMIN_INTEGRATION_TESTS="yes"
-
 cd "${BINARY_DIR}"
 start_emulators 8480 8490
 

google/cloud/bigtable/testing/table_integration_test.cc

@@ -26,6 +26,7 @@ namespace cloud {
 namespace bigtable {
 namespace testing {
 
+using ::google::cloud::internal::GetEnv;
 using ::testing::ContainerEq;
 using ::testing::IsEmpty;
 
@@ -36,19 +37,15 @@ std::string TableTestEnvironment::zone_b_;
 google::cloud::internal::DefaultPRNG TableTestEnvironment::generator_;
 std::string TableTestEnvironment::table_id_;
 bool TableTestEnvironment::using_cloud_bigtable_emulator_;
+bool TableAdminTestEnvironment::skip_test_;
 
 TableTestEnvironment::TableTestEnvironment() {
-  project_id_ =
-      google::cloud::internal::GetEnv("GOOGLE_CLOUD_PROJECT").value_or("");
-  instance_id_ = google::cloud::internal::GetEnv(
-                     "GOOGLE_CLOUD_CPP_BIGTABLE_TEST_INSTANCE_ID")
-                     .value_or("");
-  zone_a_ =
-      google::cloud::internal::GetEnv("GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_A")
-          .value_or("");
-  zone_b_ =
-      google::cloud::internal::GetEnv("GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_B")
-          .value_or("");
+  project_id_ = GetEnv("GOOGLE_CLOUD_PROJECT").value_or("");
+  instance_id_ =
+      GetEnv("GOOGLE_CLOUD_CPP_BIGTABLE_TEST_INSTANCE_ID").value_or("");
+  zone_a_ = GetEnv("GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_A").value_or("");
+  zone_b_ = GetEnv("GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_B").value_or("");
+  using_cloud_bigtable_emulator_ = GetEnv("BIGTABLE_EMULATOR_HOST").has_value();
 }
 
 void TableTestEnvironment::SetUp() {
@@ -57,9 +54,6 @@ void TableTestEnvironment::SetUp() {
   ASSERT_FALSE(zone_a_.empty());
   ASSERT_FALSE(zone_b_.empty());
 
-  using_cloud_bigtable_emulator_ =
-      google::cloud::internal::GetEnv("BIGTABLE_EMULATOR_HOST").has_value();
-
   generator_ = google::cloud::internal::MakeDefaultPRNG();
 
   auto admin_client =
@@ -107,6 +101,20 @@ std::string TableTestEnvironment::RandomInstanceId() {
   return google::cloud::bigtable::testing::RandomInstanceId(generator_);
 }
 
+void TableAdminTestEnvironment::SetUp() {
+  skip_test_ =
+      GetEnv("ENABLE_BIGTABLE_ADMIN_INTEGRATION_TESTS").value_or("") != "yes" &&
+      !TableTestEnvironment::UsingCloudBigtableEmulator();
+
+  if (skip_test_) GTEST_SKIP();
+  TableTestEnvironment::SetUp();
+}
+
+void TableAdminTestEnvironment::TearDown() {
+  if (skip_test_) GTEST_SKIP();
+  TableTestEnvironment::TearDown();
+}
+
 void TableIntegrationTest::SetUp() {
   admin_client_ = bigtable::MakeAdminClient(TableTestEnvironment::project_id());
   table_admin_ = absl::make_unique<bigtable::TableAdmin>(

google/cloud/bigtable/testing/table_integration_test.h

@@ -72,6 +72,19 @@ class TableTestEnvironment : public ::testing::Environment {
   static bool using_cloud_bigtable_emulator_;
 };
 
+/// Environment specific to TableAdmin integration tests
+class TableAdminTestEnvironment : public TableTestEnvironment {
+ public:
+  TableAdminTestEnvironment() = default;
+
+  void SetUp() override;
+  void TearDown() override;
+
+  // Skip tests that run only against production, unless explicitly enabled by
+  // setting the `ENABLE_BIGTABLE_ADMIN_INTEGRATION_TESTS` environment variable.
+  static bool skip_test_;
+};
+
 /**
  * Fixture for integration tests that need to create tables and check their
  * contents.

google/cloud/bigtable/tests/admin_backup_integration_test.cc

@@ -45,12 +45,6 @@ class AdminBackupIntegrationTest
   std::unique_ptr<bigtable::InstanceAdmin> instance_admin_;
 
   void SetUp() override {
-    if (google::cloud::internal::GetEnv(
-            "ENABLE_BIGTABLE_ADMIN_INTEGRATION_TESTS")
-            .value_or("") != "yes") {
-      GTEST_SKIP();
-    }
-
     TableIntegrationTest::SetUp();
 
     std::shared_ptr<bigtable::AdminClient> admin_client =
@@ -170,6 +164,6 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
 int main(int argc, char* argv[]) {
   ::testing::InitGoogleMock(&argc, argv);
   (void)::testing::AddGlobalTestEnvironment(
-      new google::cloud::bigtable::testing::TableTestEnvironment);
+      new google::cloud::bigtable::testing::TableAdminTestEnvironment);
   return RUN_ALL_TESTS();
 }

google/cloud/bigtable/tests/admin_iam_policy_integration_test.cc

@@ -36,12 +36,13 @@ class AdminIAMPolicyIntegrationTest
   std::string service_account_;
 
   void SetUp() override {
+    TableIntegrationTest::SetUp();
+
     service_account_ = google::cloud::internal::GetEnv(
                            "GOOGLE_CLOUD_CPP_BIGTABLE_TEST_SERVICE_ACCOUNT")
                            .value_or("");
     ASSERT_FALSE(service_account_.empty());
 
-    TableIntegrationTest::SetUp();
     admin_client_ =
         MakeAdminClient(testing::TableTestEnvironment::project_id());
     table_admin_ = absl::make_unique<TableAdmin>(

google/cloud/bigtable/tests/admin_integration_test.cc

@@ -43,11 +43,6 @@ class AdminIntegrationTest : public bigtable::testing::TableIntegrationTest {
   std::unique_ptr<bigtable::TableAdmin> table_admin_;
 
   void SetUp() override {
-    if (google::cloud::internal::GetEnv(
-            "ENABLE_BIGTABLE_ADMIN_INTEGRATION_TESTS")
-            .value_or("") != "yes") {
-      GTEST_SKIP();
-    }
     TableIntegrationTest::SetUp();
 
     std::shared_ptr<bigtable::AdminClient> admin_client =
@@ -396,6 +391,6 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
 int main(int argc, char* argv[]) {
   ::testing::InitGoogleMock(&argc, argv);
   (void)::testing::AddGlobalTestEnvironment(
-      new google::cloud::bigtable::testing::TableTestEnvironment);
+      new google::cloud::bigtable::testing::TableAdminTestEnvironment);
   return RUN_ALL_TESTS();
 }

google/cloud/bigtable/tests/instance_admin_integration_test.cc

@@ -34,6 +34,7 @@ namespace bigtable {
 GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
 namespace {
 
+using ::google::cloud::internal::GetEnv;
 using ::google::cloud::testing_util::ContainsOnce;
 using ::testing::Contains;
 using ::testing::EndsWith;
@@ -45,25 +46,22 @@ class InstanceAdminIntegrationTest
     : public ::google::cloud::testing_util::IntegrationTest {
  protected:
   void SetUp() override {
-    if (google::cloud::internal::GetEnv(
-            "ENABLE_BIGTABLE_ADMIN_INTEGRATION_TESTS")
-            .value_or("") != "yes") {
+    auto emulator_present =
+        GetEnv("BIGTABLE_INSTANCE_ADMIN_EMULATOR_HOST").has_value();
+    auto run_prod_tests =
+        GetEnv("ENABLE_BIGTABLE_ADMIN_INTEGRATION_TESTS").value_or("") == "yes";
+    if (!emulator_present && !run_prod_tests) {
       GTEST_SKIP();
     }
-    project_id_ =
-        google::cloud::internal::GetEnv("GOOGLE_CLOUD_PROJECT").value_or("");
+
+    project_id_ = GetEnv("GOOGLE_CLOUD_PROJECT").value_or("");
     ASSERT_FALSE(project_id_.empty());
-    zone_a_ =
-        google::cloud::internal::GetEnv("GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_A")
-            .value_or("");
+    zone_a_ = GetEnv("GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_A").value_or("");
     ASSERT_FALSE(zone_a_.empty());
-    zone_b_ =
-        google::cloud::internal::GetEnv("GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_B")
-            .value_or("");
+    zone_b_ = GetEnv("GOOGLE_CLOUD_CPP_BIGTABLE_TEST_ZONE_B").value_or("");
     ASSERT_FALSE(zone_b_.empty());
-    service_account_ = google::cloud::internal::GetEnv(
-                           "GOOGLE_CLOUD_CPP_BIGTABLE_TEST_SERVICE_ACCOUNT")
-                           .value_or("");
+    service_account_ =
+        GetEnv("GOOGLE_CLOUD_CPP_BIGTABLE_TEST_SERVICE_ACCOUNT").value_or("");
     ASSERT_FALSE(service_account_.empty());
 
     auto instance_admin_client = bigtable::MakeInstanceAdminClient(project_id_);