refactor(analyzer): improve analyzer pipeline module (#1542)

* rename steps to pipeline module

* move pipeline entrypoint to pipeline module

* rename steps test module to pipeline

* fix paths after renames

* move step protocol to pipeline

* create pipeline status enum

* use Protocol from typing extensions

* Fix linting

analyzer/tests/pipeline/organise_file_test.py

@@ -0,0 +1,115 @@
+import os
+import shutil
+import time
+from unittest import mock
+
+import pytest
+
+from libretime_analyzer.pipeline.organise_file import organise_file
+
+from ..conftest import AUDIO_FILENAME
+
+
+@pytest.mark.parametrize(
+    "params,exception",
+    [
+        ((42, "", "", dict()), TypeError),
+        (("", 23, "", dict()), TypeError),
+        (("", "", 5, dict()), TypeError),
+        (("", "", "", 12345), TypeError),
+    ],
+)
+def test_organise_file_wrong_params(params, exception):
+    with pytest.raises(exception):
+        organise_file(*params)
+
+
+def test_organise_file(src_dir, dest_dir):
+    organise_file(
+        os.path.join(src_dir, AUDIO_FILENAME),
+        dest_dir,
+        AUDIO_FILENAME,
+        dict(),
+    )
+    assert os.path.exists(os.path.join(dest_dir, AUDIO_FILENAME))
+
+
+def test_organise_file_samefile(src_dir):
+    organise_file(
+        os.path.join(src_dir, AUDIO_FILENAME),
+        src_dir,
+        AUDIO_FILENAME,
+        dict(),
+    )
+    assert os.path.exists(os.path.join(src_dir, AUDIO_FILENAME))
+
+
+def import_and_restore(src_dir, dest_dir) -> dict:
+    """
+    Small helper to test the organise_file function.
+    Move the file and restore it back to it's origine.
+    """
+    # Import the file
+    metadata = organise_file(
+        os.path.join(src_dir, AUDIO_FILENAME),
+        dest_dir,
+        AUDIO_FILENAME,
+        dict(),
+    )
+
+    # Copy it back to the original location
+    shutil.copy(
+        os.path.join(dest_dir, AUDIO_FILENAME),
+        os.path.join(src_dir, AUDIO_FILENAME),
+    )
+
+    return metadata
+
+
+def test_organise_file_duplicate_file(src_dir, dest_dir):
+    # Import the file once
+    import_and_restore(src_dir, dest_dir)
+
+    # Import it again. It shouldn't overwrite the old file and instead create a new
+    metadata = import_and_restore(src_dir, dest_dir)
+
+    assert metadata["full_path"] != os.path.join(dest_dir, AUDIO_FILENAME)
+    assert os.path.exists(metadata["full_path"])
+    assert os.path.exists(os.path.join(dest_dir, AUDIO_FILENAME))
+
+
+def test_organise_file_triplicate_file(src_dir, dest_dir):
+    # Here we use mock to patch out the time.localtime() function so that it
+    # always returns the same value. This allows us to consistently simulate this test cases
+    # where the last two of the three files are imported at the same time as the timestamp.
+    with mock.patch("libretime_analyzer.pipeline.organise_file.time") as mock_time:
+        mock_time.localtime.return_value = time.localtime()  # date(2010, 10, 8)
+        mock_time.side_effect = time.time
+
+    # Import the file once
+    import_and_restore(src_dir, dest_dir)
+    # Import it again. It shouldn't overwrite the old file and instead create a new
+    metadata1 = import_and_restore(src_dir, dest_dir)
+
+    # Reimport for the third time, which should have the same timestamp as the second one
+    # thanks to us mocking out time.localtime()
+    metadata2 = import_and_restore(src_dir, dest_dir)
+
+    # Check if file exists and if filename is <original>_<date>.<ext>
+    assert os.path.exists(metadata1["full_path"])
+    assert len(os.path.basename(metadata1["full_path"]).split("_")) == 2
+
+    # Check if file exists and if filename is <original>_<date>_<uuid>.<ext>
+    assert os.path.exists(metadata2["full_path"])
+    assert len(os.path.basename(metadata2["full_path"]).split("_")) == 3
+
+
+def test_organise_file_bad_permissions_dest_dir(src_dir):
+    with pytest.raises(OSError):
+        # /sys is using sysfs on Linux, which is unwritable
+        organise_file(
+            os.path.join(src_dir, AUDIO_FILENAME),
+            "/sys/foobar",
+            AUDIO_FILENAME,
+            dict(),
+        )