updates to the tests, and fixes to the retry

tests/test_retrieve_data.py

@@ -9,26 +9,27 @@ import pytest
 
 from github_backup import github_backup
 from github_backup.github_backup import (
-    MAX_RETRIES,
     calculate_retry_delay,
     make_request_with_retry,
 )
 
+# Default retry count used in tests (matches argparse default)
+# With max_retries=5, total attempts = 6 (1 initial + 5 retries)
+DEFAULT_MAX_RETRIES = 5
+
 
 class TestCalculateRetryDelay:
     def test_respects_retry_after_header(self):
-        headers = {'retry-after': '30'}
+        headers = {"retry-after": "30"}
         assert calculate_retry_delay(0, headers) == 30
 
     def test_respects_rate_limit_reset(self):
         import time
         import calendar
+
         # Set reset time 60 seconds in the future
         future_reset = calendar.timegm(time.gmtime()) + 60
-        headers = {
-            'x-ratelimit-remaining': '0',
-            'x-ratelimit-reset': str(future_reset)
-        }
+        headers = {"x-ratelimit-remaining": "0", "x-ratelimit-reset": str(future_reset)}
         delay = calculate_retry_delay(0, headers)
         # Should be approximately 60 seconds (with some tolerance for execution time)
         assert 55 <= delay <= 65
@@ -50,12 +51,10 @@ class TestCalculateRetryDelay:
     def test_minimum_rate_limit_delay(self):
         import time
         import calendar
+
         # Set reset time in the past (already reset)
         past_reset = calendar.timegm(time.gmtime()) - 100
-        headers = {
-            'x-ratelimit-remaining': '0',
-            'x-ratelimit-reset': str(past_reset)
-        }
+        headers = {"x-ratelimit-remaining": "0", "x-ratelimit-reset": str(past_reset)}
         delay = calculate_retry_delay(0, headers)
         # Should be minimum 10 seconds even if reset time is in past
         assert delay >= 10
@@ -74,6 +73,7 @@ class TestRetrieveDataRetry:
         args.osx_keychain_item_account = None
         args.throttle_limit = None
         args.throttle_pause = 0
+        args.max_retries = DEFAULT_MAX_RETRIES
         return args
 
     def test_json_parse_error_retries_and_fails(self, mock_args):
@@ -90,13 +90,22 @@ class TestRetrieveDataRetry:
             call_count += 1
             return mock_response
 
-        with patch("github_backup.github_backup.make_request_with_retry", side_effect=mock_make_request):
-            with patch("github_backup.github_backup.calculate_retry_delay", return_value=0):  # No delay in tests
+        with patch(
+            "github_backup.github_backup.make_request_with_retry",
+            side_effect=mock_make_request,
+        ):
+            with patch(
+                "github_backup.github_backup.calculate_retry_delay", return_value=0
+            ):  # No delay in tests
                 with pytest.raises(Exception) as exc_info:
-                    github_backup.retrieve_data(mock_args, "https://api.github.com/repos/test/repo/issues")
+                    github_backup.retrieve_data(
+                        mock_args, "https://api.github.com/repos/test/repo/issues"
+                    )
 
         assert "Failed to read response after" in str(exc_info.value)
-        assert call_count == MAX_RETRIES
+        assert (
+            call_count == DEFAULT_MAX_RETRIES + 1
+        )  # 1 initial + 5 retries = 6 attempts
 
     def test_json_parse_error_recovers_on_retry(self, mock_args):
         """HTTP 200 with invalid JSON should succeed if retry returns valid JSON."""
@@ -119,9 +128,16 @@ class TestRetrieveDataRetry:
             call_count += 1
             return result
 
-        with patch("github_backup.github_backup.make_request_with_retry", side_effect=mock_make_request):
-            with patch("github_backup.github_backup.calculate_retry_delay", return_value=0):
-                result = github_backup.retrieve_data(mock_args, "https://api.github.com/repos/test/repo/issues")
+        with patch(
+            "github_backup.github_backup.make_request_with_retry",
+            side_effect=mock_make_request,
+        ):
+            with patch(
+                "github_backup.github_backup.calculate_retry_delay", return_value=0
+            ):
+                result = github_backup.retrieve_data(
+                    mock_args, "https://api.github.com/repos/test/repo/issues"
+                )
 
         assert result == [{"id": 1}]
         assert call_count == 3  # Failed twice, succeeded on third
@@ -134,11 +150,18 @@ class TestRetrieveDataRetry:
         mock_response.headers = {"x-ratelimit-remaining": "5000"}
         mock_response.reason = "Not Found"
 
-        with patch("github_backup.github_backup.make_request_with_retry", return_value=mock_response):
+        with patch(
+            "github_backup.github_backup.make_request_with_retry",
+            return_value=mock_response,
+        ):
             with pytest.raises(Exception) as exc_info:
-                github_backup.retrieve_data(mock_args, "https://api.github.com/repos/test/notfound/issues")
+                github_backup.retrieve_data(
+                    mock_args, "https://api.github.com/repos/test/notfound/issues"
+                )
 
-            assert not isinstance(exc_info.value, github_backup.RepositoryUnavailableError)
+            assert not isinstance(
+                exc_info.value, github_backup.RepositoryUnavailableError
+            )
             assert "404" in str(exc_info.value)
 
 
@@ -151,7 +174,7 @@ class TestMakeRequestWithRetry:
         good_response.read.return_value = b'{"ok": true}'
 
         call_count = 0
-        fail_count = MAX_RETRIES - 1  # Fail all but last attempt
+        fail_count = DEFAULT_MAX_RETRIES  # Fail all retries, succeed on last attempt
 
         def mock_urlopen(*args, **kwargs):
             nonlocal call_count
@@ -167,14 +190,18 @@ class TestMakeRequestWithRetry:
             return good_response
 
         with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
-            with patch("github_backup.github_backup.calculate_retry_delay", return_value=0):
+            with patch(
+                "github_backup.github_backup.calculate_retry_delay", return_value=0
+            ):
                 result = make_request_with_retry(Mock(), None)
 
         assert result == good_response
-        assert call_count == MAX_RETRIES
+        assert (
+            call_count == DEFAULT_MAX_RETRIES + 1
+        )  # 1 initial + 5 retries = 6 attempts
 
     def test_503_error_retries_until_exhausted(self):
-        """HTTP 503 should retry MAX_RETRIES times then raise."""
+        """HTTP 503 should make 1 initial + DEFAULT_MAX_RETRIES retry attempts then raise."""
         call_count = 0
 
         def mock_urlopen(*args, **kwargs):
@@ -189,12 +216,16 @@ class TestMakeRequestWithRetry:
             )
 
         with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
-            with patch("github_backup.github_backup.calculate_retry_delay", return_value=0):
+            with patch(
+                "github_backup.github_backup.calculate_retry_delay", return_value=0
+            ):
                 with pytest.raises(HTTPError) as exc_info:
                     make_request_with_retry(Mock(), None)
 
         assert exc_info.value.code == 503
-        assert call_count == MAX_RETRIES
+        assert (
+            call_count == DEFAULT_MAX_RETRIES + 1
+        )  # 1 initial + 5 retries = 6 attempts
 
     def test_404_error_not_retried(self):
         """HTTP 404 should not be retried - raise immediately."""
@@ -237,7 +268,9 @@ class TestMakeRequestWithRetry:
             return good_response
 
         with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
-            with patch("github_backup.github_backup.calculate_retry_delay", return_value=0):
+            with patch(
+                "github_backup.github_backup.calculate_retry_delay", return_value=0
+            ):
                 result = make_request_with_retry(Mock(), None)
 
         assert result == good_response
@@ -269,7 +302,7 @@ class TestMakeRequestWithRetry:
         """URLError (connection error) should retry and succeed if subsequent request works."""
         good_response = Mock()
         call_count = 0
-        fail_count = MAX_RETRIES - 1  # Fail all but last attempt
+        fail_count = DEFAULT_MAX_RETRIES  # Fail all retries, succeed on last attempt
 
         def mock_urlopen(*args, **kwargs):
             nonlocal call_count
@@ -279,14 +312,18 @@ class TestMakeRequestWithRetry:
             return good_response
 
         with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
-            with patch("github_backup.github_backup.calculate_retry_delay", return_value=0):
+            with patch(
+                "github_backup.github_backup.calculate_retry_delay", return_value=0
+            ):
                 result = make_request_with_retry(Mock(), None)
 
         assert result == good_response
-        assert call_count == MAX_RETRIES
+        assert (
+            call_count == DEFAULT_MAX_RETRIES + 1
+        )  # 1 initial + 5 retries = 6 attempts
 
     def test_socket_error_retries_until_exhausted(self):
-        """socket.error should retry MAX_RETRIES times then raise."""
+        """socket.error should make 1 initial + DEFAULT_MAX_RETRIES retry attempts then raise."""
         call_count = 0
 
         def mock_urlopen(*args, **kwargs):
@@ -295,11 +332,15 @@ class TestMakeRequestWithRetry:
             raise socket.error("Connection reset by peer")
 
         with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
-            with patch("github_backup.github_backup.calculate_retry_delay", return_value=0):
+            with patch(
+                "github_backup.github_backup.calculate_retry_delay", return_value=0
+            ):
                 with pytest.raises(socket.error):
                     make_request_with_retry(Mock(), None)
 
-        assert call_count == MAX_RETRIES
+        assert (
+            call_count == DEFAULT_MAX_RETRIES + 1
+        )  # 1 initial + 5 retries = 6 attempts
 
 
 class TestRetrieveDataThrottling:
@@ -315,6 +356,7 @@ class TestRetrieveDataThrottling:
         args.osx_keychain_item_account = None
         args.throttle_limit = 10  # Throttle when remaining <= 10
         args.throttle_pause = 5  # Pause 5 seconds
+        args.max_retries = DEFAULT_MAX_RETRIES
         return args
 
     def test_throttling_pauses_when_rate_limit_low(self, mock_args):
@@ -322,11 +364,19 @@ class TestRetrieveDataThrottling:
         mock_response = Mock()
         mock_response.getcode.return_value = 200
         mock_response.read.return_value = json.dumps([{"id": 1}]).encode("utf-8")
-        mock_response.headers = {"x-ratelimit-remaining": "5", "Link": ""}  # Below throttle_limit
+        mock_response.headers = {
+            "x-ratelimit-remaining": "5",
+            "Link": "",
+        }  # Below throttle_limit
 
-        with patch("github_backup.github_backup.make_request_with_retry", return_value=mock_response):
+        with patch(
+            "github_backup.github_backup.make_request_with_retry",
+            return_value=mock_response,
+        ):
             with patch("github_backup.github_backup.time.sleep") as mock_sleep:
-                github_backup.retrieve_data(mock_args, "https://api.github.com/repos/test/repo/issues")
+                github_backup.retrieve_data(
+                    mock_args, "https://api.github.com/repos/test/repo/issues"
+                )
 
         mock_sleep.assert_called_once_with(5)  # throttle_pause value
 
@@ -344,16 +394,121 @@ class TestRetrieveDataSingleItem:
         args.osx_keychain_item_account = None
         args.throttle_limit = None
         args.throttle_pause = 0
+        args.max_retries = DEFAULT_MAX_RETRIES
         return args
 
     def test_dict_response_returned_as_list(self, mock_args):
         """Single dict response should be returned as a list with one item."""
         mock_response = Mock()
         mock_response.getcode.return_value = 200
-        mock_response.read.return_value = json.dumps({"login": "testuser", "id": 123}).encode("utf-8")
+        mock_response.read.return_value = json.dumps(
+            {"login": "testuser", "id": 123}
+        ).encode("utf-8")
         mock_response.headers = {"x-ratelimit-remaining": "5000", "Link": ""}
 
-        with patch("github_backup.github_backup.make_request_with_retry", return_value=mock_response):
-            result = github_backup.retrieve_data(mock_args, "https://api.github.com/user")
+        with patch(
+            "github_backup.github_backup.make_request_with_retry",
+            return_value=mock_response,
+        ):
+            result = github_backup.retrieve_data(
+                mock_args, "https://api.github.com/user"
+            )
 
         assert result == [{"login": "testuser", "id": 123}]
+
+
+class TestRetriesCliArgument:
+    """Tests for --retries CLI argument validation and behavior."""
+
+    def test_retries_argument_accepted(self):
+        """--retries flag should be accepted and parsed correctly."""
+        args = github_backup.parse_args(["--retries", "3", "testuser"])
+        assert args.max_retries == 3
+
+    def test_retries_default_value(self):
+        """--retries should default to 5 if not specified."""
+        args = github_backup.parse_args(["testuser"])
+        assert args.max_retries == 5
+
+    def test_retries_zero_is_valid(self):
+        """--retries 0 should be valid and mean 1 attempt (no retries)."""
+        args = github_backup.parse_args(["--retries", "0", "testuser"])
+        assert args.max_retries == 0
+
+    def test_retries_negative_rejected(self):
+        """--retries with negative value should be rejected by argparse."""
+        with pytest.raises(SystemExit):
+            github_backup.parse_args(["--retries", "-1", "testuser"])
+
+    def test_retries_non_integer_rejected(self):
+        """--retries with non-integer value should be rejected by argparse."""
+        with pytest.raises(SystemExit):
+            github_backup.parse_args(["--retries", "abc", "testuser"])
+
+    def test_retries_one_with_transient_error_succeeds(self):
+        """--retries 1 should allow one retry after initial failure."""
+        good_response = Mock()
+        good_response.read.return_value = b'{"ok": true}'
+
+        call_count = 0
+
+        def mock_urlopen(*args, **kwargs):
+            nonlocal call_count
+            call_count += 1
+            if call_count == 1:
+                raise HTTPError(
+                    url="https://api.github.com/test",
+                    code=502,
+                    msg="Bad Gateway",
+                    hdrs={"x-ratelimit-remaining": "5000"},
+                    fp=None,
+                )
+            return good_response
+
+        with patch("github_backup.github_backup.urlopen", side_effect=mock_urlopen):
+            with patch(
+                "github_backup.github_backup.calculate_retry_delay", return_value=0
+            ):
+                result = make_request_with_retry(Mock(), None, max_retries=1)
+
+        assert result == good_response
+        assert call_count == 2  # 1 initial + 1 retry = 2 attempts
+
+    def test_custom_retry_count_limits_attempts(self):
+        """Custom --retries value should limit actual retry attempts."""
+        args = Mock()
+        args.as_app = False
+        args.token_fine = None
+        args.token_classic = "fake_token"
+        args.osx_keychain_item_name = None
+        args.osx_keychain_item_account = None
+        args.throttle_limit = None
+        args.throttle_pause = 0
+        args.max_retries = 2  # 2 retries = 3 total attempts (1 initial + 2 retries)
+
+        mock_response = Mock()
+        mock_response.getcode.return_value = 200
+        mock_response.read.return_value = b"not valid json {"
+        mock_response.headers = {"x-ratelimit-remaining": "5000"}
+
+        call_count = 0
+
+        def mock_make_request(*args, **kwargs):
+            nonlocal call_count
+            call_count += 1
+            return mock_response
+
+        with patch(
+            "github_backup.github_backup.make_request_with_retry",
+            side_effect=mock_make_request,
+        ):
+            with patch(
+                "github_backup.github_backup.calculate_retry_delay", return_value=0
+            ):
+                with pytest.raises(Exception) as exc_info:
+                    github_backup.retrieve_data(
+                        args, "https://api.github.com/repos/test/repo/issues"
+                    )
+
+        assert "Failed to read response after 3 attempts" in str(exc_info.value)
+        assert call_count == 3  # 1 initial + 2 retries = 3 attempts