Revert "Fix broken channel icon in chrome://help on CrOS" and try again

[chromium-blink-merge.git] / tools / code_coverage / example.croc

# -*- python -*-\r
\r
# Copyright (c) 2012 The Chromium Authors. All rights reserved.\r
# Use of this source code is governed by a BSD-style license that can be\r
# found in the LICENSE file.\r
\r
# Example configuration file for Croc\r
\r
# Basic formatting rules:\r
#   * It looks like JSON.\r
#   * It's really python.\r
#   * Dictionaries are wrapped in {}.  Order does not matter.  Entries are of\r
#     the form:\r
#         'key':value,\r
#     Note the trailing comma, which will help save you from python's built-in\r
#     string concatenation.\r
#   * Lists are wrapped in [].  Order does matter.  Entries should be followed\r
#     with a trailing comma, which will help save you from python's built-in\r
#     string concatenation.\r
#   * Comments start with # and extend to end of line.\r
#   * Strings are wrapped in ''.  Backslashes must be escaped ('foo\\bar', not\r
#     'foo\bar') - this is particularly important in rule regular expressions.\r
\r
\r
# What follows is the main configuration dictionary.\r
{\r
  # List of root directories, applied in order.\r
  #\r
  # Typically, coverage data files contain absolute paths to the sources.\r
  # What you care about is usually a relative path from the top of your source\r
  # tree (referred to here as a 'source root') to the sources.\r
  #\r
  # Roots may also be specified on the command line via the --root option.\r
  # Roots specified by --root are applied before those specified in config\r
  # files.\r
  'roots' : [\r
    # Each entry is a dict.\r
    #     * It must contain a 'root' entry, which is the start of a path.\r
    #         * Root entries may be absolute paths\r
    #         * Root entries starting with './' or '../' are relative paths, and\r
    #           are taken relative to the current directory where you run croc.\r
    #         * Root entries may start with previously defined altnames.\r
    #         * Use '/' as a path separator, even on Windows.\r
    #     * It may contain a 'altname' entry.  If the root matches the start of\r
    #        a filename, that start is replaced with the 'altname', or with '_'\r
    #        if no default is specified.\r
    #     * Multiple root entries may share the same altname.  This is commonly\r
    #       used when combining LCOV files from different platforms into one\r
    #       coverage report, when each platform checks out source code into a\r
    #       different source tree.\r
    {'root' : 'c:/P4/EarthHammer'},\r
    {'root' : 'd:/pulse/recipes/330137642/base'},\r
    {'root' : '/Volumes/BuildData/PulseData/data/recipes/330137640/base'},\r
    {'root' : '/usr/local/google/builder/.pulse-agent/data/recipes/330137641/base'},\r
\r
    # Sub-paths we specifically care about and want to call out.  Note that\r
    # these are relative to the default '_' altname.\r
    {\r
      'root' : '_/googleclient/third_party/software_construction_toolkit/files',\r
      'altname' : 'SCT',\r
    },\r
    {\r
      'root' : '_/googleclient/tools/hammer',\r
      'altname' : 'HAMMER',\r
    },\r
  ],\r
\r
  # List of rules, applied in order.\r
  'rules' : [\r
    # Each rule is a dict.\r
    #   * It must contaihn a 'regexp' entry.  Filenames which match this\r
    #     regular expression (after applying mappings from 'roots') are\r
    #     affected by the rule.\r
    #\r
    #   * Other entries in the dict are attributes to apply to matching files.\r
    #\r
    # Allowed attributes:\r
    #\r
    #   'include' : If 1, the file will be included in coverage reports.  If 0,\r
    #               it won't be included in coverage reports.\r
    #\r
    #   'group' : Name of the group the file belongs to.  The most common\r
    #             group names are 'source' and 'test'.  Files must belong to\r
    #             a group to be included in coverage reports.\r
    #\r
    #   'language' : Programming language for the file.  The most common\r
    #                languages are 'C', 'C++', 'python', 'ObjC', 'ObjC++'.\r
    #                Files must have a language to be included in coverage\r
    #                reports.\r
    #\r
    #   'add_if_missing' : If 1, and the file was not referenced by any LCOV\r
    #                      files, it will be be scanned for executable lines\r
    #                      and added to the coverage report.  If 0, if the\r
    #                      file is not referenced by any LCOV files, it will\r
    #                      simply be ignored and not present in coverage\r
    #                      reports.\r
\r
    # Files/paths to include\r
    {\r
      'regexp' : '^(SCT|HAMMER)/',\r
      'include' : 1,\r
      'add_if_missing': 1,\r
    },\r
    {\r
      'regexp' : '.*/(\\.svn|\\.hg)/',\r
      'include' : 0,\r
    },\r
\r
    # Groups\r
    {\r
      'regexp' : '',\r
      'group' : 'source',\r
    },\r
    {\r
      'regexp' : '.*_(test|test_mac|unittest)\\.',\r
      'group' : 'test',\r
    },\r
\r
    # Languages\r
    {\r
      'regexp' : '.*\\.py$',\r
      'language' : 'python',\r
    },\r
  ],\r
\r
  # List of paths to add source from.\r
  #\r
  # Each entry is a path.  It may be a local path, or one relative to a root\r
  # altname (see 'roots' above).\r
  #\r
  # If more than one root's altname matches the start of this path, all matches\r
  # will be attempted; matches where the candidate directory doesn't exist will\r
  # be ignored.  For example, if you're combining data from multiple platforms'\r
  # LCOV files, you probably defined at least one root per LCOV, but only have\r
  # one copy of the source on your local platform.  That's fine; Croc will use\r
  # the source it can find and not worry about the source it can't.\r
  #\r
  # Source files must be added via 'add_files' to generate line-by-line HTML\r
  # output (via the --html option) and/or to scan for missing executable lines\r
  # (if 'add_if_missing' is 1).\r
  'add_files' : [\r
    'SCT',\r
    'HAMMER',\r
  ],\r
\r
  # Statistics to print.\r
  #\r
  'print_stats' : [\r
    # Each entry is a dict.\r
    #\r
    # It must have a 'stat' entry, which is the statistic to print.  This may\r
    # be one of the following stats:\r
    #\r
    #   * files_executable\r
    #   * files_instrumented\r
    #   * files_covered\r
    #   * lines_executable\r
    #   * lines_instrumented\r
    #   * lines_covered\r
    #\r
    # or an expression using those stats.\r
    #\r
    # It may have a 'format' entry, which is a python formatting string (very\r
    # printf-like) for the statistic.\r
    #\r
    # It may have a 'group' entry.  If this is specified, only files from the\r
    # matching group will be included in the statistic.  If not specified, the\r
    # group defaults to 'all', which means all groups.\r
    {\r
      'stat' : 'files_executable',\r
      'format' : '*RESULT FilesKnown: files_executable= %d files',\r
    },\r
    {\r
      'stat' : 'files_instrumented',\r
      'format' : '*RESULT FilesInstrumented: files_instrumented= %d files',\r
    },\r
    {\r
      'stat' : '100.0 * files_instrumented / files_executable',\r
      'format' : '*RESULT FilesInstrumentedPercent: files_instrumented_percent= %g',\r
    },\r
    {\r
      'stat' : 'lines_instrumented',\r
      'format' : '*RESULT LinesInstrumented: lines_instrumented= %d lines',\r
    },\r
    {\r
      'stat' : 'lines_covered',\r
      'format' : '*RESULT LinesCoveredSource: lines_covered_source= %d lines',\r
      'group' : 'source',\r
    },\r
    {\r
      'stat' : 'lines_covered',\r
      'format' : '*RESULT LinesCoveredTest: lines_covered_test= %d lines',\r
      'group' : 'test',\r
    },\r
  ],\r
\r
}\r