1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
7 #include "base/files/file_path.h"
8 #include "base/memory/scoped_vector.h"
9 #include "base/path_service.h"
10 #include "base/prefs/pref_registry_simple.h"
11 #include "base/prefs/testing_pref_service.h"
12 #include "base/strings/string_number_conversions.h"
13 #include "base/strings/stringprintf.h"
14 #include "base/strings/utf_string_conversions.h"
15 #include "base/values.h"
16 #include "chrome/browser/about_flags.h"
17 #include "chrome/browser/pref_service_flags_storage.h"
18 #include "chrome/common/chrome_switches.h"
19 #include "chrome/common/pref_names.h"
20 #include "chrome/grit/chromium_strings.h"
21 #include "testing/gtest/include/gtest/gtest.h"
22 #include "third_party/libxml/chromium/libxml_utils.h"
26 const char kFlags1
[] = "flag1";
27 const char kFlags2
[] = "flag2";
28 const char kFlags3
[] = "flag3";
29 const char kFlags4
[] = "flag4";
30 const char kFlags5
[] = "flag5";
32 const char kSwitch1
[] = "switch";
33 const char kSwitch2
[] = "switch2";
34 const char kSwitch3
[] = "switch3";
35 const char kValueForSwitch2
[] = "value_for_switch2";
37 const char kMultiSwitch1
[] = "multi_switch1";
38 const char kMultiSwitch2
[] = "multi_switch2";
39 const char kValueForMultiSwitch2
[] = "value_for_multi_switch2";
41 const char kEnableDisableValue1
[] = "value1";
42 const char kEnableDisableValue2
[] = "value2";
44 typedef base::HistogramBase::Sample Sample
;
45 typedef std::map
<std::string
, Sample
> SwitchToIdMap
;
47 // This is a helper function to the ReadEnumFromHistogramsXml().
48 // Extracts single enum (with integer values) from histograms.xml.
49 // Expects |reader| to point at given enum.
50 // Returns map { value => label }.
51 // Returns empty map on error.
52 std::map
<Sample
, std::string
> ParseEnumFromHistogramsXml(
53 const std::string
& enum_name
,
55 int entries_index
= -1;
57 std::map
<Sample
, std::string
> result
;
61 const std::string node_name
= reader
->NodeName();
62 if (node_name
== "enum" && reader
->IsClosingElement())
65 if (node_name
== "int") {
67 std::string value_str
;
69 const bool has_value
= reader
->NodeAttribute("value", &value_str
);
70 const bool has_label
= reader
->NodeAttribute("label", &label
);
72 ADD_FAILURE() << "Bad " << enum_name
<< " enum entry (at index "
73 << entries_index
<< ", label='" << label
74 << "'): No 'value' attribute.";
78 ADD_FAILURE() << "Bad " << enum_name
<< " enum entry (at index "
79 << entries_index
<< ", value_str='" << value_str
80 << "'): No 'label' attribute.";
85 if (has_value
&& !base::StringToInt(value_str
, &value
)) {
86 ADD_FAILURE() << "Bad " << enum_name
<< " enum entry (at index "
87 << entries_index
<< ", label='" << label
88 << "', value_str='" << value_str
89 << "'): 'value' attribute is not integer.";
92 if (result
.count(value
)) {
93 ADD_FAILURE() << "Bad " << enum_name
<< " enum entry (at index "
94 << entries_index
<< ", label='" << label
95 << "', value_str='" << value_str
96 << "'): duplicate value '" << value_str
97 << "' found in enum. The previous one has label='"
98 << result
[value
] << "'.";
102 result
[value
] = label
;
105 // All enum entries are on the same level, so it is enough to iterate
109 return (success
? result
: std::map
<Sample
, std::string
>());
112 // Find and read given enum (with integer values) from histograms.xml.
113 // |enum_name| - enum name.
114 // |histograms_xml| - must be loaded histograms.xml file.
116 // Returns map { value => label } so that:
117 // <int value="9" label="enable-pinch-virtual-viewport"/>
119 // { 9 => "enable-pinch-virtual-viewport" }
120 // Returns empty map on error.
121 std::map
<Sample
, std::string
> ReadEnumFromHistogramsXml(
122 const std::string
& enum_name
,
123 XmlReader
* histograms_xml
) {
124 std::map
<Sample
, std::string
> login_custom_flags
;
126 // Implement simple depth first search.
128 const std::string node_name
= histograms_xml
->NodeName();
129 if (node_name
== "enum") {
131 if (histograms_xml
->NodeAttribute("name", &name
) && name
== enum_name
) {
132 if (!login_custom_flags
.empty()) {
133 EXPECT_TRUE(login_custom_flags
.empty())
134 << "Duplicate enum '" << enum_name
<< "' found in histograms.xml";
135 return std::map
<Sample
, std::string
>();
138 const bool got_into_enum
= histograms_xml
->Read();
141 ParseEnumFromHistogramsXml(enum_name
, histograms_xml
);
142 EXPECT_FALSE(login_custom_flags
.empty())
143 << "Bad enum '" << enum_name
144 << "' found in histograms.xml (format error).";
146 EXPECT_TRUE(got_into_enum
)
147 << "Bad enum '" << enum_name
148 << "' (looks empty) found in histograms.xml.";
150 if (login_custom_flags
.empty())
151 return std::map
<Sample
, std::string
>();
154 // Go deeper if possible (stops at the closing tag of the deepest node).
155 if (histograms_xml
->Read())
158 // Try next node on the same level (skips closing tag).
159 if (histograms_xml
->Next())
162 // Go up until next node on the same level exists.
163 while (histograms_xml
->Depth() && !histograms_xml
->SkipToElement()) {
166 // Reached top. histograms.xml consists of the single top level node
167 // 'histogram-configuration', so this is the end.
168 if (!histograms_xml
->Depth())
171 EXPECT_FALSE(login_custom_flags
.empty())
172 << "Enum '" << enum_name
<< "' is not found in histograms.xml.";
173 return login_custom_flags
;
176 std::string
FilePathStringTypeToString(const base::FilePath::StringType
& path
) {
178 return base::UTF16ToUTF8(path
);
184 std::set
<std::string
> GetAllSwitchesForTesting() {
185 std::set
<std::string
> result
;
187 size_t num_experiments
= 0;
188 const about_flags::Experiment
* experiments
=
189 about_flags::testing::GetExperiments(&num_experiments
);
191 for (size_t i
= 0; i
< num_experiments
; ++i
) {
192 const about_flags::Experiment
& experiment
= experiments
[i
];
193 if (experiment
.type
== about_flags::Experiment::SINGLE_VALUE
) {
194 result
.insert(experiment
.command_line_switch
);
195 } else if (experiment
.type
== about_flags::Experiment::MULTI_VALUE
) {
196 for (int j
= 0; j
< experiment
.num_choices
; ++j
) {
197 result
.insert(experiment
.choices
[j
].command_line_switch
);
200 DCHECK_EQ(experiment
.type
, about_flags::Experiment::ENABLE_DISABLE_VALUE
);
201 result
.insert(experiment
.command_line_switch
);
202 result
.insert(experiment
.disable_command_line_switch
);
208 } // anonymous namespace
210 namespace about_flags
{
212 const Experiment::Choice kMultiChoices
[] = {
213 { IDS_PRODUCT_NAME
, "", "" },
214 { IDS_PRODUCT_NAME
, kMultiSwitch1
, "" },
215 { IDS_PRODUCT_NAME
, kMultiSwitch2
, kValueForMultiSwitch2
},
218 // The experiments that are set for these tests. The 3rd experiment is not
219 // supported on the current platform, all others are.
220 static Experiment kExperiments
[] = {
225 0, // Ends up being mapped to the current platform.
226 Experiment::SINGLE_VALUE
,
238 0, // Ends up being mapped to the current platform.
239 Experiment::SINGLE_VALUE
,
251 0, // This ends up enabling for an OS other than the current.
252 Experiment::SINGLE_VALUE
,
264 0, // Ends up being mapped to the current platform.
265 Experiment::MULTI_VALUE
,
271 arraysize(kMultiChoices
)
277 0, // Ends up being mapped to the current platform.
278 Experiment::ENABLE_DISABLE_VALUE
,
280 kEnableDisableValue1
,
282 kEnableDisableValue2
,
288 class AboutFlagsTest
: public ::testing::Test
{
290 AboutFlagsTest() : flags_storage_(&prefs_
) {
291 prefs_
.registry()->RegisterListPref(prefs::kEnabledLabsExperiments
);
292 testing::ClearState();
295 virtual void SetUp() OVERRIDE
{
296 for (size_t i
= 0; i
< arraysize(kExperiments
); ++i
)
297 kExperiments
[i
].supported_platforms
= GetCurrentPlatform();
299 int os_other_than_current
= 1;
300 while (os_other_than_current
== GetCurrentPlatform())
301 os_other_than_current
<<= 1;
302 kExperiments
[2].supported_platforms
= os_other_than_current
;
304 testing::SetExperiments(kExperiments
, arraysize(kExperiments
));
307 virtual void TearDown() OVERRIDE
{
308 testing::SetExperiments(NULL
, 0);
311 TestingPrefServiceSimple prefs_
;
312 PrefServiceFlagsStorage flags_storage_
;
316 TEST_F(AboutFlagsTest
, NoChangeNoRestart
) {
317 EXPECT_FALSE(IsRestartNeededToCommitChanges());
318 SetExperimentEnabled(&flags_storage_
, kFlags1
, false);
319 EXPECT_FALSE(IsRestartNeededToCommitChanges());
322 TEST_F(AboutFlagsTest
, ChangeNeedsRestart
) {
323 EXPECT_FALSE(IsRestartNeededToCommitChanges());
324 SetExperimentEnabled(&flags_storage_
, kFlags1
, true);
325 EXPECT_TRUE(IsRestartNeededToCommitChanges());
328 TEST_F(AboutFlagsTest
, MultiFlagChangeNeedsRestart
) {
329 const Experiment
& experiment
= kExperiments
[3];
330 ASSERT_EQ(kFlags4
, experiment
.internal_name
);
331 EXPECT_FALSE(IsRestartNeededToCommitChanges());
332 // Enable the 2nd choice of the multi-value.
333 SetExperimentEnabled(&flags_storage_
, experiment
.NameForChoice(2), true);
334 EXPECT_TRUE(IsRestartNeededToCommitChanges());
335 testing::ClearState();
336 EXPECT_FALSE(IsRestartNeededToCommitChanges());
337 // Enable the default choice now.
338 SetExperimentEnabled(&flags_storage_
, experiment
.NameForChoice(0), true);
339 EXPECT_TRUE(IsRestartNeededToCommitChanges());
342 TEST_F(AboutFlagsTest
, AddTwoFlagsRemoveOne
) {
343 // Add two experiments, check they're there.
344 SetExperimentEnabled(&flags_storage_
, kFlags1
, true);
345 SetExperimentEnabled(&flags_storage_
, kFlags2
, true);
347 const base::ListValue
* experiments_list
= prefs_
.GetList(
348 prefs::kEnabledLabsExperiments
);
349 ASSERT_TRUE(experiments_list
!= NULL
);
351 ASSERT_EQ(2u, experiments_list
->GetSize());
354 ASSERT_TRUE(experiments_list
->GetString(0, &s0
));
356 ASSERT_TRUE(experiments_list
->GetString(1, &s1
));
358 EXPECT_TRUE(s0
== kFlags1
|| s1
== kFlags1
);
359 EXPECT_TRUE(s0
== kFlags2
|| s1
== kFlags2
);
361 // Remove one experiment, check the other's still around.
362 SetExperimentEnabled(&flags_storage_
, kFlags2
, false);
364 experiments_list
= prefs_
.GetList(prefs::kEnabledLabsExperiments
);
365 ASSERT_TRUE(experiments_list
!= NULL
);
366 ASSERT_EQ(1u, experiments_list
->GetSize());
367 ASSERT_TRUE(experiments_list
->GetString(0, &s0
));
368 EXPECT_TRUE(s0
== kFlags1
);
371 TEST_F(AboutFlagsTest
, AddTwoFlagsRemoveBoth
) {
372 // Add two experiments, check the pref exists.
373 SetExperimentEnabled(&flags_storage_
, kFlags1
, true);
374 SetExperimentEnabled(&flags_storage_
, kFlags2
, true);
375 const base::ListValue
* experiments_list
= prefs_
.GetList(
376 prefs::kEnabledLabsExperiments
);
377 ASSERT_TRUE(experiments_list
!= NULL
);
379 // Remove both, the pref should have been removed completely.
380 SetExperimentEnabled(&flags_storage_
, kFlags1
, false);
381 SetExperimentEnabled(&flags_storage_
, kFlags2
, false);
382 experiments_list
= prefs_
.GetList(prefs::kEnabledLabsExperiments
);
383 EXPECT_TRUE(experiments_list
== NULL
|| experiments_list
->GetSize() == 0);
386 TEST_F(AboutFlagsTest
, ConvertFlagsToSwitches
) {
387 SetExperimentEnabled(&flags_storage_
, kFlags1
, true);
389 CommandLine
command_line(CommandLine::NO_PROGRAM
);
390 command_line
.AppendSwitch("foo");
392 EXPECT_TRUE(command_line
.HasSwitch("foo"));
393 EXPECT_FALSE(command_line
.HasSwitch(kSwitch1
));
395 ConvertFlagsToSwitches(&flags_storage_
, &command_line
, kAddSentinels
);
397 EXPECT_TRUE(command_line
.HasSwitch("foo"));
398 EXPECT_TRUE(command_line
.HasSwitch(kSwitch1
));
399 EXPECT_TRUE(command_line
.HasSwitch(switches::kFlagSwitchesBegin
));
400 EXPECT_TRUE(command_line
.HasSwitch(switches::kFlagSwitchesEnd
));
402 CommandLine
command_line2(CommandLine::NO_PROGRAM
);
404 ConvertFlagsToSwitches(&flags_storage_
, &command_line2
, kNoSentinels
);
406 EXPECT_TRUE(command_line2
.HasSwitch(kSwitch1
));
407 EXPECT_FALSE(command_line2
.HasSwitch(switches::kFlagSwitchesBegin
));
408 EXPECT_FALSE(command_line2
.HasSwitch(switches::kFlagSwitchesEnd
));
411 CommandLine::StringType
CreateSwitch(const std::string
& value
) {
413 return base::ASCIIToUTF16(value
);
419 TEST_F(AboutFlagsTest
, CompareSwitchesToCurrentCommandLine
) {
420 SetExperimentEnabled(&flags_storage_
, kFlags1
, true);
422 const std::string
kDoubleDash("--");
424 CommandLine
command_line(CommandLine::NO_PROGRAM
);
425 command_line
.AppendSwitch("foo");
427 CommandLine
new_command_line(CommandLine::NO_PROGRAM
);
428 ConvertFlagsToSwitches(&flags_storage_
, &new_command_line
, kAddSentinels
);
430 EXPECT_FALSE(AreSwitchesIdenticalToCurrentCommandLine(
431 new_command_line
, command_line
, NULL
));
433 std::set
<CommandLine::StringType
> difference
;
434 EXPECT_FALSE(AreSwitchesIdenticalToCurrentCommandLine(
435 new_command_line
, command_line
, &difference
));
436 EXPECT_EQ(1U, difference
.size());
437 EXPECT_EQ(1U, difference
.count(CreateSwitch(kDoubleDash
+ kSwitch1
)));
440 ConvertFlagsToSwitches(&flags_storage_
, &command_line
, kAddSentinels
);
442 EXPECT_TRUE(AreSwitchesIdenticalToCurrentCommandLine(
443 new_command_line
, command_line
, NULL
));
445 std::set
<CommandLine::StringType
> difference
;
446 EXPECT_TRUE(AreSwitchesIdenticalToCurrentCommandLine(
447 new_command_line
, command_line
, &difference
));
448 EXPECT_TRUE(difference
.empty());
451 // Now both have flags but different.
452 SetExperimentEnabled(&flags_storage_
, kFlags1
, false);
453 SetExperimentEnabled(&flags_storage_
, kFlags2
, true);
455 CommandLine
another_command_line(CommandLine::NO_PROGRAM
);
456 ConvertFlagsToSwitches(&flags_storage_
, &another_command_line
, kAddSentinels
);
458 EXPECT_FALSE(AreSwitchesIdenticalToCurrentCommandLine(
459 new_command_line
, another_command_line
, NULL
));
461 std::set
<CommandLine::StringType
> difference
;
462 EXPECT_FALSE(AreSwitchesIdenticalToCurrentCommandLine(
463 new_command_line
, another_command_line
, &difference
));
464 EXPECT_EQ(2U, difference
.size());
465 EXPECT_EQ(1U, difference
.count(CreateSwitch(kDoubleDash
+ kSwitch1
)));
467 difference
.count(CreateSwitch(kDoubleDash
+ kSwitch2
+ "=" +
472 TEST_F(AboutFlagsTest
, RemoveFlagSwitches
) {
473 std::map
<std::string
, CommandLine::StringType
> switch_list
;
474 switch_list
[kSwitch1
] = CommandLine::StringType();
475 switch_list
[switches::kFlagSwitchesBegin
] = CommandLine::StringType();
476 switch_list
[switches::kFlagSwitchesEnd
] = CommandLine::StringType();
477 switch_list
["foo"] = CommandLine::StringType();
479 SetExperimentEnabled(&flags_storage_
, kFlags1
, true);
481 // This shouldn't do anything before ConvertFlagsToSwitches() wasn't called.
482 RemoveFlagsSwitches(&switch_list
);
483 ASSERT_EQ(4u, switch_list
.size());
484 EXPECT_TRUE(switch_list
.find(kSwitch1
) != switch_list
.end());
485 EXPECT_TRUE(switch_list
.find(switches::kFlagSwitchesBegin
) !=
487 EXPECT_TRUE(switch_list
.find(switches::kFlagSwitchesEnd
) !=
489 EXPECT_TRUE(switch_list
.find("foo") != switch_list
.end());
491 // Call ConvertFlagsToSwitches(), then RemoveFlagsSwitches() again.
492 CommandLine
command_line(CommandLine::NO_PROGRAM
);
493 command_line
.AppendSwitch("foo");
494 ConvertFlagsToSwitches(&flags_storage_
, &command_line
, kAddSentinels
);
495 RemoveFlagsSwitches(&switch_list
);
497 // Now the about:flags-related switch should have been removed.
498 ASSERT_EQ(1u, switch_list
.size());
499 EXPECT_TRUE(switch_list
.find("foo") != switch_list
.end());
502 // Tests enabling experiments that aren't supported on the current platform.
503 TEST_F(AboutFlagsTest
, PersistAndPrune
) {
504 // Enable experiments 1 and 3.
505 SetExperimentEnabled(&flags_storage_
, kFlags1
, true);
506 SetExperimentEnabled(&flags_storage_
, kFlags3
, true);
507 CommandLine
command_line(CommandLine::NO_PROGRAM
);
508 EXPECT_FALSE(command_line
.HasSwitch(kSwitch1
));
509 EXPECT_FALSE(command_line
.HasSwitch(kSwitch3
));
511 // Convert the flags to switches. Experiment 3 shouldn't be among the switches
512 // as it is not applicable to the current platform.
513 ConvertFlagsToSwitches(&flags_storage_
, &command_line
, kAddSentinels
);
514 EXPECT_TRUE(command_line
.HasSwitch(kSwitch1
));
515 EXPECT_FALSE(command_line
.HasSwitch(kSwitch3
));
517 // Experiment 3 should show still be persisted in preferences though.
518 const base::ListValue
* experiments_list
=
519 prefs_
.GetList(prefs::kEnabledLabsExperiments
);
520 ASSERT_TRUE(experiments_list
);
521 EXPECT_EQ(2U, experiments_list
->GetSize());
523 ASSERT_TRUE(experiments_list
->GetString(0, &s0
));
524 EXPECT_EQ(kFlags1
, s0
);
526 ASSERT_TRUE(experiments_list
->GetString(1, &s1
));
527 EXPECT_EQ(kFlags3
, s1
);
530 // Tests that switches which should have values get them in the command
532 TEST_F(AboutFlagsTest
, CheckValues
) {
533 // Enable experiments 1 and 2.
534 SetExperimentEnabled(&flags_storage_
, kFlags1
, true);
535 SetExperimentEnabled(&flags_storage_
, kFlags2
, true);
536 CommandLine
command_line(CommandLine::NO_PROGRAM
);
537 EXPECT_FALSE(command_line
.HasSwitch(kSwitch1
));
538 EXPECT_FALSE(command_line
.HasSwitch(kSwitch2
));
540 // Convert the flags to switches.
541 ConvertFlagsToSwitches(&flags_storage_
, &command_line
, kAddSentinels
);
542 EXPECT_TRUE(command_line
.HasSwitch(kSwitch1
));
543 EXPECT_EQ(std::string(), command_line
.GetSwitchValueASCII(kSwitch1
));
544 EXPECT_TRUE(command_line
.HasSwitch(kSwitch2
));
545 EXPECT_EQ(std::string(kValueForSwitch2
),
546 command_line
.GetSwitchValueASCII(kSwitch2
));
548 // Confirm that there is no '=' in the command line for simple switches.
549 std::string switch1_with_equals
= std::string("--") +
550 std::string(kSwitch1
) +
553 EXPECT_EQ(std::wstring::npos
,
554 command_line
.GetCommandLineString().find(
555 base::ASCIIToWide(switch1_with_equals
)));
557 EXPECT_EQ(std::string::npos
,
558 command_line
.GetCommandLineString().find(switch1_with_equals
));
561 // And confirm there is a '=' for switches with values.
562 std::string switch2_with_equals
= std::string("--") +
563 std::string(kSwitch2
) +
566 EXPECT_NE(std::wstring::npos
,
567 command_line
.GetCommandLineString().find(
568 base::ASCIIToWide(switch2_with_equals
)));
570 EXPECT_NE(std::string::npos
,
571 command_line
.GetCommandLineString().find(switch2_with_equals
));
574 // And it should persist.
575 const base::ListValue
* experiments_list
=
576 prefs_
.GetList(prefs::kEnabledLabsExperiments
);
577 ASSERT_TRUE(experiments_list
);
578 EXPECT_EQ(2U, experiments_list
->GetSize());
580 ASSERT_TRUE(experiments_list
->GetString(0, &s0
));
581 EXPECT_EQ(kFlags1
, s0
);
583 ASSERT_TRUE(experiments_list
->GetString(1, &s1
));
584 EXPECT_EQ(kFlags2
, s1
);
587 // Tests multi-value type experiments.
588 TEST_F(AboutFlagsTest
, MultiValues
) {
589 const Experiment
& experiment
= kExperiments
[3];
590 ASSERT_EQ(kFlags4
, experiment
.internal_name
);
592 // Initially, the first "deactivated" option of the multi experiment should
595 CommandLine
command_line(CommandLine::NO_PROGRAM
);
596 ConvertFlagsToSwitches(&flags_storage_
, &command_line
, kAddSentinels
);
597 EXPECT_FALSE(command_line
.HasSwitch(kMultiSwitch1
));
598 EXPECT_FALSE(command_line
.HasSwitch(kMultiSwitch2
));
601 // Enable the 2nd choice of the multi-value.
602 SetExperimentEnabled(&flags_storage_
, experiment
.NameForChoice(2), true);
604 CommandLine
command_line(CommandLine::NO_PROGRAM
);
605 ConvertFlagsToSwitches(&flags_storage_
, &command_line
, kAddSentinels
);
606 EXPECT_FALSE(command_line
.HasSwitch(kMultiSwitch1
));
607 EXPECT_TRUE(command_line
.HasSwitch(kMultiSwitch2
));
608 EXPECT_EQ(std::string(kValueForMultiSwitch2
),
609 command_line
.GetSwitchValueASCII(kMultiSwitch2
));
612 // Disable the multi-value experiment.
613 SetExperimentEnabled(&flags_storage_
, experiment
.NameForChoice(0), true);
615 CommandLine
command_line(CommandLine::NO_PROGRAM
);
616 ConvertFlagsToSwitches(&flags_storage_
, &command_line
, kAddSentinels
);
617 EXPECT_FALSE(command_line
.HasSwitch(kMultiSwitch1
));
618 EXPECT_FALSE(command_line
.HasSwitch(kMultiSwitch2
));
622 TEST_F(AboutFlagsTest
, EnableDisableValues
) {
623 const Experiment
& experiment
= kExperiments
[4];
624 ASSERT_EQ(kFlags5
, experiment
.internal_name
);
628 CommandLine
command_line(CommandLine::NO_PROGRAM
);
629 ConvertFlagsToSwitches(&flags_storage_
, &command_line
, kAddSentinels
);
630 EXPECT_FALSE(command_line
.HasSwitch(kSwitch1
));
631 EXPECT_FALSE(command_line
.HasSwitch(kSwitch2
));
634 // "Enable" option selected.
635 SetExperimentEnabled(&flags_storage_
, experiment
.NameForChoice(1), true);
637 CommandLine
command_line(CommandLine::NO_PROGRAM
);
638 ConvertFlagsToSwitches(&flags_storage_
, &command_line
, kAddSentinels
);
639 EXPECT_TRUE(command_line
.HasSwitch(kSwitch1
));
640 EXPECT_FALSE(command_line
.HasSwitch(kSwitch2
));
641 EXPECT_EQ(kEnableDisableValue1
, command_line
.GetSwitchValueASCII(kSwitch1
));
644 // "Disable" option selected.
645 SetExperimentEnabled(&flags_storage_
, experiment
.NameForChoice(2), true);
647 CommandLine
command_line(CommandLine::NO_PROGRAM
);
648 ConvertFlagsToSwitches(&flags_storage_
, &command_line
, kAddSentinels
);
649 EXPECT_FALSE(command_line
.HasSwitch(kSwitch1
));
650 EXPECT_TRUE(command_line
.HasSwitch(kSwitch2
));
651 EXPECT_EQ(kEnableDisableValue2
, command_line
.GetSwitchValueASCII(kSwitch2
));
654 // "Default" option selected, same as nothing selected.
655 SetExperimentEnabled(&flags_storage_
, experiment
.NameForChoice(0), true);
657 CommandLine
command_line(CommandLine::NO_PROGRAM
);
658 ConvertFlagsToSwitches(&flags_storage_
, &command_line
, kAddSentinels
);
659 EXPECT_FALSE(command_line
.HasSwitch(kMultiSwitch1
));
660 EXPECT_FALSE(command_line
.HasSwitch(kMultiSwitch2
));
664 // Makes sure there are no separators in any of the experiment names.
665 TEST_F(AboutFlagsTest
, NoSeparators
) {
666 testing::SetExperiments(NULL
, 0);
668 const Experiment
* experiments
= testing::GetExperiments(&count
);
669 for (size_t i
= 0; i
< count
; ++i
) {
670 std::string name
= experiments
->internal_name
;
671 EXPECT_EQ(std::string::npos
, name
.find(testing::kMultiSeparator
)) << i
;
675 class AboutFlagsHistogramTest
: public ::testing::Test
{
677 // This is a helper function to check that all IDs in enum LoginCustomFlags in
678 // histograms.xml are unique.
679 void SetSwitchToHistogramIdMapping(const std::string
& switch_name
,
680 const Sample switch_histogram_id
,
681 std::map
<std::string
, Sample
>* out_map
) {
682 const std::pair
<std::map
<std::string
, Sample
>::iterator
, bool> status
=
683 out_map
->insert(std::make_pair(switch_name
, switch_histogram_id
));
684 if (!status
.second
) {
685 EXPECT_TRUE(status
.first
->second
== switch_histogram_id
)
686 << "Duplicate switch '" << switch_name
687 << "' found in enum 'LoginCustomFlags' in histograms.xml.";
691 // This method generates a hint for the user for what string should be added
692 // to the enum LoginCustomFlags to make in consistent.
693 std::string
GetHistogramEnumEntryText(const std::string
& switch_name
,
695 return base::StringPrintf(
696 "<int value=\"%d\" label=\"%s\"/>", value
, switch_name
.c_str());
700 TEST_F(AboutFlagsHistogramTest
, CheckHistograms
) {
701 base::FilePath histograms_xml_file_path
;
703 PathService::Get(base::DIR_SOURCE_ROOT
, &histograms_xml_file_path
));
704 histograms_xml_file_path
= histograms_xml_file_path
.AppendASCII("tools")
705 .AppendASCII("metrics")
706 .AppendASCII("histograms")
707 .AppendASCII("histograms.xml");
709 XmlReader histograms_xml
;
710 ASSERT_TRUE(histograms_xml
.LoadFile(
711 FilePathStringTypeToString(histograms_xml_file_path
.value())));
712 std::map
<Sample
, std::string
> login_custom_flags
=
713 ReadEnumFromHistogramsXml("LoginCustomFlags", &histograms_xml
);
714 ASSERT_TRUE(login_custom_flags
.size())
715 << "Error reading enum 'LoginCustomFlags' from histograms.xml.";
717 // Build reverse map {switch_name => id} from login_custom_flags.
718 SwitchToIdMap histograms_xml_switches_ids
;
720 EXPECT_TRUE(login_custom_flags
.count(kBadSwitchFormatHistogramId
))
721 << "Entry for UMA ID of incorrect command-line flag is not found in "
722 "histograms.xml enum LoginCustomFlags. "
723 "Consider adding entry:\n"
724 << " " << GetHistogramEnumEntryText("BAD_FLAG_FORMAT", 0);
725 // Check that all LoginCustomFlags entries have correct values.
726 for (std::map
<Sample
, std::string
>::const_iterator it
=
727 login_custom_flags
.begin();
728 it
!= login_custom_flags
.end();
730 if (it
->first
== kBadSwitchFormatHistogramId
) {
731 // Add eror value with empty name.
732 SetSwitchToHistogramIdMapping(
733 "", it
->first
, &histograms_xml_switches_ids
);
736 const Sample uma_id
= GetSwitchUMAId(it
->second
);
737 EXPECT_EQ(uma_id
, it
->first
)
738 << "histograms.xml enum LoginCustomFlags "
739 "entry '" << it
->second
<< "' has incorrect value=" << it
->first
740 << ", but " << uma_id
<< " is expected. Consider changing entry to:\n"
741 << " " << GetHistogramEnumEntryText(it
->second
, uma_id
);
742 SetSwitchToHistogramIdMapping(
743 it
->second
, it
->first
, &histograms_xml_switches_ids
);
746 // Check that all flags in about_flags.cc have entries in login_custom_flags.
747 std::set
<std::string
> all_switches
= GetAllSwitchesForTesting();
748 for (std::set
<std::string
>::const_iterator it
= all_switches
.begin();
749 it
!= all_switches
.end();
751 // Skip empty placeholders.
754 const Sample uma_id
= GetSwitchUMAId(*it
);
755 EXPECT_NE(kBadSwitchFormatHistogramId
, uma_id
)
756 << "Command-line switch '" << *it
757 << "' from about_flags.cc has UMA ID equal to reserved value "
758 "kBadSwitchFormatHistogramId=" << kBadSwitchFormatHistogramId
759 << ". Please modify switch name.";
760 SwitchToIdMap::iterator enum_entry
=
761 histograms_xml_switches_ids
.lower_bound(*it
);
763 // Ignore case here when switch ID is incorrect - it has already been
764 // reported in the previous loop.
765 EXPECT_TRUE(enum_entry
!= histograms_xml_switches_ids
.end() &&
766 enum_entry
->first
== *it
)
767 << "histograms.xml enum LoginCustomFlags doesn't contain switch '"
768 << *it
<< "' (value=" << uma_id
769 << " expected). Consider adding entry:\n"
770 << " " << GetHistogramEnumEntryText(*it
, uma_id
);
774 } // namespace about_flags