Merge pull request #1053 from scitran/analysis-info

Add standard info editing for analyses

Author: nagem

api/api.py

@@ -245,6 +245,7 @@ def prefix(path, routes):
         prefix( '/analyses/<_id:{cid}>', [
             route('/files',                                     AnalysesHandler, h='download',      m=['GET']),
             route('/files/<filename:{fname}>',                  AnalysesHandler, h='download',      m=['GET']),
+            route( '/info',                                     AnalysesHandler, h='modify_info',   m=['POST']),
         ]),
         prefix('/<:{cname}>/<:{cid}>/<cont_name:analyses>/<cid:{cid}>', [
             route('/<list_name:notes>',                         NotesListHandler,               m=['POST']),

api/handlers/refererhandler.py

@@ -79,8 +79,6 @@ def post(self, cont_name, cid):
         permchecker(noop)('POST')
 
         if self.is_true('job'):
-            if cont_name != 'sessions':
-                self.abort(400, 'Analysis created via a job must be at the session level')
 
             payload = self.request.json_body
             analysis = payload.get('analysis')
@@ -126,6 +124,22 @@ def put(self, cont_name, **kwargs):
         else:
             self.abort(404, 'Element not updated in container {} {}'.format(self.storage.cont_name, _id))
 
+    @validators.verify_payload_exists
+    def modify_info(self, **kwargs):
+        _id = kwargs.get('_id')
+
+        analysis = self.storage.get_container(_id)
+        parent = self.storage.get_parent(analysis['parent']['type'], analysis['parent']['id'])
+        permchecker = self.get_permchecker(parent)
+        permchecker(noop)('PUT')
+
+        payload = self.request.json_body
+        validators.validate_data(payload, 'info_update.json', 'input', 'POST')
+
+        self.storage.modify_info(_id, payload)
+
+        return
+
     def get(self, **kwargs):
         _id = kwargs.get('_id')
         analysis = self.storage.get_container(_id)

tests/integration_tests/python/test_containers.py

@@ -1065,6 +1065,72 @@ def test_edit_subject_info(data_builder, as_admin, as_user):
     assert r.json()['info'] == {}
 
 
+def test_edit_analysis_info(data_builder, default_payload, file_form, as_admin, as_user):
+    """
+    Abridged version since it uses same storage layer as container info
+    """
+
+    gear_doc = default_payload['gear']['gear']
+    gear_doc['inputs'] = {'csv': {'base': 'file'}}
+    gear = data_builder.create_gear(gear=gear_doc)
+    project = data_builder.create_project()
+
+    assert as_admin.post('/projects/' + project + '/files', files=file_form('test.csv')).ok
+    r = as_admin.post('/projects/' + project + '/analyses', params={'job': 'true'}, json={
+        'analysis': {'label': 'with-job'},
+        'job': {
+            'gear_id': gear,
+            'inputs': {'csv': {'type': 'project', 'id': project, 'name': 'test.csv'}}
+        }
+    })
+    assert r.ok
+    analysis = r.json()['_id']
+
+
+    r = as_admin.get('/analyses/' + analysis)
+    assert r.ok
+    assert not r.json().get('info')
+
+    # Send improper payload
+    r = as_admin.post('/analyses/' + analysis + '/info', json={
+        'delete': ['map'],
+        'replace': {'not_going': 'to_happen'}
+    })
+    assert r.status_code == 400
+
+    # Send improper payload
+    r = as_admin.post('/analyses/' + analysis + '/info', json={
+        'delete': {'a': 'map'},
+    })
+    assert r.status_code == 400
+
+    # Send improper payload
+    r = as_admin.post('/analyses/' + analysis + '/info', json={
+        'set': 'cannot do this',
+    })
+    assert r.status_code == 400
+
+    # Attempt full replace of info
+    analysis_info = {
+        'a': 'b',
+        'test': 123,
+        'map': {
+            'a': 'b'
+        },
+        'list': [1,2,3]
+    }
+
+
+    r = as_admin.post('/analyses/' + analysis + '/info', json={
+        'replace': analysis_info
+    })
+    assert r.ok
+
+    r = as_admin.get('/analyses/' + analysis)
+    assert r.ok
+    assert r.json()['info'] == analysis_info
+
+
 def test_fields_list_requests(data_builder, file_form, as_admin):
     # Ensure sensitive keys are not returned on list endpoints
     # Project: info and files.info