cumulusci-plus 5.0.0__tar.gz

cumulusci_plus-5.0.0/.gitignore

@@ -0,0 +1,83 @@
+# OS cruft
+.DS_Store
+
+# CumulusCI config and output
+.cci
+docs/api/
+docs/_build/
+github_release_notes.html
+tmp
+
+# Distribution / packaging
+*.egg
+*.egg-info/
+.Python
+.installed.cfg
+develop-eggs/
+dist/
+eggs/
+env/
+lib/
+lib64/
+parts/
+pip-wheel-metadata
+sdist/
+var/
+
+# Miscellaneous Python cruft
+.pdbrc
+.pdbrc.py
+.python-version
+venv/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*.pkl
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+.cache/
+.coverage
+.coverage.*
+.mypy_cache/
+.pytest_cache/
+.tox/
+cov.xml
+htmlcov/
+large_cassettes/
+.noseids
+nosetests.xml
+pytestdebug.log
+results_junit.xml
+test_results.json
+log.html
+report.html
+output.xml
+
+# Robot
+*.webm
+.pabotsuitenames
+geckodriver*.log
+pabot_results/
+playwright-log.txt
+robot/CumulusCI/results/
+
+# Salesforce
+**/.sfdx
+.sf
+
+# direnv
+.direnv
+.envrc
+
+# Editors
+*~
+.*.swp
+.*.swo
+.vscode/
+.idea/
+tags

cumulusci_plus-5.0.0/AUTHORS.rst

@@ -0,0 +1,41 @@
+=======
+Credits
+=======
+
+Development Team
+----------------
+
+CumulusCI is developed by the Salesforce.org Release Engineering team:
+
+* Jason Lantz
+* David Glick
+* James Estevez
+* Paul Prescod
+* Bryan Oakley
+* David Reed
+* Brandon Parker
+* Josh Kofsky
+* Marcel Pufal
+* David Ray
+
+Developers Emeritus
+-------------------
+
+* Chris Polcyn
+* Christian Carter
+
+Contributors
+------------
+
+Thanks to the many community and Salesforce.org staff
+contributors!
+
+For example:
+
+(add your name here, when you contribute through a Pull Request!)
+
+* Ed Rivas (jerivas)
+* Gustavo Tandeciarz (dcinzona)
+* Chandler Anderson (zenibako)
+* Ben French (BenjaminFrench)
+* Rupert Barrow (rupertbarrow)

cumulusci_plus-5.0.0/LICENSE

@@ -0,0 +1,30 @@
+Copyright (c) 2021, Salesforce.com, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the
+  above copyright notice, this list of conditions
+  and the following disclaimer.
+
+* Redistributions in binary form must reproduce
+  the above copyright notice, this list of conditions
+  and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of Salesforce.com nor the names
+  of its contributors may be used to endorse or promote
+  products derived from this software without specific
+  prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
+OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
+STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
+WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

cumulusci_plus-5.0.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: cumulusci-plus
+Version: 5.0.0
+Summary: Build and release tools for Salesforce developers
+Project-URL: Homepage, https://github.com/SFDO-Tooling/CumulusCI
+Project-URL: Changelog, https://cumulusci.readthedocs.io/en/stable/history.html
+Project-URL: Bug Tracker, https://github.com/SFDO-Tooling/CumulusCI/issues
+Author-email: "Salesforce.org" <sfdo-mrbelvedere@salesforce.com>
+License: BSD 3-Clause License
+License-File: AUTHORS.rst
+License-File: LICENSE
+Keywords: cumulusci,salesforce
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Requires-Dist: click>=8.1
+Requires-Dist: cryptography
+Requires-Dist: defusedxml
+Requires-Dist: docutils>=0.21.2
+Requires-Dist: faker
+Requires-Dist: fs
+Requires-Dist: github3-py
+Requires-Dist: jinja2
+Requires-Dist: keyring<=23.0.1
+Requires-Dist: lxml
+Requires-Dist: markupsafe
+Requires-Dist: packaging>=23.0
+Requires-Dist: psutil
+Requires-Dist: pydantic<2
+Requires-Dist: pyjwt
+Requires-Dist: python-dateutil
+Requires-Dist: pytz
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Requires-Dist: requests-futures
+Requires-Dist: rich>=13.9.4
+Requires-Dist: robotframework
+Requires-Dist: robotframework-pabot
+Requires-Dist: robotframework-requests
+Requires-Dist: robotframework-seleniumlibrary<6
+Requires-Dist: rst2ansi>=0.1.5
+Requires-Dist: salesforce-bulk
+Requires-Dist: sarge
+Requires-Dist: selenium<4
+Requires-Dist: simple-salesforce==1.11.4
+Requires-Dist: snowfakery>=4.0.0
+Requires-Dist: sqlalchemy<2
+Requires-Dist: xmltodict
+Provides-Extra: select
+Requires-Dist: annoy; extra == 'select'
+Requires-Dist: numpy; extra == 'select'
+Requires-Dist: pandas; extra == 'select'
+Requires-Dist: scikit-learn; extra == 'select'
+Description-Content-Type: text/markdown
+
+# CumulusCI
+
+[![Code Coverage](https://coveralls.io/repos/github/SFDO-Tooling/CumulusCI/badge.svg?branch=main)](https://coveralls.io/github/SFDO-Tooling/CumulusCI?branch=main)
+[![PyPI](https://img.shields.io/pypi/v/cumulusci)](https://pypi.org/project/cumulusci/)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cumulusci)
+![PyPI - License](https://img.shields.io/pypi/l/cumulusci)
+[![Documentation Status](https://readthedocs.org/projects/cumulusci/badge/?version=latest)](https://cumulusci.readthedocs.io/en/latest/?badge=latest)
+
+CumulusCI helps build great applications on the Salesforce platform by
+automating org setup, testing, and deployment for everyone --- from
+developers and admins to testers and product managers.
+
+**Best practices, proven at scale.** CumulusCI provides a complete
+development and release process created by Salesforce.org to build and
+release applications to thousands of users on the Salesforce platform.
+It\'s easy to start new projects with a standard set of tasks (single
+actions) and flows (sequences of tasks), or customize by adding your
+own.
+
+**Batteries included.** Out-of-the-box features help you quickly:
+
+-   Build sophisticated orgs with automatic installation of
+    dependencies.
+-   Load and capture sample datasets to make your orgs feel real.
+-   Apply transformations to existing metadata to tailor orgs to your
+    specific requirements.
+-   Run builds in continuous integration systems.
+-   Create end-to-end browser tests and setup automation using [Robot
+    Framework](https://cumulusci.readthedocs.io/en/latest/robotframework.html).
+-   Generate synthetic data on any scale, from a single record to a
+    million, using
+    [Snowfakery](https://cumulusci.readthedocs.io/en/latest/cookbook.html#large-volume-data-synthesis-with-snowfakery).
+
+**Build anywhere.** Automation defined using CumulusCI is portable. It
+is stored in a source repository and can be run from your local command
+line, from a continuous integration system, or from a customer-facing
+MetaDeploy installer. CumulusCI can run automation on scratch orgs
+created using the Salesforce CLI, or on persistent orgs like sandboxes,
+production orgs, and Developer Edition orgs.
+
+## Learn more
+
+For a tutorial introduction to CumulusCI, complete the [Build
+Applications with
+CumulusCI](https://trailhead.salesforce.com/en/content/learn/trails/build-applications-with-cumulusci)
+trail on Trailhead.
+
+To go in depth, read the [full
+documentation](https://cumulusci.readthedocs.io/en/latest/).
+
+If you just want a quick intro, watch [these screencast
+demos](https://cumulusci.readthedocs.io/en/latest/demos.html) of using
+CumulusCI to configure a Salesforce project from a GitHub repository.
+
+For a live demo with voiceover, please see Jason Lantz\'s [PyCon 2020
+presentation](https://www.youtube.com/watch?v=XL77lRTVF3g) from minute
+36 through minute 54.
+
+## Questions?
+
+Ask in the [CumulusCI (CCI) group in the Trailblazer
+Community](https://success.salesforce.com/_ui/core/chatter/groups/GroupProfilePage?g=0F9300000009M9ZCAU).
+
+_Please note:_ CumulusCI is distributed under an [open source
+license](https://github.com/SFDO-Tooling/CumulusCI/blob/main/LICENSE)
+and is not covered by the Salesforce Master Subscription Agreement.
+
+<!-- Changelog -->
+## v4.4.0 (2025-05-05)
+
+<!-- Release notes generated using configuration in .github/release.yml at main -->
+
+## What's Changed
+
+### Changes
+
+-   Add new tasks get_assignable_permission_sets and get_assignable_licenses by [@vsbharath](https://github.com/vsbharath) in [#3892](https://github.com/SFDO-Tooling/CumulusCI/pull/3892)
+
+### Issues Fixed
+
+-   fix: Make get permset licenses return active only by [@jstvz](https://github.com/jstvz) in [#3888](https://github.com/SFDO-Tooling/CumulusCI/pull/3888)
+-   fix: Read the docs configuration by LaTeX into PDF by [@dcinzona](https://github.com/dcinzona) in [#3891](https://github.com/SFDO-Tooling/CumulusCI/pull/3891)
+
+**Full Changelog**: https://github.com/SFDO-Tooling/CumulusCI/compare/v4.3.0.dev0...v4.4.0

cumulusci_plus-5.0.0/README.md

@@ -0,0 +1,68 @@
+# CumulusCI
+
+[![Code Coverage](https://coveralls.io/repos/github/SFDO-Tooling/CumulusCI/badge.svg?branch=main)](https://coveralls.io/github/SFDO-Tooling/CumulusCI?branch=main)
+[![PyPI](https://img.shields.io/pypi/v/cumulusci)](https://pypi.org/project/cumulusci/)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/cumulusci)
+![PyPI - License](https://img.shields.io/pypi/l/cumulusci)
+[![Documentation Status](https://readthedocs.org/projects/cumulusci/badge/?version=latest)](https://cumulusci.readthedocs.io/en/latest/?badge=latest)
+
+CumulusCI helps build great applications on the Salesforce platform by
+automating org setup, testing, and deployment for everyone --- from
+developers and admins to testers and product managers.
+
+**Best practices, proven at scale.** CumulusCI provides a complete
+development and release process created by Salesforce.org to build and
+release applications to thousands of users on the Salesforce platform.
+It\'s easy to start new projects with a standard set of tasks (single
+actions) and flows (sequences of tasks), or customize by adding your
+own.
+
+**Batteries included.** Out-of-the-box features help you quickly:
+
+-   Build sophisticated orgs with automatic installation of
+    dependencies.
+-   Load and capture sample datasets to make your orgs feel real.
+-   Apply transformations to existing metadata to tailor orgs to your
+    specific requirements.
+-   Run builds in continuous integration systems.
+-   Create end-to-end browser tests and setup automation using [Robot
+    Framework](https://cumulusci.readthedocs.io/en/latest/robotframework.html).
+-   Generate synthetic data on any scale, from a single record to a
+    million, using
+    [Snowfakery](https://cumulusci.readthedocs.io/en/latest/cookbook.html#large-volume-data-synthesis-with-snowfakery).
+
+**Build anywhere.** Automation defined using CumulusCI is portable. It
+is stored in a source repository and can be run from your local command
+line, from a continuous integration system, or from a customer-facing
+MetaDeploy installer. CumulusCI can run automation on scratch orgs
+created using the Salesforce CLI, or on persistent orgs like sandboxes,
+production orgs, and Developer Edition orgs.
+
+## Learn more
+
+For a tutorial introduction to CumulusCI, complete the [Build
+Applications with
+CumulusCI](https://trailhead.salesforce.com/en/content/learn/trails/build-applications-with-cumulusci)
+trail on Trailhead.
+
+To go in depth, read the [full
+documentation](https://cumulusci.readthedocs.io/en/latest/).
+
+If you just want a quick intro, watch [these screencast
+demos](https://cumulusci.readthedocs.io/en/latest/demos.html) of using
+CumulusCI to configure a Salesforce project from a GitHub repository.
+
+For a live demo with voiceover, please see Jason Lantz\'s [PyCon 2020
+presentation](https://www.youtube.com/watch?v=XL77lRTVF3g) from minute
+36 through minute 54.
+
+## Questions?
+
+Ask in the [CumulusCI (CCI) group in the Trailblazer
+Community](https://success.salesforce.com/_ui/core/chatter/groups/GroupProfilePage?g=0F9300000009M9ZCAU).
+
+_Please note:_ CumulusCI is distributed under an [open source
+license](https://github.com/SFDO-Tooling/CumulusCI/blob/main/LICENSE)
+and is not covered by the Salesforce Master Subscription Agreement.
+
+<!-- Changelog -->

cumulusci_plus-5.0.0/cumulusci/__about__.py

@@ -0,0 +1 @@
+__version__ = "5.0.0"

cumulusci_plus-5.0.0/cumulusci/__init__.py

@@ -0,0 +1,22 @@
+import os
+import sys
+import warnings
+from importlib.metadata import PackageNotFoundError, version
+
+# Suppress pkg_resources deprecation warnings from dependencies
+warnings.filterwarnings("ignore", message=".*pkg_resources.*", category=UserWarning)
+
+from simple_salesforce import api, bulk
+
+__location__ = os.path.dirname(os.path.realpath(__file__))
+
+try:
+    __version__ = version("cumulusci")
+except PackageNotFoundError:
+    __version__ = "unknown"
+
+if sys.version_info < (3, 8):  # pragma: no cover
+    raise Exception("CumulusCI requires Python 3.8+.")
+
+api.OrderedDict = dict
+bulk.OrderedDict = dict

cumulusci_plus-5.0.0/cumulusci/__main__.py

@@ -0,0 +1,3 @@
+from cumulusci.cli.cci import main
+
+main()

cumulusci_plus-5.0.0/cumulusci/cli/cci.py

@@ -0,0 +1,244 @@
+import code
+import contextlib
+import pdb
+import runpy
+import sys
+import traceback
+
+import click
+import requests
+import rich
+from rich.console import Console
+from rich.markup import escape
+
+import cumulusci
+from cumulusci.core.debug import set_debug_mode
+from cumulusci.core.exceptions import CumulusCIUsageError
+from cumulusci.utils import get_cci_upgrade_command
+from cumulusci.utils.http.requests_utils import init_requests_trust
+from cumulusci.utils.logging import tee_stdout_stderr
+
+from .error import error
+from .flow import flow
+from .logger import get_tempfile_logger, init_logger
+from .org import org
+from .plan import plan
+from .project import project
+from .robot import robot
+from .runtime import CliRuntime, pass_runtime
+from .service import service
+from .task import task
+from .utils import (
+    check_latest_version,
+    get_installed_version,
+    get_latest_final_version,
+    warn_if_no_long_paths,
+)
+
+SUGGEST_ERROR_COMMAND = (
+    """Run this command for more information about debugging errors: cci error --help"""
+)
+
+USAGE_ERRORS = (CumulusCIUsageError, click.UsageError)
+
+
+#
+# Root command
+#
+def main(args=None):
+    """Main CumulusCI CLI entry point.
+
+    This runs as the first step in processing any CLI command.
+
+    This wraps the `click` library in order to do some initialization and centralized error handling.
+    """
+    with contextlib.ExitStack() as stack:
+        args = args or sys.argv
+
+        # (If enabled) set up requests to validate certs using system CA certs instead of certifi
+        init_requests_trust()
+
+        # Check for updates _unless_ we've been asked to output JSON,
+        # or if we're going to check anyway as part of the `version` command.
+        is_version_command = len(args) > 1 and args[1] == "version"
+        if "--json" not in args and not is_version_command:
+            check_latest_version()
+
+        # Only create logfiles for commands that are not `cci error`
+        is_error_command = len(args) > 2 and args[1] == "error"
+        tempfile_path = None
+        if not is_error_command:
+            logger, tempfile_path = get_tempfile_logger()
+            stack.enter_context(tee_stdout_stderr(args, logger, tempfile_path))
+
+        debug = "--debug" in args
+        if debug:
+            args.remove("--debug")
+
+        with set_debug_mode(debug):
+            try:
+                runtime = CliRuntime(load_keychain=False)
+            except Exception as e:
+                handle_exception(e, is_error_command, tempfile_path, debug)
+                sys.exit(1)
+
+            runtime.check_cumulusci_version()
+            should_show_stacktraces = runtime.universal_config.cli__show_stacktraces
+
+            init_logger(debug=debug)
+            # Hand CLI processing over to click, but handle exceptions
+            try:
+                cli(args[1:], standalone_mode=False, obj=runtime)
+            except click.Abort:  # Keyboard interrupt
+                console = Console()
+                show_debug_info() if debug else console.print("\n[red bold]Aborted!")
+                sys.exit(1)
+            except Exception as e:
+                if debug:
+                    show_debug_info()
+                else:
+                    handle_exception(
+                        e,
+                        is_error_command,
+                        tempfile_path,
+                        should_show_stacktraces,
+                    )
+                sys.exit(1)
+
+
+def handle_exception(
+    error,
+    is_error_cmd,
+    logfile_path,
+    should_show_stacktraces=False,
+):
+    """Displays error of appropriate message back to user, prompts user to investigate further
+    with `cci error` commands, and writes the traceback to the latest logfile.
+    """
+    error_console = Console(stderr=True)
+    if isinstance(error, requests.exceptions.ConnectionError):
+        connection_error_message(error_console)
+    elif isinstance(error, click.ClickException):
+        error_console.print(f"[red bold]Error: {escape(error.format_message())}")
+    else:
+        # We call str ourselves to make Typeguard shut up.
+        error_console.print(f"[red bold]Error: {escape(str(error))}")
+    # Only suggest gist command if it wasn't run
+    if not is_error_cmd:
+        error_console.print(f"[yellow]{SUGGEST_ERROR_COMMAND}")
+
+    # This is None if we're handling an exception for a `cci error` command.
+    if logfile_path:
+        with open(logfile_path, "a") as log_file:
+            traceback.print_exc(file=log_file)  # log stacktrace silently
+
+    if should_show_stacktraces and not isinstance(error, USAGE_ERRORS):
+        error_console.print_exception()
+
+
+def connection_error_message(console: Console):
+    message = (
+        "We encountered an error with your internet connection. "
+        "Please check your connection and try the last cci command again."
+    )
+    console.print(f"[red bold]{message}")
+
+
+def show_debug_info():
+    """Displays the traceback and opens pdb"""
+    traceback.print_exc()
+    pdb.post_mortem()
+
+
+def show_version_info():
+    console = rich.get_console()
+    console.print(f"CumulusCI version: {cumulusci.__version__} ({sys.argv[0]})")
+    console.print(f"Python version: {sys.version.split()[0]} ({sys.executable})")
+    console.print()
+    warn_if_no_long_paths(console=console)
+
+    current_version = get_installed_version()
+    latest_version = get_latest_final_version()
+
+    if not latest_version > current_version:
+        console.print("You have the latest version of CumulusCI :sun_behind_cloud:\n")
+        display_release_notes_link(str(latest_version))
+        return
+
+    console.print(
+        f"[yellow]There is a newer version of CumulusCI available: {str(latest_version)}"
+    )
+    console.print(f"To upgrade, run `{get_cci_upgrade_command()}`")
+    display_release_notes_link(str(latest_version))
+
+
+def display_release_notes_link(latest_version: str) -> None:
+    """Provide a link to the latest CumulusCI Release Notes"""
+    release_notes_link = (
+        f"https://github.com/SFDO-Tooling/CumulusCI/releases/tag/v{latest_version}"
+    )
+    console = rich.get_console()
+    console.print(
+        f"See the latest CumulusCI Release Notes: [link={release_notes_link}]{release_notes_link}[/link]"
+    )
+
+
+def version_info_wrapper(
+    ctx: click.Context, param: click.Parameter, value: bool
+) -> None:
+    if not value:
+        return
+    show_version_info()
+    ctx.exit()
+
+
+@click.group("main", help="")
+@click.option(  # based on https://click.palletsprojects.com/en/8.1.x/options/#callbacks-and-eager-options
+    "--version",
+    is_flag=True,
+    expose_value=False,
+    is_eager=True,
+    help="Show the version and exit.",
+    callback=version_info_wrapper,
+)
+def cli():
+    """Top-level `click` command group."""
+
+
+@cli.command(name="version", help="Print the current version of CumulusCI")
+def version():
+    show_version_info()
+
+
+@cli.command(name="shell", help="Drop into a Python shell")
+@click.option("--script", help="Path to a script to run", type=click.Path())
+@click.option("--python", help="Python code to run directly")
+@pass_runtime(require_project=False, require_keychain=True)
+def shell(runtime, script=None, python=None):
+    # alias for backwards-compatibility
+    variables = {
+        "config": runtime,
+        "runtime": runtime,
+        "project_config": runtime.project_config,
+    }
+
+    if script:
+        if python:
+            raise click.UsageError("Cannot specify both --script and --python")
+        runpy.run_path(script, init_globals=variables)
+    elif python:
+        exec(python, variables)
+    else:
+        code.interact(local=variables)
+
+
+# Top Level Groups
+
+cli.add_command(error)
+cli.add_command(project)
+cli.add_command(org)
+cli.add_command(service)
+cli.add_command(task)
+cli.add_command(flow)
+cli.add_command(plan)
+cli.add_command(robot)