File: //usr/lib/python3/dist-packages/twisted/test/__pycache__/test_plugin.cpython-38.pyc
U
W[f � @ s2 d Z ddlmZmZ ddlZddlZddlZddlZddlZddl Z ddl
m Z ddl m
Z
ddlmZmZ ddlmZmZmZ ddlmZ dd lmZ er�dd
lmZ nd d � ZG d
d� de �Z G dd� de �Z G dd� de
j �Z dZ dd� Z!dd� Z"G dd� de
j �Z#G dd� de
j �Z$G d d � d e
j �Z%dS ) z"
Tests for Twisted plugin system.
� )�absolute_import�divisionN)� Interface)�unittest)�_PY3�_PYPY)�textFromEventDict� addObserver�removeObserver)�FilePath)�plugin)�invalidate_cachesc C s dS )zJ
On python 2, import caches don't need to be invalidated.
N� r r r �:/usr/lib/python3/dist-packages/twisted/test/test_plugin.py�invalidateImportCaches s r c @ s 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 r r r " s r c @ s e Zd ZdZdS )� ITestPlugin2z
See L{ITestPlugin}.
Nr r r r r r + s r c @ s� e Zd ZdZdd� Zdd� Zd dd�Zd d
� Zd d � Zd
d� Z ee �Z dd� Z
dd� Z ee �Z dd� Z ee �Z dd� Z
ee
�Z
dd� Zee�Zdd� Zee�Zdd � Zee�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 �setUp8 s
�zPluginTests.setUpc C s, | 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 �tearDownO s
zPluginTests.tearDownFc C s� |j �d�}d�|d d� �}|d }ttj| |� tj|j = ddg|rPdgpRg D ]J}zt�|j| � W qV t k
r� } z|j
t
j kr�� W 5 d }~X Y qVX qVd S )N�.����c�o� ) r �split�join�delattrr r �os�remover) �OSError�errnoZENOENT)r/ r. Z deleteSourceZ
modulePathZ packageName�
moduleNameZextZoser r r �_unimportPythonModuleX s
z!PluginTests._unimportPythonModulec C s | j �d��� dS )z;
Remove the plugins B{droping.cache} file.
� dropin.cacheN)r' r& r@ r5 r r r � _clearCacheg s zPluginTests._clearCachec 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)rF r5 ��methr r �wrappedu s
z+PluginTests._withCacheness.<locals>.wrapped)� functools�wraps)rH rI r rG r �_withCachenessn s zPluginTests._withCachenessc C s� t �| j�}|| j }| �|jd| jf � | �d|j� dd� |jD �d }| � |j
|� | �|j d� | �|j� � d� | �|j
tt jg� |�� }| � |tjd| jf 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.%szI'm a test drop-in.c S s g | ]}t |jkr|�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, � assertEqualrC �assertInZ description�pluginsZassertIs�dropin�name�striprM r ZIPlugin�loadr r rR Zmypackage.testpluginr )r/ �cacherW Zp1Z
realPlugin�tpr r r �
test_cache� 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 )rR N�rX rN r r r � <genexpr>� s
�z-PluginTests.test_cacheRepr.<locals>.<genexpr>r zT<CachedPlugin 'TestPlugin'/'mypackage.testplugin' (provides 'ITestPlugin, IPlugin')>N)r rS r. r, �listrV rT �repr)r/ Z cachedDropinZ cachedPluginr r r �test_cacheRepr� s ��zPluginTests.test_cacheReprc C sL t t�t| j��}| �t|�d� ddg}|D ]}|�|j� |� � q.dS )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.
� ZAnotherTestPluginZThirdTestPluginN)
r` r �
getPluginsr r. rT �lenr@ r Ztest)r/ rV �namesrP r r r � test_plugins� s zPluginTests.test_pluginsc
C s� t t��d��| j�d�� zr| � dtj� | �
t tjd d�d� t t
�t| j��}| �t|�d� d d
g}|D ]}|�|j� |�� qrW 5 | �tjd d� X d S ) ze
Check that L{plugin.getPlugins} is able to detect plugins added at
runtime.
�plugin_extra1.py�pluginextra.py�mypackage.pluginextraTr � pluginextraz&mypackage still has pluginextra modulerc rR �FourthTestPluginN)r r) r* r+ r' r& rD r r �failIfIn� assertFalse�hasattrr` r rd r r. rT re r@ r �test1�r/ �plgsrf rP r r r �test_detectNewFiles� s$
�� �z PluginTests.test_detectNewFilesc
C s� t t��d��| j�d�� z�t t
� t | j
��}| �t|�d� t t��d��| j�d�� | �tjd � t t
� t | j
��}| �t|�d� dd d
g}|D ]}|�|j� |�� q�W 5 | �tjd d� X d S ) z�
Check that if the content of a plugin change, L{plugin.getPlugins} is
able to detect the new plugins added.
rh ri rj Trc zplugin_extra2.py� rR rl ZFifthTestPluginN)r r) r* r+ r' r& rD r r r` r rd r r. rT re r@ r rp rq r r r �test_detectFilesChanged� s(
�
�
�z#PluginTests.test_detectFilesChangedc
C sn t t��d��| j�d�� zt t
� t | j
�� W 5 | �tjd d� X t t
� t | j
��}| �dt|�� dS )zs
Check that when a dropin file is removed, L{plugin.getPlugins} doesn't
return it anymore.
rh ri rj T� N)r r) r* r+ r' r& rD r r r` r rd r r. rT re )r/ rr r r r �test_detectFilesRemoved
s
��z#PluginTests.test_detectFilesRemovedc C sd | � � }| �tj�|�� | jj�|� z&t t
� t | j��}| �
t|�d� W 5 | jj�|� X dS )zy
Test that getCache skips over any entries in a plugin package's
C{__path__} which do not exist.
rv N)r# rn r? r �existsr. �__path__�appendr@ r` r rd r rT re )r/ r rr r r r �test_nonexistentPathEntry s z%PluginTests.test_nonexistentPathEntryc C sx t | �� �}| �|�� � |�� |�d�j}| jj� |� z&t t �
t| j��}| �t|�d� W 5 | jj�
|� X dS )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.
Z test_packagerv N)r r# rn rx Ztouchr& r r. ry rz r@ r` r rd r rT re )r/ r r& rr r r r �test_nonDirectoryChildEntry1 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|�kr� q�q�| �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.
rE rh ri i@ � i� rk �3Unable to write to plugin cache %s: error number %d�;Did not observe unwriteable cache warning in log events: %rN)r rS r. r' r& r r) r* r+ r r? �chmodr �
addCleanupr rz r
rU r, rB �EPERMr �fail)r/ Z cachepath�eventsr[ �expected�eventr r r �test_deployedModeD s8
�
� ��z PluginTests.test_deployedModeN)F)r r r r r0 r6 rD rF rL r] rb rg rs ru rw r{ r| r� r r r r r 2 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 {0}(object):
pass
�ascii)�format�encoder^ r r r �pluginFileContentsx s ���r� c C sl | � � | �d�}|� � |r.|�d��d� |�d�}|� � |rT|�d��t� |�|d ��|� |S )z'
Create a plugindummy package.
� plugindummyr r rV �.py)r% r& r( �pluginInitFile)Z entrypathZ
pluginContent�real� pluginModule�pkgZplugsr r r �_createPluginDummy� s
r� c @ sn e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z e
rbesbde _dd� ZdS )�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.
NZ system_pathZdevelopment_pathZapplication_path�systemTZplugindummy_builtin�dev�appFZplugindummy_appc S s g | ]
}|j �qS r �r �rO �xr r r rQ � s z-DeveloperSetupTests.setUp.<locals>.<listcomp>r� rV rE zplugindummy_builtin.pyi� rc i� ) r r � savedPathr r! r" r r# ZfakeRootr% r& �
systemPath�devPath�appPathr� r� Z
systemPackageZ
devPackage�
appPackage�extend�
getAllPlugins�sysplug�syscache�timer? �utime�
lockSystem�resetEnvironment)r/ Znowr r r r0 � sN
� � ��
�zDeveloperSetupTests.setUpc C s$ 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� r5 r r r r� � s z DeveloperSetupTests.lockSystemc C s$ t �| jjd� t �| jjd� dS )zW
Unlock the system directories, as if they were writable by this user.
i� Nr� r5 r r r � unlockSystem� s 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 s g | ]
}|j �qS r �r )rO Zplugr r r rQ � s z5DeveloperSetupTests.getAllPlugins.<locals>.<listcomp>)Zplugindummy.pluginsr` r rd r rV )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 s g | ]
}|j �qS r r� r� r r r rQ � s z8DeveloperSetupTests.resetEnvironment.<locals>.<listcomp>N)�unsetEnvironmentr r r� r� r� r� r5 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 r3 r4 r" r� r r5 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� r5 r r r r6 � 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.
rt r� r� N)�ranger� �sortrT )r/ r� rf r r r �"test_developmentPluginAvailability
s z6DeveloperSetupTests.test_developmentPluginAvailabilityc C s� | j �d�}|�td�� t�� d }t�|j||f� |�d�}t rRt
dd�}nt
� }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)Zlegacy�quietrv ZtwoN)r� r& r( r� r� r? r� r r* r �dict�
compileallZ compile_dirr@ r� rU r� rm )r/ Zmypathr� ZpycZextrar r r � test_freshPyReplacesStalePyc s$
z0DeveloperSetupTests.test_freshPyReplacesStalePycz/PyPy2 will not normally import lone .pyc files.c C s� | � � | j�d��td�� | �� tj�| j j� g }t
|j � | � t
|j � | �d| �� � d| jjtjf }|D ]}|t|�krx q�qx| �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 rz r� r
rU r� r� rB r� r r� )r/ r� r� r� r r r � test_newPluginsOnReadOnlyPathB s(
� ��z1DeveloperSetupTests.test_newPluginsOnReadOnlyPathN)r r r r r0 r� r� r� r� r� r6 r� r� r r �skipr� 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" r5 r r r r0 m s zAdjacentPackageTests.setUpc C s, | j tjdd�< tj�� tj�| j� dS r1 r2 r5 r r r r6 u s
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 rV r� )r& �makedirsr( r� r� )r/ r$ rX Z
pluginNameZ directoryr' rV r� r r r �createDummyPackage~ 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.
�firstZ
someplugin�secondr Nc S s g | ]
}|j �qS r r� rN r r r rQ � s zWAdjacentPackageTests.test_hiddenPackageSamePluginModuleNameObscured.<locals>.<listcomp>�r r# r� r� r r rz Z
dummy.pluginsr` r rd r rV rT �r/ r$ ZfirstDirectoryZsecondDirectoryr� rV r r r �.test_hiddenPackageSamePluginModuleNameObscured� s 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� Z
thispluginr� Z
thatpluginr Nc S s g | ]
}|j �qS r r� rN r r r rQ � s z\AdjacentPackageTests.test_hiddenPackageDifferentPluginModuleNameObscured.<locals>.<listcomp>r� r� r r r �3test_hiddenPackageDifferentPluginModuleNameObscured� s zHAdjacentPackageTests.test_hiddenPackageDifferentPluginModuleNameObscuredN) r r r r r0 r6 r� r� r� r r r r r� g 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 r5 r r r r0 � s zPackagePathTests.setUpc C s | j tjdd�< dS )z<
Restore C{sys.path} to its original value.
N)r r r r5 r r r r6 � s 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� rV N)r r r rT 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� rV r r r� r� N)
r r# r& r� r( r r rT r r� )r/ r$ r� r r r �test_pluginPackagesExcluded� s �z,PackagePathTests.test_pluginPackagesExcludedN)r r r r r0 r6 r� r� r r r r r� � s
r� )&r Z
__future__r r r rB r? r� r� rJ Zzope.interfacer Z
twisted.trialr Ztwisted.python.compatr r Ztwisted.python.logr r r
Ztwisted.python.filepathr Ztwistedr � importlibr
r r r ZTestCaser r� r� r� r� r� r� r r r r �<module> s2 B Rb