ó Ð#…Mc@sZdZddlZddlZddlZddlZddlZddlmZddlm Z ddl m Z m Z m Z ddlmZddlmZddlmZd efd „ƒYZd efd „ƒYZd e jfd„ƒYZdZd„Zd„Zde jfd„ƒYZde jfd„ƒYZde jfd„ƒYZdS(s" Tests for Twisted plugin system. iÿÿÿÿN(t Interface(tunittest(ttextFromEventDictt addObservertremoveObserver(tFilePath(tmergeFunctionMetadata(tplugint ITestPlugincBseZdZRS(sS A plugin for use by the plugin system's unit tests. Do not use this. (t__name__t __module__t__doc__(((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyRst ITestPlugin2cBseZdZRS(s See L{ITestPlugin}. (R R R (((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyR stPluginTestCasecBsÚeZdZd„Zd„Zed„Zd„Zd„Zd„Z ee ƒZ d„Z ee ƒZ d„Z ee ƒZ d „Z ee ƒZ d „Z ee ƒZ d „ZeeƒZd „ZeeƒZd „ZRS(s_ Tests which verify the behavior of the current, active Twisted plugins directory. cCsßtj|_tjjƒ|_t|jƒƒ|_|jj ƒ|jj dƒ|_ |j j ƒ|j j dƒj dƒtt ƒjdƒj|j j dƒƒd|_tjjd|jjƒdd l}||_d S( sV Save C{sys.path} and C{sys.modules}, and create a package for tests. t mypackages __init__.pytsplugin_basic.pys testplugin.pyt testpluginiiÿÿÿÿN(tsystpatht originalPathtmodulestcopyt savedModulesRtmktemptroottcreateDirectorytchildtpackaget setContentt__file__tsiblingtcopyTotoriginalPlugintinsertRtmodule(tselfR((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pytsetUp-s     cCs1|jtj(tjjƒtjj|jƒdS(sR Restore C{sys.path} and C{sys.modules} to their original values. N(RRRRtcleartupdateR(R#((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyttearDownDs  cCsÄ|jjdƒ}dj|d ƒ}|d}ttj||ƒtj|j=xmddg|rkdgpngD]L}ytj|j|ƒWqpt k r»}|j t j kr¼‚q¼qpXqpWdS(Nt.iÿÿÿÿtctoR( R tsplittjointdelattrRRtostremoveRtOSErrorterrnotENOENT(R#R"t deleteSourcet modulePatht packageNamet moduleNametexttose((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyt_unimportPythonModuleMs  &cCs|jjdƒjƒdS(s; Remove the plugins B{droping.cache} file. s dropin.cacheN(RRR/(R#((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyt _clearCache\scs‡fd†}tˆ|ƒS(sþ 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. cs6ˆ|ƒˆ|ƒ|jƒˆ|ƒˆ|ƒdS(N(R:(R#(tmeth(s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pytwrappedjs     (R(R;R<((R;s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyt_withCachenesscscCs/tj|jƒ}||j}|j|jd|jfƒ|jd|jƒg|jD]}t |j krY|^qYd}|j |j |ƒ|j|j dƒ|j|jjƒdƒ|j|j t tjgƒ|jƒ}|j |tjd|jfjƒddlj}|j ||jƒdS(s  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. s mypackage.%ssI'm a test drop-in.it TestPlugins*A plugin used solely for testing purposes.iÿÿÿÿN(RtgetCacheR"R t assertEqualsR6tassertInt descriptiontpluginsRtprovidedtassertIdenticaltdropintnametstriptIPlugintloadRRR>tmypackage.testpluginR(R#tcacheRFtptp1t realPluginttp((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyt test_cachess$  /  cCslttjt|jƒƒ}|jt|ƒdƒddg}x(|D] }|j|jƒ|j ƒqDWdS(s 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. itAnotherTestPlugintThirdTestPluginN( tlistRt getPluginsR R"R@tlenR/R ttest(R#RCtnamesRM((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyt test_plugins™s   cCsættƒjdƒj|jjdƒƒzŸ|jdtjƒ|j t tjddƒdƒt t j t|jƒƒ}|jt|ƒdƒdd g}x(|D] }|j|jƒ|jƒq¢WWd |jtjdtƒXd S( se Check that L{plugin.getPlugins} is able to detect plugins added at runtime. splugin_extra1.pyspluginextra.pysmypackage.pluginextraRt pluginextras&mypackage still has pluginextra moduleiR>tFourthTestPluginN(RRRRRRtfailIfInRRtfailIfthasattrRTRRURR"R@RVR/R ttest1R9tTrue(R#tplgsRXRM((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyttest_detectNewFiles¬s   cCs#ttƒjdƒj|jjdƒƒzÜttjt |j ƒƒ}|j t |ƒdƒttƒjdƒj|jjdƒƒ|j tjdƒttjt |j ƒƒ}|j t |ƒdƒddd g}x(|D] }|j|jƒ|jƒqßWWd |j tjdtƒXd S( s… Check that if the content of a plugin change, L{plugin.getPlugins} is able to detect the new plugins added. splugin_extra1.pyspluginextra.pyisplugin_extra2.pysmypackage.pluginextraiR>R[tFifthTestPluginN(RRRRRRRTRRURR"R@RVR9RRR/R R_R`(R#RaRXRM((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyttest_detectFilesChangedËs"  cCs•ttƒjdƒj|jjdƒƒzttjt |j ƒƒWd|j t j dtƒXttjt |j ƒƒ}|jdt|ƒƒdS(ss Check that when a dropin file is removed, L{plugin.getPlugins} doesn't return it anymore. splugin_extra1.pyspluginextra.pyNsmypackage.pluginextrai(RRRRRRRTRRURR"R9RRR`R@RV(R#Ra((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyttest_detectFilesRemovedîs cCsˆ|jƒ}|jtjj|ƒƒ|jjj|ƒz5tt j t |jƒƒ}|j t |ƒdƒWd|jjj|ƒXdS(sy Test that getCache skips over any entries in a plugin package's C{__path__} which do not exist. iN(RR]R.RtexistsR"t__path__tappendRTRRURt assertEqualRVR/(R#RRa((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyttest_nonexistentPathEntrys cCs¤t|jƒƒ}|j|jƒƒ|jƒ|jdƒj}|jjj |ƒz5t t j t |jƒƒ}|jt|ƒdƒWd|jjj|ƒXdS(s¡ Test that getCache skips over any entries in a plugin package's C{__path__} which refer to children of paths which are not directories. t test_packageiN(RRR]RfttouchRRR"RgRhRTRRURRiRVR/(R#RRRa((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyttest_nonDirectoryChildEntrys cCsXtj|jƒ|jjdƒ}ttƒjdƒj|jjdƒƒt j |jj dƒt j |j dƒ|j t j |jj dƒ|j t j |j dƒg}t |jƒ|j t|jƒtj|jƒ}|jd|ƒ|j|j|ƒd|j tjf}x8|D]}|t|ƒkr Pq q W|jd |fƒd S( s¿ 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. s dropin.cachesplugin_extra1.pyspluginextra.pyi@iiÀRZs3Unable to write to plugin cache %s: error number %ds;Did not observe unwriteable cache warning in log events: %rN(RR?R"RRRRRRR.tchmodRt addCleanupRRhRRAR R1tEPERMRtfail(R#t cachepathteventsRLtexpectedtevent((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyttest_deployedMode(s,  (R R R R$R'tFalseR9R:R=RQRYRbRdReRjRmRv(((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyR 's*     #            sj from twisted.plugin import pluginPackagePaths __path__.extend(pluginPackagePaths(__name__)) __all__ = [] cCs d|fS(Ns¸from zope.interface import classProvides from twisted.plugin import IPlugin from twisted.test.test_plugin import ITestPlugin class %s(object): classProvides(IPlugin, ITestPlugin) ((RG((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pytpluginFileContents[scCs˜|jƒ|jdƒ}|jƒ|rB|jdƒjdƒn|jdƒ}|jƒ|rz|jdƒjtƒn|j|dƒj|ƒ|S(s' Create a plugindummy package. t plugindummys __init__.pyRRCs.py(RRRtpluginInitFile(t entrypatht pluginContenttrealt pluginModuletpkgtplugs((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyt_createPluginDummyes   tDeveloperSetupTestscBsheZdZd„Zd„Zd„Zd„Zd„Zd„Zd„Z d„Z d „Z d „Z RS( s³ These tests verify things about the plugin system without actually interacting with the deployed 'twisted.plugins' package, instead creating a temporary package. cCsÁtj|_tjjƒ|_t|jƒƒ|_|jj ƒ|jj dƒ|_ |jj dƒ|_ |jj dƒ|_ t|j tdƒtdƒ|_t|j tdƒtdƒ|_t|j tdƒtdƒ|_tjjg|j |j gD]}|j^qÿƒ|jƒ|j j d ƒj d ƒ|_|jj d ƒ|_tjƒ}tj|jj d ƒj|d fdƒtj|jj|dfdƒ|jƒ|jƒdS(s7 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. t system_pathtdevelopment_pathtapplication_pathtsystemtplugindummy_builtintdevtapptplugindummy_appRyRCs dropin.cachesplugindummy_builtin.pyiˆiiÐN(RRt savedPathRRRRRtfakeRootRRt systemPathtdevPathtappPathRRxR`t systemPackaget devPackageRwt appPackagetextendt getAllPluginstsysplugtsyscachettimeR.tutimet lockSystemtresetEnvironment(R#txtnow((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyR$~s8     ! cCs0tj|jjdƒtj|jjdƒdS(sW Lock the system directories, as if they were unwritable by this user. imN(R.RnR•RR–(R#((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyR™¬scCs0tj|jjdƒtj|jjdƒdS(sW Unlock the system directories, as if they were writable by this user. iÿN(R.RnR•RR–(R#((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyt unlockSystem´scCsAddl}ttjt|jƒƒ}g|D]}|j^q.S(sl Get all the plugins loadable from our dummy package, and return their short names. iÿÿÿÿN(tplugindummy.pluginsRTRRURRCR (R#RyR›tplug((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyR”¼s cCsF|jƒtjjg|j|j|jgD]}|j^q,ƒdS(sc Change the environment to what it should be just as the test is starting. N(tunsetEnvironmentRRR“RŽRR(R#R›((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyRšÈs cCs1tjjƒtjj|jƒ|jtj(dS(sh Change the Python environment back to what it was before the test was started. N(RRR%R&RR‹R(R#((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyR Òs cCs|jƒ|jƒdS(sÑ 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#((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyR'Üs cCsGx@tdƒD]2}|jƒ}|jƒ|j|ddgƒq WdS(s 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. iR‰RˆN(trangeR”tsortRi(R#R›RX((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyt"test_developmentPluginAvailabilityês   cCs|jjdƒ}|jtdƒƒtjƒd}tj|j||fƒ|jdƒ}t j |jjddƒtj|j||fƒ|j ƒ|j ƒ|j d|jƒƒ|jd|jƒƒ|j ƒ|jtdƒƒ|jd|jƒƒ|j d|jƒƒdS( sÜ 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. sstale.pytoneiès stale.pyctquietittwoN(R’RRRxR—R.R˜RRt compileallt compile_dirR/RšRAR”R\(R#tmypathR›tpyc((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyttest_freshPyReplacesStalePycùs   cCsÝ|jƒ|jjdƒjtdƒƒ|jƒtjj|j jƒg}t |j ƒ|j t |j ƒ|jd|jƒƒd|jjtjf}x8|D]}|t|ƒkr¥Pq¥q¥W|jd|fƒdS(sF 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". s newstuff.pyR¤s3Unable to write to plugin cache %s: error number %ds;Did not observe unwriteable cache warning in log events: %rN(RR•RRRxR™RRR/RŽRRhRoRRAR”R–R1RpRRq(R#RsRtRu((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyttest_newPluginsOnReadOnlyPaths    ( R R R R$R™RR”RšR R'R£R«R¬(((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyR‚ws .     tAdjacentPackageTestscBs;eZdZd„Zd„Zd„Zd„Zd„ZRS(s– Tests for the behavior of the plugin system when there are multiple installed copies of the package containing the plugins being loaded. cCs#tj|_tjjƒ|_dS(sS Save the elements of C{sys.path} and the items of C{sys.modules}. N(RRRRRR(R#((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyR$@s cCs1|jtj(tjjƒtjj|jƒdS(sR Restore C{sys.path} and C{sys.modules} to their original values. N(RRRRR%R&R(R#((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyR'Hs  cCs—|j|ƒ}|jdƒ}|jƒ|jdƒjdƒ|jdƒ}|jƒ|jdƒjtƒ|j|dƒ}|jt|ƒƒ|S(s` 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. tdummys __init__.pyRRCs.py(RtmakedirsRRzRx(R#RRGt pluginNamet directoryRRCR~((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pytcreateDummyPackageQs  cCsÀt|jƒƒ}|jƒ|j|ddƒ}|j|ddƒ}tjj|jƒtjj|jƒddl}tt j t |j ƒƒ}|j dgg|D]}|j^q¦ƒdS(sê 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. tfirstt someplugintsecondiÿÿÿÿN(RRR¯R²RRRht dummy.pluginsRTRRURRCRiR (R#RtfirstDirectorytsecondDirectoryR®RCRM((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyt.test_hiddenPackageSamePluginModuleNameObscuredqs  cCsÀt|jƒƒ}|jƒ|j|ddƒ}|j|ddƒ}tjj|jƒtjj|jƒddl}tt j t |j ƒƒ}|j dgg|D]}|j^q¦ƒdS(sè 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³t thispluginRµt thatpluginiÿÿÿÿN(RRR¯R²RRRhR¶RTRRURRCRiR (R#RR·R¸R®RCRM((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyt3test_hiddenPackageDifferentPluginModuleNameObscured†s  (R R R R$R'R²R¹R¼(((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyR­:s   tPackagePathTestscBs2eZdZd„Zd„Zd„Zd„ZRS(sg Tests for L{plugin.pluginPackagePaths} which constructs search paths for plugin packages. cCstj|_dS(s3 Save the elements of C{sys.path}. N(RRR(R#((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyR$¢scCs|jtj(dS(s< Restore C{sys.path} to its original value. N(RRR(R#((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyR'©scCsztdƒ}tdƒ}|j|jgt_|jtjdƒ|jdƒjdƒj|jdƒjdƒjgƒdS(s® L{plugin.pluginPackagePaths} should return a list containing each directory in C{sys.path} with a suffix based on the supplied package name. tfootbars dummy.pluginsR®RCN(RRRRiRtpluginPackagePathsR(R#R¾R¿((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyttest_pluginDirectories°s   cCs¸t|jƒƒ}|jdƒjdƒjdƒ}|jƒ|jdƒjdƒ|jdƒj|jdƒjgt_|jtj dƒ|jdƒjdƒjdƒjgƒdS( s™ 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®RCs __init__.pyRR¿s dummy.pluginsN( RRRR¯RRRRiRRÀ(R#RR¾((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyttest_pluginPackagesExcluded¿s ! ' (R R R R$R'RÁRÂ(((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyR½œs    (R RR1R.R—R§tzope.interfaceRt twisted.trialRttwisted.python.logRRRttwisted.python.filepathRttwisted.python.utilRttwistedRRR tTestCaseR RzRxRR‚R­R½(((s</usr/lib/python2.7/dist-packages/twisted/test/test_plugin.pyts$0  ÿ3 Ãb