add comments to mock classes

Signed-off-by: eric846 <[email protected]>
envoyproxy · Sep 14, 2020 · 50bc113 · 50bc113
1 parent 80578fa
commit 50bc113
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 0 deletions.
diff --git a/test/mocks/adaptive_load/mock_metrics_evaluator.h b/test/mocks/adaptive_load/mock_metrics_evaluator.h
@@ -6,8 +6,22 @@
 
 namespace Nighthawk {
 
+/**
+ * A mock MetricsEvaluator that returns empty values from all methods.
+ *
+ * Typical usage:
+ *
+ *   MockMetricsEvaluator mock_metrics_evaluator;
+ *   BenchmarkResult benchmark_result;
+ *   // (set benchmark_result fields here)
+ *   EXPECT_CALL(mock_metrics_evaluator, AnalyzeNighthawkBenchmark(_, _, _))
+ *       .WillRepeatedly(Return(benchmark_result));
+ */
 class MockMetricsEvaluator : public MetricsEvaluator {
 public:
+  /**
+   * Empty constructor.
+   */
   MockMetricsEvaluator();
 
   MOCK_CONST_METHOD3(EvaluateMetric,

diff --git a/test/mocks/adaptive_load/mock_session_spec_proto_helper.h b/test/mocks/adaptive_load/mock_session_spec_proto_helper.h
@@ -6,8 +6,30 @@
 
 namespace Nighthawk {
 
+/**
+ * A mock AdaptiveLoadSessionSpecProtoHelper that returns empty values or success from all methods
+ * by default.
+ *
+ * In particular, SetSessionSpecDefaults does not pass its input value through to its output;
+ * regardless of the output, it returns an empty proto, unless explicitly configured (see below). If
+ * you don't need to inspect calls to the spec proto helper, it may be easier to use the real
+ * AdaptiveLoadSessionSpecProtoHelperImpl in tests instead.
+ *
+ * Typical usage:
+ *
+ *   NiceMock<MockAdaptiveLoadSessionSpecProtoHelper> mock_spec_proto_helper;
+ *   EXPECT_CALL(mock_spec_proto_helper, CheckSessionSpec(_))
+ *       .WillOnce(Return(absl::OkStatus()));
+ *   AdaptiveLoadSessionSpec spec;
+ *   // Set spec fields here, including providing all defaults yourself.
+ *   EXPECT_CALL(mock_spec_proto_helper, SetSessionSpecDefaults(_))
+ *       .WillOnce(Return(spec));
+ */
 class MockAdaptiveLoadSessionSpecProtoHelper : public AdaptiveLoadSessionSpecProtoHelper {
 public:
+  /**
+   * Empty constructor.
+   */
   MockAdaptiveLoadSessionSpecProtoHelper();
 
   MOCK_CONST_METHOD1(SetSessionSpecDefaults,

diff --git a/test/mocks/common/mock_nighthawk_service_client.h b/test/mocks/common/mock_nighthawk_service_client.h
@@ -6,8 +6,21 @@
 
 namespace Nighthawk {
 
+/**
+ * A mock NighthawkServiceClient that returns an empty response by default.
+ *
+ * Typical usage:
+ *
+ *   NiceMock<MockNighthawkServiceClient> mock_nighthawk_service_client;
+ *   nighthawk::client::ExecutionResponse nighthawk_response;
+ *   EXPECT_CALL(mock_nighthawk_service_client, PerformNighthawkBenchmark(_, _))
+ *       .WillRepeatedly(Return(nighthawk_response));
+ */
 class MockNighthawkServiceClient : public NighthawkServiceClient {
 public:
+  /**
+   * Empty constructor.
+   */
   MockNighthawkServiceClient();
 
   MOCK_CONST_METHOD2(PerformNighthawkBenchmark,