Merge pull request #4213 from cservakt/checker-coverage-fixing

[fix] Checker Coverage statistics fixing

It's a fix PR based on #4210. Unnecessary comments were deleted. Minimal API changes and some style corrections were made. Some parts of the code are more readable now.

web/api/report_server.thrift

@@ -396,16 +396,16 @@ struct CheckerCount {
 }
 typedef list<CheckerCount> CheckerCounts
 
-struct CheckerInfo {
-  1: string       checkerName,  // Analyzer name of the checker.
+struct CheckerStatusVerificationDetail {
+  1: string       checkerName,  // Checker name.
   2: string       analyzerName, // Analyzer name of the checker.
   3: Severity     severity,     // Severity level of the checker.
-  4: list<i64> enabled,      // Runs' names in which the checker enabled.
-  5: list<i64> disabled,     // Runs' names in which the checker disabled.
+  4: list<i64>    enabled,      // Run ids in which the checker enabled.
+  5: list<i64>    disabled,     // Run ids in which the checker disabled.
   6: i64          closed        // Number of closed reports.
   7: i64          outstanding   // Number of outstanding reports.
 }
-typedef map<i64, CheckerInfo> CheckerInfos
+typedef map<i64, CheckerStatusVerificationDetail> CheckerStatusVerificationDetails
 
 struct CommentData {
   1: i64     id,
@@ -867,9 +867,10 @@ service codeCheckerDBAccess {
   // enabled and how many reports are opened or closed.
   // If the run id list is empty the statistics
   // will be counted for all of the runs.
-  CheckerInfos getCheckerInfo(1: list<i64>    runIds,
-                              2: ReportFilter reportFilter)
-                              throws (1: codechecker_api_shared.RequestFailed requestError),
+  // PERMISSION: PRODUCT_VIEW
+  CheckerStatusVerificationDetails getCheckerStatusVerificationDetails(1: list<i64>    runIds,
+                                                                       2: ReportFilter reportFilter)
+                                                                       throws (1: codechecker_api_shared.RequestFailed requestError),
 
   // If the run id list is empty the metrics will be counted
   // for all of the runs and in compare mode all of the runs

web/server/codechecker_server/api/report_server.py

@@ -34,16 +34,17 @@
 from codechecker_api.codeCheckerDBAccess_v6.ttypes import \
     AnalysisInfoFilter, AnalysisInfoChecker as API_AnalysisInfoChecker, \
     BlameData, BlameInfo, BugPathPos, \
-    CheckerCount, Commit, CommitAuthor, CommentData, \
-    DiffType, \
+    CheckerCount, CheckerStatusVerificationDetail, Commit, CommitAuthor, \
+    CommentData, \
+    DetectionStatus, DiffType, \
     Encoding, ExportData, \
     Order, \
     ReportData, ReportDetails, ReviewData, ReviewStatusRule, \
     ReviewStatusRuleFilter, ReviewStatusRuleSortMode, \
     ReviewStatusRuleSortType, RunData, RunFilter, RunHistoryData, \
     RunReportCount, RunSortType, RunTagCount, \
-    SourceComponentData, SourceFileData, SortMode, SortType, \
-    ReviewStatus as API_ReviewStatus, DetectionStatus, CheckerInfo
+    ReviewStatus as API_ReviewStatus, \
+    SourceComponentData, SourceFileData, SortMode, SortType
 
 from codechecker_common import util
 from codechecker_common.logger import get_logger
@@ -59,7 +60,6 @@
 from ..database.database import conv, DBSession, escape_like
 from ..database.run_db_model import \
     AnalysisInfo, AnalysisInfoChecker as DB_AnalysisInfoChecker, \
-    AnalysisInfoChecker, \
     AnalyzerStatistic, \
     BugPathEvent, BugReportPoint, \
     CleanupPlan, CleanupPlanReportHash, Checker, Comment, \
@@ -1284,6 +1284,66 @@ def get_rs_rule_query(
     return q
 
 
+def get_run_id_expression(session, report_filter):
+    """
+    Get run id or concatenated run id list by the unique mode and the DB type
+    """
+    if report_filter.isUnique:
+        if session.bind.dialect.name == "postgresql":
+            return func.string_agg(
+                cast(Run.id, sqlalchemy.String).distinct(),
+                ','
+            ).label("run_id")
+        else:
+            return func.group_concat(
+                Run.id.distinct()
+            ).label("run_id")
+    else:
+        return Run.id.label("run_id")
+
+
+def get_is_enabled_case(subquery):
+    """
+    Creating a case statement to decide the report
+    is enabled or not based on the detection status
+    """
+    detection_status_filters = subquery.c.detection_status.in_(list(
+        map(detection_status_str,
+            (DetectionStatus.OFF, DetectionStatus.UNAVAILABLE))
+    ))
+
+    return case(
+        [(detection_status_filters, False)],
+        else_=True
+    )
+
+
+def get_is_opened_case(subquery):
+    """
+    Creating a case statement to decide the report is opened or not
+    based on the detection status and the review status
+    """
+    detection_statuses = (
+        DetectionStatus.NEW,
+        DetectionStatus.UNRESOLVED,
+        DetectionStatus.REOPENED
+    )
+    review_statuses = (
+        API_ReviewStatus.UNREVIEWED,
+        API_ReviewStatus.CONFIRMED
+    )
+    detection_and_review_status_filters = [
+        subquery.c.detection_status.in_(list(map(
+            detection_status_str, detection_statuses))),
+        subquery.c.review_status.in_(list(map(
+            review_status_str, review_statuses)))
+    ]
+    return case(
+        [(and_(*detection_and_review_status_filters), True)],
+        else_=False
+    )
+
+
 class ThriftRequestHandler:
     """
     Connect to database and handle thrift client requests.
@@ -2865,8 +2925,9 @@ def getCheckerCounts(self, run_ids, report_filter, cmp_data, limit,
 
     @exc_to_thrift_reqfail
     @timeit
-    def getCheckerInfo(self, run_ids, report_filter):
+    def getCheckerStatusVerificationDetails(self, run_ids, report_filter):
         self.__require_view()
+
         with DBSession(self._Session) as session:
             max_run_histories = session.query(
                 RunHistory.run_id,
@@ -2875,16 +2936,11 @@ def getCheckerInfo(self, run_ids, report_filter):
                 .filter(RunHistory.run_id.in_(run_ids) if run_ids else True) \
                 .group_by(RunHistory.run_id)
 
+            run_id_expression = get_run_id_expression(session, report_filter)
+
             subquery = (
                 session.query(
-                    (func.string_agg(
-                        cast(Run.id, sqlalchemy.String).distinct(),
-                        ','
-                        ).label("run_id")
-                     if session.bind.dialect.name == "postgresql"
-                     else func.group_concat(Run.id.distinct()).label("run_id"))
-                    if report_filter.isUnique
-                    else Run.id.label("run_id"),
+                    run_id_expression,
                     Checker.id.label("checker_id"),
                     Checker.checker_name,
                     Checker.analyzer_name,
@@ -2895,10 +2951,12 @@ def getCheckerInfo(self, run_ids, report_filter):
                 )
                 .join(RunHistory)
                 .join(AnalysisInfo, RunHistory.analysis_info)
-                .join(AnalysisInfoChecker, (
-                    (AnalysisInfo.id == AnalysisInfoChecker.analysis_info_id)
-                    & (AnalysisInfoChecker.enabled.is_(True))))
-                .join(Checker, AnalysisInfoChecker.checker_id == Checker.id)
+                .join(DB_AnalysisInfoChecker, (
+                    (AnalysisInfo.id ==
+                     DB_AnalysisInfoChecker.analysis_info_id)
+                    & (DB_AnalysisInfoChecker.enabled.is_(True))))
+                .join(Checker,
+                      DB_AnalysisInfoChecker.checker_id == Checker.id)
                 .outerjoin(Report, ((Checker.id == Report.checker_id)
                                     & (Run.id == Report.run_id)))
                 .filter(RunHistory.id == max_run_histories.subquery()
@@ -2918,46 +2976,18 @@ def getCheckerInfo(self, run_ids, report_filter):
 
             subquery = subquery.subquery()
 
+            is_enabled_case = get_is_enabled_case(subquery)
+            is_opened_case = get_is_opened_case(subquery)
+
             query = (
                 session.query(
                     subquery.c.checker_id,
                     subquery.c.checker_name,
                     subquery.c.analyzer_name,
                     subquery.c.severity,
                     subquery.c.run_id,
-                    case(
-                        [
-                            (
-                                subquery.c.detection_status.in_(list(map(
-                                    detection_status_str,
-                                    (DetectionStatus.OFF,
-                                     DetectionStatus.UNAVAILABLE)
-                                ))),
-                                False
-                            )
-                        ],
-                        else_=True
-                    ).label("isEnabled"),
-                    case(
-                        [
-                            (
-                                and_(
-                                    subquery.c.detection_status.in_(list(map(
-                                        detection_status_str,
-                                        (DetectionStatus.NEW,
-                                         DetectionStatus.UNRESOLVED,
-                                         DetectionStatus.REOPENED)
-                                    ))),
-                                    subquery.c.review_status.in_(list(map(
-                                        review_status_str,
-                                        (API_ReviewStatus.UNREVIEWED,
-                                         API_ReviewStatus.CONFIRMED))))
-                                ),
-                                True
-                            )
-                        ],
-                        else_=False
-                    ).label("isOpened"),
+                    is_enabled_case.label("isEnabled"),
+                    is_opened_case.label("isOpened"),
                     func.count(subquery.c.bug_id)
                 )
                 .group_by(
@@ -2966,39 +2996,8 @@ def getCheckerInfo(self, run_ids, report_filter):
                     subquery.c.analyzer_name,
                     subquery.c.severity,
                     subquery.c.run_id,
-                    case(
-                        [
-                            (
-                                subquery.c.detection_status.in_(list(map(
-                                    detection_status_str,
-                                    (DetectionStatus.OFF,
-                                     DetectionStatus.UNAVAILABLE)
-                                ))),
-                                False
-                            )
-                        ],
-                        else_=True
-                    ),
-                    case(
-                        [
-                            (
-                                and_(
-                                    subquery.c.detection_status.in_(list(map(
-                                        detection_status_str,
-                                        (DetectionStatus.NEW,
-                                         DetectionStatus.UNRESOLVED,
-                                         DetectionStatus.REOPENED)
-                                    ))),
-                                    subquery.c.review_status.in_(list(map(
-                                        review_status_str,
-                                        (API_ReviewStatus.UNREVIEWED,
-                                         API_ReviewStatus.CONFIRMED))))
-                                ),
-                                True
-                            )
-                        ],
-                        else_=False
-                    )
+                    is_enabled_case,
+                    is_opened_case
                 )
             )
 
@@ -3013,21 +3012,22 @@ def getCheckerInfo(self, run_ids, report_filter):
                 is_opened, \
                 cnt \
                     in query.all():
-                checker_stat = checker_stats[checker_id] \
-                    if checker_id in checker_stats \
-                    else CheckerInfo(
+
+                checker_stat = checker_stats.get(
+                    checker_id,
+                    CheckerStatusVerificationDetail(
                         checkerName=checker_name,
                         analyzerName=analyzer_name,
                         enabled=[],
                         disabled=all_run_id,
                         severity=severity,
                         closed=0,
                         outstanding=0
-                    )
+                    ))
 
                 if is_enabled:
                     for r in (run_ids.split(",")
-                              if type(run_ids) is str
+                              if isinstance(run_ids, str)
                               else [run_ids]):
                         run_id = int(r)
                         if run_id not in checker_stat.enabled:

web/server/vue-cli/src/components/Statistics/CheckerCoverage/CheckerCoverageStatistics.vue

@@ -217,7 +217,7 @@ export default {
         })
       ];
 
-      this.toCSV(data, "codechecker_analysis_statistics.csv");
+      this.toCSV(data, "codechecker_checker_coverage_statistics.csv");
     },
 
     async getRunData() {
@@ -262,7 +262,9 @@ export default {
       const filter = new ReportFilter(this.reportFilter);
 
       this.checker_stat = await new Promise(resolve => {
-        ccService.getClient().getCheckerInfo(this.runIds, filter,
+        ccService.getClient().getCheckerStatusVerificationDetails(
+          this.runIds,
+          filter,
           handleThriftError(res => {
             resolve(res);
           }));

web/server/vue-cli/src/components/Statistics/CheckerCoverage/CheckerCoverageStatisticsDialog.vue

@@ -9,7 +9,6 @@
       <v-card-title
         class="headline primary white--text"
         primary-title
-        style="text-transform: capitalize;"
       >
         {{ title }}
 
@@ -105,7 +104,8 @@ export default {
     },
 
     title() {
-      let title = `${this.type} Run List`;
+      let title = `${this.type.charAt(0).toUpperCase() 
+        + this.type.slice(1)} run list`;
       if ( this.checkerName ) {
         title += ` for the "${this.checkerName}" checker`;
       }

web/server/vue-cli/src/components/Statistics/StatisticsHelper.js

@@ -2,7 +2,6 @@ import { ccService, handleThriftError } from "@cc-api";
 import {
   ReportFilter,
   ReviewStatus,
-  // AnalysisInfoFilter
 } from "@cc/report-server-types";
 
 const reviewStatusVariations = [