def test_find_unmapped_scans(mock_hub_instance):
sage = BlackDuckSage(mock_hub_instance, file=f_name)
sage.data['scans'] = [
{
'name': 'scan1',
'mappedProjectVersion': "https://fake-url"
},
{
'name': 'scan2',
'mappedProjectVersion': "https://fake-url"
},
{
'name': 'scan3',
'mappedProjectVersion': "https://fake-url"
},
{
'name': 'unmapped_scan'
},
]
sage._find_unmapped_scans()
assert 'unmapped_scans' in sage.data
assert 'total_unmapped_scans' in sage.data
assert sage.data['unmapped_scans'] == [{
'name':
'unmapped_scan',
'message':
'This scan, unmapped_scan, is not mapped to any project-version in the system. It should either be mapped to something or deleted to reclaim space and reduce clutter.'
}]
assert sage.data['total_unmapped_scans'] == 1
def test_is_siganture_scan(mock_hub_instance):
sage = BlackDuckSage(mock_hub_instance, file=f_name)
test_data = [
(False, "bom"),
(True, "scan"),
(True, "is a scan"),
(True, "SCAN"),
(False, "scan name string with scan at beginning of string, not end"),
]
for td in test_data:
expected_result = td[0]
scan_name = td[1]
scan_obj = {'name': scan_name}
assert expected_result == sage._is_signature_scan(scan_obj)
def test_find_projects_with_too_many_versions(mock_hub_instance):
sage = BlackDuckSage(mock_hub_instance, file=f_name)
sage.data = {
'projects': [
{
'name': 'projects_with_too_many_versions',
},
{
'name': 'project2',
},
]
}
sage.data['projects'][0]['versions'] = [{
'versionName': i,
'num_scans': 2
} for i in range(21)]
sage.data['projects'][1]['versions'] = [{
'versionName': i,
'num_scans': 2
} for i in range(2)]
for p in sage.data['projects']:
p['num_versions'] = len(p['versions'])
sage._find_projects_with_too_many_versions()
assert len(sage.data['projects_with_too_many_versions']) == 1
for p in sage.data['projects_with_too_many_versions']:
assert p['name'] == 'projects_with_too_many_versions'
assert p['num_versions'] == 21
def test_find_versions_with_zero_scans(mock_hub_instance):
sage = BlackDuckSage(mock_hub_instance, file=f_name)
sage.data = {
'projects': [
{
'name':
'project1',
'versions': [
{
'project_name': 'project1',
'versionName': '1.0',
'num_scans': 0
},
{
'project_name': 'project1',
'versionName': '2.0',
'num_scans': 1
},
]
},
{
'name':
'project2',
'versions': [
{
'project_name': 'project2',
'versionName': '1.0',
'num_scans': 0
},
{
'project_name': 'project2',
'versionName': '2.0',
'num_scans': 1
},
]
},
]
}
sage._find_versions_with_zero_scans()
assert len(sage.data['versions_with_zero_scans']) == 2
for v in sage.data['versions_with_zero_scans']:
assert v['num_scans'] == 0
assert 'versionName' in v
assert v['versionName'] == "1.0"
def test_check_file_permissions(mock_hub_instance):
f_no_write_name = "/tmp/file_with_no_write_permission"
file_with_no_write_permission = open(f_no_write_name, "w")
os.chmod(f_no_write_name, S_IREAD | S_IRGRP | S_IROTH)
with pytest.raises(PermissionError) as e_info:
sage = BlackDuckSage(mock_hub_instance, file=f_no_write_name)
os.remove(f_no_write_name)
def test_is_bom_scan(mock_hub_instance):
sage = BlackDuckSage(mock_hub_instance, file=f_name)
test_data = [
(False, "scan"),
(True, "bom"),
(True, "is a bom"),
(True, "BOM"),
(True, "Black Duck I/O Export"),
(False,
"bom scan name string with bom at beginning of string, not end"),
]
for td in test_data:
expected_result = td[0]
scan_name = td[1]
scan_obj = {'name': scan_name}
assert expected_result == sage._is_bom_scan(scan_obj)
def test_construction(mock_hub_instance):
sage = BlackDuckSage(mock_hub_instance, file=f_name)
assert 'version' in sage.hub.version_info
assert sage.hub.version_info['version'] == hub_version
assert sage.file == f_name
assert sage.max_versions_per_project == 20
assert sage.max_scans_per_version == 10
assert sage.max_age_for_unmapped_scans == 365
assert sage.min_time_between_versions == 1
assert sage.min_ratio_of_released_versions == 0.1
assert sage.max_recommended_projects == 1000
assert sage.max_time_to_retrieve_projects == 60
with pytest.raises(Exception) as e_info:
class NotAHubInstance:
pass
not_a_hub_instance = NotAHubInstance()
sage = BlackDuckSage(not_a_hub_instance)
def test_get_data(mock_hub_instance):
sage = BlackDuckSage(mock_hub_instance, file=f_name)
num_projects = 10
get_projects_return = {
'items': [{
'name': 'project{}'.format(i),
'_meta': {
'href': 'proj_url_{}'.format(i)
}
} for i in range(num_projects)]
}
sage.hub.get_projects = MagicMock(return_value=get_projects_return)
num_versions_per_project = 10
get_project_versions_return = {
'items': [{
'versionName': '{}.0'.format(i),
'_meta': {
'href': 'v_url_{}'.format(i)
}
} for i in range(num_versions_per_project)]
}
sage.hub.get_project_versions = MagicMock(
return_value=get_project_versions_return)
num_scans_per_version = 3
get_version_codelocations_return = {
'items': [{
'name': 'scan{}'.format(i),
'_meta': {
'href': 's_url_{}'.format(i)
}
} for i in range(num_scans_per_version)]
}
sage.hub.get_version_codelocations = MagicMock(
return_value=get_version_codelocations_return)
num_policies = 5
get_policies_return = {
'items': [{
'name': 'policy_{}'.format(i),
'_meta': {
'href': 'policy_url_{}'.format(i)
}
} for i in range(num_policies)]
}
sage.hub.get_policies = MagicMock(return_value=get_policies_return)
total_num_scans = 100
get_codelocations_return = {
'items': [{
'name': 'scan{}'.format(i),
'_meta': {
'href': 's_url_{}'.format(i)
}
} for i in range(total_num_scans)]
}
sage.hub.get_codelocations = MagicMock(
return_value=get_codelocations_return)
sage.hub.get_codelocation_scan_summaries = MagicMock()
sage.data = {}
sage._get_data()
sage.hub.get_projects.assert_called_once_with(limit=99999)
assert len(sage.data['projects']) == num_projects
assert sage.hub.get_project_versions.call_count == num_projects
assert sage.hub.get_version_codelocations.call_count == num_projects * num_versions_per_project
sage.hub.get_policies.assert_called_once_with(parameters={'limit': 1000})
sage.hub.get_codelocations.assert_called_once_with(limit=99999)
assert sage.data['total_projects'] == num_projects
assert sage.data[
'total_versions'] == num_projects * num_versions_per_project
assert sage.data['total_scans'] == total_num_scans
assert sage.data['scans'] == get_codelocations_return['items']
def test_find_high_frequency_scans(mock_hub_instance):
sage = BlackDuckSage(mock_hub_instance, file=f_name)
one_scan_summary = [{
'createdAt':
datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%S.%fZ"),
'updatedAt': (datetime.now(timezone.utc) +
timedelta(minutes=2)).strftime("%Y-%m-%dT%H:%M:%S.%fZ")
}]
high_freq_scan_summaries = []
for i in range(5):
high_freq_scan_summaries.append({
'createdAt':
(datetime.now(timezone.utc) +
timedelta(minutes=i * 60)).strftime("%Y-%m-%dT%H:%M:%S.%fZ"),
'updatedAt':
(datetime.now(timezone.utc) + timedelta(minutes=i * 60) +
timedelta(minutes=2)).strftime("%Y-%m-%dT%H:%M:%S.%fZ")
})
lower_freq_scan_summaries = []
for i in range(5):
lower_freq_scan_summaries.append({
'createdAt':
(datetime.now(timezone.utc) +
timedelta(days=i * 60)).strftime("%Y-%m-%dT%H:%M:%S.%fZ"),
'updatedAt':
(datetime.now(timezone.utc) + timedelta(days=i * 60) +
timedelta(minutes=2)).strftime("%Y-%m-%dT%H:%M:%S.%fZ")
})
sage.data['scans'] = [
{
'name': 'one_scan',
'scan_summaries': one_scan_summary
},
{
'name': 'high_freq_scan',
'scan_summaries': high_freq_scan_summaries
},
{
'name': 'lower_freq_scan',
'scan_summaries': lower_freq_scan_summaries
},
]
sage._find_high_frequency_scans()
assert 'high_frequency_scans' in sage.data
assert 'high_freq_scan' in [
s['name'] for s in sage.data['high_frequency_scans']
]
assert 'one_scan' not in [
s['name'] for s in sage.data['high_frequency_scans']
]
assert 'lower_freq_scan' not in [
s['name'] for s in sage.data['high_frequency_scans']
]
#
# all high frequency scans should include a message explaining why this may be undesirable
assert all(map(lambda s: 'message' in s,
sage.data['high_frequency_scans']))