Add Sentry support to the /_status endpoint

Have the `/_status` endpoint send a test message to Sentry if called
with a `?sentry` query param.

This enables testing the Sentry configuration in different environments
(production, staging, etc). Otherwise you'd need to have some way to
make the app crash in order to test it.

`?sentry` does not affect the status endpoint's HTTP return status so it
won't affect Elastic Beanstalk health checking.

bouncer/views.py

@@ -5,6 +5,7 @@
 from elasticsearch import exceptions
 from pyramid import httpexceptions, i18n, view
 from pyramid.httpexceptions import HTTPNoContent
+from sentry_sdk import capture_message
 
 from bouncer import util
 from bouncer.embed_detector import url_embeds_client
@@ -240,6 +241,9 @@ def healthcheck(request):
     if status not in ("yellow", "green"):
         raise FailedHealthcheck("cluster status was {!r}".format(status))
 
+    if "sentry" in request.params:
+        capture_message("Test message from the healthcheck() view")
+
     return {"status": "okay"}
 
 

tests/unit/bouncer/views_test.py

@@ -295,13 +295,14 @@ def h_pyramid_sentry(self, patch):
 
 
 class TestHealthcheck(object):
-    def test_ok(self):
+    def test_ok(self, capture_message):
         request = mock_request()
         request.es.cluster.health.return_value = {"status": "green"}
 
         result = views.healthcheck(request)
 
         assert result == {"status": "okay"}
+        capture_message.assert_not_called()
 
     def test_failed_es_request(self):
         request = mock_request()
@@ -322,6 +323,17 @@ def test_wrong_cluster_status(self):
 
         assert "cluster status" in str(e.value)
 
+    def test_sentry(self, capture_message):
+        request = mock_request()
+        request.params["sentry"] = ""
+        request.es.cluster.health.return_value = {"status": "green"}
+
+        views.healthcheck(request)
+
+        capture_message.assert_called_once_with(
+            "Test message from the healthcheck() view"
+        )
+
 
 @pytest.fixture
 def parse_document(request):
@@ -377,3 +389,8 @@ def url_embeds_client():
     yield url_embeds_client
 
     patcher.stop()
+
+
+@pytest.fixture(autouse=True)
+def capture_message(patch):
+    return patch("bouncer.views.capture_message")

tox.ini

@@ -16,6 +16,7 @@ setenv =
     dev: HYPOTHESIS_URL = {env:HYPOTHESIS_URL:http://localhost:5000}
     dev: VIA_BASE_URL = {env:VIA_BASE_URL:http://localhost:9083}
     dev: WEB_CONCURRENCY = {env:WEB_CONCURRENCY:2}
+    dev: SENTRY_ENVIRONMENT = {env:SENTRY_ENVIRONMENT:dev}
 passenv =
     HOME
     dev: CHROME_EXTENSION_ID