Image compare module with folder structure

Author: nareshnavinash

.gitignore

@@ -11,4 +11,4 @@ __pycache__/
 .python-version
 
 # pytest reports
-reports/
+#reports/

Data/GlobalData/global_data.yml

@@ -1,2 +1,3 @@
 URL: https://naresh.free.beeceptor.com
 timeout: 10
+tolerance: 0.01

Data/Images/.keep

@@ -0,0 +1,29 @@
+import imgcompare
+import allure
+import os
+from Library.variable import Var
+
+
+class Img:
+
+    @staticmethod
+    def is_equal(image1, image2):
+        image1_path = os.path.dirname(os.path.abspath(__file__)).replace("/Library", "") + "/Data/Images/" + image1
+        image2_path = os.path.dirname(os.path.abspath(__file__)).replace("/Library", "") + "/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)
+        image_diff_percent = imgcompare.image_diff_percent(image1_path, image2_path)
+        allure.step("Difference Percentage for comparing images is" + image_diff_percent)
+        return result
+
+    @staticmethod
+    def is_equal_with_tolerance(image1, image2, tolerance=Var.current("tolerance")):
+        image1_path = os.path.dirname(os.path.abspath(__file__)).replace("/Library", "") + "/Data/Images/" + image1
+        image2_path = os.path.dirname(os.path.abspath(__file__)).replace("/Library", "") + "/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)
+        image_diff_percent = imgcompare.image_diff_percent(image1_path, image2_path)
+        allure.step("Difference Percentage for comparing images is" + image_diff_percent)
+        return result

Library/images.py

@@ -13,17 +13,17 @@ class Var:
     dynamic_data_path = Store.dynamic_data_path
     global_data_path = Store.global_data_path
 
-    def __init__(self, file_name, type):
+    def __init__(self, file_name, file_type):
         self.file_name = file_name
-        if type == "static":
+        if file_type == "static":
             try:
                 self.file_path = self.static_data_path + '/' + file_name
                 with open(self.file_path) as file:
                     self.static_variable = yaml.load(file, Loader=yaml.FullLoader)
                 allure.attach.file(self.file_path, name=self.file_name, attachment_type=allure.attachment_type.TEXT)
             except Exception as e:
                 print(e)
-        if type == "dynamic":
+        if file_type == "dynamic":
             try:
                 self.file_path = self.dynamic_data_path + '/' + file_name
                 if not os.path.isfile(self.file_path):
@@ -56,6 +56,13 @@ def glob(string):
             print(e)
             return "None"
 
+    @staticmethod
+    def current(string):
+        if Var.env(string) == "None":
+            return Var.glob(string)
+        else:
+            return Var.env(string)
+
     def static_value_for(self, string) -> str:
         try:
             return self.static_variable[string]

Library/variable.py

@@ -1,7 +1,5 @@
-import datetime
 import os
 import pytest
-import allure
 import glob
 from Library.store import Store
 
@@ -31,32 +29,38 @@ def pytest_configure(config):
     This hook is called for every plugin and initial conftest
     file after command line options have been parsed.
     """
-    print("*-* pytest_configure")
+    print("*-* pytest_configure" + config)
     # Configuring the selpy with data path location
     Store.global_data_path = os.path.dirname(
         os.path.abspath(__file__)).replace("/Tests", "") + '/Data/GlobalData/global_data.yml'
     Store.static_data_path = os.path.dirname(os.path.abspath(__file__)).replace("/Tests", "") + '/Data/TestData/'
     Store.dynamic_data_path = os.path.dirname(os.path.abspath(__file__)).replace("/Tests", "") + '/Data/DynamicData/'
+    root_dir = os.path.dirname(os.path.abspath(__file__)).replace("/Tests", "")
+    # Clearing the old screenshots from the location.
+    config_path = root_dir + '/reports/images/*.png'
+    for CleanUp in glob.glob(config_path):
+        print(CleanUp)
+        os.remove(CleanUp)
 
 
 def pytest_sessionstart(session):
     """
     Called after the Session object has been created and
     before performing collection and entering the run test loop.
     """
-    print("*-* pytest_sessionstart")
+    print("*-* pytest_sessionstart" + session)
 
 
 def pytest_sessionfinish(session, exitstatus):
     """
     Called after whole test run finished, right before
     returning the exit status to the system.
     """
-    print("*-* pytest_sessionfinish")
+    print("*-* pytest_sessionfinish" + session + exitstatus)
 
 
 def pytest_unconfigure(config):
     """
     called before test process is exited.
     """
-    print("*-* pytest_unconfigure")
+    print("*-* pytest_unconfigure" + config)

Tests/conftest.py

@@ -1,3 +1,4 @@
+imgcompare
 pytest==5.3.2
 pytest-cov==2.8.1
 pytest-metadata==1.8
@@ -9,3 +10,4 @@ allure-pytest==2.8.6
 ipdb == 0.12.3
 pyyaml == 5.3
 flake8 == 3.7.9
+imgcompare = 2.0.1