Cleanup plans

- Manage cleanup plans (create, edit, remove, close, reopen).
- Assign reports to cleanup plans.
- Filter reports by cleanup plans.
- Add functional and e2e test cases.

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

@@ -1,6 +1,6 @@
 {
   "name": "codechecker-api",
-  "version": "6.42.0",
+  "version": "6.43.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.42.0'
+api_version = '6.43.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.42.0'
+api_version = '6.43.0'
 
 setup(
     name='codechecker_api_shared',

web/api/report_server.thrift

@@ -288,6 +288,7 @@ struct ReportFilter {
   16: optional ReportDate         date,          // Dates of the report.
   17: optional list<string>       analyzerNames, // Names of the code analyzers.
   18: optional i64                openReportsDate, // Open reports date in unix time format.
+  19: optional list<string>       cleanupPlanNames, // Cleanup plan names.
 }
 
 struct RunReportCount {
@@ -405,6 +406,22 @@ struct BlameInfo {
   2: list<BlameData>         blame,
 }
 
+struct CleanupPlan {
+  1: i64          id,
+  2: string       name,
+  3: i64          dueDate, // Unix (epoch) time.
+  4: string       description,
+  5: i64          closedAt, // Unix (epoch) time.
+  6: list<string> reportHashes,
+}
+typedef list<CleanupPlan> CleanupPlans
+
+struct CleanupPlanFilter {
+  1: list<i64>    ids,
+  2: list<string> names,
+  3: bool         isOpen,
+}
+
 service codeCheckerDBAccess {
 
   // Gives back all analyzed runs.
@@ -790,5 +807,60 @@ service codeCheckerDBAccess {
   // Import data from the server.
   // PERMISSION: PRODUCT_ADMIN
   bool importData(1: ExportData exportData)
-                  throws (1: codechecker_api_shared.RequestFailed requestError),  
+                  throws (1: codechecker_api_shared.RequestFailed requestError),
+
+  // Add a new cleanup plan.
+  // Returns the cleanup plan id if the cleanup plan was successfully created.
+  // PERMISSION: PRODUCT_ADMIN
+  i64 addCleanupPlan(1: string name,
+                     2: string description,
+                     3: i64 dueDate)
+                     throws (1: codechecker_api_shared.RequestFailed requestError),
+
+  // Update a cleanup plan.
+  // Returns 'true' if cleanup plan was successfully updated.
+  // PERMISSION: PRODUCT_ADMIN
+  bool updateCleanupPlan(1: i64    id,
+                         2: string name,
+                         3: string description,
+                         4: i64    dueDate)
+                         throws (1: codechecker_api_shared.RequestFailed requestError),
+
+  // Get cleanup plans.
+  // Returns a list of cleanup plans.
+  // PERMISSION: PRODUCT_VIEW
+  CleanupPlans getCleanupPlans(1: CleanupPlanFilter filter)
+                               throws (1: codechecker_api_shared.RequestFailed requestError),
+
+  // Remove a cleanup plan.
+  // Returns 'true' if cleanup plan was successfully removed.
+  // PERMISSION: PRODUCT_ADMIN
+  bool removeCleanupPlan(1: i64 cleanupPlanId)
+                         throws (1: codechecker_api_shared.RequestFailed requestError),
+
+  // Close a cleanup plan.
+  // Returns 'true' if cleanup plan was successfully closed.
+  // PERMISSION: PRODUCT_ADMIN
+  bool closeCleanupPlan(1: i64 cleanupPlanId)
+                        throws (1: codechecker_api_shared.RequestFailed requestError),
+
+  // Reopen a cleanup plan.
+  // Returns 'true' if cleanup plan was successfully reopened.
+  // PERMISSION: PRODUCT_ADMIN
+  bool reopenCleanupPlan(1: i64 cleanupPlanId)
+                         throws (1: codechecker_api_shared.RequestFailed requestError),
+
+  // Add report hashes to the given cleanup plan.
+  // Returns 'true' if report hashes are set for the given cleanup plan.
+  // PERMISSION: PRODUCT_ADMIN
+  bool setCleanupPlan(1: i64          cleanupPlanId,
+                      2: list<string> reportHashes)
+                      throws (1: codechecker_api_shared.RequestFailed requestError),
+
+  // Remove report hashes from the given cleanup plan.
+  // Returns 'true' if report hashes are removed from the given cleanup plan.
+  // PERMISSION: PRODUCT_ADMIN
+  bool unsetCleanupPlan(1: i64          cleanupPlanId,
+                        2: list<string> reportHashes)
+                        throws (1: codechecker_api_shared.RequestFailed requestError),
 }

web/codechecker_web/shared/version.py

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