b50090e92c
removes distinction between actions and configs in the api The v1/jobs endpoint is the single point of access to the api to store, search and retrieve operating instruction about a single freezer run. optional scheduling informations can be added to a job to allow for future/recurrent job execution. removes api endpoints - v1/actions - v1/configs adds api endpoints: - v1/jobs Implements blueprint: freezer-api-jobs Change-Id: Ideeef14dfccd21ddd10b4faa438124c04d2e1ff8
209 lines
9.5 KiB
Python
209 lines
9.5 KiB
Python
"""
|
|
Copyright 2015 Hewlett-Packard
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
This product includes cryptographic software written by Eric Young
|
|
(eay@cryptsoft.com). This product includes software written by Tim
|
|
Hudson (tjh@cryptsoft.com).
|
|
========================================================================
|
|
"""
|
|
|
|
import unittest
|
|
from mock import Mock, patch
|
|
|
|
from freezer.apiclient import exceptions
|
|
from freezer.apiclient import jobs
|
|
|
|
|
|
class TestJobManager(unittest.TestCase):
|
|
|
|
def setUp(self):
|
|
self.mock_client = Mock()
|
|
self.mock_response = Mock()
|
|
self.mock_client.endpoint = 'http://testendpoint:9999'
|
|
self.mock_client.auth_token = 'testtoken'
|
|
self.mock_client.client_id = 'test_client_id_78900987'
|
|
self.job_manager = jobs.JobManager(self.mock_client)
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_create(self, mock_requests):
|
|
self.assertEqual(self.job_manager.endpoint, 'http://testendpoint:9999/v1/jobs/')
|
|
self.assertEqual(self.job_manager.headers, {'X-Auth-Token': 'testtoken'})
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_create_ok(self, mock_requests):
|
|
self.mock_response.status_code = 201
|
|
self.mock_response.json.return_value = {'job_id': 'qwerqwer'}
|
|
mock_requests.post.return_value = self.mock_response
|
|
retval = self.job_manager.create({'job': 'metadata'})
|
|
self.assertEqual(retval, 'qwerqwer')
|
|
|
|
@patch('freezer.apiclient.jobs.json')
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_create_adds_client_id_if_not_provided(self, mock_requests, mock_json):
|
|
self.mock_response.status_code = 201
|
|
self.mock_response.json.return_value = {'job_id': 'qwerqwer'}
|
|
mock_json.dumps.return_value = {'job': 'mocked'}
|
|
mock_requests.post.return_value = self.mock_response
|
|
|
|
retval = self.job_manager.create({'job': 'metadata'})
|
|
|
|
mock_json.dumps.assert_called_with({'job': 'metadata',
|
|
'client_id': 'test_client_id_78900987'})
|
|
self.assertEqual(retval, 'qwerqwer')
|
|
|
|
@patch('freezer.apiclient.jobs.json')
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_create_leaves_provided_client_id(self, mock_requests, mock_json):
|
|
self.mock_response.status_code = 201
|
|
self.mock_response.json.return_value = {'job_id': 'qwerqwer'}
|
|
mock_json.dumps.return_value = {'job': 'mocked'}
|
|
mock_requests.post.return_value = self.mock_response
|
|
|
|
retval = self.job_manager.create({'job': 'metadata', 'client_id': 'parmenide'})
|
|
|
|
mock_json.dumps.assert_called_with({'job': 'metadata',
|
|
'client_id': 'parmenide'})
|
|
self.assertEqual(retval, 'qwerqwer')
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_create_fail_when_api_return_error_code(self, mock_requests):
|
|
self.mock_response.status_code = 500
|
|
mock_requests.post.return_value = self.mock_response
|
|
self.assertRaises(exceptions.ApiClientException, self.job_manager.create, {'job': 'metadata'})
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_delete_ok(self, mock_requests):
|
|
self.mock_response.status_code = 204
|
|
mock_requests.delete.return_value = self.mock_response
|
|
retval = self.job_manager.delete('test_job_id')
|
|
self.assertIsNone(retval)
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_delete_fail(self, mock_requests):
|
|
self.mock_response.status_code = 500
|
|
mock_requests.delete.return_value = self.mock_response
|
|
self.assertRaises(exceptions.ApiClientException, self.job_manager.delete, 'test_job_id')
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_get_ok(self, mock_requests):
|
|
self.mock_response.status_code = 200
|
|
self.mock_response.json.return_value = {'job_id': 'qwerqwer'}
|
|
mock_requests.get.return_value = self.mock_response
|
|
retval = self.job_manager.get('test_job_id')
|
|
self.assertEqual(retval, {'job_id': 'qwerqwer'})
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_get_fails_on_error_different_from_404(self, mock_requests):
|
|
self.mock_response.status_code = 500
|
|
mock_requests.get.return_value = self.mock_response
|
|
self.assertRaises(exceptions.ApiClientException, self.job_manager.get, 'test_job_id')
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_get_none(self, mock_requests):
|
|
self.mock_response.status_code = 404
|
|
mock_requests.get.return_value = self.mock_response
|
|
retval = self.job_manager.get('test_job_id')
|
|
self.assertIsNone(retval)
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_list_ok(self, mock_requests):
|
|
self.mock_response.status_code = 200
|
|
job_list = [{'job_id_0': 'bomboloid'}, {'job_id_1': 'asdfasdf'}]
|
|
self.mock_response.json.return_value = {'jobs': job_list}
|
|
mock_requests.get.return_value = self.mock_response
|
|
retval = self.job_manager.list()
|
|
self.assertEqual(retval, job_list)
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_list_error(self, mock_requests):
|
|
self.mock_response.status_code = 404
|
|
job_list = [{'job_id_0': 'bomboloid'}, {'job_id_1': 'asdfasdf'}]
|
|
self.mock_response.json.return_value = {'clients': job_list}
|
|
mock_requests.get.return_value = self.mock_response
|
|
self.assertRaises(exceptions.ApiClientException, self.job_manager.list)
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_update_ok(self, mock_requests):
|
|
self.mock_response.status_code = 200
|
|
self.mock_response.json.return_value = {
|
|
"patch": {"status": "bamboozled"},
|
|
"version": 12,
|
|
"job_id": "d454beec-1f3c-4d11-aa1a-404116a40502"
|
|
}
|
|
mock_requests.patch.return_value = self.mock_response
|
|
retval = self.job_manager.update('d454beec-1f3c-4d11-aa1a-404116a40502', {'status': 'bamboozled'})
|
|
self.assertEqual(retval, 12)
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_update_raise_MetadataUpdateFailure_when_api_return_error_code(self, mock_requests):
|
|
self.mock_response.json.return_value = {
|
|
"patch": {"status": "bamboozled"},
|
|
"version": 12,
|
|
"job_id": "d454beec-1f3c-4d11-aa1a-404116a40502"
|
|
}
|
|
self.mock_response.status_code = 404
|
|
self.mock_response.text = '{"title": "Not Found","description":"No document found with ID d454beec-1f3c-4d11-aa1a-404116a40502x"}'
|
|
mock_requests.patch.return_value = self.mock_response
|
|
self.assertRaises(exceptions.ApiClientException, self.job_manager.update,
|
|
'd454beec-1f3c-4d11-aa1a-404116a40502', {'status': 'bamboozled'})
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_start_job_calls_update_with_correct_update_doc(self, mock_requests):
|
|
self.mock_response.status_code = 200
|
|
self.mock_response.json.return_value = {
|
|
"patch": {"event": "whatever"},
|
|
"version": 12,
|
|
"job_id": "d454beec-1f3c-4d11-aa1a-404116a40502"
|
|
}
|
|
mock_requests.patch.return_value = self.mock_response
|
|
retval = self.job_manager.start_job('d454beec-1f3c-4d11-aa1a-404116a40502')
|
|
self.assertEqual(retval, 12)
|
|
endpoint = 'http://testendpoint:9999/v1/jobs/d454beec-1f3c-4d11-aa1a-404116a40502'
|
|
headers = {'X-Auth-Token': 'testtoken'}
|
|
data = '{"job_schedule": {"event": "start"}}'
|
|
mock_requests.patch.assert_called_with(endpoint, headers=headers, data=data)
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_stop_job_calls_update_with_correct_update_doc(self, mock_requests):
|
|
self.mock_response.status_code = 200
|
|
self.mock_response.json.return_value = {
|
|
"patch": {"event": "whatever"},
|
|
"version": 12,
|
|
"job_id": "d454beec-1f3c-4d11-aa1a-404116a40502"
|
|
}
|
|
mock_requests.patch.return_value = self.mock_response
|
|
retval = self.job_manager.stop_job('d454beec-1f3c-4d11-aa1a-404116a40502')
|
|
self.assertEqual(retval, 12)
|
|
endpoint = 'http://testendpoint:9999/v1/jobs/d454beec-1f3c-4d11-aa1a-404116a40502'
|
|
headers = {'X-Auth-Token': 'testtoken'}
|
|
data = '{"job_schedule": {"event": "stop"}}'
|
|
mock_requests.patch.assert_called_with(endpoint, headers=headers, data=data)
|
|
|
|
@patch('freezer.apiclient.jobs.requests')
|
|
def test_abort_job_calls_update_with_correct_update_doc(self, mock_requests):
|
|
self.mock_response.status_code = 200
|
|
self.mock_response.json.return_value = {
|
|
"patch": {"event": "whatever"},
|
|
"version": 12,
|
|
"job_id": "d454beec-1f3c-4d11-aa1a-404116a40502"
|
|
}
|
|
mock_requests.patch.return_value = self.mock_response
|
|
retval = self.job_manager.abort_job('d454beec-1f3c-4d11-aa1a-404116a40502')
|
|
self.assertEqual(retval, 12)
|
|
endpoint = 'http://testendpoint:9999/v1/jobs/d454beec-1f3c-4d11-aa1a-404116a40502'
|
|
headers = {'X-Auth-Token': 'testtoken'}
|
|
data = '{"job_schedule": {"event": "abort"}}'
|
|
mock_requests.patch.assert_called_with(endpoint, headers=headers, data=data)
|