test: behavior with different suffix combinations

e3krisztian · e3krisztian · commit 711e3d2d83ba · 2024-11-28T18:28:00.000+01:00
The test files were created with this script:

    # cd tests/files/suffixes

    # clean
    rm -rf chunks_carve/ extractions/ collisions.zip

    # reproduce output
    seq 100 | gzip &gt; 0-160.gzip
    seq 128 | gzip &gt; 160-375.gzip
    dd if=/dev/zero of=375-512.padding bs=1 count=137
    cat 0-160.gzip 160-375.gzip 375-512.padding &gt; chunks

    unblob --carve-suffix _carve chunks
    cp 0-160.gzip chunks_carve/
    echo something else &gt; chunks_carve/0-160.gzip_extract/gzip.uncompressed

    zip collisions.zip chunks chunks_carve/0-160.gzip chunks_carve/0-160.gzip_extract/gzip.uncompressed

    for input in collisions.zip chunks
    do
      unblob                                   -e extractions/defaults/ $input
      unblob --carve-suffix _carve       -e extractions/_carve_extract/ $input
      unblob --carve-suffix _c --extract-suffix _e -e extractions/_c_e/ $input
    done
diff --git a/.gitattributes b/.gitattributes
@@ -1 +1,2 @@
 tests/integration/** filter=lfs diff=lfs merge=lfs -text
+tests/files/** filter=lfs diff=lfs merge=lfs -text
diff --git a/tests/files/suffixes/chunks b/tests/files/suffixes/chunks
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1e33039682514a23548f4c6f9b7ed2af6dfbfca8d921fdf7845b0ef7255725b4
+size 512
diff --git a/tests/files/suffixes/collisions.zip b/tests/files/suffixes/collisions.zip
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:33fc006557dbaa40deb732ecfd1ac7921b8397636303ac2d153fa2ab477b21b3
+size 1119
diff --git a/tests/files/suffixes/extractions/_c_e/chunks_c/0-160.gzip_e/gzip.uncompressed b/tests/files/suffixes/extractions/_c_e/chunks_c/0-160.gzip_e/gzip.uncompressed
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:93d4e5c77838e0aa5cb6647c385c810a7c2782bf769029e6c420052048ab22bb
+size 292
diff --git a/tests/files/suffixes/extractions/_c_e/chunks_c/160-375.gzip_e/gzip.uncompressed b/tests/files/suffixes/extractions/_c_e/chunks_c/160-375.gzip_e/gzip.uncompressed
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a91b12613458d22a3fbf6d66ff2fba42124b46ea0e032f68c3564cc0c506ec43
+size 404
diff --git a/tests/files/suffixes/extractions/_c_e/chunks_c/375-512.padding b/tests/files/suffixes/extractions/_c_e/chunks_c/375-512.padding
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4a93894f08d98d707cd9a0274f4c9a51bcfa27e701359e12befcc78ffb488817
+size 137
diff --git a/tests/files/suffixes/extractions/_c_e/collisions.zip_e/chunks b/tests/files/suffixes/extractions/_c_e/collisions.zip_e/chunks
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1e33039682514a23548f4c6f9b7ed2af6dfbfca8d921fdf7845b0ef7255725b4
+size 512
diff --git a/tests/files/suffixes/extractions/_c_e/collisions.zip_e/chunks_c/0-160.gzip_e/gzip.uncompressed b/tests/files/suffixes/extractions/_c_e/collisions.zip_e/chunks_c/0-160.gzip_e/gzip.uncompressed
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:93d4e5c77838e0aa5cb6647c385c810a7c2782bf769029e6c420052048ab22bb
+size 292
diff --git a/tests/files/suffixes/extractions/_c_e/collisions.zip_e/chunks_c/160-375.gzip_e/gzip.uncompressed b/tests/files/suffixes/extractions/_c_e/collisions.zip_e/chunks_c/160-375.gzip_e/gzip.uncompressed
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a91b12613458d22a3fbf6d66ff2fba42124b46ea0e032f68c3564cc0c506ec43
+size 404
diff --git a/tests/files/suffixes/extractions/_c_e/collisions.zip_e/chunks_c/375-512.padding b/tests/files/suffixes/extractions/_c_e/collisions.zip_e/chunks_c/375-512.padding
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4a93894f08d98d707cd9a0274f4c9a51bcfa27e701359e12befcc78ffb488817
+size 137
diff --git a/tests/files/suffixes/extractions/_c_e/collisions.zip_e/chunks_carve/0-160.gzip b/tests/files/suffixes/extractions/_c_e/collisions.zip_e/chunks_carve/0-160.gzip
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:04c4ab621ccdb9267ceabad58d0f801f20071533c2f01220711e86ef5e13ac40
+size 160
diff --git a/tests/files/suffixes/extractions/_c_e/collisions.zip_e/chunks_carve/0-160.gzip_e/gzip.uncompressed b/tests/files/suffixes/extractions/_c_e/collisions.zip_e/chunks_carve/0-160.gzip_e/gzip.uncompressed
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:93d4e5c77838e0aa5cb6647c385c810a7c2782bf769029e6c420052048ab22bb
+size 292
diff --git a/tests/files/suffixes/extractions/_c_e/collisions.zip_e/chunks_carve/0-160.gzip_extract/gzip.uncompressed b/tests/files/suffixes/extractions/_c_e/collisions.zip_e/chunks_carve/0-160.gzip_extract/gzip.uncompressed
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a1621be95040239ee14362c16e20510ddc20f527d772d823b2a1679b33f5cd74
+size 15
diff --git a/tests/files/suffixes/extractions/_carve_extract/chunks_carve/0-160.gzip_extract/gzip.uncompressed b/tests/files/suffixes/extractions/_carve_extract/chunks_carve/0-160.gzip_extract/gzip.uncompressed
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:93d4e5c77838e0aa5cb6647c385c810a7c2782bf769029e6c420052048ab22bb
+size 292
diff --git a/tests/files/suffixes/extractions/_carve_extract/chunks_carve/160-375.gzip_extract/gzip.uncompressed b/tests/files/suffixes/extractions/_carve_extract/chunks_carve/160-375.gzip_extract/gzip.uncompressed
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a91b12613458d22a3fbf6d66ff2fba42124b46ea0e032f68c3564cc0c506ec43
+size 404
diff --git a/tests/files/suffixes/extractions/_carve_extract/chunks_carve/375-512.padding b/tests/files/suffixes/extractions/_carve_extract/chunks_carve/375-512.padding
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4a93894f08d98d707cd9a0274f4c9a51bcfa27e701359e12befcc78ffb488817
+size 137
diff --git a/tests/files/suffixes/extractions/_carve_extract/collisions.zip_extract/chunks b/tests/files/suffixes/extractions/_carve_extract/collisions.zip_extract/chunks
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1e33039682514a23548f4c6f9b7ed2af6dfbfca8d921fdf7845b0ef7255725b4
+size 512
diff --git a/tests/files/suffixes/extractions/_carve_extract/collisions.zip_extract/chunks_carve/0-160.gzip b/tests/files/suffixes/extractions/_carve_extract/collisions.zip_extract/chunks_carve/0-160.gzip
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:04c4ab621ccdb9267ceabad58d0f801f20071533c2f01220711e86ef5e13ac40
+size 160
diff --git a/tests/files/suffixes/extractions/_carve_extract/collisions.zip_extract/chunks_carve/0-160.gzip_extract/gzip.uncompressed b/tests/files/suffixes/extractions/_carve_extract/collisions.zip_extract/chunks_carve/0-160.gzip_extract/gzip.uncompressed
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a1621be95040239ee14362c16e20510ddc20f527d772d823b2a1679b33f5cd74
+size 15
diff --git a/tests/files/suffixes/extractions/defaults/chunks_extract/0-160.gzip_extract/gzip.uncompressed b/tests/files/suffixes/extractions/defaults/chunks_extract/0-160.gzip_extract/gzip.uncompressed
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:93d4e5c77838e0aa5cb6647c385c810a7c2782bf769029e6c420052048ab22bb
+size 292
diff --git a/tests/files/suffixes/extractions/defaults/chunks_extract/160-375.gzip_extract/gzip.uncompressed b/tests/files/suffixes/extractions/defaults/chunks_extract/160-375.gzip_extract/gzip.uncompressed
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a91b12613458d22a3fbf6d66ff2fba42124b46ea0e032f68c3564cc0c506ec43
+size 404
diff --git a/tests/files/suffixes/extractions/defaults/chunks_extract/375-512.padding b/tests/files/suffixes/extractions/defaults/chunks_extract/375-512.padding
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4a93894f08d98d707cd9a0274f4c9a51bcfa27e701359e12befcc78ffb488817
+size 137
diff --git a/tests/files/suffixes/extractions/defaults/collisions.zip_extract/chunks b/tests/files/suffixes/extractions/defaults/collisions.zip_extract/chunks
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:1e33039682514a23548f4c6f9b7ed2af6dfbfca8d921fdf7845b0ef7255725b4
+size 512
diff --git a/tests/files/suffixes/extractions/defaults/collisions.zip_extract/chunks_carve/0-160.gzip b/tests/files/suffixes/extractions/defaults/collisions.zip_extract/chunks_carve/0-160.gzip
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:04c4ab621ccdb9267ceabad58d0f801f20071533c2f01220711e86ef5e13ac40
+size 160
diff --git a/tests/files/suffixes/extractions/defaults/collisions.zip_extract/chunks_carve/0-160.gzip_extract/gzip.uncompressed b/tests/files/suffixes/extractions/defaults/collisions.zip_extract/chunks_carve/0-160.gzip_extract/gzip.uncompressed
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a1621be95040239ee14362c16e20510ddc20f527d772d823b2a1679b33f5cd74
+size 15
diff --git a/tests/files/suffixes/extractions/defaults/collisions.zip_extract/chunks_extract/0-160.gzip_extract/gzip.uncompressed b/tests/files/suffixes/extractions/defaults/collisions.zip_extract/chunks_extract/0-160.gzip_extract/gzip.uncompressed
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:93d4e5c77838e0aa5cb6647c385c810a7c2782bf769029e6c420052048ab22bb
+size 292
diff --git a/tests/files/suffixes/extractions/defaults/collisions.zip_extract/chunks_extract/160-375.gzip_extract/gzip.uncompressed b/tests/files/suffixes/extractions/defaults/collisions.zip_extract/chunks_extract/160-375.gzip_extract/gzip.uncompressed
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a91b12613458d22a3fbf6d66ff2fba42124b46ea0e032f68c3564cc0c506ec43
+size 404
diff --git a/tests/files/suffixes/extractions/defaults/collisions.zip_extract/chunks_extract/375-512.padding b/tests/files/suffixes/extractions/defaults/collisions.zip_extract/chunks_extract/375-512.padding
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4a93894f08d98d707cd9a0274f4c9a51bcfa27e701359e12befcc78ffb488817
+size 137
diff --git a/tests/test_processing_suffixes.py b/tests/test_processing_suffixes.py
@@ -0,0 +1,109 @@
+from pathlib import Path
+from typing import Optional
+
+import pytest
+
+from unblob.processing import ExtractionConfig, process_file
+from unblob.report import OutputDirectoryExistsReport
+from unblob.testing import check_output_is_the_same
+
+TEST_DATA_PATH = Path(__file__).parent / "files/suffixes"
+
+
+def _patch(extraction_config: ExtractionConfig, carve_suffix, extract_suffix):
+    extraction_config.keep_extracted_chunks = False
+    if carve_suffix is not None:
+        extraction_config.carve_suffix = carve_suffix
+    if extract_suffix is not None:
+        extraction_config.extract_suffix = extract_suffix
+
+
+@pytest.mark.parametrize(
+    "carve_suffix,extract_suffix,expected_output_dir_name",
+    [
+        (None, None, "defaults"),
+        ("_c", "_e", "_c_e"),
+        ("_carve", "_extract", "_carve_extract"),
+    ],
+)
+def test_top_level_carve(
+    carve_suffix: Optional[str],
+    extract_suffix: Optional[str],
+    expected_output_dir_name: str,
+    extraction_config: ExtractionConfig,
+):
+    _patch(extraction_config, carve_suffix, extract_suffix)
+    input_file = TEST_DATA_PATH / "chunks"
+    carve_dir_name = input_file.name + extraction_config.carve_suffix
+    extract_dir_name = input_file.name + extraction_config.extract_suffix
+    expected_output_dir = (
+        TEST_DATA_PATH / "extractions" / expected_output_dir_name / carve_dir_name
+    )
+
+    reports = process_file(extraction_config, input_file)
+
+    assert reports.errors == []
+
+    assert (
+        carve_dir_name == extract_dir_name
+        or not (extraction_config.extract_root / extract_dir_name).exists()
+    )
+    check_output_is_the_same(
+        expected_output_dir, extraction_config.extract_root / carve_dir_name
+    )
+
+
+EXPECTED_COLLISION_PATHS: "dict[tuple[Optional[str], Optional[str]], set]" = {
+    (None, None): {
+        "collisions.zip_extract/chunks_carve/0-160.gzip_extract",
+    },
+    ("_carve", "_extract"): {
+        "collisions.zip_extract/chunks_carve",
+        "collisions.zip_extract/chunks_carve/0-160.gzip_extract",
+    },
+}
+
+
+@pytest.mark.parametrize(
+    "carve_suffix,extract_suffix,expected_output_dir_name",
+    [
+        (None, None, "defaults"),
+        ("_c", "_e", "_c_e"),
+        ("_carve", "_extract", "_carve_extract"),
+    ],
+)
+def test_top_level_extract_and_collisions(
+    carve_suffix: Optional[str],
+    extract_suffix: Optional[str],
+    expected_output_dir_name: str,
+    extraction_config: ExtractionConfig,
+):
+    _patch(extraction_config, carve_suffix, extract_suffix)
+    input_file = TEST_DATA_PATH / "collisions.zip"
+    carve_dir_name = input_file.name + extraction_config.carve_suffix
+    extract_dir_name = input_file.name + extraction_config.extract_suffix
+    expected_output_dir = (
+        TEST_DATA_PATH / "extractions" / expected_output_dir_name / extract_dir_name
+    )
+
+    reports = process_file(extraction_config, input_file)
+
+    # check collision problems - the input was prepared to have collisions
+    # during both the carving and extracting phases
+    problem_paths = {
+        e.path.relative_to(extraction_config.extract_root).as_posix()
+        for e in reports.errors
+        if isinstance(e, OutputDirectoryExistsReport)
+    }
+    key = (carve_suffix, extract_suffix)
+    assert problem_paths == EXPECTED_COLLISION_PATHS.get(key, set())
+    # we expect only OutputDirectoryExistsReport-s
+    assert len(reports.errors) == len(problem_paths)
+
+    assert (
+        carve_dir_name == extract_dir_name
+        or not (extraction_config.extract_root / carve_dir_name).exists()
+    )
+    check_output_is_the_same(
+        expected_output_dir, extraction_config.extract_root / extract_dir_name
+    )

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`tests/integration/** filter=lfs diff=lfs merge=lfs -text`
	`2`	`+tests/files/** filter=lfs diff=lfs merge=lfs -text`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+version https://git-lfs.github.com/spec/v1`
	`2`	`+oid sha256:1e33039682514a23548f4c6f9b7ed2af6dfbfca8d921fdf7845b0ef7255725b4`
	`3`	`+size 512`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+version https://git-lfs.github.com/spec/v1`
	`2`	`+oid sha256:33fc006557dbaa40deb732ecfd1ac7921b8397636303ac2d153fa2ab477b21b3`
	`3`	`+size 1119`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+version https://git-lfs.github.com/spec/v1`
	`2`	`+oid sha256:93d4e5c77838e0aa5cb6647c385c810a7c2782bf769029e6c420052048ab22bb`
	`3`	`+size 292`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+version https://git-lfs.github.com/spec/v1`
	`2`	`+oid sha256:a91b12613458d22a3fbf6d66ff2fba42124b46ea0e032f68c3564cc0c506ec43`
	`3`	`+size 404`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+version https://git-lfs.github.com/spec/v1`
	`2`	`+oid sha256:4a93894f08d98d707cd9a0274f4c9a51bcfa27e701359e12befcc78ffb488817`
	`3`	`+size 137`