Refactor the folder structure and env & local variable changes

Author: nareshnavinash

.gitignore

@@ -11,9 +11,9 @@ __pycache__/
 # python identifiers
 .python-version
 
-# pytest report
+# pytest reports
 html_report.html
-report/
+
 
 # browser trash
 geckodriver.log

Data/GlobalData/global_data.yml

@@ -0,0 +1,5 @@
+browser: chrome
+implicit_wait: 10
+browser_horizontal_size: 1200
+browser_vertical_size: 800
+headless: 0

screenshots/.ignore renamed to Data/TestData/.ignore

@@ -0,0 +1,2 @@
+url: https://www.google.com
+search_text: hello

Data/TestData/google.yml

@@ -1,62 +1,72 @@
 from selenium import webdriver
 from selenium.common.exceptions import NoSuchElementException
 from selenium.webdriver.remote import webelement
+from Library.variable import Var
 import os
+import datetime
+
 from Library.store import Store
 
 
 class Driver:
-	driver = None
-
-	def __init__(self, browser = "chrome") -> None:
-		if browser == "chrome":
-			options = webdriver.ChromeOptions()
-			options.add_argument("--no-sandbox")
-			options.add_argument("--foreground")
-			options.add_argument('disable-infobars')
-			options.add_argument("--disable-extensions")
-			# options.add_argument("--headless")
-			self.driver = webdriver.Chrome(options=options)
-			self.driver.implicitly_wait(20)
-		elif browser == "firefox":
-			self.driver = webdriver.Firefox()
-		elif browser == "safari":
-			self.driver = webdriver.Safari()
-		Store.push(self.driver)
-
-	def get(self, url: str) -> None:
-		self.driver.get(url)
-
-	def find_element(self, by, value) -> webelement.WebElement:
-		try:
-			return self.driver.find_element(by, value)
-		except NoSuchElementException:
-			print("Element not found \n\n" + by + "\n" + value)
-		except Exception as e:
-			print("Error in finding the element \n\n" + by + "\n" + value + "\nException: \n" + str(e))
-
-	def find_elements(self, by, value) -> list[webelement.WebElement]:
-		try:
-			return self.driver.find_elements(by, value)
-		except NoSuchElementException:
-			print("Element not found \n\n" + by + "\n" + value)
-		except Exception as e:
-			print("Error in finding the element \n\n" + by + "\n" + value + "\nException: \n" + str(e))
-
-	def refresh(self) -> None:
-		self.driver.refresh()
-
-	def execute_script(self, script, locator) -> None:
-		self.driver.execute_script(self, script, locator)
-
-	def current_url(self) -> str:
-		return self.driver.current_url
-
-	def save_screenshot(self) -> bool:
-		ROOT_DIR = os.path.dirname(os.path.abspath(__file__))
-		CONFIG_PATH = os.path.join(ROOT_DIR, 'configuration.conf')
-		self.driver.save_screenshot(self, )
-
-
-	def quit(self):
-		self.driver.quit()
+    driver = None
+
+    def __init__(self) -> None:
+        if not Var.env("browser") == "None":
+            browser = Var.env("browser")
+        else:
+            browser = Var.glob("browser")
+        if browser == "chrome":
+            options = webdriver.ChromeOptions()
+            options.add_argument("--no-sandbox")
+            options.add_argument("--foreground")
+            options.add_argument('disable-infobars')
+            options.add_argument("--disable-extensions")
+            if str(Var.glob("headless")) == "1" or str(Var.env("headless")) == "1":
+                options.add_argument("--headless")
+            self.driver = webdriver.Chrome(options=options)
+            self.driver.implicitly_wait(int(Var.glob("implicit_wait")))
+            self.driver.set_window_size(int(Var.glob("browser_horizontal_size")), int(Var.glob("browser_vertical_size")))
+        elif browser == "firefox":
+            self.driver = webdriver.Firefox()
+        elif browser == "safari":
+            self.driver = webdriver.Safari()
+        Store.push(self.driver)
+
+    def get(self, url: str) -> None:
+        self.driver.get(url)
+
+    def find_element(self, by, value) -> webelement.WebElement:
+        try:
+            return self.driver.find_element(by, value)
+        except NoSuchElementException:
+            print("Element not found \n\n" + by + "\n" + value)
+        except Exception as e:
+            print("Error in finding the element \n\n" + by + "\n" + value + "\nException: \n" + str(e))
+
+    def find_elements(self, by, value):
+        try:
+            return self.driver.find_elements(by, value)
+        except NoSuchElementException:
+            print("Element not found \n\n" + by + "\n" + value)
+        except Exception as e:
+            print("Error in finding the element \n\n" + by + "\n" + value + "\nException: \n" + str(e))
+
+    def refresh(self) -> None:
+        self.driver.refresh()
+
+    def execute_script(self, script, locator) -> None:
+        self.driver.execute_script(self, script, locator)
+
+    def current_url(self) -> str:
+        return self.driver.current_url
+
+    def save_screenshot(self) -> str:
+        root_dir = os.path.dirname(os.path.abspath(__file__))
+        config_path = os.path.join(root_dir, 'reports/screenshot/img%s.png' % datetime.datetime.now().strftime("%Y%m%d-%H%M%S"))
+        self.driver.save_screenshot(config_path)
+        return config_path
+
+    def quit(self):
+        self.driver.quit()
+

Library/driver.py

@@ -0,0 +1,42 @@
+import os
+import yaml
+
+
+class Var:
+    file_name = None
+    local_variable = None
+
+    def __init__(self, file_name):
+        self.file_name = file_name
+        try:
+            root_dir = os.path.dirname(os.path.abspath(__file__)).replace("/Library", "")
+            with open(root_dir + '/Data/TestData/' + file_name) as file:
+                self.local_variable = yaml.load(file, Loader=yaml.FullLoader)
+        except Exception as e:
+            print(e)
+
+    @staticmethod
+    def env(string):
+        try:
+            return os.environ[string]
+        except Exception as e:
+            print(e)
+            return "None"
+
+    @staticmethod
+    def glob(string):
+        try:
+            root_dir = os.path.dirname(os.path.abspath(__file__)).replace("/Library", "")
+            with open(root_dir + '/Data/GlobalData/global_data.yml') as file:
+                global_data = yaml.load(file, Loader=yaml.FullLoader)
+                return global_data[string]
+        except Exception as e:
+            print(e)
+            return "None"
+
+    def loc(self, string):
+        try:
+            return self.local_variable[string]
+        except Exception as e:
+            print(e)
+            return ""

Library/variable.py

@@ -2,10 +2,17 @@
 
 
 @pytest.fixture(autouse=True)
-def before_all():
-    print('@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ INITIALIZATION')
+def before_each():
+    print('*-* Before each INITIALIZATION')
     yield
-    print('######################################### END')
+    print('*-* After each END')
+
+
+@pytest.fixture(scope='module', autouse=True)
+def before_module():
+    print('*-* Before module INITIALIZATION')
+    yield
+    print('*-* After module END')
 
 
 def pytest_configure(config):

Tests/conftest.py

@@ -3,32 +3,23 @@
 import os
 from Library.driver import Driver
 from Pages.google import GooglePage
+from Library.variable import Var
 
 
 @allure.feature("Google Search")
 @allure.step('Enter and search')
 @allure.severity('Critical')
 def test_google_search():
+    with allure.step("Set the test data file needed for this test run"):
+        variable = Var("google.yml")
+
     with allure.step("first step"):
-        print(os.environ['BROWSER'])
-        d = Driver("chrome")
-        d.get("https://www.google.com")
+        d = Driver()
+        d.get(variable.loc("url"))
         print("landed in google home page")
 
     with allure.step("second step"):
-        GooglePage.enter_search_text("hello")
+        GooglePage.enter_search_text(variable.loc("search_text"))
         d.quit()
 
 
-@allure.feature("Google Search 2")
-@allure.step('Enter and search 2')
-@allure.severity('Critical')
-def test_google_search2():
-    with allure.step("first step 2"):
-        d = Driver("chrome")
-        d.get("https://www.google.com")
-        print("landed in google home page")
-
-    with allure.step("second step 2"):
-        GooglePage.enter_search_text("hello")
-        d.quit()

Tests/google.py

@@ -8,7 +8,7 @@ addopts = -rsxX
           -q
           -v
           --self-contained-html
-          --html=html_report.html
+          --html=reports/html_report.html
           --cov=Tests
-          --alluredir report
+          --alluredir reports/allure
           --clean-alluredir