def setUp(self):
# region Class fields
self.logger = logging.getLogger(__name__)
self.existing_asset_name = 'Analysis data'
self.existing_environment_name = 'Core Technology'
self.requirement_class = Requirement.__module__ + '.' + Requirement.__name__
self.new_requirement = Requirement(
id=-1,
label='TE-1',
name='Test requirement',
description='This is a test description',
priority='1',
rationale='This is to test the requirements controller',
fitCriterion='None',
originator='Student',
type='Functional',
asset='Analysis data')
self.new_requirement_dict = {
'session_id': 'test',
'object': self.new_requirement,
}
self.new_requirement_body = jsonpickle.encode(
self.new_requirement_dict)
self.to_delete_ids = []
# endregion
self.logger.info('JSON data: %s', self.new_requirement_body)
def setUp(self):
# region Class fields
self.logger = logging.getLogger(__name__)
self.existing_asset_name = 'Analysis data'
self.existing_environment_name = 'Core Technology'
self.requirement_class = Requirement.__module__+'.'+Requirement.__name__
self.new_requirement = Requirement(
id=-1,
label='TE-1',
name='Test requirement',
description='This is a test description',
priority='1',
rationale='This is to test the requirements controller',
fitCriterion='None',
originator='Student',
type='Functional',
asset='Analysis data'
)
self.new_requirement_dict = {
'session_id': 'test',
'object': self.new_requirement,
}
self.new_requirement_body = jsonpickle.encode(self.new_requirement_dict)
self.to_delete_ids = []
# endregion
self.logger.info('JSON data: %s', self.new_requirement_body)
def deserialize_requirement(dict):
req = Requirement(id=-1,
label=dict['theLabel'],
name=dict['theName'],
description=dict['theDescription'],
priority=dict['thePriority'],
rationale=dict['attrs']['rationale'],
fitCriterion=dict['attrs']['fitCriterion'],
originator=dict['attrs']['originator'],
type=dict['attrs']['type'],
asset=dict['attrs']['asset'],
version=-1)
return req
class RequirementAPITests(CairisDaemonTestCase):
@classmethod
def setUpClass(cls):
importModelFile(
os.environ['CAIRIS_SRC'] +
'/../examples/exemplars/NeuroGrid/NeuroGrid.xml', 1, 'test')
def setUp(self):
# region Class fields
self.logger = logging.getLogger(__name__)
self.existing_asset_name = 'Analysis data'
self.existing_environment_name = 'Core Technology'
self.requirement_class = Requirement.__module__ + '.' + Requirement.__name__
self.new_requirement = Requirement(
id=-1,
label='TE-1',
name='Test requirement',
description='This is a test description',
priority='1',
rationale='This is to test the requirements controller',
fitCriterion='None',
originator='Student',
type='Functional',
asset='Analysis data')
self.new_requirement_dict = {
'session_id': 'test',
'object': self.new_requirement,
}
self.new_requirement_body = jsonpickle.encode(
self.new_requirement_dict)
self.to_delete_ids = []
# endregion
self.logger.info('JSON data: %s', self.new_requirement_body)
def test_get_all(self):
method = 'test_get_all'
rv = self.app.get('/api/requirements?session_id=test')
requirements_dict = jsonpickle.decode(rv.data)
self.assertIsNotNone(requirements_dict,
'No results after deserialization')
self.assertIsInstance(requirements_dict, dict,
'The result is not a dictionary as expected')
assert isinstance(requirements_dict, dict)
self.assertGreater(len(requirements_dict), 0,
'No requirements in the dictionary')
requirements = requirements_dict.values()
self.logger.info('[%s] Requirements found: %d', method,
len(requirements))
self.logger.info('[%s] First requirement: %s [%d]\n', method,
requirements[0]['theName'], requirements[0]['theId'])
def test_post(self):
method = 'test_post'
url = '/api/requirements?asset=%s' % quote(self.existing_asset_name)
self.logger.info('[%s] URL: %s', method, url)
rv = self.app.post(url,
content_type='application/json',
data=self.new_requirement_body)
self.logger.debug('[%s] Response data: %s', method, rv.data)
json_resp = jsonpickle.decode(rv.data)
self.assertIsNotNone(json_resp, 'No results after deserialization')
req_id = json_resp.get('requirement_id', None)
self.assertIsNotNone(req_id, 'No requirement ID returned')
self.logger.info('[%s] Requirement ID: %d', method, req_id)
rv = self.app.get(
'/api/requirements/shortcode/%d?session_id=test' % req_id,
self.new_requirement.label())
requirement = jsonpickle.decode(rv.data)
self.logger.info('[%s] Requirement: %s [%d]\n', method,
self.new_requirement.name(),
self.new_requirement.label())
def test_get_asset_name(self):
method = 'test_asset_get_name'
url = '/api/requirements/asset/%s?session_id=test' % quote(
self.existing_asset_name)
rv = self.app.get(url)
self.assertIsNotNone(rv.data, 'No response')
self.logger.debug('[%s] Response data: %s', method, rv.data)
requirements = jsonpickle.decode(rv.data)
self.assertIsNotNone(requirements, 'No results after deserialization')
self.assertGreater(len(requirements), 0,
'No requirements found for this environment')
self.logger.info('[%s] Requirement: %s [%d]\n', method,
requirements[0]['theName'], requirements[0]['theId'])
def test_get_environment_name(self):
method = 'test_environment_get_name'
url = '/api/requirements/environment/%s?session_id=test' % quote(
self.existing_asset_name)
rv = self.app.get(url)
self.assertIsNotNone(rv.data, 'No response')
self.logger.debug('[%s] Response data: %s', method, rv.data)
requirements = jsonpickle.decode(rv.data)
self.assertIsNotNone(requirements, 'No results after deserialization')
if len(requirements) > 0:
self.logger.info('[%s] Requirement: %s [%d]\n', method,
requirements[0]['theName'],
requirements[0]['theId'])
def test_x_put(self):
method = 'test_x_put'
url = '/api/requirements?asset=%s' % quote(self.existing_asset_name)
rv = self.app.post(url,
content_type='application/json',
data=self.new_requirement_body)
url = '/api/requirements'
rv = self.app.get('/api/requirements?session_id=test')
reqs = jsonpickle.decode(rv.data)
requirement = reqs.get(self.new_requirement.theDescription)
upd_requirement = self.new_requirement
upd_requirement.theName = 'Test2'
upd_requirement.theId = requirement['theId']
upd_requirement_dict = self.new_requirement_dict
upd_requirement_dict['object'] = upd_requirement
upd_requirement_body = jsonpickle.encode(upd_requirement_dict)
self.logger.info('[%s] JSON data: %s', method, upd_requirement_body)
rv = self.app.put(url,
content_type='application/json',
data=upd_requirement_body)
self.logger.debug('[%s] Response data: %s', method, rv.data)
json_resp = jsonpickle.decode(rv.data)
self.assertIsNotNone(json_resp, 'No results after deserialization')
message = json_resp.get('message', None)
self.assertIsNotNone(message, 'No message returned')
self.logger.info('Message: %s', message)
rv = self.app.get('/api/requirements?session_id=test')
self.logger.debug('[%s] Response data: %s', method, rv.data)
requirements = jsonpickle.decode(rv.data)
requirement = requirements.get(upd_requirement.theDescription, None)
self.assertIsNotNone(requirement,
'Requirement not updated as expected')
self.logger.info('[%s] Requirement: %s [%d]\n', method,
requirement['theName'], requirement['theId'])
def test_z_delete_id(self):
method = 'test_delete_id'
rv = self.app.get('/api/requirements?session_id=test')
requirements_dict = jsonpickle.decode(rv.data)
to_delete_reqs = [
requirements_dict.get(self.new_requirement.theDescription, None)
]
for to_delete_req in to_delete_reqs:
if to_delete_req is not None:
self.to_delete_ids.append(to_delete_req['theLabel'])
for req_id in self.to_delete_ids:
url = '/api/requirements/name/%s?session_id=test' % req_id
self.logger.info('[%s] URL: %s', method, url)
rv = self.app.delete(url)
self.logger.debug('[%s] Response data: %s', method, rv.data)
json_resp = jsonpickle.decode(rv.data)
self.assertIsNotNone(json_resp, 'No results after deserialization')
message = json_resp.get('message', None)
self.assertIsNotNone(message, 'No message returned')
self.logger.info('')
def test_concept_map_model(self):
url = '/api/requirements?environment=%s' % quote('Core Technology')
reqBody1 = self.new_requirement_dict
reqBody1['object'].theLabel = '1'
reqBody1['object'].theName = 'OneRequirement'
reqBody1['object'].theDescription = 'OneRequirement description'
reqBody1['object'].attrs['asset'] = ''
rv = self.app.post(url,
content_type='application/json',
data=jsonpickle.encode(reqBody1))
json_resp = jsonpickle.decode(rv.data)
self.assertIsNotNone(json_resp, 'No results after deserialization')
req_id = json_resp.get('requirement_id', None)
self.assertIsNotNone(req_id, 'No requirement ID returned')
reqBody2 = self.new_requirement_dict
reqBody2['object'].theLabel = '2'
reqBody2['object'].theName = 'AnotherRequirement'
reqBody2['object'].theDescription = 'AnotherRequirement description'
reqBody2['object'].attrs['asset'] = ''
rv = self.app.post(url,
content_type='application/json',
data=jsonpickle.encode(reqBody2))
json_resp = jsonpickle.decode(rv.data)
self.assertIsNotNone(json_resp, 'No results after deserialization')
req_id = json_resp.get('requirement_id', None)
self.assertIsNotNone(req_id, 'No requirement ID returned')
aTrace = Trace(fObjt='requirement',
fName='OneRequirement',
tObjt='requirement',
tName='AnotherRequirement')
traceDict = {'session_id': 'test', 'object': aTrace}
rv = self.app.post('/api/traces',
content_type='application/json',
data=jsonpickle.encode(traceDict))
url = '/api/requirements/model/environment/Core%20Technology/requirement/all?session_id=test'
method = 'test_concept_map_model'
self.logger.info('[%s] URL: %s', method, url)
rv = self.app.get(url, content_type='application/json')
self.logger.debug('[%s] Response data: %s', method, rv.data)
self.assertIsNotNone(rv.data, 'No results after deserialization')
self.assertEquals(rv.data.find('svg'), 1)
def deserialize_requirement(dict):
req = Requirement(id=dict['theId'], label=dict['theLabel'], name=dict['theName'], description=dict['theDescription'], priority=dict['thePriority'], version=dict['theVersion'])
req.attrs = dict['attrs']
req.dirtyAttrs = set(dict['dirtyAttrs'])
return req
def deserialize_requirement(dict): req = Requirement(id=dict['theId'], label=dict['theLabel'], name=dict['theName'], description=dict['theDescription'], priority=dict['thePriority'], version=dict['theVersion']) req.attrs = dict['attrs'] req.dirtyAttrs = set(dict['dirtyAttrs']) return req
class RequirementAPITests(CairisDaemonTestCase):
@classmethod
def setUpClass(cls):
importModelFile(os.environ['CAIRIS_SRC'] + '/../examples/exemplars/NeuroGrid/NeuroGrid.xml',1,'test')
def setUp(self):
# region Class fields
self.logger = logging.getLogger(__name__)
self.existing_asset_name = 'Analysis data'
self.existing_environment_name = 'Core Technology'
self.requirement_class = Requirement.__module__+'.'+Requirement.__name__
self.new_requirement = Requirement(
id=-1,
label='TE-1',
name='Test requirement',
description='This is a test description',
priority='1',
rationale='This is to test the requirements controller',
fitCriterion='None',
originator='Student',
type='Functional',
asset='Analysis data'
)
self.new_requirement_dict = {
'session_id': 'test',
'object': self.new_requirement,
}
self.new_requirement_body = jsonpickle.encode(self.new_requirement_dict)
self.to_delete_ids = []
# endregion
self.logger.info('JSON data: %s', self.new_requirement_body)
def test_get_all(self):
method = 'test_get_all'
rv = self.app.get('/api/requirements?session_id=test')
requirements_dict = jsonpickle.decode(rv.data)
self.assertIsNotNone(requirements_dict, 'No results after deserialization')
self.assertIsInstance(requirements_dict, dict, 'The result is not a dictionary as expected')
assert isinstance(requirements_dict, dict)
self.assertGreater(len(requirements_dict), 0, 'No requirements in the dictionary')
requirements = requirements_dict.values()
self.logger.info('[%s] Requirements found: %d', method, len(requirements))
self.logger.info('[%s] First requirement: %s [%d]\n', method, requirements[0]['theName'], requirements[0]['theId'])
def test_post(self):
method = 'test_post'
url = '/api/requirements?asset=%s' % quote(self.existing_asset_name)
self.logger.info('[%s] URL: %s', method, url)
rv = self.app.post(url, content_type='application/json', data=self.new_requirement_body)
self.logger.debug('[%s] Response data: %s', method, rv.data)
json_resp = jsonpickle.decode(rv.data)
self.assertIsNotNone(json_resp, 'No results after deserialization')
req_id = json_resp.get('requirement_id', None)
self.assertIsNotNone(req_id, 'No requirement ID returned')
self.logger.info('[%s] Requirement ID: %d', method, req_id)
rv = self.app.get('/api/requirements/shortcode/%d?session_id=test' % req_id, self.new_requirement.label())
requirement = jsonpickle.decode(rv.data)
self.logger.info('[%s] Requirement: %s [%d]\n', method, self.new_requirement.name(), self.new_requirement.label())
def test_get_asset_name(self):
method = 'test_asset_get_name'
url = '/api/requirements/asset/%s?session_id=test' % quote(self.existing_asset_name)
rv = self.app.get(url)
self.assertIsNotNone(rv.data, 'No response')
self.logger.debug('[%s] Response data: %s', method, rv.data)
requirements = jsonpickle.decode(rv.data)
self.assertIsNotNone(requirements, 'No results after deserialization')
self.assertGreater(len(requirements), 0, 'No requirements found for this environment')
self.logger.info('[%s] Requirement: %s [%d]\n', method, requirements[0]['theName'], requirements[0]['theId'])
def test_get_environment_name(self):
method = 'test_environment_get_name'
url = '/api/requirements/environment/%s?session_id=test' % quote(self.existing_asset_name)
rv = self.app.get(url)
self.assertIsNotNone(rv.data, 'No response')
self.logger.debug('[%s] Response data: %s', method, rv.data)
requirements = jsonpickle.decode(rv.data)
self.assertIsNotNone(requirements, 'No results after deserialization')
if len(requirements) > 0:
self.logger.info('[%s] Requirement: %s [%d]\n', method, requirements[0]['theName'], requirements[0]['theId'])
def test_x_put(self):
method = 'test_x_put'
url = '/api/requirements?asset=%s' % quote(self.existing_asset_name)
rv = self.app.post(url, content_type='application/json', data=self.new_requirement_body)
url = '/api/requirements'
rv = self.app.get('/api/requirements?session_id=test')
reqs = jsonpickle.decode(rv.data)
requirement = reqs.get(self.new_requirement.theDescription)
upd_requirement = self.new_requirement
upd_requirement.theName = 'Test2'
upd_requirement.theId = requirement['theId']
upd_requirement_dict = self.new_requirement_dict
upd_requirement_dict['object'] = upd_requirement
upd_requirement_body = jsonpickle.encode(upd_requirement_dict)
self.logger.info('[%s] JSON data: %s', method, upd_requirement_body)
rv = self.app.put(url, content_type='application/json', data=upd_requirement_body)
self.logger.debug('[%s] Response data: %s', method, rv.data)
json_resp = jsonpickle.decode(rv.data)
self.assertIsNotNone(json_resp, 'No results after deserialization')
message = json_resp.get('message', None)
self.assertIsNotNone(message, 'No message returned')
self.logger.info('Message: %s', message)
rv = self.app.get('/api/requirements?session_id=test')
self.logger.debug('[%s] Response data: %s', method, rv.data)
requirements = jsonpickle.decode(rv.data)
requirement = requirements.get(upd_requirement.theDescription, None)
self.assertIsNotNone(requirement, 'Requirement not updated as expected')
self.logger.info('[%s] Requirement: %s [%d]\n', method, requirement['theName'], requirement['theId'])
def test_z_delete_id(self):
method = 'test_delete_id'
rv = self.app.get('/api/requirements?session_id=test')
requirements_dict = jsonpickle.decode(rv.data)
to_delete_reqs = [
requirements_dict.get(self.new_requirement.theDescription, None)
]
for to_delete_req in to_delete_reqs:
if to_delete_req is not None:
self.to_delete_ids.append(to_delete_req['theLabel'])
for req_id in self.to_delete_ids:
url = '/api/requirements/name/%s?session_id=test' % req_id
self.logger.info('[%s] URL: %s', method, url)
rv = self.app.delete(url)
self.logger.debug('[%s] Response data: %s', method, rv.data)
json_resp = jsonpickle.decode(rv.data)
self.assertIsNotNone(json_resp, 'No results after deserialization')
message = json_resp.get('message', None)
self.assertIsNotNone(message, 'No message returned')
self.logger.info('')