Open Menu / tools / buildman / outcome.py
Loading...
 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
# SPDX-License-Identifier: GPL-2.0+
# Copyright (c) 2013 The Chromium OS Authors.

"""Outcome class and constants for buildman build results"""

from collections import namedtuple

# Build-outcome codes
OUTCOME_OK, OUTCOME_WARNING, OUTCOME_ERROR, OUTCOME_UNKNOWN = list(range(4))

# Board status for display purposes
#   ok: List of boards fixed since last commit
#   warn: List of boards with warnings since last commit
#   err: List of new broken boards since last commit
#   new: List of boards that didn't exist last time
#   unknown: List of boards that were not built
BoardStatus = namedtuple('BoardStatus', 'ok warn err new unknown')

# Display options for result output
DisplayOptions = namedtuple('DisplayOptions', [
    'show_errors',      # Show error/warning lines
    'show_sizes',       # Show size deltas
    'show_detail',      # Show size delta detail for each board
    'show_bloat',       # Show detail for each function
    'show_config',      # Show config changes
    'show_environment', # Show environment changes
    'show_unknown',     # Show unknown boards in summary
    'ide',              # IDE mode - output to stderr
    'list_error_boards', # Include board list with error lines
])

# Error line information for display
#   char: Character representation: '+': error, '-': fixed error, 'w+': warning,
#       'w-' = fixed warning
#   brds: List of Board objects which have line in the error/warning output
#   errline: The text of the error line
ErrLine = namedtuple('ErrLine', 'char brds errline')


class Outcome:
    """Records a build outcome for a single make invocation

    Public Members:
        rc: Outcome value (OUTCOME_...)
        err_lines: List of error lines or [] if none
        sizes: Dictionary of image size information, keyed by filename
            - Each value is itself a dictionary containing
                values for 'text', 'data' and 'bss', being the integer
                size in bytes of each section.
        func_sizes: Dictionary keyed by filename - e.g. 'u-boot'. Each
                value is itself a dictionary:
                    key: function name
                    value: Size of function in bytes
        config: Dictionary keyed by filename - e.g. '.config'. Each
                value is itself a dictionary:
                    key: config name
                    value: config value
        environment: Dictionary keyed by environment variable, Each
                 value is the value of environment variable.
    """
    def __init__(self, rc, err_lines, sizes, func_sizes, config,
                 environment):
        self.rc = rc
        self.err_lines = err_lines
        self.sizes = sizes
        self.func_sizes = func_sizes
        self.config = config
        self.environment = environment