o

�N�g?4�@s�dZd
dl
Z
d
dlZd
dlmZ
d
dlmZ
dd�Zdd�Z	d	d
�Z
dd�Zd
d�Zddd�
Z
ddd�
Zddd�
Zddd�
Zdd�Z							d dd�
ZdS)!a�
Test States
===========

Provide test case states that enable easy testing of things to do with state
calls, e.g. running, calling, logging, output filtering etc.

.. code-block:: yaml

    always-passes-with-any-kwarg:
      test.nop:
        - name: foo
        - something: else
        - foo: bar

    always-passes:
      test.succeed_without_changes:
        - name: foo

    always-fails:
      test.fail_without_changes:
        - name: foo

    always-changes-and-succeeds:
      test.succeed_with_changes:
        - name: foo

    always-changes-and-fails:
      test.fail_with_changes:
        - name: foo

    my-custom-combo:
      test.configurable_test_state:
        - name: foo
        - changes: True
        - result: False
        - comment: bar.baz
        - warnings: A warning

    is-pillar-foo-present-and-bar-is-int:
      test.check_pillar:
        - present:
            - foo
        - integer:
            - bar

You may also use these states for controlled failure in state definitions, for example if certain conditions in
pillar or grains do not apply. The following state definition will fail with a message "OS not supported!" when
`grains['os']` is neither Ubuntu nor CentOS:

.. code-block:: jinja

    {% if grains['os'] in ['Ubuntu', 'CentOS'] %}

    # Your state definitions go here

    {% else %}
    failure:
      test.fail_without_changes:
        - name: "OS not supported!"
        - failhard: True
    {% endif %}

�N�
�SaltInvocationError)
�_gen_tagc
Kst|�
S)
a

    .. versionadded:: 2015.8.1

    A no-op state that does nothing. Useful in conjunction with the ``use``
    requisite, or in templates which could otherwise be empty due to jinja
    rendering.

    name
        A unique string to serve as the state's ID
    )
�succeed_without_changes)�name�kwargs�r�D/opt/saltstack/salt/lib/python3.10/site-packages/salt/states/test.py�nopIsr
c
Ks|
�d
d�}|id|d�}|S)zy
    .. versionadded:: 2014.7.0

    Returns successful

    name
        A unique string to serve as the state's ID
    �comment�Success!T�r�changes�resultr)
�get�rrr�retrrr	rWs	
rc
Ks6|
�d
d�}|id|d�}t
drd|d<d|d
<|S)zv
    .. versionadded:: 2014.7.0

    Returns failure

    name
        A unique string to serve as the state's ID
    r�Failure!Fr
�testrz/If we weren't testing, this would be a failure!�r�__opts__rrrr	�fail_without_changesfs	

rc
K�H|
�d
d�}|id|d�}dddd�i
|d	<t
d
r"d|d<d
|d
<|S)z�
    .. versionadded:: 2014.7.0

    Returns ``True`` with an non-empty ``changes`` dictionary. Useful for
    testing requisites.

    name
        A unique string to serve as the state's ID
    rrTr
�testing�	Unchanged�Something pretended to change��old�newrrNrz<If we weren't testing, this would be successful with changesrrrrr	�succeed_with_changesz�

�

rc
Kr)z�
    .. versionadded:: 2014.7.0

    Returns ``False`` with an non-empty ``changes`` dictionary. Useful for
    testing requisites.

    name
        A unique string to serve as the state's ID
    rrFr
rrrrrrNrz8If we weren't testing, this would be failed with changesrrrrr	�fail_with_changes�r r!T�cCs
|id
|d�}dddd�i
}|
dur||d<n|
d
urnt|
�
�
�d	kr.t�d
�
r-||d<nd}t|�
�
t|t�r>||d<nt|�
�
�d	krNt�d
�
|d<ntd
�
�
|durWnt|t�rb|g
|d<nt|t�rl||d<ntd�
�
tdr�|
d
urzdn
d|d<|s�dn
||d<|S)a
    .. versionadded:: 2014.7.0

    A configurable test state which allows for more control over the return
    data

    name
        A unique string to serve as the state's ID

    changes : True
        Controls whether or not the state reports that there were changes.
        There are three supported values for this argument:

        - If ``True``, the state will report changes
        - If ``False``, the state will report no changes
        - If ``"Random"``, the state will randomly report either changes or no
          changes.

    result : True
        Controls the result for for the state. Like ``changes``, there are
        three supported values for this argument:

        - If ``True``, the state will report a ``True`` result
        - If ``False``, the state will report a ``False`` result
        - If ``"Random"``, the state will randomly report either ``True``

        .. note::
            The result will be reported as ``None`` if *all* of the following
            are true:

            1. The state is being run in test mode (i.e. ``test=True`` on the
            CLI)

            2. ``result`` is ``True`` (either explicitly, or via being set to
               ``"Random"``)

            3. ``changes`` is ``True`` (either explicitly, or via being set to
               ``"Random"``)

    comment : ""
        Comment field field for the state. By default, this is an empty string.

    warnings
        A string (or a list of strings) to fill the warnings field with.
        Default is None

        .. versionadded:: 3000
    Fr
rrrrTr�random)TFzpYou have specified the state option 'changes' with invalid arguments. It must be either True, False, or 'Random'rzoYou have specified the state option 'result' with invalid arguments. It must be either True, False, or 'Random'N�warningszoYou have specified the state option 'warnings' with invalid arguments. It must be a string or a list of stringsrzThis is a testr)	�str�lowerr#�choicer�
isinstance�bool�listr)rrrrr$rZchange_data�errrrr	�configurable_test_state�sD1
�



��




�








�

r,cKs|
std
�
�
|id|
d�}|S)z�
    .. versionadded:: 2015.8.0

    Simple notification using text argument.

    name
        A unique string to serve as the state's ID

    text
        Text to return in the comment field
    �Missing required argument text.Tr
r)r�textrrrrr	�show_notification
s

r/cKsvg}d
tvr$td
dD]}t
|�
}t|dr#|�djdi|�
�
�

q||�dd�|�dd�|�dd	|i
�d
�}|S)
aM
    Call this function via a watch statement

    .. versionadded:: 2014.7.0

    Any parameters in the state return dictionary can be customized by adding
    the keywords ``result``, ``comment``, and ``changes``.

    .. code-block:: yaml

        this_state_will_return_changes:
          test.succeed_with_changes

        this_state_will_NOT_return_changes:
          test.succeed_without_changes

        this_state_is_watching_another_state:
          test.succeed_without_changes:
            - comment: 'This is a custom comment'
            - watch:
              - test: this_state_will_return_changes
              - test: this_state_will_NOT_return_changes

        this_state_is_also_watching_another_state:
          test.succeed_without_changes:
            - watch:
              - test: this_state_will_NOT_return_changes
    Z__reqs__Zwatchrz{state}: {__id__}rTrzWatch statement fired.zRequisites with changes)rrrrNr)Z__low__rZ__running__�append�formatr)rZsfunrZhas_changesZreq�tagrrrr	�	mod_watch2
s




�




�r3cCs4td
|d�}|dur
dS|
du
rt
||
�sdSdS)z�
    Helper function to get pillar[key_str] and
    check if its type is key_type

    Returns None if the pillar key is missing.
    If present True or False depending on match
    of the values type.

    Can't check for None.
    z
pillar.getNFT)Z__salt__r()Zkey_str�key_type�valuerrr	�_check_key_type_
s



r6c

Cs6t|t
�r
tjj�|�
g
St|t�st�
tjj�	|�
S)
z
    Checks if its argument is a list or a str.
    A str will be turned into a list with the
    str as its only element.
    )
r(r%�salt�utilsZstringutilsZ
to_unicoder*�	TypeError�dataZdecode_list)
�listingrrr	�_if_str_then_lists
s






r<FcCs�
|
s|s|s|s|s|std
�
�
|
pg}
|pg}|pg}|pg}|p#g}|p'g}|iddd�}i}	i}
i}t
|
�
}
|
|	d<t
|�
}||	t<t
|�
}||	t<t
|�
}||	tf
<t
|�
}||	t<t
|�
}||	t<|	��D],\}}
|
D]%}t||�}|dur�d||<d|d<qp|s�|||<d|d<qp|r�||
|<qpqj|��D]#\}}d|�d	�}|dur�|d
7}n|d|�d�7}|d
|7<q�|r�|
r�d}|
��D]\}}|d|�d|�d�7}q�|d
|7<|S)a�

    Checks the presence and, optionally, the type of given keys in Pillar

    Supported kwargs for types are:
    - boolean (bool)
    - integer (int)
    - string (str)
    - listing (list)
    - dictionary (dict)

    Checking for None type pillars is not implemented yet.

    .. code-block:: yaml

        is-pillar-foo-present-and-bar-is-int:
          test.check_pillar:
            - present:
                - foo
            - integer:
                - bar
    r-Tr"r
NFrzPillar key "z" zis missing.
zis not z.
rzThose keys passed the check:
z- z (z)
)	rr<r)�intr%r*�dict�itemsr6)rZpresentZboolean�integer�stringr;Z
dictionary�verboserZchecksZfineZfailedr4�keys�keyrrrrr	�check_pillar�
sb




























��








rE)TTr"N)
N)NNNNNNF)�__doc__r#Zsalt.utils.datar7Zsalt.exceptionsrZ
salt.staterr
rrrr!r,r/r3r6r<rErrrr	�<module>
s.A



m

-





�