| // Copyright 2014 The Chromium Authors |
| // 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/strings/stringprintf.h" |
| #include "components/variations/client_filterable_state.h" |
| #include "components/variations/processed_study.h" |
| #include "components/variations/proto/study.pb.h" |
| #include "components/variations/proto/variations_seed.pb.h" |
| #include "components/variations/variations_associated_data.h" |
| #include "components/variations/variations_test_utils.h" |
| #include "testing/gtest/include/gtest/gtest.h" |
| |
| namespace variations { |
| |
| namespace { |
| |
| // Creates and activates a single-group field trial with name |trial_name| and |
| // 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 != 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); |
| return study; |
| } |
| |
| // Adds an experiment to |study| with the specified |experiment_name| and |
| // |probability| values and sets it as the study's default experiment. |
| Study_Experiment* AddExperiment(const std::string& experiment_name, |
| int probability, |
| Study* study) { |
| Study_Experiment* experiment = study->add_experiment(); |
| experiment->set_name(experiment_name); |
| experiment->set_probability_weight(probability); |
| study->set_default_experiment_name(experiment_name); |
| return experiment; |
| } |
| |
| // Add an experiment param with |param_name| and |param_value| to |experiment|. |
| Study_Experiment_Param* AddExperimentParam(const std::string& param_name, |
| const std::string& param_value, |
| Study_Experiment* experiment) { |
| 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() {} |
| |
| VariationsSeedSimulatorTest(const VariationsSeedSimulatorTest&) = delete; |
| VariationsSeedSimulatorTest& operator=(const VariationsSeedSimulatorTest&) = |
| delete; |
| |
| ~VariationsSeedSimulatorTest() override { |
| // Ensure that the maps are cleared between tests, since they are stored as |
| // process singletons. |
| testing::ClearAllVariationIDs(); |
| testing::ClearAllVariationParams(); |
| } |
| |
| // 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) { |
| VariationsSeed seed; |
| seed.add_study()->MergeFrom(*study); |
| auto client_state = CreateDummyClientFilterableState(); |
| MockEntropyProviders entropy_providers({ |
| .low_entropy = kAlwaysUseLastGroup, |
| .high_entropy = kAlwaysUseFirstGroup, |
| }); |
| return ConvertSimulationResultToString( |
| SimulateSeedStudies(seed, *client_state, entropy_providers)); |
| } |
| |
| // Formats |result| as a string with format "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 ConvertSimulationResultToString( |
| const SeedSimulationResult& result) { |
| return base::StringPrintf("%d %d %d", |
| result.normal_group_change_count, |
| result.kill_best_effort_group_change_count, |
| result.kill_critical_group_change_count); |
| } |
| }; |
| |
| TEST_F(VariationsSeedSimulatorTest, PermanentNoChanges) { |
| 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", 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.) |
| // |
| // Note: The current (i.e. old) group is checked for the type since that group |
| // is the one that should be annotated with the type when killing it. |
| 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, SessionRandomized) { |
| 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", 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", 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, ParamsUnchanged) { |
| std::map<std::string, std::string> params; |
| params["p1"] = "x"; |
| params["p2"] = "y"; |
| params["p3"] = "z"; |
| CreateTrial("A", "B", ¶ms); |
| |
| 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); |
| |
| 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, ParamsChanged) { |
| std::map<std::string, std::string> params; |
| params["p1"] = "x"; |
| params["p2"] = "y"; |
| params["p3"] = "z"; |
| CreateTrial("A", "B", ¶ms); |
| |
| std::vector<ProcessedStudy> processed_studies; |
| Study study = CreateStudy("A", Study_Consistency_PERMANENT); |
| Study_Experiment* experiment = AddExperiment("B", 100, &study); |
| AddExperimentParam("p2", "test", experiment); |
| AddExperimentParam("p1", "x", experiment); |
| AddExperimentParam("p3", "z", experiment); |
| |
| // The param lists differ. |
| 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, ParamsRemoved) { |
| std::map<std::string, std::string> params; |
| params["p1"] = "x"; |
| params["p2"] = "y"; |
| params["p3"] = "z"; |
| CreateTrial("A", "B", ¶ms); |
| |
| std::vector<ProcessedStudy> processed_studies; |
| Study study = CreateStudy("A", Study_Consistency_PERMANENT); |
| Study_Experiment* experiment = AddExperiment("B", 100, &study); |
| |
| // The current group has params, but the new config doesn't have any. |
| 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, ParamsAdded) { |
| 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 |