fix tests

Author: JulienChampagnol

src/opengeodeweb_viewer/vtk_protocol.py

@@ -296,16 +296,22 @@ def takeScreenshot(self, params):
 
         if not include_background:
             renderWindow.SetAlphaBitPlanes(1)
+            w2if.SetInputBufferTypeToRGBA()
+        else:
+            renderWindow.SetAlphaBitPlanes(0)
+            w2if.SetInputBufferTypeToRGB()
+
+        renderWindow.Render()
 
         w2if.SetInput(renderWindow)
-        w2if.SetInputBufferTypeToRGBA() 
         w2if.ReadFrontBufferOff()
         w2if.Update()
-        renderWindow.SetAlphaBitPlanes(0)
 
         if output_extension == "png":
             writer = vtkPNGWriter()
-        elif output_extension == "jpg":
+        elif output_extension in ["jpg", "jpeg"]:
+            if not include_background:
+                raise Exception("output_extension not supported with background")
             writer = vtkJPEGWriter()
         else:
             raise Exception("output_extension not supported")

src/tests/conftest.py

@@ -30,8 +30,8 @@ def __init__(self, log):
         self.call("viewport.image.push.observer.add", [-1])
         for i in range(5):
             print(f"{i=}", flush=True)
-            reponse = self.ws.recv()
-            print(f"{reponse=}", flush=True)
+            response = self.ws.recv()
+            print(f"{response=}", flush=True)
 
     def call(self, rpc, params=[{}]):
         print(f"{rpc=} {params=}", flush=True)
@@ -62,6 +62,26 @@ def get_response(self):
             return response
         else:
             return eval(response)
+    def images_diff(self, first_image_path, second_image_path):
+        if ".png" in first_image_path:
+            first_reader = vtk.vtkPNGReader()
+        elif (".jpg" in first_image_path) or (".jpeg" in first_image_path):
+            first_reader = vtk.vtkJPEGReader()
+        first_reader.SetFileName(first_image_path)
+
+        if ".png" in second_image_path:
+            second_reader = vtk.vtkPNGReader()
+        elif (".jpg" in second_image_path) or (".jpeg" in second_image_path):
+            second_reader = vtk.vtkJPEGReader()
+        second_reader.SetFileName(second_image_path)
+
+        images_diff = vtk.vtkImageDifference()
+        images_diff.SetInputConnection(first_reader.GetOutputPort())
+        images_diff.SetImageConnection(second_reader.GetOutputPort())
+        images_diff.Update()
+
+        print(f"{images_diff.GetThresholdedError()=}")
+        return images_diff.GetThresholdedError()
 
     def compare_image(self, nb_messages, filename):
         for message in range(nb_messages):
@@ -86,20 +106,10 @@ def compare_image(self, nb_messages, filename):
                 f.write(image)
                 f.close()
 
-            test_reader = vtk.vtkJPEGReader()
-            test_reader.SetFileName(test_file_path)
-
             path_image = os.path.join(self.images_dir_path, filename)
-            answer_reader = vtk.vtkJPEGReader()
-            answer_reader.SetFileName(path_image)
 
-            images_diff = vtk.vtkImageDifference()
-            images_diff.SetInputConnection(test_reader.GetOutputPort())
-            images_diff.SetImageConnection(answer_reader.GetOutputPort())
-            images_diff.Update()
+            return self.images_diff(test_file_path, path_image)==0.0
 
-            print(f"{images_diff.GetThresholdedError()=}")
-            return images_diff.GetThresholdedError() == 0.0
 
 
 class FixtureHelper:

src/tests/data/images/take_screenshot_with_background.jpg

@@ -107,22 +107,68 @@ def test_set_color(server):
 
 
 def test_take_screenshot(server):
-
+    # Create an object
     server.call(
         "create_object_pipeline",
         [{"id": "123456789", "file_name": "hat.vtp"}],
     )
     assert server.compare_image(3, "create_object_pipeline.jpeg") == True
 
+
+    # Take a screenshot with background jpg
+    server.call(
+        "take_screenshot",
+        [{"filename": "take_screenshot_with_background", "output_extension": "jpg", "include_background": True}],
+    )
+
+    response = server.get_response()
+    blob = server.get_response()
+    assert type(blob) is bytes
+
+    with open(os.path.join(server.test_output_dir, "test.jpg"), "wb") as f:
+        f.write(blob)
+        f.close()
+    first_image_path = os.path.join(server.test_output_dir, "test.jpg")
+    second_image_path = os.path.join(server.images_dir_path, "take_screenshot_with_background.jpg")
+
+    assert server.images_diff(first_image_path, second_image_path) == 0.0
+
+    # Take a screenshot without background png
     server.call(
         "take_screenshot",
-        [{"filename": "screenshot", "output_extension": "png", "include_background": False}],
+        [{"filename": "take_screenshot_without_background", "output_extension": "png", "include_background": True}],
     )
+    
+    response = server.get_response()
+    response = server.get_response()
+    blob = server.get_response()
+    print(f"{blob=}", flush=True)
+    assert type(blob) is bytes
 
-    response1 = server.get_response()
-    print(f"{response1=}", flush=True)
-    response2 = server.get_response()
-    print(f"{response2=}", flush=True)
+    with open(os.path.join(server.test_output_dir, "test.png"), "wb") as f:
+        f.write(blob)
+        f.close()
+    first_image_path = os.path.join(server.test_output_dir, "test.png")
+    second_image_path = os.path.join(server.images_dir_path, "take_screenshot_without_background.png")
 
-    blob = response2
+    assert server.images_diff(first_image_path, second_image_path) == 0.0
+
+    # Take a screenshot with background png
+    server.call(
+        "take_screenshot",
+        [{"filename": "take_screenshot_with_background", "output_extension": "png", "include_background": True}],
+    )
+    
+    response = server.get_response()
+    response = server.get_response()
+    blob = server.get_response()
+    print(f"{blob=}", flush=True)
     assert type(blob) is bytes
+
+    with open(os.path.join(server.test_output_dir, "test.png"), "wb") as f:
+        f.write(blob)
+        f.close()
+    first_image_path = os.path.join(server.test_output_dir, "test.png")
+    second_image_path = os.path.join(server.images_dir_path, "take_screenshot_with_background.png")
+
+    assert server.images_diff(first_image_path, second_image_path) == 0.0