forked from mirrors/gecko-dev
f7577e4996
This patch fixes the path issues with PerfDocs on Windows machines. To do this, all `os` path manipulations were converted to use `pathlib`. The encoding, and permissions of the files are also set properly now since Windows has different defaults. The tests were also fixed to be able to run on Windows machines. Differential Revision: https://phabricator.services.mozilla.com/D156983
82 lines
2.5 KiB
Python
82 lines
2.5 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 pathlib
|
|
|
|
|
|
class PerfDocLogger(object):
|
|
"""
|
|
Logger for the PerfDoc tooling. Handles the warnings by outputting
|
|
them into through the StructuredLogger provided by lint.
|
|
"""
|
|
|
|
TOP_DIR = ""
|
|
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)
|
|
fpath = str(file).replace(str(PerfDocLogger.TOP_DIR), "")
|
|
|
|
# Filter out any issues that do not relate to the paths
|
|
# that are being linted
|
|
for path in PerfDocLogger.PATHS:
|
|
if str(path) not in str(file):
|
|
continue
|
|
|
|
# Output error entry
|
|
self.logger.lint_error(
|
|
message=msg,
|
|
lineno=0,
|
|
column=None,
|
|
path=str(pathlib.PurePosixPath(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)
|