Merge pull request #699 from sappelhoff/fix_empty_file_error_CTF

[MRG] make 0KB admissible exceptions for certain CTF files

Author: chrisgorgo

tests/data/empty_files/sub-0001/meg/sub-0001_task-AEF_run-01_meg.ds/sub-0001_task-AEF_run-01_meg.meg4

@@ -48,6 +48,9 @@ describe('validateMisc', () => {
   let filelist, dir
 
   beforeAll(() => {
+    // contains stripped down CTF format dataset: Both, BadChannels and
+    // bad.segments files can be empty and still valid. Everything else must
+    // not be empty.
     dir = `${process.cwd()}/tests/data/empty_files`
   })
 
@@ -56,14 +59,16 @@ describe('validateMisc', () => {
       filelist = files
     })
   })
-  it('returns issues for empty files (0kb)', done => {
+  it('returns issues for empty files (0kb), accepting a limited set of exceptions', done => {
     const files = groupFileTypes(filelist, {})
     utils.collectSummary(filelist, {})
 
     validateMisc(files.misc).then(issues => {
-      assert.ok(issues.length > 0)
+      // *.meg4 and BadChannels files are empty. But only *.meg4 is an issue
+      assert.ok(issues.length == 1)
       assert.ok(issues.every(issue => issue instanceof utils.issues.Issue))
       assert.notStrictEqual(issues.findIndex(issue => issue.code === 99), -1)
+      assert.ok(issues[0].file.name == 'sub-0001_task-AEF_run-01_meg.meg4')
       done()
     })
   })

tests/utils/files.spec.js

@@ -2,7 +2,15 @@ const Issue = require('../issues/issue')
 
 function createIssueForEmpty(file) {
   const size = typeof window !== 'undefined' ? file.size : file.stats.size
-  return size <= 0 && new Issue({ code: 99, file: file })
+  var failsSizeRequirement = size <= 0
+  // Exception misc files that can be valid although size==0
+  // E.g., BadChannels and bad.segments in CTF data format (MEG modality)
+  const exceptionMiscs = ['BadChannels', 'bad.segments']
+  if (exceptionMiscs.indexOf(file.name) > -1) {
+    failsSizeRequirement = false
+  }
+
+  return failsSizeRequirement && new Issue({ code: 99, file: file })
 }
 function clearNonIssues(x) {
   return x instanceof Issue