Skip to content
5 changes: 5 additions & 0 deletions web/client/codechecker_client/cmd/cmd.py
Original file line number Diff line number Diff line change
Expand Up @@ -1298,6 +1298,11 @@ def add_arguments_to_parser(parser):
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
description="List the analysis runs available on the server.",
help="List the available analysis runs.")

runs.add_argument(
'--enabled-checkers',
action='store_true',
help='List all enabled checkers for the specified runs.')
__register_runs(runs)
runs.set_defaults(func=cmd_line_client.handle_list_runs)
__add_common_arguments(runs, output_formats=DEFAULT_OUTPUT_FORMATS)
Expand Down
44 changes: 44 additions & 0 deletions web/client/codechecker_client/cmd_line_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import sys
import shutil
import time
import json
from typing import Dict, Iterable, List, Optional, Set, Tuple

from codechecker_api.codeCheckerDBAccess_v6 import constants, ttypes
Expand Down Expand Up @@ -639,6 +640,48 @@ def handle_list_runs(args):

runs = get_run_data(client, run_filter, sort_mode)

if hasattr(args, 'enabled_checkers') and args.enabled_checkers:
enabled_checkers: Dict[str, List[str]] = {}
for run in runs:
info_list: List[ttypes.AnalysisInfo] = client.getAnalysisInfo(
ttypes.AnalysisInfoFilter(runId=run.runId),
constants.MAX_QUERY_SIZE,
0)
for info in info_list:
analyzers = info.checkers.keys()
for analyzer in analyzers:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
analyzers = info.checkers.keys()
for analyzer in analyzers:
for analyzer in info.checkers:

if analyzer not in enabled_checkers:
enabled_checkers[analyzer] = []

checkers = info.checkers.get(analyzer, {})
for checker in checkers:
if checkers[checker].enabled:
enabled_checkers[analyzer].append(checker)

if args.output_format == 'plaintext':
for analyzer, checkers in enabled_checkers.items():
print(analyzer + ":")
for checker in checkers:
print(" " + checker)
elif args.output_format == 'csv':
separator = ';'
print("Analyzer" + separator + "Checker")
for analyzer, checkers in enabled_checkers.items():
for checker in checkers:
print(analyzer + separator + checker)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please, use the standard csv module instead.

elif args.output_format == 'json':
print(json.dumps(enabled_checkers, indent=4))
elif args.output_format == 'table':
header = ['Analyzer', 'Checker']
rows = [
(analyzer, checker)
for analyzer, checkers in enabled_checkers.items()
for checker in checkers]
print(twodim.to_str(args.output_format, header, rows))
else:
LOG.error("Unsupported output format: %s", args.output_format)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of introducing a separate if block for enabled_checkers handling, consider integrating it into the existing structure, similar to how 'details' is handled. This avoids redundant checks on args.output_format.
Additionally, rather than using direct print statements for plaintext and CSV formats, it would be better to use twodim.to_str() for consistency with the existing output formatting.

return
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding return here is totally unnecessary.

Suggested change
return

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xb058t Please do as @cservakt suggested and merge the enabled-checkers processing starting at line 684.

Also please add the enabled checkers list when CodeChecker cmd runs --details -o json is invoked by the user.

[INFO 2026-02-13 15:50] - Checking for local valid sessions.
[
{
"tinyxmls" : {
"analyzerStatistics" : {
"clang-tidy" : {
"enabledCheckers":["checker1","checker2"]
"failed" : 0,
"failedFilePaths" : [],
"successful" : 2,
"version" : "18.1.3"
},
`


if args.output_format == 'json':
# This json is different from the json format printed by the
# parse command. This json converts the ReportData type report
Expand Down Expand Up @@ -682,6 +725,7 @@ def handle_list_runs(args):
codechecker_version))

print(twodim.to_str(args.output_format, header, rows))
return
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The explicit 'return' at the end of the function is unnecessary in Python.

Suggested change
return



def handle_list_results(args):
Expand Down
4 changes: 4 additions & 0 deletions web/client/codechecker_client/helpers/results.py
Original file line number Diff line number Diff line change
Expand Up @@ -196,3 +196,7 @@ def getAnalysisStatistics(self, run_id, run_history_id):
@thrift_client_call
def storeAnalysisStatistics(self, run_name, zip_file):
pass

@thrift_client_call
def getAnalysisInfo(self, analysis_info_filter, limit, offset):
pass