File: presubmit_bad_message_reasons.py

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 (44 lines) | stat: -rw-r--r-- 1,660 bytes parent folder | download | duplicates (9)
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
# Copyright 2017 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""Check to see if the various BadMessage enums in histograms.xml need to be
updated. This can be called from a chromium PRESUBMIT.py to ensure updates to
bad_message.h also include the generated changes to histograms.xml
"""

import update_histogram_enum


def PrecheckBadMessage(input_api,
                       output_api,
                       histogram_name,
                       end_marker='^BAD_MESSAGE_MAX',
                       strip_k_prefix=False):
  source_path = ''

  # This function is called once per bad_message.h-containing directory. Check
  # for the |bad_message.h| file, and if present, remember its path.
  for f in input_api.AffectedFiles():
    if f.LocalPath().endswith('bad_message.h'):
      source_path = f.LocalPath()
      break

  # If the |bad_message.h| wasn't found in this change, then there is nothing to
  # do and histogram.xml does not need to be updated.
  if source_path == '':
    return []

  START_MARKER='^enum (class )?BadMessageReason {'
  presubmit_error = update_histogram_enum.CheckPresubmitErrors(
      'tools/metrics/histograms/metadata/stability/enums.xml',
      histogram_enum_name=histogram_name,
      update_script_name='update_bad_message_reasons.py',
      source_enum_path=source_path,
      start_marker=START_MARKER,
      end_marker=end_marker,
      strip_k_prefix=strip_k_prefix)
  if presubmit_error:
    return [output_api.PresubmitPromptWarning(presubmit_error,
                                              items=[source_path])]
  return []