o Óó·ihã@sPdZddlmZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z ddlmZmZmZddlmZddlmZdd lmZdd lmZmZmZmZdd lmZed ƒZGd d„deƒZ Gdd„deƒZ!Gdd„dej"ƒZ#dZ$d*dd„Z%d+d d!„Z&Gd"d#„d#eƒZ'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Ú TypedDictÚTypeVar)Ú Interface)Úplugin)ÚFilePath)Ú EventDictÚ addObserverÚremoveObserverÚtextFromEventDict)ÚunittestÚ_Tc@óeZdZdZdS)Ú ITestPluginzS A plugin for use by the plugin system's unit tests. Do not use this. N©Ú__name__Ú __module__Ú __qualname__Ú__doc__©rrú^C:\Users\psant\Downloads\PAF backend\school\venv\Lib\site-packages\twisted/test/test_plugin.pyrórc@r)Ú ITestPlugin2z See L{ITestPlugin}. Nrrrrrr&rrc@s¼eZdZdZd)dd„Zd)dd„Z d*d+d d„Zd)dd„Zd,dd„Zed)dd„ƒZ d)dd„Z ed)dd„ƒZ ed)dd„ƒZ ed)dd„ƒZ 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. ÚreturnÚNonecCs¤tjdd…|_tj ¡|_t| ¡ƒ|_|j  ¡|j  d¡|_ |j   ¡|j   d¡  d¡tt ƒ d¡ |j   d¡¡d|_tj 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)ÚselfrrrrÚsetUp2s    ÿ zPluginTests.setUpcCó,|jtjdd…<tj ¡tj |j¡dS©zR Restore C{sys.path} and C{sys.modules} to their original values. N©r%r#r$r&ÚclearÚupdater(©r5rrrÚtearDownJó zPluginTests.tearDownFr4rÚ deleteSourceÚboolc Cs”|jdusJ‚|j d¡}d |dd…¡}|d}ttj||ƒtj|j=ddg|r/dgp0gD]}z t |j|¡Wq2t yGYq2wdS)NÚ.éÿÿÿÿÚcÚoÚ) r/rÚsplitÚjoinÚdelattrr#r&ÚosÚremoveÚFileNotFoundError)r5r4r?Z modulePathÚ packageNameÚ moduleNameÚextrrrÚ_unimportPythonModuleRs   ÿýz!PluginTests._unimportPythonModulecCs|j d¡ ¡dS)z; Remove the plugins B{droping.cache} file. ú dropin.cacheN)r-r,rJr<rrrÚ _clearCachebózPluginTests._clearCacheÚmethúCallable[[PluginTests], object]úCallable[[PluginTests], None]cst ˆ¡d‡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. r5rrrcs,ˆ|ƒˆ|ƒ| ¡ˆ|ƒˆ|ƒdS)N)rQr<©rSrrÚwrappedrs  z+PluginTests._withCacheness..wrappedN)r5rrr)Ú functoolsÚwraps)rSrWrrVrÚ_withCachenesshs zPluginTests._withCachenesscCsÒt |j¡}||j}| |jd|j›¡| d|j¡dd„|jDƒd}|  |j |¡| |j d¡| |j  ¡d¡| |j ttjg¡| ¡}|  |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.cSsg|] }t|jvr|‘qSr)rÚprovided©Ú.0ÚprrrÚ ‹sz*PluginTests.test_cache..rÚ TestPluginz*A plugin used solely for testing purposes.N)r ÚgetCacher4r2Ú assertEqualrMÚassertInÚ descriptionÚpluginsZassertIsÚdropinÚnameÚstripr[rZIPluginÚloadr#r&r`Zmypackage.testpluginr")r5ÚcacherfÚp1Z realPluginÚtprrrÚ test_cache|s$   ÿþ zPluginTests.test_cachecCs>t |j¡|j}tdd„|jDƒƒd}| t|ƒd¡dS)zm L{CachedPlugin} has a helpful C{repr} which contains relevant information about it. css|] }|jdkr|VqdS)r`N©rgr\rrrÚ §s€z-PluginTests.test_cacheRepr..rzTN)r rar4r2ÚlistrerbÚrepr)r5Z cachedDropinZ cachedPluginrrrÚtest_cacheRepr¡sÿþzPluginTests.test_cacheReprcCsLtt 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. éZAnotherTestPluginZThirdTestPluginN) rpr Ú getPluginsrr4rbÚlenrJrÚtest)r5reÚnamesr^rrrÚ test_plugins°s  þzPluginTests.test_pluginsc Cs¸ttƒ d¡ |j d¡¡zC| dtj¡|  t tjddƒd¡t t   t|j¡ƒ}| t|ƒd¡dd 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.pyúpluginextra.pyúmypackage.pluginextrarÚ pluginextraz&mypackage still has pluginextra modulersr`ÚFourthTestPluginTN)r r/r0r1r-r,ÚfailIfInr#r&Ú assertFalseÚhasattrrpr rtrr4rbrurJrÚtest1rO©r5Úplgsrwr^rrrÚtest_detectNewFilesÁs" ÿþ  þ*zPluginTests.test_detectNewFilesc Csàttƒ d¡ |j d¡¡zWtt t |j ¡ƒ}|  t |ƒd¡ttƒ d¡ |j d¡¡|  tjd¡tt t |j ¡ƒ}|  t |ƒd¡gd¢}|D] }| |j¡| ¡qMW|  tjdd¡d S|  tjdd¡w) z… Check that if the content of a plugin change, L{plugin.getPlugins} is able to detect the new plugins added. ryrzrszplugin_extra2.pyr{é)r`r}ZFifthTestPluginTN)r r/r0r1r-r,rpr rtrr4rbrurOr#r&rJrrr‚rrrÚtest_detectFilesChangedßs$ ÿ ÿ  þ*z#PluginTests.test_detectFilesChangedc Cs€ttƒ d¡ |j d¡¡ztt t |j ¡ƒW|  t j dd¡n |  t j dd¡wtt t |j ¡ƒ}| dt|ƒ¡dS)zs Check that when a dropin file is removed, L{plugin.getPlugins} doesn't return it anymore. ryrzr{TéN)r r/r0r1r-r,rpr rtrr4rOr#r&rbru)r5rƒrrrÚtest_detectFilesRemoveds ÿ(z#PluginTests.test_detectFilesRemovedc Csp| ¡}| 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)rrIr$Úexistsr4Ú__path__Úappendrpr rtrrbrurJ)r5r$rƒrrrÚtest_nonexistentPathEntrys"z%PluginTests.test_nonexistentPathEntryc Cs„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. Z test_packager‡N)r r)rr‰Útouchr,r$r4rŠr‹rpr rtrrbrurJ)r5r$r,rƒrrrÚtest_nonDirectoryChildEntry"s  "z'PluginTests.test_nonDirectoryChildEntrycCst |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|ƒ}|d usvJ‚||vr}d Sqj| 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. rPryrzi@éiÀr|ú3Unable to write to plugin cache %s: error number %dNú;Did not observe unwriteable cache warning in log events: %r)r rar4r-r,r r/r0r1ÚinvalidateImportCachesrIÚchmodr$Ú addCleanupr r‹r rcr2ÚerrnoÚEPERMrÚfail)r5Z cachepathÚeventsrjÚexpectedÚeventÚ maybeTextrrrÚtest_deployedMode3s>   ÿ   þ ÿÿÿzPluginTests.test_deployedModeN©rr)F)r4rr?r@rr)rSrTrrU)rrrrr6r=rOrQrZrmrrrxr„r†rˆrŒrŽrœrrrrr,s0   ÿ    $      rsj from twisted.plugin import pluginPackagePaths __path__.extend(pluginPackagePaths(__name__)) __all__ = [] rgÚstrrÚbytescCsd |¡ 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ÚencodernrrrÚpluginFileContentsmsõr£Ú entrypathú FilePath[str]Ú pluginContentÚrealr@Ú pluginModulecCsl| ¡| d¡}| ¡|r| d¡ d¡| d¡}| ¡|r*| d¡ t¡| |d¡ |¡|S)z' Create a plugindummy package. Ú plugindummyr r!reú.pyN)r+r,r.ÚpluginInitFile)r¤r¦r§r¨ÚpkgZplugsrrrÚ_createPluginDummy}s  r­c@seZdZUded<dS)Ú_HasBoolLegacyKeyr@ÚlegacyN)rrrÚ__annotations__rrrrr®s r®c@steZdZdZddd„Zddd„Zddd „Zdd d „Zdd d„Zddd„Z ddd„Z ddd„Z ddd„Z ddd„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. rrcCs>tjdd…|_tj ¡|_t| ¡ƒ|_|j  ¡|j  d¡|_ |j  d¡|_ |j  d¡|_ t|j tdƒddƒ|_t|j tdƒddƒ|_t|j td ƒd d ƒ|_tj d d „|j |j fDƒ¡| ¡|j   d¡  d¡|_|j  d¡|_t ¡}t |j  d¡j|dfd¡t |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. NZ system_pathZdevelopment_pathZapplication_pathÚsystemTZplugindummy_builtinÚdevÚappFZplugindummy_appcSóg|]}|j‘qSr©r$©r]Úxrrrr_´óz-DeveloperSetupTests.setUp..r©rerPzplugindummy_builtin.pyiˆrsiÐ)r#r$Ú savedPathr&r'r(r r)ZfakeRootr+r,Ú systemPathÚdevPathÚappPathr­r£Z systemPackageZ devPackageÚ appPackageÚextendÚ getAllPluginsÚsysplugÚsyscacheÚtimerIÚutimeÚ lockSystemÚresetEnvironment)r5Únowrrrr6›s2  ÿÿÿ  zDeveloperSetupTests.setUpcCó$t |jjd¡t |jjd¡dS)zW Lock the system directories, as if they were unwritable by this user. imN©rIr“rÁr$rÂr<rrrrÅÅózDeveloperSetupTests.lockSystemcCrÈ)zW Unlock the system directories, as if they were writable by this user. iÿNrÉr<rrrÚ unlockSystemÌrÊz DeveloperSetupTests.unlockSystemú list[str]cCs(ddl}tt t|j¡ƒ}dd„|DƒS)zl Get all the plugins loadable from our dummy package, and return their short names. rNcSrµr©r)r]Zplugrrrr_Ýr¹z5DeveloperSetupTests.getAllPlugins..)Zplugindummy.pluginsrpr rtrre)r5r©r¸rrrrÀÓsz!DeveloperSetupTests.getAllPluginscCs.| ¡tj dd„|j|j|jfDƒ¡dS)zc Change the environment to what it should be just as the test is starting. cSrµrr¶r·rrrr_år¹z8DeveloperSetupTests.resetEnvironment..N)ÚunsetEnvironmentr#r$r¿r¼r»r½r<rrrrÆßs&z$DeveloperSetupTests.resetEnvironmentcCs2tƒtj ¡tj |j¡|jtjdd…<dS)zh Change the Python environment back to what it was before the test was started. N)r’r#r&r:r;r(rºr$r<rrrrÎçs 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)rÎrËr<rrrr=ñs zDeveloperSetupTests.tearDowncCs2tdƒ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ÀÚsortrb)r5r¸rwrrrÚ"test_developmentPluginAvailabilityþs ýz6DeveloperSetupTests.test_developmentPluginAvailabilitycCsâ|j d¡}| tdƒ¡t ¡d}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.pyÚoneièz stale.pycT)r¯Úquietr‡ZtwoN)r¾r,r.r£rÃrIrÄr$r0r®Ú compileallÚ compile_dirrJrÆrcrÀr~)r5Zmypathr¸ZpycÚextrarrrÚtest_freshPyReplacesStalePyc s    z0DeveloperSetupTests.test_freshPyReplacesStalePyccCs´| ¡|j d¡ tdƒ¡| ¡tj |j j¡g}t |j ƒ|  t |j ¡| d| ¡¡d|jjtjf}|D]}t|ƒ}|dusHJ‚||vrOdSq<| 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ÒrNr‘)rËrÁr,r.r£rÅr#r$rJr¼r r‹r”r rcrÀrÂr•r–rr—)r5r˜r™ršr›rrrÚtest_newPluginsOnReadOnlyPath,s.  þ ÿÿÿz1DeveloperSetupTests.test_newPluginsOnReadOnlyPathNr)rrÌ)rrrrr6rÅrËrÀrÆrÎr=rÑr×rØrrrrr±”s  *     r±c@sBeZdZdZddd„Zddd„Zdd d„Zddd„Zddd„ZdS)Ú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*r¥rgržÚ pluginNamecCsn| |¡}| 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!rerªN)r,Úmakedirsr.r«r£)r5r*rgrÚÚ directoryr-rer¨rrrÚcreateDummyPackagejs   z'AdjacentPackageTests.createDummyPackagecCs‚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ÚsecondrNcSrµrrÍr\rrrr_r¹zWAdjacentPackageTests.test_hiddenPackageSamePluginModuleNameObscured..©r r)rÜrÞr#r$r‹Z dummy.pluginsrpr rtrrerb©r5r*ZfirstDirectoryZsecondDirectoryrÛrerrrÚ.test_hiddenPackageSamePluginModuleNameObscured‹ó zCAdjacentPackageTests.test_hiddenPackageSamePluginModuleNameObscuredcCs‚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 thatpluginrNcSrµrrÍr\rrrr_±r¹z\AdjacentPackageTests.test_hiddenPackageDifferentPluginModuleNameObscured..rárârrrÚ3test_hiddenPackageDifferentPluginModuleNameObscuredŸräzHAdjacentPackageTests.test_hiddenPackageDifferentPluginModuleNameObscuredNr)r*r¥rgržrÚržrr¥) rrrrr6r=rÞrãrårrrrrÙUs    !rÙc@s8eZdZdZd dd„Zd dd„Zd 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<rrrr6ºrRzPackagePathTests.setUpcCs|jtjdd…<dS)z< Restore C{sys.path} to its original value. N)r%r#r$r<rrrr=ÀrRzPackagePathTests.tearDowncCsTtdƒ}tdƒ}|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ÛreN)r r$r#rbr ÚpluginPackagePathsr,)r5rçrèrrrÚtest_pluginDirectoriesÆsþþz'PackagePathTests.test_pluginDirectoriescCs€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Ûrer r!rèréN) r r)r,rÜr.r$r#rbr rê)r5r*rçrrrÚtest_pluginPackagesExcluded×s þz,PackagePathTests.test_pluginPackagesExcludedNr)rrrrr6r=rërìrrrrræ´s    ræ)rgržrrŸ) r¤r¥r¦rŸr§r@r¨ržrr¥)+rÚ __future__rrÔr•rXrIr#rÃÚ importlibrr’ÚtypesrÚtypingrrrZzope.interfacerZtwistedr Ztwisted.python.filepathr Ztwisted.python.logr r r rZ twisted.trialrrrrZTestCaserr«r£r­r®r±rÙrærrrrÚs<       <  B_