adding methods to compare images from the api response

Author: nareshnavinash

Data/DynamicData/sample.yml

@@ -1,6 +1,9 @@
 created_from: snap mode in pyrest framework
 test_sample_get_request_001:
-  name: Naresh
   age: 20
+  name: Naresh
 test_sample_get_request_002:
   name: $notnull
+test_sample_get_request_003:
+  image: https://avatars0.githubusercontent.com/u/27988169?s=460&v=4
+  name: Naresh

Data/Images/Naresh.png

@@ -119,3 +119,11 @@ def json_compare(json1, json2):
                 assert (result is True), "Key " + k + " is not in uuid format"
                 d1_filtered[k] = d2_filtered[k]
         return d1_filtered == d2_filtered
+
+    @staticmethod
+    def get_params_from_response(path):
+        path_array = path.split(",")
+        result = Store.current_response.json()
+        for key in path_array:
+            result = result[key]
+        return result

Library/api.py

@@ -2,45 +2,81 @@
 import allure
 import os
 import diffimg
+import requests
 from Library.variable import Var
 
 
 class Img:
 
+    @staticmethod
+    def download_image(url, name):
+        with allure.step("Downloading image from the URL: " + url):
+            response = requests.get(url, stream=True)
+            image_path = Img.root_path() + "/reports/images/" + name + ".png"
+            with open(image_path, "wb") as image:
+                for chunk in response.iter_content(chunk_size=1024):
+                    if chunk:
+                        image.write(chunk)
+            allure.attach.file(image_path, name="downloaded_image: " + name, attachment_type=allure.attachment_type.PNG)
+
     @staticmethod
     def is_equal(image1, image2):
-        image1_path = Img.root_path() + "/Data/Images/" + image1
-        image2_path = Img.root_path() + "/reports/images/" + image2
-        result = imgcompare.is_equal(image1_path, image2_path)
-        allure.attach.file(image1_path, name=image1, attachment_type=allure.attachment_type.PNG)
-        allure.attach.file(image2_path, name=image2, attachment_type=allure.attachment_type.PNG)
+        with allure.step("Comparing two images"):
+            try:
+                image1_path = Img.root_path() + "/Data/Images/" + image1 + ".png"
+                image2_path = Img.root_path() + "/reports/images/" + image2 + ".png"
+                result = imgcompare.is_equal(image1_path, image2_path)
+                allure.attach.file(image1_path, name=image1, attachment_type=allure.attachment_type.PNG)
+                allure.attach.file(image2_path, name=image2, attachment_type=allure.attachment_type.PNG)
+            except Exception as e:
+                allure.step("Exception happened while comparing the image: " + str(e))
+                result = False
         if not result:
-            image_diff_percent = imgcompare.image_diff_percent(image1_path, image2_path)
-            allure.step("Difference Percentage for comparing images is" + image_diff_percent)
-            diff_img_name = "diff_" + image1 + image2 + ".png"
-            diff_img_path = Img.root_path() + "/reports/images/" + diff_img_name
-            diffimg.diff(image1_path, image2_path, delete_diff_file=False,
-                         diff_img_file=diff_img_path, ignore_alpha=False)
-            allure.attach.file(diff_img_path, name=diff_img_name, attachment_type=allure.attachment_type.PNG)
-        return result
+            if Var.env("snap") == "1":
+                with allure.step("Copying the response file to the source file"):
+                    Img.copy_image(image1_path, image2_path)
+            with allure.step("Attaching the diff image file"):
+                image_diff_percent = imgcompare.image_diff_percent(image1_path, image2_path)
+                allure.step("Difference Percentage for comparing images is" + str(image_diff_percent))
+                diff_img_name = "diff_" + image1 + image2 + ".png"
+                diff_img_path = Img.root_path() + "/reports/images/" + diff_img_name
+                diffimg.diff(image1_path, image2_path, delete_diff_file=False,
+                             diff_img_file=diff_img_path, ignore_alpha=False)
+                allure.attach.file(diff_img_path, name=diff_img_name, attachment_type=allure.attachment_type.PNG)
+        assert (result is True), "Compared images are not equal"
 
     @staticmethod
     def is_equal_with_tolerance(image1, image2, tolerance=Var.current("tolerance")):
-        image1_path = Img.root_path() + "/Data/Images/" + image1
-        image2_path = Img.root_path() + "/reports/images/" + image2
-        result = imgcompare.is_equal(image1_path, image2_path, tolerance=tolerance)
-        allure.attach.file(image1_path, name=image1, attachment_type=allure.attachment_type.PNG)
-        allure.attach.file(image2_path, name=image2, attachment_type=allure.attachment_type.PNG)
+        with allure.step("Comparing two images with tolerance: " + tolerance):
+            image1_path = Img.root_path() + "/Data/Images/" + image1
+            image2_path = Img.root_path() + "/reports/images/" + image2
+            result = imgcompare.is_equal(image1_path, image2_path, tolerance=tolerance)
+            allure.attach.file(image1_path, name=image1, attachment_type=allure.attachment_type.PNG)
+            allure.attach.file(image2_path, name=image2, attachment_type=allure.attachment_type.PNG)
         if not result:
-            image_diff_percent = imgcompare.image_diff_percent(image1_path, image2_path)
-            allure.step("Difference Percentage for comparing images is" + image_diff_percent)
-            diff_img_name = "diff_" + image1 + image2 + ".png"
-            diff_img_path = Img.root_path() + "/reports/images/" + diff_img_name
-            diffimg.diff(image1_path, image2_path, delete_diff_file=False,
-                         diff_img_file=diff_img_path, ignore_alpha=False)
-            allure.attach.file(diff_img_path, name=diff_img_name, attachment_type=allure.attachment_type.PNG)
-        return result
+            if Var.env("snap") == "1":
+                with allure.step("Copying the response file to the source file"):
+                    Img.copy_image(image2_path, image1_path)
+            with allure.step("Attaching the diff image file"):
+                image_diff_percent = imgcompare.image_diff_percent(image1_path, image2_path)
+                allure.step("Difference Percentage for comparing images is" + image_diff_percent)
+                diff_img_name = "diff_" + image1 + image2 + ".png"
+                diff_img_path = Img.root_path() + "/reports/images/" + diff_img_name
+                diffimg.diff(image1_path, image2_path, delete_diff_file=False,
+                             diff_img_file=diff_img_path, ignore_alpha=False)
+                allure.attach.file(diff_img_path, name=diff_img_name, attachment_type=allure.attachment_type.PNG)
+        assert (result is True), "Compared images are not equal even with tolerance"
 
     @staticmethod
     def root_path():
         return os.path.dirname(os.path.abspath(__file__)).replace("/Library", "")
+
+    @staticmethod
+    def copy_image(source, destination):
+        file = open(source, "wb")
+        with open(destination, "rb") as f:
+            while True:
+                byte = f.read(1)
+                if not byte:
+                    break
+                file.write(byte)

Library/images.py

@@ -1,6 +1,7 @@
 import allure
 import pytest
 from Library.api import Api
+from Library.images import Img
 
 
 @allure.feature("Sample get request")
@@ -23,3 +24,17 @@ def test_sample_get_request_002():
     Api.verify_response_code(200)
     Api.ignore_keys("age")
     Api.verify_response_json("sample.yml", "test_sample_get_request_002")
+
+
+@allure.feature("Sample get request with image URL")
+@allure.severity('Critical')
+@pytest.mark.regression  # Custom pytest marker to run the test cases with ease on demand
+@pytest.mark.plain  # Custom pytest marker to run the test cases with ease on demand
+def test_sample_get_request_002():
+    Api.get("/image")
+    Api.verify_response_code(200)
+    Api.ignore_keys("age")
+    Api.verify_response_json("sample.yml", "test_sample_get_request_003")
+    image_url = Api.get_params_from_response("image")
+    Img.download_image(image_url, "Naresh")
+    Img.is_equal("Naresh", "Naresh")