test: Verify that dotfiles are ignored by default and with custom ignores

Author: effigies

src/bids/layout/tests/conftest.py

@@ -1,4 +1,5 @@
 from os.path import join
+import shutil
 
 import pytest
 
@@ -101,3 +102,10 @@ def layout_synthetic(tests_dir, request, db_dir):
 def layout_synthetic_nodb(tests_dir, request, db_dir):
     path = tests_dir / 'data' / 'synthetic'
     return BIDSLayout(path, derivatives=True)
+
+
+@pytest.fixture
+def temporary_dataset(tmp_path, tests_dir):
+    path = tests_dir / 'data' / 'ds005'
+    shutil.copytree(path, tmp_path / 'ds005')
+    return tmp_path / 'ds005'

src/bids/layout/tests/test_layout.py

@@ -1170,3 +1170,28 @@ def test_symlinks_in_path(tests_dir, tmp_path):
     os.symlink(src_sub, link_sub)
 
     assert "Subjects: 1 | Sessions: 2 | Runs: 2" in str(BIDSLayout(tmp_path / "7t_trt"))
+
+
+def test_ignore_dotfiles(temporary_dataset):
+    arbitrary_dotfile = temporary_dataset / '.dotfile'
+    ds_store = temporary_dataset / 'sub-01' / '.DS_Store'
+    osx_companion_file = temporary_dataset / '._task-mixedgamblestask_bold.json'
+
+    arbitrary_dotfile.touch()
+    ds_store.touch()
+    osx_companion_file.touch()
+
+    # Default behavior
+    layout = BIDSLayout(temporary_dataset, validate=False)
+    assert str(temporary_dataset / 'dataset_description.json') in layout.files
+    assert str(arbitrary_dotfile) not in layout.files
+    assert str(ds_store) not in layout.files
+    assert str(osx_companion_file) not in layout.files
+
+    # Explicit ignores do not disable dotfile filtering
+    indexer = BIDSLayoutIndexer(ignore=['some_ignore'])
+    layout = BIDSLayout(temporary_dataset, validate=False, indexer=indexer)
+    assert str(temporary_dataset / 'dataset_description.json') in layout.files
+    assert str(arbitrary_dotfile) not in layout.files
+    assert str(ds_store) not in layout.files
+    assert str(osx_companion_file) not in layout.files