cucu 1.2.1__tar.gz → 1.2.3__tar.gz

{cucu-1.2.1 → cucu-1.2.3}/CHANGELOG.md

@@ -5,8 +5,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project closely adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.2.3
+- Add - additional tab information steps
+- Change - retry open a browser
+
+## 1.2.2
+- Chore - make lint also run ruff format --check
+- Add - tags command to list tags and affected scenario counts
+- Add - click parent label of an input element when the size of the input element is zero
+
 ## 1.2.1
-- Add - add tab information to html report and cucu debug console log
+- Add - tab information to html report and cucu debug console log
 
 ## 1.2.0
 - Add - levels 2-4 to section step

{cucu-1.2.1 → cucu-1.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cucu
-Version: 1.2.1
+Version: 1.2.3
 Summary: Easy BDD web testing
 Project-URL: Homepage, https://github.com/dominodatalab/cucu/wiki
 Project-URL: Download, https://pypi.org/project/cucu/

{cucu-1.2.1 → cucu-1.2.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cucu"
-version = "1.2.1"
+version = "1.2.3"
 description = "Easy BDD web testing"
 readme = "README.md"
 license = { text = "The Clear BSD License" }

{cucu-1.2.1 → cucu-1.2.3}/src/cucu/browser/core.py

@@ -55,6 +55,18 @@ class Browser:
     def close_window(self):
         raise RuntimeError("implement me")
 
+    def get_tab_info(self):
+        raise RuntimeError("implement me")
+
+    def get_all_tabs_info(self):
+        raise RuntimeError("implement me")
+
+    def switch_to_nth_tab(self, tab_index):
+        raise RuntimeError("implement me")
+
+    def switch_to_tab_that_matches_regex(self, text):
+        raise RuntimeError("implement me")
+
     def quit(self):
         raise RuntimeError("implement me")
 
@@ -76,5 +88,5 @@ class Browser:
                 start = time.time()
                 hook(self)
                 logger.debug(
-                    f'executed page check "{name}" in {round(time.time()-start, 3)}s'
+                    f'executed page check "{name}" in {round(time.time() - start, 3)}s'
                 )

{cucu-1.2.1 → cucu-1.2.3}/src/cucu/browser/selenium.py

@@ -1,5 +1,6 @@
 import logging
 import os
+import re
 
 import chromedriver_autoinstaller
 import geckodriver_autoinstaller
@@ -226,6 +227,51 @@ class Selenium(Browser):
             raise RuntimeError("no previous browser tab available")
         self.driver.switch_to.window(window_handles[window_handle_index - 1])
 
+    def switch_to_nth_tab(self, tab_number):
+        print(f"tab_number, {tab_number}")
+        window_handles = self.driver.window_handles
+        total_tabs = len(window_handles)
+        if tab_number > total_tabs:
+            raise RuntimeError(f"no {tab_number} browser tab available")
+        self.driver.switch_to.window(window_handles[tab_number])
+
+    def switch_to_tab_that_matches_regex(self, title_pattern):
+        window_handles = self.driver.window_handles
+
+        for handle in window_handles:
+            self.driver.switch_to.window(handle)
+            if re.search(title_pattern, self.driver.title):
+                return
+
+        raise Exception(f"No tab title matches pattern: {title_pattern}")
+
+    def get_tab_info(self):
+        window_handles = self.driver.window_handles
+        current_window = self.driver.current_window_handle
+        window_handle_index = window_handles.index(current_window)
+
+        return {
+            "tab_count": len(window_handles),
+            "index": window_handle_index,
+            "title": self.driver.title,
+            "url": self.driver.current_url,
+        }
+
+    def get_all_tabs_info(self):
+        tabs_info = []
+        handles = self.driver.window_handles
+        for idx, handle in enumerate(handles):
+            self.driver.switch_to.window(handle)
+            tabs_info.append(
+                {
+                    "index": idx,
+                    "title": self.driver.title,
+                    "url": self.driver.current_url,
+                }
+            )
+
+        return tabs_info
+
     def back(self):
         self.driver.back()
         self.wait_for_page_to_load()

{cucu-1.2.1 → cucu-1.2.3}/src/cucu/cli/core.py

@@ -7,6 +7,7 @@ import signal
 import sys
 import time
 import xml.etree.ElementTree as ET
+from collections import Counter
 from importlib.metadata import version
 from pathlib import Path
 from threading import Timer
@@ -14,6 +15,8 @@ from threading import Timer
 import click
 import coverage
 import psutil
+from behave.model_core import FileLocation
+from behave.runner_util import parse_features
 from click import ClickException
 from mpire import WorkerPool
 from tabulate import tabulate
@@ -851,5 +854,56 @@ def debug(browser, url, detach, logging_level):
             time.sleep(5)
 
 
+@main.command()
+@click.option(
+    "-l",
+    "--logging-level",
+    default="INFO",
+    help="set logging level to one of debug, warn or info (default)",
+)
+@click.argument(
+    "filepath", default="features", type=click.Path(path_type=Path)
+)
+def tags(filepath, logging_level):
+    """
+    print a table of tags and affected scenario counts
+    """
+    init_global_hook_variables()
+    os.environ["CUCU_LOGGING_LEVEL"] = logging_level.upper()
+    logger.init_logging(logging_level.upper())
+
+    if filepath.is_file():
+        feature_files = [filepath]
+    else:
+        feature_files = list(filepath.rglob("*.feature"))
+
+    if not filepath.exists() or not feature_files:
+        raise ClickException("No feature files found.")
+
+    file_locations = [
+        FileLocation(os.path.abspath(str(f))) for f in feature_files
+    ]
+    features = parse_features(file_locations)
+    tag_scenarios = Counter()
+
+    for feature in features:
+        for scenario in feature.scenarios:
+            affecting_tags = set(feature.tags + scenario.tags)
+            tag_scenarios.update(affecting_tags)
+
+    if not tag_scenarios:
+        print("No tags found in feature files.")
+        return
+
+    table_data = [["Tag", "Scenarios Affected"]] + [
+        [tag_name, str(count)]
+        for tag_name, count in sorted(
+            tag_scenarios.items(), key=lambda x: x[0].lower()
+        )
+    ]
+
+    print(tabulate(table_data, headers="firstrow", tablefmt="fancy_grid"))
+
+
 if __name__ == "__main__":
     main()

{cucu-1.2.1 → cucu-1.2.3}/src/cucu/environment.py

@@ -10,7 +10,7 @@ from functools import partial
 from cucu import config, init_scenario_hook_variables, logger
 from cucu.config import CONFIG
 from cucu.page_checks import init_page_checks
-from cucu.utils import ellipsize_filename, get_tab_information, take_screenshot
+from cucu.utils import ellipsize_filename, take_screenshot
 
 CONFIG.define(
     "FEATURE_RESULTS_DIR",
@@ -264,11 +264,11 @@ def after_step(ctx, step):
     if ctx.browser is not None and ctx.current_step.has_substeps is False:
         take_screenshot(ctx, step.name, label=f"After {step.name}")
 
-        tab_info = get_tab_information(ctx)
-        total_tabs = tab_info["window_count"]
-        current_tab = tab_info["current_index"] + 1
-        title = tab_info["current_title"]
-        url = tab_info["current_url"]
+        tab_info = ctx.browser.get_tab_info()
+        total_tabs = tab_info["tab_count"]
+        current_tab = tab_info["index"] + 1
+        title = tab_info["title"]
+        url = tab_info["url"]
         log_message = (
             f"\ntab({current_tab} of {total_tabs}): {title}\nurl: {url}\n"
         )

{cucu-1.2.1 → cucu-1.2.3}/src/cucu/formatter/cucu.py

@@ -66,7 +66,7 @@ class CucuFormatter(Formatter):
     # -- IMPLEMENT-INTERFACE FOR: Formatter
     def feature(self, feature):
         self.write_tags(feature.tags, for_feature=True)
-        text = f'{self.colorize(feature.keyword, "magenta")}: {feature.name}\n'
+        text = f"{self.colorize(feature.keyword, 'magenta')}: {feature.name}\n"
         self.stream.write(text)
 
     def colorize(self, text, color):
@@ -193,7 +193,7 @@ class CucuFormatter(Formatter):
             status_text_padding = (
                 max_line_length - len(current_step_text) - len(prefix)
             )
-            status_text = f'{" " * status_text_padding}{status_text}'
+            status_text = f"{' ' * status_text_padding}{status_text}"
             status_text = self.colorize(status_text, "yellow")
 
             self.stream.write(f"{status_text}\n")
@@ -227,7 +227,7 @@ class CucuFormatter(Formatter):
                     ]
                 )
 
-                padding = f"    {' '*(len('Given')-len(step.keyword))}"
+                padding = f"    {' ' * (len('Given') - len(step.keyword))}"
                 variable_line = f"{padding}# {expanded}\n"
                 # hide secrets before we do anything to add color which could
                 # modify the output and result in not being able to correctly

{cucu-1.2.1 → cucu-1.2.3}/src/cucu/formatter/json.py

@@ -176,7 +176,7 @@ class CucuJSONFormatter(Formatter):
                         for (key, value) in step_variables.items()
                     ]
                 )
-                padding = f"    {' '*(len('Given')-len(step.keyword))}"
+                padding = f"    {' ' * (len('Given') - len(step.keyword))}"
                 step.stdout.insert(
                     0, f"{padding}# {CONFIG.hide_secrets(expanded)}\n"
                 )

{cucu-1.2.1 → cucu-1.2.3}/src/cucu/reporter/html.py

@@ -171,7 +171,7 @@ def generate(results, basepath, only_failures=False):
                     sub_headers.append(handler(scenario))
                 except Exception:
                     logger.warning(
-                        f"Exception while trying to run sub_headers hook for scenario: \"{scenario['name']}\"\n{traceback.format_exc()}"
+                        f'Exception while trying to run sub_headers hook for scenario: "{scenario["name"]}"\n{traceback.format_exc()}'
                     )
             scenario["sub_headers"] = "<br/>".join(sub_headers)
 
@@ -204,7 +204,7 @@ def generate(results, basepath, only_failures=False):
                     # Map the count to the appropriate HTML heading (h2-h5)
                     # We use h2-h5 instead of h1-h4 so h1 can be reserved for scenario/feature titles
                     step["heading_level"] = (
-                        f"h{step["name"][:4].count("#") + 1}"
+                        f"h{step['name'][:4].count('#') + 1}"
                     )
 
                 if os.path.exists(image_dirpath):
@@ -422,7 +422,7 @@ def generate(results, basepath, only_failures=False):
         )
 
         feature_output_filepath = os.path.join(
-            basepath, f'{feature["name"]}.html'
+            basepath, f"{feature['name']}.html"
         )
 
         with open(feature_output_filepath, "wb") as output:

{cucu-1.2.1 → cucu-1.2.3}/src/cucu/steps/browser_steps.py

@@ -32,7 +32,7 @@ def open_a_browser(ctx, url):
         Given I open a browser at the url "https://www.google.com"
     """
     if ctx.browser is None:
-        ctx.browser = open_browser(ctx)
+        ctx.browser = retry(open_browser)(ctx)
         ctx.browsers.append(ctx.browser)
     else:
         logger.debug("browser already open so using existing instance")
@@ -43,7 +43,7 @@ def open_a_browser(ctx, url):
 
 @step('I open a new browser at the url "{url}"')
 def open_a_new_browser(ctx, url):
-    ctx.browser = open_browser(ctx)
+    ctx.browser = retry(open_browser)(ctx)
     ctx.browsers.append(ctx.browser)
     logger.debug(f"navigating to url #{url}")
     ctx.browser.navigate(url)
@@ -219,6 +219,68 @@ def wait_to_switch_to_previous_browser_tab(ctx):
     retry(switch_to_previous_tab)(ctx)
 
 
+def switch_to_nth_tab(ctx, tab_number):
+    ctx.check_browser_initialized()
+    ctx.browser.switch_to_nth_tab(tab_number)
+
+
+@step('I switch to the "{nth:nth}" browser tab')
+def switch_to_nth_browser_tab(ctx, nth):
+    switch_to_nth_tab(ctx, nth)
+
+
+@step('I wait to switch to the "{nth:nth}" browser tab')
+def wait_to_switch_to_nth_browser_tab(ctx, nth):
+    retry(switch_to_nth_tab)(ctx, nth)
+
+
+def switch_to_tab_matching_regex(ctx, regex):
+    ctx.check_browser_initialized()
+    ctx.browser.switch_to_tab_that_matches_regex(regex)
+
+
+@step('I switch to the browser tab that matches "{regex}"')
+def switch_to_browser_tab_matching_regex(ctx, regex):
+    switch_to_tab_matching_regex(ctx, regex)
+
+
+@step('I wait to switch to the browser tab that matches "{regex}"')
+def wait_to_switch_to_browser_tab_matching_regex(ctx, regex):
+    retry(switch_to_tab_matching_regex)(ctx, regex)
+
+
+@step('I save the browser tabs info to the variable "{variable}"')
+def save_browser_tabs_info_to_variable(ctx, variable):
+    ctx.check_browser_initialized()
+    tabs_info = ctx.browser.get_all_tabs_info()
+    lst_tab_info = [
+        f"tab({tab['index'] + 1}): {tab['title']}, url: {tab['url']}"
+        for tab in tabs_info
+    ]
+    config.CONFIG[variable] = lst_tab_info
+
+
+@step("I list the current browser tab info")
+def list_current_browser_tab_info(ctx):
+    ctx.check_browser_initialized()
+    tab_info = ctx.browser.get_tab_info()
+    current_tab = tab_info["index"] + 1
+    title = tab_info["title"]
+    url = tab_info["url"]
+    print(f"\ntab({current_tab}): {title}\nurl: {url}\n")
+
+
+@step("I list all browser tabs info")
+def list_browser_tabs_info(ctx):
+    ctx.check_browser_initialized()
+    all_tabs_info = ctx.browser.get_all_tabs_info()
+    for tab in all_tabs_info:
+        tab_index = tab["index"] + 1
+        title = tab["title"]
+        url = tab["url"]
+        print(f"\ntab({tab_index}): {title}\nurl: {url}\n")
+
+
 def save_downloaded_file(ctx, filename):
     ctx.check_browser_initialized()
 

{cucu-1.2.1 → cucu-1.2.3}/src/cucu/steps/button_steps.py

@@ -1,5 +1,9 @@
 from cucu import fuzzy, helpers
-from cucu.utils import take_saw_element_screenshot
+from cucu.utils import (
+    find_n_click_input_parent_label,
+    is_element_size_zero,
+    take_saw_element_screenshot,
+)
 
 from . import base_steps
 
@@ -67,6 +71,10 @@ def click_button(ctx, button):
     if base_steps.is_disabled(button):
         raise RuntimeError("unable to click the button, as it is disabled")
 
+    if is_element_size_zero(button):
+        find_n_click_input_parent_label(ctx, button)
+        return
+
     ctx.browser.click(button)
 
 

{cucu-1.2.1 → cucu-1.2.3}/src/cucu/steps/checkbox_steps.py

@@ -1,5 +1,9 @@
 from cucu import fuzzy, helpers
-from cucu.utils import take_saw_element_screenshot
+from cucu.utils import (
+    find_n_click_input_parent_label,
+    is_element_size_zero,
+    take_saw_element_screenshot,
+)
 
 from . import base_steps
 
@@ -66,6 +70,10 @@ def check_checkbox(ctx, checkbox):
     if base_steps.is_disabled(checkbox):
         raise RuntimeError("unable to check the checkbox, as it is disabled")
 
+    if is_element_size_zero(checkbox):
+        find_n_click_input_parent_label(ctx, checkbox)
+        return
+
     ctx.browser.click(checkbox)
 
 
@@ -78,6 +86,10 @@ def uncheck_checkbox(ctx, checkbox):
     if is_not_checked(checkbox):
         raise Exception("checkbox already unchecked")
 
+    if is_element_size_zero(checkbox):
+        find_n_click_input_parent_label(ctx, checkbox)
+        return
+
     ctx.browser.click(checkbox)
 
 

{cucu-1.2.1 → cucu-1.2.3}/src/cucu/steps/radio_steps.py

@@ -1,6 +1,10 @@
 from cucu import fuzzy, helpers, retry, step
 from cucu.config import CONFIG
-from cucu.utils import take_saw_element_screenshot
+from cucu.utils import (
+    find_n_click_input_parent_label,
+    is_element_size_zero,
+    take_saw_element_screenshot,
+)
 
 from . import base_steps
 
@@ -90,6 +94,10 @@ def find_n_select_radio_button(ctx, name, index=0, ignore_if_selected=False):
 
         raise Exception(f'radio button "{name}" already selected')
 
+    if is_element_size_zero(radio):
+        find_n_click_input_parent_label(ctx, radio)
+        return
+
     ctx.browser.click(radio)
 
 
@@ -123,6 +131,10 @@ def select_radio_button(ctx, radiobox):
     if selected:
         raise Exception("radiobox already selected")
 
+    if is_element_size_zero(radiobox):
+        find_n_click_input_parent_label(ctx, radiobox)
+        return
+
     ctx.browser.click(radiobox)
 
 

{cucu-1.2.1 → cucu-1.2.3}/src/cucu/steps/table_steps.py

@@ -306,7 +306,7 @@ def get_table_cell_value(ctx, table, row, column, variable_name):
         cell_value = tables[table][row][column]
     except IndexError:
         raise RuntimeError(
-            f"Cannot find table:{table+1},row:{row+1},column:{column+1}. Please check your table data."
+            f"Cannot find table:{table + 1},row:{row + 1},column:{column + 1}. Please check your table data."
         )
     config.CONFIG[variable_name] = cell_value
 
@@ -343,7 +343,7 @@ def find_table_element(ctx, nth=1):
         return ctx.browser.css_find_elements("table")[nth]
     except IndexError:
         raise RuntimeError(
-            f"Cannot find table:{nth+1}. Please check your table data."
+            f"Cannot find table:{nth + 1}. Please check your table data."
         )
 
 
@@ -364,7 +364,7 @@ def click_table_cell(ctx, row, column, table):
         cell = row.find_elements(By.CSS_SELECTOR, "td")[column]
     except IndexError:
         raise RuntimeError(
-            f"Cannot find table:{table+1},row:{row+1},column:{column+1}. Please check your table data."
+            f"Cannot find table:{table + 1},row:{row + 1},column:{column + 1}. Please check your table data."
         )
     ctx.browser.click(cell)
 
@@ -409,7 +409,7 @@ def wait_click_table_cell_matching_text(ctx, column, match_text, table):
             cell = row[0].find_elements(By.CSS_SELECTOR, "td")[column]
         except IndexError:
             raise RuntimeError(
-                f"Cannot find table:{table+1},column:{column+1},text:{match_text}. Please check your table data."
+                f"Cannot find table:{table + 1},column:{column + 1},text:{match_text}. Please check your table data."
             )
 
         ctx.browser.click(cell)
@@ -431,7 +431,7 @@ def wait_table_row_count(ctx, row_count, table):
             return
         else:
             raise RuntimeError(
-                f"Unable to find {row_count} rows in table {table+1}. Please check your table data."
+                f"Unable to find {row_count} rows in table {table + 1}. Please check your table data."
             )
 
     retry(find_table_row_count)(ctx, row_count, table)

{cucu-1.2.1 → cucu-1.2.3}/src/cucu/utils.py

@@ -9,6 +9,7 @@ import pkgutil
 import shutil
 
 import humanize
+from selenium.webdriver.common.by import By
 from tabulate import DataRow, TableFormat, tabulate
 from tenacity import (
     after_log,
@@ -273,14 +274,26 @@ def take_screenshot(ctx, step_name, label="", element=None):
     CONFIG["__STEP_SCREENSHOT_COUNT"] += 1
 
 
-def get_tab_information(ctx):
-    driver = ctx.browser.driver
-    window_handles = driver.window_handles
-    current_window = driver.current_window_handle
-    window_handle_index = window_handles.index(current_window)
-    return {
-        "window_count": len(window_handles),
-        "current_index": window_handle_index,
-        "current_title": driver.title,
-        "current_url": driver.current_url,
-    }
+def find_n_click_input_parent_label(ctx, input_element):
+    """
+    Clicks the nearest parent <label> of an input elemnt (if input is visually hidden or size is zero).
+    """
+    try:
+        # Find the closest ancestor <label> element
+        label = input_element.find_element(By.XPATH, "ancestor::label[1]")
+
+        if label and label.is_displayed():
+            ctx.browser.click(label)
+            logger.debug("Successfully clicked the parent label.")
+        else:
+            logger.warning("Parent label is not displayed or not found.")
+
+    except Exception as e:
+        logger.error(
+            f"Click on parent label failed (possibly missing label ancestor): {e}"
+        )
+
+
+def is_element_size_zero(element):
+    size = element.size
+    return size["width"] == 0 and size["height"] == 0