o bR@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@eZdZdZddZdS)ZshScriptTestMetaz* Metaclass of ZshScriptTestMixin. cCsHdd}d|vr|dD]\}}|||}||d|<q t||||S)Ncsfdd}|S)Ncs t|S)N)test_genZshFunctionselfcmdName optionsFQPND/usr/lib/python3/dist-packages/twisted/python/test/test_shellcomp.pyrunTests z.makeTest..runTestr)rrrrrrmakeTestsz+ZshScriptTestMeta.__new__..makeTest generateFortest_genZshFunction_)type__new__)clsnamebasesattrsrrrtestrrrrs  zZshScriptTestMeta.__new__N)__name__ __module__ __qualname____doc__rrrrrrs rc@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)r"r#r$r%rrrrr&(sr&) metaclassc Cst}|tjd|zt|}Wnty'}ztd|fd}~wwz | gdWnt yD}ztd|fd}~wt yLYnw| d| d|dt|d| d|t|d r|jD]K\}}}} z | |d d d gWnt y}ztd |fd}~wt yYnw| d| d|dt|d| d|qs|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 subCommandsr*r+zzsh:3z4ImportError calling parseOptions() on subcommand: %s)rpatchrOptionsrnamedAny Exceptionr SkipTest parseOptions ImportError SystemExitfailseek assertEquallenreadtruncatehasattrr. flushWarnings) rrr outputFileoecmdshortparserdocrrrr;sR            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 descriptionscopyupdater9multiUsesetmutuallyExclusive optActions extraActions)roptsagrLrRrrrtest_accumulateMetadatas   z ZshTests.test_accumulateMetadatacCs\Gdddt}|}t|dt}hdhdhdhdhdd }||j|d S) z Exercise a corner-case of ZshArgumentsGenerator.makeExcludesDict() where the long option name already exists in the `excludes` dict being built. c@s&eZdZgdgZegdgdZdS)zGZshTests.test_mutuallyExclusiveCornerCase..OddFighterAceOptions)anatraNz0Select the Anatra DS as your dogfighter aircraft)rWfokkeralbatrosspadbristolrQN)r"r#r$optFlagsr rKrrrrOddFighterAceOptionss  r^rG>bfsrZrWrXr[>ar_r`rarZrXr[rY>rbr`rarZrWrXrY>rbr_rarZrWr[rY>rbr_r`rWrXr[rY)rYrWr[rXrZN)rHrrIrr9excludes)rr^rTrUexpectedrrr 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) rGnocrash difficultyN)rHrrIrassertInflagNameToDefinitionallOptionsNameToDefinitionparamNameToDefinition)rrTrUrrr 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..TmpOptionsdetaillN)rRr"r#r$r rKrrrr TmpOptionssrorGc@seZdZedgdZdS)z1ZshTests.test_verifyZshNames..TmpOptions2)foobarr\Nrnrrrr TmpOptions2srrN)rH assertRaises ValueErrorrrIr)rrorrrrrtest_verifyZshNamesszZshTests.test_verifyZshNamescCPt}|tjd||tdgdt}|t|j| t | dS)zt Generate a completion function, and test the textual output against a known correct output r(argv)sillyr*r+r,N) rr/rr0sysSimpleProgOptionsrsr6r4r9 testOutput1getvaluerr?rTrrr test_zshCode zZshTests.test_zshCodecCrv)z Generate a completion function with subcommands, and test the textual output against a known correct output r(rw)silly2r*r+r,N) rr/rr0rySimpleProgWithSubcommandsrsr6r4r9 testOutput2r|r}rrrtest_zshCodeWithSubsrzZshTests.test_zshCodeWithSubscCTt}|tjd|t}|t|jgd|d| dt | ddS)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/rr0rJrsr6r4r8r9r:r;r}rrrtest_incompleteCommandLines z#ZshTests.test_incompleteCommandLinecCsft}|tjd|t}|t|jgd|d| dt | d|d| dS)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()rrr --list-serverr+rrr-N) rr/rr0rJrsr6r4r8r9r:r;r<r}rrr test_incompleteCommandLine_case2s   z)ZshTests.test_incompleteCommandLine_case2cCr)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()rzunknown-subcommandrr+zzsh:4rr-Nrr}rrr test_incompleteCommandLine_case34s z)ZshTests.test_incompleteCommandLine_case3cCr)z Ensure the optimization which skips building the subcommand list under certain conditions isn't broken. r()z--albar+r,rr-Nrr}rrrtest_skipSubcommandListOs  z ZshTests.test_skipSubcommandListcCs.t}t|dd}|d}||ddS)zY Test corner case fetching an option description from a method docstring rGNrx)rJrrIgetDescriptionr9)rrTargGendescrrrrtest_poorlyDescribedOptMethod_s z&ZshTests.test_poorlyDescribedOptMethodcCsDGdddtj}t}|}||d||t|jgddS)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)rSN)r"r#r$rr r rKrrrr BrokenActionsrs rr(r)N)rr0rr/rsrtr4)rrr?rTrrrtest_brokenActionsls zZshTests.test_brokenActionscCsNGdddtj}|}t|dd}||dd||dddS) z~ opt_* methods on Options classes should not override the data provided in optFlags or optParameters. c@s0eZdZgdgZgdgZddZddZdS)z5ZshTests.test_optMethodsDontOverride..Options)flagr`A flag)parampNA paramcSdSzjunk descriptionNrrrrropt_flagz>ZshTests.test_optMethodsDontOverride..Options.opt_flagcSrrr)rrrrr opt_paramrz?ZshTests.test_optMethodsDontOverride..Options.opt_paramN)r"r#r$r] optParametersrrrrrrr0s    r0rGNrrrr)rr0rrIr9r)rr0rTrrrrtest_optMethodsDontOverride~s  z$ZshTests.test_optMethodsDontOverrideN)r"r#r$r%rVrerlrur~rrrrrrrrrrrrrFs   rFc@seZdZddZdS) EscapeTestscCs2tj}d}|||dd}|||ddS)z5 Verify _shellcomp.escape() function $z'$'z A--'$"\`--Bz"A--'\$\"\\\`--B"N)rescaper9)rescr!rrr test_escapes zEscapeTests.test_escapeN)r"r#r$rrrrrrs rc@r )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 Nbad_shell_type)rSubcommandActionrsNotImplementedError _shellCode)ractionrrrtest_unknownShells z.CompleterNotImplementedTests.test_unknownShellN)r"r#r$r%rrrrrrs rc@s$eZdZdZgdgZgdgZdS)FighterAceServerOptionsz4 Options for FighterAce 'server' subcommand )z list-serverNz3List this server with the online FighterAce network)zpackets-per-secondNz+Number of update packets to send per second20N)r"r#r$r%r]rrrrrrs rc@seZdZUdZgdgdgdgdgdgdgdgZeeeeed <gd gd gZ eeeeed <d de dggZ e ddddggdgde dgieddgdZddZdS)rJzB Command-line options for an imaginary `Fighter Ace` game )rXr`z2Select the Fokker Dr.I as your dogfighter aircraft)rYrbz5Select the Albatros D-III as your dogfighter aircraft)rZraz1Select the SPAD S.VII as your dogfighter aircraft)r[r_z4Select the Bristol Scout as your dogfighter aircraft)physicsrz$Enable secret Twisted physics engine)jamjz6Enable a small chance that your machine guns will jam!verbosevz1Verbose logging (may be specified more than once)r])z pilot-nameNzWhat's your name, Ace?zManfred von Richthofen)detaildz*Select the level of rendering detail (1-5)3rrNzStart FighterAce game-server.zTwisted-PhysicszRendering detail level)rrr)rXrYrZr[r12345zsaved game file to loadrrLrOrQrRrScCr) Nrrrrr opt_sillyrzFighterAceOptions.opt_silly)r"r#r$r%r]rrstr__annotations__rrr.r r rrKrrrrrrJs.      rJc@sNeZdZdZgdgZgdgZeddideddid Zd d Z d d Z dS)rHz 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. ) no-stallsNz+Turn off the ability to stall your aircraft) reality-levelNz)Select the level of physics reality (1-5)5rzCan't stall your planerzPhysics reality levelr)rLrRcCr)z8 Select that you can't crash your plane Nrrrrr opt_nocrashrz%FighterAceExtendedOptions.opt_nocrashcCr)z+ How tough are you? (1-10) Nr)rrgrrropt_difficultyrz(FighterAceExtendedOptions.opt_difficultyN) r"r#r$r%r]rr r rKrrrrrrrHs   rHcCstgdddS)N)12rz Accuracy'`?r)r rrrr_accuracyAction src@sxeZdZdZgdgdgdgZgdgdgZeddd d gd d ggegd ddede ddgdZ ddZ dS)rzz> Command-line options for a `Silly` imaginary program )colorczTurn on color output)graygzTurn on gray-scale outputr) optimizationNrz&Select the level of optimization (1-5))accuracyrbrz"Select the level of accuracy (1-3)zColor onzOptimization level)rrrrr)rrr4rz Optimization?r)rrz output filercCr)zM usage.Options does not recognize single-letter opt_ methods Nrrrrropt_X+rzSimpleProgOptions.opt_XN) r"r#r$r%r]rr r rrrKrrrrrrzs*  rzc@eZdZgdgZdS)SimpleProgSub1)sub-optraz Sub Opt OneNr"r#r$r]rrrrr1rc@r)SimpleProgSub2)rraz Sub Opt TwoNrrrrrr5rrc@sFeZdZdgddggZdgddggdgZdd ed gd d ed ggZd S) rz some-optionz other-optionr@z some-paramz other-paramr)z another-paramPzYet Another Paramsub1Nz Sub Command 1sub2z Sub Command 2)r"r#r$r]rrrr.rrrrr9s  rs#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%ryiortypingrrtwisted.pythonrrrtwisted.python.usagerr r r twisted.trialr rrr&rTestCaserFrrr0rrJrHrrzrrrr{rrrrrs2  D%#