Add version filtering to list_measurements

#615

api/ooniapi/measurements.py

@@ -35,6 +35,7 @@
 from ooniapi.urlparams import (
     param_asn,
     param_bool,
+    param_commasplit,
     param_date,
     param_input_or_none,
     param_report_id,
@@ -644,6 +645,21 @@ def list_measurements() -> Response:
           Set "true" for failed measurements (the control request failed, there was a bug, etc.).
           Default: both true and false
 
+      - name: software_version
+        in: query
+        type: string
+        description: Filter measurements by software version. Comma-separated.
+
+      - name: test_version
+        in: query
+        type: string
+        description: Filter measurements by test version. Comma-separated.
+
+      - name: engine_version
+        in: query
+        type: string
+        description: Filter measurements by engine version. Comma-separated.
+
       - name: order_by
         in: query
         type: string
@@ -698,6 +714,9 @@ def list_measurements() -> Response:
     anomaly = param_bool("anomaly")
     confirmed = param_bool("confirmed")
     category_code = param("category_code")
+    software_version = param_commasplit("software_version")
+    test_version = param_commasplit("test_version")
+    engine_version = param_commasplit("engine_version")
 
     # Workaround for https://github.com/ooni/probe/issues/1034
     user_agent = request.headers.get("User-Agent", "")
@@ -788,6 +807,18 @@ def list_measurements() -> Response:
         query_params["test_name"] = test_name
         fpwhere.append(sql.text("test_name = :test_name"))
 
+    if software_version is not None:
+        query_params["software_version"] = software_version
+        fpwhere.append(sql.text("software_version = :software_version"))
+
+    if test_version is not None:
+        query_params["test_version"] = test_version
+        fpwhere.append(sql.text("engine_version = :engine_version"))
+
+    if engine_version is not None:
+        query_params["engine_version"] = engine_version
+        fpwhere.append(sql.text("engine_version = :engine_version"))
+
     # Filter on anomaly, confirmed and failure:
     # The database stores anomaly and confirmed as boolean + NULL and stores
     # failures in different columns. This leads to many possible combinations

api/ooniapi/urlparams.py

@@ -114,6 +114,13 @@ def commasplit(p: str) -> List[str]:
     return sorted(out)
 
 
+def param_commasplit(name) -> Optional[List[str]]:
+    p = request.args.get(name)
+    if not p:
+        return None
+    return commasplit(p)
+
+
 def param_domain_m(name="domain") -> List[str]:
     p = request.args.get(name)
     if not p:

api/tests/integ/test_integration.py

@@ -773,6 +773,34 @@ def test_list_measurements_ZZ(client):
     assert resp.status_code == 403
 
 
+def test_list_measurements_filter_software_version_nomatch(client):
+    # https://github.com/ooni/backend/issues/15
+    url = "measurements?since=2021-07-09&until=2021-07-10&software_version=9.9.9"
+    resp = api(client, url)
+    assert len(resp["results"]) == 0
+
+
+def test_list_measurements_filter_software_version(client):
+    # https://github.com/ooni/backend/issues/15
+    url = "measurements?since=2021-07-09&until=2021-07-10&software_version=3.9.2"
+    resp = api(client, url)
+    assert len(resp["results"]) == 100
+
+
+def test_list_measurements_filter_test_version(client):
+    # https://github.com/ooni/backend/issues/15
+    url = "measurements?since=2021-07-09&until=2021-07-10&test_version=0.4.0"
+    resp = api(client, url)
+    assert len(resp["results"]) == 100
+
+
+def test_list_measurements_filter_engine_version(client):
+    # https://github.com/ooni/backend/issues/15
+    url = "measurements?since=2021-07-09&until=2021-07-10&engine_version=3.9.2"
+    resp = api(client, url)
+    assert len(resp["results"]) == 100
+
+
 ## get_measurement ##