sentry: support disabling error reporting

snapcraft/cli/_errors.py

@@ -158,6 +158,13 @@ def _handle_trace_output(
 
 
 def _is_send_to_sentry() -> bool:  # noqa: C901
+    # Check to see if error reporting has been disabled
+    if (
+        distutils.util.strtobool(os.getenv("SNAPCRAFT_ENABLE_ERROR_REPORTING", "y"))
+        == 0
+    ):
+        return False
+
     # Check the environment to see if we should allow for silent reporting
     if distutils.util.strtobool(os.getenv("SNAPCRAFT_ENABLE_SILENT_REPORT", "n")) == 1:
         click.echo(_MSG_SILENT_REPORT)

spread.yaml

@@ -13,6 +13,12 @@ environment:
   # nothing.
   SNAPCRAFT_CHANNEL: "$(HOST: echo ${SNAPCRAFT_CHANNEL})"
 
+  # Show error tracebacks
+  SNAPCRAFT_MANAGED_HOST: "yes"
+
+  # Disable all Sentry error reporting
+  SNAPCRAFT_ENABLE_ERROR_REPORTING: "no"
+
   SETUP_DIR: /snapcraft/tests/spread/setup
 
 backends:

tests/integration/__init__.py

@@ -99,7 +99,7 @@ def setUp(self):
         # Disable Sentry reporting for tests, otherwise they'll hang waiting
         # for input
         self.useFixture(
-            fixtures.EnvironmentVariable("SNAPCRAFT_ENABLE_SENTRY", "false")
+            fixtures.EnvironmentVariable("SNAPCRAFT_ENABLE_ERROR_REPORTING", "false")
         )
 
         # Note that these directories won't exist when the test starts,

tests/unit/__init__.py

@@ -162,7 +162,7 @@ def setUp(self):
         # Disable Sentry reporting for tests, otherwise they'll hang waiting
         # for input
         self.useFixture(
-            fixtures.EnvironmentVariable("SNAPCRAFT_ENABLE_SENTRY", "false")
+            fixtures.EnvironmentVariable("SNAPCRAFT_ENABLE_ERROR_REPORTING", "false")
         )
 
         machine = os.environ.get("SNAPCRAFT_TEST_MOCK_MACHINE", None)

tests/unit/cli/test_errors.py

@@ -135,8 +135,6 @@ def setUp(self):
         self.raven_client_mock = patcher.start()
         self.addCleanup(patcher.stop)
 
-        self.useFixture(fixtures.EnvironmentVariable("SNAPCRAFT_ENABLE_SENTRY", "yes"))
-
 
 class SendToSentryIsYesTest(SendToSentryBaseTest):
 
@@ -276,3 +274,19 @@ def test_send_with_config_error_does_not_save_always(self):
 
         # Given the corruption, ensure it hasn't been written to
         self.assertThat(config_path, FileContains("bad data"))
+
+
+class SendToSentryDisabledTest(SendToSentryBaseTest):
+    def test_disabled_no_send(self):
+        self.prompt_mock.return_value = "yes"
+        self.useFixture(
+            fixtures.EnvironmentVariable("SNAPCRAFT_ENABLE_ERROR_REPORTING", "no")
+        )
+
+        try:
+            self.call_handler(RuntimeError("not a SnapcraftError"), True)
+        except Exception:
+            self.fail("Exception unexpectedly raised")
+
+        self.assert_exception_traceback_exit_1_with_debug()
+        self.raven_client_mock.assert_not_called()