cucu 1.3.12__tar.gz → 1.3.21__tar.gz

{cucu-1.3.12 → cucu-1.3.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: cucu
-Version: 1.3.12
+Version: 1.3.21
 Summary: Easy BDD web testing
 Keywords: cucumber,selenium,behave
 Author: Domino Data Lab, Rodney Gomes, Cedric Young, Xin Dong, Kavya Yakkati, Kevin Garton, Joy Liao
@@ -23,11 +23,11 @@ Requires-Dist: humanize~=4.13.0
 Requires-Dist: importlib-metadata~=8.7.0
 Requires-Dist: jellyfish>=1.1
 Requires-Dist: jinja2~=3.1.3
-Requires-Dist: lsprotocol~=2023.0.1
+Requires-Dist: lsprotocol>=2025.0.0
 Requires-Dist: mpire~=2.10.2
 Requires-Dist: peewee>=3.18.2
 Requires-Dist: psutil>=6.0
-Requires-Dist: pygls~=1.3.1
+Requires-Dist: pygls>=2.0.0
 Requires-Dist: pyyaml~=6.0.1
 Requires-Dist: requests>=2.31.0,<3.0.0
 Requires-Dist: selenium~=4.31

{cucu-1.3.12 → cucu-1.3.21}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cucu"
-version = "1.3.12"
+version = "1.3.21"
 description = "Easy BDD web testing"
 readme = "README.md"
 license = { text = "The Clear BSD License" }
@@ -45,11 +45,11 @@ dependencies = [
     "importlib-metadata~=8.7.0",
     "jellyfish>=1.1",
     "jinja2~=3.1.3",
-    "lsprotocol~=2023.0.1",
+    "lsprotocol>=2025.0.0",
     "mpire~=2.10.2",
     "peewee>=3.18.2",
     "psutil>=6.0",
-    "pygls~=1.3.1",
+    "pygls>=2.0.0",
     "pyyaml~=6.0.1",
     "requests>=2.31.0,<3.0.0",
     "selenium~=4.31",

{cucu-1.3.12 → cucu-1.3.21}/src/cucu/browser/core.py

@@ -67,6 +67,9 @@ class Browser:
     def switch_to_tab_that_matches_regex(self, text):
         raise RuntimeError("implement me")
 
+    def get_session_id(self):
+        raise RuntimeError("implement me")
+
     def quit(self):
         raise RuntimeError("implement me")
 

{cucu-1.3.12 → cucu-1.3.21}/src/cucu/browser/selenium.py

@@ -195,6 +195,13 @@ class Selenium(Browser):
             raise Exception(f"unknown browser {browser}")
 
         self.driver.set_window_size(width, height)
+        session_id = self.get_session_id()
+        logger.debug(f"cucu started Selenium session with ID: {session_id}")
+
+    def get_session_id(self):
+        if self.driver:
+            return getattr(self.driver, "session_id", None)
+        return None
 
     def get_log(self):
         if config.CONFIG["CUCU_BROWSER"] == "firefox":

{cucu-1.3.12 → cucu-1.3.21}/src/cucu/cli/core.py

@@ -1,9 +1,8 @@
 # -*- coding: utf-8 -*-
-import glob
-import json
 import os
 import shutil
 import signal
+import sqlite3
 import sys
 import time
 import xml.etree.ElementTree as ET
@@ -54,7 +53,9 @@ def main():
 
 
 @main.command()
-@click.argument("filepath")
+@click.argument(
+    "filepath", default="features", type=click.Path(path_type=Path)
+)
 @click.option(
     "-b",
     "--browser",
@@ -110,6 +111,7 @@ def main():
     default=None,
     help="specify the output directory for JUnit XML files, default is "
     "the same location as --results",
+    type=click.Path(path_type=Path),
 )
 @click.option(
     "--junit-with-stacktrace",
@@ -150,18 +152,14 @@ def main():
     "--report",
     default="report",
     help="the location to put the test report when --generate-report is used",
-)
-@click.option(
-    "--report-only-failures",
-    default=False,
-    is_flag=True,
-    help="when set the HTML test report will only contain the failed test results",
+    type=click.Path(path_type=Path),
 )
 @click.option(
     "-r",
     "--results",
     default="results",
     help="the results directory used by cucu",
+    type=click.Path(path_type=Path),
 )
 @click.option(
     "--runtime-timeout",
@@ -224,7 +222,6 @@ def run(
     preserve_results,
     record_env_vars,
     report,
-    report_only_failures,
     results,
     runtime_timeout,
     feature_timeout,
@@ -247,7 +244,7 @@ def run(
         # when cucu is already running it means that we're running inside
         # another cucu process and therefore we should make sure the results
         # directory isn't the default one and throw an exception otherwise
-        if results == "results":
+        if results == Path("results"):
             raise Exception(
                 "running within cucu but --results was not used, "
                 "this would lead to some very difficult to debug "
@@ -263,10 +260,10 @@ def run(
     logger.init_logging(logging_level.upper())
 
     if not preserve_results:
-        if os.path.exists(results):
+        if results.exists():
             shutil.rmtree(results)
 
-    os.makedirs(results, exist_ok=True)
+    results.mkdir(parents=True, exist_ok=True)
 
     if selenium_remote_url is not None:
         os.environ["CUCU_SELENIUM_REMOTE_URL"] = selenium_remote_url
@@ -287,9 +284,6 @@ def run(
     if junit_with_stacktrace:
         os.environ["CUCU_JUNIT_WITH_STACKTRACE"] = "true"
 
-    if report_only_failures:
-        os.environ["CUCU_REPORT_ONLY_FAILURES"] = "true"
-
     if record_env_vars:
         os.environ["CUCU_RECORD_ENV_VARS"] = "true"
 
@@ -302,12 +296,15 @@ def run(
         generate_short_id(worker_id_seed)
     )
 
-    os.environ["CUCU_FILEPATH"] = CONFIG["CUCU_FILEPATH"] = filepath
+    os.environ["CUCU_FILEPATH"] = CONFIG["CUCU_FILEPATH"] = str(filepath)
 
     create_run(results, filepath)
 
     try:
         if workers is None or workers == 1:
+            logger.debug(
+                f"Starting cucu_run {CONFIG['CUCU_RUN_ID']} with single worker"
+            )
             if runtime_timeout:
                 logger.debug("setting up runtime timeout timer")
 
@@ -347,9 +344,11 @@ def run(
                 raise ClickException("test run failed, see above for details")
 
         else:
-            if os.path.isdir(filepath):
-                basepath = os.path.join(filepath, "**/*.feature")
-                feature_filepaths = list(glob.iglob(basepath, recursive=True))
+            logger.debug(
+                f"Starting cucu_run {CONFIG['CUCU_RUN_ID']} with multiple workers: {workers}"
+            )
+            if filepath.is_dir():
+                feature_filepaths = list(filepath.rglob("*.feature"))
             else:
                 feature_filepaths = [filepath]
 
@@ -486,8 +485,10 @@ def run(
                 task_failed.update(async_results)
 
                 if task_failed:
-                    failing_features = "\n".join(task_failed.keys())
-                    logger.error(f"Failing Features:\n{failing_features}")
+                    failing_features = [str(x) for x in task_failed.keys()]
+                    logger.error(
+                        f"Failing Features:\n{'\n'.join(failing_features)}"
+                    )
                     raise RuntimeError(
                         "there are failures, see above for details"
                     )
@@ -495,65 +496,54 @@ def run(
         if dumper is not None:
             dumper.stop()
 
-        if os.path.exists(results):
+        if results.exists():
             finish_worker_record(worker_run_id=CONFIG.get("WORKER_PARENT_ID"))
             consolidate_database_files(results)
 
         if generate_report:
             _generate_report(
-                results,
-                report,
-                only_failures=report_only_failures,
-                junit=junit,
+                results_dir=results,
+                report_folder=report,
+                junit_folder=junit,
             )
 
 
 def _generate_report(
-    results_dir: str,
-    output: str,
-    only_failures: False,
-    junit: str | None = None,
+    results_dir: Path,
+    report_folder: Path,
+    junit_folder: Path | None = None,
+    combine: bool = False,
 ):
-    if os.path.exists(output):
-        shutil.rmtree(output)
+    if report_folder.exists():
+        shutil.rmtree(report_folder)
 
-    os.makedirs(output)
+    report_folder.mkdir(parents=True, exist_ok=True)
 
-    if os.path.exists(results_dir):
-        consolidate_database_files(results_dir)
+    if results_dir.exists():
+        consolidate_database_files(results_dir, combine)
 
-    report_location = reporter.generate(
-        results_dir, output, only_failures=only_failures
-    )
+    report_location = reporter.generate(results_dir, report_folder)
     print(f"HTML test report at {report_location}")
 
-    if junit:
-        _add_report_path_in_junit(junit, output)
-
-
-def _add_report_path_in_junit(junit_folder, report_folder):
-    for junit_file in glob.glob(f"{junit_folder}/*.xml", recursive=True):
-        junit = ET.parse(junit_file)
-        test_suite = junit.getroot()
-        ts_folder = test_suite.get("foldername")
-        for test_case in test_suite.iter("testcase"):
-            report_path = os.path.join(
-                report_folder,
-                ts_folder,
-                test_case.get("foldername"),
-                "index.html",
-            )
-            test_case.set("report_path", report_path)
-        junit.write(junit_file, encoding="utf-8", xml_declaration=False)
+    if junit_folder:
+        for junit_file in junit_folder.rglob("*.xml"):
+            junit = ET.parse(junit_file)
+            test_suite = junit.getroot()
+            ts_folder = test_suite.get("foldername")
+            for test_case in test_suite.iter("testcase"):
+                report_path = os.path.join(
+                    report_folder,
+                    ts_folder,
+                    test_case.get("foldername"),
+                    "index.html",
+                )
+                test_case.set("report_path", report_path)
+            junit.write(junit_file, encoding="utf-8", xml_declaration=False)
 
 
 @main.command()
-@click.argument("results_dir", default="results")
-@click.option(
-    "--only-failures",
-    default=False,
-    is_flag=True,
-    help="when set the HTML test report will only contain the failed test results",
+@click.argument(
+    "results_dir", default="results", type=click.Path(path_type=Path)
 )
 @click.option(
     "-l",
@@ -567,21 +557,33 @@ def _add_report_path_in_junit(junit_folder, report_folder):
     is_flag=True,
     help="when set skips are shown",
 )
-@click.option("-o", "--output", default="report")
+@click.option(
+    "-o",
+    "--output",
+    default="report",
+    type=click.Path(path_type=Path),
+)
 @click.option(
     "-j",
     "--junit",
     default=None,
     help="specify the output directory for JUnit XML files, default is "
     "the same location as --results",
+    type=click.Path(path_type=Path),
+)
+@click.option(
+    "--combine",
+    default=False,
+    is_flag=True,
+    help="combine multiple cucu_runs into a single report",
 )
 def report(
-    results_dir,
-    only_failures,
+    results_dir: Path,
     logging_level,
     show_skips,
-    output,
-    junit,
+    output: Path,
+    junit: Path,
+    combine: bool,
 ):
     """
     generate a test report from a results directory
@@ -594,26 +596,32 @@ def report(
     if show_skips:
         os.environ["CUCU_SHOW_SKIPS"] = "true"
 
-    run_details_filepath = os.path.join(results_dir, "run_details.json")
-
-    if os.path.exists(run_details_filepath):
-        # load the run details at the time of execution for the provided results
-        # directory
-        run_details = {}
-
-        with open(run_details_filepath, encoding="utf8") as _input:
-            run_details = json.loads(_input.read())
-
-        # initialize any underlying custom step code things
-        behave_init(run_details["filepath"])
+    run_db_path = results_dir / "run.db"
+    if run_db_path.exists():
+        # query cucu_run to get the original filepath used during the run
+        with sqlite3.connect(run_db_path) as conn:
+            cursor = conn.cursor()
+            cursor.execute(
+                "SELECT filepath FROM cucu_run ORDER BY start_at DESC LIMIT 1"
+            )
+            row = cursor.fetchone()
+            if row:
+                filepath = row[0]
+                # initialize any underlying custom step code things
+                behave_init(filepath)
 
     _generate_report(
-        results_dir, output, only_failures=only_failures, junit=junit
+        results_dir=results_dir,
+        report_folder=output,
+        junit_folder=junit,
+        combine=combine,
     )
 
 
 @main.command()
-@click.argument("filepath", default="features")
+@click.argument(
+    "filepath", default="features", type=click.Path(path_type=Path)
+)
 @click.option(
     "-f",
     "--format",
@@ -639,7 +647,7 @@ def steps(filepath, format):
 
 
 @main.command()
-@click.argument("filepath", nargs=-1)
+@click.argument("filepath", type=click.Path(path_type=Path), nargs=-1)
 @click.option(
     "--fix/--no-fix", default=False, help="fix lint violations, default: False"
 )
@@ -741,7 +749,9 @@ def lsp(logging_level, port):
 
 
 @main.command()
-@click.argument("filepath", default="features")
+@click.argument(
+    "filepath", default="features", type=click.Path(path_type=Path)
+)
 def vars(filepath):
     """
     print built-in cucu variables
@@ -766,14 +776,14 @@ def vars(filepath):
 
 
 @main.command()
-@click.argument("filepath", default="")
+@click.argument("repo_dir", default="", type=click.Path(path_type=Path))
 @click.option(
     "-l",
     "--logging-level",
     default="INFO",
     help="set logging level to one of debug, warn or info (default)",
 )
-def init(filepath, logging_level):
+def init(repo_dir, logging_level):
     """
     initialize cucu in the current directory
 
@@ -785,10 +795,9 @@ def init(filepath, logging_level):
     init_data_dir = Path(__file__).parent.parent / "init_data"
 
     logger.debug(f"cucu init: copy example directory from {init_data_dir=}")
-    repo_dir = filepath if filepath.strip() else os.path.join(os.getcwd())
 
-    features_dir = os.path.join(repo_dir, "features")
-    if os.path.exists(features_dir):
+    features_dir = repo_dir / "features"
+    if features_dir.exists():
         answer = input("Overwrite existing files? [y/N]:")
         if answer.lower() != "y":
             print("Aborted!")
@@ -874,9 +883,7 @@ def tags(filepath, logging_level):
     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
-    ]
+    file_locations = [FileLocation(f.absolute()) for f in feature_files]
     features = parse_features(file_locations)
     tag_scenarios = Counter()
 

{cucu-1.3.12 → cucu-1.3.21}/src/cucu/cli/run.py

@@ -85,8 +85,8 @@ def behave(
     if debug_on_failure:
         os.environ["CUCU_DEBUG_ON_FAILURE"] = "true"
 
-    os.environ["CUCU_RESULTS_DIR"] = results
-    os.environ["CUCU_JUNIT_DIR"] = junit
+    os.environ["CUCU_RESULTS_DIR"] = str(results)
+    os.environ["CUCU_JUNIT_DIR"] = str(junit)
 
     if secrets:
         os.environ["CUCU_SECRETS"] = secrets
@@ -123,7 +123,7 @@ def behave(
             "--no-logcapture",
             # generate a JSON file containing the exact details of the whole run
             "--format=cucu.formatter.json:CucuJSONFormatter",
-            f"--outfile={Path(results) / run_json_filename}",
+            f"--outfile={results / run_json_filename}",
             # console formatter
             "--format=cucu.formatter.cucu:CucuFormatter",
             f"--logging-level={os.environ['CUCU_LOGGING_LEVEL'].upper()}",
@@ -154,7 +154,7 @@ def behave(
         if redirect_output:
             feature_name = get_feature_name(filepath)
             log_filename = f"{feature_name}.log"
-            log_filepath = Path(results) / log_filename
+            log_filepath = results / log_filename
 
             CONFIG["__CUCU_PARENT_STDOUT"] = sys.stdout
 
@@ -185,8 +185,7 @@ def behave(
     return result
 
 
-def create_run(results, filepath):
-    results_path = Path(results)
+def create_run(results_path: Path, filepath: Path):
     run_json_filepath = results_path / "run_details.json"
 
     if run_json_filepath.exists():
@@ -200,7 +199,7 @@ def create_run(results, filepath):
 
     run_details = {
         "cucu_run_id": CONFIG["CUCU_RUN_ID"],
-        "filepath": filepath,
+        "filepath": str(filepath),
         "full_arguments": sys.argv,
         "env": env_values,
         "date": datetime.now().isoformat(),

{cucu-1.3.12 → cucu-1.3.21}/src/cucu/cli/steps.py

@@ -131,7 +131,7 @@ def print_human_readable_steps(filepath=None):
 
     for step_name in steps:
         if steps[step_name] is not None:
-            if filepath in steps[step_name]["location"]["filepath"]:
+            if str(filepath) in steps[step_name]["location"]["filepath"]:
                 print(f"custom: {step_name}")
             else:
                 print(f"cucu:   {step_name}")

{cucu-1.3.12 → cucu-1.3.21}/src/cucu/config.py

@@ -3,6 +3,7 @@ import logging
 import os
 import re
 import socket
+from pathlib import Path
 
 import yaml
 
@@ -100,7 +101,7 @@ class Config(dict):
                 else:
                     self[key] = config[key]
 
-    def load_cucurc_files(self, filepath):
+    def load_cucurc_files(self, filepath: Path):
         """
         load in order the ~/.cucurc.yml and then subsequent config files
         starting from the current working directory to the filepath provided