feat: Implement a Bigtable Emulator (WIP)

.gitignore

@@ -1,6 +1,11 @@
+# Code coverage output artefacts
+code_coverage.info
+code_coverage_report/
+
 # Common build output directory names
 .build/
 _build/
+build/
 build-output/
 build-out/
 cmake-out/

google/cloud/bigtable/CMakeLists.txt

@@ -26,6 +26,7 @@ set(DOXYGEN_EXCLUDE_SYMBOLS
     "benchmarks"
     "bigtable_admin_internal"
     "bigtable_internal"
+    "emulator"
     "internal"
     "testing"
     "examples"
@@ -204,6 +205,8 @@ add_library(
     internal/readrowsparser.cc
     internal/readrowsparser.h
     internal/retry_traits.h
+    internal/row_range_helpers.cc
+    internal/row_range_helpers.h
     internal/row_reader_impl.h
     internal/rpc_policy_parameters.h
     internal/rpc_policy_parameters.inc
@@ -512,6 +515,8 @@ if (BUILD_TESTING)
     add_subdirectory(tests)
 endif ()
 
+add_subdirectory(emulator)
+
 # Examples are enabled if possible, but package maintainers may want to disable
 # compilation to speed up their builds.
 if (GOOGLE_CLOUD_CPP_ENABLE_EXAMPLES)

google/cloud/bigtable/ci/run_integration_tests_emulator_cmake.sh

@@ -41,6 +41,12 @@ fi
 CBT_INSTANCE_ADMIN_EMULATOR_START=(
   "${BINARY_DIR}/google/cloud/bigtable/tests/instance_admin_emulator"
 )
+
+# Configure run_emulators_utils.sh to find the cbt emulator.
+CBT_EMULATOR_CMD=(
+  "${BINARY_DIR}/google/cloud/bigtable/emulator/emulator"
+)
+
 source module /google/cloud/bigtable/tools/run_emulator_utils.sh
 
 cd "${BINARY_DIR}"

google/cloud/bigtable/emulator/CMakeLists.txt

@@ -0,0 +1,114 @@
+# ~~~
+# 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.
+# ~~~
+
+add_library(
+    bigtable_emulator_common # cmake-format: sort
+    cell_view.h
+    cluster.cc
+    cluster.h
+    column_family.cc
+    column_family.h
+    filter.cc
+    filter.h
+    filtered_map.h
+    limits.h
+    range_set.cc
+    range_set.h
+    row_streamer.cc
+    row_streamer.h
+    server.cc
+    server.h
+    table.cc
+    table.h
+    test_util.cc
+    test_util.h
+    to_grpc_status.cc
+    to_grpc_status.h)
+
+target_link_libraries(
+    bigtable_emulator_common
+    google-cloud-cpp::bigtable
+    google-cloud-cpp::bigtable_protos
+    google-cloud-cpp::common
+    google-cloud-cpp::grpc_utils
+    gRPC::grpc++
+    gRPC::grpc
+    protobuf::libprotobuf)
+google_cloud_cpp_add_common_options(bigtable_emulator_common)
+
+include(CreateBazelConfig)
+create_bazel_config(bigtable_emulator_common YEAR 2024)
+
+if (BUILD_TESTING)
+    # List the unit tests, then setup the targets and dependencies.
+    set(bigtable_emulator_unit_tests
+        # cmake-format: sort
+        column_family_test.cc
+        conditional_mutations_test.cc
+        drop_row_range_test.cc
+        filter_test.cc
+        filtered_map_test.cc
+        mutations_test.cc
+        range_set_test.cc
+        server_test.cc
+        table_test.cc)
+    export_list_to_bazel("bigtable_emulator_unit_tests.bzl"
+                         "bigtable_emulator_unit_tests" YEAR "2024")
+
+    foreach (fname ${bigtable_emulator_unit_tests})
+        google_cloud_cpp_add_executable(target "bigtable_emulator" "${fname}")
+        target_link_libraries(
+            ${target}
+            PRIVATE bigtable_emulator_common
+                    bigtable_client_testing
+                    google_cloud_cpp_testing
+                    google_cloud_cpp_testing_grpc
+                    google-cloud-cpp::bigtable
+                    google-cloud-cpp::bigtable_protos
+                    google-cloud-cpp::common
+                    google-cloud-cpp::grpc_utils
+                    GTest::gmock_main
+                    GTest::gmock
+                    GTest::gtest
+                    gRPC::grpc++
+                    gRPC::grpc
+                    protobuf::libprotobuf)
+        google_cloud_cpp_add_common_options(${target})
+        add_test(NAME ${target} COMMAND ${target})
+    endforeach ()
+endif ()
+
+set(bigtable_emulator_programs # cmake-format: sort
+                               emulator.cc)
+export_list_to_bazel("bigtable_emulator_programs.bzl"
+                     "bigtable_emulator_programs" YEAR "2024")
+
+foreach (fname ${bigtable_emulator_programs})
+    google_cloud_cpp_add_executable(target "bigtable" "${fname}")
+    target_link_libraries(
+        ${target}
+        PRIVATE bigtable_emulator_common
+                absl::flags
+                absl::flags_parse
+                google-cloud-cpp::bigtable
+                google-cloud-cpp::bigtable_protos
+                google-cloud-cpp::grpc_utils
+                google_cloud_cpp_testing
+                gRPC::grpc++
+                gRPC::grpc
+                protobuf::libprotobuf)
+    google_cloud_cpp_add_common_options(${target})
+endforeach ()

google/cloud/bigtable/emulator/bigtable_emulator_common.bzl

@@ -0,0 +1,44 @@
+# 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.
+#
+# DO NOT EDIT -- GENERATED BY CMake -- Change the CMakeLists.txt file if needed
+
+"""Automatically generated source lists for bigtable_emulator_common - DO NOT EDIT."""
+
+bigtable_emulator_common_hdrs = [
+    "cell_view.h",
+    "cluster.h",
+    "column_family.h",
+    "filter.h",
+    "filtered_map.h",
+    "limits.h",
+    "range_set.h",
+    "row_streamer.h",
+    "server.h",
+    "table.h",
+    "test_util.h",
+    "to_grpc_status.h",
+]
+
+bigtable_emulator_common_srcs = [
+    "cluster.cc",
+    "column_family.cc",
+    "filter.cc",
+    "range_set.cc",
+    "row_streamer.cc",
+    "server.cc",
+    "table.cc",
+    "test_util.cc",
+    "to_grpc_status.cc",
+]

google/cloud/bigtable/emulator/bigtable_emulator_programs.bzl

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

google/cloud/bigtable/emulator/bigtable_emulator_test_common.bzl

@@ -0,0 +1,25 @@
+# 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.
+#
+# DO NOT EDIT -- GENERATED BY CMake -- Change the CMakeLists.txt file if needed
+
+"""Automatically generated source lists for bigtable_emulator_test_common - DO NOT EDIT."""
+
+bigtable_emulator_test_common_hdrs = [
+    "test_util.h",
+]
+
+bigtable_emulator_test_common_srcs = [
+    "test_util.cc",
+]

google/cloud/bigtable/emulator/bigtable_emulator_unit_tests.bzl

@@ -0,0 +1,29 @@
+# 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.
+#
+# DO NOT EDIT -- GENERATED BY CMake -- Change the CMakeLists.txt file if needed
+
+"""Automatically generated unit tests list - DO NOT EDIT."""
+
+bigtable_emulator_unit_tests = [
+    "column_family_test.cc",
+    "conditional_mutations_test.cc",
+    "drop_row_range_test.cc",
+    "filter_test.cc",
+    "filtered_map_test.cc",
+    "mutations_test.cc",
+    "range_set_test.cc",
+    "server_test.cc",
+    "table_test.cc",
+]

google/cloud/bigtable/emulator/cell_view.h

@@ -0,0 +1,71 @@
+// 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.
+
+#ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGTABLE_EMULATOR_CELL_VIEW_H
+#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGTABLE_EMULATOR_CELL_VIEW_H
+
+#include <absl/types/optional.h>
+#include <chrono>
+#include <functional>
+#include <string>
+
+namespace google {
+namespace cloud {
+namespace bigtable {
+namespace emulator {
+
+/**
+ * A class used to represent values when scanning a table.
+ *
+ * It is transient - it should never be stored as it only contains references to
+ * data which will likely become invalidated on first update.
+ */
+class CellView {
+ public:
+  CellView(std::string const& row_key, std::string const& column_family,
+           std::string const& column_qualifier,
+           std::chrono::milliseconds timestamp, std::string const& value)
+      : row_key_(row_key),
+        column_family_(column_family),
+        column_qualifier_(column_qualifier),
+        timestamp_(timestamp),
+        value_(value) {}
+
+  std::string const& row_key() const { return row_key_.get(); }
+  std::string const& column_family() const { return column_family_.get(); }
+  std::string const& column_qualifier() const {
+    return column_qualifier_.get();
+  }
+  std::chrono::milliseconds timestamp() const { return timestamp_; }
+  std::string const& value() const { return value_.get(); }
+  bool HasLabel() const { return label_.has_value(); }
+  std::string const& label() const { return label_.value().get(); }
+  void SetLabel(std::string const& label) { label_ = label; }
+  void SetValue(std::string const& value) { value_ = value; }
+
+ private:
+  std::reference_wrapper<std::string const> row_key_;
+  std::reference_wrapper<std::string const> column_family_;
+  std::reference_wrapper<std::string const> column_qualifier_;
+  std::chrono::milliseconds timestamp_;
+  std::reference_wrapper<std::string const> value_;
+  absl::optional<std::reference_wrapper<std::string const>> label_;
+};
+
+}  // namespace emulator
+}  // namespace bigtable
+}  // namespace cloud
+}  // namespace google
+
+#endif  // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_BIGTABLE_EMULATOR_CELL_VIEW_H