test: make tests that emit a deprecation warning fail

jcouball · jcouball · commit 7e211d7b2b7c · 2025-07-08T14:38:13.000-07:00
Deprecation warnings should not be ignored.

This is important so that:
* when a user sees a deprecation warning, they can be confident it is coming from
  their code and not this gem
* test output is clean and does not contain noisey deprecation warnings

Tests whose purpose is to test that a deprecation warning is issued in the right
circumstance should mock Git::Deprecation#warn to avoid raising an error.
diff --git a/tests/test_helper.rb b/tests/test_helper.rb
@@ -12,8 +12,19 @@
 $stdout.sync = true
 $stderr.sync = true
 
-# # Silence deprecation warnings during tests
-# Git::Deprecation.behavior = :silence
+# Make tests that emit a deprecation warning fail
+
+# Deprecation warnings should not be ignored.
+
+# This is important so that:
+# * when a user sees a deprecation warning, they can be confident it is coming from
+#   their code and not this gem
+# * test output is clean and does not contain noisey deprecation warnings
+
+# Tests whose purpose is to test that a deprecation warning is issued in the right
+# circumstance should mock Git::Deprecation#warn to avoid raising an error.
+#
+Git::Deprecation.behavior = :raise
 
 module Test
   module Unit
