3
\me4
@ s d Z ddlZddlZddlZddlZddlmZ ddlmZ ddl m
Z
m Z ej e
ZejdddgZd d
ZG d d d eZdddd
ddddddddd ddZdddZd ddZdd Zd ddZdS ) z9Common utility functions for interacting with subprocess. N)ENOEXEC)
TextIOWrapper)ListUnion
SubpResultstdoutstderrc C s g }g }g }x|D ]}t |trT|d dkr:|dd }q|d | kr|jd| n6t |trz|j| ds|j| n|jt| q|j| qW |rtjd| | dj| |rt dj
| dj|d|S ) a Ensure user-provided commands start with base_command; warn otherwise.
Each command is either a list or string. Perform the following:
- If the command is a list, pop the first element if it is None
- If the command is a list, insert base_command as the first element if
not present.
- When the command is a string not starting with 'base-command', warn.
Allow flexibility to provide non-base-command environment/config setup if
needed.
@commands: List of commands. Each command element is a list or string.
@return: List of 'fixed up' commands.
@raise: TypeError on invalid config item type.
r N z Non-%s commands in %s config:
%s
zHInvalid {name} config. These commands are not a string or list:
{errors})nameerrors)
isinstancelistinsertstr
startswithappendLOGwarningjoin TypeErrorformat)Z base_commandZcommandswarningsr
Zfixed_commandscommand r /usr/lib/python3.6/subp.pyprepend_base_command s4
r c @ sH e Zd ZdZdZd ddZdd Zd
eee f eee f d d
d Z
dS )ProcessExecutionErrorzr%(description)s
Command: %(cmd)s
Exit code: %(exit_code)s
Reason: %(reason)s
Stdout: %(stdout)s
Stderr: %(stderr)s-Nc C s |p| j | _|r|| _n | r.|tkr.d| _nd| _t|trB|n| j | _|sd|d kr\| j n|| _n | j|| _|s|d kr| j n|| _ n | j|| _ |p| j | _
|r|| _ | j | j
| j| j
| j| j
| j| j
| j | j
| j| j
| j
d }tj| | d S )Nz(Exec format error. Missing #! in script?z'Unexpected error while running command.) descriptioncmd exit_coder r reason)
empty_attrr! r r r intr" r _indent_textr r# errno MESSAGE_TMPL_ensure_stringIOError__init__) selfr r r" r! r r# r' messager r r r+ O s0
z ProcessExecutionError.__init__c C s t |tr|j S |S )z1
if data is bytes object, decode
)r bytesdecode)r, textr r r r) ~ s z$ProcessExecutionError._ensure_string )r0 returnc C s> t |ts$|jdjddd| S |jdjddd| S )z
indent text on all but the first line, allowing for easy to read output
remove any newlines at end of text first to prevent unneeded blank
line in output
r r
)r r. rstripreplace)r, r0 Z indent_levelr r r r& s
z"ProcessExecutionError._indent_text)NNNNNNN)r1 ) __name__
__module__ __qualname__r( r$ r+ r) r r r. r& r r r r r D s
' r TFr6 ) datarcsenvcapturecombine_captureshell logstringr/ target
update_env status_cbcwdc s | dk rt d|dkr dg}d}
|
rF|dkr4tj}|j }|j|
t| dkrbd| gt| } | rt| trzdj| n| }| dj |d |st
j d | |||rd
n| n t
j d | d}d}|rt j
}t j
}|rt j
}t j}|dkrttj}
|
}nt j
}t|ts|j }t| tr&| }n&t| tr>| jd }nd
d | D }zy*t j||||||| d}|j|\}}W n\ tk
r } z>| r| d t| ||j rdnd rdndd|W Y dd}~X nX W d|
r|
j X |s|r
|s d}|s
d} r.d fdd }||}||}|j}||krd| rT| dj |d t|||| d| rz| dj |d t||S ) a Run a subprocess.
:param args: command to run in a list. [cmd, arg1, arg2...]
:param data: input to the command, made available on its stdin.
:param rcs:
a list of allowed return codes. If subprocess exits with a value not
in this list, a ProcessExecutionError will be raised. By default,
data is returned as a string. See 'decode' parameter.
:param env: a dictionary for the command's environment.
:param capture:
boolean indicating if output should be captured. If True, then stderr
and stdout will be returned. If False, they will not be redirected.
:param combine_capture:
boolean indicating if stderr should be redirected to stdout. When True,
interleaved stderr and stdout will be returned as the first element of
a tuple, the second will be empty string or bytes (per decode).
if combine_capture is True, then output is captured independent of
the value of capture.
:param shell: boolean indicating if this should be run with a shell.
:param logstring:
the command will be logged to DEBUG. If it contains info that should
not be logged, then logstring will be logged instead.
:param decode:
if False, no decoding will be done and returned stdout and stderr will
be bytes. Other allowed values are 'strict', 'ignore', and 'replace'.
These values are passed through to bytes().decode() as the 'errors'
parameter. There is no support for decoding to other than utf-8.
:param target:
not supported, kwarg present only to make function signature similar
to curtin's subp.
:param update_env:
update the enviornment for this command with this dictionary.
this will not affect the current processes os.environ.
:param status_cb:
call this fuction with a single string argument before starting
and after finishing.
:param cwd:
change the working directory to cwd before executing the command.
:return
if not capturing, return is (None, None)
if capturing, stdout and stderr are returned.
if decode:
entries in tuple will be string
if not decode:
entries in tuple will be bytes
Nz&target arg not supported by cloud-initr /chrootr
z Begin run command: {command}
)r zFRunning command %s with allowed return codes %s (shell=%s, capture=%s)ZcombinezFRunning hidden command to protect sensitive input/output logstring: %sutf-8c S s$ g | ] }t |tr|n|jd qS )zutf-8)r r. encode).0xr r r
s zsubp..)r r stdinr< r? rD z1ERROR: End run command: invalid command provided
r -)r! r# r' r r c s t | tr| j| S | S )N)r r. r/ )r: m)r/ r r ldecode8 s zsubp..ldecodez%ERROR: End run command: exit({code})
)code)r r r" r! z End run command: exit({code})
)rG )
ValueErrorosenvironcopyupdate target_pathr r r r r debug
subprocessPIPEZSTDOUTopendevnullr. rH r PopenZ communicateOSErrorr r' close
returncoder )argsr: r; r< r= r> r? r@ r/ rA rB rC rD Z
devnull_fpr r r rL Z
bytes_argsZspouterrerP Zrcr )r/ r subp s B
re c C s | dkrd} n.PATHrf rE c S s g | ]}|j d r|qS )rE )r )rI rl r r r rK m s c S s g | ]}t jj|qS r )rS rg rh )rI rl r r r rK p s )
rW rS rg sepis_exerT getsplitpathsepr )ZprogramsearchrA pathsrg Zppathr r r which_ s
ru c C s t jj| ot j| t jS )N)rS rg isfileaccessX_OK)Zfpathr r r ro z s ro c C s& |rt jj| rd S g }g }|d kr,g }n.t|trBt|g}nt|trR|}ntdxtt j| D ]}t jj | |}t
|r|j | yt ||g dd W q t
k
r } ztj| |j | W Y d d }~X qX qjtjd| qjW |o|r"tdt| ddj | dt| d d S )
Nz%exe_prefix must be None, str, or listF)r= zjskipping %s as its not executable or the underlying file system is mounted without executable permissions.z
Runparts: z failures (,z) in z attempted commands)rS rg isdirr r r r sortedlistdirr ro r re r r rX r RuntimeErrorri ) ZdirpZ
skip_no_existZ
exe_prefixZfailedZ attemptedprefixZexe_nameZexe_pathrd r r r runparts s4
r )N)NN)TN)__doc__ collectionsZloggingrS rY r' r ior Ztypingr r Z getLoggerr7 r
namedtupler r r* r re rW ru ro r r r r r s8
3Q +