Skip to content

[Documentation] Added missing docstrings to 7 function(s) in devel. #2410

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

Closed
wants to merge 1 commit into from
Closed

[Documentation] Added missing docstrings to 7 function(s) in devel. #2410

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
72 changes: 19 additions & 53 deletions tests/test_probes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,101 +5,67 @@
from sherlock_project.sherlock import sherlock
from sherlock_project.notify import QueryNotify
from sherlock_project.result import QueryStatus
#from sherlock_interactives import Interactives


def simple_query(sites_info: dict, site: str, username: str) -> QueryStatus:
"""Return the result of simple_query using parameters: sites_info, site, username."""
query_notify = QueryNotify()
site_data: dict = {}
site_data[site] = sites_info[site]
return sherlock(
username=username,
site_data=site_data,
query_notify=query_notify,
)[site]['status'].status

return sherlock(username=username, site_data=site_data, query_notify=query_notify)[site]['status'].status

@pytest.mark.online
class TestLiveTargets:
"""Actively test probes against live and trusted targets"""
# Known positives should only use sites trusted to be reliable and unchanging
@pytest.mark.parametrize('site,username',[
('GitLab', 'ppfeister'),
('AllMyLinks', 'blue'),
])

@pytest.mark.parametrize('site,username', [('GitLab', 'ppfeister'), ('AllMyLinks', 'blue')])
def test_known_positives_via_message(self, sites_info, site, username):
"""Compute test_known_positives_via_message given sites_info, site, username."""
assert simple_query(sites_info=sites_info, site=site, username=username) is QueryStatus.CLAIMED


# Known positives should only use sites trusted to be reliable and unchanging
@pytest.mark.parametrize('site,username',[
('GitHub', 'ppfeister'),
('GitHub', 'sherlock-project'),
('Docker Hub', 'ppfeister'),
('Docker Hub', 'sherlock'),
])
@pytest.mark.parametrize('site,username', [('GitHub', 'ppfeister'), ('GitHub', 'sherlock-project'), ('Docker Hub', 'ppfeister'), ('Docker Hub', 'sherlock')])
def test_known_positives_via_status_code(self, sites_info, site, username):
"""Implement the test_known_positives_via_status_code operation on the given input: sites_info, site, username."""
assert simple_query(sites_info=sites_info, site=site, username=username) is QueryStatus.CLAIMED


# Known positives should only use sites trusted to be reliable and unchanging
@pytest.mark.parametrize('site,username',[
('Keybase', 'blue'),
('devRant', 'blue'),
])
@pytest.mark.parametrize('site,username', [('Keybase', 'blue'), ('devRant', 'blue')])
def test_known_positives_via_response_url(self, sites_info, site, username):
"""Calculate and return the output of test_known_positives_via_response_url based on sites_info, site, username."""
assert simple_query(sites_info=sites_info, site=site, username=username) is QueryStatus.CLAIMED


# Randomly generate usernames of high length and test for positive availability
# Randomly generated usernames should be simple alnum for simplicity and high
# compatibility. Several attempts may be made ~just in case~ a real username is
# generated.
@pytest.mark.parametrize('site,random_len',[
('GitLab', 255),
('Codecademy', 30)
])
@pytest.mark.parametrize('site,random_len', [('GitLab', 255), ('Codecademy', 30)])
def test_likely_negatives_via_message(self, sites_info, site, random_len):
"""Execute test_likely_negatives_via_message with input (sites_info, site, random_len)."""
num_attempts: int = 3
attempted_usernames: list[str] = []
status: QueryStatus = QueryStatus.CLAIMED
for i in range(num_attempts):
acceptable_types = string.ascii_letters + string.digits
random_handle = ''.join(random.choice(acceptable_types) for _ in range (random_len))
random_handle = ''.join((random.choice(acceptable_types) for _ in range(random_len)))
attempted_usernames.append(random_handle)
status = simple_query(sites_info=sites_info, site=site, username=random_handle)
if status is QueryStatus.AVAILABLE:
break
assert status is QueryStatus.AVAILABLE, f"Could not validate available username after {num_attempts} attempts with randomly generated usernames {attempted_usernames}."

assert status is QueryStatus.AVAILABLE, f'Could not validate available username after {num_attempts} attempts with randomly generated usernames {attempted_usernames}.'

# Randomly generate usernames of high length and test for positive availability
# Randomly generated usernames should be simple alnum for simplicity and high
# compatibility. Several attempts may be made ~just in case~ a real username is
# generated.
@pytest.mark.parametrize('site,random_len',[
('GitHub', 39),
('Docker Hub', 30)
])
@pytest.mark.parametrize('site,random_len', [('GitHub', 39), ('Docker Hub', 30)])
def test_likely_negatives_via_status_code(self, sites_info, site, random_len):
"""Return the result of test_likely_negatives_via_status_code using parameters: sites_info, site, random_len."""
num_attempts: int = 3
attempted_usernames: list[str] = []
status: QueryStatus = QueryStatus.CLAIMED
for i in range(num_attempts):
acceptable_types = string.ascii_letters + string.digits
random_handle = ''.join(random.choice(acceptable_types) for _ in range (random_len))
random_handle = ''.join((random.choice(acceptable_types) for _ in range(random_len)))
attempted_usernames.append(random_handle)
status = simple_query(sites_info=sites_info, site=site, username=random_handle)
if status is QueryStatus.AVAILABLE:
break
assert status is QueryStatus.AVAILABLE, f"Could not validate available username after {num_attempts} attempts with randomly generated usernames {attempted_usernames}."

assert status is QueryStatus.AVAILABLE, f'Could not validate available username after {num_attempts} attempts with randomly generated usernames {attempted_usernames}.'

def test_username_illegal_regex(sites_info):
"""Return the result of test_username_illegal_regex using parameters: sites_info."""
site: str = 'BitBucket'
invalid_handle: str = '*#$Y&*JRE'
pattern = re.compile(sites_info[site]['regexCheck'])
# Ensure that the username actually fails regex before testing sherlock
assert pattern.match(invalid_handle) is None
assert simple_query(sites_info=sites_info, site=site, username=invalid_handle) is QueryStatus.ILLEGAL

assert simple_query(sites_info=sites_info, site=site, username=invalid_handle) is QueryStatus.ILLEGAL