Add encryption for sensitive data

README.md

@@ -18,13 +18,16 @@ A simple UI automation framework built with:
 - Integrated with **GitHub Actions** CI workflow for Darwin (Mac) and Linux.
 - Supports multiple environments: **dev**, **stage**.
 - Generates **pytest reports** and **custom logs**.
+- Secure Secrets Handling: Sensitive data like passwords are encrypted and stored securely.
+- Test Data Management: Integrated with YAML files for test data storage and access.
 
 ## Getting Started
 
 ### Prerequisites
 
 - Python 3.8 - 3.12
 - If you're not using macOS with ARM64 architecture or a Selenium version below 4.24.0, please upload the appropriate driver corresponding to your OS to the `resources` directory.
+- secure-test-automation for encrypting sensitive data
 
 ### Local Usage
 
@@ -68,7 +71,7 @@ A simple UI automation framework built with:
 | 1. Drivers factory: local, remote, [Chrome, Firefox]                                                      | ![Status](https://img.shields.io/badge/DONE-brightgreen)      |
 | 2. `pytest.ini` config: addopts, errors, markers                                                          | ![Status](https://img.shields.io/badge/DONE-brightgreen)      |
 | 3. Environments: dev, stag, prod                                                                          | ![Status](https://img.shields.io/badge/DONE-brightgreen)      |
-| 4. Secrets                                                                                                | ![Status](https://img.shields.io/badge/TODO-yellow)      |
+| 4. Secrets                                                                                                | ![Status](https://img.shields.io/badge/DONE-brightgreen)      |
 | 5. Utilities: YAML reader, logger                                                                          | ![Status](https://img.shields.io/badge/DONE-brightgreen)      |
 | 6. BasePage: wait strategy, base actions                                                                  | ![Status](https://img.shields.io/badge/DONE-brightgreen)      |
 | 7. Properties: make properties helper                                                                       | ![Status](https://img.shields.io/badge/DONE-brightgreen)      |
@@ -107,4 +110,20 @@ The linting configuration defines rules that dictate the checks performed. Custo
    ```plaintext
    $FilePathRelativeToProjectRoot$ --config .ruff.toml
    ```
+### Secrets
+To secure our passwords or sensitive data, we store them in an encrypted form. For this, we use the [secure-test-automation](https://pypi.org/project/secure-test-automation/) library.
+implementation on framework side: utils/crypto.py
+The encryption key is stored in `/config/key.properties` (this file should be added to `.gitignore`) for local testing.  
+For executing tests in remote environments (e.g., BrowserStack, Jenkins, etc.), we have integrated the Vault HashiCorp library.  
+
+```python
+@pytest.fixture
+def get_password():
+    secure = Secure()
+    read = YAMLReader.read("data.yaml", to_simple_namespace=True)
+    password = read.users.john.details.password
+    return secure.decrypt_password(password)
+```
+
+
 ### Demo tool https://demoqa.com/text-box

config/data.yaml

@@ -1,10 +1,10 @@
 users:
-  username1:
+  john:
     username: "[email protected]"
     details:
       first_name: "John"
       last_name: "Doe"
-      password: ""
+      password: gAAAAABngSXGxzoV1WZASXEj7VbEH37pOJ4_vC9gcdUnSpUI46fPOvTxhQ4-p_JNdCpRqmDlqX4nE0c9ISBB3-0-lWs2WcvdAQ==
   username2:
     username: "username"
 names:

config/key.properties

@@ -0,0 +1 @@
+rd-xPFY051UmVWPmmNoMXkq3qbuCJ7Ajc0BY7MtXm6g=

conftest.py

@@ -4,8 +4,8 @@
 from dotenv import load_dotenv
 from selenium.webdriver.support.event_firing_webdriver import EventFiringWebDriver
 
-from core.event_listener import EventListener
-from core.driver_factory import WebDriverFactory
+from core_driver.event_listener import EventListener
+from core_driver.driver_factory import WebDriverFactory
 from utils.logger import Logger, LogLevel
 
 log = Logger(log_lvl=LogLevel.INFO).get_instance()

core/driver.py → core_driver/driver.py

@@ -4,7 +4,7 @@
 from selenium.webdriver.chrome.service import Service as ChromeService
 from selenium.webdriver.remote.remote_connection import RemoteConnection
 from webdriver_manager.chrome import ChromeDriverManager
-from core.driver_options import _init_driver_options
+from core_driver.driver_options import _init_driver_options
 from utils.error_handler import ErrorHandler, ErrorType
 from utils.logger import Logger, LogLevel
 from properties import Properties
@@ -57,16 +57,13 @@ def create_driver(self, environment=None, dr_type="local"):
             driver_path = ChromeDriverManager().install()
             options = _init_driver_options(dr_type=dr_type)
             driver = webdriver.Chrome(
-                service=ChromeService(executable_path=driver_path),
-                options=options
+                service=ChromeService(executable_path=driver_path), options=options
             )
             log.info(
                 f"Created local Chrome driver with session: {driver.session_id}"
             )
         except Exception as e:
-            log.error(
-                f"Failed to create Chrome driver  {e}"
-            )
+            log.error(f"Failed to create Chrome driver  {e}")
             driver = webdriver.Chrome(
                 service=ChromeService(_get_driver_path(dr_type)),
                 options=_init_driver_options(dr_type=dr_type),
@@ -82,18 +79,14 @@ def create_driver(self, environment=None, dr_type=None):
             command_executor=RemoteConnection("your remote URL"),
             desired_capabilities={"LT:Options": caps},  # noqa
         )
-        log.info(
-            f"Remote Chrome driver created with session: {driver.session_id}"
-        )
+        log.info(f"Remote Chrome driver created with session: {driver.session_id}")
         return driver
 
 
 class FirefoxDriver(Driver):
     def create_driver(self, environment=None, dr_type=None):
         try:
-            driver = webdriver.Firefox(
-                options=_init_driver_options(dr_type=dr_type)
-            )
+            driver = webdriver.Firefox(options=_init_driver_options(dr_type=dr_type))
             log.info(f"Created Firefox driver with session: {driver.session_id}")
         except Exception as e:
             driver = webdriver.Chrome(

core/driver_factory.py → core_driver/driver_factory.py

@@ -1,4 +1,4 @@
-from core.driver import ChromeRemoteDriver, FirefoxDriver, LocalDriver
+from core_driver.driver import ChromeRemoteDriver, FirefoxDriver, LocalDriver
 from utils.error_handler import ErrorHandler, ErrorType
 from utils.logger import Logger, LogLevel
 

core/driver_options.py → core_driver/driver_options.py

@@ -9,7 +9,7 @@
 def _shared_driver_options(options):
     options.add_argument("--start-maximized")
     options.add_argument("--disable-dev-shm-usage")
-    options.page_load_strategy = 'none'  # disable waiting for fully load page
+    options.page_load_strategy = "none"  # disable waiting for fully load page
     if platform.system() == "Linux":
         options.add_argument("--no-sandbox")
     log.info(f"Driver options {options.arguments}")
@@ -25,9 +25,7 @@ def _init_driver_options(dr_type=None):
     options = driver_option_mapping.get(dr_type)
 
     if options is None:
-        raise ErrorHandler.raise_error(
-            ErrorType.UNSUPPORTED_DRIVER_TYPE, dr_type
-        )
+        raise ErrorHandler.raise_error(ErrorType.UNSUPPORTED_DRIVER_TYPE, dr_type)
 
     _shared_driver_options(options)
     log.info(f"Driver options {options.arguments}")

core/event_listener.py → core_driver/event_listener.py

@@ -1,6 +1,4 @@
-from selenium.webdriver.support.abstract_event_listener import (
-    AbstractEventListener
-)
+from selenium.webdriver.support.abstract_event_listener import AbstractEventListener
 
 
 class EventListener(AbstractEventListener):

pyproject.toml

@@ -7,7 +7,7 @@ readme = "README.md"
 packages = [
     { include = "utils" },
     { include = "scraper" },
-    { include = "core" }
+    { include = "core_driver" }
 ]
 [tool.poetry.dependencies]
 python = "^3.12"
@@ -19,11 +19,12 @@ python-dotenv = "1.0.1"
 asyncio = "3.4.3"
 aioselenium = "0.0.1"
 pytest-xdist="3.3.1"
-cryptography="43.0.1"
+cryptography="44.0.0"
 beautifulsoup4="4.12.2"
 requests="^2.31.0"
 setuptools="70.0.0"
 ruff="0.6.8"
+secure-test-automation="^1.3.1"
 
 
 [tool.pytest.ini_options]

src/locators/locators.py

@@ -3,7 +3,11 @@
 
 class General:
     LOGO = (By.ID, "userForm")
+    ELEMENTS = (By.XPATH, "//h5[text()='Elements']")
+    FORMS = (By.XPATH, "//div[@class='card-body']//h5[text()='Forms']")
+    STORE = (By.XPATH, "//h5[text()='Book Store Application']")
 
 
-class TextFields:
+class TextBoxFields:
     USER_NAME = (By.ID, "userName")
+    TEXT_BOX = (By.XPATH, "//span[text()='Text Box']")

src/pageobjects/base_page.py

@@ -126,3 +126,7 @@ def get_current_url(self):
     def refresh(self):
         """Refresh the current page."""
         self.driver.refresh()
+
+    def scroll_to_element(self, element):
+        """Sroll to element"""
+        self.driver.execute_script("arguments[0].scrollIntoView();", element)

src/pageobjects/text/fill_form.py

@@ -1,4 +1,4 @@
-from src.locators.locators import TextFields
+from src.locators.locators import TextBoxFields, General
 from src.pageobjects.base_page import BasePage
 from utils.logger import log
 
@@ -7,4 +7,9 @@ class FillForm(BasePage):
     @log()
     def enter_username(self, name: str):
         """Enter username"""
-        self.set(TextFields.USER_NAME, name)
+        self.set(TextBoxFields.USER_NAME, name)
+
+    @log()
+    def enter_password(self, password):
+        """Enter password"""
+        self.set(TextBoxFields.USER_NAME, password)

tests/test_fill_form/test_fill_form.py

@@ -1,8 +1,27 @@
+import time
+
+import pytest
 from src.pageobjects.text.fill_form import FillForm
+from utils.crypto import Secure
+from utils.yaml_reader import YAMLReader
 
 
-class TestFillForm:
+@pytest.fixture
+def get_password():
+    secure = Secure()
+    read = YAMLReader.read("data.yaml", to_simple_namespace=True)
+    password = read.users.john.details.password
+    print(password)
+    return secure.decrypt_password(password)
+
 
-    def test_fill_user(self, make_driver):
+class TestFillForm:
+    def test_fill_user(self, make_driver, get_password):
         fill = FillForm(make_driver)
+
+        # Use the password provided by the fixture
+        password = get_password
+        print(password)
+
         fill.enter_username("selenium framework")
+        fill.enter_password(password)

utils/crypto.py

@@ -0,0 +1,20 @@
+import pathlib
+from typing import Optional, Literal
+
+from core.cipher import Cipher
+
+
+class Secure:
+    def __init__(
+        self,
+        base_path: Optional[pathlib.Path] = None,
+        store_type: Literal["local", "vault"] = "local",
+    ):
+        self.base_path = (
+            base_path or pathlib.Path(__file__).resolve().parent.parent / "config"
+        )
+        self.store_type = store_type
+        self.cipher = Cipher(base_path=self.base_path, vault_type=store_type)
+
+    def decrypt_password(self, password: bytes):
+        return self.cipher.decrypt(password)

utils/error_handler.py

@@ -13,7 +13,7 @@ class ErrorHandler:
         ErrorType.ENV_ERROR: "Unsupported environment",
         ErrorType.EMPTY_URL_ERROR: "Environment variable is empty or not found",
         ErrorType.UNSUPPORTED_DRIVER_TYPE: "Unsupported driver type",
-        ErrorType.DRIVER_NOT_FOUND: "WebDriver binary not found at "
+        ErrorType.DRIVER_NOT_FOUND: "WebDriver binary not found at ",
     }
 
     @staticmethod

utils/helpers.py

@@ -23,6 +23,7 @@ def wrapper(*args, **kwargs):
 
 def timing(func):
     """Perform a timing function"""
+
     @wraps(func)
     def wrapper(*args, **kwargs):
         start_time = time.time()

utils/logger.py

@@ -112,9 +112,7 @@ def wrapper(self, *args, **kwargs) -> Any:
             logger_instance.annotate(logs, level)
 
             # Call the original method, passing *args and **kwargs
-            return func(
-                self, *args, **kwargs
-            )
+            return func(self, *args, **kwargs)
 
         return wrapper