+ jhRt^RIHt^RIt^RIt^RIt^RIt^RIt^RIt^RI H t ^RI H t ^RIHtHtHt^RIHt^RIHt^RIHt^R IHtHtHtHt^R IHt]!R 4t!R R ]4t !RR]4t!!RR]PD4t#Rt$RRlt%RRlt&!RR]4t'!RR]PD4t(!RR]PD4t)!RR]PD4t*R#)z" Tests for Twisted plugin system. ) annotationsN)invalidate_caches) ModuleType)Callable TypedDictTypeVar) Interface)plugin)FilePath) EventDict addObserverremoveObservertextFromEventDict)unittest_Tc]tRt^tRtRtR#) ITestPluginzG A plugin for use by the plugin system's unit tests. Do not use this. N__name__ __module__ __qualname____firstlineno____doc____static_attributes__r:/usr/lib/python3/dist-packages/twisted/test/test_plugin.pyrrsrrc]tRt^&tRtRtR#) ITestPlugin2z See L{ITestPlugin}. rNrrrrrr&srrc ]tRt^,tRtRRltRRltR RRlltRR ltR R lt ] R R l4t RRlt ] RRl4t ] RRl4t ] RRl4t] RRl4t] RRl4t] RRl4tRRltRtR#)! PluginTestszS Tests which verify the behavior of the current, active Twisted plugins directory. cV^8dQhRR/#returnNoner)formats"r __annotate__PluginTests.__annotate__2s  t rc \PR,Vn\PP 4Vn\ VP44VnVPP4VPPR4Vn VPP4VPPR4PR4\ \4PR4PVPPR44RVn\PP#^VPP4^RIpWnR#) zF Save C{sys.path} and C{sys.modules}, and create a package for tests. NNN mypackage __init__.pyrzplugin_basic.pyz testplugin.py testpluginN)syspath originalPathmodulescopy savedModulesr mktemprootcreateDirectorychildpackage setContent__file__siblingcopyTooriginalPlugininsertr+module)selfr+s& rsetUpPluginTests.setUp2s HHQKKK,,.T[[]+  !!#yy{3  $$& =)44S9""#45<< LL   / + 499>>* rcV^8dQhRR/#r"r)r&s"rr'r(J..$.rc VP\PR&\PP 4\PP VP 4R#zB Restore C{sys.path} and C{sys.modules} to their original values. r*Nr0r.r/r1clearupdater3r@s&rtearDownPluginTests.tearDownJ?''   4,,-rc$V^8dQhRRRRRR/#)r#r?r deleteSourceboolr$r%r)r&s"rr'r(Rs$ 04 rc VPfQhVPPR4pRPVRR4pVR,p\ \ P V,V4\ P VPRR.T;'d R.;'g.,F+p\P!VPV,4K- R# \dK?i;i)N.co) r:rsplitjoindelattrr.r1osremoveFileNotFoundError)r@r?rO modulePath packageName moduleNameexts&&& r_unimportPythonModule!PluginTests._unimportPythonModuleRs***__**3/ hhz#2/ ^  K(*5 KK (:!6!62$!%  s)'C C%$C%cV^8dQhRR/#r"r)r&s"rr'r(bs44T4rc XVPPR4P4R#)z+ Remove the plugins B{droping.cache} file. dropin.cacheN)r8r7r[rJs&r _clearCachePluginTests._clearCachebs >*113rc V^8dQhRRRR/#)r#methzCallable[[PluginTests], object]r$zCallable[[PluginTests], None]r)r&s"rr'r(hs- &rc La\P!S4RV3Rll4pV#)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 V^8dQhRRRR/#)r#r@r r$r%r)r&s"rr'0PluginTests._withCacheness..__annotate__ss  + $ rch<S!V4S!V4VP4S!V4S!V4R#)N)rf)r@ris&rwrapped+PluginTests._withCacheness..wrappedrs+ J J     J Jr) functoolswraps)rirnsf r_withCachenessPluginTests._withCachenesshs'     rcV^8dQhRR/#r"r)r&s"rr'r(}s"1"1D"1rc t\P!VP4pWP,pVP VP RVP 24VP RVP4VPUu.uFp\VP9gKVNK up^,pVPVPV4VP VPR4VP VPP4R4VP VP\\P.4VP!4pVPV\"P$RVP 2,P&4^RIHpVPWVP&4R#uupi)z 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. TestPluginz*A plugin used solely for testing purposes.N)r getCacher?r= assertEqualr_assertIn descriptionpluginsrprovidedassertIsdropinnamestripIPluginloadr.r1rvmypackage.testpluginr-)r@cacher~pp1 realPlugintps& r test_cachePluginTests.test_cache|sF ,**+ **j9L9L8M,NO +V-?-?@  EA;!**+Daa Ea H bii( ,/  NN "$P  {FNN&CDWWY   KK*T%8%8$9: ; F F * j--0)Fs F5"F5cV^8dQhRR/#r"r)r&s"rr'r(s     rc \P!VP4VP,p\ RVP 44^,pVP \V4R4R#)zU L{CachedPlugin} has a helpful C{repr} which contains relevant information about it. c3J"TFqPR8XgKVxK R#5i)rvNr).0rs& r -PluginTests.test_cacheRepr..sV';!vv?UAA';s# #zTN)r rwr?r=listr{rxrepr)r@ cachedDropin cachedPlugins& rtest_cacheReprPluginTests.test_cacheReprs\ t{{3D4G4GH V|';';VV      1 rcV^8dQhRR/#r"r)r&s"rr'r(sdrc \\P!\VP44pVP \ V4^4RR.pVF.pVPVP4VP4K0 R#)z 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) rr getPluginsrr?rxlenr[rtest)r@r{namesrs& r test_pluginsPluginTests.test_pluginssav((t{{CD Wq)$&78A LL $ FFHrcV^8dQhRR/#r"r)r&s"rr'r(sSSTSrc \\4PR4PVPP R44VP R\P4VP\\PR,R4R4\\P!\VP44pVP!\#V4^4RR.pVF.pVP%VP&4VP)4K0 VP+\PR,R 4R # TP+\PR,R 4i;i) zM Check that L{plugin.getPlugins} is able to detect plugins added at runtime. plugin_extra1.pypluginextra.pymypackage.pluginextrar+ pluginextraz&mypackage still has pluginextra modulervFourthTestPluginTN)r r:r;r<r8r7failIfInr.r1 assertFalsehasattrrr rrr?rxrr[rtest1rar@plgsrrs& rtest_detectNewFilesPluginTests.test_detectNewFiless  ""#56== LL  / 0  S MM13;; ?    K0-@8  ))+t{{CDD   SY *!#56E QZZ(   & &s{{3J'KT RD & &s{{3J'KT Rs CE)E,cV^8dQhRR/#r"r)r&s"rr'r(sSSSrc \\4PR4PVPP R44\ \P!\VP44pVP\V4^4\\4PR4PVPP R44VP\PR,4\ \P!\VP44pVP\V4^4.ROpVF.pVP!VP"4VP%4K0 VP\PR,R4R# TP\PR,R4i;i)zm Check that if the content of a plugin change, L{plugin.getPlugins} is able to detect the new plugins added. rrzplugin_extra2.pyrTN)rvrFifthTestPlugin)r r:r;r<r8r7rr rrr?rxrrar.r1r[rrrs& rtest_detectFilesChanged#PluginTests.test_detectFilesChangedsG ""#56== LL  / 0  S))+t{{CDD   SY * X  & &'9 : A A ""#34   & &s{{3J'K L))+t{{CDD   SY *IE QZZ(   & &s{{3J'KT RD & &s{{3J'KT Rs D6F'')GcV^8dQhRR/#r"r)r&s"rr'r(s'''rc (\\4PR4PVPP R44\ \P!\VP44VP\PR,R4\ \P!\VP44pVP^\V44R# TP\PR,R4i;i)z[ Check that when a dropin file is removed, L{plugin.getPlugins} doesn't return it anymore. rrrTN)r r:r;r<r8r7rr rrr?rar.r1rxr)r@rs& rtest_detectFilesRemoved#PluginTests.test_detectFilesRemoveds ""#56== LL  / 0  S ""; < =  & &s{{3J'KT RF%%k4;;?@ CI&  & &s{{3J'KT Rs .C(()DcV^8dQhRR/#r"r)r&s"rr'r(s . .4 .rc VP4pVP\PP V44VP P PV4\\P!\VP 44pVP\V4^4VP P PV4R# TP P PT4i;i)za Test that getCache skips over any entries in a plugin package's C{__path__} which do not exist. N)r4rrZr/existsr?__path__appendrr rrrxrr[)r@r/rs& rtest_nonexistentPathEntry%PluginTests.test_nonexistentPathEntrys {{} -. ##D) .))+t{{CDD   SY * KK ' ' -DKK ' ' -s %A C'C<cV^8dQhRR/#r"r)r&s"rr'r(#s//T/rc H\VP44pVPVP44VP 4VP R4P pVPPPV4\\P!\VP44pVP\V4^4VPPP!V4R# TPPP!T4i;i)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_packageN)r r4rrtouchr7r/r?rrrr rrrxrr[)r@r/r7rs& rtest_nonDirectoryChildEntry'PluginTests.test_nonDirectoryChildEntry"s  & '  >*// ##E* /))+t{{CDD   SY * KK ' ' .DKK ' ' .s A C::'D!cV^8dQhRR/#r"r)r&s"rr'r(3s//4/rc 4\P!VP4VPP R4p\ \ 4PR4PVPP R44\4\P!VPPR4\P!VPR4VP\PVPPR4VP\PVPR4.p\VP4VP\ VP4\P!VP4pVP#RV4VP#VP$V4RVP\&P(3,pVFp\+V4pVfQhWF9gKR # VP-R V: 24R #) 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. rerri@ir3Unable to write to plugin cache %s: error number %dN9Did not observe unwriteable cache warning in log events: )r rwr?r8r7r r:r;r<invalidateImportCachesrZchmodr/ addCleanupr rr ryr=errnoEPERMrfail)r@ cachepatheventsrexpectedevent maybeTexts& rtest_deployedModePluginTests.test_deployedMode3s  $LL&&~6  ""#56== LL  / 0    ""E* ' $,,"3"3U; )..%8#%FMM"  6 , mU+ d))51I NN KKL  E)%0I( (($  II &) r)r?r0r=r8r5r3N)F)rrrrrrArKrarfrrrrrrrrrrrrrrrr r ,s  0. 4 ("1"1H   SS:SS@''" . .// //rr sj from twisted.plugin import pluginPackagePaths __path__.extend(pluginPackagePaths(__name__)) __all__ = [] c V^8dQhRRRR/#)r#rstrr$bytesr)r&s"rr'r'ms  S U rcBRPV4PR4#)zfrom zope.interface import provider from twisted.plugin import IPlugin from twisted.test.test_plugin import ITestPlugin @provider(IPlugin, ITestPlugin) class {}: pass ascii)r&encoders&rpluginFileContentsrms     rc ,V^8dQhRRRRRRRRR R/#) r# entrypath FilePath[str] pluginContentrrealrP pluginModulerr$r)r&s"rr'r'}s4-2:>NQrcVP4VPR4pVP4V'd!VPR4PR4VPR4pVP4V'd%VPR4P\4VPVR,4PV4V#)z Create a plugindummy package. plugindummyr,rr{.py)r6r7r9pluginInitFile)rrrrpkgplugss&&&& r_createPluginDummyr}s  //- (C  - ++C0 IIi E   M"--n= KK u$%00? Lrc"]tRtRt$R]R&RtR#)_HasBoolLegacyKeyirPlegacyrN)rrrr__annotations__rrrrrrs Lrrc]tRtRtRtRRltRRltRRltR R ltR R lt R Rlt RRlt RRlt RRlt RRltRtR#)DeveloperSetupTestsiz These tests verify things about the plugin system without actually interacting with the deployed 'twisted.plugins' package, instead creating a temporary package. cV^8dQhRR/#r"r)r&s"rr' DeveloperSetupTests.__annotate__s( ( t( rc l\PR,Vn\PP 4Vn\ VP44VnVPP4VPPR4Vn VPPR4Vn VPPR4Vn \VP\R4RR4Vn\VP\R4RR4Vn\VP\R 4R R 4Vn\PP'VPVP3Uu.uFqPNK up4VP)4VPPR 4PR 4VnVP*PR4Vn\.P.!4p\0P2!VP*PR4PVR, 3^,4\0P2!VP,PVR, 3^,4VP54VP74R#uupi)a 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. r* system_pathdevelopment_pathapplication_pathsystemTplugindummy_builtindevappFplugindummy_apprr{rezplugindummy_builtin.pyiiN)r.r/ savedPathr1r2r3r r4fakeRootr6r7 systemPathdevPathappPathrr systemPackage devPackage appPackageextend getAllPluginssysplugsyscachetimerZutime lockSystemresetEnvironment)r@xnows& rrADeveloperSetupTests.setUps!KK,,. /  %%'----m<}}**+=> }}**+=> / OO/94AV - LL,U3T;P - LL,U3U: iik ##$<=BBS4ZMTUDUV ##cDj]Q%67  Js=J1cV^8dQhRR/#r"r)r&s"rr'rs,,D,rc \P!VPPR4\P!VPPR4R#)zG Lock the system directories, as if they were unwritable by this user. imNrZrrr/r rJs&rr DeveloperSetupTests.lockSystem4 ""E* ##U+rcV^8dQhRR/#r"r)r&s"rr'rs,,d,rc \P!VPPR4\P!VPPR4R#)zG Unlock the system directories, as if they were writable by this user. iNrrJs&r unlockSystem DeveloperSetupTests.unlockSystemrrcV^8dQhRR/#)r#r$z list[str]r)r&s"rr'rs - -y -rc ^RIp\\P!\VP 44pVUu.uFq3P NK up#uupi)zT Get all the plugins loadable from our dummy package, and return their short names. N)plugindummy.pluginsrr rrr{r)r@rrplugs& rr!DeveloperSetupTests.getAllPluginss> # ""; 0C0CD E*+,!$ !,,,sAcV^8dQhRR/#r"r)r&s"rr'rsYY$Yrc VP4\PPVPVP VP 3Uu.uFqPNK up4R#uupi)zK Change the environment to what it should be just as the test is starting. N)unsetEnvironmentr.r/rrrr)r@rs& rr $DeveloperSetupTests.resetEnvironmentsI  $,,)VW)VA)VWXWsA,cV^8dQhRR/#r"r)r&s"rr'rs%%$%rc \4\PP4\PP VP 4VP \PR&R#)zP Change the Python environment back to what it was before the test was started. r*N)rr.r1rHrIr3rr/rJs&rr!$DeveloperSetupTests.unsetEnvironmentsC    4,,-nn rcV^8dQhRR/#r"r)r&s"rr'rs  $ rc FVP4VP4R#)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!rrJs&rrKDeveloperSetupTests.tearDowns  rcV^8dQhRR/#r"r)r&s"rr'rs 4 4D 4rc \^4F7pVP4pVP4VPVRR.4K9 R#)z 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. rrN)rangersortrx)r@rrs& r"test_developmentPluginAvailability6DeveloperSetupTests.test_developmentPluginAvailabilitys=qA&&(E JJL   UUEN 3rcV^8dQhRR/#r"r)r&s"rr'r s33d3rc XVPPR4pVP\R44\P!4R, p\ P !VPW"34VPR4p\RR7p\P!VPP3R^/VB\ P !VPW"34VP4VP4VPRVP44VP!RVP44VP4VP\R44VP!RVP44VPRVP44R #) 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)rquiettwoN)rr7r9rr rZr r/r;r compileall compile_dirr[r ryrr)r@mypathrpycextras& rtest_freshPyReplacesStalePyc0DeveloperSetupTests.test_freshPyReplacesStalePyc s1 &&z2,U34 IIK$  qf%nn[) ".t33F1FF A6"   eT//12 eT//12 ,U34 eT//12 eT//12rcV^8dQhRR/#r"r)r&s"rr'r,s&&t&rc VP4VPPR4P\ R44VP 4\ PPVPP4.p\VP4VP\VP4VPRVP44RVP P\"P$3,pVFp\'V4pVfQhW$9gKR# VP)RV: 24R#)a 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.pyr1rNr)rrr7r9rr r.r/r[rr rrr ryrr rrrr)r@rrrrs& rtest_newPluginsOnReadOnlyPath1DeveloperSetupTests.test_newPluginsOnReadOnlyPath,s  =)445G5NO   ))*#%FMM"  6 eT//12I MM   KKL  E)%0I( (($  II &) r) rrrrrr3rr rrrN)rrrrrrAr rrr r!rKr-r9r=rrrrrrsA ( T,, -Y%  43@&&rrcV]tRtRtRtRRltRRltRRltR R ltR R lt R t R#)AdjacentPackageTestsiUz Tests for the behavior of the plugin system when there are multiple installed copies of the package containing the plugins being loaded. cV^8dQhRR/#r"r)r&s"rr'!AdjacentPackageTests.__annotate__[s//t/rc \PR,Vn\PP 4VnR#)zC Save the elements of C{sys.path} and the items of C{sys.modules}. r*N)r.r/r0r1r2r3rJs&rrAAdjacentPackageTests.setUp[s) HHQKKK,,.rcV^8dQhRR/#r"r)r&s"rr'rBbrDrc VP\PR&\PP 4\PP VP 4R#rFrGrJs&rrKAdjacentPackageTests.tearDownbrMrc(V^8dQhRRRRRRRR/#)r#r5rrr pluginNamer$r)r&s"rr'rBjs,!),:= rc VPV4pVPR4pVP4VPR4PR4VPR4pVP4VPR4P\4VPVR,4pVP\ V44V#)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,rr{r)r7makedirsr9rr)r@r5rrI directoryr8r{rs&&&& rcreateDummyPackage'AdjacentPackageTests.createDummyPackagejs,JJt$ //'* m$//4-- * m$//?}}Z%%78  24 89rcV^8dQhRR/#r"r)r&s"rr'rBsCCCrc \VP44pVP4VPVRR4pVPVRR4p\P P VP 4\P P VP 4^RIp\\P!\VP44pTPR.VUu.uFqfPNK up4R#uupi)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 somepluginsecondNr r4rLrNr.r/r dummy.pluginsrr rrr{rxrr@r5firstDirectorysecondDirectoryrKr{rs& r.test_hiddenPackageSamePluginModuleNameObscuredCAdjacentPackageTests.test_hiddenPackageSamePluginModuleNameObscured  & 00w M11$,O ++, ,,-v((emmDE '$AAZZ$AB$A%D cV^8dQhRR/#r"r)r&s"rr'rBsCCTCrc \VP44pVP4VPVRR4pVPVRR4p\P P VP 4\P P VP 4^RIp\\P!\VP44pTPR.VUu.uFqfPNK up4R#uupi)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. rR thispluginrT thatpluginNrUrWs& r3test_hiddenPackageDifferentPluginModuleNameObscuredHAdjacentPackageTests.test_hiddenPackageDifferentPluginModuleNameObscuredr\r])r0r3N) rrrrrrArKrNrZrbrrrrr@r@Us) /.BC(CCrr@cJ]tRtRtRtRRltRRltRRltR R ltR t R #) PackagePathTestsiz[ Tests for L{plugin.pluginPackagePaths} which constructs search paths for plugin packages. cV^8dQhRR/#r"r)r&s"rr'PackagePathTests.__annotate__s((t(rc >\PR,VnR#)z# Save the elements of C{sys.path}. r*N)r.r/r0rJs&rrAPackagePathTests.setUps HHQKrcV^8dQhRR/#r"r)r&s"rr'rgs(($(rc @VP\PR&R#)z, Restore C{sys.path} to its original value. r*N)r0r.r/rJs&rrKPackagePathTests.tearDowns'' rcV^8dQhRR/#r"r)r&s"rr'rgs   rc d\R4p\R4pVPVP.\nVP\P !R4VP R4P R4PVP R4P R4P.4R#)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.pluginsrKr{N)r r/r.rxr pluginPackagePathsr7)r@rorps& rtest_pluginDirectories'PackagePathTests.test_pluginDirectoriess uouoHHchh'   % %o 6 '"((388 '"((388  rcV^8dQhRR/#r"r)r&s"rr'rgs  T rc 0\VP44pVPR4PR4PR4pVP4VPR4P R4VPR4P VPR4P .\ nVP\P!R4VPR4PR4PR4P .4R#) aa 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. rorKr{r,rrprqN) r r4r7rLr9r/r.rxr rr)r@r5ros& rtest_pluginPackagesExcluded,PackagePathTests.test_pluginPackagesExcludeds &jj%%g.44Y?  - ++C0JJu%**DJJu,=,B,BC   % %o 6 ZZ  $ $W - 3 3I > C C D r)r0N) rrrrrrArKrsrwrrrrreres  ( (  "  rre)+r __future__rr4rrprZr.r  importlibrrtypesrtypingrrrzope.interfacertwistedr twisted.python.filepathr twisted.python.logr r r r twisted.trialrrrrTestCaser rrrrrr@rerrrrs #  A//$,XX" T])9 v(##vt   & ~(++~B\C8,,\C~4 x((4 r