1 files changed, 79 insertions, 0 deletions
diff --git a/tools/lint/perfdocs/perfdocs.py b/tools/lint/perfdocs/perfdocs.py
new file mode 100644
index 0000000000..3df01595c2
--- /dev/null
+++ b/tools/lint/perfdocs/perfdocs.py
@@ -0,0 +1,79 @@
+# 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, print_function
+
+import os
+import re
+
+
+def run_perfdocs(config, logger=None, paths=None, generate=True):
+    """
+    Build up performance testing documentation dynamically by combining
+    text data from YAML files that reside in `perfdoc` folders
+    across the `testing` directory. Each directory is expected to have
+    an `index.rst` file along with `config.yml` YAMLs defining what needs
+    to be added to the documentation.
+
+    The YAML must also define the name of the "framework" that should be
+    used in the main index.rst for the performance testing documentation.
+
+    The testing documentation list will be ordered alphabetically once
+    it's produced (to avoid unwanted shifts because of unordered dicts
+    and path searching).
+
+    Note that the suite name headings will be given the H4 (---) style so it
+    is suggested that you use H3 (===) style as the heading for your
+    test section. H5 will be used be used for individual tests within each
+    suite.
+
+    Usage for verification: ./mach lint -l perfdocs
+    Usage for generation: ./mach lint -l perfdocs --fix
+
+    For validation, see the Verifier class for a description of how
+    it works.
+
+    The run will fail if the valid result from validate_tree is not
+    False, implying some warning/problem was logged.
+
+    :param dict config: The configuration given by mozlint.
+    :param StructuredLogger logger: The StructuredLogger instance to be used to
+        output the linting warnings/errors.
+    :param list paths: The paths that are being tested. Used to filter
+        out errors from files outside of these paths.
+    :param bool generate: If true, the docs will be (re)generated.
+    """
+    from perfdocs.logger import PerfDocLogger
+
+    top_dir = os.environ.get("WORKSPACE", None)
+    if not top_dir:
+        floc = os.path.abspath(__file__)
+        top_dir = floc.split("tools")[0]
+    top_dir = top_dir.replace("\\", "\\\\")
+
+    PerfDocLogger.LOGGER = logger
+    PerfDocLogger.TOP_DIR = top_dir
+
+    # Convert all the paths to relative ones
+    rel_paths = [re.sub(top_dir, "", path) for path in paths]
+    PerfDocLogger.PATHS = rel_paths
+
+    target_dir = [os.path.join(top_dir, i) for i in rel_paths]
+    for path in target_dir:
+        if not os.path.exists(path):
+            raise Exception("Cannot locate directory at %s" % path)
+
+    # Late import because logger isn't defined until later
+    from perfdocs.generator import Generator
+    from perfdocs.verifier import Verifier
+
+    # Run the verifier first
+    verifier = Verifier(top_dir)
+    verifier.validate_tree()
+
+    if not PerfDocLogger.FAILED:
+        # Even if the tree is valid, we need to check if the documentation
+        # needs to be regenerated, and if it does, we throw a linting error.
+        # `generate` dictates whether or not the documentation is generated.
+        generator = Generator(verifier, generate=generate, workspace=top_dir)
+        generator.generate_perfdocs()