tests: update to use pytest bdd version 8

Author: henryborchers

pyproject.toml

@@ -41,7 +41,7 @@ test = [
     "coverage",
     "pytest",
     "pytest-cov",
-    "pytest-bdd >= 3.1.0,<4.0",
+    "pytest-bdd >= 4,<9.0",
 ]
 tox = ['tox']
 tox-uv = [

tests/features/package_factory.feature

@@ -3,10 +3,11 @@ Feature: Build package objects
   # You should easily be able to build a new package object using the package factory
 
   Scenario Outline: Loading session containing 2 objects
-    Given We have a object created by contains files that belong to two groups
+    Given We have a <package_type> object created by contains files that belong to two groups
     Then resulting packages should be 2
-    And the first object should contain everything from the first group
-    And the second object should contain everything from the second group
+    And the first <package_type> object should contain everything from the first group
+    And the second <package_type> object should contain everything from the second group
+
     Examples:
       | package_type             |
       | CaptureOnePackage        |

tests/features/package_transform.feature

@@ -1,9 +1,9 @@
 Feature: Transform package objects
   Scenario Outline: package containing 2 objects and want to transform them into a another type of package
-    Given A package containing 2 objects
-    And We have another path to save the objects to
-    When we transform all the packages found into the new package format
-    Then the newly transformed package should contain the same files but in the new format
+    Given A package containing 2 objects of <source_package_type>
+    And We have another path to save the objects to <new_package_type>
+    When we transform all the packages found into the new <new_package_type> package format
+    Then the newly transformed package should contain the same files but in the <new_package_type> format
     Examples:
       | source_package_type | new_package_type  |
       | CaptureOnePackage   | HathiTiff         |

tests/steps/test_package_factory_feature.py

@@ -3,22 +3,24 @@
 import shutil
 from uiucprescon import packager
 
-from pytest_bdd import scenario, given, when, then
+from pytest_bdd import scenario, given, when, then, parsers
 import pytest
 
 from uiucprescon.packager import Metadata
 from ..conftest import sample_packages
 
 
-@scenario(
-    "package_factory.feature",
-    "Loading session containing 2 objects"
-)
+@scenario("package_factory.feature", "Loading session containing 2 objects")
 def test_load_session_objects():
     pass
 
 
-@given("We have a object created by contains files that belong to two groups")
+@given(
+    parsers.parse(
+        "We have a {package_type} object created by contains files that belong to two groups"
+    ),
+    target_fixture="package_objects",
+)
 def package_objects(source_path, package_type):
     pkg_factory_type = eval(f"packager.packages.{package_type}")
 
@@ -36,11 +38,14 @@ def two_packages(package_objects):
     assert len(package_objects) == 2
 
 
-@then("the first object should contain everything from the first group")
+@then(
+    parsers.parse(
+        "the first {package_type} object should contain everything from the first group"
+    )
+)
 def step_impl(package_objects, package_type):
     first_group_regex = sample_packages[package_type][1]
-    package_objects = sorted(package_objects,
-                             key=lambda p: p.metadata[Metadata.ID])
+    package_objects = sorted(package_objects, key=lambda p: p.metadata[Metadata.ID])
     object_000001 = package_objects[0]
 
     assert object_000001.metadata[Metadata.ID] == "000001"
@@ -57,11 +62,14 @@ def step_impl(package_objects, package_type):
                 assert checker.match(basename)
 
 
-@then("the second object should contain everything from the second group")
+@then(
+    parsers.parse(
+        "the second {package_type} object should contain everything from the second group"
+    )
+)
 def step_impl(package_objects, package_type):
     second_group_regex = sample_packages[package_type][2]
-    package_objects = sorted(package_objects,
-                             key=lambda p: p.metadata[Metadata.ID])
+    package_objects = sorted(package_objects, key=lambda p: p.metadata[Metadata.ID])
     object_000002 = package_objects[1]
     assert object_000002.metadata[Metadata.ID] == "000002"
 
@@ -77,27 +85,31 @@ def step_impl(package_objects, package_type):
                 assert checker.match(basename)
 
 
-@scenario("package_factory.feature",
-          "Hathi TIFF package containing 2 objects with sidecar text files"
+@scenario(
+    "package_factory.feature",
+    "Hathi TIFF package containing 2 objects with sidecar text files",
 )
 def test_hathi_tiff_two_object_and_sidecar_text():
     pass
 
 
-@given("a hathi tiff package containing 2 objects with text sidecar files")
+@given(
+    "a hathi tiff package containing 2 objects with text sidecar files",
+    target_fixture="hathi_tiff_package_w_sidecar_text",
+)
 def hathi_tiff_package_w_sidecar_text(hathi_tiff_sample_package):
     package_one_path = os.path.join(hathi_tiff_sample_package, "000001")
     for i in range(3):
-        with open(os.path.join(package_one_path, f"0000000{i+1}.txt"), "w"):
+        with open(os.path.join(package_one_path, f"0000000{i + 1}.txt"), "w"):
             pass
 
     package_two_path = os.path.join(hathi_tiff_sample_package, "000002")
     for i in range(2):
-        with open(os.path.join(package_two_path, f"0000000{i+1}.txt"), "w"):
+        with open(os.path.join(package_two_path, f"0000000{i + 1}.txt"), "w"):
             pass
     package_factory = packager.PackageFactory(packager.packages.HathiTiff())
 
-    packages = list(package_factory .locate_packages(hathi_tiff_sample_package))
+    packages = list(package_factory.locate_packages(hathi_tiff_sample_package))
     return packages
 
 
@@ -113,31 +125,39 @@ def step_impl(hathi_tiff_package_w_sidecar_text):
             for instance in item.instantiations.values():
                 num_sidecar_file = len(instance.sidecar_files)
                 if num_sidecar_file != 1:
-                    pytest.fail(f"{instance} contains {num_sidecar_file} sidecare files")
+                    pytest.fail(
+                        f"{instance} contains {num_sidecar_file} sidecare files"
+                    )
+
 
-@scenario("package_factory.feature",
-          "Hathi jp2 package containing 2 objects with sidecar text files"
+@scenario(
+    "package_factory.feature",
+    "Hathi jp2 package containing 2 objects with sidecar text files",
 )
 def test_hathi_jp2_two_object_and_sidecar_text():
     pass
 
 
-@given("a hathi jp2 package containing 2 objects with text sidecar files")
+@given(
+    "a hathi jp2 package containing 2 objects with text sidecar files",
+    target_fixture="hathi_jp2_package_w_sidecar_text",
+)
 def hathi_jp2_package_w_sidecar_text(hathi_jp2_sample_package):
     package_one_path = os.path.join(hathi_jp2_sample_package, "000001")
     for i in range(3):
-        with open(os.path.join(package_one_path, f"0000000{i+1}.txt"), "w"):
+        with open(os.path.join(package_one_path, f"0000000{i + 1}.txt"), "w"):
             pass
 
     package_two_path = os.path.join(hathi_jp2_sample_package, "000002")
     for i in range(2):
-        with open(os.path.join(package_two_path, f"0000000{i+1}.txt"), "w"):
+        with open(os.path.join(package_two_path, f"0000000{i + 1}.txt"), "w"):
             pass
     package_factory = packager.PackageFactory(packager.packages.HathiJp2())
 
     packages = list(package_factory.locate_packages(hathi_jp2_sample_package))
     return packages
 
+
 @then("resulting packages hathi jp2 package should be 2")
 def step_impl(hathi_jp2_package_w_sidecar_text):
     assert len(hathi_jp2_package_w_sidecar_text) == 2
@@ -150,9 +170,7 @@ def step_impl(hathi_jp2_package_w_sidecar_text):
             for instance in item.instantiations.values():
                 num_sidecar_file = len(instance.sidecar_files)
                 if num_sidecar_file != 1:
-                    pytest.fail(
-                        f"{instance} contains {num_sidecar_file} sidecar files"
-                    )
+                    pytest.fail(f"{instance} contains {num_sidecar_file} sidecar files")
 
 
 @then("each instance in jp2 package should files")
@@ -161,6 +179,4 @@ def instances_has_files(hathi_jp2_package_w_sidecar_text):
         for item in obj:
             for inst in item.instantiations.values():
                 if len(list(inst.get_files())) == 0:
-                    pytest.fail(
-                        f"{inst.metadata[Metadata.ID]} contains no files"
-                    )
+                    pytest.fail(f"{inst.metadata[Metadata.ID]} contains no files")