TEST: Add and test version check

Author: effigies

nibabel/freesurfer/mghformat.py

@@ -21,6 +21,7 @@
 from ..arrayproxy import ArrayProxy, reshape_dataobj
 from ..keywordonly import kw_only_meth
 from ..openers import ImageOpener
+from ..batteryrunners import BatteryRunner, Report
 from ..wrapstruct import LabeledWrapStruct
 from ..deprecated import deprecate_with_version
 
@@ -120,6 +121,20 @@ def __init__(self,
         if check:
             self.check_fix()
 
+    @staticmethod
+    def chk_version(hdr, fix=False):
+        rep = Report()
+        if hdr['version'] != 1:
+            rep = Report(HeaderDataError, 40)
+            rep.problem_msg = 'Unknown MGH format version'
+            if fix:
+                hdr['version'] = 1
+        return hdr, rep
+
+    @classmethod
+    def _get_checks(klass):
+        return (klass.chk_version,)
+
     @classmethod
     def from_header(klass, header=None, check=True):
         ''' Class method to create MGH header from another MGH header

nibabel/freesurfer/tests/test_mghformat.py

@@ -21,6 +21,7 @@
 from ...spatialimages import HeaderDataError
 from ...volumeutils import sys_is_le
 from ...wrapstruct import WrapStructError
+from ... import imageglobals
 
 from nose.tools import assert_true, assert_false
 
@@ -32,7 +33,7 @@
 from ...testing import data_path
 
 from ...tests import test_spatialimages as tsi
-from ...tests.test_wrapstruct import _TestWrapStructBase
+from ...tests.test_wrapstruct import _TestLabeledWrapStruct
 
 MGZ_FNAME = os.path.join(data_path, 'test.mgz')
 
@@ -371,9 +372,16 @@ def check_dtypes(self, expected, actual):
         assert_equal(expected.newbyteorder('>'), actual)
 
 
-class TestMGHHeader(_TestWrapStructBase):
+class TestMGHHeader(_TestLabeledWrapStruct):
     header_class = MGHHeader
 
+    def _set_something_into_hdr(self, hdr):
+        hdr['dims'] = [4, 3, 2, 1]
+
+    def get_bad_bb(self):
+        return b'\xff' + bytes(self.header_class._hdrdtype.itemsize)
+
+    # Update tests to account for big-endian requirement
     def test_general_init(self):
         hdr = self.header_class()
         # binaryblock has length given by header data dtype
@@ -385,10 +393,6 @@ def test_general_init(self):
         # effect
         hdr = self.header_class(check=False)
 
-    def _set_something_into_hdr(self, hdr):
-        hdr['dims'] = [4, 3, 2, 1]
-
-    # Update tests to account for big-endian requirement
     def test__eq__(self):
         # Test equal and not equal
         hdr1 = self.header_class()
@@ -470,3 +474,14 @@ def check_fix(self, *args, **kwargs):
         assert_raises(Exception, DC, hdr.binaryblock)
         hdr = DC(hdr.binaryblock, check=False)
         hdr2 = hdr.as_byteswapped('>')
+
+    def test_checks(self):
+        # Test header checks
+        hdr_t = self.header_class()
+        # _dxer just returns the diagnostics as a string
+        # Default hdr is OK
+        assert_equal(self._dxer(hdr_t), '')
+        # Version should be 1
+        hdr = hdr_t.copy()
+        hdr['version'] = 2
+        assert_equal(self._dxer(hdr), 'Unknown MGH format version')