impl(bigquery): Logging decorator cleanup (contd) - Adds DebugString() member functions to GetJobRequest and ListJobsRequest (#11141)

Author: jsrinnn

google/cloud/bigquery/v2/minimal/internal/job_request.cc

@@ -15,6 +15,7 @@
 #include "google/cloud/bigquery/v2/minimal/internal/job_request.h"
 #include "google/cloud/common_options.h"
 #include "google/cloud/internal/absl_str_cat_quiet.h"
+#include "google/cloud/internal/debug_string.h"
 #include "google/cloud/internal/format_time_point.h"
 #include "google/cloud/internal/make_status.h"
 #include "google/cloud/status.h"
@@ -70,6 +71,32 @@ StateFilter StateFilter::Done() {
   return state_filter;
 }
 
+std::string GetJobRequest::DebugString(TracingOptions const& options) const {
+  std::string out;
+  auto const* delim = options.single_line_mode() ? " " : "\n";
+  absl::StrAppend(&out, "GetJobRequest{", delim,
+                  "project_id=", internal::DebugString(project_id_, options),
+                  delim, "job_id=", internal::DebugString(job_id_, options),
+                  delim, internal::DebugString(location_, options), delim, "}");
+  return out;
+}
+
+std::string ListJobsRequest::DebugString(TracingOptions const& options) const {
+  std::string out;
+  auto const* delim = options.single_line_mode() ? " " : "\n";
+  auto const* all_users = all_users_ ? "true" : "false";
+  absl::StrAppend(
+      &out, "ListJobsRequest{", delim,
+      "project_id=", internal::DebugString(project_id_, options), delim,
+      ", all_users=", all_users, delim, ", max_results=", max_results_, delim,
+      ", page_token=", internal::DebugString(page_token_, options), delim,
+      ", projection=", internal::DebugString(projection_.value, options), delim,
+      ", state_filter=", internal::DebugString(state_filter_.value, options),
+      delim, ", parent_job_id=", internal::DebugString(parent_job_id_, options),
+      delim, "}");
+  return out;
+}
+
 ListJobsRequest::ListJobsRequest(std::string project_id)
     : project_id_(std::move(project_id)),
       all_users_(false),

google/cloud/bigquery/v2/minimal/internal/job_request.h

@@ -18,6 +18,7 @@
 #include "google/cloud/internal/rest_request.h"
 #include "google/cloud/options.h"
 #include "google/cloud/status_or.h"
+#include "google/cloud/tracing_options.h"
 #include "google/cloud/version.h"
 #include <chrono>
 #include <ostream>
@@ -63,6 +64,8 @@ class GetJobRequest {
     return std::move(set_location(std::move(location)));
   }
 
+  std::string DebugString(TracingOptions const& options) const;
+
  private:
   std::string project_id_;
   std::string job_id_;
@@ -179,6 +182,8 @@ class ListJobsRequest {
     return std::move(set_parent_job_id(std::move(parent_job_id)));
   }
 
+  std::string DebugString(TracingOptions const& options) const;
+
   // Members
  private:
   std::string project_id_;

google/cloud/bigquery/v2/minimal/internal/job_request_test.cc

@@ -165,18 +165,36 @@ TEST(ListJobsRequestTest, EmptyProjectId) {
 TEST(ListJobsRequestTest, OutputStream) {
   auto const request = GetListJobsRequest();
   std::string all_users = request.all_users() ? "true" : "false";
-  std::string expected = absl::StrCat(
-      "ListJobsRequest{project_id=", request.project_id(),
-      ", all_users=", all_users, ", max_results=", request.max_results(),
-      ", page_token=", request.page_token(),
-      ", projection=", request.projection().value,
-      ", state_filter=", request.state_filter().value,
-      ", parent_job_id=", request.parent_job_id(), "}");
+  std::string expected =
+      "ListJobsRequest{project_id=1, all_users=true, max_results=10"
+      ", page_token=123, projection=FULL, state_filter=RUNNING"
+      ", parent_job_id=1}";
   std::ostringstream os;
   os << request;
   EXPECT_EQ(expected, os.str());
 }
 
+TEST(GetJobRequest, DebugString) {
+  GetJobRequest request("test-project-id", "test-job-id");
+  request.set_location("test-location");
+  std::string expected =
+      "GetJobRequest{ project_id=test-project-id job_id=test-job-id "
+      "test-location }";
+
+  EXPECT_EQ(expected, request.DebugString(TracingOptions{}));
+}
+
+TEST(ListJobsRequestTest, DebugString) {
+  auto const request = GetListJobsRequest();
+  std::string all_users = request.all_users() ? "true" : "false";
+  std::string expected =
+      "ListJobsRequest{ project_id=1 , all_users=true , max_results=10 , "
+      "page_token=123 , projection=FULL , state_filter=RUNNING , "
+      "parent_job_id=1 }";
+
+  EXPECT_EQ(expected, request.DebugString(TracingOptions{}));
+}
+
 GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
 }  // namespace bigquery_v2_minimal_internal
 }  // namespace cloud