Merge pull request #12 from startrug/SPF-04

Spf-04: feat: Reorganize tests; add sample test for alternative website

Author: startrug

.gitignore

@@ -1,3 +1,148 @@
-.idea
-venv
-reports
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/master/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# VSCode
+.vscode

pages/__init__.py renamed to base/__init__.py

@@ -0,0 +1,10 @@
+import allure
+
+
+class PageBase:
+    def __init__(self, driver):
+        self.driver = driver
+
+    @allure.step("Opening main page")
+    def open(self):
+        self.driver.open()

base/page_base.py

@@ -1,6 +1,6 @@
 {
-  "browser": "firefox",
-  "headless_mode": true,
-  "tested_page": "http://www.phptravels.net/",
+  "browser": "chrome",
+  "headless_mode": false,
+  "base_url": "http://www.demoblaze.com/",
   "timeout": 10
 }

config.json

@@ -0,0 +1,10 @@
+from selenium.webdriver.support.event_firing_webdriver import EventFiringWebDriver
+
+
+class WebDriverExtended(EventFiringWebDriver):
+    def __init__(self, driver, event_listener, config):
+        super().__init__(driver, event_listener)
+        self.base_url = config["base_url"]
+
+    def open(self):
+        self.get(self.base_url)

extensions/webdriver_extended.py

@@ -2,24 +2,24 @@
 import datetime
 from selenium.webdriver.support.events import AbstractEventListener
 
-log_filename = datetime.datetime.now().strftime("%Y%m%d_%H%M%S")
-logging.basicConfig(
-    # log file will be created in "tests" directory. Feel free to change the path or filename
-    filename=f"{log_filename}.log",
-    format="%(asctime)s: %(levelname)s: %(message)s",
-    level=logging.INFO
-)
-
 
 class WebDriverListener(AbstractEventListener):
+    log_filename = datetime.datetime.now().strftime("%Y%m%d")
+    logging.basicConfig(
+        # log file will be created in "tests" directory. Feel free to change the path or filename
+        filename=f"{log_filename}.log",
+        format="%(asctime)s: %(levelname)s: %(message)s",
+        level=logging.INFO
+    )
+
     def __init__(self):
         self.logger = logging.getLogger("selenium")
 
     def before_navigate_to(self, url, driver):
         self.logger.info(f"Navigating to {url}")
 
     def after_navigate_to(self, url, driver):
-        self.logger.info(f"Navigated to {url}")
+        self.logger.info(f"{url} opened")
 
     def before_find(self, by, value, driver):
         self.logger.info(f"Searching for element by {by} {value}")

helpers/web_driver_listener.py renamed to helpers/webdriver_listener.py

@@ -0,0 +1,11 @@
+from base.page_base import PageBase
+import allure
+
+
+class HomePage(PageBase):
+    def __init__(self, driver):
+        super().__init__(driver)
+
+    @allure.step("Getting title of the page")
+    def get_page_title(self):
+        return self.driver.title

pages/base_page.py

@@ -1,10 +1,10 @@
 import allure
 from selenium.webdriver.common.keys import Keys
 from locators.locators import LogInLocators
-from pages.base_page import BasePage
+from base.page_base import PageBase
 
 
-class LogInPage(BasePage):
+class LogInPage(PageBase):
     def __init__(self, driver):
         super().__init__(driver)
 
@@ -21,7 +21,8 @@ def set_user_inputs(self, email, password):
         self.driver.find_element(*LogInLocators.email_input).click()
         self.driver.find_element(*LogInLocators.email_input).send_keys(email)
         self.driver.find_element(*LogInLocators.password_input).click()
-        self.driver.find_element(*LogInLocators.password_input).send_keys(password, Keys.ENTER)
+        self.driver.find_element(
+            *LogInLocators.password_input).send_keys(password, Keys.ENTER)
 
     @allure.step("Logout")
     def logout(self):

pages/demoblaze/__init__.py

@@ -6,10 +6,10 @@
 
 from utils.driver_factory import DriverFactory
 
-CONFIG_PATH = "../config.json"
+CONFIG_PATH = "config.json"
 DEFAULT_WAIT_TIME = 10
 SUPPORTED_BROWSERS = ["chrome", "firefox", "edge"]
-DEFAULT_WEBSITE = "http://www.google.com/"
+DEFAULT_URL = "http://www.demoblaze.com/"
 
 
 @pytest.fixture(scope='session')
@@ -33,19 +33,20 @@ def wait_time_setup(config):
 
 
 @pytest.fixture(scope='session')
-def website_setup(config):
-    return config['tested_page'] if 'tested_page' in config else DEFAULT_WEBSITE
+def url_setup(config):
+    return config["base_url"] if "base_url" in config else DEFAULT_URL
 
 
 @pytest.fixture()
 def setup(request, config):
-    driver = DriverFactory.get_driver(config["browser"], config["headless_mode"])
+    driver = DriverFactory.get_driver(config)
     driver.implicitly_wait(config["timeout"])
     request.cls.driver = driver
     before_failed = request.session.testsfailed
     if config["browser"] == "firefox":
         driver.maximize_window()
     yield
     if request.session.testsfailed != before_failed:
-        allure.attach(driver.get_screenshot_as_png(), name="Test failed", attachment_type=AttachmentType.PNG)
+        allure.attach(driver.get_screenshot_as_png(),
+                      name="Test failed", attachment_type=AttachmentType.PNG)
     driver.quit()

pages/demoblaze/home_page.py

@@ -0,0 +1,14 @@
+import pytest
+import allure
+
+from pages.demoblaze.home_page import HomePage
+
+
+@pytest.mark.usefixtures("setup")
+class TestHomePage:
+    @allure.title("Home page - smoke test")
+    @allure.description("Check if home page of Demoblaze has correct title")
+    def test_homepage_title(self):
+        homepage = HomePage(self.driver)
+        homepage.open()
+        assert("STORE" in homepage.get_page_title())

pages/phptravels/__init__.py

@@ -1,34 +1,34 @@
 import pytest
 import allure
 from locators.locators import UserAccountLocators, LogInLocators
-from pages.login_page import LogInPage
+from pages.phptravels.login_page import LogInPage
 
 
-@pytest.mark.usefixtures("setup", "website_setup")
+@pytest.mark.usefixtures("setup")
 class TestLogIn:
 
     @allure.title("Login with valid data test")
     @allure.description("This is test of login with valid data")
-    def test_login_passed(self, config):
+    def test_login_passed(self):
         log_in_page = LogInPage(self.driver)
-        log_in_page.open_home_page(config)
+        log_in_page.open()
         log_in_page.expand_account_menu()
         log_in_page.open_login_page()
         log_in_page.set_user_inputs("[email protected]", "demouser")
         welcome_msg = "Hi, Demo User"
-        assert welcome_msg in self.driver.find_element(*UserAccountLocators.welcome_msg).text
+        assert welcome_msg in self.driver.find_element(
+            *UserAccountLocators.welcome_msg).text
         log_in_page.expand_account_menu()
         log_in_page.logout()
 
     @allure.title("Login with invalid email test")
     @allure.description("This is test of login with invalid email")
-    def test_login_failed(self, config):
+    def test_login_failed(self):
         log_in_page = LogInPage(self.driver)
-        log_in_page.open_home_page(config)
+        log_in_page.open()
         log_in_page.expand_account_menu()
         log_in_page.open_login_page()
         log_in_page.set_user_inputs("[email protected]", "demouser")
         error_msg = "Invalid Email or Password"
-        assert error_msg in self.driver.find_element(*LogInLocators.invalid_data_msg).text
-
-
+        assert error_msg in self.driver.find_element(
+            *LogInLocators.invalid_data_msg).text