Bug 1393041 - Refactor and share the telemetry c++ utility functions in gtests. r=dexter

toolkit/components/telemetry/tests/gtest/TelemetryTestHelpers.cpp

@@ -0,0 +1,185 @@
+/* Any copyright is dedicated to the Public Domain.
+ * http://creativecommons.org/publicdomain/zero/1.0/
+ */
+
+#include "TelemetryTestHelpers.h"
+
+#include "gtest/gtest.h"
+#include "mozilla/CycleCollectedJSContext.h"
+#include "mozilla/Unused.h"
+
+using namespace mozilla;
+
+// Helper methods provided to simplify writing tests and meant to be used in C++ Gtests.
+namespace TelemetryTestHelpers {
+
+void
+CheckUintScalar(const char* aName, JSContext* aCx, JS::HandleValue aSnapshot, uint32_t expectedValue)
+{
+  // Validate the value of the test scalar.
+  JS::RootedValue value(aCx);
+  JS::RootedObject scalarObj(aCx, &aSnapshot.toObject());
+  ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &value)) << "The test scalar must be reported.";
+  JS_GetProperty(aCx, scalarObj, aName, &value);
+
+  ASSERT_TRUE(value.isInt32()) << "The scalar value must be of the correct type.";
+  ASSERT_TRUE(value.toInt32() >= 0) << "The uint scalar type must contain a value >= 0.";
+  ASSERT_EQ(static_cast<uint32_t>(value.toInt32()), expectedValue) << "The scalar value must match the expected value.";
+}
+
+void
+CheckBoolScalar(const char* aName, JSContext* aCx, JS::HandleValue aSnapshot, bool expectedValue)
+{
+  // Validate the value of the test scalar.
+  JS::RootedValue value(aCx);
+  JS::RootedObject scalarObj(aCx, &aSnapshot.toObject());
+  ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &value)) << "The test scalar must be reported.";
+  ASSERT_TRUE(value.isBoolean()) << "The scalar value must be of the correct type.";
+  ASSERT_EQ(static_cast<bool>(value.toBoolean()), expectedValue) << "The scalar value must match the expected value.";
+}
+
+void
+CheckStringScalar(const char* aName, JSContext* aCx, JS::HandleValue aSnapshot, const char* expectedValue)
+{
+  // Validate the value of the test scalar.
+  JS::RootedValue value(aCx);
+  JS::RootedObject scalarObj(aCx, &aSnapshot.toObject());
+  ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &value)) << "The test scalar must be reported.";
+  ASSERT_TRUE(value.isString()) << "The scalar value must be of the correct type.";
+
+  bool sameString;
+  ASSERT_TRUE(JS_StringEqualsAscii(aCx, value.toString(), expectedValue, &sameString)) << "JS String comparison failed";
+  ASSERT_TRUE(sameString) << "The scalar value must match the expected string";
+}
+
+void
+CheckKeyedUintScalar(const char* aName, const char* aKey, JSContext* aCx, JS::HandleValue aSnapshot,
+                     uint32_t expectedValue)
+{
+  JS::RootedValue keyedScalar(aCx);
+  JS::RootedObject scalarObj(aCx, &aSnapshot.toObject());
+  // Get the aName keyed scalar object from the scalars snapshot.
+  ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &keyedScalar))
+    << "The keyed scalar must be reported.";
+
+  CheckUintScalar(aKey, aCx, keyedScalar, expectedValue);
+}
+
+void
+CheckKeyedBoolScalar(const char* aName, const char* aKey, JSContext* aCx, JS::HandleValue aSnapshot,
+                     bool expectedValue)
+{
+  JS::RootedValue keyedScalar(aCx);
+  JS::RootedObject scalarObj(aCx, &aSnapshot.toObject());
+  // Get the aName keyed scalar object from the scalars snapshot.
+  ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &keyedScalar))
+    << "The keyed scalar must be reported.";
+
+  CheckBoolScalar(aKey, aCx, keyedScalar, expectedValue);
+}
+
+void
+CheckNumberOfProperties(const char* aName, JSContext* aCx, JS::HandleValue aSnapshot,
+                        uint32_t expectedNumProperties)
+{
+  JS::RootedValue keyedScalar(aCx);
+  JS::RootedObject scalarObj(aCx, &aSnapshot.toObject());
+  // Get the aName keyed scalar object from the scalars snapshot.
+  ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &keyedScalar))
+    << "The keyed scalar must be reported.";
+
+  JS::RootedObject keyedScalarObj(aCx, &keyedScalar.toObject());
+  JS::Rooted<JS::IdVector> ids(aCx, JS::IdVector(aCx));
+  ASSERT_TRUE(JS_Enumerate(aCx, keyedScalarObj, &ids))
+    << "We must be able to get keyed scalar members.";
+
+  ASSERT_EQ(expectedNumProperties, ids.length())
+    << "The scalar must report the expected number of properties.";
+}
+
+void
+GetScalarsSnapshot(bool aKeyed, JSContext* aCx, JS::MutableHandle<JS::Value> aResult)
+{
+  nsCOMPtr<nsITelemetry> telemetry = do_GetService("@mozilla.org/base/telemetry;1");
+
+  // Get a snapshot of the scalars.
+  JS::RootedValue scalarsSnapshot(aCx);
+  nsresult rv;
+
+  if (aKeyed) {
+    rv = telemetry->SnapshotKeyedScalars(nsITelemetry::DATASET_RELEASE_CHANNEL_OPTIN,
+                                         false, aCx, 0, &scalarsSnapshot);
+  } else {
+    rv = telemetry->SnapshotScalars(nsITelemetry::DATASET_RELEASE_CHANNEL_OPTIN,
+                                    false, aCx, 0, &scalarsSnapshot);
+  }
+
+  // Validate the snapshot.
+  ASSERT_EQ(rv, NS_OK) << "Creating a snapshot of the data must not fail.";
+  ASSERT_TRUE(scalarsSnapshot.isObject()) << "The snapshot must be an object.";
+
+  // We currently only support scalars from the parent process in the gtests.
+  JS::RootedValue parentScalars(aCx);
+  JS::RootedObject scalarObj(aCx, &scalarsSnapshot.toObject());
+  // Don't complain if no scalars for the parent process can be found. Just
+  // return an empty object.
+  Unused << JS_GetProperty(aCx, scalarObj, "parent", &parentScalars);
+
+  aResult.set(parentScalars);
+}
+
+void
+GetAndClearHistogram(JSContext* cx, nsCOMPtr<nsITelemetry> mTelemetry,
+                     const nsACString &name, bool is_keyed)
+{
+  JS::RootedValue testHistogram(cx);
+  nsresult rv = is_keyed ? mTelemetry->GetKeyedHistogramById(name, cx, &testHistogram)
+                         : mTelemetry->GetHistogramById(name, cx, &testHistogram);
+
+  ASSERT_EQ(rv, NS_OK) << "Cannot fetch histogram";
+
+  // Clear the stored value
+  JS::RootedObject testHistogramObj(cx, &testHistogram.toObject());
+  JS::RootedValue rval(cx);
+  ASSERT_TRUE(JS_CallFunctionName(cx, testHistogramObj, "clear",
+                  JS::HandleValueArray::empty(), &rval)) << "Cannot clear histogram";
+}
+
+void
+GetProperty(JSContext* cx, const char* name, JS::HandleValue valueIn,
+            JS::MutableHandleValue valueOut)
+{
+  JS::RootedValue property(cx);
+  JS::RootedObject valueInObj(cx, &valueIn.toObject());
+  ASSERT_TRUE(JS_GetProperty(cx, valueInObj, name, &property))
+    << "Cannot get property '" << name << "'";
+  valueOut.set(property);
+}
+
+void
+GetElement(JSContext* cx, uint32_t index, JS::HandleValue valueIn,
+           JS::MutableHandleValue valueOut)
+{
+  JS::RootedValue element(cx);
+  JS::RootedObject valueInObj(cx, &valueIn.toObject());
+  ASSERT_TRUE(JS_GetElement(cx, valueInObj, index, &element))
+    << "Cannot get element at index '" << index << "'";
+  valueOut.set(element);
+}
+
+void
+GetSnapshots(JSContext* cx, nsCOMPtr<nsITelemetry> mTelemetry,
+             const char* name, JS::MutableHandleValue valueOut, bool is_keyed)
+{
+  JS::RootedValue snapshots(cx);
+  nsresult rv = is_keyed ? mTelemetry->SnapshotKeyedHistograms(nsITelemetry::DATASET_RELEASE_CHANNEL_OPTIN, false, false, cx, &snapshots)
+                         : mTelemetry->SnapshotHistograms(nsITelemetry::DATASET_RELEASE_CHANNEL_OPTIN, false, false, cx, &snapshots);
+
+  JS::RootedValue snapshot(cx);
+  GetProperty(cx, "parent", snapshots, &snapshot);
+
+  ASSERT_EQ(rv, NS_OK) << "Cannot call histogram snapshots";
+  valueOut.set(snapshot);
+}
+
+} // namespace TelemetryTestHelpers

toolkit/components/telemetry/tests/gtest/TelemetryTestHelpers.h

@@ -0,0 +1,55 @@
+/* Any copyright is dedicated to the Public Domain.
+ * http://creativecommons.org/publicdomain/zero/1.0/
+ */
+
+#ifndef TelemetryTestHelpers_h_
+#define TelemetryTestHelpers_h_
+
+#include "js/TypeDecls.h"
+#include "nsITelemetry.h"
+
+namespace TelemetryTestHelpers {
+
+void
+CheckUintScalar(const char* aName, JSContext* aCx, JS::HandleValue aSnapshot, uint32_t expectedValue);
+
+void
+CheckBoolScalar(const char* aName, JSContext* aCx, JS::HandleValue aSnapshot, bool expectedValue);
+
+void
+CheckStringScalar(const char* aName, JSContext* aCx, JS::HandleValue aSnapshot, const char* expectedValue);
+
+void
+CheckKeyedUintScalar(const char* aName, const char* aKey, JSContext* aCx, JS::HandleValue aSnapshot,
+                     uint32_t expectedValue);
+
+void
+CheckKeyedBoolScalar(const char* aName, const char* aKey, JSContext* aCx, JS::HandleValue aSnapshot,
+                     bool expectedValue);
+
+void
+CheckNumberOfProperties(const char* aName, JSContext* aCx, JS::HandleValue aSnapshot,
+                        uint32_t expectedNumProperties);
+
+void
+GetScalarsSnapshot(bool aKeyed, JSContext* aCx, JS::MutableHandle<JS::Value> aResult);
+
+void
+GetAndClearHistogram(JSContext* cx, nsCOMPtr<nsITelemetry> mTelemetry,
+                     const nsACString &name, bool is_keyed);
+
+void
+GetProperty(JSContext* cx, const char* name, JS::HandleValue valueIn,
+            JS::MutableHandleValue valueOut);
+
+void
+GetElement(JSContext* cx, uint32_t index, JS::HandleValue valueIn,
+           JS::MutableHandleValue valueOut);
+
+void
+GetSnapshots(JSContext* cx, nsCOMPtr<nsITelemetry> mTelemetry,
+             const char* name, JS::MutableHandleValue valueOut, bool is_keyed);
+
+} // namespace TelemetryTestHelpers
+
+#endif

toolkit/components/telemetry/tests/gtest/TestHistograms.cpp

@@ -8,66 +8,10 @@
 #include "nsITelemetry.h"
 #include "Telemetry.h"
 #include "TelemetryFixture.h"
+#include "TelemetryTestHelpers.h"
 
 using namespace mozilla;
-
-namespace {
-
-void
-GetAndClearHistogram(JSContext* cx, nsCOMPtr<nsITelemetry> mTelemetry,
-                     const nsACString &name, bool is_keyed)
-{
-  JS::RootedValue testHistogram(cx);
-  nsresult rv = is_keyed ? mTelemetry->GetKeyedHistogramById(name, cx, &testHistogram)
-                         : mTelemetry->GetHistogramById(name, cx, &testHistogram);
-
-  ASSERT_EQ(rv, NS_OK) << "Cannot fetch histogram";
-
-  // Clear the stored value
-  JS::RootedObject testHistogramObj(cx, &testHistogram.toObject());
-  JS::RootedValue rval(cx);
-  ASSERT_TRUE(JS_CallFunctionName(cx, testHistogramObj, "clear",
-                  JS::HandleValueArray::empty(), &rval)) << "Cannot clear histogram";
-}
-
-void
-GetProperty(JSContext* cx, const char* name, JS::HandleValue valueIn,
-            JS::MutableHandleValue valueOut)
-{
-  JS::RootedValue property(cx);
-  JS::RootedObject valueInObj(cx, &valueIn.toObject());
-  ASSERT_TRUE(JS_GetProperty(cx, valueInObj, name, &property))
-    << "Cannot get property '" << name << "'";
-  valueOut.set(property);
-}
-
-void
-GetElement(JSContext* cx, uint32_t index, JS::HandleValue valueIn,
-           JS::MutableHandleValue valueOut)
-{
-  JS::RootedValue element(cx);
-  JS::RootedObject valueInObj(cx, &valueIn.toObject());
-  ASSERT_TRUE(JS_GetElement(cx, valueInObj, index, &element))
-    << "Cannot get element at index '" << index << "'";
-  valueOut.set(element);
-}
-
-void
-GetSnapshots(JSContext* cx, nsCOMPtr<nsITelemetry> mTelemetry,
-             const char* name, JS::MutableHandleValue valueOut, bool is_keyed)
-{
-  JS::RootedValue snapshots(cx);
-  nsresult rv = is_keyed ? mTelemetry->SnapshotKeyedHistograms(nsITelemetry::DATASET_RELEASE_CHANNEL_OPTIN, false, false, cx, &snapshots)
-                         : mTelemetry->SnapshotHistograms(nsITelemetry::DATASET_RELEASE_CHANNEL_OPTIN, false, false, cx, &snapshots);
-
-  JS::RootedValue snapshot(cx);
-  GetProperty(cx, "parent", snapshots, &snapshot);
-
-  ASSERT_EQ(rv, NS_OK) << "Cannot call histogram snapshots";
-  valueOut.set(snapshot);
-}
-
-}
+using namespace TelemetryTestHelpers;
 
 TEST_F(TelemetryTestFixture, AccumulateCountHistogram)
 {
@@ -181,6 +125,16 @@ TEST_F(TelemetryTestFixture, TestKeyedKeysHistogram)
   GetProperty(cx.GetJSContext(), "not-allowed", histogram,  &expectedKeyData);
   ASSERT_TRUE(expectedKeyData.isUndefined())
     << "Unallowed keys must not be recorded in the histogram data";
+
+  // The 'not-allowed' key accumulation for 'TELEMETRY_TESTED_KEYED_KEYS' was
+  // attemtped twice, so we expect the count of
+  // 'telemetry.accumulate_unknown_histogram_keys' to be 2
+  const uint32_t expectedAccumulateUnknownCount = 2;
+  JS::RootedValue scalarsSnapshot(cx.GetJSContext());
+  GetScalarsSnapshot(true, cx.GetJSContext(),&scalarsSnapshot);
+  CheckKeyedUintScalar("telemetry.accumulate_unknown_histogram_keys",
+                       "TELEMETRY_TEST_KEYED_KEYS", cx.GetJSContext(),
+                       scalarsSnapshot, expectedAccumulateUnknownCount);
 }
 
 TEST_F(TelemetryTestFixture, AccumulateCategoricalHistogram)

toolkit/components/telemetry/tests/gtest/TestScalars.cpp

@@ -12,128 +12,13 @@
 #include "nsThreadUtils.h"
 #include "Telemetry.h"
 #include "TelemetryFixture.h"
+#include "TelemetryTestHelpers.h"
 
 using namespace mozilla;
+using namespace TelemetryTestHelpers;
 
 #define EXPECTED_STRING "Nice, expected and creative string."
 
-namespace {
-
-void
-CheckUintScalar(const char* aName, JSContext* aCx, JS::HandleValue aSnapshot, uint32_t expectedValue)
-{
-  // Validate the value of the test scalar.
-  JS::RootedValue value(aCx);
-  JS::RootedObject scalarObj(aCx, &aSnapshot.toObject());
-  ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &value)) << "The test scalar must be reported.";
-  ASSERT_TRUE(value.isInt32()) << "The scalar value must be of the correct type.";
-  ASSERT_TRUE(value.toInt32() >= 0) << "The uint scalar type must contain a value >= 0.";
-  ASSERT_EQ(static_cast<uint32_t>(value.toInt32()), expectedValue) << "The scalar value must match the expected value.";
-}
-
-void
-CheckBoolScalar(const char* aName, JSContext* aCx, JS::HandleValue aSnapshot, bool expectedValue)
-{
-  // Validate the value of the test scalar.
-  JS::RootedValue value(aCx);
-  JS::RootedObject scalarObj(aCx, &aSnapshot.toObject());
-  ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &value)) << "The test scalar must be reported.";
-  ASSERT_TRUE(value.isBoolean()) << "The scalar value must be of the correct type.";
-  ASSERT_EQ(static_cast<bool>(value.toBoolean()), expectedValue) << "The scalar value must match the expected value.";
-}
-
-void
-CheckStringScalar(const char* aName, JSContext* aCx, JS::HandleValue aSnapshot, const char* expectedValue)
-{
-  // Validate the value of the test scalar.
-  JS::RootedValue value(aCx);
-  JS::RootedObject scalarObj(aCx, &aSnapshot.toObject());
-  ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &value)) << "The test scalar must be reported.";
-  ASSERT_TRUE(value.isString()) << "The scalar value must be of the correct type.";
-
-  bool sameString;
-  ASSERT_TRUE(JS_StringEqualsAscii(aCx, value.toString(), expectedValue, &sameString)) << "JS String comparison failed";
-  ASSERT_TRUE(sameString) << "The scalar value must match the expected string";
-}
-
-void
-CheckKeyedUintScalar(const char* aName, const char* aKey, JSContext* aCx, JS::HandleValue aSnapshot,
-                     uint32_t expectedValue)
-{
-  JS::RootedValue keyedScalar(aCx);
-  JS::RootedObject scalarObj(aCx, &aSnapshot.toObject());
-  // Get the aName keyed scalar object from the scalars snapshot.
-  ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &keyedScalar))
-    << "The keyed scalar must be reported.";
-
-  CheckUintScalar(aKey, aCx, keyedScalar, expectedValue);
-}
-
-void
-CheckKeyedBoolScalar(const char* aName, const char* aKey, JSContext* aCx, JS::HandleValue aSnapshot,
-                     bool expectedValue)
-{
-  JS::RootedValue keyedScalar(aCx);
-  JS::RootedObject scalarObj(aCx, &aSnapshot.toObject());
-  // Get the aName keyed scalar object from the scalars snapshot.
-  ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &keyedScalar))
-    << "The keyed scalar must be reported.";
-
-  CheckBoolScalar(aKey, aCx, keyedScalar, expectedValue);
-}
-
-void
-CheckNumberOfProperties(const char* aName, JSContext* aCx, JS::HandleValue aSnapshot,
-                        uint32_t expectedNumProperties)
-{
-  JS::RootedValue keyedScalar(aCx);
-  JS::RootedObject scalarObj(aCx, &aSnapshot.toObject());
-  // Get the aName keyed scalar object from the scalars snapshot.
-  ASSERT_TRUE(JS_GetProperty(aCx, scalarObj, aName, &keyedScalar))
-    << "The keyed scalar must be reported.";
-
-  JS::RootedObject keyedScalarObj(aCx, &keyedScalar.toObject());
-  JS::Rooted<JS::IdVector> ids(aCx, JS::IdVector(aCx));
-  ASSERT_TRUE(JS_Enumerate(aCx, keyedScalarObj, &ids))
-    << "We must be able to get keyed scalar members.";
-
-  ASSERT_EQ(expectedNumProperties, ids.length())
-    << "The scalar must report the expected number of properties.";
-}
-
-void
-GetScalarsSnapshot(bool aKeyed, JSContext* aCx, JS::MutableHandle<JS::Value> aResult)
-{
-  nsCOMPtr<nsITelemetry> telemetry = do_GetService("@mozilla.org/base/telemetry;1");
-
-  // Get a snapshot of the scalars.
-  JS::RootedValue scalarsSnapshot(aCx);
-  nsresult rv;
-
-  if (aKeyed) {
-    rv = telemetry->SnapshotKeyedScalars(nsITelemetry::DATASET_RELEASE_CHANNEL_OPTIN,
-                                         false, aCx, 0, &scalarsSnapshot);
-  } else {
-    rv = telemetry->SnapshotScalars(nsITelemetry::DATASET_RELEASE_CHANNEL_OPTIN,
-                                    false, aCx, 0, &scalarsSnapshot);
-  }
-
-  // Validate the snapshot.
-  ASSERT_EQ(rv, NS_OK) << "Creating a snapshot of the data must not fail.";
-  ASSERT_TRUE(scalarsSnapshot.isObject()) << "The snapshot must be an object.";
-
-  // We currently only support scalars from the parent process in the gtests.
-  JS::RootedValue parentScalars(aCx);
-  JS::RootedObject scalarObj(aCx, &scalarsSnapshot.toObject());
-  // Don't complain if no scalars for the parent process can be found. Just
-  // return an empty object.
-  Unused << JS_GetProperty(aCx, scalarObj, "parent", &parentScalars);
-
-  aResult.set(parentScalars);
-}
-
-} // Anonymous namespace.
-
 // Test that we can properly write unsigned scalars using the C++ API.
 TEST_F(TelemetryTestFixture, ScalarUnsigned) {
   AutoJSContextWithGlobal cx(mCleanGlobal);

toolkit/components/telemetry/tests/gtest/moz.build

@@ -11,6 +11,7 @@ LOCAL_INCLUDES += [
 ]
 
 UNIFIED_SOURCES = [
+    'TelemetryTestHelpers.cpp',
     'TestHistograms.cpp',
     'TestScalars.cpp'
 ]