Adding communications Retry functionality into requests via urllib3 retry object. (#1002)

This is a continuation of the work started by @allevin on https://github.com/PyGithub/PyGithub/pull/860. I have refactored the testing Framework to use the `httpretty` library in order to use the urllib3 retry feature and therefore be able to test it. Please refer to https://github.com/PyGithub/PyGithub/pull/860 for additional context. cc: @allevin @mfonville @jrouquie @sfdye Closes #757 Closes #860
2026-09-01 19:31:10 +00:00 · 2019-04-05 13:49:01 +08:00
parent 6efd631890
commit 5ae7af55ea
13 changed files with 311 additions and 28 deletions
@@ -0,0 +1,86 @@
+# -*- coding: utf-8 -*-
+
+############################ Copyrights and license ############################
+#                                                                              #
+# Copyright 2018 Justin Kufro <jkufro@andrew.cmu.edu>                          #
+# Copyright 2018 Ivan Minno <iminno@andrew.cmu.edu>                            #
+# Copyright 2018 Zilei Gu <zileig@andrew.cmu.edu>                              #
+# Copyright 2018 Yves Zumbach <yzumbach@andrew.cmu.edu>                        #
+# Copyright 2018 Leying Chen <leyingc@andrew.cmu.edu>                          #
+#                                                                              #
+# This file is part of PyGithub.                                               #
+# http://pygithub.readthedocs.io/                                              #
+#                                                                              #
+# PyGithub is free software: you can redistribute it and/or modify it under    #
+# the terms of the GNU Lesser General Public License as published by the Free  #
+# Software Foundation, either version 3 of the License, or (at your option)    #
+# any later version.                                                           #
+#                                                                              #
+# PyGithub is distributed in the hope that it will be useful, but WITHOUT ANY  #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS    #
+# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more #
+# details.                                                                     #
+#                                                                              #
+# You should have received a copy of the GNU Lesser General Public License     #
+# along with PyGithub. If not, see <http://www.gnu.org/licenses/>.             #
+#                                                                              #
+################################################################################
+import urllib3
+from httpretty import httpretty
+
+import Framework
+
+import requests
+
+from github import GithubException
+from github.Repository import Repository
+
+REPO_NAME = 'PyGithub/PyGithub'
+
+
+class Retry(Framework.TestCase):
+    def setUp(self):
+        # status codes returned on random github server errors
+        status_forcelist = (500, 502, 504)
+        retry = urllib3.Retry(
+            total=3,
+            read=3,
+            connect=3,
+            status_forcelist=status_forcelist
+        )
+
+        Framework.enableRetry(retry)
+        Framework.TestCase.setUp(self)
+
+    def testShouldNotRetryWhenStatusNotOnList(self):
+        try:
+            self.g.get_repo(REPO_NAME)
+        except GithubException:
+            self.assertEquals(len(httpretty.latest_requests), 1)
+
+    def testReturnsRepoAfter3Retries(self):
+        repository = self.g.get_repo(REPO_NAME)
+        self.assertEquals(len(httpretty.latest_requests), 4)
+        for request in httpretty.latest_requests:
+            self.assertEquals(request.path, '/repos/' + REPO_NAME)
+
+        self.assertIsInstance(repository, Repository)
+        self.assertEquals(repository.full_name, REPO_NAME)
+
+    def testReturnsRepoAfter1Retry(self):
+        repository = self.g.get_repo(REPO_NAME)
+        self.assertEquals(len(httpretty.latest_requests), 2)
+        for request in httpretty.latest_requests:
+            self.assertEquals(request.path, '/repos/' + REPO_NAME)
+
+        self.assertIsInstance(repository, Repository)
+        self.assertEquals(repository.full_name, REPO_NAME)
+
+    def testRaisesRetryErrorAfterMaxRetries(self):
+        try:
+            response = self.g.get_repo('PyGithub/PyGithub')
+            self.fail("RetryError should have been raised")
+        except requests.exceptions.RetryError:
+            self.assertEquals(len(httpretty.latest_requests), 4)
+            for request in httpretty.latest_requests:
+                self.assertEquals(request.path, '/repos/PyGithub/PyGithub')