Skip to content

handle github api pagination when present (WIP) #2776

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
migueldiascosta wants to merge 7 commits into
base: develop
Choose a base branch
from
Open

handle github api pagination when present (WIP) #2776

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
67409d2
handle github api pagination when present
migueldiascosta Jan 29, 2019
68bf52b
get link header inside try block
migueldiascosta Jan 29, 2019
38fa4b1
Merge branch 'develop' of github.com:easybuilders/easybuild-framework…
migueldiascosta Feb 1, 2019
4a5166c
refactor handling of github pagination
migueldiascosta Feb 21, 2019
b015c91
Merge branch 'develop' into github_api_pagination
migueldiascosta Feb 21, 2019
5e44ce6
test handling of github pagination
migueldiascosta Feb 21, 2019
fcd265f
remove unnecessary break
migueldiascosta Feb 21, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions easybuild/tools/github.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,10 +243,33 @@ def github_api_get_request(request_f, github_user=None, token=None, **kwargs):
url = request_f(RestClient(GITHUB_API_URL, username=github_user, token=token))

try:
status, data = url.get(**kwargs)
status, headers = url.head(**kwargs)
except socket.gaierror as err:
_log.warning("Error occurred while performing get request: %s", err)
status, data = 0, None
_log.warning("Error occurred while performing head request: %s", err)
status, headers = 0, None

pages = [1]
if headers:
links = headers.getheader('Link')
if links:
match = re.search(r"page=(\d+)>; rel=\"last\"", links)
if match:
last = int(match.groups()[0])
pages = range(1, last+1)

data = []
for page in pages:
kwargs['page'] = page
try:
status, page_data = url.get(**kwargs)
except socket.gaierror as err:
_log.warning("Error occurred while performing get request: %s", err)
status, page_data = 0, None
break
if isinstance(page_data, list):
data.extend(page_data)
else:
data = page_data

_log.debug("get request result for %s: status: %d, data: %s", url, status, data)
return (status, data)
Expand Down
5 changes: 5 additions & 0 deletions test/framework/github.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,11 @@ def test_list_prs(self):
output = gh.list_prs(parameters, per_page=1, github_user=GITHUB_TEST_ACCOUNT)
self.assertEqual(expected, output)

# test handling of github pagination
parameters = ('all', 'created', 'asc')
output = gh.list_prs(parameters, per_page=1, github_user=GITHUB_TEST_ACCOUNT)
self.assertTrue(len(output.splitlines()) > 1)

def test_reasons_for_closing(self):
"""Test reasons_for_closing function."""
if self.skip_github_tests:
Expand Down