first commit

Author: prashant1507

README.md

@@ -0,0 +1,34 @@
+
+# Setup
+1. Execute `pip3 install -r requirements.tx`
+2. Set up allure-report
+   ``` 
+    Download from https://allurereport.org/docs/install-for-linux/
+    Execute: sudo dpkg -i allure_*_all.deb
+    Execute: allure --version
+   ```
+3. Execute `playwright install`
+4. Setup `resources/details.json` as
+   ```
+      # TO DO
+   ```
+
+# Start Tests
+1. Execute `python3 runner.py`
+
+
+# Helpers
+1. Check all behave options `behave -h`
+2. Check all allure options `allure -h`
+3. Check all playwright options `playwright -h`
+4Execute `allure serve FOLDER_PATH` to start and create allure-report
+
+# Notes:
+1. Test will be executed in parallel feature by feature
+2. Create Gmail Key Password
+   ```
+   1. Goto: https://myaccount.google.com/apppasswords
+   2. Enter App Name
+   3. Copy generated password
+   4. Provide in resources/details.json
+   ```

ToDo.txt

@@ -0,0 +1,3 @@
+Playwright in docker - https://chatgpt.com/c/6711edb3-49b8-8010-9a2e-933316f2542e
+
+Fix allure report for parallel run

behave.ini

@@ -0,0 +1,29 @@
+[behave]
+format = pretty
+ json.pretty
+ rerun
+ allure_behave.formatter:AllureFormatter
+
+outfiles = reports/pretty/pretty.txt
+ reports/json/report.json
+ reports/rerun/rerun.txt
+ reports/allure_json
+
+stderr_capture = True
+stdout_capture = True
+
+log_capture = True
+logging_level = INFO
+logging_format = LOG.%(levelname)-8s  %(asctime)s  %(name)-10s: %(message)s
+
+verbose = True
+;tags = @ss
+paths = tests/features/
+color = True
+dry_run = False
+show_timings = True
+show_skipped = false
+
+# Define the output for JUnit reports (optional)
+;junit = True
+;junit_directory = reports/xml

conf_behavex.cfg

@@ -0,0 +1,2 @@
+[output]
+path = "reports/html"

helpers/__init__.py

@@ -0,0 +1,25 @@
+
+import os.path
+
+
+class FrameworkConstants:
+
+    reports_parent_dir = os.path.abspath("reports")
+    allure_json_dir = os.path.abspath(f"{reports_parent_dir}/allure_json")
+    allure_html_dir = os.path.abspath(f"{reports_parent_dir}/allure_html")
+    html_dir = os.path.abspath(f"{reports_parent_dir}/html")
+    logs_dir = os.path.abspath(f"{reports_parent_dir}/logs")
+    json_dir = os.path.abspath(f"{reports_parent_dir}/json")
+    pretty_dir = os.path.abspath(f"{reports_parent_dir}/pretty")
+    rerun_dir = os.path.abspath(f"{reports_parent_dir}/rerun")
+    screenshots_dir = os.path.abspath(f"{reports_parent_dir}/screenshots")
+    test_trace_dir = os.path.abspath(f"{reports_parent_dir}/test_traces")
+
+    resources = os.path.abspath("resources")
+
+    docker_compose_file = os.path.abspath("resources/docker-compose.yml")
+    details_file = os.path.abspath(f"{resources}/details.json")
+    behave_ini = os.path.abspath("behave.ini")
+    conf_behavex = os.path.abspath("conf_behavex.cfg")
+
+    features = os.path.abspath("tests/features")

helpers/constants/__init__.py

@@ -0,0 +1,7 @@
+behave~=1.2.6
+allure-behave
+behavex
+allure-python-commons~=2.13.5
+Faker
+pycommons-lang
+playwright

helpers/constants/framework_constants.py

@@ -0,0 +1,40 @@
+{
+  "delete_old_reports": true,
+  "start_docker_compose": true,
+  "password_for_sshpass": "password",
+  "headless": false,
+  "allow_tracing": true,
+  "email": {
+    "send_report_on_email": false,
+    "token": "",
+    "sender_email": "",
+    "receiver_email": ""
+  },
+
+  "selenium_host_ip": "127.0.0.1",
+  "browser": "Chrome",
+
+  "url": "https://www.saucedemo.com",
+  "logins": {
+    "standard_user": {
+      "username": "standard_user",
+      "password": "secret_sauce"
+    },
+    "locked_out_user": {
+      "username": "locked_out_user",
+      "password": "secret_sauce"
+    },
+    "performance_glitch_user": {
+      "username": "performance_glitch_user",
+      "password": "secret_sauce"
+    },
+    "error_user": {
+      "username": "error_user",
+      "password": "secret_sauce"
+    },
+    "problem_user": {
+      "username": "problem_user",
+      "password": "secret_sauce"
+    }
+  }
+}

helpers/constants/test_constants.py

@@ -0,0 +1,39 @@
+# To execute this docker compose yml file use `docker compose -f docker-compose-v2.yml up`
+# Add the `-d` flag at the end for detached execution
+# To stop the execution, hit Ctrl+C, and then `docker compose -f docker-compose-v2.yml down`
+version: '2'
+services:
+  chrome:
+    image: selenium/node-chrome:4.25.0-20241010
+    shm_size: 2gb
+    depends_on:
+      - selenium-hub
+    environment:
+      - SE_EVENT_BUS_HOST=selenium-hub
+      - SE_EVENT_BUS_PUBLISH_PORT=4442
+      - SE_EVENT_BUS_SUBSCRIBE_PORT=4443
+      - SE_NODE_MAX_SESSIONS=3
+      - SE_NODE_OVERRIDE_MAX_SESSIONS=true
+    ports:
+      - "6900:5900"
+
+  firefox:
+    image: selenium/node-firefox:4.25.0-20241010
+    shm_size: 2gb
+    depends_on:
+      - selenium-hub
+    environment:
+      - SE_EVENT_BUS_HOST=selenium-hub
+      - SE_EVENT_BUS_PUBLISH_PORT=4442
+      - SE_EVENT_BUS_SUBSCRIBE_PORT=4443
+      - SE_NODE_MAX_SESSIONS=2
+      - SE_NODE_OVERRIDE_MAX_SESSIONS=true
+    ports:
+      - "6902:5900"
+
+  selenium-hub:
+    image: selenium/hub:4.25.0-20241010
+    ports:
+      - "4442:4442"
+      - "4443:4443"
+      - "4444:4444"

helpers/variables/__init__.py

@@ -0,0 +1,42 @@
+from pycommons.lang.stringutils import StringUtils
+from utils.docker_compose_actions import start_docker_compose, stop_docker_compose
+from utils.helper_utils import prepare_dirs, execute_command_using_popen
+from utils.reporting.generate_report import generate_allure_report
+from helpers.constants.framework_constants import FrameworkConstants as Fc
+
+import logging
+
+def logs():
+    logger = logging.getLogger()
+    logger.handlers.clear()
+    logging.basicConfig(
+        level=logging.INFO,
+        format="%(message)s"
+    )
+    return logger
+
+
+
+def main():
+    process = None
+    log = logs()
+    # Read and print the output line by line
+    try:
+        prepare_dirs()
+        # start_docker_compose(log)
+        process = execute_command_using_popen(f"behavex {Fc.features} -c {Fc.conf_behavex} --parallel-processes 2 --parallel-delay 1000 --parallel-scheme feature --show-progress-bar")
+        while True:
+            output = process.stdout.readline()
+            if output == StringUtils.EMPTY and process.poll() is not None:
+                break
+            if output:
+                log.info(output.strip())
+    except KeyboardInterrupt:
+        log.error("Process terminated by user.")
+        process.terminate()
+    finally:
+        generate_allure_report(log)
+        # stop_docker_compose(log)
+
+if __name__ == "__main__":
+    main()

requirements.txt

@@ -0,0 +1,73 @@
+import datetime
+
+from behave.runner import Context
+from behavex_images import image_attachments
+from behavex_images.image_attachments import AttachmentsCondition
+from playwright.sync_api import Page
+
+from helpers.constants.framework_constants import FrameworkConstants as Fc
+from utils.reporting.logger import get_logs
+from utils.reporting.screenshots import attach_screenshot_in_report
+from utils.browser_utils import prepare_browser, test_tracing
+
+
+def before_all(context: Context):
+    current_time = datetime.datetime.now()
+    file_name = current_time.strftime("%d_%m_%y-%H_%M_%S_%f")[:-3]
+    global logger, details
+    logger = get_logs(f"{Fc.logs_dir}/{file_name}.txt")
+    # start_docker_compose(logger)
+    image_attachments.set_attachments_condition(context, AttachmentsCondition.ALWAYS)
+
+
+def before_feature(context: Context, feature):
+    logger.info(f"Feature file: {feature.filename}")
+    logger.info(f"Number of Scenarios: {len(feature.scenarios)}")
+    formatted_tags = " ".join([f"@{tag}" for tag in feature.tags])
+    if formatted_tags:
+        logger.info(f"{formatted_tags}")
+    logger.info(f"Feature: {feature.name}")
+    prepare_browser(context)
+
+def before_scenario(context, scenario):
+    formatted_tags = " ".join([f"@{tag}" for tag in scenario.tags])
+    if formatted_tags:
+        logger.info(f"{formatted_tags}")
+    logger.info(f"Scenario: {scenario.name}")
+
+    if scenario.feature.background:
+        background = scenario.feature.background
+        for step in background.steps:
+            logger.info(f"{step.keyword} {step.name}")
+
+    for step in scenario.steps:
+        logger.info(f"{step.keyword} {step.name}")
+
+
+def after_step(context: Context, step):
+    current_time = datetime.datetime.now()
+    file_name = current_time.strftime("%d_%m_%y-%H_%M_%S_%f")[:-3]
+    page: Page = context.page
+    page.wait_for_load_state()
+    page.screenshot(path=f"{Fc.screenshots_dir}/{file_name}.png")
+    attach_screenshot_in_report(f"{Fc.screenshots_dir}/{file_name}.png")
+    image_attachments.attach_image_file(context, f"{Fc.screenshots_dir}/{file_name}.png")
+
+def after_scenario(context, scenario):
+    logger.info(f"Scenario status: {scenario.status}")
+
+
+def after_feature(context, feature):
+    test_tracing(context, False)
+    try:
+        logger.info(f"Feature Status: {feature.status}")
+    finally:
+        context.page.close()
+        context.browser.close()
+        context.playwright.stop()
+
+# def after_all(context):
+#     try:
+#         generate_allure_report(logger)
+#     finally:
+#         stop_docker_compose(logger)

resources/details.json

@@ -0,0 +1,23 @@
+@Homepage
+Feature: Homepage
+
+  Background:
+    Given User navigates to login page
+
+  Scenario: Verify if user is able to see 'Swag Labs' on login
+    When User enters username as 'problem_user'
+    And User enters password for 'problem_user'
+    And User clicks on 'Login' button
+    Then Homepage is displayed
+
+  Scenario: Verify if user is able to see 'Swag Labs' on login
+    When User enters username as 'problem_user'
+    And User enters password for 'problem_user'
+    And User clicks on 'Login' button
+    Then Homepage is displayed
+
+  Scenario: This is failed test case
+    When User enters username as 'problem_user'
+    And User enters password for 'problem_user'
+    And User clicks on 'Login' button
+    Then Product is displayed

resources/docker-compose.yml

@@ -0,0 +1,24 @@
+@Login
+Feature: Login
+
+  Scenario: Verify if user is able to login with valid user
+    Given User navigates to login page
+    When User enters username as 'standard_user'
+    And User enters password for 'standard_user'
+    And User clicks on 'Login' button
+    Then Homepage is displayed
+    And Labels are present
+      | label_name |
+      | Products   |
+
+  Scenario Outline: Verify if user is able to login with '<username>'
+    Given User navigates to login page
+    When User enters username as '<username>'
+    And User enters password for '<username>'
+    And User clicks on 'Login' button
+    Then Homepage is displayed
+    Examples:
+      | username                |
+      | performance_glitch_user |
+      | error_user              |
+      | locked_out_user         |

resources/drivers/geckodriver

@@ -0,0 +1,19 @@
+
+class BasePage:
+    def __init__(self, page):
+        self.page = page
+
+    def open_page(self, url):
+        self.page.goto(url)
+
+    def send_keys(self, locator, text):
+        self.page.locator(locator).fill(text)
+
+    def click(self, locator):
+        self.page.locator(locator).click()
+
+    def get_title(self):
+        return self.page.title().strip()
+
+    def get_text(self, locator):
+        return self.page.locator(locator).text_content().strip()

runner.py

@@ -0,0 +1,12 @@
+from tests.pages.base_page import BasePage
+
+
+class Homepage:
+
+    products_label = "//span[normalize-space()='Products']"
+
+    def __init__(self, page):
+        self.bp = BasePage(page)
+
+    def get_text_from_page(self):
+        self.bp.get_text(self.products_label)