Merge pull request #677 from adamtheturtle/rename-fixture

Rename a fixture to be more clear

Author: adamtheturtle

tests/mock_vws/conftest.py

@@ -81,15 +81,15 @@ def _delete_all_targets(database_keys: VuforiaDatabaseKeys) -> None:
 
 @pytest.fixture()
 def target_id(
-    png_rgb_success: io.BytesIO,
+    image_file_success_state_low_rating: io.BytesIO,
     vuforia_database_keys: VuforiaDatabaseKeys,
 ) -> str:
     """
     Return the target ID of a target in the database.
 
     The target is one which will have a 'success' status when processed.
     """
-    image_data = png_rgb_success.read()
+    image_data = image_file_success_state_low_rating.read()
     image_data_encoded = base64.b64encode(image_data).decode('ascii')
 
     data = {

tests/mock_vws/fixtures/images.py

@@ -11,10 +11,10 @@
 
 
 @pytest.fixture
-def png_rgb_success() -> io.BytesIO:
+def image_file_success_state_low_rating() -> io.BytesIO:
     """
-    Return a PNG file in the RGB color space which is expected to have a
-    'success' status when added to a target.
+    Return an image file which is expected to have a 'success' status when
+    added to a target and a low rating after processing.
     """
     return make_image_file(
         file_format='PNG',

tests/mock_vws/test_database_summary.py

@@ -193,13 +193,13 @@ def test_failed_images(
     def test_inactive_images(
         self,
         vuforia_database_keys: VuforiaDatabaseKeys,
-        png_rgb_success: io.BytesIO,
+        image_file_success_state_low_rating: io.BytesIO,
     ) -> None:
         """
         The number of images with a False active_flag and a 'success' status is
         returned.
         """
-        image_data = png_rgb_success.read()
+        image_data = image_file_success_state_low_rating.read()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')
 
         data = {
@@ -323,12 +323,12 @@ class TestProcessingImages:
 
     def test_processing_images(
         self,
-        png_rgb_success: io.BytesIO,
+        image_file_success_state_low_rating: io.BytesIO,
     ) -> None:
         """
         The number of images in the processing state is returned.
         """
-        image_data = png_rgb_success.read()
+        image_data = image_file_success_state_low_rating.read()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')
 
         data = {

tests/mock_vws/test_get_duplicates.py

@@ -60,7 +60,7 @@ def test_duplicates(
         self,
         vuforia_database_keys: VuforiaDatabaseKeys,
         high_quality_image: io.BytesIO,
-        png_rgb_success: io.BytesIO,
+        image_file_success_state_low_rating: io.BytesIO,
     ) -> None:
         """
         Target IDs of similar targets are returned.
@@ -70,7 +70,7 @@ def test_duplicates(
         image_data = high_quality_image.read()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')
 
-        different = png_rgb_success.read()
+        different = image_file_success_state_low_rating.read()
         different_data_encoded = base64.b64encode(different).decode('ascii')
 
         original_data = {

tests/mock_vws/test_get_target.py

@@ -204,7 +204,7 @@ def test_fail_status(
     def test_success_status(
         self,
         vuforia_database_keys: VuforiaDatabaseKeys,
-        png_rgb_success: io.BytesIO,
+        image_file_success_state_low_rating: io.BytesIO,
     ) -> None:
         """
         When a random, large enough image is given, the status changes from
@@ -214,7 +214,7 @@ def test_success_status(
         The test image does not prove that what is counted as a success in the
         mock will be counted as a success in the real implementation.
         """
-        image_data = png_rgb_success.read()
+        image_data = image_file_success_state_low_rating.read()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')
 
         data = {

tests/mock_vws/test_update_target.py

@@ -266,14 +266,14 @@ class TestActiveFlag:
     def test_active_flag(
         self,
         vuforia_database_keys: VuforiaDatabaseKeys,
-        png_rgb_success: io.BytesIO,
+        image_file_success_state_low_rating: io.BytesIO,
         initial_active_flag: bool,
         desired_active_flag: bool,
     ) -> None:
         """
         Setting the active flag to a Boolean value changes it.
         """
-        image_data = png_rgb_success.read()
+        image_data = image_file_success_state_low_rating.read()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')
 
         data = {
@@ -582,13 +582,13 @@ def test_name_invalid(
 
     def test_existing_target_name(
         self,
-        png_rgb_success: io.BytesIO,
+        image_file_success_state_low_rating: io.BytesIO,
         vuforia_database_keys: VuforiaDatabaseKeys,
     ) -> None:
         """
         Only one target can have a given name.
         """
-        image_data = png_rgb_success.read()
+        image_data = image_file_success_state_low_rating.read()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')
 
         first_target_name = 'example_name'
@@ -644,13 +644,13 @@ def test_existing_target_name(
 
     def test_same_name_given(
         self,
-        png_rgb_success: io.BytesIO,
+        image_file_success_state_low_rating: io.BytesIO,
         vuforia_database_keys: VuforiaDatabaseKeys,
     ) -> None:
         """
         Updating a target with its own name does not give an error.
         """
-        image_data = png_rgb_success.read()
+        image_data = image_file_success_state_low_rating.read()
         image_data_encoded = base64.b64encode(image_data).decode('ascii')
 
         name = 'example'
@@ -964,7 +964,7 @@ def test_invalid_type(
 
     def test_rating_can_change(
         self,
-        png_rgb_success: io.BytesIO,
+        image_file_success_state_low_rating: io.BytesIO,
         high_quality_image: io.BytesIO,
         vuforia_database_keys: VuforiaDatabaseKeys,
     ) -> None:
@@ -976,7 +976,7 @@ def test_rating_can_change(
         The mock randomly assigns a quality and makes sure that the new quality
         is different to the old quality.
         """
-        poor_image = png_rgb_success.read()
+        poor_image = image_file_success_state_low_rating.read()
         poor_image_data_encoded = base64.b64encode(poor_image).decode('ascii')
 
         good_image = high_quality_image.read()