U  W[fã@s2dZddlmZmZddlZddlZddlZddlZddlZddl Z ddl m Z ddl m Z ddlmZmZddlmZmZmZddlmZdd lmZerªdd lmZnd d „ZGd d„de ƒZGdd„de ƒZGdd„de jƒZdZ dd„Z!dd„Z"Gdd„de jƒZ#Gdd„de jƒZ$Gdd„de jƒZ%dS)z" Tests for Twisted plugin system. é)Úabsolute_importÚdivisionN)Ú Interface)Úunittest)Ú_PY3Ú_PYPY)ÚtextFromEventDictÚ addObserverÚremoveObserver)ÚFilePath)Úplugin)Úinvalidate_cachescCsdS)zJ On python 2, import caches don't need to be invalidated. N©rrrú:/usr/lib/python3/dist-packages/twisted/test/test_plugin.pyÚinvalidateImportCachessrc@seZdZdZdS)Ú ITestPluginzS A plugin for use by the plugin system's unit tests. Do not use this. N©Ú__name__Ú __module__Ú __qualname__Ú__doc__rrrrr"src@seZdZdZdS)Ú ITestPlugin2z See L{ITestPlugin}. Nrrrrrr+src@sºeZdZdZdd„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ƒZdd„ZdS)!Ú PluginTestsz_ Tests which verify the behavior of the current, active Twisted plugins directory. cCs¤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ÚsetUp8s    ÿzPluginTests.setUpcCs,|jtjdd…<tj ¡tj |j¡dS©zR Restore C{sys.path} and C{sys.modules} to their original values. N©rrrr ÚclearÚupdater"©r/rrrÚtearDownOs zPluginTests.tearDownFc Cs¦|j d¡}d |dd…¡}|d}ttj||ƒtj|j=ddg|rPdgpRgD]J}zt |j|¡WqVt k rž}z|j t j krŽ‚W5d}~XYqVXqVdS)NÚ.éÿÿÿÿÚcÚoÚ) rÚsplitÚjoinÚdelattrrr ÚosÚremover)ÚOSErrorÚerrnoZENOENT)r/r.Z deleteSourceZ modulePathZ packageNameÚ moduleNameZextZoserrrÚ_unimportPythonModuleXs   z!PluginTests._unimportPythonModulecCs|j d¡ ¡dS)z; Remove the plugins B{droping.cache} file. ú dropin.cacheN)r'r&r@r5rrrÚ _clearCachegszPluginTests._clearCachecst ˆ¡‡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. cs,ˆ|ƒˆ|ƒ| ¡ˆ|ƒˆ|ƒdS)N)rFr5©ÚmethrrÚwrappedus z+PluginTests._withCacheness..wrapped)Ú functoolsÚwraps)rHrIrrGrÚ_withCachenessnszPluginTests._withCachenesscCsÒt |j¡}||j}| |jd|jf¡| d|j¡dd„|jDƒd}|  |j |¡| |j d¡| |j  ¡d¡| |j ttjg¡| ¡}|  |tjd|jfj¡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.cSsg|]}t|jkr|‘qSr)rÚprovided©Ú.0ÚprrrÚ s z*PluginTests.test_cache..rÚ TestPluginz*A plugin used solely for testing purposes.N)r ÚgetCacher.r,Ú assertEqualrCÚassertInZ descriptionÚpluginsZassertIsÚdropinÚnameÚstriprMrZIPluginÚloadrr rRZmypackage.testpluginr)r/ÚcacherWZp1Z 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)rRN©rXrNrrrÚ ¬s ÿz-PluginTests.test_cacheRepr..rzTN)r rSr.r,ÚlistrVrTÚrepr)r/Z cachedDropinZ cachedPluginrrrÚtest_cacheRepr¦sÿþzPluginTests.test_cacheReprcCsLtt 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 Ú getPluginsrr.rTÚlenr@rZtest)r/rVÚnamesrPrrrÚ test_pluginsµs  zPluginTests.test_pluginsc Cs¨ttƒ d¡ |j d¡¡zr|  dtj¡|  t tjddƒd¡t t  t|j¡ƒ}| t|ƒd¡d d g}|D]}| |j¡| ¡qrW5| tjdd¡Xd 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 modulercrRÚFourthTestPluginN)r r)r*r+r'r&rDrr ÚfailIfInÚ assertFalseÚhasattrr`r rdrr.rTrer@rÚtest1©r/ÚplgsrfrPrrrÚtest_detectNewFilesÈs$ ÿÿ þzPluginTests.test_detectNewFilesc CsÒttƒ d¡ |j d¡¡zœt t   t |j ¡ƒ}| t|ƒd¡ttƒ d¡ |j d¡¡| tjd¡t t   t |j ¡ƒ}| t|ƒd¡dd d g}|D]}| |j¡| ¡qœW5| tjdd¡Xd S) z… Check that if the content of a plugin change, L{plugin.getPlugins} is able to detect the new plugins added. rhrirjTrczplugin_extra2.pyérRrlZFifthTestPluginN)r r)r*r+r'r&rDrr r`r rdrr.rTrer@rrprqrrrÚtest_detectFilesChangedçs( ÿ ÿ  þz#PluginTests.test_detectFilesChangedc Csnttƒ d¡ |j d¡¡zt t   t |j ¡ƒW5| tjdd¡Xt t   t |j ¡ƒ}| dt|ƒ¡dS)zs Check that when a dropin file is removed, L{plugin.getPlugins} doesn't return it anymore. rhrirjTéN)r r)r*r+r'r&rDrr r`r rdrr.rTre)r/rrrrrÚtest_detectFilesRemoved s ÿþz#PluginTests.test_detectFilesRemovedc Csd| ¡}| tj |¡¡|jj |¡z&t t   t |j¡ƒ}|  t|ƒd¡W5|jj |¡XdS)zy Test that getCache skips over any entries in a plugin package's C{__path__} which do not exist. rvN)r#rnr?rÚexistsr.Ú__path__Úappendr@r`r rdrrTre)r/rrrrrrÚtest_nonexistentPathEntrysz%PluginTests.test_nonexistentPathEntryc Csxt| ¡ƒ}| | ¡¡| ¡| d¡j}|jj  |¡z&t t   t|j¡ƒ}| t|ƒd¡W5|jj  |¡XdS)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_packagervN)r r#rnrxZtouchr&rr.ryrzr@r`r rdrrTre)r/rr&rrrrrÚtest_nonDirectoryChildEntry1s  z'PluginTests.test_nonDirectoryChildEntrycCsþ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. rErhrii@éiÀrkú3Unable to write to plugin cache %s: error number %dú;Did not observe unwriteable cache warning in log events: %rN)r rSr.r'r&r r)r*r+rr?ÚchmodrÚ addCleanupr rzr rUr,rBÚEPERMrÚfail)r/Z cachepathÚeventsr[ÚexpectedÚeventrrrÚtest_deployedModeDs8   ÿ   ÿ ÿÿzPluginTests.test_deployedModeN)F)rrrrr0r6rDrFrLr]rbrgrsrurwr{r|r‡rrrrr2s, # rsj from twisted.plugin import pluginPackagePaths __path__.extend(pluginPackagePaths(__name__)) __all__ = [] cCsd |¡ 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^rrrÚpluginFileContentsxs ÿøør‹cCsl| ¡| d¡}| ¡|r.| d¡ d¡| d¡}| ¡|rT| d¡ t¡| |d¡ |¡|S)z' Create a plugindummy package. Ú plugindummyrrrVú.py)r%r&r(ÚpluginInitFile)Z entrypathZ pluginContentÚrealÚ pluginModuleÚpkgZplugsrrrÚ_createPluginDummy„s  r’c@sneZdZdZdd„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. cCs>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_appcSsg|] }|j‘qSr©r©rOÚxrrrrQ¶sz-DeveloperSetupTests.setUp..rŒrVrEzplugindummy_builtin.pyiˆrciÐ)rrÚ savedPathr r!r"r r#ZfakeRootr%r&Ú systemPathÚdevPathÚappPathr’r‹Z systemPackageZ devPackageÚ appPackageÚextendÚ getAllPluginsÚsysplugÚsyscacheÚtimer?ÚutimeÚ lockSystemÚresetEnvironment)r/Znowrrrr0sN  þþþÿ   þzDeveloperSetupTests.setUpcCs$t |jjd¡t |jjd¡dS)zW Lock the system directories, as if they were unwritable by this user. imN©r?r€r¡rr¢r5rrrr¥ËszDeveloperSetupTests.lockSystemcCs$t |jjd¡t |jjd¡dS)zW Unlock the system directories, as if they were writable by this user. iÿNr§r5rrrÚ unlockSystemÓsz DeveloperSetupTests.unlockSystemcCs(ddl}tt t|j¡ƒ}dd„|DƒS)zl Get all the plugins loadable from our dummy package, and return their short names. rNcSsg|] }|j‘qSr©r)rOZplugrrrrQäsz5DeveloperSetupTests.getAllPlugins..)Zplugindummy.pluginsr`r rdrrV)r/rŒ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. cSsg|] }|j‘qSrr—r˜rrrrQísz8DeveloperSetupTests.resetEnvironment..N)ÚunsetEnvironmentrrrŸrœr›rr5rrrr¦ç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)rrr r3r4r"ršrr5rrrrªñ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¨r5rrrr6üszDeveloperSetupTests.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. rtr–r•N)Úranger ÚsortrT)r/r™rfrrrÚ"test_developmentPluginAvailability s z6DeveloperSetupTests.test_developmentPluginAvailabilitycCsî|j d¡}| tdƒ¡t ¡d}t |j||f¡| d¡}t rRt dd}nt ƒ}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)ZlegacyÚquietrvZtwoN)ržr&r(r‹r£r?r¤rr*rÚdictÚ compileallZ compile_dirr@r¦rUr rm)r/Zmypathr™ZpycZextrarrrÚtest_freshPyReplacesStalePycs$    z0DeveloperSetupTests.test_freshPyReplacesStalePycz/PyPy2 will not normally import lone .pyc files.cCs¢| ¡|j d¡ tdƒ¡| ¡tj |j j¡g}t |j ƒ|  t |j ¡| d| ¡¡d|jjtjf}|D]}|t|ƒkrxqž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~rN)r¨r¡r&r(r‹r¥rrr@rœr rzrr rUr r¢rBr‚rrƒ)r/r„r…r†rrrÚtest_newPluginsOnReadOnlyPathBs(  ÿ ÿÿz1DeveloperSetupTests.test_newPluginsOnReadOnlyPathN)rrrrr0r¥r¨r r¦rªr6r­r²rrÚskipr³rrrrr“–s.   $ÿr“c@s8eZdZdZdd„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. cCs tjdd…|_tj ¡|_dS)zS Save the elements of C{sys.path} and the items of C{sys.modules}. N)rrrr r!r"r5rrrr0mszAdjacentPackageTests.setUpcCs,|jtjdd…<tj ¡tj |j¡dSr1r2r5rrrr6us zAdjacentPackageTests.tearDowncCsn| |¡}| 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. ÚdummyrrrVr)r&Úmakedirsr(rŽr‹)r/r$rXZ pluginNameZ directoryr'rVrrrrÚcreateDummyPackage~s   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ÚsecondrNcSsg|] }|j‘qSrr©rNrrrrQ°szWAdjacentPackageTests.test_hiddenPackageSamePluginModuleNameObscured..©r r#r·r¸rrrzZ dummy.pluginsr`r rdrrVrT©r/r$ZfirstDirectoryZsecondDirectoryr¶rVrrrÚ.test_hiddenPackageSamePluginModuleNameObscuredžs 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 thatpluginrNcSsg|] }|j‘qSrr©rNrrrrQÅsz\AdjacentPackageTests.test_hiddenPackageDifferentPluginModuleNameObscured..r»r¼rrrÚ3test_hiddenPackageDifferentPluginModuleNameObscured³s zHAdjacentPackageTests.test_hiddenPackageDifferentPluginModuleNameObscuredN) rrrrr0r6r¸r½r¾rrrrrµgs   rµc@s0eZdZdZdd„Zdd„Zdd„Zdd „Zd S) ÚPackagePathTestszg Tests for L{plugin.pluginPackagePaths} which constructs search paths for plugin packages. cCstjdd…|_dS)z3 Save the elements of C{sys.path}. N)rrrr5rrrr0ÏszPackagePathTests.setUpcCs|jtjdd…<dS)z< Restore C{sys.path} to its original value. N)rrrr5rrrr6ÖszPackagePathTests.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¶rVN)r rrrTr ÚpluginPackagePathsr&)r/rÀ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¶rVrrrÁrÂN) r r#r&r·r(rrrTr rÃ)r/r$rÀrrrÚtest_pluginPackagesExcludedìs þz,PackagePathTests.test_pluginPackagesExcludedN)rrrrr0r6rÄrÅrrrrr¿És r¿)&rZ __future__rrrrBr?r£r±rJZzope.interfacerZ twisted.trialrZtwisted.python.compatrrZtwisted.python.logrr r Ztwisted.python.filepathr Ztwistedr Ú importlibr rrrZTestCaserrŽr‹r’r“rµr¿rrrrÚs2      B Rb