mirror of
https://github.com/github/codeql.git
synced 2025-12-17 01:03:14 +01:00
2cd58817d7
This is a developer QoL improvement, where running codegen will skip writing (and especially formatting) any files that were not changed. **Why?** While code generation in itself was pretty much instant, QL formatting of generated code was starting to take a long time. This made unconditionally running codegen quite annoying, for example before each test run as part of an IDE workflow or as part of the pre-commit hook. **How?** This was not completely straightforward as we could not work with the contents of the file prior to code generation as that was already post-processed by the QL formatting, so we had no chance of comparing the output of template rendering with that. We therefore store the hashes of the files _prior_ to QL formatting in a checked-in file (`swift/ql/.generated.list`). We can therefore load those hashes at the beginning of code generation, use them to compare the template rendering output and update them in this special registry file. **What else?** We also extend this mechanism to detect accidental modification of generated files in a more robust way. Before this patch, we were doing it with a rough regexp based heuristic. Now, we just store the hashes of the files _after_ QL formatting in the same checked file, so we can check that and stop generation if a generated file was modified, or a stub was modified without removing the `// generated` header.
67 lines
3.4 KiB
Python
Executable File
67 lines
3.4 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
""" Driver script to run all code generation """
|
|
|
|
import argparse
|
|
import logging
|
|
import pathlib
|
|
import sys
|
|
import importlib
|
|
import types
|
|
import typing
|
|
|
|
from swift.codegen.lib import render, paths
|
|
from swift.codegen.generators import generate
|
|
|
|
|
|
def _parse_args() -> argparse.Namespace:
|
|
p = argparse.ArgumentParser(description="Code generation suite")
|
|
p.add_argument("--generate", type=lambda x: x.split(","), default=["dbscheme", "ql"],
|
|
help="specify what targets to generate as a comma separated list, choosing among dbscheme, ql, trap "
|
|
"and cpp")
|
|
p.add_argument("--verbose", "-v", action="store_true", help="print more information")
|
|
p.add_argument("--quiet", "-q", action="store_true", help="only print errors")
|
|
p.add_argument("--swift-dir", type=_abspath, default=paths.swift_dir,
|
|
help="the directory that should be regarded as the root of the swift codebase. Used to compute QL "
|
|
"imports and in some comments (default %(default)s)")
|
|
p.add_argument("--schema", type=_abspath, default=paths.swift_dir / "schema.py",
|
|
help="input schema file (default %(default)s)")
|
|
p.add_argument("--dbscheme", type=_abspath, default=paths.swift_dir / "ql/lib/swift.dbscheme",
|
|
help="output file for dbscheme generation, input file for trap generation (default %(default)s)")
|
|
p.add_argument("--ql-output", type=_abspath, default=paths.swift_dir / "ql/lib/codeql/swift/generated",
|
|
help="output directory for generated QL files (default %(default)s)")
|
|
p.add_argument("--ql-stub-output", type=_abspath, default=paths.swift_dir / "ql/lib/codeql/swift/elements",
|
|
help="output directory for QL stub/customization files (default %(default)s). Defines also the "
|
|
"generated qll file importing every class file")
|
|
p.add_argument("--ql-test-output", type=_abspath, default=paths.swift_dir / "ql/test/extractor-tests/generated",
|
|
help="output directory for QL generated extractor test files (default %(default)s)")
|
|
p.add_argument("--ql-format", action="store_true", default=True,
|
|
help="use codeql to autoformat QL files (which is the default)")
|
|
p.add_argument("--no-ql-format", action="store_false", dest="ql_format", help="do not format QL files")
|
|
p.add_argument("--codeql-binary", default="codeql", help="command to use for QL formatting (default %(default)s)")
|
|
p.add_argument("--cpp-output", type=_abspath,
|
|
help="output directory for generated C++ files, required if trap or cpp is provided to --generate")
|
|
p.add_argument("--generated-registry", type=_abspath, default=paths.swift_dir / "ql/.generated.list",
|
|
help="registry file containing information about checked-in generated code")
|
|
return p.parse_args()
|
|
|
|
|
|
def _abspath(x: str) -> typing.Optional[pathlib.Path]:
|
|
return pathlib.Path(x).resolve() if x else None
|
|
|
|
|
|
def run():
|
|
opts = _parse_args()
|
|
if opts.verbose:
|
|
log_level = logging.DEBUG
|
|
elif opts.quiet:
|
|
log_level = logging.ERROR
|
|
else:
|
|
log_level = logging.INFO
|
|
logging.basicConfig(format="{levelname} {message}", style='{', level=log_level)
|
|
for target in opts.generate:
|
|
generate(target, opts, render.Renderer(opts.swift_dir))
|
|
|
|
|
|
if __name__ == "__main__":
|
|
run()
|