Use mock instead of generate in tests (#4587)

Author: h-mayorquin

src/spikeinterface/core/tests/test_binaryrecordingextractor.py

@@ -2,10 +2,9 @@
 import numpy as np
 from pathlib import Path
 
-from spikeinterface.core import BinaryRecordingExtractor
+from spikeinterface.core import BinaryRecordingExtractor, MockRecording
 from spikeinterface.core.numpyextractors import NumpyRecording
 from spikeinterface.core.core_tools import measure_memory_allocation
-from spikeinterface.core.generate import NoiseGeneratorRecording
 
 
 def test_BinaryRecordingExtractor(create_cache_folder):
@@ -73,7 +72,7 @@ def folder_with_binary_files(tmpdir_factory):
     num_channels = 32
     sampling_frequency = 30_000.0
     dtype = "float32"
-    recording = NoiseGeneratorRecording(
+    recording = MockRecording(
         durations=[1.0],
         sampling_frequency=sampling_frequency,
         num_channels=num_channels,

src/spikeinterface/core/tests/test_generate.py

@@ -9,7 +9,7 @@
 from spikeinterface.core.generate import (
     generate_recording,
     generate_sorting,
-    NoiseGeneratorRecording,
+    MockRecording,
     SortingGenerator,
     TransformSorting,
     generate_recording_by_size,
@@ -22,6 +22,7 @@
     generate_sorting_to_inject,
     synthesize_random_firings,
 )
+from spikeinterface.generation import NoiseGeneratorRecording
 
 from spikeinterface.core.numpyextractors import NumpySorting
 
@@ -178,7 +179,7 @@ def test_noise_generator_memory():
 
     # case 1 preallocation of noise use one noise block 88M for 60000 sample of 384
     before_instanciation_MiB = measure_memory_allocation() / bytes_to_MiB_factor
-    rec1 = NoiseGeneratorRecording(
+    rec1 = MockRecording(
         num_channels=num_channels,
         sampling_frequency=sampling_frequency,
         durations=durations,
@@ -193,11 +194,11 @@ def test_noise_generator_memory():
     ratio = expected_allocation_MiB / expected_allocation_MiB
     assert (
         ratio <= 1.0 + relative_tolerance
-    ), f"NoiseGeneratorRecording with 'tile_pregenerated' wrong memory {memory_usage_MiB} instead of {expected_allocation_MiB}"
+    ), f"MockRecording with 'tile_pregenerated' wrong memory {memory_usage_MiB} instead of {expected_allocation_MiB}"
 
     # case 2: no preallocation very few memory (under 2 MiB)
     before_instanciation_MiB = measure_memory_allocation() / bytes_to_MiB_factor
-    rec2 = NoiseGeneratorRecording(
+    rec2 = MockRecording(
         num_channels=num_channels,
         sampling_frequency=sampling_frequency,
         durations=durations,
@@ -208,7 +209,7 @@ def test_noise_generator_memory():
     )
     after_instanciation_MiB = measure_memory_allocation() / bytes_to_MiB_factor
     memory_usage_MiB = after_instanciation_MiB - before_instanciation_MiB
-    assert memory_usage_MiB < 2, f"NoiseGeneratorRecording with 'on_the_fly wrong memory  {memory_usage_MiB}MiB"
+    assert memory_usage_MiB < 2, f"MockRecording with 'on_the_fly wrong memory  {memory_usage_MiB}MiB"
 
 
 def test_noise_generator_several_noise_levels():
@@ -262,7 +263,7 @@ def test_noise_generator_correct_shape(strategy):
     num_channels = 2
     seed = 0
 
-    lazy_recording = NoiseGeneratorRecording(
+    lazy_recording = MockRecording(
         num_channels=num_channels,
         sampling_frequency=sampling_frequency,
         durations=durations,
@@ -298,7 +299,7 @@ def test_noise_generator_consistency_across_calls(strategy, start_frame, end_fra
     num_channels = 2
     seed = 0
 
-    lazy_recording = NoiseGeneratorRecording(
+    lazy_recording = MockRecording(
         num_channels=num_channels,
         sampling_frequency=sampling_frequency,
         durations=durations,
@@ -333,7 +334,7 @@ def test_noise_generator_consistency_across_traces(strategy, start_frame, end_fr
     num_channels = 2
     seed = start_frame + end_frame + extra_samples  # To make sure that the seed is different for each test
 
-    lazy_recording = NoiseGeneratorRecording(
+    lazy_recording = MockRecording(
         num_channels=num_channels,
         sampling_frequency=sampling_frequency,
         durations=durations,
@@ -353,7 +354,7 @@ def test_noise_generator_consistency_across_traces(strategy, start_frame, end_fr
 @pytest.mark.parametrize("seed", [None, 42])
 def test_noise_generator_consistency_after_dump(strategy, seed):
     # test same noise after dump even with seed=None
-    rec0 = NoiseGeneratorRecording(
+    rec0 = MockRecording(
         num_channels=2,
         sampling_frequency=30000.0,
         durations=[2.0],

src/spikeinterface/core/tests/test_recording_tools.py

@@ -2,10 +2,9 @@
 import platform
 import numpy as np
 
-from spikeinterface.core import NumpyRecording, generate_recording
+from spikeinterface.core import NumpyRecording, generate_recording, MockRecording
 
 from spikeinterface.core.binaryrecordingextractor import BinaryRecordingExtractor
-from spikeinterface.core.generate import NoiseGeneratorRecording
 
 
 from spikeinterface.core.recording_tools import (
@@ -30,7 +29,7 @@ def test_write_binary_recording(tmp_path):
     dtype = "float32"
 
     durations = [10.0]
-    recording = NoiseGeneratorRecording(
+    recording = MockRecording(
         durations=durations,
         num_channels=num_channels,
         sampling_frequency=sampling_frequency,
@@ -57,7 +56,7 @@ def test_write_binary_recording_offset(tmp_path):
     dtype = "float32"
 
     durations = [10.0]
-    recording = NoiseGeneratorRecording(
+    recording = MockRecording(
         durations=durations,
         num_channels=num_channels,
         sampling_frequency=sampling_frequency,
@@ -91,7 +90,7 @@ def test_write_binary_recording_parallel(tmp_path):
     num_channels = 2
     dtype = "float32"
     durations = [10.30, 3.5]
-    recording = NoiseGeneratorRecording(
+    recording = MockRecording(
         durations=durations,
         num_channels=num_channels,
         sampling_frequency=sampling_frequency,
@@ -122,7 +121,7 @@ def test_write_binary_recording_multiple_segment(tmp_path):
     dtype = "float32"
 
     durations = [10.30, 3.5]
-    recording = NoiseGeneratorRecording(
+    recording = MockRecording(
         durations=durations,
         num_channels=num_channels,
         sampling_frequency=sampling_frequency,
@@ -147,7 +146,7 @@ def test_write_binary_recording_multiple_segment(tmp_path):
 
 def test_write_memory_recording():
     # 2 segments
-    recording = NoiseGeneratorRecording(
+    recording = MockRecording(
         num_channels=2, durations=[10.325, 3.5], sampling_frequency=30_000, strategy="tile_pregenerated"
     )
     recording = recording.save()
@@ -317,7 +316,7 @@ def test_order_channels_by_depth():
 
 
 def test_do_recording_attributes_match():
-    recording = NoiseGeneratorRecording(
+    recording = MockRecording(
         num_channels=2, durations=[10.325, 3.5], sampling_frequency=30_000, strategy="tile_pregenerated"
     )
     rec_attributes = get_rec_attributes(recording)

src/spikeinterface/core/tests/test_time_series_tools.py

@@ -1,9 +1,8 @@
 import numpy as np
 
-from spikeinterface.core import generate_recording
+from spikeinterface.core import generate_recording, MockRecording
 
 from spikeinterface.core.binaryrecordingextractor import BinaryRecordingExtractor
-from spikeinterface.core.generate import NoiseGeneratorRecording
 
 
 from spikeinterface.core.time_series_tools import (
@@ -22,7 +21,7 @@ def test_write_binary(tmp_path):
     dtype = "float32"
 
     durations = [10.0]
-    recording = NoiseGeneratorRecording(
+    recording = MockRecording(
         durations=durations,
         num_channels=num_channels,
         sampling_frequency=sampling_frequency,
@@ -49,7 +48,7 @@ def test_write_binary_offset(tmp_path):
     dtype = "float32"
 
     durations = [10.0]
-    recording = NoiseGeneratorRecording(
+    recording = MockRecording(
         durations=durations,
         num_channels=num_channels,
         sampling_frequency=sampling_frequency,
@@ -81,7 +80,7 @@ def test_write_binary_parallel(tmp_path):
     num_channels = 2
     dtype = "float32"
     durations = [10.30, 3.5]
-    recording = NoiseGeneratorRecording(
+    recording = MockRecording(
         durations=durations,
         num_channels=num_channels,
         sampling_frequency=sampling_frequency,
@@ -112,7 +111,7 @@ def test_write_binary_multiple_segment(tmp_path):
     dtype = "float32"
 
     durations = [10.30, 3.5]
-    recording = NoiseGeneratorRecording(
+    recording = MockRecording(
         durations=durations,
         num_channels=num_channels,
         sampling_frequency=sampling_frequency,
@@ -137,7 +136,7 @@ def test_write_binary_multiple_segment(tmp_path):
 
 def test_write_memory_recording():
     # 2 segments
-    recording = NoiseGeneratorRecording(
+    recording = MockRecording(
         num_channels=2, durations=[10.325, 3.5], sampling_frequency=30_000, strategy="tile_pregenerated"
     )
     recording = recording.save()

src/spikeinterface/generation/tests/test_drift_tools.py

@@ -7,8 +7,9 @@
     make_linear_displacement,
     DriftingTemplates,
     InjectDriftingTemplatesRecording,
+    NoiseGeneratorRecording,
 )
-from spikeinterface.core.generate import generate_templates, generate_sorting, NoiseGeneratorRecording
+from spikeinterface.core.generate import generate_templates, generate_sorting
 from spikeinterface.core import Templates, BaseRecording
 
 from probeinterface import generate_multi_columns_probe