Merge pull request #1593 from squirrelo/admin-actions

Admin actions

Author: josenavas

qiita_db/test/test_util.py

@@ -697,6 +697,11 @@ def test_scrub_data_single_quote(self):
         """Correctly removes single quotes from the string"""
         self.assertEqual(qdb.util.scrub_data("'quotes'"), "quotes")
 
+    def test_get_visibilities(self):
+        obs = qdb.util.get_visibilities()
+        exp = ['awaiting_approval', 'sandbox', 'private', 'public']
+        self.assertEqual(obs, exp)
+
     def test_infer_status(self):
         obs = qdb.util.infer_status([])
         self.assertEqual(obs, 'sandbox')

qiita_db/util.py

@@ -25,6 +25,7 @@
     convert_from_id
     convert_to_id
     get_environmental_packages
+    get_visibilities
     purge_filepaths
     move_filepaths_to_upload_folder
     move_upload_files_to_trash
@@ -979,6 +980,19 @@ def get_environmental_packages():
         return qdb.sql_connection.TRN.execute_fetchindex()
 
 
+def get_visibilities():
+    """Get the list of available visibilities for artifacts
+
+    Returns
+    -------
+    list of str
+        The available visibilities
+    """
+    with qdb.sql_connection.TRN:
+        qdb.sql_connection.TRN.add("SELECT visibility FROM qiita.visibility")
+        return qdb.sql_connection.TRN.execute_fetchflatten()
+
+
 def get_timeseries_types():
     """Get the list of available timeseries types
 

qiita_pet/handlers/api_proxy/__init__.py

@@ -24,7 +24,8 @@
     ena_ontology_get_req, prep_template_samples_get_req)
 from .studies import (
     data_types_get_req, study_get_req, study_prep_get_req, study_delete_req)
-from .artifact import artifact_graph_get_req
+from .artifact import (artifact_graph_get_req, artifact_get_req,
+                       artifact_status_put_req, artifact_delete_req)
 
 __all__ = ['prep_template_summary_get_req', 'sample_template_post_req',
            'sample_template_put_req', 'data_types_get_req',
@@ -33,7 +34,8 @@
            'prep_template_summary_get_req', 'prep_template_post_req',
            'prep_template_put_req', 'prep_template_delete_req',
            'prep_template_graph_get_req', 'prep_template_filepaths_get_req',
-           'artifact_get_graph', 'prep_template_get_req', 'study_delete_req',
+           'artifact_get_req', 'artifact_status_put_req',
+           'artifact_delete_req', 'prep_template_get_req', 'study_delete_req',
            'study_prep_get_req', 'sample_template_get_req',
            'artifact_graph_get_req', 'ena_ontology_get_req',
            'sample_template_meta_cats_get_req',

qiita_pet/handlers/api_proxy/artifact.py

@@ -6,6 +6,10 @@
 # The full license is in the file LICENSE, distributed with this software.
 # -----------------------------------------------------------------------------
 from qiita_db.artifact import Artifact
+from qiita_db.user import User
+from qiita_db.util import get_visibilities
+from qiita_db.exceptions import QiitaDBArtifactDeletionError
+from qiita_core.qiita_settings import qiita_config
 from qiita_pet.handlers.api_proxy.util import check_access
 
 
@@ -53,3 +57,124 @@ def artifact_graph_get_req(artifact_id, direction, user_id):
             'node_labels': node_labels,
             'status': 'success',
             'message': ''}
+
+
+def artifact_get_req(artifact_id, user_id):
+    """Get information about the artifact
+
+    Parameters
+    ----------
+    artifact_id : int
+        Artifact being acted on
+    user_id : str
+        The user requesting the action
+
+    Returns
+    -------
+    dict
+        information about the artifact
+    """
+    pd = Artifact(int(artifact_id))
+    access_error = check_access(pd.study.id, user_id)
+    if access_error:
+        return access_error
+
+    can_submit_to_ebi = pd.can_be_submitted_to_ebi
+    ebi_run_accessions = pd.ebi_run_accessions if can_submit_to_ebi else None
+
+    can_submit_to_vamps = pd.can_be_submitted_to_vamps
+    is_submitted_to_vamps = pd.is_submitted_to_vamps if can_submit_to_vamps \
+        else False
+
+    return {
+        'timestamp': pd.timestamp,
+        'processing_parameters': pd.processing_parameters,
+        'visibility': pd.visibility,
+        'artifact_type': pd.artifact_type,
+        'data_type': pd.data_type,
+        'can_be_submitted_to_ebi': can_submit_to_ebi,
+        'can_be_submitted_to_vamps': can_submit_to_vamps,
+        'is_submitted_to_vamps': is_submitted_to_vamps,
+        'filepaths': pd.filepaths,
+        'parents': [a.id for a in pd.parents],
+        'prep_templates': [p.id for p in pd.prep_templates],
+        'ebi_run_accessions': ebi_run_accessions,
+        'study': pd.study.id}
+
+
+def artifact_delete_req(artifact_id, user_id):
+    """Deletes the artifact
+
+    Parameters
+    ----------
+    artifact_id : int
+        Artifact being acted on
+    user_id : str
+        The user requesting the action
+
+    Returns
+    -------
+    dict
+        Status of action, in the form {'status': status, 'message': msg}
+        status: status of the action, either success or error
+        message: Human readable message for status
+    """
+    pd = Artifact(int(artifact_id))
+    access_error = check_access(pd.study.id, user_id)
+    if access_error:
+        return access_error
+    try:
+        Artifact.delete(int(artifact_id))
+    except QiitaDBArtifactDeletionError as e:
+        return {'status': 'error',
+                'message': str(e)}
+    return {'status': 'success',
+            'message': ''}
+
+
+def artifact_status_put_req(artifact_id, user_id, visibility):
+    """Set the status of the artifact given
+
+    Parameters
+    ----------
+    artifact_id : int
+        Artifact being acted on
+    user_id : str
+        The user requesting the action
+    visibility : {'sandbox', 'awaiting_approval', 'private', 'public'}
+        What to change the visibility to
+
+    Returns
+    -------
+    dict
+        Status of action, in the form {'status': status, 'message': msg}
+        status: status of the action, either success or error
+        message: Human readable message for status
+    """
+    if visibility not in get_visibilities():
+        return {'status': 'error',
+                'message': 'Unknown visiblity value: %s' % visibility}
+
+    pd = Artifact(int(artifact_id))
+    access_error = check_access(pd.study.id, user_id)
+    if access_error:
+        return access_error
+    user = User(str(user_id))
+    status = 'success'
+    msg = 'Artifact visibility changed to %s' % visibility
+    # Set the approval to private if needs approval and admin
+    if visibility == 'private':
+        if not qiita_config.require_approval:
+            pd.visibility = 'private'
+        # Set the approval to private if approval not required
+        elif user.level == 'admin':
+            pd.visibility = 'private'
+        # Trying to set approval without admin privileges
+        else:
+            status = 'error'
+            msg = 'User does not have permissions to approve change'
+    else:
+        pd.visibility = visibility
+
+    return {'status': status,
+            'message': msg}

qiita_pet/handlers/api_proxy/tests/test_artifact.py

@@ -6,11 +6,103 @@
 # The full license is in the file LICENSE, distributed with this software.
 # -----------------------------------------------------------------------------
 from unittest import TestCase, main
+from datetime import datetime
+from os.path import join
 
-from qiita_pet.handlers.api_proxy.artifact import artifact_graph_get_req
+from qiita_core.util import qiita_test_checker
+from qiita_core.qiita_settings import qiita_config
+from qiita_db.artifact import Artifact
+from qiita_db.exceptions import QiitaDBUnknownIDError
+from qiita_pet.handlers.api_proxy.artifact import (
+    artifact_get_req, artifact_status_put_req, artifact_graph_get_req,
+    artifact_delete_req)
 
 
+@qiita_test_checker()
 class TestArtifactAPI(TestCase):
+    def tearDown(self):
+        Artifact(1).visibility = 'private'
+
+    def test_artifact_get_req(self):
+        obs = artifact_get_req(1, 'test@foo.bar')
+        exp = {'is_submitted_to_vamps': False,
+               'data_type': '18S',
+               'can_be_submitted_to_vamps': False,
+               'can_be_submitted_to_ebi': False,
+               'timestamp': datetime(2012, 10, 1, 9, 30, 27),
+               'prep_templates': [1],
+               'visibility': 'private',
+               'study': 1,
+               'processing_parameters': None,
+               'ebi_run_accessions': None,
+               'parents': [],
+               'filepaths': [
+                   (1, join(qiita_config.base_data_dir,
+                            'raw_data/1_s_G1_L001_sequences.fastq.gz'),
+                    'raw_forward_seqs'),
+                   (2, join(qiita_config.base_data_dir,
+                            'raw_data/1_s_G1_L001_sequences_barcodes.'
+                            'fastq.gz'),
+                    'raw_barcodes')],
+               'artifact_type': 'FASTQ'}
+        self.assertEqual(obs, exp)
+
+    def test_artifact_get_req_no_access(self):
+        obs = artifact_get_req(1, 'demo@microbio.me')
+        exp = {'status': 'error',
+               'message': 'User does not have access to study'}
+        self.assertEqual(obs, exp)
+
+    def test_artifact_delete_req(self):
+        obs = artifact_delete_req(3, 'test@foo.bar')
+        exp = {'status': 'success', 'message': ''}
+        self.assertEqual(obs, exp)
+
+        with self.assertRaises(QiitaDBUnknownIDError):
+            Artifact(3)
+
+    def test_artifact_delete_req_error(self):
+        obs = artifact_delete_req(1, 'test@foo.bar')
+        exp = {'status': 'error',
+               'message': 'Cannot delete artifact 1: it has children: 2, 3'}
+        self.assertEqual(obs, exp)
+
+    def test_artifact_delete_req_no_access(self):
+        obs = artifact_delete_req(3, 'demo@microbio.me')
+        exp = {'status': 'error',
+               'message': 'User does not have access to study'}
+        self.assertEqual(obs, exp)
+
+    def test_artifact_status_put_req(self):
+        obs = artifact_status_put_req(1, 'test@foo.bar', 'sandbox')
+        exp = {'status': 'success',
+               'message': 'Artifact visibility changed to sandbox'}
+        self.assertEqual(obs, exp)
+
+    def test_artifact_status_put_req_private(self):
+        obs = artifact_status_put_req(1, 'admin@foo.bar', 'private')
+        exp = {'status': 'success',
+               'message': 'Artifact visibility changed to private'}
+        self.assertEqual(obs, exp)
+
+    def test_artifact_status_put_req_private_bad_permissions(self):
+        obs = artifact_status_put_req(1, 'test@foo.bar', 'private')
+        exp = {'status': 'error',
+               'message': 'User does not have permissions to approve change'}
+        self.assertEqual(obs, exp)
+
+    def test_artifact_status_put_req_no_access(self):
+        obs = artifact_status_put_req(1, 'demo@microbio.me', 'sandbox')
+        exp = {'status': 'error',
+               'message': 'User does not have access to study'}
+        self.assertEqual(obs, exp)
+
+    def test_artifact_status_put_req_unknown_status(self):
+        obs = artifact_status_put_req(1, 'test@foo.bar', 'BADSTAT')
+        exp = {'status': 'error',
+               'message': 'Unknown visiblity value: BADSTAT'}
+        self.assertEqual(obs, exp)
+
     def test_artifact_graph_get_req_ancestors(self):
         obs = artifact_graph_get_req(1, 'ancestors', 'test@foo.bar')
         exp = {'status': 'success',
@@ -23,25 +115,24 @@ def test_artifact_graph_get_req_descendants(self):
         obs = artifact_graph_get_req(1, 'descendants', 'test@foo.bar')
         exp = {'status': 'success',
                'message': '',
-               'edge_list': [(1, 3), (1, 2), (2, 4)],
                'node_labels': [(1, 'Raw data 1 - FASTQ'),
                                (3, 'Demultiplexed 2 - Demultiplexed'),
                                (2, 'Demultiplexed 1 - Demultiplexed'),
-                               (4, 'BIOM - BIOM')]}
-        self.assertEqual(obs, exp)
-
-    def test_artifact_graph_get_req_bad(self):
-        obs = artifact_graph_get_req(1, 'UNKNOWN', 'test@foo.bar')
-        exp = {'status': 'error',
-               'message': 'Unknown directon UNKNOWN'}
+                               (4, 'BIOM - BIOM')],
+               'edge_list': [(1, 3), (1, 2), (2, 4)]}
         self.assertEqual(obs, exp)
 
     def test_artifact_graph_get_req_no_access(self):
-        obs = artifact_graph_get_req(1, 'descendants', 'demo@microbio.me')
+        obs = artifact_graph_get_req(1, 'ancestors', 'demo@microbio.me')
         exp = {'status': 'error',
                'message': 'User does not have access to study'}
         self.assertEqual(obs, exp)
 
+    def test_artifact_graph_get_req_bad_direction(self):
+        obs = artifact_graph_get_req(1, 'WRONG', 'test@foo.bar')
+        exp = {'status': 'error', 'message': 'Unknown directon WRONG'}
+        self.assertEqual(obs, exp)
+
 
 if __name__ == "__main__":
     main()