U ~HjR@sNdZddlZddlmZddlmZmZddlmZm Z m Z ddl m Z m Z mZmZddlmZGdd d eZGd d d ed Zd dZGdddejZGdddejZGdddejZGddde jZGddde jZGdddeZddZGddde jZGdd d e jZ Gd!d"d"e jZ!Gd#d$d$eZ"d%Z#d&Z$dS)'z* Test cases for twisted.python._shellcomp N)BytesIO)ListOptional) _shellcompreflectusage) CompleteFiles CompleteList Completer Completions)unittestc@seZdZdZddZdS)ZshScriptTestMetaz* Metaclass of ZshScriptTestMixin. cCsHdd}d|kr8|dD]\}}|||}||d|<qt||||S)Ncsfdd}|S)Ncs t|S)N)test_genZshFunctionselfcmdName optionsFQPNF/tmp/pip-unpacked-wheel-ewod1tgb/twisted/python/test/test_shellcomp.pyrunTestsz.makeTest..runTestr)rrrrrrmakeTestsz+ZshScriptTestMeta.__new__..makeTestZ generateForZtest_genZshFunction_)type__new__)clsnamebasesattrsrrrtestrrrrs  zZshScriptTestMeta.__new__N)__name__ __module__ __qualname____doc__rrrrrr sr c@seZdZdZdS)ZshScriptTestMixina Integration test helper to show that C{usage.Options} classes can have zsh completion functions generated for them without raising errors. In your subclasses set a class variable like so:: # | cmd name | Fully Qualified Python Name of Options class | # generateFor = [('conch', 'twisted.conch.scripts.conch.ClientOptions'), ('twistd', 'twisted.scripts.twistd.ServerOptions'), ] Each package that contains Twisted scripts should contain one TestCase subclass which also inherits from this mixin, and contains a C{generateFor} list appropriate for the scripts in that package. N)rr r!r"rrrrr#(sr#) metaclassc Cst}|tjd|zt|}Wn2tk rX}ztd|fW5d}~XYnXz| dddgWnBt k r}ztd|fW5d}~XYnt k rYn X| d| d |d t|d | d |t|d r|jD]\}}}} z| |ddd gWnFt k rT}ztd |fW5d}~XYn t k rhYn X| d| d |d t|d | d |q|dS)aI Generate completion functions for given twisted command - no errors should be raised @type cmdName: C{str} @param cmdName: The name of the command-line utility e.g. 'twistd' @type optionsFQPN: C{str} @param optionsFQPN: The Fully Qualified Python Name of the C{Options} class to be tested. _shellCompFilez0Couldn't import or instantiate Options class: %sN--_shell-completionzsh:2z&ImportError calling parseOptions(): %szSystemExit not raisedr subCommandszzsh:3z4ImportError calling parseOptions() on subcommand: %s)rpatchrOptionsrZnamedAny Exceptionr ZSkipTest parseOptions ImportError SystemExitZfailseek assertEquallenreadtruncatehasattrr*Z flushWarnings) rrr outputFileoecmdshortparserdocrrrr;sH         rc@sxeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZddZddZdS)ZshTestsz' Tests for zsh completion code cCst}t|dt}tjj}|tjj| |j|| |j t tjj | |j tjj tjj }|tjj | |j || |jtjjdS)zi Are `compData' attributes you can place on Options classes picked up correctly? aceN)FighterAceExtendedOptionsrZshArgumentsGeneratorrFighterAceOptionscompData descriptionscopyupdater2multiUsesetmutuallyExclusive optActions extraActions)roptsagrDrJrrrtest_accumulateMetadatas  z ZshTests.test_accumulateMetadatac CsGdddt}|}t|dt}dddddd d hd d ddddd d hd d dddd d hd d dddd d hd d dddddhd }||j|dS)z Exercise a corner-case of ZshArgumentsGenerator.makeExcludesDict() where the long option name already exists in the `excludes` dict being built. c@s.eZdZdddggZedddddggdZdS) zGZshTests.test_mutuallyExclusiveCornerCase..OddFighterAceOptionsanatraNz0Select the Anatra DS as your dogfighter aircraftfokkeralbatrosspadbristolrI)rr r!optFlagsr rCrrrrOddFighterAceOptionss rVr?rObrSfrPsrRarQ)rQrOrSrPrRN)r@rrArr2Zexcludes)rrVrLrMexpectedrrr test_mutuallyExclusiveCornerCases z)ZshTests.test_mutuallyExclusiveCornerCasecCsRt}t|dt}|d|j|d|j|d|j|d|jdS)z We pick up options that are only defined by having an appropriately named method on your Options class, e.g. def opt_foo(self, foo) r?Znocrash difficultyN)r@rrArZassertInZflagNameToDefinitionZallOptionsNameToDefinitionZparamNameToDefinition)rrLrMrrr test_accumulateAdditionalOptionss z)ZshTests.test_accumulateAdditionalOptionscCsTGdddt}|ttj|dtGdddt}|ttj|dtdS)z\ Using a parameter/flag name that doesn't exist will raise an error c@seZdZeddidZdS)z0ZshTests.test_verifyZshNames..TmpOptionsZdetaillN)rJrr r!r rCrrrr TmpOptionssr`r?c@seZdZedgdZdS)z1ZshTests.test_verifyZshNames..TmpOptions2)ZfoobarrTNr_rrrr TmpOptions2srbN)r@ assertRaises ValueErrorrrAr)rr`rbrrrtest_verifyZshNamess zZshTests.test_verifyZshNamescCsTt}|tjd||tdddddgt}|t|j| t | dS)zt Generate a completion function, and test the textual output against a known correct output r%argvsillyr&r'r(N) rr+rr,sysSimpleProgOptionsrcr0r.r2 testOutput1getvaluerr7rLrrr test_zshCodes zZshTests.test_zshCodecCsTt}|tjd||tdddddgt}|t|j| t | dS)z Generate a completion function with subcommands, and test the textual output against a known correct output r%rfZsilly2r&r'r(N) rr+rr,rhSimpleProgWithSubcommandsrcr0r.r2 testOutput2rkrlrrrtest_zshCodeWithSubss zZshTests.test_zshCodeWithSubsc Cs\t}|tjd|t}|t|jddddddg|d| d t | d d S) zx Completion still happens even if a command-line is given that would normally throw UsageError. r%--fokkerserver--unknown-optionz--unknown-option2r'zsh:5rr)N rr+rr,rBrcr0r.r1r2r3r4rlrrrtest_incompleteCommandLines  z#ZshTests.test_incompleteCommandLinec Csnt}|tjd|t}|t|jddddddg|d| d t | d |d| d S) z Completion still happens even if a command-line is given that would normally throw UsageError. The existence of --unknown-option prior to the subcommand will break subcommand detection... but we complete anyway r%rqrsrr --list-serverr'rtrr)N) rr+rr,rBrcr0r.r1r2r3r4r5rlrrr test_incompleteCommandLine_case2s$  z)ZshTests.test_incompleteCommandLine_case2c CsZt}|tjd|t}|t|jdddddg|d| dt | dd S) z Completion still happens even if a command-line is given that would normally throw UsageError. Break subcommand detection in a different way by providing an invalid subcommand name. r%rqzunknown-subcommandrwr'zzsh:4rr)Nrurlrrr test_incompleteCommandLine_case34s z)ZshTests.test_incompleteCommandLine_case3cCsVt}|tjd|t}|t|jdddg|d| dt | ddS)z Ensure the optimization which skips building the subcommand list under certain conditions isn't broken. r%z--albar'r(rr)Nrurlrrrtest_skipSubcommandListOs z ZshTests.test_skipSubcommandListcCs.t}t|dd}|d}||ddS)zY Test corner case fetching an option description from a method docstring r?Nrg)rBrrAgetDescriptionr2)rrLargGendescrrrrtest_poorlyDescribedOptMethod_s z&ZshTests.test_poorlyDescribedOptMethodcCsFGdddtj}t}|}||d||t|jdddgdS)zu A C{Completer} with repeat=True may only be used as the last item in the extraActions list. c@s(eZdZejejddegdZdS)z2ZshTests.test_brokenActions..BrokenActionsT)repeat)rKN)rr r!rr r rCrrrr BrokenActionsrsrr%r&r'r(N)rr,rr+rcrdr.)rrr7rLrrrtest_brokenActionslszZshTests.test_brokenActionscCsNGdddtj}|}t|dd}||dd||dddS) z~ opt_* methods on Options classes should not override the data provided in optFlags or optParameters. c@s6eZdZdddggZddddggZdd Zd d ZdS) z5ZshTests.test_optMethodsDontOverride..OptionsflagrXA flagparampNA paramcSsdSzjunk descriptionNrrrrropt_flagsz>ZshTests.test_optMethodsDontOverride..Options.opt_flagcSsdSrr)rrrrr opt_paramsz?ZshTests.test_optMethodsDontOverride..Options.opt_param)rr r!rU optParametersrrrrrrr,s r,r?Nrrrr)rr,rrAr2r{)rr,rLr|rrrtest_optMethodsDontOverride~s  z$ZshTests.test_optMethodsDontOverrideN)rr r!r"rNr\r^rermrprvrxryrzr~rrrrrrr>s   r>c@seZdZddZdS) EscapeTestscCs2tj}d}|||dd}|||ddS)z5 Verify _shellcomp.escape() function $z'$'z A--'$"\`--Bz"A--'\$\"\\\`--B"N)rescaper2)rescrrrr test_escapes zEscapeTests.test_escapeN)rr r!rrrrrrsrc@seZdZdZddZdS)CompleterNotImplementedTestsz Test that using an unknown shell constant with SubcommandAction raises NotImplementedError The other Completer() subclasses are tested in test_usage.py cCst}|t|jdddS)zM Using an unknown shellType should raise NotImplementedError NZbad_shell_type)rZSubcommandActionrcNotImplementedErrorZ _shellCode)ractionrrrtest_unknownShellsz.CompleterNotImplementedTests.test_unknownShellN)rr r!r"rrrrrrsrc@s*eZdZdZdddggZddddggZdS)FighterAceServerOptionsz4 Options for FighterAce 'server' subcommand z list-serverNz3List this server with the online FighterAce networkzpackets-per-secondz+Number of update packets to send per secondZ20)rr r!r"rUrrrrrrsrc @seZdZUdZdddgdddgdd d gd d d gdddgdddgdddggZeeeeed<ddddgddddggZ eeeeed <d!de d"ggZ e d#d$d%dgdddd ggde d&gied'd(gd)Zd*d+ZdS),rBzB Command-line options for an imaginary `Fighter Ace` game rPrXz2Select the Fokker Dr.I as your dogfighter aircraftrQrZz5Select the Albatros D-III as your dogfighter aircraftrRrYz1Select the SPAD S.VII as your dogfighter aircraftrSrWz4Select the Bristol Scout as your dogfighter aircraftphysicsrz$Enable secret Twisted physics engineZjamjz6Enable a small chance that your machine guns will jam!verbosev1Verbose logging (may be specified more than once)rUz pilot-nameNzWhat's your name, Ace?zManfred von Richthofendetaildz*Select the level of rendering detail (1-5)3rrrzStart FighterAce game-server.zTwisted-PhysicszRendering detail level)rrZ12345zsaved game file to loadr}rDrGrIrJrKcCsdS) Nrrrrr opt_sillyszFighterAceOptions.opt_silly)rr r!r"rUrrstr__annotations__rrr*r r rrCrrrrrrBs,       rBc@sTeZdZdZdddggZddddggZeddided d id Zd d Z ddZ dS)r@z Extend the options and zsh metadata provided by FighterAceOptions. _shellcomp must accumulate options and metadata from all classes in the hiearchy so this is important to test. z no-stallsNz+Turn off the ability to stall your aircraftz reality-levelz)Select the level of physics reality (1-5)5zCan't stall your planezPhysics reality levelr)rDrJcCsdS)z8 Select that you can't crash your plane Nrrrrr opt_nocrashsz%FighterAceExtendedOptions.opt_nocrashcCsdS)z+ How tough are you? (1-10) Nr)rr]rrropt_difficultysz(FighterAceExtendedOptions.opt_difficulty) rr r!r"rUrr r rCrrrrrrr@s   r@cCstdddgddS)N12rz Accuracy'`?r)r rrrr_accuracyAction src @seZdZdZdddgdddgdd d ggZd d d dgddddggZeddddgddggeddddd gddede ddgdZ ddZ d S) riz> Command-line options for a `Silly` imaginary program colorczTurn on color outputZgraygzTurn on gray-scale outputrrr optimizationNrz&Select the level of optimization (1-5)accuracyrZrz"Select the level of accuracy (1-3)zColor onzOptimization level)rrrr4z Optimization?r)rrz output filercCsdS)zM usage.Options does not recognize single-letter opt_ methods Nrrrrropt_X+szSimpleProgOptions.opt_X) rr r!r"rUrr r rrrCrrrrrris*     ric@seZdZdddggZdS)SimpleProgSub1sub-optrYz Sub Opt OneNrr r!rUrrrrr1src@seZdZdddggZdS)SimpleProgSub2rrYz Sub Opt TwoNrrrrrr5src@sHeZdZdgddggZdgddgddd ggZd d ed gd d edggZd S)rnz some-optionz other-optionr8z some-paramz other-paramrz another-paramPzYet Another ParamZsub1Nz Sub Command 1Zsub2z Sub Command 2)rr r!rUrrrr*rrrrrn9s  rns#compdef silly _arguments -s -A "-*" \ ':output file (*):_files -g "*"' \ "(--accuracy)-a[Select the level of accuracy (1-3)]:Accuracy'\`?:(1 2 3)" \ "(-a)--accuracy=[Select the level of accuracy (1-3)]:Accuracy'\`?:(1 2 3)" \ '(--color --gray -g)-c[Color on]' \ '(--gray -c -g)--color[Color on]' \ '(--color --gray -c)-g[Turn on gray-scale output]' \ '(--color -c -g)--gray[Turn on gray-scale output]' \ '--help[Display this help and exit.]' \ '--optimization=[Optimization level]:Optimization?:(1 2 3 4 5)' \ '*-v[Verbose logging (may be specified more than once)]' \ '*--verbose[Verbose logging (may be specified more than once)]' \ '--version[Display Twisted version and exit.]' \ && return 0 s#compdef silly2 _arguments -s -A "-*" \ '*::subcmd:->subcmd' \ ':output file (*):_files -g "*"' \ "(--accuracy)-a[Select the level of accuracy (1-3)]:Accuracy'\`?:(1 2 3)" \ "(-a)--accuracy=[Select the level of accuracy (1-3)]:Accuracy'\`?:(1 2 3)" \ '(--another-param)-P[another-param]:another-param:_files' \ '(-P)--another-param=[another-param]:another-param:_files' \ '(--color --gray -g)-c[Color on]' \ '(--gray -c -g)--color[Color on]' \ '(--color --gray -c)-g[Turn on gray-scale output]' \ '(--color -c -g)--gray[Turn on gray-scale output]' \ '--help[Display this help and exit.]' \ '--optimization=[Optimization level]:Optimization?:(1 2 3 4 5)' \ '(--other-option)-o[other-option]' \ '(-o)--other-option[other-option]' \ '(--other-param)-p[other-param]:other-param:_files' \ '(-p)--other-param=[other-param]:other-param:_files' \ '--some-option[some-option]' \ '--some-param=[some-param]:some-param:_files' \ '*-v[Verbose logging (may be specified more than once)]' \ '*--verbose[Verbose logging (may be specified more than once)]' \ '--version[Display Twisted version and exit.]' \ && return 0 local _zsh_subcmds_array _zsh_subcmds_array=( "sub1:Sub Command 1" "sub2:Sub Command 2" ) _describe "sub-command" _zsh_subcmds_array )%r"rhiortypingrrZtwisted.pythonrrrZtwisted.python.usagerr r r Z twisted.trialr rr r#rZTestCaser>rrr,rrBr@rrirrrnrjrorrrrs0  D%#