def uninstall_autorun(context: Context) -> None:
"""
Configures Bento to NOT run automatically on commits.
Autorun is only removed for the project from which this
command is run.
"""
import git # import inside def for performance
# Get hook path
repo = bento.git.repo(context.base_path)
if repo is None:
raise NotAGitRepoException()
hook_path = Path(git.index.fun.hook_path("pre-commit", repo.git_dir))
if not _is_bento_precommit(hook_path):
echo_warning(
"Not uninstalling autorun: Bento is not configured for autorun on this project."
)
sys.exit(1)
else:
# Put back legacy hook if exits
legacy_hook_path = Path(f"{hook_path}.pre-bento")
if legacy_hook_path.exists():
shutil.move(legacy_hook_path, hook_path)
else:
hook_path.unlink()
echo_success("Uninstalled Bento autorun.")
echo_next_step("To enable autorun", "bento enable autorun")
def __log_exception(e: Exception) -> None:
logging.exception(e)
if isinstance(e, subprocess.CalledProcessError):
cmd = e.cmd
if isinstance(e.cmd, list):
cmd = " ".join([str(part) for part in e.cmd])
echo_warning(f'Could not execute "{cmd}":\n{e.stderr}')
logging.error(e.stdout)
logging.error(e.stderr)
else:
echo_error(f"There was an exception {e}")
def orchestrate(
baseline: Baseline,
target_file_manager: TargetFileManager,
staged: bool,
tools: Iterable[Tool],
) -> Tuple[Collection[RunResults], float]:
"""
Manages interactions between TargetFileManager, Runner and Tools
Uses passed target_file_manager, staged flag, and tool list to setup
Runner and runs tools on relevant files, returning aggregated output
of tool running and time to run all tools in parallel
"""
elapsed = 0.0
if staged:
head_baseline, elapsed = _calculate_head_comparison(
target_file_manager, tools)
for t in tools:
tool_id = t.tool_id()
if tool_id not in baseline:
baseline[tool_id] = head_baseline.get(tool_id, set())
else:
baseline[tool_id].update(head_baseline.get(tool_id, set()))
with target_file_manager.run_context(staged,
RunStep.CHECK) as target_paths:
use_cache = not staged # if --all then can use cache
skip_setup = staged # if check --all then include setup
runner = Runner(paths=target_paths,
use_cache=use_cache,
skip_setup=skip_setup)
if len(runner.paths) == 0:
echo_warning(
f"Nothing to check or archive. Please confirm that changes are staged and not excluded by `{IGNORE_FILE_NAME}`. To check all Git tracked files, use `--all`."
)
click.secho("", err=True)
all_results: Collection[RunResults] = []
elapsed = 0.0
else:
before = time.time()
all_results = runner.parallel_results(tools, baseline)
elapsed += time.time() - before
return all_results, elapsed
def orchestrate(context: Context, target_paths: List[Path], staged: bool,
tools: Iterable[Tool]) -> Tuple[Collection[RunResults], float]:
baseline, elapsed = _calculate_baseline(context, target_paths, staged,
tools)
with run_context(context, target_paths, staged, RunStep.CHECK) as runner:
if len(runner.paths) == 0:
echo_warning(
f"Nothing to check or archive. Please confirm that changes are staged and not excluded by `{IGNORE_FILE_NAME}`. To check all Git tracked files, use `--all`."
)
click.secho("", err=True)
all_results: Collection[bento.tool_runner.RunResults] = []
elapsed = 0.0
else:
before = time.time()
all_results = runner.parallel_results(tools, baseline)
elapsed += time.time() - before
return all_results, elapsed
def uninstall_ci(context: Context) -> None:
"""
Configures Bento to NOT run in CI.
"""
repo = bento.git.repo(context.base_path)
if repo is None:
raise NotAGitRepoException()
if not context.gh_actions_file_path.exists():
echo_warning(
"Not uninstalling CI config: Bento is not configured for CI on this project."
)
sys.exit(1)
_delete_gh_actions_config(path=context.gh_actions_file_path,
root_path=context.base_path)
echo_success("Uninstalled Bento from CI.")
echo_next_step("To re-enable CI integration", "bento enable ci")
def open_ignores(base_path: Path,
ignore_path: Path,
is_init: bool = False) -> FileIgnore:
"""
Opens this project's ignore file
"""
if not ignore_path.exists():
if not is_init:
echo_warning(
f"""'{os.path.relpath(ignore_path, os.getcwd())}' not found; using default ignore patterns.
Please run 'bento init' to configure a .bentoignore for your project.
""")
ignore_path = Path(
os.path.dirname(__file__)) / "configs" / ".bentoignore"
logging.info(
f"Loading bento file ignores from {os.path.abspath(ignore_path)}")
with ignore_path.open() as ignore_lines:
patterns = Parser(base_path, ignore_path).parse(ignore_lines)
return FileIgnore(base_path=base_path, patterns=patterns)
def check(
context: Context,
all_: bool = False,
formatter: Tuple[str, ...] = (),
pager: bool = True,
tool: Optional[str] = None,
staged_only: bool = False, # Should not be used. Legacy support for old pre-commit hooks
paths: Tuple[Path, ...] = (),
) -> None:
"""
Checks for new findings.
By default, only staged files are checked. New findings introduced by
these staged changes AND that are not in the archive (`.bento/archive.json`)
will be shown.
Use `--all` to check all Git tracked files, not just those that are staged:
$ bento check --all [PATHS]
Optional PATHS can be specified to check specific directories or files.
See `bento archive --help` to learn about suppressing findings.
"""
# Fail out if not configured
if not context.config_path.exists():
raise NoConfigurationException()
# Fail out if no .bentoignore
if not context.ignore_file_path.exists():
raise NoIgnoreFileException(context)
# Default to no path filter
if len(paths) < 1:
path_list = [context.base_path]
else:
path_list = list(paths)
# Handle specified tool that is not configured
if tool and tool not in context.configured_tools:
click.echo(
f"{tool} has not been configured. Adding default configuration for tool to {bento.constants.CONFIG_FILE_NAME}"
)
update_tool_run(context, tool, False)
# Set configured_tools to None so that future calls will
# update and include newly added tool
context._configured_tools = None
# Handle specified formatters
if formatter:
context.config["formatter"] = [{f: {}} for f in formatter]
if all_:
click.echo(f"Running Bento checks on all tracked files...\n", err=True)
else:
click.echo(f"Running Bento checks on staged files...\n", err=True)
tools: Iterable[Tool[Any]] = context.tools.values()
if tool:
tools = [context.configured_tools[tool]]
baseline: Baseline = {}
if context.baseline_file_path.exists():
with context.baseline_file_path.open() as json_file:
baseline = bento.result.json_to_violation_hashes(json_file)
target_file_manager = TargetFileManager(
context.base_path, path_list, not all_, context.ignore_file_path
)
all_results, elapsed = bento.orchestrator.orchestrate(
baseline, target_file_manager, not all_, tools
)
fmts = context.formatters
findings_to_log: List[Any] = []
n_all = 0
n_all_filtered = 0
filtered_findings: Dict[str, List[Violation]] = {}
for tool_id, findings in all_results:
if isinstance(findings, Exception):
logging.error(findings)
echo_error(f"Error while running {tool_id}: {findings}")
if isinstance(findings, BentoException):
click.secho(findings.msg, err=True)
else:
if isinstance(findings, subprocess.CalledProcessError):
click.secho(findings.stderr, err=True)
click.secho(findings.stdout, err=True)
if isinstance(findings, NodeError):
echo_warning(
f"Node.js not found or version is not compatible with ESLint v6."
)
click.secho(
f"""-------------------------------------------------------------------------------------------------
This may be due to a corrupted tool installation. You might be able to fix this issue by running:
bento init --clean
You can also view full details of this error in `{bento.constants.DEFAULT_LOG_PATH}`.
-------------------------------------------------------------------------------------------------
""",
err=True,
)
context.error_on_exit(ToolRunException())
elif isinstance(findings, list) and findings:
findings_to_log += bento.metrics.violations_to_metrics(
tool_id,
context.timestamp,
findings,
__get_ignores_for_tool(tool_id, context.config),
)
filtered = [f for f in findings if not f.filtered]
filtered_findings[tool_id] = filtered
n_all += len(findings)
n_filtered = len(filtered)
n_all_filtered += n_filtered
logging.debug(f"{tool_id}: {n_filtered} findings passed filter")
def post_metrics() -> None:
bento.network.post_metrics(findings_to_log, is_finding=True)
stats_thread = threading.Thread(name="stats", target=post_metrics)
stats_thread.start()
dumped = [f.dump(filtered_findings) for f in fmts]
context.start_user_timer()
bento.util.less(dumped, pager=pager, overrun_pages=OVERRUN_PAGES)
context.stop_user_timer()
finding_source_text = "in this project" if all_ else "due to staged changes"
if n_all_filtered > 0:
echo_warning(
f"{n_all_filtered} finding(s) {finding_source_text} in {elapsed:.2f} s"
)
click.secho("\nPlease fix these issues, or:\n", err=True)
echo_next_step("To archive findings as tech debt", f"bento archive")
echo_next_step("To disable a specific check", f"bento disable check TOOL CHECK")
else:
echo_success(f"0 findings {finding_source_text} in {elapsed:.2f} s\n")
n_archived = n_all - n_all_filtered
if n_archived > 0:
echo_next_step(
f"Not showing {n_archived} archived finding(s). To view",
"cat .bento/archive.json",
)
if not all_ and not context.autorun_is_blocking:
return
elif context.on_exit_exception:
raise context.on_exit_exception
elif n_all_filtered > 0:
sys.exit(2)
def check(
context: Context,
formatter: Tuple[str, ...] = (),
pager: bool = True,
show_all: bool = False,
staged_only: bool = False,
tool: Optional[str] = None,
paths: Optional[List[str]] = None,
) -> None:
"""
Checks for new findings.
Only findings not previously archived will be displayed (use --show-all
to display archived findings).
By default, 'bento check' will check the entire project. To run
on one or more paths only, run:
bento check path1 path2 ...
"""
if tool and tool not in context.configured_tools:
click.echo(
f"{tool} has not been configured. Adding default configuration for tool to .bento.yml"
)
update_tool_run(context, tool, False)
# Set configured_tools to None so that future calls will
# update and include newly added tool
context._configured_tools = None
if not context.config_path.exists():
echo_error("No Bento configuration found. Please run `bento init`.")
sys.exit(3)
if not show_all and context.baseline_file_path.exists():
with context.baseline_file_path.open() as json_file:
baseline = bento.result.yml_to_violation_hashes(json_file)
else:
baseline = {}
config = context.config
if formatter:
config["formatter"] = [{f: {}} for f in formatter]
fmts = context.formatters
findings_to_log: List[Any] = []
click.echo("Running Bento checks...\n", err=True)
ctx = noop_context()
if paths and len(paths) > 0:
if staged_only:
raise Exception(
"--staged_only should not be used with explicit paths")
elif staged_only:
ctx = staged_files_only(
os.path.join(os.path.expanduser("~"), ".cache", "bento",
"patches"))
paths = get_staged_files()
else:
paths = None
with ctx:
before = time.time()
runner = bento.tool_runner.Runner()
tools: Iterable[Tool[Any]] = context.tools.values()
if tool:
tools = [context.configured_tools[tool]]
all_results = runner.parallel_results(tools, baseline, paths)
elapsed = time.time() - before
# Progress bars terminate on whitespace
echo_newline()
is_error = False
n_all = 0
n_all_filtered = 0
filtered_findings: Dict[str, List[Violation]] = {}
for tool_id, findings in all_results:
if isinstance(findings, Exception):
logging.error(findings)
echo_error(f"Error while running {tool_id}: {findings}")
if isinstance(findings, subprocess.CalledProcessError):
click.secho(findings.stderr, err=True)
click.secho(findings.stdout, err=True)
if isinstance(findings, NodeError):
echo_warning(
f"Node.js not found or version is not compatible with ESLint v6."
)
click.secho(
f"""-------------------------------------------------------------------------------------------------
This may be due to a corrupted tool installation. You might be able to fix this issue by running:
bento init --clean
You can also view full details of this error in `{bento.constants.DEFAULT_LOG_PATH}`.
-------------------------------------------------------------------------------------------------
""",
err=True,
)
is_error = True
elif isinstance(findings, list) and findings:
findings_to_log += bento.metrics.violations_to_metrics(
tool_id,
context.timestamp,
findings,
__get_ignores_for_tool(tool_id, config),
)
filtered = [f for f in findings if not f.filtered]
filtered_findings[tool_id] = filtered
n_all += len(findings)
n_filtered = len(filtered)
n_all_filtered += n_filtered
logging.debug(f"{tool_id}: {n_filtered} findings passed filter")
def post_metrics() -> None:
bento.network.post_metrics(findings_to_log, is_finding=True)
stats_thread = threading.Thread(name="stats", target=post_metrics)
stats_thread.start()
if n_all_filtered > 0:
dumped = [f.dump(filtered_findings) for f in fmts]
context.start_user_timer()
bento.util.less(dumped, pager=pager, overrun_pages=OVERRUN_PAGES)
context.stop_user_timer()
echo_warning(f"{n_all_filtered} finding(s) in {elapsed:.2f} s\n")
if not context.is_init:
echo_next_step("To suppress all findings", "bento archive")
else:
echo_success(f"0 findings in {elapsed:.2f} s\n")
n_archived = n_all - n_all_filtered
if n_archived > 0 and not show_all:
echo_next_step(
f"Not showing {n_archived} archived finding(s). To view",
f"bento check {SHOW_ALL}",
)
if is_error:
sys.exit(3)
elif n_all_filtered > 0:
sys.exit(2)
