cucu 0.0.0__tar.gz → 1.0.0__tar.gz

cucu-1.0.0/.circleci/config.yml

@@ -0,0 +1,137 @@
+# Use the latest 2.1 version of CircleCI pipeline process engine.
+# See: https://circleci.com/docs/2.0/configuration-reference
+---
+version: 2.1
+
+workflows:
+  build-test-publish:
+    jobs:
+      - build
+      - test:
+          name: test-chrome
+          browser: chrome
+          requires:
+            - build
+      - test:
+          name: test-edge
+          browser: edge
+          requires:
+            - build
+      - test:
+          name: test-firefox
+          browser: firefox
+          requires:
+            - build
+
+jobs:
+  build:
+    docker:
+      - image: cimg/python:3.12
+    resource_class: medium
+    steps:
+      - checkout
+      - inline-orb-uv/setup-uv
+      - run:
+          name: install cucu with Python 3.12
+          command: uv sync -p 3.12 --dev
+      - run:
+          name: run pre-commit validations
+          command: uv run pre-commit run --show-diff-on-failure --from-ref origin/HEAD --to-ref HEAD
+      - run:
+          name: build the cucu python package
+          command: uv build
+      - run:
+          name: install cucu globally
+          command: pip install dist/cucu-*.tar.gz
+
+  test:
+    parameters:
+      browser:
+        type: string
+        default: "chrome"
+    docker:
+      - image: cimg/python:3.12
+      - image: selenium/standalone-<<parameters.browser>>:124.0
+        environment:
+          SE_NODE_MAX_SESSIONS: 12
+          SE_NODE_SESSION_TIMEOUT: 300
+          SCREEN_WIDTH: 1366
+          SCREEN_HEIGHT: 768
+    resource_class: xlarge
+    steps:
+      - setup_remote_docker
+      - checkout
+      - inline-orb-uv/setup-uv
+      - run:
+          name: install cucu dependencies
+          command: uv sync
+      - run:
+          name: install test dependencies
+          command: |
+            set +eo pipefail
+            sudo apt-get update
+            sudo apt-get install -y expect
+      - run:
+          name: wait_for_selenium
+          # retry connection every 5s x 60 which is a total of 5 minutes
+          command: curl --retry 60 --retry-delay 5 --retry-connrefused http://localhost:4444
+      - run:
+          name: run_functional_tests
+          command: uv run cucu run features --workers 6 --selenium-remote-url http://localhost:4444 --generate-report --junit junit_results --browser "<<parameters.browser>>"
+          environment:
+            COVERAGE_PROCESS_START: pyproject.toml  # set to config file
+      - run:
+          name: run unit tests
+          command: uv run coverage run -m pytest --junit-xml=results/unit-tests.xml
+      - run:
+          name: code_coverage_check
+          command: |
+            set +eo pipefail
+            uv run coverage combine .coverage.*
+            uv run coverage html
+            uv run coverage report
+            uv run coverage xml
+            mv coverage.xml coverage-<<parameters.browser>>.xml
+      - persist_to_workspace:
+          root: .
+          paths:
+            - coverage-<<parameters.browser>>.xml
+      - run:
+          name: tar up results and reporting
+          command: |
+            tar cvfz results.tgz results
+            tar cvfz report.tgz report
+            tar cvfz junit_results.tgz junit_results
+          when: always
+      - store_artifacts:
+          path: coverage-<<parameters.browser>>.xml
+      - store_artifacts:
+          path: results.tgz
+      - store_artifacts:
+          path: junit_results.tgz
+      - store_artifacts:
+          path: report.tgz
+      - store_test_results:
+          path: junit_results
+
+orbs:
+  inline-orb-uv:
+    commands:
+      setup-uv:
+        steps:
+          - restore_cache:
+              keys:
+                - v1-uv-cache-{{ checksum "uv.lock" }}
+          - run:
+              name: Install uv
+              command: |
+                curl -LsSf https://astral.sh/uv/install.sh | sh
+                echo 'source $HOME/.cargo/env' >> $BASH_ENV
+                source $BASH_ENV
+          - save_cache:
+              paths:
+                - $HOME/.cargo/env
+              key: v1-uv-cache-{{ checksum "uv.lock" }}
+          - run:
+              name: Verify uv installation
+              command: uv --version

cucu-1.0.0/.env

@@ -0,0 +1 @@
+export PYTHONBREAKPOINT="ipdb.set_trace"

cucu-1.0.0/.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Ownership updated by devprod
+* @dominodatalab/eng-automation

cucu-1.0.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,25 @@
+## PR Type
+What kind of change does this PR introduce?
+
+<!-- Please check the one that applies to this PR using "x". -->
+- [ ] Bugfix
+- [ ] Feature
+- [ ] Code style update (formatting)
+- [ ] Refactoring (no functional changes)
+- [ ] CI related changes
+- [ ] Other... Please describe:
+
+## What is the current behavior?
+<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
+
+Issue Number: https://dominodatalab.atlassian.net/browse/
+
+## What is the new behavior?
+
+## Does this PR introduce a breaking change?
+- [ ] Yes
+- [ ] No
+
+<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
+
+## Other information

cucu-1.0.0/.github/workflows/build.yml

@@ -0,0 +1,126 @@
+name: build
+# This is a beta version of migrating the CircleCI build to GH Actions
+# TODO: Figure out and prevent firefox and edge tests getting auto-cancelled (out of memory?)
+# TODO: Combine coverage reports in another job
+
+on:
+  workflow_dispatch:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install the latest version of uv
+      uses: astral-sh/setup-uv@v2
+      with:
+        enable-cache: true
+    - name: Install cucu with Python 3.12
+      run: |
+        uv sync -p 3.12 --dev
+    - name: Run pre-commit
+      run: |
+        uv run pre-commit run
+
+  unit:
+    needs: lint
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install the latest version of uv
+      uses: astral-sh/setup-uv@v2
+      with:
+        enable-cache: true
+    - name: Install cucu with Python 3.12
+      run: |
+        uv sync -p 3.12 --dev
+    - name: unit tests
+      run: |
+        uv run coverage run -m pytest --junit-xml=output/unit-tests.xml
+    - name: package results
+      if: always()
+      run: |
+        mkdir -p output
+        mv .coverage.* output/
+        tar cvfz output.tgz output
+    - name: save output
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: unit-tests
+        path: output.tgz
+    - name: Publish Test Results
+      uses: EnricoMi/publish-unit-test-result-action@v2
+      if: always()
+      with:
+        check_name: "unit results"
+        files: |
+          output/unit-tests.xml
+
+  cucu:
+    needs: unit
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        browser: ["chrome", "firefox", "edge"]
+    permissions:  # to publish junit results - see https://github.com/EnricoMi/publish-unit-test-result-action?tab=readme-ov-file#permissions
+      contents: read
+      issues: read
+      checks: write
+      pull-requests: write
+    services:
+      webserver:
+        image: selenium/standalone-${{ matrix.browser }}:124.0
+        ports:
+          - 4444:4444
+        options: --shm-size=4gb
+        env:
+          SE_NODE_MAX_SESSIONS: 12
+          SE_NODE_SESSION_TIMEOUT: 300
+          SCREEN_WIDTH: 1366
+          SCREEN_HEIGHT: 768
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Install the latest version of uv
+      uses: astral-sh/setup-uv@v2
+      with:
+        enable-cache: true
+    - name: Install Python 3.12
+      run: |
+        uv python install 3.12
+        uv sync
+    - name: wait_for_selenium
+      # retry connection every 2s x 60 which is a total of 2 minutes
+      run: curl --retry 60 --retry-delay 2 --retry-connrefused http://localhost:4444
+    - name: UI tests
+      run: |
+        uv run cucu run features --browser "${{ matrix.browser }}" --workers 1 --generate-report --report output/report --junit output/junit --selenium-remote-url http://localhost:4444
+      env:
+        COVERAGE_PROCESS_START: pyproject.toml
+        SE_NODE_MAX_SESSIONS: 12
+        SE_NODE_SESSION_TIMEOUT: 300
+        SCREEN_WIDTH: 1366
+        SCREEN_HEIGHT: 768
+        DISPLAY: :99  # Needed for headless mode
+        SELENIUM_HOST: localhost
+        SELENIUM_PORT: 4444
+    - name: package results
+      if: always()
+      run: |
+        mkdir -p output
+        mv .coverage.* output/
+        tar cvfz output.tgz output
+    - name: save output
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ matrix.browser }}-tests
+        path: output.tgz
+    - name: Publish Test Results
+      uses: EnricoMi/publish-unit-test-result-action@v2
+      if: always()
+      with:
+        check_name: "${{ matrix.browser }} results"
+        files: |
+          output/junit/**/*.xml

cucu-1.0.0/.github/workflows/create_a_new_release.yml

@@ -0,0 +1,45 @@
+name: Create a New Release
+# The following job is run when a commit changes pyproject.toml file:
+#   * Checks if the version of the project is the same of the latest release
+#   * If not, create a new release and then start the publishing
+#   * to test.pypi.org job
+
+on:
+  push:
+    branches:
+      - 'main'
+    paths:
+      - 'pyproject.toml'
+
+jobs:
+  create-release-if-new-version:
+    runs-on: "ubuntu-latest"
+    steps:
+      - id: check_out
+        name: Check out code
+        uses: actions/checkout@v4
+      - id: release_if_needed
+        name: Release on version change merged
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: |
+          version=$(sed -n "s/^version *= *\"\(.*\)\"/\1/p" pyproject.toml)
+          latest_release=$(gh api /repos/dominodatalab/cucu/releases/latest --jq '.tag_name')
+          if [[ $version != $latest_release ]]; then
+            gh api \
+              --method POST \
+              -H "Accept: application/vnd.github+json" \
+              /repos/dominodatalab/cucu/releases \
+              -f tag_name=$version \
+              -f name="v$version" \
+              -F draft=false \
+              -F prerelease=false \
+              -F generate_release_notes=true
+          fi
+      - name: trigger publish-test workflow
+        run: |
+            curl -X POST \
+            -H "Authorization: token ${{ github.token }}" \
+            -H "Accept: application/vnd.github+json" \
+            https://api.github.com/repos/${GITHUB_REPOSITORY}/dispatches \
+            -d '{"event_type": "trigger_publish_test"}'

cucu-1.0.0/.github/workflows/publish-production.yml

@@ -0,0 +1,31 @@
+name: publish-production
+# publish to pypi.org on merge to default branch
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish-production-main:
+    environment: cucu-publish-production  # match name in www.PyPI.org OIDC
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Required for connection to pypi OIDC
+      contents: read  # For non-public repo
+    steps:
+      - name: checkout main
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 0
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v2
+        with:
+          enable-cache: true
+      - name: Install cucu with Python 3.12
+        run: |
+          uv sync -p 3.12
+      - name: build package
+        run: |
+          uv build
+      - name: publish to pypi.org
+        uses: pypa/gh-action-pypi-publish@release/v1

cucu-1.0.0/.github/workflows/publish-test.yml

@@ -0,0 +1,35 @@
+name: publish-test
+# publish to test.pypi.org on merge to default branch
+
+on:
+  workflow_dispatch:
+  repository_dispatch:
+    types: [trigger_publish_test]
+
+jobs:
+  publish-test-main:
+    environment: cucu-publish-test  # match name in test.PyPI.org OIDC
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Required for connection to pypi OIDC
+      contents: read  # For non-public repo
+    steps:
+      - name: checkout main
+        uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 0
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v2
+        with:
+          version: "latest"
+      - name: Install cucu with Python 3.12
+        run: |
+          uv sync -p 3.12
+      - name: build package
+        run: |
+          uv build
+      - name: publish to test.pypi.org
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

cucu-1.0.0/.gitignore

@@ -0,0 +1,190 @@
+dist
+.cache
+.coverage.*
+.DS_Store
+*.egg-info
+htmlcov
+.nox
+.ruff_cache
+terraform.tfstate
+terraform.tfstate.backup
+.terraform
+.pytest_cache
+__pycache__
+*.pyc
+pygls.log
+junit_results/
+report/
+results/
+.monitor.png
+geckodriver.log
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+## COMMON - PYTHON (from https://github.com/github/gitignore/blob/main/Python.gitignore)
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+
+## COMMON - TERRAFORM (from https://github.com/github/gitignore/blob/main/Terraform.gitignore)
+# Local .terraform directories
+**/.terraform/*
+
+# .tfstate files
+*.tfstate
+*.tfstate.*
+
+# Crash log files
+crash.log
+crash.*.log
+
+# Exclude all .tfvars files, which are likely to contain sensitive data, such as
+# password, private keys, and other secrets. These should not be part of version
+# control as they are data points which are potentially sensitive and subject
+# to change depending on the environment.
+*.tfvars
+*.tfvars.json
+
+# Ignore override files as they are usually used to override resources locally and so
+# are not checked in
+override.tf
+override.tf.json
+*_override.tf
+*_override.tf.json
+
+# Include override files you do wish to add to version control using negated pattern
+# !example_override.tf
+
+# Include tfplan files to ignore the plan output of command: terraform plan -out=tfplan
+# example: *tfplan*
+
+# Ignore CLI configuration files
+.terraformrc
+terraform.rc
+
+# VSCode
+.vscode
+
+# generated during test run
+skip_first_scenario.txt

cucu-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+exclude: "^features/cli/lint.feature|^data/features/feature_with_mixed_results.feature"
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: check-xml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: detect-private-key
+  - repo: local
+    hooks:
+      - id: makefile
+        name: run make lint
+        entry: make
+        args: ["lint"]
+        language: system
+        pass_filenames: false
+        verbose: true

cucu-1.0.0/.python-version

@@ -0,0 +1 @@
+3.12