Add UMA demographic Earl Grey tests.

These tests correspond to those in
metrics_service_user_demographics_browsertest.cc.


(Note that there will be a follow-up CL to remove duplicate code.)

Bug: 1065870
Change-Id: I13df596c3ca62b90ba138a973db8f344011d02f8
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2132534
Commit-Queue: Caitlin Fischer <caitlinfischer@google.com>
Reviewed-by: Alexei Svitkine <asvitkine@chromium.org>
Reviewed-by: Roger McFarlane <rogerm@chromium.org>
Reviewed-by: Eugene But <eugenebut@chromium.org>
Cr-Commit-Position: refs/heads/master@{#757852}

ios/chrome/browser/metrics/BUILD.gn

@@ -245,6 +245,7 @@ source_set("eg_tests") {
     "//components/metrics:demographic_metrics_provider",
     "//components/metrics_services_manager",
     "//components/strings",
+    "//components/sync/base",
     "//components/ukm",
     "//components/ukm:test_support",
     "//components/unified_consent:unified_consent",

ios/chrome/browser/metrics/metrics_app_interface.h

@@ -56,21 +56,48 @@ const NSTimeInterval kSyncUKMOperationsTimeout = 10.0;
 + (void)setNetworkTimeForTesting;
 
 // TODO(crbug.com/1066297): Refactor to remove duplicate code.
-// If new data are available, creates a UKM Report and stores it in the
+// Gets the user's noised birth year, where |rawBirthYear| is the true birth
+// year, pre-noise.
++ (int)noisedBirthYear:(int)rawBirthYear;
+
+// TODO(crbug.com/1066297): Refactor to remove duplicate code.
+// If data are available, creates a UKM Report and stores it in the
 // UKM service's UnsentLogStore.
 + (void)buildAndStoreUKMLog;
 
 // TODO(crbug.com/1066297): Refactor to remove duplicate code.
 // Returns YES if the UKM service has logs to send.
-+ (BOOL)hasUnsentLogs;
++ (BOOL)hasUnsentUKMLogs;
 
+// TODO(crbug.com/1066297): Refactor to remove duplicate code.
 // Returns YES if the UKM service's report has the expected year and gender.
-// Gender corresponds to the options in UserDemographicsProto::Gender.
+// The year is the un-noised birth year, and the gender corresponds to the
+// options in UserDemographicsProto::Gender.
 + (BOOL)UKMReportHasBirthYear:(int)year gender:(int)gender;
 
+// TODO(crbug.com/1066297): Refactor to remove duplicate code.
 // Returns YES if the UKM service's report has user demographics.
 + (BOOL)UKMReportHasUserDemographics;
 
+// TODO(crbug.com/1066297): Refactor to remove duplicate code.
+// If data are available, creates an UMA log and stores it in the
+// MetricsLogStore.
++ (void)buildAndStoreUMALog;
+
+// TODO(crbug.com/1066297): Refactor to remove duplicate code.
+// Returns YES if the metrics service has logs to send.
++ (BOOL)hasUnsentUMALogs;
+
+// TODO(crbug.com/1066297): Refactor to remove duplicate code.
+// Returns YES if the UMA log has the expected year and gender. The year is the
+// un-noised birth year, and the gender corresponds to the proto enum
+// UserDemographicsProto::Gender.
++ (BOOL)UMALogHasBirthYear:(int)year gender:(int)gender;
+
+// TODO(crbug.com/1066297): Refactor to remove duplicate code.
+// Returns YES if the UMA log has user demographics.
++ (BOOL)UMALogHasUserDemographics;
+
 // Creates a chrome_test_util::HistogramTester that will record every histogram
 // sent during test.
 + (NSError*)setupHistogramTester WARN_UNUSED_RESULT;

ios/chrome/browser/metrics/metrics_app_interface.mm

@@ -4,7 +4,7 @@
 
 #include "ios/chrome/browser/metrics/metrics_app_interface.h"
 
-#include <memory>
+#include <string>
 
 #include "base/feature_list.h"
 #include "base/run_loop.h"
@@ -14,6 +14,7 @@
 #include "base/time/default_clock.h"
 #include "base/time/default_tick_clock.h"
 #include "base/time/time.h"
+#include "components/metrics/metrics_service.h"
 #include "components/metrics/unsent_log_store.h"
 #include "components/metrics_services_manager/metrics_services_manager.h"
 #include "components/network_time/network_time_tracker.h"
@@ -26,8 +27,8 @@
 #import "ios/chrome/test/app/histogram_test_util.h"
 #import "ios/testing/nserror_util.h"
 #include "services/metrics/public/cpp/ukm_source_id.h"
+#include "third_party/metrics_proto/chrome_user_metrics_extension.pb.h"
 #include "third_party/metrics_proto/ukm/report.pb.h"
-#include "third_party/metrics_proto/user_demographics.pb.h"
 #include "third_party/zlib/google/compression_utils.h"
 
 #if !defined(__has_feature) || !__has_feature(objc_arc)
@@ -39,6 +40,29 @@ namespace {
 bool g_metrics_enabled = false;
 
 chrome_test_util::HistogramTester* g_histogram_tester = nullptr;
+
+// TODO(crbug.com/1066297): Refactor to remove duplicate code.
+// Returns an UMA log if the metrics service has a staged log.
+std::unique_ptr<metrics::ChromeUserMetricsExtension> GetLastUmaLog() {
+  metrics::MetricsLogStore* const log_store =
+      GetApplicationContext()->GetMetricsService()->LogStoreForTest();
+
+  // Decompress the staged log.
+  std::string uncompressed_log;
+  if (!compression::GzipUncompress(log_store->staged_log(),
+                                   &uncompressed_log)) {
+    return nullptr;
+  }
+
+  // Deserialize and return the log.
+  std::unique_ptr<metrics::ChromeUserMetricsExtension> uma_log =
+      std::make_unique<metrics::ChromeUserMetricsExtension>();
+  if (!uma_log->ParseFromString(uncompressed_log)) {
+    return nullptr;
+  }
+  return uma_log;
+}
+
 }  // namespace
 
 namespace metrics {
@@ -91,13 +115,13 @@ class UkmEGTestHelper {
     service->Flush();
   }
 
-  static bool HasUnsentLogs() {
+  static bool HasUnsentUkmLogs() {
     ukm::UkmService* service = ukm_service();
     return service->reporting_service_.ukm_log_store()->has_unsent_logs();
   }
 
   static std::unique_ptr<ukm::Report> GetUKMReport() {
-    if (!HasUnsentLogs()) {
+    if (!HasUnsentUkmLogs()) {
       return nullptr;
     }
 
@@ -195,25 +219,28 @@ class UkmEGTestHelper {
       clock.Now() - latency / 2, resolution, latency, tickClock.NowTicks());
 }
 
++ (int)noisedBirthYear:(int)rawBirthYear {
+  int birthYearOffset =
+      GetApplicationContext()
+          ->GetChromeBrowserStateManager()
+          ->GetLastUsedBrowserState()
+          ->GetPrefs()
+          ->GetInteger(syncer::prefs::kSyncDemographicsBirthYearOffset);
+  return rawBirthYear + birthYearOffset;
+}
+
 + (void)buildAndStoreUKMLog {
   metrics::UkmEGTestHelper::BuildAndStoreUkmLog();
 }
 
-+ (BOOL)hasUnsentLogs {
-  return metrics::UkmEGTestHelper::HasUnsentLogs();
++ (BOOL)hasUnsentUKMLogs {
+  return metrics::UkmEGTestHelper::HasUnsentUkmLogs();
 }
 
 + (BOOL)UKMReportHasBirthYear:(int)year gender:(int)gender {
   std::unique_ptr<ukm::Report> report =
       metrics::UkmEGTestHelper::GetUKMReport();
-
-  int birthYearOffset =
-      GetApplicationContext()
-          ->GetChromeBrowserStateManager()
-          ->GetLastUsedBrowserState()
-          ->GetPrefs()
-          ->GetInteger(syncer::prefs::kSyncDemographicsBirthYearOffset);
-  int noisedBirthYear = year + birthYearOffset;
+  int noisedBirthYear = [self noisedBirthYear:year];
 
   return report && gender == report->user_demographics().gender() &&
          noisedBirthYear == report->user_demographics().birth_year();
@@ -225,6 +252,36 @@ class UkmEGTestHelper {
   return report && report->has_user_demographics();
 }
 
++ (void)buildAndStoreUMALog {
+  GetApplicationContext()->GetMetricsService()->StageCurrentLogForTest();
+}
+
++ (BOOL)hasUnsentUMALogs {
+  return GetApplicationContext()
+      ->GetMetricsService()
+      ->LogStoreForTest()
+      ->has_unsent_logs();
+}
+
++ (BOOL)UMALogHasBirthYear:(int)year gender:(int)gender {
+  if (![self UMALogHasUserDemographics]) {
+    return NO;
+  }
+  std::unique_ptr<metrics::ChromeUserMetricsExtension> log = GetLastUmaLog();
+  int noisedBirthYear = [self noisedBirthYear:year];
+
+  return noisedBirthYear == log->user_demographics().birth_year() &&
+         gender == log->user_demographics().gender();
+}
+
++ (BOOL)UMALogHasUserDemographics {
+  if (![self hasUnsentUMALogs]) {
+    return NO;
+  }
+  std::unique_ptr<metrics::ChromeUserMetricsExtension> log = GetLastUmaLog();
+  return log && log->has_user_demographics();
+}
+
 + (NSError*)setupHistogramTester {
   if (g_histogram_tester) {
     return testing::NSErrorWithLocalizedDescription(

ios/chrome/test/earl_grey/chrome_earl_grey.h

@@ -155,10 +155,10 @@ id ExecuteJavaScript(NSString* javascript, NSError* __autoreleasing* out_error);
 // Stops the sync server. The server should be running when calling this.
 - (void)stopSync;
 
-// Injects user demographics into the fake sync server. The year is the
-// un-noised birth year, and the gender corresponds to the options in
+// Injects user demographics into the fake sync server. |rawBirthYear| is the
+// true birth year, pre-noise, and the gender corresponds to the proto enum
 // UserDemographicsProto::Gender.
-- (void)addUserDemographicsToSyncServerWithBirthYear:(int)birthYear
+- (void)addUserDemographicsToSyncServerWithBirthYear:(int)rawBirthYear
                                               gender:(int)gender;
 
 // Clears the autofill profile for the given |GUID|.

ios/chrome/test/earl_grey/chrome_earl_grey.mm

@@ -621,10 +621,10 @@ GREY_STUB_CLASS_IN_APP_MAIN_QUEUE(ChromeEarlGreyAppInterface)
   [ChromeEarlGreyAppInterface stopSync];
 }
 
-- (void)addUserDemographicsToSyncServerWithBirthYear:(int)birthYear
+- (void)addUserDemographicsToSyncServerWithBirthYear:(int)rawBirthYear
                                               gender:(int)gender {
   [ChromeEarlGreyAppInterface
-      addUserDemographicsToSyncServerWithBirthYear:birthYear
+      addUserDemographicsToSyncServerWithBirthYear:rawBirthYear
                                             gender:gender];
 }
 

ios/chrome/test/earl_grey/chrome_earl_grey_app_interface.h

@@ -305,10 +305,10 @@
 // Triggers a sync cycle for a |type|.
 + (void)triggerSyncCycleForType:(syncer::ModelType)type;
 
-// Injects user demographics into the fake sync server. The year is the
-// un-noised birth year, and the gender corresponds to the options in
-// UserDemographicsProto::Gender..
-+ (void)addUserDemographicsToSyncServerWithBirthYear:(int)birthYear
+// Injects user demographics into the fake sync server. |rawBirthYear| is the
+// true birth year, pre-noise, and the gender corresponds to the proto enum
+// UserDemographicsProto::Gender.
++ (void)addUserDemographicsToSyncServerWithBirthYear:(int)rawBirthYear
                                               gender:(int)gender;
 
 // Clears the autofill profile for the given |GUID|.

ios/chrome/test/earl_grey/chrome_earl_grey_app_interface.mm

@@ -500,9 +500,9 @@ NSString* SerializedPref(const PrefService::Preference* pref) {
   chrome_test_util::TriggerSyncCycle(type);
 }
 
-+ (void)addUserDemographicsToSyncServerWithBirthYear:(int)birthYear
++ (void)addUserDemographicsToSyncServerWithBirthYear:(int)rawBirthYear
                                               gender:(int)gender {
-  chrome_test_util::AddUserDemographicsToSyncServer(birthYear, gender);
+  chrome_test_util::AddUserDemographicsToSyncServer(rawBirthYear, gender);
 }
 
 + (void)clearAutofillProfileWithGUID:(NSString*)GUID {