Rename hello-world-type examples. (#2631)

Renaming the examples to make their role clearer. There is some amount
of duplication and cleanup needed, but that will be in a future PR.

Author: coryan

google/cloud/bigtable/examples/BUILD

@@ -17,38 +17,38 @@ package(default_visibility = ["//visibility:public"])
 licenses(["notice"])  # Apache 2.0
 
 cc_binary(
-    name = "bigtable_hello_world",
-    srcs = ["bigtable_hello_world.cc"],
+    name = "bigtable_hello_app_profile",
+    srcs = ["bigtable_hello_app_profile.cc"],
     deps = ["//google/cloud/bigtable:bigtable_client"],
 )
 
 cc_binary(
-    name = "bigtable_hello_app_profile",
-    srcs = ["bigtable_hello_app_profile.cc"],
+    name = "bigtable_hello_instance_admin",
+    srcs = ["bigtable_hello_instance_admin.cc"],
     deps = ["//google/cloud/bigtable:bigtable_client"],
 )
 
 cc_binary(
-    name = "bigtable_quickstart",
-    srcs = ["bigtable_quickstart.cc"],
+    name = "bigtable_hello_table_admin",
+    srcs = ["bigtable_hello_table_admin.cc"],
     deps = ["//google/cloud/bigtable:bigtable_client"],
 )
 
 cc_binary(
-    name = "bigtable_samples",
-    srcs = ["bigtable_samples.cc"],
+    name = "bigtable_hello_world",
+    srcs = ["bigtable_hello_world.cc"],
     deps = ["//google/cloud/bigtable:bigtable_client"],
 )
 
 cc_binary(
-    name = "bigtable_instance_admin_snippets",
-    srcs = ["bigtable_instance_admin_snippets.cc"],
+    name = "bigtable_quickstart",
+    srcs = ["bigtable_quickstart.cc"],
     deps = ["//google/cloud/bigtable:bigtable_client"],
 )
 
 cc_binary(
-    name = "bigtable_samples_instance_admin",
-    srcs = ["bigtable_samples_instance_admin.cc"],
+    name = "bigtable_instance_admin_snippets",
+    srcs = ["bigtable_instance_admin_snippets.cc"],
     deps = ["//google/cloud/bigtable:bigtable_client"],
 )
 

google/cloud/bigtable/examples/CMakeLists.txt

@@ -18,6 +18,14 @@
 # to keep this particular file as simple as possible, as it is intended to be
 # part of the examples.
 
+add_executable(bigtable_hello_table_admin bigtable_hello_table_admin.cc)
+target_link_libraries(bigtable_hello_table_admin bigtable_client
+                      bigtable_common_options)
+
+add_executable(bigtable_hello_instance_admin bigtable_hello_instance_admin.cc)
+target_link_libraries(bigtable_hello_instance_admin bigtable_client
+                      bigtable_common_options)
+
 add_executable(bigtable_hello_world bigtable_hello_world.cc)
 target_link_libraries(bigtable_hello_world bigtable_client
                       bigtable_common_options)
@@ -30,19 +38,11 @@ add_executable(bigtable_quickstart bigtable_quickstart.cc)
 target_link_libraries(bigtable_quickstart bigtable_client
                       bigtable_common_options)
 
-add_executable(bigtable_samples bigtable_samples.cc)
-target_link_libraries(bigtable_samples bigtable_client bigtable_common_options)
-
 add_executable(bigtable_instance_admin_snippets
                bigtable_instance_admin_snippets.cc)
 target_link_libraries(bigtable_instance_admin_snippets bigtable_client
                       bigtable_common_options)
 
-add_executable(bigtable_samples_instance_admin
-               bigtable_samples_instance_admin.cc)
-target_link_libraries(bigtable_samples_instance_admin bigtable_client
-                      bigtable_common_options)
-
 add_executable(instance_admin_async_snippets instance_admin_async_snippets.cc)
 target_link_libraries(instance_admin_async_snippets bigtable_client
                       bigtable_common_options)

google/cloud/bigtable/examples/README.md

@@ -18,10 +18,14 @@ referenced from the Doxygen landing page as "Hello World".
 
 ### Compile the Examples
 
+<!-- START bigtable_hw_install -->
+
 These examples are compiled as part of the build for the Cloud Bigtable C++
 Client.  The instructions on how to compile the code are in the
 [top-level README](../../README.md) file.
 
+<!-- END bigtable_hw_install -->
+
 ### Run the Examples
 
 You first need to create a production instance, the easiest way is to
@@ -61,7 +65,8 @@ $ gcloud auth login
 
 ### Hello world
 
-View the [Hello World][hello_world_code] example to see sample usage of the Bigtable client library.
+View the [Hello World][hello_world_code] example to see sample usage of the
+Bigtable client library.
 
 #### Usage
 
@@ -71,6 +76,7 @@ Usage: bigtable_hello_world <project_id> <instance_id> <table_id>
 ```
 
 #### Run Hello world
+
 After configuring gRPC, you can run the examples using:
 
 ```console
@@ -81,8 +87,8 @@ $ ./bigtable_hello_world ${PROJECT_ID} ${INSTANCE_ID} example-table
 
 ### Administer Instances
 
-View the [example][instance_admin_code] to see sample usage of instance administration of
-the Bigtable client library.
+View the [example][instance_admin_code] to see sample usage of instance
+administration of the Bigtable client library.
 
 #### Usage
 
@@ -114,7 +120,7 @@ $ ./bigtable_samples_instance_admin run ${PROJECT_ID} ${INSTANCE_ID} ${CLUSTER_I
 ```
 
 [hello_world_code]: bigtable_hello_world.cc
-[instance_admin_code]: bigtable_samples_instance_admin.cc
+[instance_admin_code]: bigtable_hello_instance_admin.cc
 
 ### Administer Tables
 

…mples/bigtable_samples_instance_admin.cc …xamples/bigtable_hello_instance_admin.ccgoogle/cloud/bigtable/examples/bigtable_samples_instance_admin.cc renamed to google/cloud/bigtable/examples/bigtable_hello_instance_admin.cc google/cloud/bigtable/examples/bigtable_samples_instance_admin.cc renamed to google/cloud/bigtable/examples/bigtable_hello_instance_admin.cc

@@ -36,6 +36,12 @@ source "${BINDIR}/../../../../ci/colors.sh"
 echo "${COLOR_YELLOW}run_quickstart_example${COLOR_RESET}"
 run_quickstart_example "${PROJECT_ID}" "${INSTANCE_ID}"
 
+echo "${COLOR_YELLOW}run_hello_instance_admin_example${COLOR_RESET}"
+run_hello_instance_admin_example "${PROJECT_ID}" "${ZONE_A}"
+
+echo "${COLOR_YELLOW}run_hello_table_admin_example${COLOR_RESET}"
+run_hello_table_admin_example "${PROJECT_ID}" "${INSTANCE_ID}"
+
 echo "${COLOR_YELLOW}run_hello_world_example${COLOR_RESET}"
 run_hello_world_example "${PROJECT_ID}" "${INSTANCE_ID}"
 

…ud/bigtable/examples/bigtable_samples.cc …e/examples/bigtable_hello_table_admin.ccgoogle/cloud/bigtable/examples/bigtable_samples.cc renamed to google/cloud/bigtable/examples/bigtable_hello_table_admin.cc google/cloud/bigtable/examples/bigtable_samples.cc renamed to google/cloud/bigtable/examples/bigtable_hello_table_admin.cc

@@ -139,7 +139,6 @@ function run_all_instance_admin_examples {
   # Verify that calling without a command produces the right exit status and
   # some kind of Usage message.
   run_example_usage ./bigtable_instance_admin_snippets
-  run_example_usage ./bigtable_samples_instance_admin
 }
 
 # Run all the instance admin async examples.
@@ -225,8 +224,6 @@ function run_all_table_admin_examples {
   run_example ./bigtable_instance_admin_snippets create-instance \
       "${project_id}" "${INSTANCE}" "${zone_id}"
 
-  run_example ./bigtable_samples run "${project_id}" "${INSTANCE}" "${TABLE}"
-
   run_example ./table_admin_snippets create-table \
       "${project_id}" "${INSTANCE}" "${TABLE}"
   run_example ./table_admin_snippets list-tables \
@@ -433,12 +430,6 @@ run_all_data_examples() {
 
   run_mutate_examples "${project_id}" "${instance_id}"
 
-  # Use a different table for the full example test, if we use the same table
-  # as the other tests this can fail with timeouts.
-  local -r FULL_TABLE="data-ex-full-${RANDOM}-${RANDOM}"
-  run_example ./bigtable_samples run-full-example \
-      "${project_id}" "${instance_id}" "${FULL_TABLE}"
-
   # Use the same table in all the tests.
   local -r TABLE="data-ex-tbl-${RANDOM}-${RANDOM}"
   local -r PREFIX_1="root/0/1/"
@@ -695,6 +686,75 @@ run_quickstart_example() {
   run_example_usage ./bigtable_quickstart
 }
 
+################################################
+# Run the Bigtable hello world for InstanceAdmin example.
+# Globals:
+#   None
+# Arguments:
+#   project_id: the Google Cloud Platform project used in the test. Can be a
+#       fake project when testing against the emulator, as the emulator creates
+#       projects on demand. It must be a valid, existing instance when testing
+#       against production.
+#   zone_id: a Google Cloud Platform zone with support for Cloud Bigtable.
+# Returns:
+#   None
+################################################
+run_hello_instance_admin_example() {
+  local project_id=$1
+  local zone_id=$2
+  shift 2
+
+  # Use the same table in all the tests.
+  local -r RANDOM_INSTANCE_ID="it-${RANDOM}-${RANDOM}"
+  local -r RANDOM_CLUSTER_ID="${RANDOM_INSTANCE_ID}-c1"
+
+  run_example ./bigtable_hello_instance_admin "run" \
+      "${project_id}" "${RANDOM_INSTANCE_ID}" "${RANDOM_CLUSTER_ID}" \
+      "${zone_id}"
+
+  # Verify that calling without a command produces the right exit status and
+  # some kind of Usage message.
+  run_example_usage ./bigtable_hello_instance_admin
+}
+
+################################################
+# Run the Bigtable hello world for Table Admin example.
+# Globals:
+#   None
+# Arguments:
+#   project_id: the Google Cloud Platform project used in the test. Can be a
+#       fake project when testing against the emulator, as the emulator creates
+#       projects on demand. It must be a valid, existing instance when testing
+#       against production.
+#   instance_id: the Google Cloud Bigtable instance used in the test. Can be a
+#       fake instance when testing against the emulator, as the emulator creates
+#       instances on demand. It must be a valid, existing instance when testing
+#       against production.
+# Returns:
+#   None
+################################################
+run_hello_table_admin_example() {
+  local project_id=$1
+  local instance_id=$2
+  shift 2
+
+  # TODO(#2626) - remove "run-full-example" it is just a duplicate of "run".
+  # Use a different table for the full example test, if we use the same table
+  # as the other tests this can fail with timeouts.
+  local -r FULL_TABLE="data-ex-full-${RANDOM}-${RANDOM}"
+  run_example ./bigtable_hello_table_admin run-full-example \
+      "${project_id}" "${instance_id}" "${FULL_TABLE}"
+
+  # Use the same table in all the tests.
+  local -r TABLE="hello-table-admin-${RANDOM}"
+  run_example ./bigtable_hello_table_admin run \
+      "${project_id}" "${instance_id}" "${TABLE}"
+
+  # Verify that calling without a command produces the right exit status and
+  # some kind of Usage message.
+  run_example_usage ./bigtable_hello_world
+}
+
 ################################################
 # Run the Bigtable hello world example.
 # Globals: