CasperSecurity
o
�b�a � @ s� d Z ddlZddlmZmZmZ ddlmZ ddlm Z ddl
m Z ddl m
Z
mZ ddlmZ dd lmZ G d
d � d �ZG d d
� d
ee�ZG dd� dej�ZG dd� dej�ZdS )z&
Tests for L{twisted.runner.procmon}.
� N)� ProcessDone�ProcessExitedAlready�ProcessTerminated)�Clock)�globalLogPublisher)�Failure)�LoggingProtocol�ProcessMonitor)�
MemoryReactor)�unittestc @ s> e Zd ZdZdZdZdZ d dd�Zdd� Zd d
� Z dS ) � DummyProcessa
An incomplete and fake L{IProcessTransport} implementation for testing how
L{ProcessMonitor} behaves when its monitored processes exit.
@ivar _terminationDelay: the delay in seconds after which the DummyProcess
will appear to exit when it receives a TERM signal
� Nr c C s@ || _ || _|| _|| _|| _|| _|| _|| _| | _|
| _ d S �N)
�proto�_reactor� _executable�_args� _environment�_path�_uid�_gid�_usePTY� _childFDs) �self�reactor�
executable�args� environment�pathr �uid�gid�usePTY�childFDs� r# �B/usr/lib/python3/dist-packages/twisted/runner/test/test_procmon.py�__init__ s
zDummyProcess.__init__c C sP | j dfdd�}| jdu rt� �||v r&|| \}}| j�|| j|�| _dS dS )a�
A partial implementation of signalProcess which can only handle TERM and
KILL signals.
- When a TERM signal is given, the dummy process will appear to exit
after L{DummyProcess._terminationDelay} seconds with exit code 0
- When a KILL signal is given, the dummy process will appear to exit
immediately with exit code 1.
@param signalID: The signal name or number to be issued to the process.
@type signalID: C{str}
r �r r
)�TERM�KILLN)�_terminationDelay�pidr r � callLater� processEnded�_signalHandler)r �signalID�params�delay�statusr# r# r$ �
signalProcess: s
��zDummyProcess.signalProcessc C s, d| _ ttd�}| j�t|| |��� dS )zC
Deliver the process ended event to C{self.proto}.
Nr& )r* r r r r, r )r r1 � statusMapr# r# r$ r, Q s
� zDummyProcess.processEnded)NNr N)
�__name__�
__module__� __qualname__�__doc__r* r r) r% r2 r, r# r# r# r$ r s
� r c @ s0 e Zd ZdZdd� Zdi dddddfdd�ZdS ) �DummyProcessReactorz�
@ivar spawnedProcesses: a list that keeps track of the fake process
instances built by C{spawnProcess}.
@type spawnedProcesses: C{list}
c C s t �| � t�| � g | _d S r )r
r% r �spawnedProcesses�r r# r# r$ r% d s
z DummyProcessReactor.__init__r# Nr c
C s4 t | ||||||||| �
}
|�|
� | j�|
� |
S )zz
Fake L{reactor.spawnProcess}, that logs all the process
arguments and returns a L{DummyProcess}.
)r �makeConnectionr9 �append) r �processProtocolr r �envr r r r! r" �procr# r# r$ � spawnProcessj s �
z DummyProcessReactor.spawnProcess)r4 r5 r6 r7 r% r@ r# r# r# r$ r8 ] s
�r8 c @ s e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zdd� Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� Zd&d'� Zd(d)� Zd*d+� Zd,d-� Zd.d/� Zd0d1� Zd2d3� Z d4d5� Z d6d7� Z d8d9� Z d:d;� Z d<d=� Z!d>d?� Z"d@dA� Z#dBS )C� ProcmonTestsz&
Tests for L{ProcessMonitor}.
c C s2 t � | _t| jd�| _d| j_d| j_d| j_dS )zL
Create an L{ProcessMonitor} wrapped around a fake reactor.
�r � �
N)r8 r r �pm�minRestartDelay�maxRestartDelay� thresholdr: r# r# r$ �setUp� s
zProcmonTests.setUpc C sL | j jdddgddi d� t| j �}| �d|� | �d|� | �d|� d S )
z+
Repr includes all details
�foo�arg1�arg2r
rC �r r r> �1�2N)rE �
addProcess�repr�assertIn�r �representationr# r# r$ �test_reprLooksGood� s
z ProcmonTests.test_reprLooksGoodc C s< | j jdddgi d� t| j �}| �d|� | �d|� dS )z�
Repr does not include unneeded details.
Values of attributes that just mean "inherit from launching
process" do not appear in the repr of a process.
rJ rK rL )r> �(�)N)rE rP rQ � assertNotInrS r# r# r$ �test_simpleReprLooksGood� s
z%ProcmonTests.test_simpleReprLooksGoodc C sD | j jdddgddi d� | �| j �� d dddgddi fi� dS ) zW
The list of monitored processes must be included in the pickle state.
rJ rK rL r
rC rM � processesN)rE rP � assertEqual� __getstate__r: r# r# r$ � test_getStateIncludesProcesses� s �z+ProcmonTests.test_getStateIncludesProcessesc C s | � d| j�� � dS )z~
The private L{ProcessMonitor._reactor} instance variable should not be
included in the pickle state.
r N)rX rE r\ r: r# r# r$ � test_getStateExcludesReactor� � z)ProcmonTests.test_getStateExcludesReactorc C s~ | j jdddgddi d� | �| j ji � | �| j jdddgddi fi� | j �� | j�d� | �t| j j� � �dg� dS ) z�
L{ProcessMonitor.addProcess} only starts the named program if
L{ProcessMonitor.startService} has been called.
rJ rK rL r
rC rM r N)
rE rP r[ � protocolsrZ � startServicer �advance�list�keysr: r# r# r$ �test_addProcess� s
z ProcmonTests.test_addProcessc C s> | j jdddgddi d� | jt| j jdddgddi d� dS )z|
L{ProcessMonitor.addProcess} raises a C{KeyError} if a process with the
given name already exists.
rJ rK rL r
rC rM N)rE rP � assertRaises�KeyErrorr: r# r# r$ � test_addProcessDuplicateKeyError� s
�z-ProcmonTests.test_addProcessDuplicateKeyErrorc C sP ddi}| j �� | j jddgdd|d� | j�d� | �| jjd j|� dS ) z�
L{ProcessMonitor.addProcess} takes an C{env} parameter that is passed to
L{IReactorProcess.spawnProcess}.
�KEY�valuerJ r
rC rM r N)rE ra rP r rb r[ r9 r )r �fakeEnvr# r# r$ �test_addProcessEnv� s
z ProcmonTests.test_addProcessEnvc C sD | j �� | j jddgdd� | j�d� | �| jjd jd� dS )z�
L{ProcessMonitor.addProcess} takes an C{cwd} parameter that is passed
to L{IReactorProcess.spawnProcess}.
rJ z /mnt/lala)�cwdr N)rE ra rP r rb r[ r9 r r: r# r# r$ �test_addProcessCwd� s
z ProcmonTests.test_addProcessCwdc C sR | j �� | j �ddg� | �t| j j�d� | j �d� | �t| j j�d� dS )zm
L{ProcessMonitor.removeProcess} removes the process from the public
processes list.
rJ r
r N)rE ra rP r[ �lenrZ �
removeProcessr: r# r# r$ �test_removeProcess� s
z ProcmonTests.test_removeProcessc C s | j �� | �t| j jd� dS )zz
L{ProcessMonitor.removeProcess} raises a C{KeyError} if the given
process name isn't recognised.
rJ N)rE ra rf rg rp r: r# r# r$ �!test_removeProcessUnknownKeyError� s
z.ProcmonTests.test_removeProcessUnknownKeyErrorc C sH | j �ddg� | j �d� | �| j jd t� | �d| j j�� � dS )a
When a process has been started, an instance of L{LoggingProtocol} will
be added to the L{ProcessMonitor.protocols} dict and the start time of
the process will be recorded in the L{ProcessMonitor.timeStarted}
dictionary.
rJ N) rE rP � startProcess�assertIsInstancer` r rR � timeStartedrd r: r# r# r$ �test_startProcess� s z ProcmonTests.test_startProcessc C s2 | j �ddg� | j �d� | �| j �d�� dS )zr
L{ProcessMonitor.startProcess} silently returns if the named process is
already started.
rJ N)rE rP rs � assertIsNoner: r# r# r$ � test_startProcessAlreadyStarted s z,ProcmonTests.test_startProcessAlreadyStartedc C � | � t| jjd� dS )zy
L{ProcessMonitor.startProcess} raises a C{KeyError} if the given
process name isn't recognised.
rJ N)rf rg rE rs r: r# r# r$ � test_startProcessUnknownKeyError r_ z-ProcmonTests.test_startProcessUnknownKeyErrorc C s� | j �� | j �ddg� | �d| j j� d }| j jd j_| j�| j j � | j �
d� | j�|� | � | j� � | j j
d � dS )zm
L{ProcessMonitor.stopProcess} immediately sends a TERM signal to the
named process.
rJ r
N)rE ra rP rR r` � transportr) r rb rH � stopProcessr[ �secondsru )r � timeToDier# r# r$ �"test_stopProcessNaturalTermination s
z/ProcmonTests.test_stopProcessNaturalTerminationc C s� | j �� | j �ddg� | �d| j j� | j�| j j� | j jd j}| j j d |_
| j � d� | j�| j j d � | � d| j j
d � | j�d� | � | j�� | j j
d � dS )z�
L{ProcessMonitor.stopProcess} kills a process which fails to terminate
naturally within L{ProcessMonitor.killTime} seconds.
rJ r
g N)rE ra rP rR r` r rb rH r{ �killTimer) r| r[ ru r} )r r? r# r# r$ �test_stopProcessForcedKill4 s
z'ProcmonTests.test_stopProcessForcedKillc C ry )zx
L{ProcessMonitor.stopProcess} raises a C{KeyError} if the given process
name isn't recognised.
rJ N)rf rg rE r| r: r# r# r$ � test_stopProcessUnknownKeyErrorJ r_ z,ProcmonTests.test_stopProcessUnknownKeyErrorc C s& | j �ddg� | �| j �d�� dS )z�
L{ProcessMonitor.stopProcess} silently returns if the named process
is already stopped. eg Process has crashed and a restart has been
rescheduled, but in the meantime, the service is stopped.
rJ N)rE rP rw r| r: r# r# r$ � test_stopProcessAlreadyStoppedQ s z+ProcmonTests.test_stopProcessAlreadyStoppedc C �� g }| � tj|j� t�|j� | j�ddg� | j�� | j� d� | �
d| jj � | j� | jj � | jj d �
d� | �t|�d� |d d }|d d }|d d }|d d }| �|d � | �|d
� | �|d� | �|d � d S )
zS
Getting a complete output line on stdout generates a log message.
rJ r �
hello world!
r
�
log_namespace�stream�tag�line�%twisted.runner.procmon.ProcessMonitor�stdout� hello world!N)�
addCleanupr �removeObserverr< � addObserverrE rP ra r rb rR r` rH � outReceived� assertEqualsro �r �events� namespacer� r� r� r# r# r$ � test_outputReceivedCompleteLineZ �$
z,ProcmonTests.test_outputReceivedCompleteLinec C r� )
zS
Getting a complete output line on stderr generates a log message.
rJ r r� r
r� r� r� r� r� �stderrr� N)r� r r� r< r� rE rP ra r rb rR r` rH � errReceivedr� ro r� r# r# r$ �!test_ouputReceivedCompleteErrLineu r� z.ProcmonTests.test_ouputReceivedCompleteErrLinec C s� g }| � tj|j� t�|j� | j�ddg� | j�� | j� d� | �
d| jj � | j� | jj � | jj d �
d� | �t|�d� |d }|d }|d }|d }|d }| �|d � | �|d
� | �|d� | �|td �� d S )
zN
Getting invalid UTF-8 results in the repr of the raw message
rJ r s �hello world!
r
r� r� r� r� r� r� s
�hello world!N)r� r r� r< r� rE rP ra r rb rR r` rH r� r� ro rQ )r r� �messager� r� r� �outputr# r# r$ �*test_outputReceivedCompleteLineInvalidUTF8� s&
z7ProcmonTests.test_outputReceivedCompleteLineInvalidUTF8c C s g }| � tj|j� t�|j� | j�ddg� | j�� | j� d� | �
d| jj � | j� | jj � | jj d �
d� | �t|�d� | jj d �ttd��� | �t|�d� |d d }|d d }|d d }|d d }| �|d � | �|d
� | �|d� | �|d � d S )
zM
Getting partial line results in no events until process end
rJ r s hello world!r
r� r� r� r� r� r� r� N)r� r r� r< r� rE rP ra r rb rR r` rH r� r� ro r, r r r� r# r# r$ � test_outputReceivedPartialLine� s(
z+ProcmonTests.test_outputReceivedPartialLinec C s� | j �ddg� | j �� | j�d� | �d| j j� | j�| j j� | j jd �t t
d��� | � d| j j� | j�d� | �d| j j� dS )z�
L{ProcessMonitor.connectionLost} should immediately restart a process
if it has been running longer than L{ProcessMonitor.threshold} seconds.
rJ r N) rE rP ra r rb rR r` rH r, r r rX r: r# r# r$ �#test_connectionLostLongLivedProcess� s
z0ProcmonTests.test_connectionLostLongLivedProcessc C s� | j �ddg� | j �� | j�d� | j �d� | �d| j j� | j jd }| �|� � � | j�| j j
d j j � | �
|� � � | �d| j j� dS )z�
L{ProcessMonitor.connectionLost} cancels a scheduled process killer and
deletes the DelayedCall from the L{ProcessMonitor.murder} list.
rJ r
N)rE rP ra r rb r| rR �murder�
assertTrue�activer` r{ r) � assertFalserX )r � delayedCallr# r# r$ � test_connectionLostMurderCancel� s
z,ProcmonTests.test_connectionLostMurderCancelc C sj | j �� | j �ddg� | �d| j j� | j jd j�d� | j�| j jd jj � | �
d| j j� dS )z�
L{ProcessMonitor.connectionLost} removes the corresponding
ProcessProtocol instance from the L{ProcessMonitor.protocols} list.
rJ r( N) rE ra rP rR r` r{ r2 r rb r) rX r: r# r# r$ �#test_connectionLostProtocolDeletion� s
z0ProcmonTests.test_connectionLostProtocolDeletionc C s� d| j _d| j _| j �� | j �ddg� | �| j jd | j j� | j�| j j d � | j j
d � t t
d��� | �| j jd | j j� dS )z}
L{ProcessMonitor.connectionLost} will wait at least minRestartDelay s
and at most maxRestartDelay s
rC � rJ r
r N)rE rF rG ra rP r[ r0 r rb rH r` r, r r r: r# r# r$ �%test_connectionLostMinMaxRestartDelay� s
z2ProcmonTests.test_connectionLostMinMaxRestartDelayc C s� | j �� | j �ddg� | j�| j jd � | �d| j j� | �| j j d | j j
� | j jd � t t
d��� | �| j j d | j j
d � dS )z|
L{ProcessMonitor.connectionLost} doubles the restart delay each time
the process dies too quickly.
rJ r
r rC N)rE ra rP r rb rH rR r` r[ r0 rF r, r r r: r# r# r$ �&test_connectionLostBackoffDelayDoubles s
z3ProcmonTests.test_connectionLostBackoffDelayDoublesc C s: | j �ddg� | j �� | j�d� | �d| j j� dS )zP
L{ProcessMonitor.startService} starts all monitored processes.
rJ r N)rE rP ra r rb rR r` r: r# r# r$ �test_startService s
z ProcmonTests.test_startServicec C s� | j �ddg� | j �ddg� | j �� | j�| j j� | �d| j j� | �d| j j� | j�d� | j �� | j�| j j d � | �
i | j j� dS )zT
L{ProcessMonitor.stopService} should stop all monitored processes.
rJ �barr
N) rE rP ra r rb rH rR r` � stopServicer� r[ r: r# r# r$ �test_stopService' s
z ProcmonTests.test_stopServicec C sl | j �ddg� | j �� | j�d� | j �� | j�d� t| jj�}|�� }| � |g � | �
|j � dS )zR
L{ProcessMonitor.restartAll} succeeds when there is one process.
rJ r
N) rE rP ra r rb �
restartAllrc r9 �popr� rw r* )r rZ � myProcessr# r# r$ �!test_restartAllRestartsOneProcess= s
z.ProcmonTests.test_restartAllRestartsOneProcessc C s� | j �ddg� | j �� | j�| j j� | �d| j j� | j�d� | j jd �t t
d��� | � | j j d �
� � | j �� | �| j j d �
� � dS )ze
L{ProcessMonitor.stopService} should cancel any scheduled process
restarts.
rJ r
r N)rE rP ra r rb rH rR r` r, r r r� �restartr� r� r� r: r# r# r$ � test_stopServiceCancelRestartsM s
z+ProcmonTests.test_stopServiceCancelRestartsc C sx d| j _d| j _| j �� | j �ddg� | j�d� | j �d� | j�d� | j �� | j�d� | � | j j
i � dS )ze
L{ProcessMonitor.stopService} should cancel all scheduled process
restarts.
� rJ r
� N) rE rH rF ra rP r rb r| r� r[ r` r: r# r# r$ �(test_stopServiceCleanupScheduledRestartsa s
z5ProcmonTests.test_stopServiceCleanupScheduledRestartsN)$r4 r5 r6 r7 rI rU rY r] r^ re rh rl rn rq rr rv rx rz r r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r# r# r# r$ rA � sD
rA c @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
S ) �DeprecationTestszQ
Tests that check functionality that should be deprecated is deprecated.
c C s t � | _t| jd�| _dS )z5
Create reactor and process monitor.
rB N)r8 r r rE r: r# r# r$ rI s zDeprecationTests.setUpc C sx | j �ddg� | j j}| �t|�d� | �� }d}|D ]}| �|d t� d|d v r.d}q | �|dt |�� �� d S )
a
_Process.toTuple is deprecated.
When getting the deprecated processes property, the actual
data (kept in the class _Process) is converted to a tuple --
which produces a DeprecationWarning per process so converted.
rJ r
F�category�toTupler� Tzno tuple deprecation found:N)
rE rP rZ r� ro �
flushWarnings�assertIs�DeprecationWarningr� rQ )r � myprocesses�warnings� foundToTuple�warningr# r# r$ � test_toTuple� s �z DeprecationTests.test_toTuplec C sF | j j}| �|i � | �� }|�d�}| �|d t� | �|g � dS )a
Accessing L{ProcessMonitor.processes} results in deprecation warning
Even when there are no processes, and thus no process is converted
to a tuple, accessing the L{ProcessMonitor.processes} property
should generate its own DeprecationWarning.
r r� N)rE rZ r� r� r� r� r� )r � myProcessesr� �firstr# r# r$ �test_processes� s
z DeprecationTests.test_processesc C s2 t �| j� | �� }|D ]
}| �|d t� q dS )zO
Pickling an L{ProcessMonitor} results in deprecation warnings
r� N)�pickle�dumpsrE r� r� r� )r r� r� r# r# r$ �
test_getstate� s
�z DeprecationTests.test_getstateN)r4 r5 r6 r7 rI r� r� r� r# r# r# r$ r� y s r� )r7 r� �twisted.internet.errorr r r �twisted.internet.taskr �twisted.loggerr �twisted.python.failurer �twisted.runner.procmonr r �twisted.test.proto_helpersr
�
twisted.trialr r r8 �TestCaserA �SynchronousTestCaser� r# r# r# r$ �<module> s K/ p