Use low entropy for studies that send experiment IDs to Google properties.

components/variations/variations_seed_simulator_unittest.cc

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "components/variations/variations_seed_simulator.h"
 
 #include <stdint.h>
 
 #include <map>
 
 #include "base/macros.h"
 #include "base/strings/stringprintf.h"
+#include "base/test/mock_entropy_provider.h"
 #include "components/variations/processed_study.h"
 #include "components/variations/proto/study.pb.h"
 #include "components/variations/variations_associated_data.h"
 #include "testing/gtest/include/gtest/gtest.h"
 
 namespace variations {
 
 namespace {
-
-// An implementation of EntropyProvider that always returns a specific entropy
-// value, regardless of field trial.
-class TestEntropyProvider : public base::FieldTrial::EntropyProvider {
- public:
-  explicit TestEntropyProvider(double entropy_value)
-      : entropy_value_(entropy_value) {}
-  ~TestEntropyProvider() override {}
-
-  // base::FieldTrial::EntropyProvider implementation:
-  double GetEntropyForTrial(const std::string& trial_name,
-                            uint32_t randomization_seed) const override {
-    return entropy_value_;
-  }
-
- private:
-  const double entropy_value_;
-
-  DISALLOW_COPY_AND_ASSIGN(TestEntropyProvider);
-};
-
 // Creates and activates a single-group field trial with name |trial_name| and
-// group |group_name| and variations |params| (if not NULL).
+// group |group_name| and variations |params| (if not null).
 void CreateTrial(const std::string& trial_name,
                  const std::string& group_name,
                  const std::map<std::string, std::string>* params) {
   base::FieldTrialList::CreateFieldTrial(trial_name, group_name);
-  if (params != NULL)
+  if (params != nullptr)
     AssociateVariationParams(trial_name, group_name, *params);
   base::FieldTrialList::FindFullName(trial_name);
 }
 
 // Creates a study with the given |study_name| and |consistency|.
 Study CreateStudy(const std::string& study_name,
                   Study_Consistency consistency) {
   Study study;
   study.set_name(study_name);
   study.set_consistency(consistency);
@@ skipping 19 matching lines @@
   Study_Experiment_Param* param = experiment->add_param();
   param->set_name(param_name);
   param->set_value(param_value);
   return param;
 }
 
 }  // namespace
 
 class VariationsSeedSimulatorTest : public ::testing::Test {
  public:
-  VariationsSeedSimulatorTest() : field_trial_list_(NULL) {
+  VariationsSeedSimulatorTest() : field_trial_list_(nullptr) {
   }
 
   ~VariationsSeedSimulatorTest() override {
     // Ensure that the maps are cleared between tests, since they are stored as
     // process singletons.
     testing::ClearAllVariationIDs();
     testing::ClearAllVariationParams();
   }
 
   // Uses a VariationsSeedSimulator to simulate the differences between
   // |studies| and the current field trial state.
   VariationsSeedSimulator::Result SimulateDifferences(
       const std::vector<ProcessedStudy>& studies) {
-    TestEntropyProvider provider(0.5);
-    VariationsSeedSimulator seed_simulator(provider);
+    // Should pick the first group that has non-zero probability weight.
+    base::MockEntropyProvider default_provider;
+    default_provider.set_entropy_value(0);
+    // Should pick default groups, if they have non-zero probability weight.
+    base::MockEntropyProvider low_provider;
+    low_provider.set_entropy_value(1.0 - 1e-8);
+    VariationsSeedSimulator seed_simulator(default_provider, low_provider);
     return seed_simulator.ComputeDifferences(studies);
   }
 
   // Simulates the differences between |study| and the current field trial
   // state, returning a string like "1 2 3", where 1 is the number of regular
   // group changes, 2 is the number of "kill best effort" group changes and 3
   // is the number of "kill critical" group changes.
   std::string SimulateStudyDifferences(const Study* study) {
     std::vector<ProcessedStudy> studies;
     if (!ProcessedStudy::ValidateAndAppendStudy(study, false, &studies))
@@ skipping 25 matching lines @@
                               result.kill_critical_group_change_count);
   }
 
  private:
   base::FieldTrialList field_trial_list_;
 
   DISALLOW_COPY_AND_ASSIGN(VariationsSeedSimulatorTest);
 };
 
 TEST_F(VariationsSeedSimulatorTest, PermanentNoChanges) {
-  CreateTrial("A", "B", NULL);
+  CreateTrial("A", "B", nullptr);
 
   std::vector<ProcessedStudy> processed_studies;
   Study study = CreateStudy("A", Study_Consistency_PERMANENT);
   Study_Experiment* experiment = AddExperiment("B", 100, &study);
 
   EXPECT_EQ("0 0 0", SimulateStudyDifferences(&study));
 
   experiment->set_type(Study_Experiment_Type_NORMAL);
   EXPECT_EQ("0 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_IGNORE_CHANGE);
   EXPECT_EQ("0 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_KILL_BEST_EFFORT);
   EXPECT_EQ("0 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_KILL_CRITICAL);
   EXPECT_EQ("0 0 0", SimulateStudyDifferences(&study));
 }
 
 TEST_F(VariationsSeedSimulatorTest, PermanentGroupChange) {
-  CreateTrial("A", "B", NULL);
+  CreateTrial("A", "B", nullptr);
 
   Study study = CreateStudy("A", Study_Consistency_PERMANENT);
   Study_Experiment* experiment = AddExperiment("C", 100, &study);
 
   EXPECT_EQ("1 0 0", SimulateStudyDifferences(&study));
 
   // Changing "C" group type should not affect the type of change. (Since the
   // type is evaluated for the "old" group.)
   experiment->set_type(Study_Experiment_Type_NORMAL);
   EXPECT_EQ("1 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_IGNORE_CHANGE);
   EXPECT_EQ("1 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_KILL_BEST_EFFORT);
   EXPECT_EQ("1 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_KILL_CRITICAL);
   EXPECT_EQ("1 0 0", SimulateStudyDifferences(&study));
 }
 
+TEST_F(VariationsSeedSimulatorTest, PermanentGroupChangeDueToExperimentID) {
+  CreateTrial("A", "B", nullptr);
+  CreateTrial("X", "Y", nullptr);
+
+  Study study = CreateStudy("A", Study_Consistency_PERMANENT);
+  Study_Experiment* experiment_b = AddExperiment("B", 50, &study);
+  AddExperiment("Default", 50, &study);
+
+  EXPECT_EQ("0 0 0", SimulateStudyDifferences(&study));
+
+  // Adding a google_web_experiment_id will cause the low entropy provider to be
+  // used, causing a group change.
+  experiment_b->set_google_web_experiment_id(1234);
+  EXPECT_EQ("1 0 0", SimulateStudyDifferences(&study));
+}
+
 TEST_F(VariationsSeedSimulatorTest, PermanentExpired) {
-  CreateTrial("A", "B", NULL);
+  CreateTrial("A", "B", nullptr);
 
   Study study = CreateStudy("A", Study_Consistency_PERMANENT);
   Study_Experiment* experiment = AddExperiment("B", 1, &study);
   AddExperiment("C", 0, &study);
 
   // There should be a difference because the study is expired, which should
   // result in the default group "C" being chosen.
   EXPECT_EQ("1 0 0", SimulateStudyDifferencesExpired(&study));
 
   experiment->set_type(Study_Experiment_Type_NORMAL);
   EXPECT_EQ("1 0 0", SimulateStudyDifferencesExpired(&study));
   experiment->set_type(Study_Experiment_Type_IGNORE_CHANGE);
   EXPECT_EQ("0 0 0", SimulateStudyDifferencesExpired(&study));
   experiment->set_type(Study_Experiment_Type_KILL_BEST_EFFORT);
   EXPECT_EQ("0 1 0", SimulateStudyDifferencesExpired(&study));
   experiment->set_type(Study_Experiment_Type_KILL_CRITICAL);
   EXPECT_EQ("0 0 1", SimulateStudyDifferencesExpired(&study));
 }
 
 TEST_F(VariationsSeedSimulatorTest, SessionRandomized) {
-  CreateTrial("A", "B", NULL);
+  CreateTrial("A", "B", nullptr);
 
   Study study = CreateStudy("A", Study_Consistency_SESSION);
   Study_Experiment* experiment = AddExperiment("B", 1, &study);
   AddExperiment("C", 1, &study);
   AddExperiment("D", 1, &study);
 
   // There should be no differences, since a session randomized study can result
   // in any of the groups being chosen on startup.
   EXPECT_EQ("0 0 0", SimulateStudyDifferences(&study));
 
   experiment->set_type(Study_Experiment_Type_NORMAL);
   EXPECT_EQ("0 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_IGNORE_CHANGE);
   EXPECT_EQ("0 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_KILL_BEST_EFFORT);
   EXPECT_EQ("0 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_KILL_CRITICAL);
   EXPECT_EQ("0 0 0", SimulateStudyDifferences(&study));
 }
 
 TEST_F(VariationsSeedSimulatorTest, SessionRandomizedGroupRemoved) {
-  CreateTrial("A", "B", NULL);
+  CreateTrial("A", "B", nullptr);
 
   Study study = CreateStudy("A", Study_Consistency_SESSION);
   AddExperiment("C", 1, &study);
   AddExperiment("D", 1, &study);
 
   // There should be a difference since there is no group "B" in the new config.
   EXPECT_EQ("1 0 0", SimulateStudyDifferences(&study));
 }
 
 TEST_F(VariationsSeedSimulatorTest, SessionRandomizedGroupProbabilityZero) {
-  CreateTrial("A", "B", NULL);
+  CreateTrial("A", "B", nullptr);
 
   Study study = CreateStudy("A", Study_Consistency_SESSION);
   Study_Experiment* experiment = AddExperiment("B", 0, &study);
   AddExperiment("C", 1, &study);
   AddExperiment("D", 1, &study);
 
   // There should be a difference since group "B" has probability 0.
   EXPECT_EQ("1 0 0", SimulateStudyDifferences(&study));
 
   experiment->set_type(Study_Experiment_Type_NORMAL);
   EXPECT_EQ("1 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_IGNORE_CHANGE);
   EXPECT_EQ("0 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_KILL_BEST_EFFORT);
   EXPECT_EQ("0 1 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_KILL_CRITICAL);
   EXPECT_EQ("0 0 1", SimulateStudyDifferences(&study));
 }
 
 TEST_F(VariationsSeedSimulatorTest, SessionRandomizedExpired) {
-  CreateTrial("A", "B", NULL);
+  CreateTrial("A", "B", nullptr);
 
   Study study = CreateStudy("A", Study_Consistency_SESSION);
   Study_Experiment* experiment = AddExperiment("B", 1, &study);
   AddExperiment("C", 1, &study);
   AddExperiment("D", 1, &study);
 
   // There should be a difference because the study is expired, which should
   // result in the default group "D" being chosen.
   EXPECT_EQ("1 0 0", SimulateStudyDifferencesExpired(&study));
 
@@ skipping 78 matching lines @@
   EXPECT_EQ("1 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_IGNORE_CHANGE);
   EXPECT_EQ("0 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_KILL_BEST_EFFORT);
   EXPECT_EQ("0 1 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_KILL_CRITICAL);
   EXPECT_EQ("0 0 1", SimulateStudyDifferences(&study));
 }
 
 TEST_F(VariationsSeedSimulatorTest, ParamsAdded) {
-  CreateTrial("A", "B", NULL);
+  CreateTrial("A", "B", nullptr);
 
   std::vector<ProcessedStudy> processed_studies;
   Study study = CreateStudy("A", Study_Consistency_PERMANENT);
   Study_Experiment* experiment = AddExperiment("B", 100, &study);
   AddExperimentParam("p2", "y", experiment);
   AddExperimentParam("p1", "x", experiment);
   AddExperimentParam("p3", "z", experiment);
 
   // The current group has no params, but the config has added some.
   EXPECT_EQ("1 0 0", SimulateStudyDifferences(&study));
 
   experiment->set_type(Study_Experiment_Type_NORMAL);
   EXPECT_EQ("1 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_IGNORE_CHANGE);
   EXPECT_EQ("0 0 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_KILL_BEST_EFFORT);
   EXPECT_EQ("0 1 0", SimulateStudyDifferences(&study));
   experiment->set_type(Study_Experiment_Type_KILL_CRITICAL);
   EXPECT_EQ("0 0 1", SimulateStudyDifferences(&study));
 }
 
 }  // namespace variations