fix(generator): clean up protobuf debug markers and format test expectations

Author: colinmoy

generator/internal/discovery_type_vertex_test.cc

@@ -248,31 +248,28 @@ TEST(DiscoveryTypeVertexTest, FormatFieldOptionsDebugRedactNonMatches) {
 )""";
   auto json = nlohmann::json::parse(kFieldJson, nullptr, false);
   ASSERT_TRUE(json.is_object());
-  EXPECT_THAT(
-      DiscoveryTypeVertex::FormatFieldOptions("monkey", "monkey", json),
-      Eq(" [json_name=\"monkey\"]"));
+  EXPECT_THAT(DiscoveryTypeVertex::FormatFieldOptions("monkey", "monkey", json),
+              Eq(" [json_name=\"monkey\"]"));
   EXPECT_THAT(
       DiscoveryTypeVertex::FormatFieldOptions("keyboard", "keyboard", json),
       Eq(" [json_name=\"keyboard\"]"));
-  EXPECT_THAT(
-      DiscoveryTypeVertex::FormatFieldOptions("hockey", "hockey", json),
-      Eq(" [json_name=\"hockey\"]"));
-  EXPECT_THAT(
-      DiscoveryTypeVertex::FormatFieldOptions("keypad", "keypad", json),
-      Eq(" [json_name=\"keypad\"]"));
+  EXPECT_THAT(DiscoveryTypeVertex::FormatFieldOptions("hockey", "hockey", json),
+              Eq(" [json_name=\"hockey\"]"));
+  EXPECT_THAT(DiscoveryTypeVertex::FormatFieldOptions("keypad", "keypad", json),
+              Eq(" [json_name=\"keypad\"]"));
 }
 
-TEST(DiscoveryTypeVertexTest, FormatFieldOptionsDebugRedactNonStringNotRedacted) {
+TEST(DiscoveryTypeVertexTest,
+     FormatFieldOptionsDebugRedactNonStringNotRedacted) {
   auto constexpr kFieldJson = R"""(
 {
   "type": "integer"
 }
 )""";
   auto json = nlohmann::json::parse(kFieldJson, nullptr, false);
   ASSERT_TRUE(json.is_object());
-  EXPECT_THAT(
-      DiscoveryTypeVertex::FormatFieldOptions("key_id", "keyId", json),
-      Eq(" [json_name=\"keyId\"]"));
+  EXPECT_THAT(DiscoveryTypeVertex::FormatFieldOptions("key_id", "keyId", json),
+              Eq(" [json_name=\"keyId\"]"));
 }
 
 TEST(DiscoveryTypeVertexTest, FormatFieldOptionsDebugRedactRequired) {
@@ -1420,8 +1417,7 @@ message TestSchema {
                                  "optional string to: optional double")));
 }
 
-TEST_F(DiscoveryTypeVertexDescriptorTest,
-       JsonToProtobufCustomerEncryptionKey) {
+TEST_F(DiscoveryTypeVertexDescriptorTest, JsonToProtobufCustomerEncryptionKey) {
   auto constexpr kSchemaJson = R"""(
 {
   "id": "CustomerEncryptionKey",

google/cloud/internal/debug_string_protobuf.cc

@@ -63,14 +63,30 @@ class TimestampMessagePrinter
 };
 
 template <typename Printer>
-auto SetRedact(Printer& p, int)
-    -> decltype(p.SetRedactDebugString(true), void()) {
+auto SetRedact(Printer& p, int) -> decltype(p.SetRedactDebugString(true),
+                                            void()) {
   p.SetRedactDebugString(true);
 }
 
 template <typename Printer>
 void SetRedact(Printer&, ...) {}
 
+void RemoveSilentMarker(std::string& str) {
+  auto start = str.find("goo.gle/");
+  if (start != std::string::npos) {
+    auto nl = str.find('\n', start);
+    if (nl != std::string::npos) {
+      str.erase(0, nl + 1);
+    } else {
+      auto end = str.find_first_of(" \t", start);
+      if (end != std::string::npos) {
+        auto next = str.find_first_not_of(" \t", end);
+        str.erase(0, next == std::string::npos ? str.size() : next);
+      }
+    }
+  }
+}
+
 }  // namespace
 
 std::string DebugString(google::protobuf::Message const& m,
@@ -90,6 +106,7 @@ std::string DebugString(google::protobuf::Message const& m,
   p.RegisterMessagePrinter(google::protobuf::Timestamp::descriptor(),
                            new TimestampMessagePrinter);
   p.PrintToString(m, &str);
+  RemoveSilentMarker(str);
   return absl::StrCat(m.GetTypeName(), " {",
                       (options.single_line_mode() ? " " : "\n"), str, "}");
 }

google/cloud/internal/debug_string_protobuf_test.cc

@@ -54,7 +54,6 @@ TEST(LogWrapperHelpers, DefaultOptions) {
   // clang-format off
   std::string const text =
     R"pb(google.iam.v1.Policy { )pb"
-    R"pb(goo.gle/debugonly )pb"
     R"pb(bindings { )pb"
     R"pb(role: "roles/viewer" )pb"
     R"pb(members: "user:user1@example.com" )pb"
@@ -76,7 +75,6 @@ TEST(LogWrapperHelpers, MultiLine) {
   tracing_options.SetOptions("single_line_mode=off");
   // clang-format off
   std::string const text = R"pb(google.iam.v1.Policy {
-  goo.gle/debugonly 
   bindings {
     role: "roles/viewer"
     members: "user:user1@example.com"
@@ -99,7 +97,6 @@ TEST(LogWrapperHelpers, Truncate) {
   // clang-format off
   std::string const text =
     R"pb(google.iam.v1.Policy { )pb"
-    R"pb(goo.gle/debugonly )pb"
     R"pb(bindings { )pb"
     R"pb(role: "roles/vi...<truncated>..." )pb"
     R"pb(members: "user:use...<truncated>..." )pb"
@@ -121,7 +118,7 @@ TEST(LogWrapperHelpers, Duration) {
   duration.set_seconds((11 * 60 + 22) * 60 + 33);
   duration.set_nanos(123456789);
   std::string const expected =
-      R"(google.protobuf.Duration { goo.gle/debugonly "11h22m33.123456789s" })";
+      R"(google.protobuf.Duration { "11h22m33.123456789s" })";
   EXPECT_EQ(expected, DebugString(duration, TracingOptions{}.SetOptions(
                                                 "single_line_mode=on")));
 }
@@ -131,7 +128,6 @@ TEST(LogWrapperHelpers, Timestamp) {
   timestamp.set_seconds(1658470436);
   timestamp.set_nanos(123456789);
   std::string const expected = R"(google.protobuf.Timestamp {
-  goo.gle/debugonly 
   "2022-07-22T06:13:56.123456789Z"
 })";
   EXPECT_EQ(expected, DebugString(timestamp, TracingOptions{}.SetOptions(
@@ -150,7 +146,8 @@ TEST(LogWrapperHelpers, RedactedField) {
       message_proto->add_field();
   unredacted_field->set_name("public_field");
   unredacted_field->set_number(1);
-  unredacted_field->set_type(google::protobuf::FieldDescriptorProto::TYPE_STRING);
+  unredacted_field->set_type(
+      google::protobuf::FieldDescriptorProto::TYPE_STRING);
 
   google::protobuf::FieldDescriptorProto* redacted_field =
       message_proto->add_field();