cucu 1.0.13__tar.gz → 1.1.2__tar.gz

{cucu-1.0.13 → cucu-1.1.2}/CHANGELOG.md

@@ -5,6 +5,19 @@ 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.1.2
+- Add - `cucu init` command to setup new projects
+
+## 1.1.1
+- Chore - bump coverage lib from 7.6.12 to 7.8.0
+- Chore - change CI to not use experimental COVERAGE_CORE=sysmon
+
+## 1.1.0
+- Add - now python 3.13 compatible
+- Change - use stdlib pdb instead of unsupported ipdb
+- Change - rename CUCU_IPDB_ON_FAILURE => to CUCU_DEBUG_ON_FAILURE
+- Chore - bump selenium lib to 4.31.0
+
 ## 1.0.13
 - Change - rename logger.warn to logger.warning
 

{cucu-1.0.13 → cucu-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cucu
-Version: 1.0.13
+Version: 1.1.2
 Summary: Easy BDD web testing
 Project-URL: Homepage, https://github.com/dominodatalab/cucu/wiki
 Project-URL: Download, https://pypi.org/project/cucu/
@@ -23,18 +23,18 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Testing :: BDD
 Requires-Python: >=3.9
 Requires-Dist: beautifulsoup4~=4.13.3
-Requires-Dist: behave~=1.2.6
+Requires-Dist: behave==1.2.6
 Requires-Dist: chromedriver-autoinstaller~=0.6.2
 Requires-Dist: click~=8.1.7
-Requires-Dist: coverage[toml]~=7.6.12
+Requires-Dist: coverage[toml]~=7.8
 Requires-Dist: geckodriver-autoinstaller~=0.1.0
 Requires-Dist: humanize~=4.12.1
-Requires-Dist: importlib-metadata~=8.6.1
-Requires-Dist: ipdb~=0.13.13
-Requires-Dist: jellyfish~=1.1.3
+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: mpire~=2.10.2
@@ -42,9 +42,9 @@ Requires-Dist: psutil>=6.0
 Requires-Dist: pygls~=1.3.1
 Requires-Dist: pyyaml~=6.0.1
 Requires-Dist: requests<3.0.0,>=2.31.0
-Requires-Dist: selenium~=4.28
+Requires-Dist: selenium~=4.31
 Requires-Dist: tabulate~=0.9.0
-Requires-Dist: tenacity~=9.0.0
+Requires-Dist: tenacity>=9.0
 Description-Content-Type: text/markdown
 
 [![pypi](https://img.shields.io/pypi/v/cucu.svg)](https://pypi.org/project/cucu/)
@@ -90,8 +90,9 @@ to drive various underlying tools/frameworks to create real world testing scenar
 
 - [Installation](#installation)
   - [Requirements](#requirements)
-  - [Install Walkthrough](#install-walkthrough)
-- [Usage](#usage)
+  - [Setup](#setup)
+  - [Usage](#usage)
+- [Usage](#usage-1)
   - [Cucu Run](#cucu-run)
   - [Run specific browser version with docker](#run-specific-browser-version-with-docker)
 - [Extending Cucu](#extending-cucu)
@@ -103,40 +104,55 @@ to drive various underlying tools/frameworks to create real world testing scenar
   - [Install From Build](#install-from-build)
 
 # Installation
+Let's get your repo to start using the cucu framework!
+> [!NOTE] If you're not using uv, then just
+> `pip install cucu` for your repo
+
 ## Requirements
-Cucu requires
-1. python 3.9+
-2. docker (to do UI testing)
+1. Docker (for UI testing)
+2. The [uv](https://docs.astral.sh/uv/) tool
+3. A repo in a clean state
 
-## Install Walkthrough
-_Get your repo setup using cucu as a test framework_
+## Setup
+> [!NOTE] Always run cucu from your repo root folder
 
-1. install and start Docker if you haven't already
-2. install [cucu](https://pypi.org/project/cucu/)
+1. Have docker running (don't need it right now, but why not get ready for testing)
+2. Make sure you have no files to commit and a clean working tree
    ```
-   pip install cucu
+   git status
    ```
-3. create the folder structure and files with content:
-    _Cucu uses the [behave framework](https://github.com/behave/behave) which expects the `features/steps` directories_
-   - features/
-      - steps/
-      - `__init__.py` # enables cucu and custom steps
-        ```python
-        # import all of the steps from cucu
-        from cucu.steps import *  # noqa: F403, F401
-
-        # import individual sub-modules here (i.e. module names of your custom step py files)
-        # Example: For file features/steps/ui/login.py
-        # import steps.ui.login_steps
-        ```
-   - environment.py - enables before/after hooks
-     ```python
-     # flake8: noqa
-     from cucu.environment import *
-
-     # Define custom before/after hooks here
-     ```
-4. list available cucu steps
+   Should report: `nothing to commit, working tree clean`
+
+3. Add [cucu](https://pypi.org/project/cucu/) to your project and activate your venv
+   ```
+   uv add cucu --dev
+   source .venv/bin/activate
+   ```
+4. Initialize cucu (copies the `init_data` folder to your repo)
+   ```
+   cucu init
+   ```
+5. Manually resolve any file conflicts
+   ```
+   git status
+   ```
+6. Run the example tests
+   ```
+   cucu run features
+   ```
+7. Done! But there is more optional stuff you can do, like:
+   1. Run with `--no-headless` mode to see the browser interaction
+   2. Run with `--generate-report` (or `-g`) to generate the html **report/** folder
+   3. Reference the exact test (i.e. scenario) with `features/example.feature:8` instead of using the `features` folder
+   ```
+   cucu run features/example.feature:8 -g --no-headless
+   ```
+
+## Usage
+> [!Note] Cucu needs to be run from your **repo root** (i.e. the parent of the `features` folder)
+
+
+1. list available cucu steps
    ```bash
    cucu steps
    ```
@@ -145,7 +161,7 @@ _Get your repo setup using cucu as a test framework_
      cucu steps | fzf
      # start typing for search
      ```
-5. **create your first cucu test**
+2. **create your first cucu test**
    - features/my_first_test.feature
      ```gherkin
      Feature: My First Cucu Test
@@ -157,7 +173,7 @@ _Get your repo setup using cucu as a test framework_
            And I click the button "Google Search"
           Then I wait to see the text "results"
      ```
-6. **run it**
+3. **run it**
    ```bash
    cucu run features/my_first_test.feature
    ```

{cucu-1.0.13 → cucu-1.1.2}/README.md

@@ -41,8 +41,9 @@ to drive various underlying tools/frameworks to create real world testing scenar
 
 - [Installation](#installation)
   - [Requirements](#requirements)
-  - [Install Walkthrough](#install-walkthrough)
-- [Usage](#usage)
+  - [Setup](#setup)
+  - [Usage](#usage)
+- [Usage](#usage-1)
   - [Cucu Run](#cucu-run)
   - [Run specific browser version with docker](#run-specific-browser-version-with-docker)
 - [Extending Cucu](#extending-cucu)
@@ -54,40 +55,55 @@ to drive various underlying tools/frameworks to create real world testing scenar
   - [Install From Build](#install-from-build)
 
 # Installation
+Let's get your repo to start using the cucu framework!
+> [!NOTE] If you're not using uv, then just
+> `pip install cucu` for your repo
+
 ## Requirements
-Cucu requires
-1. python 3.9+
-2. docker (to do UI testing)
+1. Docker (for UI testing)
+2. The [uv](https://docs.astral.sh/uv/) tool
+3. A repo in a clean state
 
-## Install Walkthrough
-_Get your repo setup using cucu as a test framework_
+## Setup
+> [!NOTE] Always run cucu from your repo root folder
 
-1. install and start Docker if you haven't already
-2. install [cucu](https://pypi.org/project/cucu/)
+1. Have docker running (don't need it right now, but why not get ready for testing)
+2. Make sure you have no files to commit and a clean working tree
    ```
-   pip install cucu
+   git status
    ```
-3. create the folder structure and files with content:
-    _Cucu uses the [behave framework](https://github.com/behave/behave) which expects the `features/steps` directories_
-   - features/
-      - steps/
-      - `__init__.py` # enables cucu and custom steps
-        ```python
-        # import all of the steps from cucu
-        from cucu.steps import *  # noqa: F403, F401
-
-        # import individual sub-modules here (i.e. module names of your custom step py files)
-        # Example: For file features/steps/ui/login.py
-        # import steps.ui.login_steps
-        ```
-   - environment.py - enables before/after hooks
-     ```python
-     # flake8: noqa
-     from cucu.environment import *
-
-     # Define custom before/after hooks here
-     ```
-4. list available cucu steps
+   Should report: `nothing to commit, working tree clean`
+
+3. Add [cucu](https://pypi.org/project/cucu/) to your project and activate your venv
+   ```
+   uv add cucu --dev
+   source .venv/bin/activate
+   ```
+4. Initialize cucu (copies the `init_data` folder to your repo)
+   ```
+   cucu init
+   ```
+5. Manually resolve any file conflicts
+   ```
+   git status
+   ```
+6. Run the example tests
+   ```
+   cucu run features
+   ```
+7. Done! But there is more optional stuff you can do, like:
+   1. Run with `--no-headless` mode to see the browser interaction
+   2. Run with `--generate-report` (or `-g`) to generate the html **report/** folder
+   3. Reference the exact test (i.e. scenario) with `features/example.feature:8` instead of using the `features` folder
+   ```
+   cucu run features/example.feature:8 -g --no-headless
+   ```
+
+## Usage
+> [!Note] Cucu needs to be run from your **repo root** (i.e. the parent of the `features` folder)
+
+
+1. list available cucu steps
    ```bash
    cucu steps
    ```
@@ -96,7 +112,7 @@ _Get your repo setup using cucu as a test framework_
      cucu steps | fzf
      # start typing for search
      ```
-5. **create your first cucu test**
+2. **create your first cucu test**
    - features/my_first_test.feature
      ```gherkin
      Feature: My First Cucu Test
@@ -108,7 +124,7 @@ _Get your repo setup using cucu as a test framework_
            And I click the button "Google Search"
           Then I wait to see the text "results"
      ```
-6. **run it**
+3. **run it**
    ```bash
    cucu run features/my_first_test.feature
    ```

{cucu-1.0.13 → cucu-1.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cucu"
-version = "1.0.13"
+version = "1.1.2"
 description = "Easy BDD web testing"
 readme = "README.md"
 license = { text = "The Clear BSD License" }
@@ -33,6 +33,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: 3 :: Only",
     "Topic :: Software Development :: Testing :: BDD",
 ]
@@ -43,15 +44,14 @@ include = [
 requires-python = ">=3.9"
 dependencies = [
     "beautifulsoup4~=4.13.3",
-    "behave~=1.2.6",
+    "behave==1.2.6",
     "chromedriver-autoinstaller~=0.6.2",
     "click~=8.1.7",
-    "coverage[toml]~=7.6.12",
+    "coverage[toml]~=7.8",
     "geckodriver-autoinstaller~=0.1.0",
     "humanize~=4.12.1",
-    "importlib-metadata~=8.6.1",
-    "ipdb~=0.13.13",
-    "jellyfish~=1.1.3",
+    "importlib-metadata~=8.7.0",
+    "jellyfish>=1.1",
     "jinja2~=3.1.3",
     "lsprotocol~=2023.0.1",
     "mpire~=2.10.2",
@@ -59,9 +59,9 @@ dependencies = [
     "pygls~=1.3.1",
     "pyyaml~=6.0.1",
     "requests>=2.31.0,<3.0.0",
-    "selenium~=4.28",
+    "selenium~=4.31",
     "tabulate~=0.9.0",
-    "tenacity~=9.0.0",
+    "tenacity>=9.0",
 ]
 
 [project.urls]
@@ -76,6 +76,17 @@ cucu = "cucu.cli:main"
 requires = ["hatchling"]
 build-backend = "hatchling.build"
 
+[tool.hatch.build.targets.sdist]
+include = [
+  "/src",
+  "/CHANGELOG.md",
+]
+exclude = [
+  "/data",
+  "/features",
+  "/tests",
+]
+
 [tool.uv]
 dev-dependencies = [
     "pre-commit>=3.8.0",

{cucu-1.0.13 → cucu-1.1.2}/src/cucu/behave_tweaks.py

@@ -3,10 +3,14 @@
 #      writing while not interfering with the way behave does its own log
 #      capturing
 #
+import os
 import sys
 import warnings
 from functools import wraps
 
+# set env var BEHAVE_STRIP_STEPS_WITH_TRAILING_COLON=yes before importing behave
+os.environ["BEHAVE_STRIP_STEPS_WITH_TRAILING_COLON"] = "yes"
+
 import behave
 from behave.__main__ import main as original_behave_main
 from behave.model import Table
@@ -62,7 +66,7 @@ def init_step_hooks(stdout, stderr):
                     # resolve variables in the table values
                     if ctx.table is not None:
                         ctx.table.original = Table(
-                            ctx.table.headings, rows=ctx.table.rows
+                            ctx.table.headings, rows=ctx.table.rows, line=ctx.table.line
                         )
                         new_rows = []
                         for row in ctx.table.rows:
@@ -119,7 +123,7 @@ def init_step_hooks(stdout, stderr):
 
             return wrapper
 
-        behave.__dict__[decorator_name] = new_decorator
+        behave.__dict__[decorator_name.title()] = behave.__dict__[decorator_name] = new_decorator
 
 
 _stdout = sys.stdout

{cucu-1.0.13 → cucu-1.1.2}/src/cucu/cli/core.py

@@ -8,6 +8,7 @@ import sys
 import time
 import xml.etree.ElementTree as ET
 from importlib.metadata import version
+from pathlib import Path
 from threading import Timer
 
 import click
@@ -90,10 +91,10 @@ def main():
 )
 @click.option("-n", "--name", help="used to specify the exact scenario to run")
 @click.option(
-    "-i",
-    "--ipdb-on-failure/--no-ipdb-on-failure",
+    "-d",
+    "--debug-on-failure/--no-debug-on-failure",
     default=False,
-    help="on failure drop into the ipdb debug shell",
+    help="on failure drop into the debug shell",
 )
 @click.option(
     "-j",
@@ -213,7 +214,7 @@ def run(
     fail_fast,
     headless,
     name,
-    ipdb_on_failure,
+    debug_on_failure,
     junit,
     junit_with_stacktrace,
     logging_level,
@@ -323,7 +324,7 @@ def run(
                 fail_fast,
                 headless,
                 name,
-                ipdb_on_failure,
+                debug_on_failure,
                 junit,
                 results,
                 secrets,
@@ -415,7 +416,7 @@ def run(
                             fail_fast,
                             headless,
                             name,
-                            ipdb_on_failure,
+                            debug_on_failure,
                             junit,
                             results,
                             secrets,
@@ -468,7 +469,9 @@ def run(
                     time.sleep(1)
 
                 if timeout_reached:
-                    logger.warning("Timeout reached, send kill signal to workers")
+                    logger.warning(
+                        "Timeout reached, send kill signal to workers"
+                    )
                     kill_workers()
 
                 task_failed.update(async_results)
@@ -765,6 +768,39 @@ def vars(filepath):
     print(tabulate(variables, tablefmt="fancy_grid"))
 
 
+@main.command()
+@click.argument("filepath", default="")
+@click.option(
+    "-l",
+    "--logging-level",
+    default="INFO",
+    help="set logging level to one of debug, warn or info (default)",
+)
+def init(filepath, logging_level):
+    """
+    initialize cucu in the current directory
+
+    Copies the `init_data` directory to the current directory
+    """
+    os.environ["CUCU_LOGGING_LEVEL"] = logging_level.upper()
+    logger.init_logging(logging_level.upper())
+
+    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):
+        answer = input("Overwrite existing files? [y/N]:")
+        if answer.lower() != "y":
+            print("Aborted!")
+            return
+
+    shutil.copytree(init_data_dir, repo_dir, dirs_exist_ok=True)
+    print("You can now start writing your tests")
+
+
 @main.command()
 @click.option(
     "-b",

{cucu-1.0.13 → cucu-1.1.2}/src/cucu/cli/run.py

@@ -46,7 +46,7 @@ def behave(
     fail_fast,
     headless,
     name,
-    ipdb_on_failure,
+    debug_on_failure,
     junit,
     results,
     secrets,
@@ -81,8 +81,8 @@ def behave(
         key, value = variable.split("=")
         os.environ[key] = value
 
-    if ipdb_on_failure:
-        os.environ["CUCU_IPDB_ON_FAILURE"] = "true"
+    if debug_on_failure:
+        os.environ["CUCU_DEBUG_ON_FAILURE"] = "true"
 
     os.environ["CUCU_RESULTS_DIR"] = results
     os.environ["CUCU_JUNIT_DIR"] = junit

{cucu-1.0.13 → cucu-1.1.2}/src/cucu/cli/steps.py

@@ -47,6 +47,10 @@ def load_cucu_steps(filepath=None):
     stdout = stdout.getvalue()
     stderr = stderr.getvalue()
 
+    if stdout.startswith("USING RUNNER:"):
+        # remove the first line of the output so that linter won't error out trying to parse it as a step
+        stdout = "\n".join(stdout.split("\n")[1:])
+
     if stdout.startswith("ParserError"):
         print(stdout)
         raise RuntimeError(

{cucu-1.0.13 → cucu-1.1.2}/src/cucu/environment.py

@@ -270,11 +270,11 @@ def after_step(ctx, step):
         ctx.step_index += 1
         CONFIG["__STEP_SCREENSHOT_COUNT"] = 0
 
-    if CONFIG.bool("CUCU_IPDB_ON_FAILURE") and step.status == "failed":
+    if CONFIG.bool("CUCU_DEBUG_ON_FAILURE") and step.status == "failed":
         ctx._runner.stop_capture()
-        import ipdb
+        import pdb
 
-        ipdb.post_mortem(step.exc_traceback)
+        pdb.post_mortem(step.exc_traceback)
 
     CONFIG["__CUCU_BEFORE_THIS_SCENARIO_HOOKS"] = []
 

{cucu-1.0.13 → cucu-1.1.2}/src/cucu/formatter/cucu.py

@@ -171,6 +171,10 @@ class CucuFormatter(Formatter):
             text = self.colorize(
                 f"{indent}{prefix}{keyword} {step.name}\n", "cyan"
             )
+        else:
+            text = self.colorize(
+                f"{indent}{prefix}{keyword} {step.name}\n", "yellow"
+            )
 
         if self.monochrome:
             self.stream.write(f"{text}")

cucu-1.1.2/src/cucu/init_data/.gitignore

@@ -0,0 +1,5 @@
+# Cucu temp files
+.monitor.png
+report/
+results/
+# /cucurc.yml # TODO: Uncomment this rule as the file should be a local only config file

cucu-1.1.2/src/cucu/init_data/README.md

@@ -0,0 +1,63 @@
+<!-- your project readme here -->
+
+# Development
+## E2E tests
+Use [cucu](https://pypi.org/project/cucu/) to run e2e-tests with the following:
+1. make sure you're in the **repo root**
+2. install the --dev dependecies
+    ```sh
+    uv sync --dev
+    ```
+3. activate it
+    ```sh
+    source .venv/bin/activate
+    ```
+4. run scenario
+    ```sh
+    cucu run features
+    ```
+
+### Other helpful commands
+
+- Show all steps
+    ```sh
+    cucu steps
+    ```
+- Run scenario by tag
+    ```sh
+    cucu run features --tag my_tag
+    ```
+- Run scenario by line number
+    ```sh
+    cucu run features/example.feature:8
+    ```
+- Generate an html report
+    ```sh
+    cucu report
+    ```
+- Run scenarios and generate report
+    ```sh
+    cucu run features -g
+    ```
+- Lint your feature files!
+    _see `/features/lint_rules` for custom rules_
+    ```sh
+    cucu lint
+    ```
+
+### Tagging Tests
+
+> [!Note] This is just an example of how use tags
+
+1. Tags are very important as they provide:
+
+   - Critical metadata for reporting and tracking
+   - Control where it runs in CI
+   - Filtering on what tests should run
+
+2. They can be at the **Feature** file level or at the **Scenario** level.
+
+3. Here's a list of some notable tags
+   | Tag       | Gist                                                                                            | Example   |
+   | --------- | ----------------------------------------------------------------------------------------------- | --------- |
+   | @sid-#### | **[Required]** The scenario (i.e. test case) id (numbers only) that is used to track and record | @sid-1234 |

cucu-1.1.2/src/cucu/init_data/cucurc.yml

@@ -0,0 +1,10 @@
+# Don't check in this file! (I mean you could, but you probably don't want to)
+
+# The config heirarchy starts with ~/.cucurc.yml, then this file, and down the folder tree.
+# Use this file for local configuration per user
+
+# This is just an example, normally you could have it as environment variables or pass it in the command line
+MY_SECRET_USERNAME: "Bob"
+MY_SECRET_PASSWORD: "123456"
+
+SOME_OTHER_SECRET: "another secret"

cucu-1.1.2/src/cucu/init_data/data/www/example.html

@@ -0,0 +1,27 @@
+<html>
+  <head>
+    <title>Some Example</title>
+    <script>
+    function update() {
+      document.querySelector("#my_status").textContent = "Welcome " + document.querySelector("#my_name").value + " !";
+      document.querySelector("#my_name").value = "";
+      document.querySelector("#my_key").value = "";
+    }
+    </script>
+  </head>
+  <body>
+
+    <h1>Some Example</h1>
+    <div id="my_status"></div>
+    <br/>
+
+    <div style="background: aliceblue;">Fake login box
+      <br/>
+      <label>username:</label><input id="my_name" type="text"></input>
+      <br/>
+      <label>The password here but use aria label to find</label><input aria-label="password" id="my_key" type="password"></input>
+      <br/>
+      <button onclick="update();">Login</button>
+    </div>
+  </body>
+</html>

cucu-1.1.2/src/cucu/init_data/features/cucurc.yml

@@ -0,0 +1,9 @@
+# Checkin this file for the repo configuration
+
+# CUCU_SECRETS is a comma-separated list of the names of the secrets (not the values)
+CUCU_SECRETS: "MY_SECRET_PASSWORD,SOME_OTHER_SECRET"
+
+CUCU_BROWSER_WINDOW_HEIGHT: 1080
+CUCU_BROWSER_WINDOW_WIDTH: 1920
+
+CUCU_BROKEN_IMAGES_PAGE_CHECK: false