Merge pull request #91 from simvue-io/save_files_in_created_state

Allow files to be saved & metadata/tags to be updated for runs in the created state

Author: alahiff

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change log
 
+## v0.13.3
+
+* Allow files (`input` and `code` only) to be saved for runs in the `created` state.
+* Allow metadata and tags to be updated for runs in the `created` state.
+
 ## v0.13.2
 
 * Added `plot_metrics` method to the `Client` class to simplify plotting metrics.

simvue/run.py

@@ -389,10 +389,6 @@ def update_metadata(self, metadata):
             self._error(INIT_MISSING)
             return False
 
-        if not self._active:
-            self._error('Run is not active')
-            return False
-
         if not isinstance(metadata, dict):
             self._error('metadata must be a dict')
             return False
@@ -415,10 +411,6 @@ def update_tags(self, tags):
             self._error(INIT_MISSING)
             return False
 
-        if not self._active:
-            self._error('Run is not active')
-            return False
-
         data = {'name': self._name, 'tags': tags}
 
         if self._simvue.update(data):
@@ -525,8 +517,8 @@ def save(self, filename, category, filetype=None, preserve_path=False, name=None
             self._error(INIT_MISSING)
             return False
 
-        if not self._active:
-            self._error('Run is not active')
+        if self._status == 'created' and category == 'output':
+            self._error("Cannot upload output files for runs in the created state")
             return False
 
         is_file = False

simvue/version.py

@@ -1 +1 @@
-__version__ = '0.13.2'
+__version__ = '0.13.3'

tests/functional/test_artifacts_code_created.py

@@ -0,0 +1,42 @@
+import configparser
+import filecmp
+import os
+import shutil
+import time
+import unittest
+import uuid
+from simvue import Run, Client
+from simvue.sender import sender
+
+import common
+
+class TestArtifactsCreatedState(unittest.TestCase):
+    def test_artifact_code_created(self):
+        """
+        Create a run & an artifact of type 'code' & check it can be downloaded for
+        a run left in the created state
+        """
+        run = Run()
+        run.init(common.RUNNAME1, folder=common.FOLDER, running=False)
+
+        content = str(uuid.uuid4())
+        with open(common.FILENAME1, 'w') as fh:
+            fh.write(content)
+        run.save(common.FILENAME1, 'code')
+
+        shutil.rmtree('./test', ignore_errors=True)
+        os.mkdir('./test')
+
+        client = Client()
+        client.get_artifact_as_file(common.RUNNAME1, common.FILENAME1, './test')
+
+        self.assertTrue(filecmp.cmp(common.FILENAME1, './test/%s' % common.FILENAME1))
+
+        runs = client.delete_runs(common.FOLDER)
+        self.assertEqual(len(runs), 1)
+
+        shutil.rmtree('./test', ignore_errors=True)
+        os.remove(common.FILENAME1)
+
+if __name__ == '__main__':
+    unittest.main()

tests/functional/test_artifacts_input_created.py

@@ -0,0 +1,42 @@
+import configparser
+import filecmp
+import os
+import shutil
+import time
+import unittest
+import uuid
+from simvue import Run, Client
+from simvue.sender import sender
+
+import common
+
+class TestArtifactsCreated(unittest.TestCase):
+    def test_artifact_input_created(self):
+        """
+        Create a run & an artifact of type 'input' & check it can be downloaded
+        for runs in the created state
+        """
+        run = Run()
+        run.init(common.RUNNAME2, folder=common.FOLDER, running=False)
+
+        content = str(uuid.uuid4())
+        with open(common.FILENAME2, 'w') as fh:
+            fh.write(content)
+        run.save(common.FILENAME2, 'input')
+
+        shutil.rmtree('./test', ignore_errors=True)
+        os.mkdir('./test')
+
+        client = Client()
+        client.get_artifact_as_file(common.RUNNAME2, common.FILENAME2, './test')
+
+        self.assertTrue(filecmp.cmp(common.FILENAME2, './test/%s' % common.FILENAME2))
+
+        runs = client.delete_runs(common.FOLDER)
+        self.assertEqual(len(runs), 1)
+
+        shutil.rmtree('./test', ignore_errors=True)
+        os.remove(common.FILENAME2)
+
+if __name__ == '__main__':
+    unittest.main()

tests/functional/test_artifacts_output_created.py

@@ -0,0 +1,37 @@
+import configparser
+import filecmp
+import os
+import shutil
+import time
+import unittest
+import uuid
+from simvue import Run, Client
+
+import common
+
+class TestArtifactsOutputCreated(unittest.TestCase):
+    def test_artifact_output_created(self):
+        """
+        Create a run in the created state and check that an output file
+        cannot be saved.
+        """
+        run = Run()
+        run.init(common.RUNNAME3, folder=common.FOLDER, running=False)
+
+        content = str(uuid.uuid4())
+        with open(common.FILENAME3, 'w') as fh:
+            fh.write(content)
+
+        with self.assertRaises(Exception) as context:
+            run.save(common.FILENAME3, 'output')
+
+        self.assertTrue('Cannot upload output files for runs in the created state' in str(context.exception))
+
+        client = Client()
+        runs = client.delete_runs(common.FOLDER)
+        self.assertEqual(len(runs), 1)
+
+        os.remove(common.FILENAME3)
+
+if __name__ == '__main__':
+    unittest.main()

tests/functional/test_run_metadata_update_created.py

@@ -0,0 +1,28 @@
+import unittest
+import uuid
+from simvue import Run, Client
+
+import common
+
+class TestRunMetadataUpdatedCreated(unittest.TestCase):
+    def test_run_metadata_update_created(self):
+        """
+        Check metadata can be updated & retrieved
+        """
+        name = 'test-%s' % str(uuid.uuid4())
+        metadata = {'a': 'string', 'b': 1, 'c': 2.5}
+        run = Run()
+        run.init(name, metadata=metadata, folder=common.FOLDER, running=False)
+        run.update_metadata({'b': 2})
+
+        metadata['b'] = 2
+
+        client = Client()
+        data = client.get_run(name, metadata=True)
+        self.assertEqual(data['metadata'], metadata)
+
+        runs = client.delete_runs(common.FOLDER)
+        self.assertEqual(len(runs), 1)
+
+if __name__ == '__main__':
+    unittest.main()

tests/functional/test_run_tags_update_created.py

@@ -0,0 +1,29 @@
+import unittest
+import uuid
+from simvue import Run, Client
+
+import common
+
+class TestRunUpdateTagsCreated(unittest.TestCase):
+    def test_run_tags_update_created(self):
+        """
+        Check tags can be updated & retrieved for a run in the 
+        created state
+        """
+        name = 'test-%s' % str(uuid.uuid4())
+        tags = ['a1']
+        run = Run()
+        run.init(name, tags=tags, folder=common.FOLDER, running=False)
+        run.update_tags(['b2'])
+
+        tags.append('b2')
+
+        client = Client()
+        data = client.get_run(name, tags=True)
+        self.assertEqual(tags, data['tags'])
+
+        runs = client.delete_runs(common.FOLDER)
+        self.assertEqual(len(runs), 1)
+
+if __name__ == '__main__':
+    unittest.main()