o >hh@sPdZddlmZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z ddlmZmZmZddlmZddlmZdd lmZdd lmZmZmZmZdd lmZed ZGd ddeZ GdddeZ!Gdddej"Z#dZ$d*ddZ%d+d d!Z&Gd"d#d#eZ'Gd$d%d%ej"Z(Gd&d'd'ej"Z)Gd(d)d)ej"Z*dS),z" Tests for Twisted plugin system. ) annotationsN)invalidate_caches) ModuleType)Callable TypedDictTypeVar) Interface)plugin)FilePath) EventDict addObserverremoveObservertextFromEventDict)unittest_Tc@eZdZdZdS) ITestPluginzS A plugin for use by the plugin system's unit tests. Do not use this. N__name__ __module__ __qualname____doc__rrx/var/www/vedio/testing/chatpythonscript.ninositsolution.com/env/lib/python3.10/site-packages/twisted/test/test_plugin.pyrrc@r) ITestPlugin2z See L{ITestPlugin}. Nrrrrrr&rrc@seZdZdZd)ddZd)ddZ d*d+d dZd)ddZd,ddZed)ddZ d)ddZ ed)ddZ ed)ddZ ed)ddZ ed)d d!Zed)d"d#Zed)d$d%Zd)d&d'Zd(S)- PluginTestsz_ Tests which verify the behavior of the current, active Twisted plugins directory. returnNonecCstjdd|_tj|_t||_|j |j d|_ |j |j d dtt d|j dd|_tjd|jjddl}||_dS) zV Save C{sys.path} and C{sys.modules}, and create a package for tests. N mypackage __init__.pyzplugin_basic.pyz testplugin.py testpluginr)syspath originalPathmodulescopy savedModulesr mktemprootcreateDirectorychildpackage setContent__file__siblingcopyTooriginalPlugininsertrmodule)selfrrrrsetUp2s     zPluginTests.setUpcC,|jtjdd<tjtj|jdSzR Restore C{sys.path} and C{sys.modules} to their original values. Nr%r#r$r&clearupdater(r5rrrtearDownJ zPluginTests.tearDownFr4r deleteSourceboolc Cs|jdusJ|jd}d|dd}|d}ttj||tj|j=ddg|r/dgp0gD]}z t|j|Wq2t yGYq2wdS)N.co) r/rsplitjoindelattrr#r&osremoveFileNotFoundError)r5r4r? modulePath packageName moduleNameextrrr_unimportPythonModuleRs   z!PluginTests._unimportPythonModulecCs|jddS)z; Remove the plugins B{droping.cache} file. dropin.cacheN)r-r,rJr<rrr _clearCachebzPluginTests._clearCachemethCallable[[PluginTests], object]Callable[[PluginTests], None]cstdfdd }|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. r5rrrcs,|||||dS)N)rRr<rTrrwrappedrs  z+PluginTests._withCacheness..wrappedN)r5rrr) functoolswraps)rTrXrrWr_withCachenesshs zPluginTests._withCachenesscCst|j}||j}||jd|j|d|jdd|jDd}| |j |||j d||j d||j ttjg|}| |tjd|jjddlm}| ||jdS) 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.cSsg|] }t|jvr|qSr)rprovided.0prrr sz*PluginTests.test_cache..r TestPluginz*A plugin used solely for testing purposes.N)r getCacher4r2 assertEqualrNassertIn descriptionpluginsassertIsdropinnamestripr\rIPluginloadr#r&ramypackage.testpluginr")r5cacherhp1 realPlugintprrr test_cache|s$    zPluginTests.test_cachecCs>t|j|j}tdd|jDd}|t|ddS)zm L{CachedPlugin} has a helpful C{repr} which contains relevant information about it. css|] }|jdkr|VqdS)raNrir]rrr sz-PluginTests.test_cacheRepr..rzTN)r rbr4r2listrfrcrepr)r5 cachedDropin cachedPluginrrrtest_cacheReprszPluginTests.test_cacheReprcCsLttt|j}|t|dddg}|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. AnotherTestPluginThirdTestPluginN) rur getPluginsrr4rclenrJrtest)r5rfnamesr_rrr test_pluginss  zPluginTests.test_pluginsc Csttd|jdzC|dtj| t tjdddt t t|j}|t|ddd g}|D] }||j|q9W|tjdd d S|tjdd w) ze Check that L{plugin.getPlugins} is able to detect plugins added at runtime. plugin_extra1.pypluginextra.pymypackage.pluginextrar pluginextraz&mypackage still has pluginextra modulerzraFourthTestPluginTN)r r/r0r1r-r,failIfInr#r& assertFalsehasattrrur r}rr4rcr~rJrtest1rPr5plgsrr_rrrtest_detectNewFiless"   *zPluginTests.test_detectNewFilesc Csttd|jdzWttt |j }| t |dttd|jd| tjdttt |j }| t |dgd}|D] }||j|qMW| tjddd S| tjddw) z Check that if the content of a plugin change, L{plugin.getPlugins} is able to detect the new plugins added. rrrzzplugin_extra2.pyr)rarFifthTestPluginTN)r r/r0r1r-r,rur r}rr4rcr~rPr#r&rJrrrrrrtest_detectFilesChangeds$    *z#PluginTests.test_detectFilesChangedc Csttd|jdzttt |j W| t j ddn | t j ddwttt |j }|dt|dS)zs Check that when a dropin file is removed, L{plugin.getPlugins} doesn't return it anymore. rrrTN)r r/r0r1r-r,rur r}rr4rPr#r&rcr~)r5rrrrtest_detectFilesRemoveds (z#PluginTests.test_detectFilesRemovedc Csp|}|tj||jj|ztt t |j}| t |dW|jj|dS|jj|w)zy Test that getCache skips over any entries in a plugin package's C{__path__} which do not exist. rN)r)rrIr$existsr4__path__appendrur r}rrcr~rJ)r5r$rrrrtest_nonexistentPathEntrys"z%PluginTests.test_nonexistentPathEntryc Cst|}||||dj}|jj |zt t t |j}|t|dW|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_packagerN)r r)rrtouchr,r$r4rrrur r}rrcr~rJ)r5r$r,rrrrtest_nonDirectoryChildEntry"s  "z'PluginTests.test_nonDirectoryChildEntrycCst|j|jd}ttd|jdt t |jj dt |j d| t j |jj d| t j |j dg}t|j| t|jt|j}|d|||j|d|j tjf}|D]}t|}|d usvJ||vr}d Sqj|d |fd 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. rQrri@ir3Unable to write to plugin cache %s: error number %dN;Did not observe unwriteable cache warning in log events: %r)r rbr4r-r,r r/r0r1invalidateImportCachesrIchmodr$ addCleanupr rr rdr2errnoEPERMrfail)r5 cachepatheventsrnexpectedevent maybeTextrrrtest_deployedMode3s>       zPluginTests.test_deployedModeNrr)F)r4rr?r@rr)rTrUrrV)rrrrr6r=rPrRr[rrryrrrrrrrrrrrr,s0      $      rsj from twisted.plugin import pluginPackagePaths __path__.extend(pluginPackagePaths(__name__)) __all__ = [] ristrrbytescCsd|dS)Nzfrom zope.interface import provider from twisted.plugin import IPlugin from twisted.test.test_plugin import ITestPlugin @provider(IPlugin, ITestPlugin) class {}: pass ascii)formatencodersrrrpluginFileContentsmsr entrypath FilePath[str] pluginContentrealr@ pluginModulecCsl||d}||r|dd|d}||r*|dt||d||S)z' Create a plugindummy package. plugindummyr r!rf.py)r+r,r.pluginInitFile)rrrrpkgplugsrrr_createPluginDummy}s  rc@seZdZUded<dS)_HasBoolLegacyKeyr@legacyN)rrr__annotations__rrrrrs rc@steZdZdZdddZdddZddd Zdd d Zdd dZdddZ dddZ dddZ dddZ dddZ dS)DeveloperSetupTestsz These tests verify things about the plugin system without actually interacting with the deployed 'twisted.plugins' package, instead creating a temporary package. rrcCs>tjdd|_tj|_t||_|j |j d|_ |j d|_ |j d|_ t|j tddd|_t|j tddd|_t|j td d d |_tjd d |j |j fD||j d d|_|j d|_t}t|j dj|dfdt|jj|dfd||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_pathdevelopment_pathapplication_pathsystemTplugindummy_builtindevappFplugindummy_appcSg|]}|jqSrr$r^xrrrr`z-DeveloperSetupTests.setUp..rrfrQzplugindummy_builtin.pyirzi)r#r$ savedPathr&r'r(r r)fakeRootr+r, systemPathdevPathappPathrr systemPackage devPackage appPackageextend getAllPluginssysplugsyscachetimerIutime lockSystemresetEnvironment)r5nowrrrr6s2    zDeveloperSetupTests.setUpcC$t|jjdt|jjddS)zW Lock the system directories, as if they were unwritable by this user. imNrIrrr$rr<rrrrzDeveloperSetupTests.lockSystemcCr)zW Unlock the system directories, as if they were writable by this user. iNrr<rrr unlockSystemrz DeveloperSetupTests.unlockSystem list[str]cCs(ddl}ttt|j}dd|DS)zl Get all the plugins loadable from our dummy package, and return their short names. rNcSrrr)r^plugrrrr`rz5DeveloperSetupTests.getAllPlugins..)plugindummy.pluginsrur r}rrf)r5rrrrrrsz!DeveloperSetupTests.getAllPluginscCs.|tjdd|j|j|jfDdS)zc Change the environment to what it should be just as the test is starting. cSrrrrrrrr`rz8DeveloperSetupTests.resetEnvironment..N)unsetEnvironmentr#r$rrrrr<rrrrs&z$DeveloperSetupTests.resetEnvironmentcCs2ttjtj|j|jtjdd<dS)zh Change the Python environment back to what it was before the test was started. N)rr#r&r:r;r(rr$r<rrrrs z$DeveloperSetupTests.unsetEnvironmentcCs||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)rrr<rrrr=s zDeveloperSetupTests.tearDowncCs2tdD]}|}|||ddgqdS)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. rrrN)rangersortrc)r5rrrrr"test_developmentPluginAvailabilitys z6DeveloperSetupTests.test_developmentPluginAvailabilitycCs|jd}|tdtd}t|j||f|d}t dd}t j |jjfddi|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.pyoneiz stale.pycT)rquietrtwoN)rr,r.rrrIrr$r0r compileall compile_dirrJrrdrr)r5mypathrpycextrarrrtest_freshPyReplacesStalePyc s    z0DeveloperSetupTests.test_freshPyReplacesStalePyccCs||jdtd|tj|j jg}t |j | t |j |d|d|jjtjf}|D]}t|}|dusHJ||vrOdSq<|d|fdS)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.pyrrNr)rrr,r.rrr#r$rJrr rrr rdrrrrrr)r5rrrrrrrtest_newPluginsOnReadOnlyPath,s.   z1DeveloperSetupTests.test_newPluginsOnReadOnlyPathNr)rr)rrrrr6rrrrrr=rrrrrrrrs  *     rc@sBeZdZdZdddZdddZdd dZdddZdddZdS)AdjacentPackageTestsz Tests for the behavior of the plugin system when there are multiple installed copies of the package containing the plugins being loaded. rrcCs tjdd|_tj|_dS)zS Save the elements of C{sys.path} and the items of C{sys.modules}. N)r#r$r%r&r'r(r<rrrr6[szAdjacentPackageTests.setUpcCr7r8r9r<rrrr=br>zAdjacentPackageTests.tearDownr*rrir pluginNamecCsn||}|d}||dd|d}||dt||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!rfr)r,makedirsr.rr)r5r*rir directoryr-rfrrrrcreateDummyPackagejs   z'AdjacentPackageTests.createDummyPackagecCst|}|||dd}||dd}tj|jtj|jddl}tt t |j }| dgdd|DdS)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 somepluginsecondrNcSrrrr]rrrr`rzWAdjacentPackageTests.test_hiddenPackageSamePluginModuleNameObscured..r r)rrr#r$r dummy.pluginsrur r}rrfrcr5r*firstDirectorysecondDirectoryrrfrrr.test_hiddenPackageSamePluginModuleNameObscured zCAdjacentPackageTests.test_hiddenPackageSamePluginModuleNameObscuredcCst|}|||dd}||dd}tj|jtj|jddl}tt t |j }| dgdd|DdS) 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 thatpluginrNcSrrrr]rrrr`rz\AdjacentPackageTests.test_hiddenPackageDifferentPluginModuleNameObscured..rrrrr3test_hiddenPackageDifferentPluginModuleNameObscuredrzHAdjacentPackageTests.test_hiddenPackageDifferentPluginModuleNameObscuredNr)r*rrirrrrr) rrrrr6r=rrrrrrrrUs    !rc@s8eZdZdZd ddZd ddZd dd Zd d d Zd S)PackagePathTestszg Tests for L{plugin.pluginPackagePaths} which constructs search paths for plugin packages. rrcCstjdd|_dS)z3 Save the elements of C{sys.path}. N)r#r$r%r<rrrr6rSzPackagePathTests.setUpcCs|jtjdd<dS)z< Restore C{sys.path} to its original value. N)r%r#r$r<rrrr=rSzPackagePathTests.tearDowncCsTtd}td}|j|jgt_|td|ddj|ddjgdS)z L{plugin.pluginPackagePaths} should return a list containing each directory in C{sys.path} with a suffix based on the supplied package name. foobar dummy.pluginsrrfN)r r$r#rcr pluginPackagePathsr,)r5rrrrrtest_pluginDirectoriessz'PackagePathTests.test_pluginDirectoriescCst|}|ddd}||dd|dj|djgt_|t d|dddjgdS) 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. rrrfr r!rr N) r r)r,rr.r$r#rcr r )r5r*rrrrtest_pluginPackagesExcludeds z,PackagePathTests.test_pluginPackagesExcludedNr)rrrrr6r=r r rrrrrs    r)rirrr) rrrrrr@rrrr)+r __future__rrrrYrIr#r importlibrrtypesrtypingrrrzope.interfacertwistedr twisted.python.filepathr twisted.python.logr r r r twisted.trialrrrrTestCaserrrrrrrrrrrrs<       <  B_