Addition of Saving and Loading of Filter Presets

codechecker_common/util.py

@@ -223,6 +223,23 @@ def generate_random_token(num_bytes: int = 32) -> str:
     return hash_value[idx:(idx + num_bytes)]
 
 
+def thrift_to_json(obj):
+    """
+    Recursively convert a Thrift object (or any object with __dict__)
+    into a JSON-serializable dict, skipping None-valued fields.
+    """
+    if obj is None or isinstance(obj, (str, int, float, bool)):
+        return obj
+    if isinstance(obj, list):
+        return [thrift_to_json(x) for x in obj]
+    if isinstance(obj, dict):
+        return {k: thrift_to_json(v) for k, v in obj.items()}
+    if hasattr(obj, '__dict__'):
+        return {k: thrift_to_json(v) for k, v in obj.__dict__.items()
+                if v is not None}
+    return str(obj)
+
+
 def format_size(num: float, suffix: str = 'B') -> str:
     """
     Pretty print storage units.

docs/web/user_guide.md

@@ -28,6 +28,11 @@
       - [List runs (`runs`)](#list-runs-runs)
       - [List of run histories (`history`)](#list-of-run-histories-history)
       - [List analysis results' summary (`results`)](#list-analysis-results-summary-results)
+      - [Manage filter presets (`filter-preset`)](#manage-filter-presets-filter-preset)
+        - [Creating a filter preset](#creating-a-filter-preset)
+        - [Listing filter presets](#listing-filter-presets)
+        - [Deleting a filter preset](#deleting-a-filter-preset)
+        - [Applying a filter preset to results](#applying-a-filter-preset-to-results)
         - [Example](#example-1)
       - [Show differences between two runs (`diff`)](#show-differences-between-two-runs-diff)
       - [Show summarised count of results (`sum`)](#show-summarised-count-of-results-sum)
@@ -1122,7 +1127,100 @@ CodeChecker cmd results my_run --severity critical high medium \
 
 # Get detailed analysis results for a run in JSON format.
 CodeChecker cmd results -o json --details my_run
+
+# Get analysis results using a saved filter preset:
+CodeChecker cmd results my_run --filter-preset my_preset \
+    --url <PRODUCT_URL>
+```
+
+#### Manage filter presets (`filter-preset`)
+
+Filter presets allow you to save a named set of filter parameters on the
+server so they can be reused across multiple queries without having to
+specify all the filter flags every time.
+
+A preset stores any combination of the filter arguments available to
+`cmd results` (severity, checker name, file path, detection status, etc.).
+
+##### Creating a filter preset
+
 ```
+# Create a minimal preset that filters by severity:
+CodeChecker cmd filter-preset new \
+    --name "high_and_critical" \
+    --url <PRODUCT_URL> \
+    --severity critical high
+
+# Create a preset with many filter parameters:
+CodeChecker cmd filter-preset new \
+    --name "FullPreset" \
+    --url <PRODUCT_URL> \
+    --severity critical high medium low style unspecified \
+    --review-status unreviewed confirmed false_positive intentional \
+    --detection-status new reopened unresolved resolved off unavailable \
+    --report-status outstanding closed \
+    --file "*/src/*.cpp" "*/include/*.h" \
+    --checker-name "deadcode.DeadStores" "core.NullDereference" \
+    --checker-msg "*null pointer*" "*memory leak*" \
+    --analyzer-name clangsa clang-tidy \
+    --component myComponent \
+    --tag v1.0 v2.0 \
+    --report-hash "abcdef1234567890" \
+    --bug-path-length "1:50" \
+    --detected-before "2026:03:09:00:00:00" \
+    --detected-after "2025:01:01:00:00:00" \
+    --fixed-before "2026:03:09:00:00:00" \
+    --fixed-after "2025:06:01:00:00:00" \
+    --outstanding-reports-date "2026:03:01:00:00:00" \
+    --anywhere-on-report-path \
+    --single-origin-report \
+    --uniqueing off
+```
+
+Preset names must be unique. Attempting to create a preset with an
+already-existing name will fail.
+
+##### Listing filter presets
+
+```
+# List all presets (default table output):
+CodeChecker cmd filter-preset list \
+    --url <PRODUCT_URL>
+
+# List presets in CSV format:
+CodeChecker cmd filter-preset list \
+    --url <PRODUCT_URL> \
+    --output csv
+
+# List presets in JSON format:
+CodeChecker cmd filter-preset list \
+    --url <PRODUCT_URL> \
+    --output json
+```
+
+##### Deleting a filter preset
+
+You can find the preset ID by [listing filter presets](#listing-filter-presets).
+
+```
+# Delete a preset by its ID (shown in the list output):
+CodeChecker cmd filter-preset delete \
+    --id 1 \
+    --url <PRODUCT_URL>
+```
+
+##### Applying a filter preset to results
+
+Use the `--filter-preset` flag with `cmd results` to apply a saved preset:
+
+```
+CodeChecker cmd results my_run \
+    --filter-preset "high_and_critical" \
+    --url <PRODUCT_URL>
+```
+
+**Note:** `--filter-preset` cannot be combined with other filter arguments.
+Either use a preset or specify filters on the command line, not both.
 
 #### Show differences between two runs (`diff`)
 

web/api/js/codechecker-api-node/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codechecker-api",
-  "version": "6.67.0",
+  "version": "6.68.0",
   "description": "Generated node.js compatible API stubs for CodeChecker server.",
   "main": "lib",
   "homepage": "https://github.com/Ericsson/codechecker",

web/api/py/codechecker_api/setup.py

@@ -8,7 +8,7 @@
 with open('README.md', encoding='utf-8', errors="ignore") as f:
     long_description = f.read()
 
-api_version = '6.67.0'
+api_version = '6.68.0'
 
 setup(
     name='codechecker_api',

web/api/py/codechecker_api_shared/setup.py

@@ -8,7 +8,7 @@
 with open('README.md', encoding='utf-8', errors="ignore") as f:
     long_description = f.read()
 
-api_version = '6.67.0'
+api_version = '6.68.0'
 
 setup(
     name='codechecker_api_shared',

web/api/report_server.thrift

@@ -406,6 +406,12 @@ struct ReportFilter {
   24: optional bool fullReportPathInComponent,
 }
 
+struct FilterPreset {
+  1: i64          id,           // Unique ID of "FilterPreset".
+  2: string       name,         // Human readable name of preset.
+  3: ReportFilter reportFilter  // Uniquely configured ReportFilter.
+}
+
 struct RunReportCount {
   1: i64            runId,        // Unique ID of the run.
   2: string         name,         // Human readable name of the run.
@@ -583,6 +589,40 @@ service codeCheckerDBAccess {
                          4: optional RunSortMode sortMode)
                          throws (1: codechecker_api_shared.RequestFailed requestError),
 
+  //============================================
+  // Filter grouping api calls.
+  //============================================
+
+  // Stores the given FilterPreset with the given id
+  // If the preset exists with the given id, it overwrites the name, and all preset values
+  // If the preset does not exist yet, throws and error
+  // If the id is -1 a new preset filter is created and the id of the new preset is returned.
+  // If a preset with that name already existed, it throws an error. Thus the "FilterPreset" name must be unique.
+  // The encoding of the name must be unicode. (whitespaces allowed)
+  // Maximum "FilterPreset" name 50
+  // Returns: the id of the modified or created preset
+  // PERMISSION: PRODUCT_ADMIN
+  i64 storeFilterPreset(1: FilterPreset preset)
+                      throws (1: codechecker_api_shared.RequestFailed requestError);
+
+  // Returns the "FilterPreset" identified by id
+  // Throws and error in case there is no preset with the given id
+  // PERMISSION: PRODUCT_VIEW
+  FilterPreset getFilterPreset(1: i64 id)
+                            throws (1: codechecker_api_shared.RequestFailed requestError);
+
+  // Removes the FilterPreset with the given id
+  // Returns the id of the "FilterPreset" removed
+  // Throws an error if the preset with the given id does not exist.
+  // PERMISSION: PRODUCT_ADMIN
+  i64 deleteFilterPreset(1: i64 id)
+                        throws (1: codechecker_api_shared.RequestFailed requestError);
+
+  // Returns all "FilterPreset"s stored for the product repository
+  // PERMISSION: PRODUCT_VIEW
+  list <FilterPreset> listFilterPreset()
+                                    throws (1: codechecker_api_shared.RequestFailed requestError);
+
   // Returns the number of available runs based on the run filter parameter.
   // PERMISSION: PRODUCT_VIEW
   i64 getRunCount(1: RunFilter runFilter)

web/client/codechecker_client/cli/cmd.py

@@ -25,18 +25,13 @@
     product_client, \
     source_component_client, \
     task_client, \
-    token_client
+    token_client, \
+    filter_preset_client
+from codechecker_client.filter_defaults import DEFAULT_FILTER_VALUES
 
 from codechecker_common import arg, logger, util
 from codechecker_common.output import USER_FORMATS
 
-DEFAULT_FILTER_VALUES = {
-    'review_status': ['unreviewed', 'confirmed'],
-    'detection_status': ['new', 'reopened', 'unresolved'],
-    'uniqueing': 'off',
-    'anywhere_on_report_path': False,
-    'single_origin_report': False
-}
 
 DEFAULT_OUTPUT_FORMATS = ["plaintext"] + USER_FORMATS
 
@@ -448,6 +443,32 @@ def init_default(dest):
                               "entirely in the files specified by the "
                               "given --component.")
 
+    f_group.add_argument('--report-status',
+                         nargs='*',
+                         dest="report_status",
+                         metavar='REPORT_STATUS',
+                         default=init_default('report_status'),
+                         help="R|Filter results by report statuses.\n"
+                              "Reports can be assigned a report status of the "
+                              "following values:\n"
+                              "- Outstanding: Currently detected and still unresolved reports.\n"
+                              "- Closed: Reports marked as fixed, false positive, or otherwise resolved.\n" +
+                              warn_diff_mode)
+
+
+def __add_filter_preset_argument(parser):
+    """Add the --filter-preset argument to the given parser."""
+    parser.add_argument('--filter-preset',
+                        type=str,
+                        dest='filter_preset_name',
+                        metavar='PRESET_NAME',
+                        required=False,
+                        default=argparse.SUPPRESS,
+                        help="Use a pre-configured filter preset. The preset "
+                             "is loaded from the server and applied to the "
+                             "results. Use 'CodeChecker cmd filter-preset "
+                             "list' to see available presets.")
+
 
 def __register_results(parser):
     """
@@ -478,6 +499,7 @@ def __register_results(parser):
                              "events, bug report points etc.")
 
     __add_filtering_arguments(parser, DEFAULT_FILTER_VALUES)
+    __add_filter_preset_argument(parser)
 
 
 def __register_diff(parser):
@@ -543,6 +565,7 @@ def __register_diff(parser):
                              "the reported defect.")
 
     __add_filtering_arguments(parser, DEFAULT_FILTER_VALUES, True)
+    __add_filter_preset_argument(parser)
 
     group = parser.add_argument_group(
         "comparison modes",
@@ -623,6 +646,7 @@ def __register_sum(parser):
     default_filter_values = DEFAULT_FILTER_VALUES
     default_filter_values['uniqueing'] = 'on'
     __add_filtering_arguments(parser, default_filter_values)
+    __add_filter_preset_argument(parser)
 
 
 def __register_delete(parser):
@@ -1530,6 +1554,62 @@ def __register_del(parser):
     __add_common_arguments(del_t, needs_product_url=False)
 
 
+def __register_filter_presets(parser):
+    """
+    Add argparse subcommand parser for the "filter preset management" action.
+    """
+
+    def __register_new(parser):
+        parser.add_argument('--name',
+                            type=str,
+                            dest='preset_name',
+                            required=True,
+                            metavar='PRESET_NAME',
+                            help="Name of the filter preset to create.")
+        __add_filtering_arguments(parser)
+
+    def __register_delete(parser):
+        """
+        Add argparse subcommand parser for the "delete preset" action.
+        """
+        parser.add_argument('--id',
+                            type=int,
+                            dest='preset_id',
+                            required=True,
+                            metavar='PRESET_ID',
+                            help="ID of the filter preset to delete.")
+
+    subcommands = parser.add_subparsers(title='available actions')
+
+    # Create handlers for individual subcommands.
+    list_presets = subcommands.add_parser(
+        'list',
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+        description="List all filter presets available on the server.",
+        help="List all filter presets.")
+    list_presets.set_defaults(func=filter_preset_client.handle_list_presets)
+    __add_common_arguments(list_presets,
+                           output_formats=DEFAULT_OUTPUT_FORMATS)
+
+    new_preset = subcommands.add_parser(
+        'new',
+        formatter_class=arg.RawDescriptionDefaultHelpFormatter,
+        description="Create a new filter preset.",
+        help="Create a new filter preset.")
+    __register_new(new_preset)
+    new_preset.set_defaults(func=filter_preset_client.handle_new_preset)
+    __add_common_arguments(new_preset)
+
+    delete_preset = subcommands.add_parser(
+        'delete',
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+        description="Delete a filter preset from the server.",
+        help="Delete a filter preset.")
+    __register_delete(delete_preset)
+    delete_preset.set_defaults(func=filter_preset_client.handle_delete_preset)
+    __add_common_arguments(delete_preset)
+
+
 def add_arguments_to_parser(parser):
     """
     Add the subcommand's arguments to the given argparse.ArgumentParser.
@@ -1820,5 +1900,18 @@ def add_arguments_to_parser(parser):
     tasks.set_defaults(func=task_client.handle_tasks)
     __add_common_arguments(tasks, needs_product_url=False)
 
+    filter_preset = subcommands.add_parser(
+        'filter-preset',
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+        description="Manage filter presets of a CodeChecker server. "
+                    "Filter presets are named collections of filter "
+                    "configurations that can be applied to the analysis "
+                    "results of a run. Please see the individual "
+                    "subcommands for details.",
+        help="Access subcommands related to configuring filter presets of a "
+             "CodeChecker server.")
+    __register_filter_presets(filter_preset)
+    __add_common_arguments(filter_preset)
+
 # 'cmd' does not have a main() method in itself, as individual subcommands are
 # handled later on separately.