Current File : //usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyo
�
���^c @@ sl 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 Z d d l m
Z
d d l m Z e j
e � Z e d � Z e d d � Z d d � Z d
� Z d � Z d � Z d
� Z d 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 � Z$ d � Z% d � Z& d � Z' d � Z( d S( u�
Module for low-level interaction with JbossAS7 through CLI.
This module exposes two ways of interaction with the CLI, either through commands or operations.
.. note:: Following JBoss documentation (https://developer.jboss.org/wiki/CommandLineInterface):
"Operations are considered a low level but comprehensive way to manage the AS controller, i.e. if it can't be done with operations it can't be done in any other way.
Commands, on the other hand, are more user-friendly in syntax,
although most of them still translate into operation requests and some of them even into a few
composite operation requests, i.e. commands also simplify some management operations from the user's point of view."
The difference between calling a command or operation is in handling the result.
Commands return a zero return code if operation is successful or return non-zero return code and
print an error to standard output in plain text, in case of an error.
Operations return a json-like structure, that contain more information about the result.
In case of a failure, they also return a specific return code. This module parses the output from the operations and
returns it as a dictionary so that an execution of an operation can then be verified against specific errors.
In order to run each function, jboss_config dictionary with the following properties must be passed:
* cli_path: the path to jboss-cli script, for example: '/opt/jboss/jboss-7.0/bin/jboss-cli.sh'
* controller: the IP address and port of controller, for example: 10.11.12.13:9999
* cli_user: username to connect to jboss administration console if necessary
* cli_password: password to connect to jboss administration console if necessary
Example:
.. code-block:: yaml
jboss_config:
cli_path: '/opt/jboss/jboss-7.0/bin/jboss-cli.sh'
controller: 10.11.12.13:9999
cli_user: 'jbossadm'
cli_password: 'jbossadm'
i ( t absolute_importt print_functiont unicode_literalsN( t CommandExecutionError( t sixc C@ sX t | | � } | d d k r, t | d <n( | rJ t d j | � � � n
t | d <| S( u�
Execute a command against jboss instance through the CLI interface.
jboss_config
Configuration dictionary with properties specified above.
command
Command to execute against jboss instance
fail_on_error (default=True)
Is true, raise CommandExecutionError exception if execution fails.
If false, 'success' property of the returned dictionary is set to False
CLI Example:
.. code-block:: bash
salt '*' jboss7_cli.run_command '{"cli_path": "integration.modules.sysmod.SysModuleTest.test_valid_docs", "controller": "10.11.12.13:9999", "cli_user": "jbossadm", "cli_password": "jbossadm"}' my_command
u retcodei u successuV Command execution failed, return code={retcode}, stdout='{stdout}', stderr='{stderr}' ( t
__call_clit TrueR t formatt False( t jboss_configt commandt
fail_on_errort cli_command_result( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyt run_command7 s
i c C@ s) t | | | � } | d d k ru t | d � rY t | d � } | d d k | d <q%t d j | d � � � n� t | d � r� t | d � } t | d <t j d | d � } | j d � | d
<| d | d <nL | r� t d j | � � � n. i t d 6| d d 6| d d 6| d d 6} | S(
u
Execute an operation against jboss instance through the CLI interface.
jboss_config
Configuration dictionary with properties specified above.
operation
An operation to execute against jboss instance
fail_on_error (default=True)
Is true, raise CommandExecutionError exception if execution fails.
If false, 'success' property of the returned dictionary is set to False
retries:
Number of retries in case of "JBAS012144: Could not connect to remote" error.
CLI Example:
.. code-block:: bash
salt '*' jboss7_cli.run_operation '{"cli_path": "integration.modules.sysmod.SysModuleTest.test_valid_docs", "controller": "10.11.12.13:9999", "cli_user": "jbossadm", "cli_password": "jbossadm"}' my_operation
u retcodei u stdoutu outcomeu successu. Operation has returned unparseable output: {0}u ^(JBAS\d+):u failure-descriptioni u err_codeuV Command execution failed, return code={retcode}, stdout='{stdout}', stderr='{stderr}' u stderr( R t _is_cli_outputt _parseR R R t ret searcht group( R t operationR t retriesR t
cli_resultt match( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyt
run_operationV s(
c C@ s� | d d d j | d � g } d t j | � k rR | j d j | d � � n d t j | � k r� | j d j | d � � n | j d j t | � � � d
j | � } t d | � } t j d | � t j d
| d � t j d | d � t j d | d � | d d k r:t d j d | d � � � n | d d k rrd | d k rrt d j | � � � n | d d k r�d | d k r�| d k r�t j d | � t
j d � t | | | d � S| S( Nu cli_pathu --connectu --controller="{0}"u
controlleru cli_useru --user="{0}"u cli_passwordu --password="{0}"u --command="{0}"u u cmd.run_allu cli_command_result=%su ========= STDOUT:
%su stdoutu ========= STDERR:
%su stderru ========= RETCODE: %du retcodei uw Could not execute jboss-cli.sh script. Have you specified server_dir variable correctly?
Current CLI path: {cli_path}. t cli_pathi u) Unable to authenticate against controlleru� Could not authenticate against controller, please check username and password for the management console. Err code: {retcode}, stdout: {stdout}, stderr: {stderr}u
JBAS012144i u+ Command failed, retrying... (%d tries left)i (
R R t iterkeyst appendt __escape_commandt joint __salt__t logt debugR t timet sleepR ( R R
R t command_segmentst
cli_scriptR ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR � s. ,
c C@ s( | j d d � } | j d d � } | S( u�
This function escapes the command so that can be passed in the command line to JBoss CLI.
Escaping commands passed to jboss is extremely confusing.
If you want to save a binding that contains a single backslash character read the following explanation.
A sample value, let's say "a" (with single backslash), that is saved in the config.xml file:
<bindings>
<simple name="java:/app/binding1" value="a"/>
</bindings>
Eventhough it is just a single "" if you want to read it from command line you will get:
/opt/jboss/jboss-eap-6.0.1/bin/jboss-cli.sh --connect --controller=ip_addr:9999 --user=user --password=pass --command="/subsystem=naming/binding="java:/app/binding1":read-resource"
{
"outcome" => "success",
"result" => {
"binding-type" => "simple",
"value" => "a\b"
}
}
So, now you have two backslashes in the output, even though in the configuration file you have one.
Now, if you want to update this property, the easiest thing to do is to create a file with appropriate command:
/tmp/update-binding.cli:
----
/subsystem=naming/binding="java:/app/binding1":write-attribute(name=value, value="a\\b")
----
And run cli command:
${JBOSS_HOME}/bin/jboss-cli.sh --connect --controller=ip_addr:9999 --user=user --password=pass --file="/tmp/update-binding.cli"
As you can see, here you need 4 backslashes to save it as one to the configuration file. Run it and go to the configuration file to check.
(You may need to reload jboss afterwards: ${JBOSS_HOME}/bin/jboss-cli.sh --connect --controller=ip_addr:9999 --user=user --password=pass --command=":reload" )
But if you want to run the same update operation directly from command line, prepare yourself for more escaping:
${JBOSS_HOME}/bin/jboss-cli.sh --connect --controller=ip_addr:9999 --user=user --password=pass --command="/subsystem=naming/binding="java:/app/binding1":write-attribute(name=value, value="a\\\\b")"
So, here you need 8 backslashes to force JBoss to save it as one.
To sum up this behavior:
(1) 1 backslash in configuration file
(2) 2 backslashes when reading
(3) 4 backslashes when writing from file
(4) 8 backslashes when writing from command line
... are all the same thing:)
Remember that the command that comes in is already (3) format. Now we need to escape it further to be able to pass it to command line.
u \u \\u "u \"( t replace( R
t result( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR � s /c C@ s0 t j d t j � } | j | � r( t St Sd S( Nu ^\s*{.+}\s*$( R t compilet DOTALLR R R ( t textt cli_re( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR � s c C@ s6 t | � } t | � } t j d t j | � � | S( Nu === RESULT: ( t
__tokenizet __process_tokensR R t pprintt pformat( t
cli_outputt tokensR% ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR � s c C@ s t | � \ } } | S( N( t __process_tokens_internal( R/ R% t token_no( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR+ � s c C@ sT t | | � r, | d k r, t | d d �St j d | � | } i } d } x�| t | � k rO| | } t j d | | � t | � r� t j d � | d k r� t | � } t j d | � qBt | � | | <t j d | | | � d } nNt | � r@t j d | � t | � | | <t j d | | | � d } nt
| � r�t j d
� t | � | | <t j d | | | � d } n�t | � r�t j d � t
| � | | <t j d | | | � d } npt | � rt j d � t | � | | <t j d | | | � d } n't | � rWt j d
� t j d | � d | | <d } n� t | � r�t j d � t | d | d �\ } } t j d | � | | | <t j d | | | � d } n| t | � r�t j d � | | f St | � r t j d � t } n7 t | � r-t j d � t } n t d j | � � � | d } qQ Wd S( Ni t start_ati u __process_tokens, start_at=%su PROCESSING TOKEN %d: %su TYPE: QUOTED STRING u KEY: %su %s -> %su TYPE: DATATYPE: %s u TYPE: BOOLEAN u TYPE: INT u TYPE: LONG u TYPE: UNDEFINED u+ %s -> undefined (Adding as None to map)u TYPE: DICT STARTu DICT = %s u TYPE: DICT ENDu TYPE: ASSIGNMENTu TYPE: EXPRESSIONu Unknown token! Token: {0}( t __is_dict_startR0 R R t Nonet lent __is_quoted_stringt __get_quoted_stringt
__is_datatypet __get_datatypet __is_booleant
__get_booleant __is_intt __get_intt __is_longt
__get_longt __is_undefinedt
__is_dict_endt __is_assignmentR t __is_expressionR R ( R/ R2 R1 R% t current_keyt tokent
dict_valuet
is_assignmentt
is_expression( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR0 � sx
c C@ s8 t j d t j � } | j | � } t j d | � | S( NuA ("(?:[^"\\]|\\"|\\\\)*"|=>|{|}|true|false|undefined|[0-9A-Za-z]+)u tokens=%s( R R& R' t findallR R ( R. t tokens_reR/ ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR* 6 s c C@ s
| d k S( Nu {( ( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR3 ? s c C@ s
| d k S( Nu }( ( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyRA C s c C@ s | d k p | d k S( Nu trueu false( ( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR: G s c C@ s
| d k S( Nu true( ( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR; K s c C@ s
| j � S( N( t isdigit( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR< O s c C@ s
t | � S( N( t int( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR= S s c C@ s! | d d !j � o | d d k S( Ni i����u L( RK ( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR> W s c C@ s/ t j r t | d d !� St | d d !� Sd S( Ni i����( R t PY2t longRL ( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR? [ s c C@ s
| d k S( Nu INTu BOOLEANu STRINGu OBJECTu LONG( u INTu BOOLEANu STRINGu OBJECTu LONG( ( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR8 b s c C@ s | S( N( ( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR9 f s c C@ s
| d k S( Nu undefined( ( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR@ j s c C@ s | d d k o | d d k S( Ni u "i����( ( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR6 n s c C@ s# | d d !} | j d d � } | S( Ni i����u \\u \( R$ ( RE R% ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyR7 r s
c C@ s
| d k S( Nu =>( ( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyRB x s c C@ s
| d k S( Nu
expression( ( RE ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyRC | s () t __doc__t
__future__R R R t loggingR R, R t salt.exceptionsR t salt.extR t getLoggert __name__R R R
R R R R R R+ R0 R* R3 RA R: R; R< R= R> R? R8 R9 R@ R6 R7 RB RC ( ( ( s; /usr/lib/python2.7/site-packages/salt/modules/jboss7_cli.pyt <module>% s@ 1 # 4 C
Mini Shell