Merge pull request #87 from killianrochet/eLabFTW/testServer

Modification of download tests

Author: JuliaSprenger

elab_bridge/server_interface.py

@@ -78,6 +78,7 @@ def upload_experiment(experiment_file, server_config_json, experiment_title):
     Returns
     -------
         (dict) Content of the experiment as registered on the server
+        (int) ID of the experiment
     """
 
     try:
@@ -114,7 +115,29 @@ def upload_experiment(experiment_file, server_config_json, experiment_title):
 
     metadata = json.loads(experiment_obj.metadata)
 
-    return metadata
+    return metadata, item_id
+
+
+def delete_experiment(experiment_id, server_config_json):
+    """
+    Delete an existing experiment.
+
+    Parameters
+    ----------
+    experiment_id: int
+        ID of the experiment you want to delete
+    server_config_json: str
+        Path to the json file containing the api_url and the api_token
+    """
+    api_client = get_elab_config(server_config_json)
+    experiment_api = elabapi_python.ExperimentsApi(api_client)
+
+    res = experiment_api.delete_experiment_with_http_info(id=experiment_id)
+    status_delete = res[1]
+
+    if status_delete != 204:
+        raise ValueError('Deletion of an experiment on server failed.'
+                         ' Check your internet connection and permissions.')
 
 
 def upload_template(template_file, server_config_json, template_title):
@@ -134,6 +157,7 @@ def upload_template(template_file, server_config_json, template_title):
     Returns
     -------
         (dict) Content of the template as registered on the server
+        (int) ID of the template
     """
 
     try:
@@ -173,7 +197,29 @@ def upload_template(template_file, server_config_json, template_title):
 
     metadata = json.loads(template_obj.metadata)
 
-    return metadata
+    return metadata, template_id
+
+
+def delete_template(template_id, server_config_json):
+    """
+    Delete an existing template.
+
+    Parameters
+    ----------
+    template_id: int
+        ID of the experiment you want to delete
+    server_config_json: str
+        Path to the json file containing the api_url and the api_token
+    """
+    api_client = get_elab_config(server_config_json)
+    template_api = elabapi_python.ExperimentsTemplatesApi(api_client)
+
+    res = template_api.delete_experiment_template_with_http_info(id=template_id)
+    status_delete = res[1]
+
+    if status_delete != 204:
+        raise ValueError('Deletion of an template on server failed.'
+                         ' Check your internet connection and permissions.')
 
 
 def get_elab_config(server_config_json):

elab_bridge/tests/test_server_interface.py

@@ -1,38 +1,54 @@
 from diglab_utils.test_utils import (test_directory, initialize_test_dir)
-from elab_bridge.server_interface import (download_experiment, upload_template, upload_experiment)
+from elab_bridge.server_interface import (download_experiment, upload_template, upload_experiment,
+                                          delete_template, delete_experiment)
 
 SERVER_CONFIG_YAML = (test_directory / 'testfiles_elab' / 'TestProject' / 'project.json').resolve()
 
 
 def test_upload_template(initialize_test_dir):
     template_file = test_directory / 'testfiles_elab' / 'template.json'
-    template = upload_template(server_config_json=SERVER_CONFIG_YAML,
-                               template_file=template_file,
-                               template_title='Testproject')
+    template, template_id = upload_template(server_config_json=SERVER_CONFIG_YAML,
+                                            template_file=template_file,
+                                            template_title='Testproject')
 
     assert 'elabftw' in template
     assert 'extra_fields' in template
 
+    # cleanup
+    delete_template(server_config_json=SERVER_CONFIG_YAML, template_id=template_id)
+
 
 def test_upload_experiment(initialize_test_dir):
     template_file = test_directory / 'testfiles_elab' / 'experiment.json'
 
-    experiment = upload_experiment(server_config_json=SERVER_CONFIG_YAML,
-                                   experiment_file=template_file,
-                                   experiment_title='TestExperiment')
+    experiment, experiment_id = upload_experiment(server_config_json=SERVER_CONFIG_YAML,
+                                                  experiment_file=template_file,
+                                                  experiment_title='TestExperiment')
 
     assert 'extra_fields' in experiment
 
+    # cleanup
+    delete_experiment(server_config_json=SERVER_CONFIG_YAML, experiment_id=experiment_id)
+
 
 def test_download_experiment(initialize_test_dir):
     json_file = test_directory / 'testfiles_elab' / 'downloaded_experiment.json'
+    upload_experiment_file = test_directory / 'testfiles_elab' / 'experiment.json'
+    upload, experiment_id = upload_experiment(server_config_json=SERVER_CONFIG_YAML,
+                                              experiment_file=upload_experiment_file,
+                                              experiment_title='UploadExperiment')
+
     experiment = download_experiment(save_to=json_file,
                                      server_config_json=SERVER_CONFIG_YAML,
-                                     experiment_id=232,
+                                     experiment_id=experiment_id,
                                      format='json')
 
+    assert len(upload) == len(experiment)
+    assert upload == experiment
+
     assert json_file.exists()
     assert 'extra_fields' in experiment
 
     # cleanup
+    delete_experiment(server_config_json=SERVER_CONFIG_YAML, experiment_id=experiment_id)
     json_file.unlink()