airship
/
shipyard
Code Issues Proposed changes

Query 'dryrun' Added to Shipyard API for Commit Configdocs 

Shipyard API to retrieve validation status of a collection of configdocs

1 of 4 Commits (API Client, CLI, Documentation are in separate commits)

API
-Added "POST api/v1.0/commitconfigdocs?dryrun=true" in configdocs_api.py.
 The dryrun option retrieves validations but does not commit.
-Unit tests are located in test_configdocs_api.py.

Change-Id: Ic03bef622010bb255274d4dbc626404e12f8abdf
This commit is contained in:
One-Fine-Day 2018-01-10 09:09:57 -06:00
parent 36f5caea63
commit 4eaa4027ef
2 changed files with 59 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
shipyard_airflow/control/configdocs/configdocs_api.py
View File

@ -144,14 +144,15 @@ class CommitConfigDocsResource(BaseResource):
Get validations from all UCP components
Functionality does not exist yet
"""
# force query parameter is False unless explicitly true
# force and dryrun query parameter is False unless explicitly true
force = req.get_param_as_bool(name='force') or False
dryrun = req.get_param_as_bool(name='dryrun') or False
helper = ConfigdocsHelper(req.context)
validations = self.commit_configdocs(helper, force)
validations = self.commit_configdocs(helper, force, dryrun)
resp.body = self.to_json(validations)
resp.status = validations.get('code', falcon.HTTP_200)
def commit_configdocs(self, helper, force):
def commit_configdocs(self, helper, force, dryrun):
"""
Attempts to commit the configdocs
"""
@ -162,14 +163,22 @@ class CommitConfigDocsResource(BaseResource):
status=falcon.HTTP_409,
retry=True)
validations = helper.get_validations_for_buffer()
if force or validations.get('status') == 'Success':
helper.tag_buffer(configdocs_helper.COMMITTED)
if force and validations.get('status') == 'Failure':
# override the status in the response
if dryrun:
validations['code'] = falcon.HTTP_200
if validations.get('message'):
if 'message' in validations:
validations['message'] = (
validations['message'] + ' FORCED SUCCESS')
validations['message'] + ' DRYRUN')
else:
validations['message'] = 'FORCED SUCCESS'
validations['message'] = 'DRYRUN'
else:
if force or validations.get('status') == 'Success':
helper.tag_buffer(configdocs_helper.COMMITTED)
if force and validations.get('status') == 'Failure':
# override the status in the response
validations['code'] = falcon.HTTP_200
if 'message' in validations:
validations['message'] = (
validations['message'] + ' FORCED SUCCESS')
else:
validations['message'] = 'FORCED SUCCESS'
return validations

46
tests/unit/control/test_configdocs_api.py
View File

@ -13,7 +13,7 @@
# limitations under the License.
""" Tests for the configdocs_api"""
import mock
from mock import patch
from mock import ANY, patch
import pytest
@ -119,6 +119,25 @@ class TestConfigDocsResource():
class TestCommitConfigDocsResource():
@mock.patch.object(ApiLock, 'release')
@mock.patch.object(ApiLock, 'acquire')
def test_on_post(self, mock_acquire, mock_release, api_client):
queries = ["", "force=true", "dryrun=true"]
ccdr = CommitConfigDocsResource()
with patch.object(
CommitConfigDocsResource, 'commit_configdocs', return_value={}
) as mock_method:
for q in queries:
result = api_client.simulate_post(
"/api/v1.0/commitconfigdocs", query_string=q,
headers=common.AUTH_HEADERS)
assert result.status_code == 200
mock_method.assert_has_calls([
mock.call(ANY, False, False),
mock.call(ANY, True, False),
mock.call(ANY, False, True)
])
def test_commit_configdocs(self):
"""
Tests the CommitConfigDocsResource method commit_configdocs
@ -129,7 +148,7 @@ class TestCommitConfigDocsResource():
helper = ConfigdocsHelper(CTX)
helper.is_buffer_empty = lambda: False
helper.get_validations_for_buffer = lambda: {'status': 'Success'}
commit_resp = ccdr.commit_configdocs(helper, False)
commit_resp = ccdr.commit_configdocs(helper, False, False)
mock_method.assert_called_once_with('committed')
assert commit_resp['status'] == 'Success'
@ -145,7 +164,7 @@ class TestCommitConfigDocsResource():
'message': 'this is a mock response'
}
)
commit_resp = ccdr.commit_configdocs(helper, False)
commit_resp = ccdr.commit_configdocs(helper, False, False)
assert '400' in commit_resp['code']
assert commit_resp['message'] is not None
assert commit_resp['status'] == 'Failure'
@ -160,10 +179,9 @@ class TestCommitConfigDocsResource():
helper = ConfigdocsHelper(CTX)
helper.is_buffer_empty = lambda: False
helper.get_validations_for_buffer = lambda: {'status': 'Failure'}
commit_resp = ccdr.commit_configdocs(helper, True)
commit_resp = ccdr.commit_configdocs(helper, True, False)
mock_method.assert_called_once_with('committed')
print(commit_resp)
assert '200' in commit_resp['code']
assert 'FORCED' in commit_resp['message']
assert commit_resp['status'] == 'Failure'
@ -178,4 +196,20 @@ class TestCommitConfigDocsResource():
helper = ConfigdocsHelper(CTX)
helper.is_buffer_empty = lambda: True
helper.get_validations_for_buffer = lambda: {'status': 'Success'}
ccdr.commit_configdocs(helper, False)
ccdr.commit_configdocs(helper, False, False)
def test_commit_configdocs_dryrun(self):
"""
Tests the CommitConfigDocsResource method commit_configdocs
"""
ccdr = CommitConfigDocsResource()
commit_resp = None
with patch.object(ConfigdocsHelper, 'tag_buffer') as mock_method:
helper = ConfigdocsHelper(CTX)
helper.is_buffer_empty = lambda: False
helper.get_validations_for_buffer = lambda: {'status': 'Success'}
commit_resp = ccdr.commit_configdocs(helper, False, True)
assert '200' in commit_resp['code']
assert commit_resp['message'] == 'DRYRUN'
assert commit_resp['status'] == 'Success'