mirror of
https://github.com/mozilla/gecko-dev.git
synced 2025-11-09 21:00:42 +02:00
5b6ff5a709
This patch adds the PerfDocs Generator. Some modificiations to `run_perfdocs` were also made because verification always has to occur before the documentation generation, and generation always has to be run after verification (if verification passes). Differential Revision: https://phabricator.services.mozilla.com/D57111 --HG-- extra : moz-landing-system : lando
83 lines
2.6 KiB
Python
83 lines
2.6 KiB
Python
# This Source Code Form is subject to the terms of the Mozilla Public
|
|
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
from __future__ import absolute_import
|
|
|
|
import re
|
|
|
|
|
|
class PerfDocLogger(object):
|
|
'''
|
|
Logger for the PerfDoc tooling. Handles the warnings by outputting
|
|
them into through the StructuredLogger provided by lint.
|
|
'''
|
|
PATHS = []
|
|
LOGGER = None
|
|
FAILED = False
|
|
|
|
def __init__(self):
|
|
'''Initializes the PerfDocLogger.'''
|
|
|
|
# Set up class attributes for all logger instances
|
|
if not PerfDocLogger.LOGGER:
|
|
raise Exception(
|
|
"Missing linting LOGGER instance for PerfDocLogger initialization"
|
|
)
|
|
if not PerfDocLogger.PATHS:
|
|
raise Exception(
|
|
"Missing PATHS for PerfDocLogger initialization"
|
|
)
|
|
self.logger = PerfDocLogger.LOGGER
|
|
|
|
def log(self, msg):
|
|
'''
|
|
Log an info message.
|
|
|
|
:param str msg: Message to log.
|
|
'''
|
|
self.logger.info(msg)
|
|
|
|
def warning(self, msg, files):
|
|
'''
|
|
Logs a validation warning message. The warning message is
|
|
used as the error message that is output in the reviewbot.
|
|
|
|
:param str msg: Message to log, it's also used as the error message
|
|
for the issue that is output by the reviewbot.
|
|
:param list/str files: The file(s) that this warning is about.
|
|
'''
|
|
if type(files) != list:
|
|
files = [files]
|
|
|
|
# Add a reviewbot error for each file that is given
|
|
for file in files:
|
|
# Get a relative path (reviewbot can't handle absolute paths)
|
|
# TODO: Expand to outside of the testing directory
|
|
fpath = re.sub(".*testing", "testing", file)
|
|
|
|
# Filter out any issues that do not relate to the paths
|
|
# that are being linted
|
|
for path in PerfDocLogger.PATHS:
|
|
if path not in file:
|
|
continue
|
|
|
|
# Output error entry
|
|
self.logger.lint_error(
|
|
message=msg,
|
|
lineno=0,
|
|
column=None,
|
|
path=fpath,
|
|
linter='perfdocs',
|
|
rule="Flawless performance docs."
|
|
)
|
|
|
|
PerfDocLogger.FAILED = True
|
|
break
|
|
|
|
def critical(self, msg):
|
|
'''
|
|
Log a critical message.
|
|
|
|
:param str msg: Message to log.
|
|
'''
|
|
self.logger.critical(msg)
|