backend: Serve detailed reports through API (#145)

Author: La0

backend/code_coverage_backend/api.py

@@ -8,6 +8,7 @@
 
 from code_coverage_backend.config import COVERAGE_EXTENSIONS
 from code_coverage_backend.gcp import load_cache
+from code_coverage_backend.report import DEFAULT_FILTER
 
 DEFAULT_REPOSITORY = "mozilla-central"
 logger = structlog.get_logger(__name__)
@@ -39,7 +40,13 @@ def coverage_latest(repository=DEFAULT_REPOSITORY):
         abort(404)
 
 
-def coverage_for_path(path="", changeset=None, repository=DEFAULT_REPOSITORY):
+def coverage_for_path(
+    path="",
+    changeset=None,
+    repository=DEFAULT_REPOSITORY,
+    platform=DEFAULT_FILTER,
+    suite=DEFAULT_FILTER,
+):
     """
     Aggregate coverage for a path, regardless of its type:
     * file, gives its coverage percent
@@ -54,17 +61,17 @@ def coverage_for_path(path="", changeset=None, repository=DEFAULT_REPOSITORY):
     try:
         if changeset:
             # Find closest report matching this changeset
-            changeset, _ = gcp.find_closest_report(repository, changeset)
+            report = gcp.find_closest_report(repository, changeset, platform, suite)
         else:
             # Fallback to latest report
-            changeset, _ = gcp.find_report(repository)
+            report = gcp.find_report(repository, platform, suite)
     except Exception as e:
         logger.warn("Failed to retrieve report: {}".format(e))
         abort(404)
 
     # Load tests data from GCP
     try:
-        return gcp.get_coverage(repository, changeset, path)
+        return gcp.get_coverage(report, path)
     except Exception as e:
         logger.warn(
             "Failed to load coverage",
@@ -76,7 +83,14 @@ def coverage_for_path(path="", changeset=None, repository=DEFAULT_REPOSITORY):
         abort(400)
 
 
-def coverage_history(repository=DEFAULT_REPOSITORY, path="", start=None, end=None):
+def coverage_history(
+    repository=DEFAULT_REPOSITORY,
+    path="",
+    start=None,
+    end=None,
+    platform=DEFAULT_FILTER,
+    suite=DEFAULT_FILTER,
+):
     """
     List overall coverage from ingested reports over a period of time
     """
@@ -86,7 +100,7 @@ def coverage_history(repository=DEFAULT_REPOSITORY, path="", start=None, end=Non
         abort(500)
 
     try:
-        return gcp.get_history(repository, path=path, start=start, end=end)
+        return gcp.get_history(repository, path, start, end, platform, suite)
     except Exception as e:
         logger.warn(
             "Failed to load history",
@@ -97,3 +111,22 @@ def coverage_history(repository=DEFAULT_REPOSITORY, path="", start=None, end=Non
             error=str(e),
         )
         abort(400)
+
+
+def coverage_filters(repository=DEFAULT_REPOSITORY):
+    """
+    List all available filters for that repository
+    """
+    gcp = load_cache()
+    if gcp is None:
+        logger.error("No GCP cache available")
+        abort(500)
+
+    try:
+        return {
+            "platforms": gcp.get_platforms(repository),
+            "suites": gcp.get_suites(repository),
+        }
+    except Exception as e:
+        logger.warn("Failed to load filters", repo=repository, error=str(e))
+        abort(400)

backend/code_coverage_backend/api.yml

@@ -42,6 +42,16 @@ paths:
         description: Mozilla repository for this changeset (default to mozilla-central)
         required: false
         type: string
+      - name: suite
+        in: query
+        description: Filter the coverage using this test suite
+        required: false
+        type: string
+      - name: platform
+        in: query
+        description: Filter the coverage using this platform
+        required: false
+        type: string
       responses:
         200:
           description: Code coverage information for a given file or directory at a given changeset
@@ -72,6 +82,16 @@ paths:
         description: Path of the repository folder to get coverage info on.
         required: false
         type: string
+      - name: suite
+        in: query
+        description: Filter the coverage using this test suite
+        required: false
+        type: string
+      - name: platform
+        in: query
+        description: Filter the coverage using this platform
+        required: false
+        type: string
       responses:
         200:
           description: Overall coverage of specified path over a period of time
@@ -86,3 +106,18 @@ paths:
           description: File extensions supported for code coverage
       tags:
         - v2
+
+  /v2/filters:
+    get:
+      operationId: "code_coverage_backend.api.coverage_filters"
+      parameters:
+      - name: repository
+        in: query
+        description: Mozilla repository for these reports (default to mozilla-central)
+        required: false
+        type: string
+      responses:
+        200:
+          description: Available filters on the endpoints
+      tags:
+        - v2