CalcJobNode: Fix validation for depth=None in retrieve_list (#6078

)

Commit a1b9f79 added support for using
`None` as the third element in a directive of the `retrieve_list` of a
`CalcJob`. However, the method `_validate_retrieval_directive` that
validates the retrieve list directives when stored on the `CalcJobNode`
was not updated and would only still accept integers.

aiida/orm/nodes/process/calculation/calcjob.py

@@ -264,8 +264,8 @@ def _validate_retrieval_directive(directives: Sequence[Union[str, Tuple[str, str
             if not isinstance(directive[1], str):
                 raise ValueError('invalid directive, second element has to be a string representing local path')
 
-            if not isinstance(directive[2], int):
-                raise ValueError('invalid directive, three element has to be an integer representing the depth')
+            if not isinstance(directive[2], (int, type(None))):
+                raise ValueError('invalid directive, third element has to be an integer representing the depth')
 
     def set_retrieve_list(self, retrieve_list: Sequence[Union[str, Tuple[str, str, str]]]) -> None:
         """Set the retrieve list.

tests/orm/nodes/test_calcjob.py

@@ -95,3 +95,29 @@ def test_get_scheduler_stderr(self):
                 # It should return `None` if no scheduler output is there (file not there, or option not set),
                 # while it should return the content if both are set
                 assert node.get_scheduler_stderr() == (stderr if with_file and with_option else None)
+
+    @pytest.mark.parametrize(
+        'retrieve_list, exception, match', (
+            ([], None, None),
+            (['directive'], None, None),
+            ([['path', '.', None]], None, None),
+            ([['path', '.', 1]], None, None),
+            ([['path', '.', 1], 'directive'], None, None),
+            (1, TypeError, 'file retrieval directives has to be a list or tuple'),
+            ([1], ValueError, r'invalid directive, not a list or tuple of length three: .*'),
+            ([['str', 'str']], ValueError, r'invalid directive, not a list or tuple of length three: .*'),
+            ([[1, 'str', 0]], ValueError, r'.*, first element has to be a string representing remote path'),
+            ([['str', 1, 0]], ValueError, r'.*, second element has to be a string representing local path'),
+            ([['s', 's', '0']], ValueError, r'.*, third element has to be an integer representing the depth'),
+        )
+    )
+    def test_set_retrieve_list(self, retrieve_list, exception, match):
+        """Test the :meth:`aiida.orm.nodes.process.calculation.calcjob.CalcJobNode.set_retrieve_list`."""
+        node = CalcJobNode()
+
+        if exception:
+            with pytest.raises(exception, match=match):
+                node.set_retrieve_list(retrieve_list)
+        else:
+            node.set_retrieve_list(retrieve_list)
+            assert node.get_retrieve_list() == retrieve_list