cumulusci-plus 5.0.0__py3-none-any.whl

cumulusci/utils/tests/test_org_schema_models.py

@@ -0,0 +1,79 @@
+import pytest
+
+from cumulusci.salesforce_api.org_schema_models import SObject
+
+
+class TestOrgSchemaModels:
+    def test_sobject__eq__true(self):
+        a = SObject(name="foo", createable=False)
+        b = SObject(name="foo", createable=False)
+        assert a == b
+
+    def test_sobject__eq__false(self):
+        a = SObject(name="foo", createable=False)
+        b = SObject(name="bar", createable=False)
+        assert a != b
+        b = SObject(name="bar", createable=True)
+        assert a != b
+
+    def test_repr(self):
+        a = SObject(name="foo", createable=False)
+        r = repr(a)
+        assert "foo" in r
+        assert "createable" in r
+
+    def test_roundtrip_mappings(self, temp_db):
+        with temp_db() as (connection, metadata, session):
+            session.add(SObject(name="Foo", urls={"a": "b"}))
+            session.commit()
+        with temp_db() as (connection, metadata, session):
+            foo = session.query(SObject).one()
+            assert foo["name"] == "Foo"
+            assert foo["urls"] == {"a": "b"}
+
+    def test_roundtrip_mappings__empty(self, temp_db):
+        # with temp_db() as open_db:
+        with temp_db() as (connection, metadata, session):
+            session.add(SObject(name="Foo", urls={}))
+            session.commit()
+        with temp_db() as (connection, metadata, session):
+            foo = session.query(SObject).one()
+            assert foo["name"] == "Foo"
+            assert foo["urls"] == {}
+            assert session.execute("select urls from sobjects").first()["urls"] is None
+
+    def test_roundtrip_sequences(self, temp_db):
+        # with temp_db() as open_db:
+        with temp_db() as (connection, metadata, session):
+            session.add(
+                SObject(name="Foo", childRelationships=[("a", "b"), ("c", "d")])
+            )
+            session.commit()
+        with temp_db() as (connection, metadata, session):
+            foo = session.query(SObject).one()
+            assert foo["name"] == "Foo"
+            assert foo["childRelationships"] == (("a", "b"), ("c", "d"))
+
+    def test_roundtrip_sequences__empty(self, temp_db):
+        with temp_db() as (connection, metadata, session):
+            session.add(SObject(name="Foo", childRelationships=[]))
+            session.commit()
+        with temp_db() as (connection, metadata, session):
+            foo = session.query(SObject).one()
+            assert foo["name"] == "Foo"
+            assert foo["childRelationships"] == ()
+            assert (
+                session.execute("select childRelationships from sobjects").first()[
+                    "childRelationships"
+                ]
+                is None
+            )
+
+    def test_getattr_getitem(self):
+        so = SObject(name="Foo", childRelationships=[])
+        assert so.name == so["name"]
+        with pytest.raises(KeyError):
+            so["aaa"]
+
+        with pytest.raises(AttributeError):
+            so.aaa

cumulusci/utils/tests/test_waiting.py

@@ -0,0 +1,25 @@
+from unittest import mock
+
+import pytest
+
+from cumulusci.utils.waiting import poll, retry
+
+
+def test_retry(caplog):
+    func = mock.Mock(side_effect=[Exception, 42])
+    assert retry(func) == 42
+    assert "Sleeping for 5 seconds before retry..." in caplog.text
+    assert "Retrying (4 attempts remaining)" in caplog.text
+
+
+def test_retry__limit():
+    func = mock.Mock(side_effect=Exception)
+    with pytest.raises(Exception):
+        retry(func, retries=0)
+    assert func.call_count == 1
+
+
+def test_poll():
+    func = mock.Mock(side_effect=[False, False, False, True])
+    poll(func)
+    assert func.call_count == 4

cumulusci/utils/version_strings.py

@@ -0,0 +1,391 @@
+#
+# From https://github.com/python/cpython/blob/b07f546ea3a574bc3016fb023c157c65a47f4849/Lib/distutils/version.py
+#
+# PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
+# --------------------------------------------
+
+# 1. This LICENSE AGREEMENT is between the Python Software Foundation
+# ("PSF"), and the Individual or Organization ("Licensee") accessing and
+# otherwise using this software ("Python") in source or binary form and
+# its associated documentation.
+
+# 2. Subject to the terms and conditions of this License Agreement, PSF hereby
+# grants Licensee a nonexclusive, royalty-free, world-wide license to reproduce,
+# analyze, test, perform and/or display publicly, prepare derivative works,
+# distribute, and otherwise use Python alone or in any derivative version,
+# provided, however, that PSF's License Agreement and PSF's notice of copyright,
+# i.e., "Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010,
+# 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022 Python Software Foundation;
+# All Rights Reserved" are retained in Python alone or in any derivative version
+# prepared by Licensee.
+
+# 3. In the event Licensee prepares a derivative work that is based on
+# or incorporates Python or any part thereof, and wants to make
+# the derivative work available to others as provided herein, then
+# Licensee hereby agrees to include in any such work a brief summary of
+# the changes made to Python.
+
+# 4. PSF is making Python available to Licensee on an "AS IS"
+# basis.  PSF MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR
+# IMPLIED.  BY WAY OF EXAMPLE, BUT NOT LIMITATION, PSF MAKES NO AND
+# DISCLAIMS ANY REPRESENTATION OR WARRANTY OF MERCHANTABILITY OR FITNESS
+# FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF PYTHON WILL NOT
+# INFRINGE ANY THIRD PARTY RIGHTS.
+
+# 5. PSF SHALL NOT BE LIABLE TO LICENSEE OR ANY OTHER USERS OF PYTHON
+# FOR ANY INCIDENTAL, SPECIAL, OR CONSEQUENTIAL DAMAGES OR LOSS AS
+# A RESULT OF MODIFYING, DISTRIBUTING, OR OTHERWISE USING PYTHON,
+# OR ANY DERIVATIVE THEREOF, EVEN IF ADVISED OF THE POSSIBILITY THEREOF.
+
+# 6. This License Agreement will automatically terminate upon a material
+# breach of its terms and conditions.
+
+# 7. Nothing in this License Agreement shall be deemed to create any
+# relationship of agency, partnership, or joint venture between PSF and
+# Licensee.  This License Agreement does not grant permission to use PSF
+# trademarks or trade name in a trademark sense to endorse or promote
+# products or services of Licensee, or any third party.
+
+# 8. By copying, installing or otherwise using Python, Licensee
+# agrees to be bound by the terms and conditions of this License
+# Agreement.
+
+#
+# distutils/version.py
+#
+# Implements multiple version numbering conventions for the
+# Python Module Distribution Utilities.
+#
+# $Id$
+#
+
+"""Provides classes to represent module version numbers (one class for
+each style of version numbering).  There are currently two such classes
+implemented: StrictVersion and LooseVersion.
+
+Every version number class implements the following interface:
+  * the 'parse' method takes a string and parses it to some internal
+    representation; if the string is an invalid version number,
+    'parse' raises a ValueError exception
+  * the class constructor takes an optional string argument which,
+    if supplied, is passed to 'parse'
+  * __str__ reconstructs the string that was passed to 'parse' (or
+    an equivalent string -- ie. one that will generate an equivalent
+    version number instance)
+  * __repr__ generates Python code to recreate the version number instance
+  * _cmp compares the current instance with either another instance
+    of the same class or a string (which will be parsed to an instance
+    of the same class, thus must follow the same rules)
+"""
+
+import re
+
+
+class Version:
+    """Abstract base class for version numbering classes.  Just provides
+    constructor (__init__) and reproducer (__repr__), because those
+    seem to be the same for all version numbering classes; and route
+    rich comparisons to _cmp.
+    """
+
+    def __init__(self, vstring=None):
+        if vstring:
+            self.parse(vstring)
+
+    def __repr__(self):
+        return "%s ('%s')" % (self.__class__.__name__, str(self))
+
+    def __eq__(self, other):
+        c = self._cmp(other)
+        if c is NotImplemented:
+            return c
+        return c == 0
+
+    def __lt__(self, other):
+        c = self._cmp(other)
+        if c is NotImplemented:
+            return c
+        return c < 0
+
+    def __le__(self, other):
+        c = self._cmp(other)
+        if c is NotImplemented:
+            return c
+        return c <= 0
+
+    def __gt__(self, other):
+        c = self._cmp(other)
+        if c is NotImplemented:
+            return c
+        return c > 0
+
+    def __ge__(self, other):
+        c = self._cmp(other)
+        if c is NotImplemented:
+            return c
+        return c >= 0
+
+
+# Interface for version-number classes -- must be implemented
+# by the following classes (the concrete ones -- Version should
+# be treated as an abstract class).
+#    __init__ (string) - create and take same action as 'parse'
+#                        (string parameter is optional)
+#    parse (string)    - convert a string representation to whatever
+#                        internal representation is appropriate for
+#                        this style of version numbering
+#    __str__ (self)    - convert back to a string; should be very similar
+#                        (if not identical to) the string supplied to parse
+#    __repr__ (self)   - generate Python code to recreate
+#                        the instance
+#    _cmp (self, other) - compare two version numbers ('other' may
+#                        be an unparsed version string, or another
+#                        instance of your version class)
+
+
+class StrictVersion(Version):
+
+    """Version numbering for anal retentives and software idealists.
+    Implements the standard interface for version number classes as
+    described above.  A version number consists of two or three
+    dot-separated numeric components, with an optional "pre-release" tag
+    on the end.  The pre-release tag consists of the letter 'a' or 'b'
+    followed by a number.  If the numeric components of two version
+    numbers are equal, then one with a pre-release tag will always
+    be deemed earlier (lesser) than one without.
+
+    The following are valid version numbers (shown in the order that
+    would be obtained by sorting according to the supplied cmp function):
+
+        0.4       0.4.0  (these two are equivalent)
+        0.4.1
+        0.5a1
+        0.5b3
+        0.5
+        0.9.6
+        1.0
+        1.0.4a3
+        1.0.4b1
+        1.0.4
+
+    The following are examples of invalid version numbers:
+
+        1
+        2.7.2.2
+        1.3.a4
+        1.3pl1
+        1.3c4
+
+    The rationale for this version numbering system will be explained
+    in the distutils documentation.
+    """
+
+    version_re = re.compile(
+        r"^(\d+) \. (\d+) (\. (\d+))? ([ab](\d+))?$", re.VERBOSE | re.ASCII
+    )
+
+    def parse(self, vstring):
+        match = self.version_re.match(vstring)
+        if not match:
+            raise ValueError("invalid version number '%s'" % vstring)
+
+        (major, minor, patch, prerelease, prerelease_num) = match.group(1, 2, 4, 5, 6)
+
+        if patch:
+            self.version = tuple(map(int, [major, minor, patch]))
+        else:
+            self.version = tuple(map(int, [major, minor])) + (0,)
+
+        if prerelease:
+            self.prerelease = (prerelease[0], int(prerelease_num))
+        else:
+            self.prerelease = None
+
+    def __str__(self):
+
+        if self.version[2] == 0:
+            vstring = ".".join(map(str, self.version[0:2]))
+        else:
+            vstring = ".".join(map(str, self.version))
+
+        if self.prerelease:
+            vstring = vstring + self.prerelease[0] + str(self.prerelease[1])
+
+        return vstring
+
+    def _cmp(self, other):
+        if isinstance(other, str):
+            other = StrictVersion(other)
+        elif not isinstance(other, StrictVersion):
+            return NotImplemented
+
+        if self.version != other.version:
+            # numeric versions don't match
+            # prerelease stuff doesn't matter
+            if self.version < other.version:
+                return -1
+            else:
+                return 1
+
+        # have to compare prerelease
+        # case 1: neither has prerelease; they're equal
+        # case 2: self has prerelease, other doesn't; other is greater
+        # case 3: self doesn't have prerelease, other does: self is greater
+        # case 4: both have prerelease: must compare them!
+
+        if not self.prerelease and not other.prerelease:
+            return 0
+        elif self.prerelease and not other.prerelease:
+            return -1
+        elif not self.prerelease and other.prerelease:
+            return 1
+        elif self.prerelease and other.prerelease:
+            if self.prerelease == other.prerelease:
+                return 0
+            elif self.prerelease < other.prerelease:
+                return -1
+            else:
+                return 1
+        else:
+            assert False, "never get here"
+
+
+# end class StrictVersion
+
+
+# The rules according to Greg Stein:
+# 1) a version number has 1 or more numbers separated by a period or by
+#    sequences of letters. If only periods, then these are compared
+#    left-to-right to determine an ordering.
+# 2) sequences of letters are part of the tuple for comparison and are
+#    compared lexicographically
+# 3) recognize the numeric components may have leading zeroes
+#
+# The LooseVersion class below implements these rules: a version number
+# string is split up into a tuple of integer and string components, and
+# comparison is a simple tuple comparison.  This means that version
+# numbers behave in a predictable and obvious way, but a way that might
+# not necessarily be how people *want* version numbers to behave.  There
+# wouldn't be a problem if people could stick to purely numeric version
+# numbers: just split on period and compare the numbers as tuples.
+# However, people insist on putting letters into their version numbers;
+# the most common purpose seems to be:
+#   - indicating a "pre-release" version
+#     ('alpha', 'beta', 'a', 'b', 'pre', 'p')
+#   - indicating a post-release patch ('p', 'pl', 'patch')
+# but of course this can't cover all version number schemes, and there's
+# no way to know what a programmer means without asking him.
+#
+# The problem is what to do with letters (and other non-numeric
+# characters) in a version number.  The current implementation does the
+# obvious and predictable thing: keep them as strings and compare
+# lexically within a tuple comparison.  This has the desired effect if
+# an appended letter sequence implies something "post-release":
+# eg. "0.99" < "0.99pl14" < "1.0", and "5.001" < "5.001m" < "5.002".
+#
+# However, if letters in a version number imply a pre-release version,
+# the "obvious" thing isn't correct.  Eg. you would expect that
+# "1.5.1" < "1.5.2a2" < "1.5.2", but under the tuple/lexical comparison
+# implemented here, this just isn't so.
+#
+# Two possible solutions come to mind.  The first is to tie the
+# comparison algorithm to a particular set of semantic rules, as has
+# been done in the StrictVersion class above.  This works great as long
+# as everyone can go along with bondage and discipline.  Hopefully a
+# (large) subset of Python module programmers will agree that the
+# particular flavour of bondage and discipline provided by StrictVersion
+# provides enough benefit to be worth using, and will submit their
+# version numbering scheme to its domination.  The free-thinking
+# anarchists in the lot will never give in, though, and something needs
+# to be done to accommodate them.
+#
+# Perhaps a "moderately strict" version class could be implemented that
+# lets almost anything slide (syntactically), and makes some heuristic
+# assumptions about non-digits in version number strings.  This could
+# sink into special-case-hell, though; if I was as talented and
+# idiosyncratic as Larry Wall, I'd go ahead and implement a class that
+# somehow knows that "1.2.1" < "1.2.2a2" < "1.2.2" < "1.2.2pl3", and is
+# just as happy dealing with things like "2g6" and "1.13++".  I don't
+# think I'm smart enough to do it right though.
+#
+# In any case, I've coded the test suite for this module (see
+# ../test/test_version.py) specifically to fail on things like comparing
+# "1.2a2" and "1.2".  That's not because the *code* is doing anything
+# wrong, it's because the simple, obvious design doesn't match my
+# complicated, hairy expectations for real-world version numbers.  It
+# would be a snap to fix the test suite to say, "Yep, LooseVersion does
+# the Right Thing" (ie. the code matches the conception).  But I'd rather
+# have a conception that matches common notions about version numbers.
+
+
+class LooseVersion(Version):
+
+    """Version numbering for anarchists and software realists.
+    Implements the standard interface for version number classes as
+    described above.  A version number consists of a series of numbers,
+    separated by either periods or strings of letters.  When comparing
+    version numbers, the numeric components will be compared
+    numerically, and the alphabetic components lexically.  The following
+    are all valid version numbers, in no particular order:
+
+        1.5.1
+        1.5.2b2
+        161
+        3.10a
+        8.02
+        3.4j
+        1996.07.12
+        3.2.pl0
+        3.1.1.6
+        2g6
+        11g
+        0.960923
+        2.2beta29
+        1.13++
+        5.5.kw
+        2.0b1pl0
+
+    In fact, there is no such thing as an invalid version number under
+    this scheme; the rules for comparison are simple and predictable,
+    but may not always give the results you want (for some definition
+    of "want").
+    """
+
+    component_re = re.compile(r"(\d+ | [a-z]+ | \.)", re.VERBOSE)
+
+    def __init__(self, vstring=None):
+        if vstring:
+            self.parse(vstring)
+
+    def parse(self, vstring):
+        # I've given up on thinking I can reconstruct the version string
+        # from the parsed tuple -- so I just store the string here for
+        # use by __str__
+        self.vstring = vstring
+        components = [x for x in self.component_re.split(vstring) if x and x != "."]
+        for i, obj in enumerate(components):
+            try:
+                components[i] = int(obj)
+            except ValueError:
+                pass
+
+        self.version = components
+
+    def __str__(self):
+        return self.vstring
+
+    def __repr__(self):
+        return "LooseVersion ('%s')" % str(self)
+
+    def _cmp(self, other):
+        if isinstance(other, str):
+            other = LooseVersion(other)
+        elif not isinstance(other, LooseVersion):
+            return NotImplemented
+
+        if self.version == other.version:
+            return 0
+        if self.version < other.version:
+            return -1
+        if self.version > other.version:
+            return 1

cumulusci/utils/waiting.py

@@ -0,0 +1,42 @@
+import logging
+import time
+from typing import Callable
+
+logger = logging.getLogger(__name__)
+
+
+def retry(
+    func: Callable,
+    should_retry: Callable[[Exception], bool] = lambda e: True,
+    retries: int = 5,
+    retry_interval: int = 5,
+    retry_interval_add: int = 30,
+):
+    while True:
+        try:
+            return func()
+            break
+        except Exception as e:
+            if not (retries and should_retry(e)):
+                raise
+            if retry_interval:
+                logger.warning(f"Sleeping for {retry_interval} seconds before retry...")
+                time.sleep(retry_interval)
+                if retry_interval_add:
+                    retry_interval += retry_interval_add
+            retries -= 1
+            logger.warning(f"Retrying ({retries} attempts remaining)")
+
+
+def poll(action: Callable):
+    """poll for a result in a loop"""
+    count = 0
+    interval = 1
+    while True:
+        count += 1
+        complete = action()
+        if complete:
+            break
+        time.sleep(interval)
+        if count % 3 == 0:
+            interval += 1

cumulusci/utils/xml/__init__.py

@@ -0,0 +1,91 @@
+import typing as T
+import xml.etree.ElementTree as etree
+from pathlib import Path
+
+from lxml import etree as lxml_etree
+
+UTF8 = "UTF-8"
+
+
+def elementtree_parse_file(
+    path: T.Union[str, Path, T.IO], namespace=None
+) -> etree.ElementTree:
+    """Parse a file from filename, Path or Stream using Python stdlib.
+
+    All else equal, prefer elementtree over LXML for performance and simplicity reasons."""
+    try:
+        if namespace:
+            etree.register_namespace("", namespace)
+        tree = etree.parse(path)
+    except etree.ParseError as err:
+        err.filename = path
+        raise err
+    return tree
+
+
+def lxml_parse_file(path: T.Union[str, Path, T.IO]) -> lxml_etree._ElementTree:
+    """Parse a file from filename, Path or stream using lxml for richer API
+
+    Use this if you need advanced xpath and parent-pointer features.
+    Otherwise prefer elementree_parse_file for performance and simplicity reasons."""
+    parser = lxml_etree.XMLParser(
+        resolve_entities=False, load_dtd=False, no_network=True
+    )
+    try:
+        if isinstance(path, Path):
+            path = str(path)
+        tree = lxml_etree.parse(path, parser=parser)
+    except etree.ParseError as err:
+        err.filename = path
+        raise err
+    return tree
+
+
+elementtree_parse_string = etree.fromstring
+
+
+def lxml_parse_string(string: str) -> lxml_etree._ElementTree:
+    """Parse a string using lxml for richer API
+
+    Use this if you need advanced xpath and parent-pointer features.
+    Otherwise prefer elementree_parse_string for performance and simplicity reasons."""
+
+    parser = lxml_etree.XMLParser(
+        resolve_entities=False, load_dtd=False, no_network=True
+    )
+    return lxml_etree.ElementTree(lxml_etree.fromstring(string, parser=parser))
+
+
+def remove_xml_element_file(name: str, path: T.Union[str, Path]):
+    """Remove XML elements from a single file"""
+    etree.register_namespace("", "http://soap.sforce.com/2006/04/metadata")
+    tree = elementtree_parse_file(path)
+    tree = remove_xml_element(name, tree)
+    return tree.write(path, encoding=UTF8, xml_declaration=True)
+
+
+def remove_xml_element_string(name: str, content: str):
+    """Remove XML elements from a string"""
+    etree.register_namespace("", "http://soap.sforce.com/2006/04/metadata")
+    tree = etree.fromstring(content)
+    tree = remove_xml_element(name, tree)
+    clean_content = etree.tostring(tree, encoding=UTF8)
+    return clean_content
+
+
+def remove_xml_element(name: str, tree):
+    """Removes XML elements from an ElementTree content tree"""
+    # root = tree.getroot()
+    remove = tree.findall(
+        ".//{{http://soap.sforce.com/2006/04/metadata}}{}".format(name)
+    )
+    if not remove:
+        return tree
+
+    parent_map = {c: p for p in tree.iter() for c in p}
+
+    for elem in remove:
+        parent = parent_map[elem]
+        parent.remove(elem)
+
+    return tree