Current File : //usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyc
�
���^c @@ sP d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z d d l m Z m
Z
d d l Z d d l
Z d d l Z d d l Z d d l Z d d l m Z e j e � Z d Z d � Z d � Z d � Z d
� Z d � Z d � Z d
� Z d � Z d � Z d � Z d � Z! d e" f d � � YZ# d e" f d � � YZ$ d S( u�
A module for testing the logic of states and highstates
:codeauthor: William Cannon <william.cannon@gmail.com>
:maturity: new
Saltcheck provides unittest like functionality requiring only the knowledge of
salt module execution and yaml.
In order to run state and highstate saltcheck tests a sub-folder of a state must
be created and named ``saltcheck-tests``.
Tests for a state should be created in files ending in ``*.tst`` and placed in
the ``saltcheck-tests`` folder.
Multiple tests can be created in a file. Multiple ``*.tst`` files can be
created in the ``saltcheck-tests`` folder. Salt rendering is supported in test
files (e.g. ``yaml + jinja``). The ``id`` of a test works in the same manner as
in salt state files. They should be unique and descriptive.
Example file system layout:
.. code-block: txt
/srv/salt/apache/
init.sls
config.sls
saltcheck-tests/
pkg_and_mods.tst
config.tst
Example:
.. code-block:: yaml
echo-test-hello:
module_and_function: test.echo
args:
- "hello"
kwargs:
assertion: assertEqual
expected-return: 'hello'
i ( t absolute_importt unicode_literalst print_functionN( t loadst dumps( t sixu saltcheckc C@ s t S( u6
Check dependencies - may be useful in future
( t __virtualname__( ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt __virtual__C s c C@ s t d � t S( uL
Updates the master cache onto the minion - transfers all salt-check-tests
Should be done one time before running tests, and if tests are updated
Can be automated by setting "auto_update_master_cache: True" in minion config
CLI Example:
.. code-block:: bash
salt '*' saltcheck.update_master_cache
u cp.cache_master( t __salt__t True( ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt update_master_cacheJ s c K@ sE t � } | j d d � } | r= t | t � r= | j | � Sd Sd S( um
Execute one saltcheck test and return result
:param keyword arg test:
CLI Example:
.. code-block:: bash
salt '*' saltcheck.run_test
test='{"module_and_function": "test.echo",
"assertion": "assertEqual",
"expected-return": "This works!",
"args":["This works!"] }'
u testu Test must be a dictionaryN( t SaltCheckt gett Nonet
isinstancet dictt run_test( t kwargst scheckt test( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyR Z s
c C@ s� t � } | j � } t d | � } i } t | � } x} | D]u } | j | � } | j | � | j � i } x6 | j j � D]% \ } }
| j |
� } | | | <q W| | | <q= Wd } d }
d } x� | D]� } t
| | j � � d k r� | d } q� xi | | j � D]W \ } } t j d | | � | j
d � rJ| d } n | j
d � r|
d }
qqWq� Wg } x. | j � D] \ } }
| j i |
| 6� q�W| j � | j i i | d 6|
d 6| d 6d
6� | S( u�
Execute all tests for a salt state and return results
Nested states will also be tested
:param str state: the name of a user defined state
CLI Example:
.. code-block:: bash
salt '*' saltcheck.run_state_tests postfix
t search_pathsi i u dummy=%s, val=%su Passu Failu Passedu Failedu
Missing Testsu TEST RESULTS( R t get_state_search_path_listt StateTestLoadert _get_state_slst convert_sls_to_patht add_test_files_for_slst load_test_suitet test_dictt itemsR t lent logt infot
startswitht appendt sort( t stateR t pathst stlt resultst sls_listt
state_namet mypatht results_dictt keyt valuet resultt passedt failedt
missing_testst dummyt valt out_list( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt run_state_testss s@
)c C@ s) t � } | j � } t d | � } i } t � } g } xG | D]? } t | � } x* | D]" } | | k rY | j | � qY qY Wq@ Wx} | D]u } | j | � } | j | � | j � i }
x6 | j j
� D]% \ } } | j | � }
|
|
| <q� W|
| | <q� Wd } d } d } x� | D]� } t | | j
� � d k rK| d } q xi | | j
� D]W \ } } t
j d | | � | j d � r�| d } n | j d � r\| d } q\q\Wq Wg } x. | j
� D] \ } } | j i | | 6� q�W| j � | j i i | d 6| d 6| d 6d
6� | S( u�
Execute all tests for a salt highstate and return results
CLI Example:
.. code-block:: bash
salt '*' saltcheck.run_highstate_tests
R i i u dummy=%s, val=%su Passu Failu Passedu Failedu
Missing Testsu TEST RESULTS( R R R t _get_top_statesR R! R R R R R R R R R R R" ( R R$ R% R& R' t
all_statest top_stateR# R( R) R* R+ R, R- R. R/ R0 R1 R2 R3 ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt run_highstate_tests� sL
)c C@ s$ t d | � } t j d | � | S( u0
call the salt utility to render a file
u slsutil.rendereru rendered: %s( R R R ( t file_patht rendered( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt _render_file� s c C@ s t d � } t | | k � S( u:
Return a list of all modules available on minion
u sys.list_modules( R t bool( t modulet modules( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt _is_valid_module� s
c C@ s t d d � t S( u=
Return the config value of auto_update_master_cache
u
config.getu auto_update_master_cache( R R ( ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt _get_auto_update_cache_value� s c C@ sM y t d | � } Wn t j j k
r6 d g } n Xd j | | � | k S( u7
Determine if a function is valid for a module
u sys.list_functionsu unable to look up functionsu {0}.{1}( R t saltt
exceptionst
SaltExceptiont format( t module_namet functiont functions( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt _is_valid_function� s
c C@ sT g } y3 t d � } x | d D] } | j | � q! WWn t k
rO � n X| S( u;
Equivalent to a salt cli: salt web state.show_top
u state.show_topu base( R R! t Exception( t
alt_statest returnedt i( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyR5 � s
c C@ sj g } yI t d | � } x2 | D]* } | d | k r | j | d � q q WWn t k
re � n X| S( uE
Equivalent to a salt cli: salt web state.show_low_sls STATE
u state.show_low_slsu __sls__( R R! RI ( R# t sls_list_stateRK RL ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyR s
R c B@ s� e Z d Z d � Z d � Z d � Z d � Z e d � � Z e d � � Z e d � � Z
e d � � Z e d � � Z e d
� � Z
e d � � Z e d � � Z e d
� � Z e d � � Z e d � � Z e d � � Z RS( u-
This class implements the saltcheck
c C@ se g | _ g | _ i | _ i | _ d j � | _ t | _ t j j
� | _ | j ra t � n d S( Nu, assertEqual assertNotEqual
assertTrue assertFalse
assertIn assertNotIn
assertGreater
assertGreaterEqual
assertLess assertLessEqual(
RM R> R* t results_dict_summaryt splitt assertions_listR@ t auto_update_master_cacheRA t clientt Callert salt_lcR
( t self( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt __init__ s c C@ s, d } | j d d
� } | j d d
� } | j d d
� } t j d | � | r� | d 7} | j d � \ } } t | � r� | d 7} n t | | � r� | d 7} n t j d � n | r� | d 7} | | j k r� | d 7} t j d � q� n | r| d 7} t j d
� n t j d | � | d k S( u�
Determine if a test contains:
- a test name
- a valid module and function
- a valid assertion
- an expected return value
i u module_and_functionu assertionu expected-returnu __is_valid_test has test: %si u .u! __is_valid_test has valid m_and_fu# __is_valid_test has valid_assertionu) __is_valid_test has valid_expected_returnu __is_valid_test score: %si N( R R
R R RO R? RH RP ( RU R t totst m_and_ft assertiont expected_returnR= RF ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt __is_valid_test1 s.
c C@ s� t } y� | r0 | r0 | j j | | | � } n\ | rU | rU | j j | | � } n7 | rz | rz | j j | | � } n | j j | � } Wn- t j j k
r� � n t k
r� � n X| S( u5
Generic call of salt Caller command
( t FalseRT t cmdRA RB RC RI ( RU t funt argsR R, ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt call_salt_commandR s
c C@ s� | j | � r�| d } | j d d � } | j d d � } | d } | d } | j | | | � } | d k r� | j | | � } n | d k r� | j | | � } q�| d k r� | j | | � } q�| d k r� | j | � } q�| d
k r| j | � } q�| d k r&| j | | � } q�| d k rG| j
| | � } q�| d k rh| j | | � } q�| d
k r�| j | | � } q�| d k r�| j
| | � } q�| d k r�| j | | � } q�d } n d S| S( u-
Run a single saltcheck test
u module_and_functionu argsu kwargsu assertionu expected-returnu assertInu assertEqualu assertNotEqualu
assertTrueu assertFalseu assertNotInu
assertGreateru assertGreaterEqualu
assertLessu assertLessEqualu Fail - bas assertionu Fail - invalid testN( t _SaltCheck__is_valid_testR R
R` t cast_expected_to_returned_typet _SaltCheck__assert_equalt _SaltCheck__assert_not_equalt _SaltCheck__assert_truet _SaltCheck__assert_falset _SaltCheck__assert_int _SaltCheck__assert_not_int _SaltCheck__assert_greatert _SaltCheck__assert_greater_equalt _SaltCheck__assert_lesst _SaltCheck__assert_less_equal( RU R t mod_and_funcR_ R RY RZ t
actual_returnR, ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyR i s@
c C@ s� t | � } | } | d k r3 | t k r3 t } n y | | � } Wnj t k
r� t j d � t j d | � t j d t | � � t j d | � t j d t | � � n X| S( ut
Determine the type of variable returned
Cast the expected to the type of variable returned
u Falseu- Unable to cast expected into type of returnedu
returned = %su type of returned = %su
expected = %su type of expected = %s( t typeR< R\ t
ValueErrorR R ( t expectedRK t ret_typet new_expected( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyRb � s
c C@ s[ d } y( | | k s- t d j | | � � � Wn& t k
rV } d t j | � } n X| S( u/
Test if two objects are equal
u Passu {0} is not equal to {1}u Fail: ( t AssertionErrorRD R t text_type( Rq RK R- t err( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt __assert_equal� s (c C@ s[ d } y( | | k s- t d j | | � � � Wn& t k
rV } d t j | � } n X| S( u3
Test if two objects are not equal
u Passu {0} is equal to {1}u Fail: ( Rt RD R Ru ( Rq RK R- Rv ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt __assert_not_equal� s (c C@ sX d } y% | t k s* t d j | � � � Wn& t k
rS } d t j | � } n X| S( u,
Test if an boolean is True
u Passu {0} not Trueu Fail: ( R Rt RD R Ru ( RK R- Rv ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt
__assert_true� s %c C@ s� d } t | t � r? y t | � } Wq? t k
r; � q? Xn y% | t k sc t d j | � � � Wn& t k
r� } d t j | � } n X| S( u-
Test if an boolean is False
u Passu
{0} not Falseu Fail: ( R t strR< Rp R\ Rt RD R Ru ( RK R- Rv ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt __assert_false� s
%c C@ sX d } y% | | k s* t d j | � � � Wn& t k
rS } d t j | � } n X| S( uC
Test if a value is in the list of returned values
u Passu
{0} not Falseu Fail: ( Rt RD R Ru ( Rq RK R- Rv ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt __assert_in� s %c C@ sX d } y% | | k s* t d j | � � � Wn& t k
rS } d t j | � } n X| S( uG
Test if a value is not in the list of returned values
u Passu
{0} not Falseu Fail: ( Rt RD R Ru ( Rq RK R- Rv ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt __assert_not_in� s %c C@ sX d } y% | | k s* t d j | � � � Wn& t k
rS } d t j | � } n X| S( uD
Test if a value is greater than the returned value
u Passu
{0} not Falseu Fail: ( Rt RD R Ru ( Rq RK R- Rv ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt __assert_greater� s %c C@ sX d } y% | | k s* t d j | � � � Wn& t k
rS } d t j | � } n X| S( uP
Test if a value is greater than or equal to the returned value
u Passu
{0} not Falseu Fail: ( Rt RD R Ru ( Rq RK R- Rv ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt __assert_greater_equal� s %c C@ sX d } y% | | k s* t d j | � � � Wn& t k
rS } d t j | � } n X| S( uA
Test if a value is less than the returned value
u Passu
{0} not Falseu Fail: ( Rt RD R Ru ( Rq RK R- Rv ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt
__assert_less
s %c C@ sX d } y% | | k s* t d j | � � � Wn& t k
rS } d t j | � } n X| S( uM
Test if a value is less than or equal to the returned value
u Passu
{0} not Falseu Fail: ( Rt RD R Ru ( Rq RK R- Rv ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt __assert_less_equal s %c C@ s� g } t j d d � } t d } | rT | t j d t j | } | j | � n | t j d t j d } | j | � | S( uX
For the state file system, return a list of paths to search for states
u cachediru saltenvu filesu baseN( t __opts__R R
t ost sepR! ( t search_listt cachedirt environmentt path( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyR " s
( t __name__t
__module__t __doc__RV Ra R` R t staticmethodRb Rc Rd Re Rf Rg Rh Ri Rj Rk Rl R ( ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyR s" ! '
R c B@ sb e Z d Z d � Z d � Z d � Z d � Z d � Z e d � � Z e d � � Z
d � Z RS( uh
Class loads in test files for a state
e.g. state_dir/saltcheck-tests/[1.tst, 2.tst, 3.tst]
c C@ s( | | _ d | _ g | _ i | _ d S( N( R R
t path_typet
test_filesR ( RU R ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyRV 9 s c C@ s7 i | _ x | j D] } | j | � q Wg | _ d S( uD
Load tests either from one file, or a set of files
N( R R� t load_file_salt_rendered( RU t myfile( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyR ? s c C@ s yn t d | d � �U } t j j j t j j j | � � } x' | j � D] \ } } | | j | <qJ WWd QXWn
� n Xd S( u(
loads in one test file
u files.fopenu rN( t __utils__RA t utilst datat decodet yamlt safe_loadR R ( RU t filepathR� t
contents_yamlR+ R, ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt load_fileI s $c C@ sL t | � } t t | � � } x' | j � D] \ } } | | j | <q+ Wd S( u(
loads in one test file
N( R; R R R R ( RU R� t testst mydictR+ R, ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyR� X s
c C@ s� g | _ t j d t j � � | t j d } | } x| t j j j | � D]e \ } } } xS | D]K } | j
d � rb | t j | } t j j | � } | j j | � qb qb WqL Wd S( u/
Gather files for a test suite
u gather_files: %su saltcheck-testsu .tstN(
R� R R t timeR� R� RA R� R� t os_walkt endswitht abspathR! ( RU R� t rootdirt dirnameR1 t filelistt fnamet
start_patht full_path( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt gather_filesd s %
c C@ s= g } x0 | D]( } | j d t j � } | j | � q
W| S( u)
Converting sls to paths
u .( t replaceR� R� R! ( R' t new_sls_listt sls( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt convert_sls_to_pathsu s
c C@ s | j d t j � } | S( u)
Converting sls to paths
u .( R� R� R� ( R� ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyR � s c C@ s� x� | j D]� } | t j | } | } t j j | � r� t j d | � x� t j j j | d t
�D]b \ } } } d | k r� | j | � t j d | j � t j d | � n t j d | � | 2qe Wq
t j d | � q
Wd S( u#
Adding test files
u searching path= %st topdownu saltcheck-testsu test_files list: %su found subdir match in = %su! did not find subdir match in = %su path is not a directory= %sN(
R R� R� R� t isdirR R RA R� R� R R� R� ( RU t sls_pathR� R� R� R� t
subdirlistR1 ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyR � s +
( R� R� R� RV R R� R� R� R� R� R R ( ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyR 3 s
(% R� t
__future__R R R t loggingR� R� t jsonR R t salt.utils.filesRA t salt.utils.patht salt.utils.yamlt salt.clientt salt.exceptionst salt.extR t getLoggerR� R R R R
R R4 R8 R; R? R@ RH R5 R t objectR R ( ( ( s: /usr/lib/python2.7/site-packages/salt/modules/saltcheck.pyt <module>- s6 0 4
�
Mini Shell