Ensure user prop set for register snapshots method (issue #964) (#966)

* Ensure user prop set for register snapshots method (issue #964)

* Move ONE validation to register_snapshots method

Author: k1o0

ibllib/pipes/base_tasks.py

@@ -523,6 +523,13 @@ def register_snapshots(self, unlink=False, collection=None):
         - TIFF files are converted to PNG format before upload. The original file is not replaced.
         - JPEG and PNG files are resized by Alyx.
         """
+        assert self.one and not self.one.offline, f'{self.__class__.__name__} requires an online ONE instance'
+        if not self.one.alyx.is_logged_in:
+            # Register snapshot requires the user field to be set, which may happen before a REST
+            # query is made. To avoid the user field being None, we authenticate here.  If the
+            # token is cached this will simply set the user and token properties.
+            self.one.alyx.authenticate()
+
         collection = getattr(self, 'device_collection', None) if collection is None else collection
         collection = collection or ''  # If not defined, use no collection
         if collection and '*' in collection:

ibllib/tests/test_pipes.py

@@ -314,6 +314,29 @@ def test_rename_files(self):
             expected = ('snap.PNG', 'pic.jpeg', 'snapshot.png', 'snapshot.jpg', 'snapshot.gif')
             self.assertCountEqual(expected, files)
 
+    def test_online_validation(self):
+        """Test ONE validation and AlyxClient authentication."""
+        # Test that the constructor raises an error if ONE is offline
+        task = RegisterRawDataTask(self.session_path)
+        self.assertRaises(AssertionError, task.register_snapshots)
+        alyx = self.one.alyx
+        try:
+            self.one._web_client = None
+            task.one = self.one
+            with self.assertRaises(AssertionError) as e:
+                task.register_snapshots()
+        finally:
+            self.one._web_client = alyx
+        self.assertEqual(str(e.exception), 'RegisterRawDataTask requires an online ONE instance')
+
+        # Test that the constructor authenticates the AlyxClient
+        assert alyx.silent is True, 'AlyxClient must be silent for this test'  # ensures no user prompt
+        alyx.user = None  # should restore Alyx user
+        assert self.one.alyx.is_logged_in is False
+        task.register_snapshots()
+        self.assertTrue(alyx.is_logged_in)
+        self.assertTrue(alyx.user)
+
 
 class TestSleeplessDecorator(unittest.TestCase):