[feat] Introduce chronological order for dynamic reports

Reports' can be assigned some labels. It is useful especially for
dynamic analyzer reports for storing their timestamps or test cases
during which they appeared.
Now it is possible to store a "chronological-order" annotation which is
a simple integer counter.

docs/analyzer/user_guide.md

@@ -391,18 +391,18 @@ checker configuration:
 
   Checker prefix groups
   ------------------------------------------------
-  Checker prefix groups allow you to enable checkers that share a common 
-  prefix in their names. Checkers within a prefix group will have names that 
-  start with the same identifier, making it easier to manage and reference 
+  Checker prefix groups allow you to enable checkers that share a common
+  prefix in their names. Checkers within a prefix group will have names that
+  start with the same identifier, making it easier to manage and reference
   related checkers.
-  
-  You can enable/disable checkers belonging to a checker prefix group: 
+
+  You can enable/disable checkers belonging to a checker prefix group:
   '-e <label>:<value>', e.g. '-e prefix:security'.
-  
+
   Note: The 'prefix' label is mandatory when there is ambiguity between the
-  name of a checker prefix group and a checker profile or a guideline. This 
+  name of a checker prefix group and a checker profile or a guideline. This
   prevents conflicts and ensures the correct checkers are applied.
-  
+
   See "CodeChecker checkers --help" to learn more.
 
   Checker labels
@@ -413,9 +413,9 @@ checker configuration:
 
   You can enable/disable checkers belonging to a label: '-e <label>:<value>',
   e.g. '-e profile:default'.
-  
+
   Note: The 'profile' label is mandatory when there is ambiguity between the
-  name of a checker profile and a checker prefix group or a guideline. This 
+  name of a checker profile and a checker prefix group or a guideline. This
   prevents conflicts and ensures the correct checkers are applied.
 
   See "CodeChecker checkers --help" to learn more.
@@ -432,9 +432,9 @@ checker configuration:
 
   Guidelines are labels themselves, and can be used as a label:
   '-e guideline:<value>', e.g. '-e guideline:sei-cert'.
-  
+
   Note: The 'guideline' label is mandatory when there is ambiguity between the
-  name of a guideline and a checker prefix group or a checker profile. This 
+  name of a guideline and a checker prefix group or a checker profile. This
   prevents conflicts and ensures the correct checkers are applied.
 
   Batch enabling/disabling checkers
@@ -1551,12 +1551,12 @@ and disabled flags starting from the bigger groups and going inwards. For
 example
 
 ```sh
---enable prefix:clang-diagnostic-unused 
+--enable prefix:clang-diagnostic-unused
 --disable checker:clang-diagnostic-unused-parameter
 ```
 or
 ```sh
---enable prefix:clang-diagnostic-unused 
+--enable prefix:clang-diagnostic-unused
 --disable clang-diagnostic-unused-parameter
 ```
 will enable every `unused` warnings except `unused-parameter`. To turn off a
@@ -1771,9 +1771,15 @@ name.
 
 `.plist` files can be extended with a `report-annotation` section shown in the
 following example. Report annotations are custom labels that can be attached to
-a report. CodeChecker supports the usage of `testcase` and `timestamp`
-annotations. `timestamp` can be used for ordering and `testcase` can be used
-for filtering reports in the CodeChecker GUI.
+a report. CodeChecker supports the usage of `testcase`, `timestamp` and
+`chronological_order` annotations. `timestamp` and `chronological_order` can be
+used for ordering and `testcase` can be used for filtering reports in the
+CodeChecker GUI. These are typed annotations and CodeChecker is validating
+these types:
+
+- `timestamp`: Date-time format
+- `chronological_order`: Integer
+- `testcase`: String
 
 <pre>
 &lt;dict&gt;
@@ -1796,6 +1802,8 @@ for filtering reports in the CodeChecker GUI.
         &lt;string&gt;yhegalkoei&lt;/string&gt;
         &lt;key&gt;timestamp&lt;/key&gt;
         &lt;string&gt;1970-04-26T17:27:55&lt;/string&gt;
+        &lt;key&gt;chronological_order&lt;/key&gt;
+        &lt;string&gt;42&lt;/string&gt;
       &lt;/dict&gt;</b>
       &lt;key&gt;path&lt;/key&gt;
       &lt;array&gt;

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

@@ -1,6 +1,6 @@
 {
   "name": "codechecker-api",
-  "version": "6.60.0",
+  "version": "6.61.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.60.0'
+api_version = '6.61.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.60.0'
+api_version = '6.61.0'
 
 setup(
     name='codechecker_api_shared',

web/api/report_server.thrift

@@ -82,7 +82,8 @@ enum SortType {
   DETECTION_STATUS,
   BUG_PATH_LENGTH,
   TIMESTAMP,
-  TESTCASE
+  TESTCASE,
+  CHRONOLOGICAL_ORDER
 }
 
 enum RunSortType {

web/codechecker_web/shared/version.py

@@ -20,7 +20,7 @@
 # The newest supported minor version (value) for each supported major version
 # (key) in this particular build.
 SUPPORTED_VERSIONS = {
-    6: 60
+    6: 61
 }
 
 # Used by the client to automatically identify the latest major and minor

web/server/codechecker_server/api/mass_store_run.py

@@ -48,6 +48,7 @@
     Run, RunLock, RunHistory
 from ..metadata import checker_is_unavailable, MetadataInfoParser
 
+from .report_annotations import report_annotation_types
 from .report_server import ThriftRequestHandler
 from .thrift_enum_helper import report_extended_data_type_str
 
@@ -1160,39 +1161,22 @@ def __validate_and_add_report_annotations(
         doesn't match then an exception is thrown. In case of proper format the
         annotation is added to the database.
         """
-        allowed_types = {
-            "datetime": {
-                "func": datetime.fromisoformat,
-                "display": "date-time in ISO format"
-            },
-            "string": {
-                "func": str,
-                "display": "string"
-            }
-        }
-
-        allowed_annotations = {
-            "timestamp": allowed_types["datetime"],
-            "testsuite": allowed_types["string"],
-            "testcase": allowed_types["string"]
-        }
-
         for key, value in report_annotation.items():
             try:
-                allowed_annotations[key]["func"](value)
+                value = str(report_annotation_types[key]["func"](value))
                 session.add(ReportAnnotations(report_id, key, value))
             except KeyError:
                 # pylint: disable=raise-missing-from
                 raise codechecker_api_shared.ttypes.RequestFailed(
                     codechecker_api_shared.ttypes.ErrorCode.REPORT_FORMAT,
                     f"'{key}' is not an allowed report annotation.",
-                    allowed_annotations.keys())
+                    report_annotation_types.keys())
             except ValueError:
                 # pylint: disable=raise-missing-from
                 raise codechecker_api_shared.ttypes.RequestFailed(
                     codechecker_api_shared.ttypes.ErrorCode.REPORT_FORMAT,
                     f"'{value}' has wrong format. '{key}' annotations must be "
-                    f"'{allowed_annotations[key]['display']}'.")
+                    f"'{report_annotation_types[key]['display']}'.")
 
     def __get_report_limit_for_product(self):
         with DBSession(self.__config_database) as session:

web/server/codechecker_server/api/report_annotations.py

@@ -0,0 +1,37 @@
+# -------------------------------------------------------------------------
+#
+#  Part of the CodeChecker project, under the Apache License v2.0 with
+#  LLVM Exceptions. See LICENSE for license information.
+#  SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+#
+# -------------------------------------------------------------------------
+
+from datetime import datetime
+import sqlalchemy
+
+
+__allowed_types = {
+    "datetime": {
+        "func": datetime.fromisoformat,
+        "display": "date-time in ISO format",
+        # TODO: SQLite has limited datetime support
+        "db": sqlalchemy.types.String
+    },
+    "string": {
+        "func": str,
+        "display": "string",
+        "db": sqlalchemy.types.String
+    },
+    "integer": {
+        "func": int,
+        "display": "integer",
+        "db": sqlalchemy.types.Integer
+    }
+}
+
+
+report_annotation_types = {
+    "timestamp": __allowed_types["datetime"],
+    "testcase": __allowed_types["string"],
+    "chronological_order": __allowed_types["integer"]
+}

web/server/codechecker_server/api/report_server.py

@@ -72,6 +72,7 @@
 from .thrift_enum_helper import detection_status_enum, \
     detection_status_str, report_status_enum, \
     review_status_enum, review_status_str, report_extended_data_type_enum
+from .report_annotations import report_annotation_types
 
 # These names are inherited from Thrift stubs.
 # pylint: disable=invalid-name
@@ -1024,7 +1025,9 @@ def get_sort_map(sort_types, is_unique=False):
         SortType.REVIEW_STATUS: [(Report.review_status, 'rw_status')],
         SortType.DETECTION_STATUS: [(Report.detection_status, 'dt_status')],
         SortType.TIMESTAMP: [('annotation_timestamp', 'annotation_timestamp')],
-        SortType.TESTCASE: [('annotation_testcase', 'annotation_testcase')]}
+        SortType.TESTCASE: [('annotation_testcase', 'annotation_testcase')],
+        SortType.CHRONOLOGICAL_ORDER: [('annotation_chronological_order',
+                                        'annotation_chronological_order')]}
 
     if is_unique:
         sort_type_map[SortType.FILENAME] = [(File.filename, 'filename')]
@@ -1959,7 +1962,9 @@ def getRunResults(self, run_ids, limit, offset, sort_types,
             for col in annotation_keys:
                 annotation_cols[col] = func.max(sqlalchemy.case([(
                     ReportAnnotations.key == col,
-                    ReportAnnotations.value)])).label(f"annotation_{col}")
+                    cast(ReportAnnotations.value,
+                         report_annotation_types[col]["db"]))])) \
+                            .label(f"annotation_{col}")
 
             if report_filter.isUnique:
                 # A report annotation filter cannot be set in WHERE clause if
@@ -2143,7 +2148,7 @@ def getRunResults(self, run_ids, limit, offset, sort_types,
                 for row in query_result:
                     report, filepath = row[0], row[1]
                     annotations = {
-                        k: v for k, v in zip(annotation_keys, row[2:])
+                        k: str(v) for k, v in zip(annotation_keys, row[2:])
                         if v is not None}
 
                     review_data = create_review_data(

web/server/vue-cli/package.json

@@ -27,7 +27,7 @@
   },
   "dependencies": {
     "@mdi/font": "^6.5.95",
-    "codechecker-api": "file:../../api/js/codechecker-api-node/dist/codechecker-api-6.60.0.tgz",
+    "codechecker-api": "file:../../api/js/codechecker-api-node/dist/codechecker-api-6.61.0.tgz",
     "chart.js": "^2.9.4",
     "chartjs-plugin-datalabels": "^0.7.0",
     "codemirror": "^5.65.0",

web/server/vue-cli/src/views/Reports.vue

@@ -276,6 +276,12 @@ export default {
           align: "center",
           sortable: true
         },
+        {
+          text: "Chronological order",
+          value: "chronological-order",
+          align: "center",
+          sortable: true
+        },
         {
           text: "Testcase",
           value: "testcase",
@@ -287,6 +293,7 @@ export default {
       sameReports: {},
       hasTimeStamp: true,
       hasTestCase : true,
+      hasChronologicalOrder: true,
       selected: [],
       namespace: namespace,
       pagination: {
@@ -337,6 +344,10 @@ export default {
           return this.hasTestCase;
         }
 
+        if (header.value === "chronological-order") {
+          return this.hasChronologicalOrder;
+        }
+
         return true;
       });
     },
@@ -365,7 +376,8 @@ export default {
           "$id": id,
           "sameReports": report.sameReports,
           "timestamp": report.annotations["timestamp"],
-          "testcase": report.annotations["testcase"]
+          "testcase": report.annotations["testcase"],
+          "chronological-order": report.annotations["chronological-order"]
         };
       });
     }
@@ -388,6 +400,9 @@ export default {
 
         this.hasTestCase =
           this.formattedReports.some(report => report.testcase);
+
+        this.hasChronologicalOrder =
+          this.formattedReports.some(report => report["chronological-order"]);
       }
     }
   },
@@ -426,6 +441,9 @@ export default {
       case "testcase":
         type = SortType.TESTCASE;
         break;
+      case "chronological-order":
+        type = SortType.CHRONOLOGICAL_ORDER;
+        break;
       default:
         type = SortType.SEVERITY;
       }