enh: add test on LiterateWorkflow

Author: oesteban

niworkflows/engine/tests/__init__.py

@@ -0,0 +1,41 @@
+"""Test the LiterateWorkflow."""
+from nipype.pipeline.engine import Node
+from nipype.interfaces import afni, utility as niu
+from ..workflows import LiterateWorkflow as Workflow
+
+
+def _reorient_wf(name='ReorientWorkflow'):
+    """A workflow to reorient images to 'RPI' orientation."""
+    workflow = Workflow(name=name)
+    workflow.__desc__ = "Inner workflow. "
+    inputnode = Node(niu.IdentityInterface(fields=['in_file']),
+                     name='inputnode')
+    outputnode = Node(niu.IdentityInterface(
+        fields=['out_file']), name='outputnode')
+    deoblique = Node(afni.Refit(deoblique=True), name='deoblique')
+    reorient = Node(afni.Resample(
+        orientation='RPI', outputtype='NIFTI_GZ'), name='reorient')
+    workflow.connect([
+        (inputnode, deoblique, [('in_file', 'in_file')]),
+        (deoblique, reorient, [('out_file', 'in_file')]),
+        (reorient, outputnode, [('out_file', 'out_file')])
+    ])
+    return workflow
+
+
+def test_boilerplate():
+    """Check the boilerplate is generated."""
+
+    workflow = Workflow(name='test')
+    workflow.__desc__ = "Outer workflow. "
+    workflow.__postdesc__ = "Outer workflow (postdesc)."
+
+    inputnode = Node(niu.IdentityInterface(fields=['in_file']),
+                     name='inputnode')
+    inner = _reorient_wf()
+
+    workflow.connect([
+        (inputnode, inner, [('in_file', 'inputnode.in_file')]),
+    ])
+
+    assert workflow.visit_desc() == "Outer workflow. Inner workflow. Outer workflow (postdesc)."

niworkflows/engine/tests/test_workflows.py

@@ -1,9 +1,7 @@
-# -*- coding: utf-8 -*-
 # emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
 # vi: set ft=python sts=4 ts=4 sw=4 et:
 """
-Supercharging Nipype's workflow engine
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Supercharging Nipype's workflow engine.
 
 Add special features to the Nipype's vanilla workflows
 """
@@ -14,23 +12,23 @@ class LiterateWorkflow(pe.Workflow):
     """Controls the setup and execution of a pipeline of processes."""
 
     def __init__(self, name, base_dir=None):
-        """Create a workflow object.
+        """
+        Create a workflow object.
+
         Parameters
         ----------
-        name : alphanumeric string
+        name : alphanumeric :obj:`str`
             unique identifier for the workflow
-        base_dir : string, optional
+        base_dir : :obj:`str`, optional
             path to workflow storage
+
         """
         super(LiterateWorkflow, self).__init__(name, base_dir)
         self.__desc__ = None
         self.__postdesc__ = None
 
     def visit_desc(self):
-        """
-        Builds a citation boilerplate by visiting all workflows
-        appending their ``__desc__`` field
-        """
+        """Build a citation boilerplate by visiting all workflows."""
         desc = []
 
         if self.__desc__: