Merge ec1ed40 into c87f1b2

.flaskenv

@@ -6,3 +6,4 @@ FLASK_APP=conbench
 FLASK_ENV=development
 REGISTRATION_KEY=code
 SECRET_KEY="Person, woman, man, camera, TV"
+BENCHMARKS_DATA_PUBLIC=true

conbench/api/_endpoint.py

@@ -1,7 +1,26 @@
+import functools
+import os
+
 import flask as f
+import flask_login
 import flask.views
 
 
+def as_bool(x):
+    return x.lower() in ["yes", "y", "1", "on", "true"]
+
+
+def maybe_login_required(func):
+    @functools.wraps(func)
+    def maybe(*args, **kwargs):
+        public = as_bool(os.getenv("BENCHMARKS_DATA_PUBLIC", "yes"))
+        if not public:
+            return flask_login.login_required(func)(*args, **kwargs)
+        return func(*args, **kwargs)
+
+    return maybe
+
+
 class ApiEndpoint(flask.views.MethodView):
     def validate(self, schema):
         data = f.request.get_json(silent=True)

conbench/api/benchmarks.py

@@ -4,7 +4,7 @@
 
 from ..api import rule
 from ..api._docs import spec
-from ..api._endpoint import ApiEndpoint
+from ..api._endpoint import ApiEndpoint, maybe_login_required
 from ..entities._entity import NotFound
 from ..entities.case import Case
 from ..entities.distribution import set_z_scores
@@ -26,6 +26,7 @@ def _get(self, benchmark_id):
             self.abort_404_not_found()
         return summary
 
+    @maybe_login_required
     def get(self, benchmark_id):
         """
         ---
@@ -72,6 +73,7 @@ class BenchmarkListAPI(ApiEndpoint, BenchmarkValidationMixin):
     serializer = SummarySerializer()
     schema = BenchmarkFacadeSchema()
 
+    @maybe_login_required
     def get(self):
         """
         ---

conbench/api/commits.py

@@ -1,12 +1,13 @@
 from ..api import rule
-from ..api._endpoint import ApiEndpoint
+from ..api._endpoint import ApiEndpoint, maybe_login_required
 from ..entities._entity import NotFound
 from ..entities.commit import Commit, CommitSerializer
 
 
 class CommitListAPI(ApiEndpoint):
     serializer = CommitSerializer()
 
+    @maybe_login_required
     def get(self):
         """
         ---
@@ -31,6 +32,7 @@ def _get(self, commit_id):
             self.abort_404_not_found()
         return commit
 
+    @maybe_login_required
     def get(self, commit_id):
         """
         ---

conbench/api/compare.py

@@ -2,7 +2,7 @@
 
 
 from ..api import rule
-from ..api._endpoint import ApiEndpoint
+from ..api._endpoint import ApiEndpoint, maybe_login_required
 from ..entities._comparator import BenchmarkComparator, BenchmarkListComparator
 from ..entities._entity import NotFound
 from ..entities.distribution import set_z_scores
@@ -34,6 +34,7 @@ def _get(self, benchmark_id):
         set_z_scores([summary])
         return summary
 
+    @maybe_login_required
     def get(self, compare_ids):
         """
         ---
@@ -112,6 +113,7 @@ def _get(self, batch_id):
         set_z_scores(summaries)
         return summaries
 
+    @maybe_login_required
     def get(self, compare_ids):
         """
         ---

conbench/api/contexts.py

@@ -1,12 +1,13 @@
 from ..api import rule
-from ..api._endpoint import ApiEndpoint
+from ..api._endpoint import ApiEndpoint, maybe_login_required
 from ..entities._entity import NotFound
 from ..entities.context import Context, ContextSerializer
 
 
 class ContextListAPI(ApiEndpoint):
     serializer = ContextSerializer()
 
+    @maybe_login_required
     def get(self):
         """
         ---
@@ -31,6 +32,7 @@ def _get(self, context_id):
             self.abort_404_not_found()
         return context
 
+    @maybe_login_required
     def get(self, context_id):
         """
         ---

conbench/api/history.py

@@ -1,5 +1,5 @@
 from ..api import rule
-from ..api._endpoint import ApiEndpoint
+from ..api._endpoint import ApiEndpoint, maybe_login_required
 from ..entities._entity import NotFound
 from ..entities.history import get_history, HistorySerializer
 from ..entities.summary import Summary
@@ -19,6 +19,7 @@ def _get(self, benchmark_id):
             summary.run.machine.hash,
         )
 
+    @maybe_login_required
     def get(self, benchmark_id):
         """
         ---

conbench/api/machines.py

@@ -1,12 +1,13 @@
 from ..api import rule
-from ..api._endpoint import ApiEndpoint
+from ..api._endpoint import ApiEndpoint, maybe_login_required
 from ..entities._entity import NotFound
 from ..entities.machine import Machine, MachineSerializer
 
 
 class MachineListAPI(ApiEndpoint):
     serializer = MachineSerializer()
 
+    @maybe_login_required
     def get(self):
         """
         ---
@@ -31,6 +32,7 @@ def _get(self, machine_id):
             self.abort_404_not_found()
         return machine
 
+    @maybe_login_required
     def get(self, machine_id):
         """
         ---

conbench/api/runs.py

@@ -1,5 +1,5 @@
 from ..api import rule
-from ..api._endpoint import ApiEndpoint
+from ..api._endpoint import ApiEndpoint, maybe_login_required
 from ..entities._entity import NotFound
 from ..entities.run import Run, RunSerializer
 
@@ -14,6 +14,7 @@ def _get(self, run_id):
             self.abort_404_not_found()
         return run
 
+    @maybe_login_required
     def get(self, run_id):
         """
         ---
@@ -37,6 +38,7 @@ def get(self, run_id):
 class RunListAPI(ApiEndpoint):
     serializer = RunSerializer()
 
+    @maybe_login_required
     def get(self):
         """
         ---

conbench/tests/api/_asserts.py

@@ -77,8 +77,13 @@ def test_unauthenticated(self, client):
 
 
 class ListEnforcer(Enforcer):
-    def test_unauthenticated(self, client):
+    def test_unauthenticated(self, client, monkeypatch):
         if getattr(self, "public", False):
+            monkeypatch.setenv("BENCHMARKS_DATA_PUBLIC", "off")
+            response = client.get(self.url)
+            self.assert_401_unauthorized(response)
+
+            monkeypatch.setenv("BENCHMARKS_DATA_PUBLIC", "on")
             response = client.get(self.url)
             self.assert_200_ok(response)
         else:
@@ -87,12 +92,17 @@ def test_unauthenticated(self, client):
 
 
 class GetEnforcer(Enforcer):
-    def test_unauthenticated(self, client):
+    def test_unauthenticated(self, client, monkeypatch):
         if getattr(self, "public", False):
             entity = self._create()
-            response = client.get(self.url.format(entity.id))
-            # TODO: compare _expected_entity too
-            # self.assert_200_ok(response, _expected_entity(entity))
+            entity_url = self.url.format(entity.id)
+
+            monkeypatch.setenv("BENCHMARKS_DATA_PUBLIC", "off")
+            response = client.get(entity_url)
+            self.assert_401_unauthorized(response)
+
+            monkeypatch.setenv("BENCHMARKS_DATA_PUBLIC", "on")
+            response = client.get(entity_url)
             self.assert_200_ok(response)
         else:
             response = client.get(self.url.format("id"))