File: action_suffix_reader.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (39 lines) | stat: -rw-r--r-- 1,522 bytes parent folder | download | duplicates (6)
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
// Copyright 2024 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef BASE_TEST_METRICS_ACTION_SUFFIX_READER_H_
#define BASE_TEST_METRICS_ACTION_SUFFIX_READER_H_

#include <map>
#include <string>
#include <variant>
#include <vector>

namespace base {

using ActionSuffixEntryMap = std::map<std::string, std::string>;

// Find and read the suffixes list(s) which apply to the given `affected_action`
// in actions.xml.
//
// Useful for when you want to verify that the set of suffixes associated with
// a particular action contains expected values. For example,
// BrowserUserEducationServiceTest.CheckFeaturePromoActions verifies that for
// every registered Chrome Desktop in-product-help experience, there is a
// corresponding suffix for recording UserEducation.MessageAction* actions. This
// prevents someone from adding an IPH experience without adding the
// corresponding action entry.
//
// Returns a list of maps, each of which corresponds to one list of suffixes
// associated with the action (an `<affected-action>` could theoretically show
// up in more than one `<action-suffix>` block.)
//
// If no suffix list is found, returns an empty list. May generate test errors
// on malformed/duplicate entries even if valid suffixes are found.
extern std::vector<ActionSuffixEntryMap> ReadActionSuffixesForAction(
    const std::string& affected_action);

}  // namespace base

#endif  // BASE_TEST_METRICS_ACTION_SUFFIX_READER_H_