Added some JavaDocs.

Minor refactorings, mostly renaming.
Fixed typos.

Author: robsunday

jmx-scraper/src/integrationTest/java/io/opentelemetry/contrib/jmxscraper/assertions/MetricAssert.java

@@ -47,20 +47,22 @@ public void setStrict(boolean strict) {
   }
 
   public void strictCheck() {
-    strictCheck("description", /* expectedValue= */ true, descriptionChecked);
-    strictCheck("unit", /* expectedValue= */ true, unitChecked);
-    strictCheck("type", /* expectedValue= */ true, typeChecked);
-    strictCheck("data point attributes", /* expectedValue= */ true, dataPointAttributesChecked);
+    strictCheck("description", /* expectedCheckStatus= */ true, descriptionChecked);
+    strictCheck("unit", /* expectedCheckStatus= */ true, unitChecked);
+    strictCheck("type", /* expectedCheckStatus= */ true, typeChecked);
+    strictCheck(
+        "data point attributes", /* expectedCheckStatus= */ true, dataPointAttributesChecked);
   }
 
-  private void strictCheck(String attribute, boolean expectedValue, boolean value) {
+  private void strictCheck(
+      String metricProperty, boolean expectedCheckStatus, boolean actualCheckStatus) {
     if (!strict) {
       return;
     }
-    String failMsgPrefix = expectedValue ? "duplicate" : "missing";
+    String failMsgPrefix = expectedCheckStatus ? "duplicate" : "missing";
     info.description(
-        "%s assertion on %s for metric '%s'", failMsgPrefix, attribute, actual.getName());
-    objects.assertEqual(info, value, expectedValue);
+        "%s assertion on %s for metric '%s'", failMsgPrefix, metricProperty, actual.getName());
+    objects.assertEqual(info, actualCheckStatus, expectedCheckStatus);
   }
 
   /**
@@ -75,7 +77,7 @@ public MetricAssert hasDescription(String description) {
 
     info.description("unexpected description for metric '%s'", actual.getName());
     objects.assertEqual(info, actual.getDescription(), description);
-    strictCheck("description", /* expectedValue= */ false, descriptionChecked);
+    strictCheck("description", /* expectedCheckStatus= */ false, descriptionChecked);
     descriptionChecked = true;
     return this;
   }
@@ -92,13 +94,13 @@ public MetricAssert hasUnit(String unit) {
 
     info.description("unexpected unit for metric '%s'", actual.getName());
     objects.assertEqual(info, actual.getUnit(), unit);
-    strictCheck("unit", /* expectedValue= */ false, unitChecked);
+    strictCheck("unit", /* expectedCheckStatus= */ false, unitChecked);
     unitChecked = true;
     return this;
   }
 
   /**
-   * Verifies the metric to be a gauge
+   * Verifies the metric is a gauge
    *
    * @return this
    */
@@ -108,7 +110,7 @@ public MetricAssert isGauge() {
 
     info.description("gauge expected for metric '%s'", actual.getName());
     objects.assertEqual(info, actual.hasGauge(), true);
-    strictCheck("type", /* expectedValue= */ false, typeChecked);
+    strictCheck("type", /* expectedCheckStatus= */ false, typeChecked);
     typeChecked = true;
     return this;
   }
@@ -135,16 +137,21 @@ private MetricAssert hasSum(boolean monotonic) {
   public MetricAssert isCounter() {
     // counters have a monotonic sum as their value can't decrease
     hasSum(true);
-    strictCheck("type", /* expectedValue= */ false, typeChecked);
+    strictCheck("type", /* expectedCheckStatus= */ false, typeChecked);
     typeChecked = true;
     return this;
   }
 
+  /**
+   * Verifies the metric is an up-down counter
+   *
+   * @return this
+   */
   @CanIgnoreReturnValue
   public MetricAssert isUpDownCounter() {
     // up down counters are non-monotonic as their value can increase & decrease
     hasSum(false);
-    strictCheck("type", /* expectedValue= */ false, typeChecked);
+    strictCheck("type", /* expectedCheckStatus= */ false, typeChecked);
     typeChecked = true;
     return this;
   }
@@ -169,7 +176,7 @@ public MetricAssert hasDataPointsWithoutAttributes() {
   @CanIgnoreReturnValue
   private MetricAssert checkDataPoints(Consumer<List<NumberDataPoint>> listConsumer) {
     // in practice usually one set of data points is provided but the
-    // protobuf does not enforce that so we have to ensure checking at least one
+    // protobuf does not enforce that, so we have to ensure checking at least one
     int count = 0;
     if (actual.hasGauge()) {
       count++;
@@ -182,7 +189,7 @@ private MetricAssert checkDataPoints(Consumer<List<NumberDataPoint>> listConsume
     info.description("at least one set of data points expected for metric '%s'", actual.getName());
     integers.assertGreaterThan(info, count, 0);
 
-    strictCheck("data point attributes", /* expectedValue= */ false, dataPointAttributesChecked);
+    strictCheck("data point attributes", /* expectedCheckStatus= */ false, dataPointAttributesChecked);
     dataPointAttributesChecked = true;
     return this;
   }
@@ -295,7 +302,7 @@ public final MetricAssert hasDataPointsAttributes(Map<String, String>... attribu
   }
 
   /**
-   * map equality utility
+   * Map equality utility
    *
    * @param m1 first map
    * @param m2 second map

jmx-scraper/src/integrationTest/java/io/opentelemetry/contrib/jmxscraper/target_systems/MetricAssertions.java

@@ -41,10 +41,7 @@ static void assertSum(
     assertThat(metric.hasSum()).isTrue();
     assertThat(metric.getSum().getIsMonotonic()).isEqualTo(isMonotonic);
 
-    assertThat(metric)
-        .hasDescription(description)
-        .hasUnit(unit)
-        .hasDataPointsWithoutAttributes();
+    assertThat(metric).hasDescription(description).hasUnit(unit).hasDataPointsWithoutAttributes();
   }
 
   @SafeVarargs
@@ -86,9 +83,7 @@ static void assertSumWithAttributesMultiplePoints(
       Consumer<MapAssert<String, String>>... attributeGroupAssertions) {
 
     assertThat(metric.getName()).isEqualTo(name);
-    assertThat(metric)
-        .hasDescription(description)
-        .hasUnit(unit);
+    assertThat(metric).hasDescription(description).hasUnit(unit);
 
     assertThat(metric.hasSum()).isTrue();
     assertThat(metric.getSum().getIsMonotonic()).isEqualTo(isMonotonic);
@@ -104,10 +99,7 @@ static void assertGaugeWithAttributes(
       Consumer<MapAssert<String, String>>... attributeGroupAssertions) {
     assertThat(metric.getName()).isEqualTo(name);
 
-    assertThat(metric)
-        .hasDescription(description)
-        .hasUnit(unit)
-        .isGauge();
+    assertThat(metric).hasDescription(description).hasUnit(unit).isGauge();
 
     assertAttributedPoints(metric.getGauge().getDataPointsList(), attributeGroupAssertions);
   }

jmx-scraper/src/integrationTest/java/io/opentelemetry/contrib/jmxscraper/target_systems/MetricsVerifier.java

@@ -29,7 +29,7 @@ private MetricsVerifier() {}
   /**
    * Create instance of MetricsVerifier configured to fail verification if any metric was not
    * verified because there is no assertion defined for it. This behavior can be changed by calling
-   * allowingExtraMetrics() method.
+   * {@link #disableStrictMode()} method.
    *
    * @return new instance of MetricsVerifier
    * @see #disableStrictMode()
@@ -38,12 +38,29 @@ public static MetricsVerifier create() {
     return new MetricsVerifier();
   }
 
+  /**
+   * Disable strict checks of metric assertions. It means that all metrics checks added after
+   * calling this method will not enforce asserting all metric properties and will not detect
+   * duplicate property assertions. Also, there will be no error reported if any of metrics was
+   * skipped because no assertion was added for it.
+   *
+   * @return this
+   * @see #verify(List)
+   * @see #add(String, Consumer)
+   */
   @CanIgnoreReturnValue
   public MetricsVerifier disableStrictMode() {
     strictMode = false;
     return this;
   }
 
+  /**
+   * Add assertion for given metric
+   *
+   * @param metricName name of metric to be verified by provided assertion
+   * @param assertion an assertion to verify properties of the metric
+   * @return this
+   */
   @CanIgnoreReturnValue
   public MetricsVerifier add(String metricName, Consumer<MetricAssert> assertion) {
     assertions.put(
@@ -57,6 +74,15 @@ public MetricsVerifier add(String metricName, Consumer<MetricAssert> assertion)
     return this;
   }
 
+  /**
+   * Execute all defined assertions against provided list of metrics. Error is reported if any of
+   * defined assertions failed. Error is also reported if any of expected metrics was not present in
+   * the metrics list, unless strict mode is disabled with {@link #disableStrictMode()}.
+   *
+   * @param metrics list of metrics to be verified
+   * @see #add(String, Consumer)
+   * @see #disableStrictMode()
+   */
   public void verify(List<Metric> metrics) {
     verifyAllExpectedMetricsWereReceived(metrics);
 
@@ -78,7 +104,6 @@ public void verify(List<Metric> metrics) {
     }
   }
 
-  @SuppressWarnings("SystemOut")
   private void verifyAllExpectedMetricsWereReceived(List<Metric> metrics) {
     Set<String> receivedMetricNames =
         metrics.stream().map(Metric::getName).collect(Collectors.toSet());