tfhdZddlmZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z ddlmZmZmZddlmZddlmZdd lmZdd lmZmZmZmZdd lmZed ZGd deZ GddeZ!Gddej"Z#dZ$d(dZ%d)dZ&Gd d!eZ'Gd"d#ej"Z(Gd$d%ej"Z)Gd&d'ej"Z*dS)*z" Tests for Twisted plugin system. ) annotationsN)invalidate_caches) ModuleType)Callable TypedDictTypeVar) Interface)plugin)FilePath) EventDict addObserverremoveObservertextFromEventDict)unittest_TceZdZdZdS) ITestPluginzS A plugin for use by the plugin system's unit tests. Do not use this. N__name__ __module__ __qualname____doc__W/var/www/surfInsights/venv3-11/lib/python3.11/site-packages/twisted/test/test_plugin.pyrrsrrceZdZdZdS) ITestPlugin2z See L{ITestPlugin}. Nrrrrrr&srrceZdZdZddZddZ ddd Zdd ZddZeddZ ddZ eddZ eddZ eddZ eddZeddZeddZddZdS) PluginTestsz_ Tests which verify the behavior of the current, active Twisted plugins directory. returnNonectjdd|_tj|_t ||_|j |j d|_ |j |j d dt td|j dd|_tjd|jjddl}||_dS) zV Save C{sys.path} and C{sys.modules}, and create a package for tests. N mypackage __init__.pyrzplugin_basic.pyz testplugin.py testpluginr)syspath originalPathmodulescopy savedModulesr mktemprootcreateDirectorychildpackage setContent__file__siblingcopyTooriginalPlugininsertr#module)selfr#s rsetUpzPluginTests.setUp2s! HQQQKK,,..T[[]]++  !!###y{33  $$&&& =))44S999""#455<< L   / /   + 49>*** rc|jtjdd<tjtj|jdSzR Restore C{sys.path} and C{sys.modules} to their original values. Nr(r&r'r)clearupdater+r8s rtearDownzPluginTests.tearDownJI'   4,-----rFr7r deleteSourceboolcr|jJ|jd}d|dd}|d}t t j||t j|j=ddg|rdgpgzD]/} tj|j|z #t$rY,wxYwdS)N.co) r2rsplitjoindelattrr&r)osremoveFileNotFoundError)r8r7rB modulePath packageName moduleNameexts r_unimportPythonModulez!PluginTests._unimportPythonModuleRs***_**3// hhz#2#// ^  K(*555 K (:!62$!<"=  C  &/C/0000$      s B'' B43B4c^|jddS)z; Remove the plugins B{droping.cache} file. dropin.cacheN)r0r/rNr?s r _clearCachezPluginTests._clearCachebs, >**1133333rmethCallable[[PluginTests], object]Callable[[PluginTests], None]cHtjdfd }|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. r8rr r!c|||||dS)N)rW)r8rXs rwrappedz+PluginTests._withCacheness..wrappedrsM DJJJ DJJJ       DJJJ DJJJJJr)r8rr r!) functoolswraps)rXr]s` r_withCachenesszPluginTests._withCachenesshs?           rctj|j}||j}||jd|j|d|jd|jDd}| |j |||j d||j d||j ttjg|}| |t"jd|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.c.g|]}t|jv|Sr)rprovided.0ps r z*PluginTests.test_cache..s$ E E EA;!*+D+Da+D+D+Drr TestPluginz*A plugin used solely for testing purposes.N)r getCacher7r5 assertEqualrRassertIn descriptionpluginsassertIsdropinnamestriprcrIPluginloadr&r)rhmypackage.testpluginr%)r8cacherop1 realPlugintps r test_cachezPluginTests.test_cache|sh ,,t*+ *,N9L,N,NOOO +V-?@@@F E E E Ea H bi((( ,///  N " "$P    {FN&CDDDWWYY   K:T%8:: ; F   *))))) j"-00000rctj|j|j}t d|jDd}|t|ddS)zm L{CachedPlugin} has a helpful C{repr} which contains relevant information about it. c30K|]}|jdk |VdS)rhNrprds r z-PluginTests.test_cacheRepr..s.VV!qv?U?UA?U?U?U?UVVrrzTN)r rir7r5listrmrjrepr)r8 cachedDropin cachedPlugins rtest_cacheReprzPluginTests.test_cacheReprsx t{33D4GH VV|';VVVVV       1     rcttjt|j}|t |dddg}|D]0}||j| 1dS)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) r~r getPluginsrr7rjlenrNrtest)r8rmnamesrfs r test_pluginszPluginTests.test_pluginssv(t{CCDD Wq)))$&78  A LL $ $ $ FFHHHH  rcttd|jd |dtj| ttjdddttj t|j}|t#|ddd g}|D]0}||j|1 |tjdd d S#|tjdd wxYw) ze Check that L{plugin.getPlugins} is able to detect plugins added at runtime. plugin_extra1.pypluginextra.pymypackage.pluginextrar# pluginextraz&mypackage still has pluginextra modulerrhFourthTestPluginTN)r r2r3r4r0r/failIfInr&r) assertFalsehasattrr~r rrr7rjrrNrtest1rTr8plgsrrfs rtest_detectNewFileszPluginTests.test_detectNewFiless[ ""#566== L  / 0 0    S MM13; ? ? ?    K0-@@8    )+t{CCDDD   SYY * * *!#56E   QZ(((    & &s{3J'KT R R R R RD & &s{3J'KT R R R Rs CE(E?cttd|jd t tjt|j }| t|dttd|jd| tjdt tjt|j }| t|dgd}|D]0}||j|1 | tjddd S#| tjddwxYw) z Check that if the content of a plugin change, L{plugin.getPlugins} is able to detect the new plugins added. rrrzplugin_extra2.pyr)rhrFifthTestPluginTN)r r2r3r4r0r/r~r rrr7rjrrTr&r)rNrrrs rtest_detectFilesChangedz#PluginTests.test_detectFilesChangeds ""#566== L  / 0 0    S)+t{CCDDD   SYY * * * X   & &'9 : : A A ""#344     & &s{3J'K L L L)+t{CCDDD   SYY * * *IIIE   QZ(((    & &s{3J'KT R R R R RD & &s{3J'KT R R R Rs E G (G1cFttd|jd t tjt|j | tj ddn+#| tj ddwxYwt tjt|j }|dt|dS)zs Check that when a dropin file is removed, L{plugin.getPlugins} doesn't return it anymore. rrrTN)r r2r3r4r0r/r~r rrr7rTr&r)rjr)r8rs rtest_detectFilesRemovedz#PluginTests.test_detectFilesRemoveds ""#566== L  / 0 0    S "; << = = =  & &s{3J'KT R R R RD & &s{3J'KT R R R RF%k4;??@@ CII&&&&&s ,B''(Cc|}|tj||jj| ttj t|j}| t|d|jj|dS#|jj|wxYw)zy Test that getCache skips over any entries in a plugin package's C{__path__} which do not exist. rN)r,rrMr'existsr7__path__appendr~r rrrjrrN)r8r'rs rtest_nonexistentPathEntryz%PluginTests.test_nonexistentPathEntrys {{}} --... ##D))) .)+t{CCDDD   SYY * * * K ' ' - - - - -DK ' ' - - - -s 'AC!C8cVt|}||||dj}|jj | ttj t|j}|t|d|jj|dS#|jj|wxYw)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'r7rrr~r rrrjrrN)r8r'r/rs rtest_nonDirectoryChildEntryz'PluginTests.test_nonDirectoryChildEntry"s  && '''  >**/ ##E*** /)+t{CCDDD   SYY * * * K ' ' . . . . .DK ' ' . . . .s AD!D(ctj|j|jd}t t d|jdttj |jj dtj |j d| tj |jj d| tj |j dg}t|j| t |jtj|j}|d|||j|d|j t&jfz}|D]}t+|}|J||vrd S|d |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. rVrri@ir3Unable to write to plugin cache %s: error number %dN9Did not observe unwriteable cache warning in log events: )r rir7r0r/r r2r3r4invalidateImportCachesrMchmodr' addCleanupr rrrkr5errnoEPERMrfail)r8 cachepatheventsruexpectedevent maybeTexts rtest_deployedModezPluginTests.test_deployedMode3s  $$$L&&~66  ""#566== L  / 0 0        "E*** ''' $,"3U;;; ).%888#%FM"""  666 ,, mU+++ d)5111I N KL    E)%00I(((9$$% III &)     rNr r!)F)r7rrBrCr r!)rXrYr rZ)rrrrr9r@rTrWr`ryrrrrrrrrrrrrr,s     0....8= 4444 ("1"1"1^"1H     ^ SSS^S:SSS^S@'''^'" . . .^ .///^/ //////rrsj from twisted.plugin import pluginPackagePaths __path__.extend(pluginPackagePaths(__name__)) __all__ = [] rpstrr bytescRd|dS)Nzfrom zope.interface import provider from twisted.plugin import IPlugin from twisted.test.test_plugin import ITestPlugin @provider(IPlugin, ITestPlugin) class {}: pass ascii)formatencoder|s rpluginFileContentsrms$    r entrypath FilePath[str] pluginContentrealrC pluginModulec||d}||r(|dd|d}||r-|dt||dz||S)z' Create a plugindummy package. plugindummyr$rrm.py)r.r/r1pluginInitFile)rrrrpkgplugss r_createPluginDummyr}s  //- ( (C 1 -  ++C000 IIi E  > M""--n=== KK u$%%00??? LrceZdZUded<dS)_HasBoolLegacyKeyrClegacyN)rrr__annotations__rrrrrsLLLLLrrcbeZdZdZddZddZddZddZdd Zdd Z dd Z dd Z dd Z ddZ dS)DeveloperSetupTestsz These tests verify things about the plugin system without actually interacting with the deployed 'twisted.plugins' package, instead creating a temporary package. r r!ctjdd|_tj|_t ||_|j |j d|_ |j d|_ |j d|_ t|j tddd|_t|j tddd|_t|j td d d |_tjd |j |j fD||j d  d|_|j d|_t/j}t1j|j dj|dz fdzt1j|jj|dz fdz||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_appcg|] }|j Srr'rexs rrgz-DeveloperSetupTests.setUp..sIIIAIIIrrrmrVzplugindummy_builtin.pyiri)r&r' savedPathr)r*r+r r,fakeRootr.r/ systemPathdevPathappPathrr systemPackage devPackage appPackageextend getAllPluginssysplugsyscachetimerMutime lockSystemresetEnvironment)r8nows rr9zDeveloperSetupTests.setUps!!!K,,.. //  %%'''---m<<}**+=>> }**+=>> / O/994AV  - L,U33T;P  - L,U33U:: ikk ##$<==BS4ZMTUDUVVV #cDj]Q%6777  rctj|jjdtj|jjddS)zW Lock the system directories, as if they were unwritable by this user. imNrMrrr'rr?s rrzDeveloperSetupTests.lockSystem8 "E*** #U+++++rctj|jjdtj|jjddS)zW Unlock the system directories, as if they were writable by this user. iNrr?s r unlockSystemz DeveloperSetupTests.unlockSystemrr list[str]czddl}ttjt|j}d|DS)zl Get all the plugins loadable from our dummy package, and return their short names. rNcg|] }|j Srr)replugs rrgz5DeveloperSetupTests.getAllPlugins..s,,,$ ,,,r)plugindummy.pluginsr~r rrrm)r8rrs rrz!DeveloperSetupTests.getAllPluginssA #""" "; 0CDD E E,,!,,,,rc|tjd|j|j|jfDdS)zc Change the environment to what it should be just as the test is starting. cg|] }|j Srrrs rrgz8DeveloperSetupTests.resetEnvironment..sWWWAWWWrN)unsetEnvironmentr&r'rrrrr?s rrz$DeveloperSetupTests.resetEnvironmentsL  WW$,)VWWWXXXXXrcttjtj|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?s rrz$DeveloperSetupTests.unsetEnvironmentsR      4,---n rcV||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?s rr@zDeveloperSetupTests.tearDowns0  rctdD]B}|}|||ddgCdS)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)rangersortrj)r8rrs r"test_developmentPluginAvailabilityz6DeveloperSetupTests.test_developmentPluginAvailabilitys^q 4 4A&&((E JJLLL   UUEN 3 3 3 3 4 4rc|jd}|tdt jdz }t j|j||f|d}td}tj |jjfddi|t j|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/r1rrrMrr'r3r compileall compile_dirrNrrkrr)r8mypathrpycextras rtest_freshPyReplacesStalePycz0DeveloperSetupTests.test_freshPyReplacesStalePyc s &&z22,U33444 IKK$  q!f%%%nn[)) "...t3FF1FFFF Aq6"""   eT//11222 eT//11222 ,U33444 eT//11222 eT//1122222rc|||jdt d|t j|j jg}t|j | t|j |d|d|jjt"jfz}|D]}t'|}|J||vrdS|d|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.pyrrNr)rrr/r1rrr&r'rNrr rrrrkrrrrrr)r8rrrrs rtest_newPluginsOnReadOnlyPathz1DeveloperSetupTests.test_newPluginsOnReadOnlyPath,sJ  =))445G5N5NOOO   )***#%FM"""  666 eT//11222I M  KL    E)%00I(((9$$% III &)     rNr)r r)rrrrr9rrrrrr@rrrrrrrrs ( ( ( ( T,,,,,,,, - - - -YYYY%%%%     4 4 4 43333@&&&&&&rrc:eZdZdZddZddZdd Zdd Zdd ZdS)AdjacentPackageTestsz Tests for the behavior of the plugin system when there are multiple installed copies of the package containing the plugins being loaded. r r!c~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?s rr9zAdjacentPackageTests.setUp[s2 HQQQKK,,..rc|jtjdd<tjtj|jdSr;r<r?s rr@zAdjacentPackageTests.tearDownbrArr-rrpr pluginNamec||}|d}||dd|d}||dt||dz}|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$rrmr)r/makedirsr1rr)r8r-rpr directoryr0rmrs rcreateDummyPackagez'AdjacentPackageTests.createDummyPackagejs,JJt$$ //'** m$$//444-- ** m$$//???}}Z%%788  24 8 8999rct|}|||dd}||dd}tj|jtj|jddl}ttj t|j }| dgd|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 somepluginsecondrNcg|] }|j Srrrds rrgzWAdjacentPackageTests.test_hiddenPackageSamePluginModuleNameObscured..$A$A$AAQZ$A$A$Arr r,rrr&r'r dummy.pluginsr~r rrrmrjr8r-firstDirectorysecondDirectoryrrms r.test_hiddenPackageSamePluginModuleNameObscuredzCAdjacentPackageTests.test_hiddenPackageSamePluginModuleNameObscured  && 00w MM11$,OO +,,, ,---v(emDDEE '$A$A$A$A$ABBBBBrct|}|||dd}||dd}tj|jtj|jddl}ttj t|j }| dgd|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 thatpluginrNcg|] }|j Srrrds rrgz\AdjacentPackageTests.test_hiddenPackageDifferentPluginModuleNameObscured..r rr!r#s r3test_hiddenPackageDifferentPluginModuleNameObscuredzHAdjacentPackageTests.test_hiddenPackageDifferentPluginModuleNameObscuredr'rNr)r-rrprrrr r) rrrrr9r@rr&r,rrrrrUs ////....BCCCC(CCCCCCrrc2eZdZdZd dZd dZd dZd dZdS) PackagePathTestszg Tests for L{plugin.pluginPackagePaths} which constructs search paths for plugin packages. r r!c8tjdd|_dS)z3 Save the elements of C{sys.path}. N)r&r'r(r?s rr9zPackagePathTests.setUps HQQQKrc2|jtjdd<dS)z< Restore C{sys.path} to its original value. N)r(r&r'r?s rr@zPackagePathTests.tearDowns' rcrtd}td}|j|jgt_|t jd|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.pluginsrrmN)r r'r&rjr pluginPackagePathsr/)r8r2r3s rtest_pluginDirectoriesz'PackagePathTests.test_pluginDirectoriess uoouooHch'   %o 6 6 '""((338 '""((338      rct|}|ddd}||dd|dj|djgt _|tj 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. r2rrmr$rr3r4N) r r,r/rr1r'r&rjr r5)r8r-r2s rtest_pluginPackagesExcludedz,PackagePathTests.test_pluginPackagesExcludeds &&jj%%g..44Y??  -  ++C000JJu%%*DJJu,=,=,BC   %o 6 6 ZZ   $ $W - - 3 3I > > C D     rNr)rrrrr9r@r6r8rrrr.r.sn (((( ((((     "      rr.)rprr r) rrrrrrCrrr r)+r __future__rr rr^rMr&r importlibrrtypesrtypingrrrzope.interfacer twistedr twisted.python.filepathr twisted.python.logr r rr twisted.trialrrrrTestCaserrrrrrrr.rrrrCs #"""""  AAAAAA//////////$$$$$$,,,,,,XXXXXXXXXXXX"""""" WT]])9 vvvvv(#vvvt      & ~~~~~(+~~~B\C\C\C\C\C8,\C\C\C~4 4 4 4 4 x(4 4 4 4 4 r