File: variations_params_manager.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (83 lines) | stat: -rw-r--r-- 3,051 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
// Copyright 2016 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.

#ifndef COMPONENTS_VARIATIONS_VARIATIONS_PARAMS_MANAGER_H_
#define COMPONENTS_VARIATIONS_VARIATIONS_PARAMS_MANAGER_H_

#include <map>
#include <memory>
#include <set>
#include <string>

#include "base/macros.h"
#include "base/metrics/field_trial.h"

namespace base {
class FieldTrialList;

namespace test {
class ScopedFeatureList;
}  // namespace test

}  // namespace base

namespace variations {
namespace testing {

// Use this class as a member in your test class to set variation params for
// your tests. You can directly set the parameters in the constructor (if they
// are used by other members upon construction). You can change them later
// arbitrarily many times using the SetVariationParams function. Internally, it
// creates a FieldTrialList as a member. It works well for multiple tests of a
// given test class, as it clears the parameters when this class is destructed.
// Note that it clears all parameters (not just those registered here).
class VariationParamsManager {
 public:
  // Does not associate any parameters.
  VariationParamsManager();
  // Calls directly SetVariationParams with the provided arguments.
  VariationParamsManager(
      const std::string& trial_name,
      const std::map<std::string, std::string>& param_values);
  // Calls directly SetVariationParamsWithFeatures with the provided arguments.
  VariationParamsManager(
      const std::string& trial_name,
      const std::map<std::string, std::string>& param_values,
      const std::set<std::string>& associated_features);
  ~VariationParamsManager();

  // Associates |param_values| with the given |trial_name|. |param_values| maps
  // parameter names to their values. The function creates a new trial group,
  // used only for testing. Between two calls of this function,
  // ClearAllVariationParams() has to be called.
  void SetVariationParams(
      const std::string& trial_name,
      const std::map<std::string, std::string>& param_values);

  // Like SetVariationParams(). |associated_features| lists names of features
  // to be associated to the newly created trial group. As a result, all
  // parameters from |param_values| can be accessed via any of the feature from
  // |associated_features|.
  void SetVariationParamsWithFeatureAssociations(
      const std::string& trial_name,
      const std::map<std::string, std::string>& param_values,
      const std::set<std::string>& associated_features);

  // Clears all of the mapped associations.
  void ClearAllVariationIDs();

  // Clears all of the associated params.
  void ClearAllVariationParams();

 private:
  std::unique_ptr<base::FieldTrialList> field_trial_list_;
  std::unique_ptr<base::test::ScopedFeatureList> scoped_feature_list_;

  DISALLOW_COPY_AND_ASSIGN(VariationParamsManager);
};

}  // namespace testing
}  // namespace variations

#endif  // COMPONENTS_VARIATIONS_VARIATIONS_PARAMS_MANAGER_H_