def test_delete_with_scans(self):
"""Delete a Source used by a scan."""
cred = Credential(name='cred2', username='******',
password='******')
cred.save()
source = Source(name='cred_source',
source_type=Source.NETWORK_SOURCE_TYPE,
hosts=['1.2.3.4'])
source.save()
source.credentials.add(cred)
source.save()
scan = Scan(name='test_scan',
scan_type=ScanTask.SCAN_TYPE_CONNECT)
scan.save()
scan.sources.add(source)
url = reverse('source-detail', args=(source.id,))
response = self.client.delete(url, format='json')
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
response_json = response.json()
self.assertEqual(
response_json['detail'],
messages.SOURCE_DELETE_NOT_VALID_W_SCANS)
self.assertEqual(response_json['scans'][0]['name'], 'test_scan')
def setUp(self):
"""Create test setup."""
management.call_command('flush', '--no-input')
self.cred = Credential.objects.create(
name='cred1',
username='******',
password='******',
become_password=None,
ssh_keyfile=None)
self.cred_for_upload = self.cred.id
self.source = Source(
name='source1',
source_type='network',
port=22)
self.source.save()
self.source.credentials.add(self.cred)
# Create scan configuration
scan = Scan(name='scan_name',
scan_type=ScanTask.SCAN_TYPE_CONNECT)
scan.save()
# Add source to scan
scan.sources.add(self.source)
# Create Job
self.scan_job = ScanJob(scan=scan)
self.scan_job.save()
def setUp(self):
"""Create test setup."""
self.cred = Credential.objects.create(
name='cred1',
username='******',
password='******',
become_password=None,
ssh_keyfile=None)
self.cred_for_upload = self.cred.id
self.source = Source(
name='source1',
source_type='network',
port=22)
self.source.save()
self.source.credentials.add(self.cred)
self.connect_scan = Scan(name='connect_test',
scan_type=ScanTask.SCAN_TYPE_CONNECT)
self.connect_scan.save()
self.connect_scan.sources.add(self.source)
self.connect_scan.save()
self.inspect_scan = Scan(name='inspect_test')
self.inspect_scan.save()
self.inspect_scan.sources.add(self.source)
self.inspect_scan.save()
def test_get_scan(self):
user = User.objects.get(pk=1)
house_objects_all = House.objects.all()
house = random.choice(house_objects_all)
#print 'picked house %i' % house.pk
measure = random.choice(house.measures.all())
#print 'picked measure %i' % measure.pk
Scan(user=user, text="%04d%04d" % (house.id, measure.measure.id), timestamp=time.time()).save()
house = random.choice(house_objects_all)
measure = random.choice(house.measures.all())
Scan(user=user, text="%04d%04d" % (house.id, measure.measure.id), timestamp=time.time()).save()
report = ReportService().get_html_report(user=user)
print report
def test_queue_task(self):
"""Test create queue state change."""
# Cannot use util because its testing queue
# Create scan configuration
scan = Scan(name='test',
scan_type=ScanTask.SCAN_TYPE_INSPECT)
scan.save()
# Add source to scan
scan.sources.add(self.source)
options_to_use = ScanOptions()
options_to_use.save()
scan.options = options_to_use
scan.save()
# Create Job
scan_job = ScanJob(scan=scan)
scan_job.save()
# Job in created state
self.assertEqual(scan_job.status, ScanTask.CREATED)
tasks = scan_job.tasks.all()
self.assertEqual(len(tasks), 0)
# Queue job to run
scan_job.queue()
# Job should be in pending state
self.assertEqual(scan_job.status, ScanTask.PENDING)
# Queue should have created scan tasks
tasks = scan_job.tasks.all()
self.assertEqual(len(tasks), 2)
# Validate connect task created and correct
connect_task = tasks[0]
self.assertEqual(connect_task.scan_type, ScanTask.SCAN_TYPE_CONNECT)
self.assertEqual(connect_task.status, ScanTask.PENDING)
# Validate inspect task created and correct
inspect_task = tasks[1]
self.assertEqual(inspect_task.scan_type, ScanTask.SCAN_TYPE_INSPECT)
self.assertEqual(inspect_task.status, ScanTask.PENDING)
def create_scan_job_two_tasks(source,
source2,
scan_type=ScanTask.SCAN_TYPE_CONNECT,
scan_name='test',
scan_options=None):
"""Create a new scan job with two sources.
:param source: the source for the scan job
:param sourc2: the second source for the scan job
:param scan_type: Either connect or inspect
:param scan_options: Job scan options
:return: the scan job and task
"""
# Create scan configuration
scan = Scan(name=scan_name, scan_type=scan_type)
scan.save()
# Add source to scan
if source is not None:
scan.sources.add(source)
if source2 is not None:
scan.sources.add(source2)
# Add options to scan
if scan_options is not None:
scan.options = scan_options
scan.save()
# Create Job
scan_job = ScanJob(scan=scan)
scan_job.save()
scan_job.queue()
# grab the scan tasks
scan_tasks = scan_job.tasks.all()
if scan_type == ScanTask.SCAN_TYPE_INSPECT:
for task in scan_tasks:
task.complete()
return scan_job, scan_tasks
def create_scan_job(source,
scan_type=ScanTask.SCAN_TYPE_CONNECT,
scan_name='test',
scan_options=None):
"""Create a new scan job.
:param source: the source for the scan job
:param scan_type: Either connect or inspect
:param scan_options: Job scan options
:return: the scan job and task
"""
# Create scan configuration
scan = Scan(name=scan_name, scan_type=scan_type)
scan.save()
# Add source to scan
if source is not None:
scan.sources.add(source)
# Add options to scan
if scan_options is not None:
scan.options = scan_options
scan.save()
# Create Job
scan_job = ScanJob(scan=scan)
scan_job.save()
scan_job.queue()
# pylint: disable=no-member
scan_task = scan_job.tasks.first()
if scan_type == ScanTask.SCAN_TYPE_INSPECT:
scan_task.complete()
scan_task = scan_job.tasks.filter(
scan_type=ScanTask.SCAN_TYPE_INSPECT).first()
return scan_job, scan_task
def createScan(self, user, text):
scan = Scan(text=text, user=user, timestamp=time.time())
scan.save()
return scan
def setUp(self):
"""Create test setup."""
management.call_command('flush', '--no-input')
self.cred = Credential.objects.create(name='cred1',
username='******',
password='******',
become_password=None,
ssh_keyfile=None)
self.cred.save()
self.cred_for_upload = self.cred.id
self.source = Source(name='source1', source_type='network', port=22)
self.source.save()
self.source.credentials.add(self.cred)
self.source.save()
self.test1 = Scan(name='test1', scan_type=ScanTask.SCAN_TYPE_INSPECT)
self.test1.save()
self.test1.sources.add(self.source)
self.test1.save()
self.test2 = Scan(name='test2', scan_type=ScanTask.SCAN_TYPE_CONNECT)
self.test2.save()
self.test2.sources.add(self.source)
self.test2.save()
# self.test1 will not have a most_recent_scanjob, self.test2
# will.
job = ScanJob(scan=self.test2)
job.save()
job.sources.add(self.source)
job.save()
self.test2.most_recent_scanjob = job
self.test2.save()
results1 = [{
'id':
1,
'name':
'test1',
'sources': [{
'id': 1,
'name': 'source1',
'source_type': 'network'
}],
'scan_type':
'inspect'
}, {
'id':
2,
'jobs': [{
'id': 1
}],
'most_recent': {
'id': 1,
'scan_type': 'inspect',
'status': 'created',
'status_details': {
'job_status_message': 'Job is created.'
}
},
'name':
'test2',
'sources': [{
'id': 1,
'name': 'source1',
'source_type': 'network'
}],
'scan_type':
'connect'
}]
self.expected = {
'count': 2,
'next': None,
'previous': None,
'results': results1
}
class TestScanList(TestCase):
"""Tests for the List method.
These are separate from the other Scan tests because they have
more setup than the others.
"""
maxDiff = None
def setUp(self):
"""Create test setup."""
management.call_command('flush', '--no-input')
self.cred = Credential.objects.create(name='cred1',
username='******',
password='******',
become_password=None,
ssh_keyfile=None)
self.cred.save()
self.cred_for_upload = self.cred.id
self.source = Source(name='source1', source_type='network', port=22)
self.source.save()
self.source.credentials.add(self.cred)
self.source.save()
self.test1 = Scan(name='test1', scan_type=ScanTask.SCAN_TYPE_INSPECT)
self.test1.save()
self.test1.sources.add(self.source)
self.test1.save()
self.test2 = Scan(name='test2', scan_type=ScanTask.SCAN_TYPE_CONNECT)
self.test2.save()
self.test2.sources.add(self.source)
self.test2.save()
# self.test1 will not have a most_recent_scanjob, self.test2
# will.
job = ScanJob(scan=self.test2)
job.save()
job.sources.add(self.source)
job.save()
self.test2.most_recent_scanjob = job
self.test2.save()
results1 = [{
'id':
1,
'name':
'test1',
'sources': [{
'id': 1,
'name': 'source1',
'source_type': 'network'
}],
'scan_type':
'inspect'
}, {
'id':
2,
'jobs': [{
'id': 1
}],
'most_recent': {
'id': 1,
'scan_type': 'inspect',
'status': 'created',
'status_details': {
'job_status_message': 'Job is created.'
}
},
'name':
'test2',
'sources': [{
'id': 1,
'name': 'source1',
'source_type': 'network'
}],
'scan_type':
'connect'
}]
self.expected = {
'count': 2,
'next': None,
'previous': None,
'results': results1
}
def test_list(self):
"""List all scan objects."""
url = reverse('scan-list')
response = self.client.get(url)
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(response.json(), self.expected)
def test_list_by_scanjob_end_time(self):
"""List all scan objects, ordered by ScanJob start time."""
url = reverse('scan-list')
response = self.client.get(
url, {'ordering': 'most_recent_scanjob__start_time'})
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(response.json(), self.expected)
class ScanJobTest(TestCase):
"""Test the basic ScanJob infrastructure."""
def setUp(self):
"""Create test setup."""
self.cred = Credential.objects.create(
name='cred1',
username='******',
password='******',
become_password=None,
ssh_keyfile=None)
self.cred_for_upload = self.cred.id
self.source = Source(
name='source1',
source_type='network',
port=22)
self.source.save()
self.source.credentials.add(self.cred)
self.connect_scan = Scan(name='connect_test',
scan_type=ScanTask.SCAN_TYPE_CONNECT)
self.connect_scan.save()
self.connect_scan.sources.add(self.source)
self.connect_scan.save()
self.inspect_scan = Scan(name='inspect_test')
self.inspect_scan.save()
self.inspect_scan.sources.add(self.source)
self.inspect_scan.save()
def create_job_expect_201(self, scan_id):
"""Create a scan, return the response as a dict."""
url = reverse('scan-detail', args=(scan_id,)) + 'jobs/'
response = self.client.post(url,
{},
'application/json')
response_json = response.json()
if response.status_code != status.HTTP_201_CREATED:
print('Cause of failure: ')
print(response_json)
self.assertEqual(response.status_code, status.HTTP_201_CREATED)
return response_json
def test_queue_task(self):
"""Test create queue state change."""
# Cannot use util because its testing queue
# Create scan configuration
scan = Scan(name='test',
scan_type=ScanTask.SCAN_TYPE_INSPECT)
scan.save()
# Add source to scan
scan.sources.add(self.source)
options_to_use = ScanOptions()
options_to_use.save()
scan.options = options_to_use
scan.save()
# Create Job
scan_job = ScanJob(scan=scan)
scan_job.save()
# Job in created state
self.assertEqual(scan_job.status, ScanTask.CREATED)
tasks = scan_job.tasks.all()
self.assertEqual(len(tasks), 0)
# Queue job to run
scan_job.queue()
# Job should be in pending state
self.assertEqual(scan_job.status, ScanTask.PENDING)
# Queue should have created scan tasks
tasks = scan_job.tasks.all()
self.assertEqual(len(tasks), 2)
# Validate connect task created and correct
connect_task = tasks[0]
self.assertEqual(connect_task.scan_type, ScanTask.SCAN_TYPE_CONNECT)
self.assertEqual(connect_task.status, ScanTask.PENDING)
# Validate inspect task created and correct
inspect_task = tasks[1]
self.assertEqual(inspect_task.scan_type, ScanTask.SCAN_TYPE_INSPECT)
self.assertEqual(inspect_task.status, ScanTask.PENDING)
def test_queue_invalid_state_changes(self):
"""Test create queue failed."""
scan_job, _ = create_scan_job(
self.source, scan_type=ScanTask.SCAN_TYPE_INSPECT)
scan_job.status = ScanTask.FAILED
# Queue job to run
scan_job.queue()
self.assertEqual(scan_job.status, ScanTask.FAILED)
scan_job.complete()
self.assertEqual(scan_job.status, ScanTask.FAILED)
scan_job.pause()
self.assertEqual(scan_job.status, ScanTask.FAILED)
scan_job.start()
self.assertEqual(scan_job.status, ScanTask.FAILED)
scan_job.cancel()
self.assertEqual(scan_job.status, ScanTask.FAILED)
scan_job.restart()
self.assertEqual(scan_job.status, ScanTask.FAILED)
scan_job.fail('test failure')
self.assertEqual(scan_job.status, ScanTask.FAILED)
scan_job.status = ScanTask.CREATED
scan_job.fail('test failure')
self.assertEqual(scan_job.status, ScanTask.CREATED)
scan_job.status = ScanTask.RUNNING
scan_job.complete()
self.assertEqual(scan_job.status, ScanTask.COMPLETED)
def test_start_task(self):
"""Test start pending task."""
scan_job, _ = create_scan_job(
self.source, scan_type=ScanTask.SCAN_TYPE_CONNECT)
# Job in created state
tasks = scan_job.tasks.all()
# Queue job to run
scan_job.queue()
self.assertEqual(scan_job.status, ScanTask.PENDING)
# Queue should have created scan tasks
tasks = scan_job.tasks.all()
self.assertEqual(len(tasks), 1)
# Start job
scan_job.start()
def test_pause_restart_task(self):
"""Test pause and restart task."""
scan_job, _ = create_scan_job(
self.source, scan_type=ScanTask.SCAN_TYPE_CONNECT)
# Queue job to run
scan_job.queue()
self.assertEqual(scan_job.status, ScanTask.PENDING)
# Queue should have created scan tasks
tasks = scan_job.tasks.all()
self.assertEqual(len(tasks), 1)
connect_task = scan_job.tasks.first()
self.assertEqual(connect_task.status, ScanTask.PENDING)
# Start job
scan_job.start()
self.assertEqual(scan_job.status, ScanTask.RUNNING)
scan_job.pause()
connect_task = scan_job.tasks.first()
self.assertEqual(scan_job.status, ScanTask.PAUSED)
self.assertEqual(connect_task.status, ScanTask.PAUSED)
scan_job.restart()
connect_task = scan_job.tasks.first()
self.assertEqual(scan_job.status, ScanTask.RUNNING)
self.assertEqual(connect_task.status, ScanTask.PENDING)
scan_job.cancel()
connect_task = scan_job.tasks.first()
self.assertEqual(scan_job.status, ScanTask.CANCELED)
self.assertEqual(connect_task.status, ScanTask.CANCELED)
@patch('api.scan.view.start_scan', side_effect=dummy_start)
def test_successful_create(self, start_scan):
"""A valid create request should succeed."""
response = self.create_job_expect_201(self.connect_scan.id)
self.assertIn('id', response)
@patch('api.scan.view.start_scan', side_effect=dummy_start)
def test_retrieve(self, start_scan):
"""Get ScanJob details by primary key."""
initial = self.create_job_expect_201(self.connect_scan.id)
url = reverse('scanjob-detail', args=(initial['id'],))
response = self.client.get(url)
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertIn('scan', response.json())
scan = response.json()['scan']
self.assertEqual(
scan, {'id': 1, 'name': 'connect_test'})
def test_retrieve_bad_id(self):
"""Get ScanJob details by bad primary key."""
url = reverse('scanjob-detail', args=('string',))
response = self.client.get(url)
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
def test_details(self):
"""Get ScanJob result details by primary key."""
# pylint: disable=no-member
scan_job, scan_task = create_scan_job(
self.source, ScanTask.SCAN_TYPE_INSPECT)
# Create a connection system result
sys_result = SystemConnectionResult(name='Foo',
credential=self.cred,
status=SystemConnectionResult
.SUCCESS)
sys_result.save()
conn_result = scan_task.prerequisites.first().connection_result
conn_result.systems.add(sys_result)
conn_result.save()
# Create an inspection system result
sys_result = SystemInspectionResult(name='Foo',
status=SystemConnectionResult
.SUCCESS)
sys_result.save()
fact = RawFact(name='fact_key', value='"fact_value"')
fact.save()
sys_result.facts.add(fact)
sys_result.save()
inspect_result = scan_task.inspection_result
inspect_result.systems.add(sys_result)
inspect_result.save()
scan_job.save()
url = reverse('scanjob-detail', args=(scan_job.id,)) + 'results/'
response = self.client.get(url)
self.assertEqual(response.status_code, status.HTTP_200_OK)
json_response = response.json()
self.assertIn('connection_results', json_response)
self.assertIn('inspection_results', json_response)
self.assertEqual(
json_response, {
'connection_results': {'task_results': [
{'source':
{'id': 1, 'name': 'source1', 'source_type': 'network'},
'systems':
[{'name': 'Foo', 'credential':
{'id': 1, 'name': 'cred1'},
'status': 'success'}]}]},
'inspection_results': {'task_results': [
{'source':
{'id': 1, 'name': 'source1', 'source_type': 'network'},
'systems':
[{'name': 'Foo', 'status': 'success',
'facts': [
{'name': 'fact_key', 'value': 'fact_value'}]}]}]}})
def test_merge_empty_body(self):
"""Test merge with empty body."""
# pylint: disable=no-member
url = reverse('scanjob-merge')
response = self.client.put(url)
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
json_response = response.json()
self.assertEqual(
json_response, {'jobs': [messages.SJ_MERGE_JOB_REQUIRED]})
def test_merge_empty_dict(self):
"""Test merge with empty dict."""
# pylint: disable=no-member
url = reverse('scanjob-merge')
data = {}
response = self.client.put(url, json.dumps(data),
content_type='application/json',
format='json')
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
json_response = response.json()
self.assertEqual(
json_response, {'jobs': [messages.SJ_MERGE_JOB_REQUIRED]})
def test_merge_jobs_not_list(self):
"""Test merge with not list."""
# pylint: disable=no-member
url = reverse('scanjob-merge')
data = {'jobs': 5}
response = self.client.put(url, json.dumps(data),
content_type='application/json',
format='json')
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
json_response = response.json()
self.assertEqual(
json_response, {'jobs': [messages.SJ_MERGE_JOB_NOT_LIST]})
def test_merge_jobs_list_too_short(self):
"""Test merge with list too short."""
# pylint: disable=no-member
url = reverse('scanjob-merge')
data = {'jobs': [5]}
response = self.client.put(url, json.dumps(data),
content_type='application/json',
format='json')
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
json_response = response.json()
self.assertEqual(
json_response, {'jobs': [messages.SJ_MERGE_JOB_TOO_SHORT]})
def test_merge_jobs_list_contains_string(self):
"""Test merge with containing str."""
# pylint: disable=no-member
url = reverse('scanjob-merge')
data = {'jobs': [5, 'hello']}
response = self.client.put(url, json.dumps(data),
content_type='application/json',
format='json')
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
json_response = response.json()
self.assertEqual(
json_response, {'jobs': [messages.SJ_MERGE_JOB_NOT_INT]})
def test_merge_jobs_list_contains_duplicates(self):
"""Test merge with containing duplicates."""
# pylint: disable=no-member
url = reverse('scanjob-merge')
data = {'jobs': [5, 5]}
response = self.client.put(url, json.dumps(data),
content_type='application/json',
format='json')
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
json_response = response.json()
self.assertEqual(
json_response, {'jobs': [messages.SJ_MERGE_JOB_NOT_UNIQUE]})
def test_merge_jobs_list_contains_invalid_job_ids(self):
"""Test merge with containing duplicates."""
# pylint: disable=no-member
url = reverse('scanjob-merge')
data = {'jobs': [5, 6]}
response = self.client.put(url, json.dumps(data),
content_type='application/json',
format='json')
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
json_response = response.json()
self.assertEqual(
json_response, {'jobs':
[messages.SJ_MERGE_JOB_NOT_FOUND % '5, 6']})
def test_merge_jobs_not_complete(self):
"""Test merge jobs not complete."""
# pylint: disable=no-member
scan_job1, _ = create_scan_job(
self.source, ScanTask.SCAN_TYPE_INSPECT,
scan_name='test1')
scan_job2, _ = create_scan_job(
self.source, ScanTask.SCAN_TYPE_INSPECT,
scan_name='test2')
url = reverse('scanjob-merge')
data = {'jobs': [scan_job1.id, scan_job2.id]}
response = self.client.put(url, json.dumps(data),
content_type='application/json',
format='json')
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
json_response = response.json()
error_message = messages.SJ_MERGE_JOB_NOT_COMPLETE % (
', '.join([str(i) for i in [scan_job1.id, scan_job2.id]]))
self.assertEqual(
json_response, {'jobs': [error_message]})
def test_merge_jobs_no_results(self):
"""Test merge job no results."""
# pylint: disable=no-member
scan_job1, _ = create_scan_job(
self.source, ScanTask.SCAN_TYPE_INSPECT,
scan_name='test1')
scan_job2, _ = create_scan_job(
self.source, ScanTask.SCAN_TYPE_INSPECT,
scan_name='test2')
scan_job1.status = ScanTask.COMPLETED
scan_job1.save()
scan_job2.status = ScanTask.COMPLETED
scan_job2.save()
url = reverse('scanjob-merge')
data = {'jobs': [scan_job1.id, scan_job2.id]}
response = self.client.put(url, json.dumps(data),
content_type='application/json',
format='json')
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
json_response = response.json()
validation_result = {'sources': 'Required. May not be null or empty.'}
error_message = messages.SJ_MERGE_JOB_NO_RESULTS % validation_result
self.assertEqual(
json_response, {'jobs': [error_message]})
def test_merge_jobs_success(self):
"""Test merge jobs success."""
# pylint: disable=no-member
scan_job1, scan_task1 = create_scan_job(
self.source, ScanTask.SCAN_TYPE_INSPECT,
scan_name='test1')
scan_job2, scan_task2 = create_scan_job(
self.source, ScanTask.SCAN_TYPE_INSPECT,
scan_name='test2')
# Create a connection system result
connect_sys_result = SystemConnectionResult(
name='Foo',
credential=self.cred,
status=SystemConnectionResult
.SUCCESS)
connect_sys_result.save()
# Create an inspection system result
inspect_sys_result = SystemInspectionResult(
name='Foo',
status=SystemConnectionResult
.SUCCESS)
inspect_sys_result.save()
fact = RawFact(name='fact_key', value='"fact_value"')
fact.save()
inspect_sys_result.facts.add(fact)
inspect_sys_result.save()
conn_result = scan_task1.prerequisites.first().connection_result
conn_result.systems.add(connect_sys_result)
conn_result.save()
inspect_result = scan_task1.inspection_result
inspect_result.systems.add(inspect_sys_result)
inspect_result.save()
scan_task1.status = ScanTask.COMPLETED
scan_task1.save()
conn_result = scan_task2.prerequisites.first().connection_result
conn_result.systems.add(connect_sys_result)
conn_result.save()
inspect_result = scan_task2.inspection_result
inspect_result.systems.add(inspect_sys_result)
inspect_result.save()
scan_task1.status = ScanTask.COMPLETED
scan_task1.save()
scan_job1.status = ScanTask.COMPLETED
scan_job1.save()
scan_job2.status = ScanTask.COMPLETED
scan_job2.save()
url = reverse('scanjob-merge')
data = {'jobs': [scan_job1.id, scan_job2.id]}
response = self.client.put(url, json.dumps(data),
content_type='application/json',
format='json')
self.assertEqual(response.status_code, status.HTTP_201_CREATED)
json_response = response.json()
expected = {'id': 1, 'sources':
[{'source_id': 1,
'source_type': 'network',
'facts': [{'fact_key': 'fact_value'}]},
{'source_id': 1,
'source_type': 'network',
'facts': [{'fact_key': 'fact_value'}]}],
'status': 'complete'}
self.assertEqual(
json_response, expected)
def test_post_jobs_not_allowed(self):
"""Test post jobs not allowed."""
url = reverse('scanjob-detail', args=(1,))
url = url[:-2]
response = self.client.post(url,
{},
'application/json')
self.assertEqual(response.status_code,
status.HTTP_404_NOT_FOUND)
def test_list_not_allowed(self):
"""Test list all jobs not allowed."""
url = reverse('scanjob-detail', args=(1,))
url = url[:-2]
response = self.client.get(url,
format='json')
self.assertEqual(response.status_code,
status.HTTP_404_NOT_FOUND)
@patch('api.scan.view.start_scan', side_effect=dummy_start)
def test_update_not_allowed(self, start_scan):
"""Test update scanjob not allowed."""
initial = self.create_job_expect_201(self.connect_scan.id)
data = {'sources': [self.source.id],
'scan_type': ScanTask.SCAN_TYPE_INSPECT,
'options': {'disabled_optional_products':
{'jboss_eap': True,
'jboss_fuse': True,
'jboss_brms': True}}}
url = reverse('scanjob-detail', args=(initial['id'],))
response = self.client.put(url,
json.dumps(data),
content_type='application/json',
format='json')
self.assertEqual(response.status_code,
status.HTTP_405_METHOD_NOT_ALLOWED)
@patch('api.scan.view.start_scan', side_effect=dummy_start)
def test_update_not_allowed_disable_optional_products(self, start_scan):
"""Test update scan job options not allowed."""
initial = self.create_job_expect_201(self.connect_scan.id)
data = {'sources': [self.source.id],
'scan_type': ScanTask.SCAN_TYPE_INSPECT,
'options': {'disabled_optional_products': 'bar'}}
url = reverse('scanjob-detail', args=(initial['id'],))
response = self.client.put(url,
json.dumps(data),
content_type='application/json',
format='json')
self.assertEqual(response.status_code,
status.HTTP_405_METHOD_NOT_ALLOWED)
@patch('api.scan.view.start_scan', side_effect=dummy_start)
def test_partial_update(self, start_scan):
"""Test partial update not allow for scanjob."""
initial = self.create_job_expect_201(self.connect_scan.id)
data = {'scan_type': ScanTask.SCAN_TYPE_INSPECT}
url = reverse('scanjob-detail', args=(initial['id'],))
response = self.client.patch(url,
json.dumps(data),
content_type='application/json',
format='json')
self.assertEqual(response.status_code,
status.HTTP_405_METHOD_NOT_ALLOWED)
@patch('api.scan.view.start_scan', side_effect=dummy_start)
def test_delete(self, start_scan):
"""Delete a ScanJob is not supported."""
initial = self.create_job_expect_201(self.connect_scan.id)
url = reverse('scanjob-detail', args=(initial['id'],))
response = self.client.delete(url, format='json')
self.assertEqual(response.status_code,
status.HTTP_405_METHOD_NOT_ALLOWED)
@patch('api.scan.view.start_scan', side_effect=dummy_start)
def test_pause_bad_state(self, start_scan):
"""Pause a scanjob."""
initial = self.create_job_expect_201(self.connect_scan.id)
url = reverse('scanjob-detail', args=(initial['id'],))
pause_url = '{}pause/'.format(url)
response = self.client.put(pause_url, format='json')
self.assertEqual(response.status_code,
status.HTTP_400_BAD_REQUEST)
def test_pause_bad_id(self):
"""Pause a scanjob with bad id."""
url = reverse('scanjob-detail', args=('string',))
pause_url = '{}pause/'.format(url)
response = self.client.put(pause_url, format='json')
self.assertEqual(response.status_code,
status.HTTP_400_BAD_REQUEST)
@patch('api.scan.view.start_scan', side_effect=dummy_start)
def test_cancel(self, start_scan):
"""Cancel a scanjob."""
initial = self.create_job_expect_201(self.connect_scan.id)
url = reverse('scanjob-detail', args=(initial['id'],))
pause_url = '{}cancel/'.format(url)
response = self.client.put(pause_url, format='json')
self.assertEqual(response.status_code,
status.HTTP_200_OK)
def test_cancel_bad_id(self):
"""Cancel a scanjob with bad id."""
url = reverse('scanjob-detail', args=('string',))
pause_url = '{}cancel/'.format(url)
response = self.client.put(pause_url, format='json')
self.assertEqual(response.status_code,
status.HTTP_400_BAD_REQUEST)
@patch('api.scan.view.start_scan', side_effect=dummy_start)
def test_restart_bad_state(self, start_scan):
"""Restart a scanjob."""
initial = self.create_job_expect_201(self.connect_scan.id)
url = reverse('scanjob-detail', args=(initial['id'],))
pause_url = '{}restart/'.format(url)
response = self.client.put(pause_url, format='json')
self.assertEqual(response.status_code,
status.HTTP_400_BAD_REQUEST)
def test_restart_bad_id(self):
"""Restart a scanjob with bad id."""
url = reverse('scanjob-detail', args=('string',))
pause_url = '{}restart/'.format(url)
response = self.client.put(pause_url, format='json')
self.assertEqual(response.status_code,
status.HTTP_400_BAD_REQUEST)
def test_expand_scanjob(self):
"""Test view expand_scanjob."""
scan_job, scan_task = create_scan_job(
self.source, scan_type=ScanTask.SCAN_TYPE_INSPECT)
scan_task.update_stats('TEST_VC.', sys_count=2,
sys_failed=1, sys_scanned=1)
scan_job = ScanJob.objects.filter(pk=scan_job.id).first()
serializer = ScanJobSerializer(scan_job)
json_scan = serializer.data
json_scan = expand_scanjob(json_scan)
self.assertEqual(json_scan.get('systems_count'), 2)
self.assertEqual(json_scan.get('systems_failed'), 1)
self.assertEqual(json_scan.get('systems_scanned'), 1)
def test_expand_sys_conn_result(self):
"""Test view expand_sys_conn_result."""
# pylint: disable=no-member
_, scan_task = create_scan_job(
self.source, ScanTask.SCAN_TYPE_CONNECT)
sys_result = SystemConnectionResult(name='Foo',
credential=self.cred,
status=SystemConnectionResult
.SUCCESS)
sys_result.save()
conn_result = scan_task.connection_result
conn_result.systems.add(sys_result)
conn_result.save()
result = expand_sys_conn_result(conn_result)
self.assertEqual(result[0]['credential']['name'], 'cred1')
def test_expand_conn_results(self):
"""Test view expand_conn_results."""
# pylint: disable=no-member
scan_job, scan_task = create_scan_job(
self.source, ScanTask.SCAN_TYPE_CONNECT)
sys_result = SystemConnectionResult(name='Foo',
credential=self.cred,
status=SystemConnectionResult
.SUCCESS)
sys_result.save()
conn_result = scan_task.connection_result
conn_result.systems.add(sys_result)
conn_result.save()
conn_results_json = {'task_results': [{}]}
expand_conn_results(scan_job.connection_results, conn_results_json)
self.assertEqual(
conn_results_json['task_results'][0]['systems'][0]['name'], 'Foo')
def test_expand_inspect_results(self):
"""Test view expand_inspect_results."""
# pylint: disable=no-member
scan_job, scan_task = create_scan_job(self.source,
ScanTask.SCAN_TYPE_INSPECT)
sys_result = SystemInspectionResult(name='Foo',
status=SystemConnectionResult
.SUCCESS)
sys_result.save()
fact = RawFact(name='foo', value='"value"')
fact.save()
sys_result.facts.add(fact)
sys_result.save()
inspect_result = scan_task.inspection_result
inspect_result.systems.add(sys_result)
inspect_result.save()
inspect_results_json = {'task_results': [{}]}
expand_inspect_results(
scan_job.inspection_results, inspect_results_json)
self.assertEqual(
inspect_results_json['task_results'][0]['systems'][0]
['facts'][0]['name'],
'foo')
def test_get_extra_vars(self):
"""Tests the get_extra_vars method with empty dict."""
extended = ExtendedProductSearchOptions()
extended.save()
disabled = DisabledOptionalProductsOptions()
disabled.save()
scan_options = ScanOptions(
disabled_optional_products=disabled,
enabled_extended_product_search=extended)
scan_options.save()
scan_job, _ = create_scan_job(self.source,
ScanTask.SCAN_TYPE_INSPECT,
scan_options=scan_options)
extra_vars = scan_job.options.get_extra_vars()
expected_vars = {'jboss_eap': True,
'jboss_fuse': True,
'jboss_brms': True,
'jboss_eap_ext': False,
'jboss_fuse_ext': False,
'jboss_brms_ext': False}
self.assertEqual(extra_vars, expected_vars)
def test_get_extra_vars_missing_disable_product(self):
"""Tests the get_extra_vars with extended search None."""
disabled = DisabledOptionalProductsOptions()
disabled.save()
scan_options = ScanOptions(
disabled_optional_products=disabled)
scan_options.save()
scan_job, _ = create_scan_job(self.source,
ScanTask.SCAN_TYPE_INSPECT,
scan_options=scan_options)
extra_vars = scan_job.options.get_extra_vars()
expected_vars = {'jboss_eap': True,
'jboss_fuse': True,
'jboss_brms': True,
'jboss_eap_ext': False,
'jboss_fuse_ext': False,
'jboss_brms_ext': False}
self.assertEqual(extra_vars, expected_vars)
def test_get_extra_vars_missing_extended_search(self):
"""Tests the get_extra_vars with disabled products None."""
extended = ExtendedProductSearchOptions()
extended.save()
scan_options = ScanOptions(
enabled_extended_product_search=extended)
scan_options.save()
scan_job, _ = create_scan_job(self.source,
ScanTask.SCAN_TYPE_INSPECT,
scan_options=scan_options)
extra_vars = scan_job.options.get_extra_vars()
expected_vars = {'jboss_eap': True,
'jboss_fuse': True,
'jboss_brms': True,
'jboss_eap_ext': False,
'jboss_fuse_ext': False,
'jboss_brms_ext': False}
self.assertEqual(extra_vars, expected_vars)
def test_get_extra_vars_missing_search_directories_empty(self):
"""Tests the get_extra_vars with search_directories empty."""
extended = {
'search_directories': []
}
serializer = ExtendedProductSearchOptionsSerializer(data=extended)
is_valid = serializer.is_valid()
self.assertTrue(is_valid)
def test_get_extra_vars_missing_search_directories_w_int(self):
"""Tests the get_extra_vars with search_directories contains int."""
extended = {
'search_directories': [1]
}
serializer = ExtendedProductSearchOptionsSerializer(data=extended)
is_valid = serializer.is_valid()
self.assertFalse(is_valid)
def test_get_extra_vars_missing_search_directories_w_not_path(self):
"""Tests the get_extra_vars with search_directories no path."""
extended = {
'search_directories': ['a']
}
serializer = ExtendedProductSearchOptionsSerializer(data=extended)
is_valid = serializer.is_valid()
self.assertFalse(is_valid)
def test_get_extra_vars_missing_search_directories_w_path(self):
"""Tests the get_extra_vars with search_directories no path."""
extended = {
'search_directories': ['/a']
}
serializer = ExtendedProductSearchOptionsSerializer(data=extended)
is_valid = serializer.is_valid()
self.assertTrue(is_valid)
def test_get_extra_vars_extended_search(self):
"""Tests the get_extra_vars method with extended search."""
extended = ExtendedProductSearchOptions(
jboss_eap=True,
jboss_fuse=True,
jboss_brms=True,
search_directories='["a", "b"]')
extended.save()
disabled = DisabledOptionalProductsOptions()
disabled.save()
scan_options = ScanOptions(
disabled_optional_products=disabled,
enabled_extended_product_search=extended)
scan_options.save()
scan_job, _ = create_scan_job(self.source,
ScanTask.SCAN_TYPE_INSPECT,
scan_options=scan_options)
extra_vars = scan_job.options.get_extra_vars()
expected_vars = {'jboss_eap': True,
'jboss_fuse': True,
'jboss_brms': True,
'jboss_eap_ext': True,
'jboss_fuse_ext': True,
'jboss_brms_ext': True,
'search_directories': 'a b'}
self.assertEqual(extra_vars, expected_vars)
def test_get_extra_vars_mixed(self):
"""Tests the get_extra_vars method with mixed values."""
extended = ExtendedProductSearchOptions()
extended.save()
disabled = DisabledOptionalProductsOptions(
jboss_eap=True,
jboss_fuse=True,
jboss_brms=False)
disabled.save()
scan_options = ScanOptions(
disabled_optional_products=disabled,
enabled_extended_product_search=extended)
scan_options.save()
scan_job, _ = create_scan_job(self.source,
ScanTask.SCAN_TYPE_INSPECT,
scan_options=scan_options)
extra_vars = scan_job.options.get_extra_vars()
expected_vars = {'jboss_eap': True,
'jboss_fuse': False,
'jboss_brms': True,
'jboss_eap_ext': False,
'jboss_fuse_ext': False,
'jboss_brms_ext': False}
self.assertEqual(extra_vars, expected_vars)
def test_get_extra_vars_false(self):
"""Tests the get_extra_vars method with all False."""
extended = ExtendedProductSearchOptions()
extended.save()
disabled = DisabledOptionalProductsOptions(
jboss_eap=True,
jboss_fuse=True,
jboss_brms=True)
disabled.save()
scan_options = ScanOptions(
disabled_optional_products=disabled,
enabled_extended_product_search=extended)
scan_options.save()
scan_job, _ = create_scan_job(self.source,
ScanTask.SCAN_TYPE_INSPECT,
scan_options=scan_options)
extra_vars = scan_job.options.get_extra_vars()
expected_vars = {'jboss_eap': False,
'jboss_fuse': False,
'jboss_brms': False,
'jboss_eap_ext': False,
'jboss_fuse_ext': False,
'jboss_brms_ext': False}
self.assertEqual(extra_vars, expected_vars)
# ############################################################
# # Scan Job tests /jobs path
# ############################################################
@patch('api.scan.view.start_scan', side_effect=dummy_start)
def test_list_jobs(self, start_scan):
"""List all ScanJobs under a scan."""
self.create_job_expect_201(self.inspect_scan.id)
self.create_job_expect_201(self.connect_scan.id)
url = reverse('scan-detail', args=(self.inspect_scan.id,)) + 'jobs/'
response = self.client.get(url)
self.assertEqual(response.status_code, status.HTTP_200_OK)
content = response.json()
results1 = [{'id': 1,
'scan': {'id': 2, 'name': 'inspect_test'},
'scan_type': ScanTask.SCAN_TYPE_INSPECT,
'status': 'created',
'status_message': messages.SJ_STATUS_MSG_CREATED}]
expected = {'count': 1,
'next': None,
'previous': None,
'results': results1}
self.assertEqual(content, expected)
@patch('api.scan.view.start_scan', side_effect=dummy_start)
def test_filtered_list(self, start_scan):
"""List filtered ScanJob objects."""
self.create_job_expect_201(self.inspect_scan.id)
url = reverse('scan-detail', args=(self.inspect_scan.id,)) + 'jobs/'
response = self.client.get(
url, {'status': ScanTask.PENDING})
self.assertEqual(response.status_code, status.HTTP_200_OK)
content = response.json()
expected = {'count': 0, 'next': None,
'previous': None, 'results': []}
self.assertEqual(content, expected)
response = self.client.get(
url, {'status': ScanTask.CREATED})
self.assertEqual(response.status_code, status.HTTP_200_OK)
content = response.json()
results1 = [{'id': 1,
'scan': {'id': 2, 'name': 'inspect_test'},
'scan_type': ScanTask.SCAN_TYPE_INSPECT,
'status': 'created',
'status_message': messages.SJ_STATUS_MSG_CREATED}]
expected = {'count': 1,
'next': None,
'previous': None,
'results': results1}
self.assertEqual(content, expected)
@patch('api.scan.view.start_scan', side_effect=dummy_start)
def test_delete_scan_cascade(self, start_scan):
"""Delete a scan and its related data."""
# pylint: disable=no-member
scan_job, scan_task = create_scan_job(
self.source, ScanTask.SCAN_TYPE_INSPECT)
scan = scan_job.scan
scan_id = scan.id
self.create_job_expect_201(scan_id)
# Create a connection system result
sys_result = SystemConnectionResult(name='Foo',
credential=self.cred,
status=SystemConnectionResult
.SUCCESS)
sys_result.save()
conn_result = scan_task.prerequisites.first().connection_result
conn_result.systems.add(sys_result)
conn_result.save()
# Create an inspection system result
sys_result = SystemInspectionResult(name='Foo',
status=SystemConnectionResult
.SUCCESS)
sys_result.save()
fact = RawFact(name='fact_key', value='"fact_value"')
fact.save()
sys_result.facts.add(fact)
sys_result.save()
inspect_result = scan_task.inspection_result
inspect_result.systems.add(sys_result)
inspect_result.save()
scan_job.save()
job_count = len(scan.jobs.all())
self.assertNotEqual(job_count, 0)
url = reverse('scan-detail', args=(scan_id,))
response = self.client.delete(url, format='json')
self.assertEqual(response.status_code,
status.HTTP_204_NO_CONTENT)
job_count = len(scan.jobs.all())
self.assertEqual(job_count, 0)