Skip to content

update validate_github_token function to accept GitHub token in new format #3632

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

Merged
ocaisa merged 1 commit into from
Apr 6, 2021
Merged

update validate_github_token function to accept GitHub token in new format #3632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 12 additions & 3 deletions easybuild/tools/github.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2156,14 +2156,22 @@ def validate_github_token(token, github_user):
* see if it conforms expectations (only [a-f]+[0-9] characters, length of 40)
* see if it can be used for authenticated access
"""
sha_regex = re.compile('^[0-9a-f]{40}')
# cfr. https://github.blog/2021-04-05-behind-githubs-new-authentication-token-formats/
token_regex = re.compile('^ghp_[a-zA-Z0-9]{36}$')
token_regex_old_format = re.compile('^[0-9a-f]{40}$')

# token should be 40 characters long, and only contain characters in [0-9a-f]
sanity_check = bool(sha_regex.match(token))
sanity_check = bool(token_regex.match(token))
if sanity_check:
_log.info("Sanity check on token passed")
else:
_log.warning("Sanity check on token failed; token doesn't match pattern '%s'", sha_regex.pattern)
_log.warning("Sanity check on token failed; token doesn't match pattern '%s'", token_regex.pattern)
sanity_check = bool(token_regex_old_format.match(token))
if sanity_check:
_log.info("Sanity check on token (old format) passed")
else:
_log.warning("Sanity check on token failed; token doesn't match pattern '%s'",
token_regex_old_format.pattern)

# try and determine sha of latest commit in easybuilders/easybuild-easyconfigs repo through authenticated access
sha = None
Expand All @@ -2173,6 +2181,7 @@ def validate_github_token(token, github_user):
except Exception as err:
_log.warning("An exception occurred when trying to use token for authenticated GitHub access: %s", err)

sha_regex = re.compile('^[0-9a-f]{40}$')
token_test = bool(sha_regex.match(sha or ''))
if token_test:
_log.info("GitHub token can be used for authenticated GitHub access, validation passed")
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 @@ -547,6 +547,11 @@ def test_validate_github_token(self):

self.assertTrue(gh.validate_github_token(self.github_token, GITHUB_TEST_ACCOUNT))

# if a token in the old format is available, test with that too
token_old_format = os.getenv('TEST_GITHUB_TOKEN_OLD_FORMAT')
if token_old_format:
self.assertTrue(gh.validate_github_token(token_old_format, GITHUB_TEST_ACCOUNT))

def test_find_easybuild_easyconfig(self):
"""Test for find_easybuild_easyconfig function"""
if self.skip_github_tests:
Expand Down