forked from mirrors/gecko-dev
6ab48776f3
This patch forces perfdocs to produce unix line endings rather than os-specific line endings. This fixes an issue where generating the docs on windows causes all the docs to change because of the line endings. Differential Revision: https://phabricator.services.mozilla.com/D117919
289 lines
8.7 KiB
Python
289 lines
8.7 KiB
Python
import contextlib
|
|
from unittest import mock
|
|
import os
|
|
import shutil
|
|
import tempfile
|
|
|
|
import mozunit
|
|
|
|
LINTER = "perfdocs"
|
|
|
|
|
|
@contextlib.contextmanager
|
|
def temp_file(name="temp", tempdir=None, content=None):
|
|
if tempdir is None:
|
|
tempdir = tempfile.mkdtemp()
|
|
path = os.path.join(tempdir, name)
|
|
if content is not None:
|
|
with open(path, "w", newline="\n") as f:
|
|
f.write(content)
|
|
try:
|
|
yield path
|
|
finally:
|
|
try:
|
|
shutil.rmtree(tempdir)
|
|
except FileNotFoundError:
|
|
pass
|
|
|
|
|
|
def setup_sample_logger(logger, structured_logger, top_dir):
|
|
from perfdocs.logger import PerfDocLogger
|
|
|
|
PerfDocLogger.LOGGER = structured_logger
|
|
PerfDocLogger.PATHS = ["perfdocs"]
|
|
PerfDocLogger.TOP_DIR = top_dir
|
|
|
|
import perfdocs.verifier as vf
|
|
import perfdocs.gatherer as gt
|
|
import perfdocs.generator as gn
|
|
|
|
gt.logger = logger
|
|
vf.logger = logger
|
|
gn.logger = logger
|
|
|
|
|
|
@mock.patch("perfdocs.logger.PerfDocLogger")
|
|
def test_perfdocs_generator_generate_perfdocs_pass(
|
|
logger, structured_logger, perfdocs_sample
|
|
):
|
|
top_dir = perfdocs_sample["top_dir"]
|
|
setup_sample_logger(logger, structured_logger, top_dir)
|
|
|
|
templates_dir = os.path.join(top_dir, "tools", "lint", "perfdocs", "templates")
|
|
os.makedirs(templates_dir)
|
|
|
|
from perfdocs.generator import Generator
|
|
from perfdocs.verifier import Verifier
|
|
|
|
verifier = Verifier(top_dir)
|
|
verifier.validate_tree()
|
|
|
|
generator = Generator(verifier, generate=True, workspace=top_dir)
|
|
with temp_file("index.rst", tempdir=templates_dir, content="{test_documentation}"):
|
|
generator.generate_perfdocs()
|
|
|
|
assert logger.warning.call_count == 0
|
|
|
|
|
|
@mock.patch("perfdocs.logger.PerfDocLogger")
|
|
def test_perfdocs_generator_needed_regeneration(
|
|
logger, structured_logger, perfdocs_sample
|
|
):
|
|
top_dir = perfdocs_sample["top_dir"]
|
|
setup_sample_logger(logger, structured_logger, top_dir)
|
|
|
|
from perfdocs.generator import Generator
|
|
from perfdocs.verifier import Verifier
|
|
|
|
verifier = Verifier(top_dir)
|
|
verifier.validate_tree()
|
|
|
|
generator = Generator(verifier, generate=False, workspace=top_dir)
|
|
generator.generate_perfdocs()
|
|
|
|
expected = "PerfDocs need to be regenerated."
|
|
args, _ = logger.warning.call_args
|
|
|
|
assert logger.warning.call_count == 1
|
|
assert args[0] == expected
|
|
|
|
|
|
@mock.patch("perfdocs.logger.PerfDocLogger")
|
|
def test_perfdocs_generator_needed_update(logger, structured_logger, perfdocs_sample):
|
|
top_dir = perfdocs_sample["top_dir"]
|
|
setup_sample_logger(logger, structured_logger, top_dir)
|
|
|
|
templates_dir = os.path.join(top_dir, "tools", "lint", "perfdocs", "templates")
|
|
os.makedirs(templates_dir)
|
|
|
|
from perfdocs.generator import Generator
|
|
from perfdocs.verifier import Verifier
|
|
|
|
# Initializing perfdocs
|
|
verifier = Verifier(top_dir)
|
|
verifier.validate_tree()
|
|
|
|
generator = Generator(verifier, generate=True, workspace=top_dir)
|
|
with temp_file("index.rst", tempdir=templates_dir, content="{test_documentation}"):
|
|
generator.generate_perfdocs()
|
|
|
|
# Removed file for testing and run again
|
|
generator._generate = False
|
|
files = [f for f in os.listdir(generator.perfdocs_path)]
|
|
for f in files:
|
|
os.remove(os.path.join(generator.perfdocs_path, f))
|
|
|
|
generator.generate_perfdocs()
|
|
|
|
expected = (
|
|
"PerfDocs are outdated, run ./mach lint -l perfdocs --fix` to update them."
|
|
)
|
|
args, _ = logger.warning.call_args
|
|
|
|
assert logger.warning.call_count == 1
|
|
assert args[0] == expected
|
|
|
|
|
|
@mock.patch("perfdocs.logger.PerfDocLogger")
|
|
def test_perfdocs_generator_created_perfdocs(
|
|
logger, structured_logger, perfdocs_sample
|
|
):
|
|
top_dir = perfdocs_sample["top_dir"]
|
|
setup_sample_logger(logger, structured_logger, top_dir)
|
|
|
|
templates_dir = os.path.join(top_dir, "tools", "lint", "perfdocs", "templates")
|
|
os.makedirs(templates_dir)
|
|
|
|
from perfdocs.generator import Generator
|
|
from perfdocs.verifier import Verifier
|
|
|
|
verifier = Verifier(top_dir)
|
|
verifier.validate_tree()
|
|
|
|
generator = Generator(verifier, generate=True, workspace=top_dir)
|
|
with temp_file("index.rst", tempdir=templates_dir, content="{test_documentation}"):
|
|
perfdocs_tmpdir = generator._create_perfdocs()
|
|
|
|
files = [f for f in os.listdir(perfdocs_tmpdir)]
|
|
files.sort()
|
|
expected_files = ["index.rst", "mozperftest.rst"]
|
|
|
|
for i, file in enumerate(files):
|
|
assert file == expected_files[i]
|
|
|
|
with open(os.path.join(perfdocs_tmpdir, expected_files[0])) as f:
|
|
filedata = f.readlines()
|
|
assert "".join(filedata) == " * :doc:`mozperftest`"
|
|
|
|
|
|
@mock.patch("perfdocs.logger.PerfDocLogger")
|
|
def test_perfdocs_generator_build_perfdocs(logger, structured_logger, perfdocs_sample):
|
|
top_dir = perfdocs_sample["top_dir"]
|
|
setup_sample_logger(logger, structured_logger, top_dir)
|
|
|
|
from perfdocs.generator import Generator
|
|
from perfdocs.verifier import Verifier
|
|
|
|
verifier = Verifier(top_dir)
|
|
verifier.validate_tree()
|
|
|
|
generator = Generator(verifier, generate=True, workspace=top_dir)
|
|
frameworks_info = generator.build_perfdocs_from_tree()
|
|
|
|
expected = ["dynamic", "static"]
|
|
|
|
for framework in sorted(frameworks_info.keys()):
|
|
for i, framework_info in enumerate(frameworks_info[framework]):
|
|
assert framework_info == expected[i]
|
|
|
|
|
|
@mock.patch("perfdocs.logger.PerfDocLogger")
|
|
def test_perfdocs_generator_create_temp_dir(logger, structured_logger, perfdocs_sample):
|
|
top_dir = perfdocs_sample["top_dir"]
|
|
setup_sample_logger(logger, structured_logger, top_dir)
|
|
|
|
from perfdocs.generator import Generator
|
|
from perfdocs.verifier import Verifier
|
|
|
|
verifier = Verifier(top_dir)
|
|
verifier.validate_tree()
|
|
|
|
generator = Generator(verifier, generate=True, workspace=top_dir)
|
|
tmpdir = generator._create_temp_dir()
|
|
|
|
assert os.path.isdir(tmpdir)
|
|
|
|
|
|
@mock.patch("perfdocs.generator.os")
|
|
@mock.patch("perfdocs.logger.PerfDocLogger")
|
|
def test_perfdocs_generator_create_temp_dir_fail(
|
|
logger, os, structured_logger, perfdocs_sample
|
|
):
|
|
top_dir = perfdocs_sample["top_dir"]
|
|
setup_sample_logger(logger, structured_logger, top_dir)
|
|
|
|
from perfdocs.generator import Generator
|
|
from perfdocs.verifier import Verifier
|
|
|
|
verifier = Verifier(top_dir)
|
|
verifier.validate_tree()
|
|
|
|
generator = Generator(verifier, generate=True, workspace=top_dir)
|
|
os.mkdir = mock.Mock(side_effect=OSError())
|
|
os.path.isdir.return_value = False
|
|
tmpdir = generator._create_temp_dir()
|
|
|
|
expected = "Error creating temp file: "
|
|
args, _ = logger.critical.call_args
|
|
|
|
assert not tmpdir
|
|
assert logger.critical.call_count == 1
|
|
assert args[0] == expected
|
|
|
|
|
|
@mock.patch("perfdocs.logger.PerfDocLogger")
|
|
def test_perfdocs_generator_save_perfdocs_pass(
|
|
logger, structured_logger, perfdocs_sample
|
|
):
|
|
top_dir = perfdocs_sample["top_dir"]
|
|
setup_sample_logger(logger, structured_logger, top_dir)
|
|
|
|
templates_dir = os.path.join(top_dir, "tools", "lint", "perfdocs", "templates")
|
|
os.makedirs(templates_dir)
|
|
|
|
from perfdocs.generator import Generator
|
|
from perfdocs.verifier import Verifier
|
|
|
|
verifier = Verifier(top_dir)
|
|
verifier.validate_tree()
|
|
|
|
generator = Generator(verifier, generate=True, workspace=top_dir)
|
|
|
|
assert not os.path.isdir(generator.perfdocs_path)
|
|
|
|
with temp_file("index.rst", tempdir=templates_dir, content="{test_documentation}"):
|
|
perfdocs_tmpdir = generator._create_perfdocs()
|
|
|
|
generator._save_perfdocs(perfdocs_tmpdir)
|
|
|
|
expected = ["index.rst", "mozperftest.rst"]
|
|
files = [f for f in os.listdir(generator.perfdocs_path)]
|
|
files.sort()
|
|
|
|
for i, file in enumerate(files):
|
|
assert file == expected[i]
|
|
|
|
|
|
@mock.patch("perfdocs.generator.shutil")
|
|
@mock.patch("perfdocs.logger.PerfDocLogger")
|
|
def test_perfdocs_generator_save_perfdocs_fail(
|
|
logger, shutil, structured_logger, perfdocs_sample
|
|
):
|
|
top_dir = perfdocs_sample["top_dir"]
|
|
setup_sample_logger(logger, structured_logger, top_dir)
|
|
|
|
templates_dir = os.path.join(top_dir, "tools", "lint", "perfdocs", "templates")
|
|
os.makedirs(templates_dir)
|
|
|
|
from perfdocs.generator import Generator
|
|
from perfdocs.verifier import Verifier
|
|
|
|
verifier = Verifier(top_dir)
|
|
verifier.validate_tree()
|
|
|
|
generator = Generator(verifier, generate=True, workspace=top_dir)
|
|
with temp_file("index.rst", tempdir=templates_dir, content="{test_documentation}"):
|
|
perfdocs_tmpdir = generator._create_perfdocs()
|
|
|
|
shutil.copytree = mock.Mock(side_effect=Exception())
|
|
generator._save_perfdocs(perfdocs_tmpdir)
|
|
|
|
expected = "There was an error while saving the documentation: "
|
|
args, _ = logger.critical.call_args
|
|
|
|
assert logger.critical.call_count == 1
|
|
assert args[0] == expected
|
|
|
|
|
|
if __name__ == "__main__":
|
|
mozunit.main()
|