add collectors to ooniapi

Author: aagbsn

ooniapi/common/src/common/config.py

@@ -1,4 +1,4 @@
-from typing import List
+from typing import List, Dict
 from pydantic_settings import BaseSettings
 
 
@@ -41,3 +41,21 @@ class Settings(BaseSettings):
     failed_reports_bucket: str = (
         ""  # for uploading reports that couldn't be sent to fastpath
     )
+
+    # ooniprobe client configuration
+    collectors: List[Dict[str, str]] = [
+        {"address": "httpo://guegdifjy7bjpequ.onion", "type": "onion"},
+        {"address": "https://ams-pg.ooni.org:443", "type": "https"},
+        {
+            "address": "https://dkyhjv0wpi2dk.cloudfront.net",
+            "front": "dkyhjv0wpi2dk.cloudfront.net",
+            "type": "cloudfront",
+        },
+        {"address": "httpo://guegdifjy7bjpequ.onion", "type": "onion"},
+        {"address": "https://ams-pg.ooni.org:443", "type": "https"},
+        {
+            "address": "https://dkyhjv0wpi2dk.cloudfront.net",
+            "front": "dkyhjv0wpi2dk.cloudfront.net",
+            "type": "cloudfront",
+        },
+    ]

ooniapi/services/ooniprobe/src/ooniprobe/routers/v1/probe_services.py

@@ -590,3 +590,21 @@ def random_web_test_helpers(th_list: List[str]) -> List[Dict]:
     for th_addr in th_list:
         out.append({"address": th_addr, "type": "https"})
     return out
+
+
+class CollectorEntry(BaseModel):
+    # not actually used but necessary to be compliant with the old API schema
+    address: str = Field(description="Address of collector")
+    front: Optional[str] = Field(default=None, description="Fronted domain")
+    type: Optional[str] = Field(default=None, description="Type of collector")
+
+@router.post("/collectors", tags=["ooniprobe"])
+def list_collectors(
+    settings: Settings = Depends(get_settings),
+    ) -> List[CollectorEntry]:
+    config_collectors = settings.collectors
+    collectors_response = []
+    for entry in config_collectors:
+        collector = CollectorEntry(**entry)
+        collectors_response.append(collector)
+    return collectors_response

ooniapi/services/ooniprobe/tests/integ/test_list_collectors.py

@@ -0,0 +1,5 @@
+def test_list_collectors(client):
+    c = client.post("/api/v1/collectors").json()
+    assert len(c) == 6
+    for entry in c:
+        assert "address" in entry