[core][feat] Allow filtering benchmarks (#2069)

Author: aquamatthias

fixcore/fixcore/report/__init__.py

@@ -393,7 +393,9 @@ class Inspector(ABC):
     """
 
     @abstractmethod
-    async def list_benchmarks(self) -> List[Benchmark]:
+    async def list_benchmarks(
+        self, *, provider_ids: Optional[List[str]] = None, benchmark_ids: Optional[List[str]] = None
+    ) -> List[Benchmark]:
         pass
 
     @abstractmethod

fixcore/fixcore/report/inspector_service.py

@@ -121,10 +121,19 @@ async def report_config(self) -> ReportConfig:
             log.warning(f"Can not load report config: {e}")
         return ReportConfig()  # safe default
 
-    async def list_benchmarks(self) -> List[Benchmark]:
-        result = {b.id: b for b in benchmarks_from_file().values()}
+    async def list_benchmarks(
+        self, *, provider_ids: Optional[List[str]] = None, benchmark_ids: Optional[List[str]] = None
+    ) -> List[Benchmark]:
+
+        def filter_benchmark(benchmark: Benchmark) -> bool:
+            in_p = provider_ids is None or benchmark.clouds is None or any(p in benchmark.clouds for p in provider_ids)
+            in_b = benchmark_ids is None or benchmark.id in benchmark_ids
+            return in_p and in_b
+
+        result = {b.id: b for b in benchmarks_from_file().values() if filter_benchmark(b)}
         async for b in self.benchmark_db.all():
-            result[b.id] = b
+            if filter_benchmark(b):
+                result[b.id] = b
         return list(result.values())
 
     async def benchmark(self, bid: str) -> Optional[Benchmark]:

fixcore/fixcore/static/api-doc.yaml

@@ -2632,7 +2632,13 @@ paths:
       tags:
         - report
       parameters:
-        - name: benchmark
+        - name: providers
+          in: query
+          description: "Comma separated list of cloud provides. All if not defined."
+          schema:
+            type: string
+          example: "aws"
+        - name: benchmarks
           in: query
           description: "Comma separated list of benchmarks. All if not defined."
           schema:

fixcore/fixcore/web/api.py

@@ -709,7 +709,10 @@ async def delete_check(self, request: Request, deps: TenantDependencies) -> Stre
         return HTTPNoContent()
 
     async def benchmarks(self, request: Request, deps: TenantDependencies) -> StreamResponse:
-        benchmark_filter = [b.strip() for b in request.query.get("benchmarks", "").split(",") if b.strip()]
+        benchmarks = request.query.get("benchmarks")
+        providers = request.query.get("providers")
+        benchmark_ids = [b.strip() for b in benchmarks.split(",") if b.strip()] if benchmarks else None
+        provider_ids = [p.strip() for p in providers.split(",") if p.strip()] if providers else None
         short = request.query.get("short", "false").lower() == "true"
         ids_only = request.query.get("ids_only", "false").lower() == "true"
         with_checks = request.query.get("with_checks", "false").lower() == "true"
@@ -729,12 +732,11 @@ def to_js_benchmark(b: Benchmark) -> JsonElement:
                 bj["report_checks"] = [to_js_check(lookup[c]) for c in b.nested_checks()]
             return bj
 
-        benchmarks = [
+        benchmark_results = [
             to_js_benchmark(b)
-            for b in await deps.inspector.list_benchmarks()
-            if (b.id in benchmark_filter or not benchmark_filter)
+            for b in await deps.inspector.list_benchmarks(provider_ids=provider_ids, benchmark_ids=benchmark_ids)
         ]
-        return await single_result(request, benchmarks)
+        return await single_result(request, benchmark_results)
 
     async def get_benchmark(self, request: Request, deps: TenantDependencies) -> StreamResponse:
         if result := await deps.inspector.benchmark(request.match_info["benchmark"]):