CasperSecurity
o
�b(c � @ s d Z ddlZddlZddlZddlZddlZddlZddlmZ ddl
m Z ddl m
Z
ddlmZ ddlmZ ddlmZmZmZ dd lmZ G d
d � d e
�ZG d d
� d
e
�ZG dd� dej�ZdZ dd� Z dd� Z G dd� dej�Z G dd� dej�Z G dd� dej�Z!dS )z"
Tests for Twisted plugin system.
� N)�invalidate_caches)�Callable)� Interface)�plugin)�FilePath)� addObserver�removeObserver�textFromEventDict)�unittestc @ � e Zd ZdZdS )� ITestPluginzS
A plugin for use by the plugin system's unit tests.
Do not use this.
N��__name__�
__module__� __qualname__�__doc__� r r �:/usr/lib/python3/dist-packages/twisted/test/test_plugin.pyr � r c @ r )� ITestPlugin2z
See L{ITestPlugin}.
Nr
r r r r r # r r c @ s� e Zd ZdZdd� Zdd� Zd!dd�Zd d
� Zd efd d
�Z e dd� �Z
dd� Z e dd� �Z e dd� �Z
e dd� �Ze dd� �Ze dd� �Ze d d � �Zd d � Zd S )"� PluginTestsz_
Tests which verify the behavior of the current, active Twisted plugins
directory.
c C s� t jdd� | _t j�� | _t| �� �| _| j� � | j�
d�| _ | j � � | j �
d�� d� tt
��d��| j �
d�� d| _t j�d| jj� ddl}|| _dS ) zV
Save C{sys.path} and C{sys.modules}, and create a package for tests.
N� mypackage� __init__.py� zplugin_basic.pyz
testplugin.py�
testpluginr )�sys�path� originalPath�modules�copy� savedModulesr �mktemp�root�createDirectory�child�package�
setContent�__file__�sibling�copyTo�originalPlugin�insertr �module)�selfr r r r �setUp/ s
�
zPluginTests.setUpc C �, | j tjdd�< tj�� tj�| j� dS �zR
Restore C{sys.path} and C{sys.modules} to their original values.
N�r r r r �clear�updater �r- r r r �tearDownG �
zPluginTests.tearDownFc C s� |j �d�}d�|d d� �}|d }ttj| |� tj|j = ddg|r(dgp)g D ]%}z
t�|j| � W q+ t yP } z
|j
t
j krF� W Y d }~q+d }~ww d S )N�.����c�o� ) r �split�join�delattrr r �os�remover' �OSError�errno�ENOENT)r- r, � deleteSource�
modulePath� packageName�
moduleName�ext�oser r r �_unimportPythonModuleO s
����z!PluginTests._unimportPythonModulec C s | j �d��� dS )z;
Remove the plugins B{droping.cache} file.
� dropin.cacheN)r% r$ r@ r4 r r r � _clearCache] � zPluginTests._clearCache�methc s t �� �� fdd��}|S )z�
This is a paranoid test wrapper, that calls C{meth} 2 times, clear the
cache, and calls it 2 other times. It's supposed to ensure that the
plugin system behaves correctly no matter what the state of the cache
is.
c s, � | � � | � | � � � | � � | � d S )N)rL r4 �rN r r �wrappedk s
z+PluginTests._withCacheness.<locals>.wrapped)� functools�wraps)rN rP r rO r �_withCachenessc s zPluginTests._withCachenessc C s� t �| j�}|| j }| �|jd| j� �� | �d|j� dd� |jD �d }| � |j
|� | �|j d� | �|j� � d� | �|j
tt jg� |�� }| � |tjd| j� � j� ddlm} | � ||j� dS ) a
Check that the cache returned by L{plugin.getCache} hold the plugin
B{testplugin}, and that this plugin has the properties we expect:
provide L{TestPlugin}, has the good name and description, and can be
loaded successfully.
z
mypackage.zI'm a test drop-in.c S s g | ] }t |jv r|�qS r )r �provided��.0�pr r r �
<listcomp>� s z*PluginTests.test_cache.<locals>.<listcomp>r �
TestPluginz*A plugin used solely for testing purposes.N)r �getCacher, r* � assertEqualrG �assertIn� description�plugins�assertIs�dropin�name�striprT r �IPlugin�loadr r rY �mypackage.testpluginr )r- �cacher` �p1�
realPlugin�tpr r r �
test_cacheu s$
�� zPluginTests.test_cachec C s> t �| j�| j }tdd� |jD ��d }| �t|�d� dS )zm
L{CachedPlugin} has a helpful C{repr} which contains relevant
information about it.
c s s � | ]
}|j d kr|V qdS )rY N�ra rU r r r � <genexpr>� s � z-PluginTests.test_cacheRepr.<locals>.<genexpr>r zT<CachedPlugin 'TestPlugin'/'mypackage.testplugin' (provides 'ITestPlugin, IPlugin')>N)r rZ r, r* �listr^ r[ �repr)r- � cachedDropin� cachedPluginr r r �test_cacheRepr� s ��zPluginTests.test_cacheReprc C sL t t�t| j��}| �t|�d� ddg}|D ] }|�|j� |� � qdS )a
L{plugin.getPlugins} should return the list of plugins matching the
specified interface (here, L{ITestPlugin2}), and these plugins
should be instances of classes with a C{test} method, to be sure
L{plugin.getPlugins} load classes correctly.
� �AnotherTestPlugin�ThirdTestPluginN)
rm r �
getPluginsr r, r[ �lenr@ r �test)r- r^ �namesrW r r r � test_plugins� s
�zPluginTests.test_pluginsc
C s� t t��d��| j�d�� zC| �dtj� | � t
tjd d�d� t t �
t| j��}| �t|�d� dd g}|D ] }|�|j� |�� q9W | �tjd d
� d S | �tjd d
� w ) ze
Check that L{plugin.getPlugins} is able to detect plugins added at
runtime.
�plugin_extra1.py�pluginextra.py�mypackage.pluginextrar � pluginextraz&mypackage still has pluginextra modulerr rY �FourthTestPluginTN)r r' r( r) r% r$ �failIfInr r � assertFalse�hasattrrm r ru r r, r[ rv r@ r �test1rJ �r- �plgsrx rW r r r �test_detectNewFiles� s"
��
�*z PluginTests.test_detectNewFilesc
C s� t t��d��| j�d�� zWtt�t | j
��}| � t |�d� t t��d��| j�d�� | �
tjd � tt�t | j
��}| � t |�d� g d�}|D ] }|�|j� |�� qMW | �
tjd d� d S | �
tjd d� w )
z�
Check that if the content of a plugin change, L{plugin.getPlugins} is
able to detect the new plugins added.
rz r{ rr zplugin_extra2.pyr| � )rY r~ �FifthTestPluginTN)r r' r( r) r% r$ rm r ru r r, r[ rv rJ r r r@ r r� r� r r r �test_detectFilesChanged� s$
�
�
�*z#PluginTests.test_detectFilesChangedc
C s� t t��d��| j�d�� ztt�t | j
�� W | � t j
d d� n
| � t j
d d� w tt�t | j
��}| �dt|�� dS )zs
Check that when a dropin file is removed, L{plugin.getPlugins} doesn't
return it anymore.
rz r{ r| T� N)r r' r( r) r% r$ rm r ru r r, rJ r r r[ rv )r- r� r r r �test_detectFilesRemoved� s
�(z#PluginTests.test_detectFilesRemovedc C sp | � � }| �tj�|�� | jj�|� ztt �
t | j��}| � t
|�d� W | jj�|� dS | jj�|� w )zy
Test that getCache skips over any entries in a plugin package's
C{__path__} which do not exist.
r� N)r! r� r? r �existsr, �__path__�appendrm r ru r r[ rv r@ )r- r r� r r r �test_nonexistentPathEntry s "z%PluginTests.test_nonexistentPathEntryc C s� t | �� �}| �|�� � |�� |�d�j}| jj� |� zt
t � t
| j��}| �t|�d� W | jj�|� dS | jj�|� w )z�
Test that getCache skips over any entries in a plugin package's
C{__path__} which refer to children of paths which are not directories.
� test_packager� N)r r! r� r� �touchr$ r r, r� r� rm r ru r r[ rv r@ )r- r r$ r� r r r �test_nonDirectoryChildEntry s "z'PluginTests.test_nonDirectoryChildEntryc C s t �| j� | j�d�}tt��d��| j�d�� t � t
� | jj d� t
� |j d� | �
t
j | jj d� | �
t
j |j d� g }t|j� | �
t|j� t �| j�}| �d|� | �| j|� d|j tjf }|D ] }|t|�v ru d
S qj| �d |f � d
S ) z�
The C{dropin.cache} file may not be writable: the cache should still be
attainable, but an error should be logged to show that the cache
couldn't be updated.
rK rz r{ i@ � i� r} �3Unable to write to plugin cache %s: error number %d�;Did not observe unwriteable cache warning in log events: %rN)r rZ r, r% r$ r r' r( r) �invalidateImportCachesr? �chmodr �
addCleanupr r� r r\ r* rB �EPERMr �fail)r- � cachepath�eventsrf �expected�eventr r r �test_deployedMode, s:
�
� ���z PluginTests.test_deployedModeN)F)r r r r r. r5 rJ rL r rS rj rq ry r� r� r� r� r� r� r r r r r ) s.
$
r sj
from twisted.plugin import pluginPackagePaths
__path__.extend(pluginPackagePaths(__name__))
__all__ = []
c C s d� | ��d�S )Nz�from zope.interface import provider
from twisted.plugin import IPlugin
from twisted.test.test_plugin import ITestPlugin
@provider(IPlugin, ITestPlugin)
class {}:
pass
�ascii)�format�encoderk r r r �pluginFileContentsd s �r� c C sl | � � | �d�}|� � |r|�d��d� |�d�}|� � |r*|�d��t� |�|d ��|� |S )z'
Create a plugindummy package.
� plugindummyr r r^ �.py)r# r$ r& �pluginInitFile)� entrypath�
pluginContent�real� pluginModule�pkg�plugsr r r �_createPluginDummyt s
r� c @ s` e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
dS )�DeveloperSetupTestsz�
These tests verify things about the plugin system without actually
interacting with the deployed 'twisted.plugins' package, instead creating a
temporary package.
c C s> t jdd� | _t j�� | _t| �� �| _| j� � | j�
d�| _ | j�
d�| _ | j�
d�| _
t| j td�dd�| _t| j td�dd�| _t| j
td �d
d �| _t j�d d
� | j | j
fD �� | �� | j �
d��
d�| _| j�
d�| _t�� }t�| j�
d�j|d fd � t�| jj|d fd � | �� | �� dS )a7
Create a complex environment with multiple entries on sys.path, akin to
a developer's environment who has a development (trunk) checkout of
Twisted, a system installed version of Twisted (for their operating
system's tools) and a project which provides Twisted plugins.
N� system_path�development_path�application_path�systemT�plugindummy_builtin�dev�appF�plugindummy_appc S � g | ]}|j �qS r �r �rV �xr r r rX � � z-DeveloperSetupTests.setUp.<locals>.<listcomp>r� r^ rK zplugindummy_builtin.pyi� rr i� ) r r � savedPathr r r r r! �fakeRootr# r$ �
systemPath�devPath�appPathr� r� �
systemPackage�
devPackage�
appPackage�extend�
getAllPlugins�sysplug�syscache�timer? �utime�
lockSystem�resetEnvironment)r- �nowr r r r. � s2
��� zDeveloperSetupTests.setUpc C �$ t �| jjd� t �| jjd� dS )zW
Lock the system directories, as if they were unwritable by this user.
im N�r? r� r� r r� r4 r r r r� � � z DeveloperSetupTests.lockSystemc C r� )zW
Unlock the system directories, as if they were writable by this user.
i� Nr� r4 r r r � unlockSystem� r� z DeveloperSetupTests.unlockSystemc C s( ddl }tt�t|j��}dd� |D �S )zl
Get all the plugins loadable from our dummy package, and return their
short names.
r Nc S r� r �r )rV �plugr r r rX � r� z5DeveloperSetupTests.getAllPlugins.<locals>.<listcomp>)�plugindummy.pluginsrm r ru r r^ )r- r� r� r r r r� � s z!DeveloperSetupTests.getAllPluginsc C s. | � � tj�dd� | j| j| jfD �� dS )zc
Change the environment to what it should be just as the test is
starting.
c S r� r r� r� r r r rX � r� z8DeveloperSetupTests.resetEnvironment.<locals>.<listcomp>N)�unsetEnvironmentr r r� r� r� r� r4 r r r r� � s &z$DeveloperSetupTests.resetEnvironmentc C s2 t � tj�� tj�| j� | jtjdd�< dS )zh
Change the Python environment back to what it was before the test was
started.
N)r� r r r2 r3 r r� r r4 r r r r� � s
z$DeveloperSetupTests.unsetEnvironmentc C s | � � | �� dS )z�
Reset the Python environment to what it was before this test ran, and
restore permissions on files which were marked read-only so that the
directory may be cleanly cleaned up.
N)r� r� r4 r r r r5 � s z DeveloperSetupTests.tearDownc C s2 t d�D ]}| �� }|�� | �|ddg� qdS )a
Plugins added in the development path should be loadable, even when
the (now non-importable) system path contains its own idea of the
list of plugins for a package. Inversely, plugins added in the
system path should not be available.
r� r� r� N)�ranger� �sortr[ )r- r� rx r r r �"test_developmentPluginAvailability� s
�z6DeveloperSetupTests.test_developmentPluginAvailabilityc C s� | j �d�}|�td�� t�� d }t�|j||f� |�d�}t dd�}t
j | j jfddi|�� t�|j||f� |� � | �
� | �d| �� � | �d | �� � | �
� |�td �� | �d| �� � | �d | �� � d
S ) z�
Verify that if a stale .pyc file on the PYTHONPATH is replaced by a
fresh .py file, the plugins in the new .py are picked up rather than
the stale .pyc, even if the .pyc is still around.
zstale.py�onei� z stale.pycT)�legacy�quietr� �twoN)r� r$ r& r� r� r? r� r r( �dict�
compileall� compile_dirr@ r� r\ r� r )r- �mypathr� �pyc�extrar r r � test_freshPyReplacesStalePyc� s
z0DeveloperSetupTests.test_freshPyReplacesStalePycc C s� | � � | j�d��td�� | �� tj�| j j� g }t
|j � | � t
|j � | �d| �� � d| jjtjf }|D ] }|t|�v rG dS q<| �d|f � dS )aF
Verify that a failure to write the dropin.cache file on a read-only
path will not affect the list of plugins returned.
Note: this test should pass on both Linux and Windows, but may not
provide useful coverage on Windows due to the different meaning of
"read-only directory".
z newstuff.pyr� r� r� N)r� r� r$ r& r� r� r r r@ r� r r� r� r r\ r� r� rB r� r r� )r- r� r� r� r r r � test_newPluginsOnReadOnlyPath s*
� ���z1DeveloperSetupTests.test_newPluginsOnReadOnlyPathN)r r r r r. r� r� r� r� r� r5 r� r� r� r r r r r� � s *
r� c @ s8 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd S )
�AdjacentPackageTestsz�
Tests for the behavior of the plugin system when there are multiple
installed copies of the package containing the plugins being loaded.
c C s t jdd� | _t j�� | _dS )zS
Save the elements of C{sys.path} and the items of C{sys.modules}.
N)r r r r r r r4 r r r r. J s zAdjacentPackageTests.setUpc C r/ r0 r1 r4 r r r r5 Q r6 z AdjacentPackageTests.tearDownc C sn |� |�}|� d�}|�� |� d��d� |� d�}|�� |� d��t� |� |d �}|�t|�� |S )a`
Create a directory containing a Python package named I{dummy} with a
I{plugins} subpackage.
@type root: L{FilePath}
@param root: The directory in which to create the hierarchy.
@type name: C{str}
@param name: The name of the directory to create which will contain
the package.
@type pluginName: C{str}
@param pluginName: The name of a module to create in the
I{dummy.plugins} package.
@rtype: L{FilePath}
@return: The directory which was created to contain the I{dummy}
package.
�dummyr r r^ r� )r$ �makedirsr& r� r� )r- r" ra �
pluginName� directoryr% r^ r� r r r �createDummyPackageY s
z'AdjacentPackageTests.createDummyPackagec C s� t | �� �}|�� | �|dd�}| �|dd�}tj�|j� tj�|j� ddl}tt �
t |j ��}| �
dgdd� |D �� dS )z�
Only plugins from the first package in sys.path should be returned by
getPlugins in the case where there are two Python packages by the same
name installed, each with a plugin module by a single name.
�first�
someplugin�secondr Nc S r� r r� rU r r r rX � r� zWAdjacentPackageTests.test_hiddenPackageSamePluginModuleNameObscured.<locals>.<listcomp>�r r! r� r� r r r� �
dummy.pluginsrm r ru r r^ r[ �r- r" �firstDirectory�secondDirectoryr� r^ r r r �.test_hiddenPackageSamePluginModuleNameObscuredx � zCAdjacentPackageTests.test_hiddenPackageSamePluginModuleNameObscuredc C s� t | �� �}|�� | �|dd�}| �|dd�}tj�|j� tj�|j� ddl}tt �
t |j ��}| �
dgdd� |D �� dS ) z�
Plugins from the first package in sys.path should be returned by
getPlugins in the case where there are two Python packages by the same
name installed, each with a plugin module by a different name.
r� �
thispluginr� �
thatpluginr Nc S r� r r� rU r r r rX � r� z\AdjacentPackageTests.test_hiddenPackageDifferentPluginModuleNameObscured.<locals>.<listcomp>r� r� r r r �3test_hiddenPackageDifferentPluginModuleNameObscured� r� zHAdjacentPackageTests.test_hiddenPackageDifferentPluginModuleNameObscuredN) r r r r r. r5 r� r� r� r r r r r� D s r� c @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
S ) �PackagePathTestszg
Tests for L{plugin.pluginPackagePaths} which constructs search paths for
plugin packages.
c C s t jdd� | _dS )z3
Save the elements of C{sys.path}.
N)r r r r4 r r r r. � rM zPackagePathTests.setUpc C s | j tjdd�< dS )z<
Restore C{sys.path} to its original value.
N)r r r r4 r r r r5 � rM zPackagePathTests.tearDownc C sT t d�}t d�}|j|jgt_| �t�d�|�d��d�j|�d��d�jg� dS )z�
L{plugin.pluginPackagePaths} should return a list containing each
directory in C{sys.path} with a suffix based on the supplied package
name.
�foo�bar�
dummy.pluginsr� r^ N)r r r r[ r �pluginPackagePathsr$ )r- r� r� r r r �test_pluginDirectories� s ��z'PackagePathTests.test_pluginDirectoriesc C s� t | �� �}|�d��d��d�}|�� |�d��d� |�d�j|�d�jgt_| �t� d�|�d��d��d�jg� dS ) a�
L{plugin.pluginPackagePaths} should exclude directories which are
Python packages. The only allowed plugin package (the only one
associated with a I{dummy} package which Python will allow to be
imported) will already be known to the caller of
L{plugin.pluginPackagePaths} and will most commonly already be in
the C{__path__} they are about to mutate.
r� r� r^ r r r� r� N)
r r! r$ r� r& r r r[ r r� )r- r" r� r r r �test_pluginPackagesExcluded� s �z,PackagePathTests.test_pluginPackagesExcludedN)r r r r r. r5 r� r� r r r r r� � s r� )"r r� rB rQ r? r r� � importlibr r� �typingr �zope.interfacer �twistedr �twisted.python.filepathr �twisted.python.logr r r �
twisted.trialr
r r �TestCaser r� r� r� r� r� r� r r r r �<module> s4 6 @]