feat: support retry_transient_errors through config

javatarz · javatarz · commit bfb087541874 · 2021-08-22T10:03:26.000+05:30
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -250,6 +250,7 @@ def from_config(
             pagination=config.pagination,
             order_by=config.order_by,
             user_agent=config.user_agent,
+            retry_transient_errors=config.retry_transient_errors,
         )
 
     def auth(self) -> None:
diff --git a/gitlab/config.py b/gitlab/config.py
@@ -206,6 +206,20 @@ def __init__(
         except Exception:
             pass
 
+        self.retry_transient_errors = False
+        try:
+            self.retry_transient_errors = self._config.get(
+                "global", "retry_transient_errors"
+            )
+        except Exception:
+            pass
+        try:
+            self.retry_transient_errors = self._config.get(
+                self.gitlab_id, "retry_transient_errors"
+            )
+        except Exception:
+            pass
+
     def _get_values_from_helper(self) -> None:
         """Update attributes that may get values from an external helper program"""
         for attr in HELPER_ATTRIBUTES:
diff --git a/tests/unit/test_config.py b/tests/unit/test_config.py
@@ -86,6 +86,33 @@
 """
 
 
+def global_retry_transient_errors(value: bool) -> str:
+    return u"""[global]
+default = one
+retry_transient_errors={}
+
+[one]
+url = http://one.url
+private_token = ABCDEF""".format(
+        value
+    )
+
+
+def global_and_gitlab_retry_transient_errors(
+    global_value: bool, gitlab_value: bool
+) -> str:
+    return u"""[global]
+    default = one
+    retry_transient_errors={global_value}
+
+    [one]
+    url = http://one.url
+    private_token = ABCDEF
+    retry_transient_errors={gitlab_value}""".format(
+        global_value=global_value, gitlab_value=gitlab_value
+    )
+
+
 @mock.patch.dict(os.environ, {"PYTHON_GITLAB_CFG": "/some/path"})
 def test_env_config_present():
     assert ["/some/path"] == config._env_config()
@@ -245,3 +272,48 @@ def test_config_user_agent(m_open, path_exists, config_string, expected_agent):
 
     cp = config.GitlabConfigParser()
     assert cp.user_agent == expected_agent
+
+
+@mock.patch("os.path.exists")
+@mock.patch("builtins.open")
+@pytest.mark.parametrize(
+    "config_string,expected",
+    [
+        pytest.param(valid_config, False, id="default_value"),
+        pytest.param(
+            global_retry_transient_errors(True), "True", id="global_config_true"
+        ),
+        pytest.param(
+            global_retry_transient_errors(False), "False", id="global_config_false"
+        ),
+        pytest.param(
+            global_and_gitlab_retry_transient_errors(False, True),
+            "True",
+            id="gitlab_overrides_global_true",
+        ),
+        pytest.param(
+            global_and_gitlab_retry_transient_errors(True, False),
+            "False",
+            id="gitlab_overrides_global_false",
+        ),
+        pytest.param(
+            global_and_gitlab_retry_transient_errors(True, True),
+            "True",
+            id="gitlab_equals_global_true",
+        ),
+        pytest.param(
+            global_and_gitlab_retry_transient_errors(False, False),
+            "False",
+            id="gitlab_equals_global_false",
+        ),
+    ],
+)
+def test_config_retry_transient_errors_when_global_config_is_set(
+    m_open, path_exists, config_string, expected
+):
+    fd = io.StringIO(config_string)
+    fd.close = mock.Mock(return_value=None)
+    m_open.return_value = fd
+
+    cp = config.GitlabConfigParser()
+    assert cp.retry_transient_errors == expected

Original file line number	Diff line number	Diff line change
`@@ -250,6 +250,7 @@ def from_config(`
`250`	`250`	`pagination=config.pagination,`
`251`	`251`	`order_by=config.order_by,`
`252`	`252`	`user_agent=config.user_agent,`
	`253`	`+ retry_transient_errors=config.retry_transient_errors,`
`253`	`254`	`)`
`254`	`255`
`255`	`256`	`def auth(self) -> None:`