forked from blackducksoftware/sage
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_sage.py
356 lines (306 loc) · 12.6 KB
/
test_sage.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
from datetime import datetime, timedelta, timezone
import json
import os
import pytest
from stat import S_IREAD, S_IRGRP, S_IROTH, S_IWUSR
import uuid
from unittest.mock import MagicMock
from blackduck.HubRestApi import HubInstance
from sage import BlackDuckSage
fake_hub_host = "https://my-hub-host"
fake_bearer_token = "aFakeToken"
invalid_bearer_token="anInvalidTokenValue"
invalid_csrf_token="anInvalidCSRFTokenValue"
made_up_api_token="theMadeUpAPIToken"
hub_version = '2019.10.1'
string_length = 8
random_str = uuid.uuid4().hex
random_str = random_str.upper()[0:string_length]
f_name = "/tmp/sage_says.json_" + random_str
@pytest.fixture()
def mock_hub_instance(requests_mock):
requests_mock.post(
"https://my-hub-host/api/tokens/authenticate",
content = json.dumps({'bearerToken': invalid_bearer_token}).encode('utf-8'),
headers={
'X-CSRF-TOKEN': invalid_csrf_token,
'Content-Type': 'application/json'
}
)
requests_mock.get(
"{}/api/current-version".format(fake_hub_host),
json = {
"version": hub_version,
"_meta": {
"allow": [
"GET"
],
"href": "{}/api/current-version".format(fake_hub_host)
}
}
)
yield HubInstance(fake_hub_host, api_token=made_up_api_token)
try:
os.remove(f_name)
print("Removed {}".format(f_name))
except:
print("Failed to remove {}".format(f_name))
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_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_find_versions_with_too_many_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': 21
},
]
},
{
'name': 'project2',
'versions': [
{
'project_name': 'project2',
'versionName': '1.0',
'num_scans': 0
},
{
'project_name': 'project2',
'versionName': '2.0',
'num_scans': 21
},
]
},
{
'name': 'project3',
'versions': [
{
'project_name': 'project3',
'versionName': '1.0',
'num_scans': 0
},
{
'project_name': 'project3',
'versionName': '2.0',
'num_scans': 21
},
]
},
]
}
sage._find_versions_with_too_many_scans()
assert len(sage.data['versions_with_too_many_scans']) == 3
for v in sage.data['versions_with_too_many_scans']:
assert v['num_scans'] == 21
assert 'versionName' in v
assert v['versionName'] == "2.0"
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_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_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_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_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_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']))