o b[@sddZddlmZddlmZGdddejZGdddejZGdd d ejZ Gd d d ejZ Gd d d ejZ GdddejZ GdddejZ GdddejZGdddejZGdddejZGdddejZGdddejZGdddejZGdddejZGd d!d!ejZGd"d#d#ejZGd$d%d%ejZGd&d'd'ejZd(S))zK Tests for L{twisted.python.usage}, a command line option parsing library. )usage)unittestc@sHeZdZgdgdgdgdgZgdddggZdd Zd d Zd S) WellBehaved)longwdefaultzand a docstring)anothernz no docstring)longonlyNnoshort) shortlessNexceptzthis one got docstring)aflagfzO flagallicious docstringness for this here floutocCsd|jd<dS)NPONY!myflagoptsselfr9/usr/lib/python3/dist-packages/twisted/test/test_usage.py opt_myflag!szWellBehaved.opt_myflagcCs|d|jd<dS)Nz WITH A PONY!myparamrrvaluerrr opt_myparam$szWellBehaved.opt_myparamN)__name__ __module__ __qualname__ optParametersoptFlagsrrrrrrr s  rc@s0eZdZdZddZddZddZdd Zd S) ParseCorrectnessTestszZ Test L{usage.Options.parseOptions} for correct values under good conditions. cCs$d|_t|_|j|jdS)zL Instantiate and parseOptions a well-behaved Options class. A--long Alpha -n Beta --shortless Gamma -f --myflag --myparam TofuN)splitniceArgVrnice parseOptionsrrrrsetUp.s zParseCorrectnessTests.setUpcCsT||jjdd||jjdd||jjdd||jjddd S) z1 Parameters have correct values. rAlpharBetar r r GammaN assertEqualr(rrrrrtest_checkParameters;sz*ParseCorrectnessTests.test_checkParameterscC,||jjdd||jjdddS)z, Flags have correct values. rrrNr.rrrrtest_checkFlagsDz%ParseCorrectnessTests.test_checkFlagscCr1)zB Custom flags and parameters have correct values. rrrzTofu WITH A PONY!Nr.rrrrtest_checkCustomsKr4z'ParseCorrectnessTests.test_checkCustomsN)rr r!__doc__r*r0r3r5rrrrr$(s   r$c@sLeZdZddddegddddegdddd egd ddd eggZd d ZeZdS) TypedOptionsfoointNzFoo intfoofloatQ@z Foo floateggintzEgg int without defaulteggfloatzEgg float without defaultcCs ||_dS)zg This option has an underscore in its name to exercise the _ to - translation. N)underscoreValuerrrropt_under_score[s zTypedOptions.opt_under_score)rr r!intfloatr"r?opt_urrrrr7Ss    r7c@s@eZdZdZddZddZddZdd Zd d Zd d Z dS) TypedTestszK Test L{usage.Options.parseOptions} for options with forced types. cCs t|_dSN)r7rrrrrr*js zTypedTests.setUpcCsg}|j|||jjdd||jjdt||jjdd||jjdt||jjd||jjddS)z, Default values are parsed. r8r9r:r;r<r=N)rr)r/rassertIsInstancer@rA assertIsNonerargVrrrtest_defaultValuesms zTypedTests.test_defaultValuescCsd}|j|||jjdd||jjdt||jjdd||jjdt||jjdd||jjdt||jjdd ||jjdtd S) z2 int and float values are parsed. z8--fooint 912 --foofloat -823.1 --eggint 32 --eggfloat 21r8ir:g̸r< r=g5@N)r&rr)r/rrEr@rArGrrrtest_parsingValueszs zTypedTests.test_parsingValuescC$|jddg||jjddS)zw A dash in an option name is translated to an underscore before being dispatched to a handler. z --under-scorefooNrr)r/r>rrrrtest_underscoreOptionsz TypedTests.test_underscoreOptioncCrL)zE An option name with a dash in it can have an alias. z-ubarNrNrrrrtest_underscoreOptionAliassz%TypedTests.test_underscoreOptionAliascCs d}|tj|jj|dS)z7 Passing wrong values raises an error. z --fooint eggN)r& assertRaisesr UsageErrorr)rGrrrtest_invalidValuesszTypedTests.test_invalidValuesN) rr r!r6r*rIrKrOrQrTrrrrrCes  rCc@seZdZgdgZdS)WrongTypedOptions)barwrongNNzBar with wrong coerceheN)rr r!r"rrrrrUsrUc@s8eZdZddZddZddddegdddd eggZdS) WeirdCallableOptionscCtd)NOuch) RuntimeErrorrrrr_barzWeirdCallableOptions._barcCrY)NYay) ValueErrorr\rrr_foor^zWeirdCallableOptions._foorVNzBar with strange callablefoowrongzFoo with strange callable)rr r!r]rar"rrrrrXs   rXc@(eZdZdZddZddZddZdS) WrongTypedTestszF Test L{usage.Options.parseOptions} for wrong coerce options. cCs"t}d}|t|j|dS)z2 Using a non-callable type fails. z--barwrong eggN)rUr&rR TypeErrorr)rusrHrrrtest_nonCallablesz WrongTypedTests.test_nonCallablecCst}g}||dS)zP The coerce functions are not called if no values are provided. N)rXr)rfrrrtest_notCalledInDefaultsz'WrongTypedTests.test_notCalledInDefaultcCsRt}d}|tj|j|}|t|dt}d}|t|j|dS)zI Errors raised by coerce functions are handled properly. z--foowrong blahz&Parameter type enforcement failed: Yayz--barwrong blahN) rXr&rRrrSr)r/strr[)rrgrHerrrtest_weirdCallablesz"WrongTypedTests.test_weirdCallableN)rr r!r6rhrirlrrrrrds  rdc@eZdZddZdS) OutputTestscCs.t}|tj|jdg}|t|ddS)zF Error output case adjustment does not mangle options z-Zzoption -Z not recognizedN)rrRrrSr)r/rj)roptrkrrrtest_uppercasingszOutputTests.test_uppercasingN)rr r!rprrrrrn rnc@seZdZdgZdgZdS)InquisitionOptions)expectrk)torture-devicet comfy-chairzset preferred torture deviceN)rr r!r#r"rrrrrrs rrc@seZdZddgZdS)HolyQuestOptions) horsebackhz use a horse) for-grailgN)rr r!r#rrrrrwsrwc@s*eZdZdgZddedfddedfgZdS) SubCommandOptions)europian-swallowNz$set default swallow type to Europian inquisitioninquestzPerform an inquisition holyquestquestzEmbark upon a holy questN)rr r!r#rrrw subCommandsrrrrr|s   r|c@sPeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ dS)SubCommandTestszJ Test L{usage.Options.parseOptions} for options with subcommands. cCsdt}|ddg||d||jd||jt||jd||jdddS)z- A subcommand is recognized. --europian-swallowr~r}rsrtrvN) r|r) assertTruer/ subCommandrE subOptionsrr assertFalserrrrrtest_simpleSubcommandz%SubCommandTests.test_simpleSubcommandcCdt}|gd||d||jd||jt||jd||jdddS)zA Flags and options of a subcommand are assigned. )r~--expect--torture-device=featherr}r~rsrtfeatherN r|r)rr/rrErrrrrrrr"test_subcommandWithFlagsAndOptions rz2SubCommandTests.test_subcommandWithFlagsAndOptionscCr)zG Flags and options of a subcommand alias are assigned. )rrrr}r~rsrtrNrrrrr'test_subcommandAliasWithFlagsAndOptionsrz7SubCommandTests.test_subcommandAliasWithFlagsAndOptionscCsbt}|ddg||d||jd||jt||jd||jddS)zG Flags and options of another subcommand are assigned. rz --for-grailr}rxrzN) r|r)rr/rrErrwrrrrr)test_anotherSubcommandWithFlagsAndOptions#sz9SubCommandTests.test_anotherSubcommandWithFlagsAndOptionscCs@t}|dg||d||j|t|ddS)z If no subcommand is specified and no default subcommand is assigned, a subcommand will not be implied. rr}rN)r|r)rrFrrhasattrrrrrtest_noSubcommand/s   z!SubCommandTests.test_noSubcommandcCsht}d|_|dg||d||jd||jt| |jd||jdddS) zK Flags and options in the default subcommand are assigned. rrr}r~rsrtrvN) r|defaultSubCommandr)rr/rrErrrrrrrrtest_defaultSubcommand:s z&SubCommandTests.test_defaultSubcommandcs`GdddtjGfdddtj}|}|dg|t|jd||jj|dS)zw The parseOptions method from the Options object specified for the given subcommand is called. c@rm)zDSubCommandTests.test_subCommandParseOptionsHasParent..SubOptc_s&|j|_tjj|g|Ri|dSrD)parent sawParentrOptionsr))rakwrrrr)NszQSubCommandTests.test_subCommandParseOptionsHasParent..SubOpt.parseOptionsN)rr r!r)rrrrSubOptMrqrceZdZdddfgZdS)zASubCommandTests.test_subCommandParseOptionsHasParent..OptrMrrPNrr r!rrrrrOptR rrMrN)rrr)rrrr/r)rrrrrr$test_subCommandParseOptionsHasParentGs  z4SubCommandTests.test_subCommandParseOptionsHasParentcsGdddtjGfdddtj}Gfdddtj}|}|dg|}|dg|t|jd |t|jd ||jj|||jj|d S) zh The .parent pointer is correct even when the same Options class is used twice. c@s eZdZdS)z:SubCommandTests.test_subCommandInTwoPlaces..SubOptN)rr r!rrrrrbsrcr)z:SubCommandTests.test_subCommandInTwoPlaces..OptFoorMrquuxNrrrrrOptFooerrcr)z:SubCommandTests.test_subCommandInTwoPlaces..OptBarrPbrNrrrrrOptBarjrrrMrPrN)rrr)rrrfailUnlessIdenticalr)rrroFoooBarrrrtest_subCommandInTwoPlaces\s  z*SubCommandTests.test_subCommandInTwoPlacesN) rr r!r6rrrrrrrrrrrrrs      rc@rc) HelpStringTestsz& Test generated help strings. cCsd|_t|_dS)z; Instantiate a well-behaved Options class. r%N)r&r'rr(rrrrr*~s zHelpStringTests.setUpc CsBz|jWdSty }z ||WYd}~dSd}~ww)z, __str__ shouldn't go boom. N)r(__str__ Exceptionfail)rrkrrr test_noGoBooms zHelpStringTests.test_noGoBoomcCsFddt|jD}|t|dk||dddkdS)zK Extra whitespace in flag and parameters docs is stripped. cSsg|] }|ddkr|qS)rr)find).0srrr szJHelpStringTests.test_whitespaceStripFlagsAndParameters..r flagalliciousN)rjr( splitlinesrlenr)rlinesrrr&test_whitespaceStripFlagsAndParameterssz6HelpStringTests.test_whitespaceStripFlagsAndParametersN)rr r!r6r*rrrrrrrys  rc@s eZdZdZddZddZdS)PortCoerceTestsz3 Test the behavior of L{usage.portCoerce}. cCs:|dtd|dtd|dtddS)z4 Test the answers with valid input. r0i 3210i65535N)r/r portCoercerrrrtest_validCoercesz PortCoerceTests.test_validCoercecCsD|ttjd|ttjd|ttjd|ttjddS)z" Test error path. z-21212189rMN)rRr`rrrrrrtest_errorCoercesz PortCoerceTests.test_errorCoerceN)rr r!r6rrrrrrrs rc@s`eZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ dS)ZshCompleterTestsz Test the behavior of the various L{twisted.usage.Completer} classes for producing output usable by zsh tab-completion system. cCNt}|dtj}||dtjddd}|dtj}||ddS)zX Completer produces zsh shell-code that produces no completion matches. some-optionz :some-option: some actionTdescrrepeat*:some action:N)r Completer _shellCode_ZSHr/rcgotrrrtest_completer  z ZshCompleterTests.test_completercCstt}|dtj}||dtd}|dtj}||dtjdddd}|dtj}||dd S) zn CompleteFiles produces zsh shell-code that completes file names according to a glob. rz:some-option (*):_files -g "*"z*.pyz$:some-option (*.py):_files -g "*.py"rTrz%*:some action (*.py):_files -g "*.py"N)r CompleteFilesrrr/rrrr test_filess   zZshCompleterTests.test_filescCr)zV CompleteDirs produces zsh shell-code that completes directory names. rz:some-option:_directoriesrTrz*:some action:_directoriesN)r CompleteDirsrrr/rrrr test_dirsrzZshCompleterTests.test_dirscCs~td}|dtj}||dtgd}|dtj}||dtjgdddd}|dtj}||d d S) zw CompleteList produces zsh shell-code that completes words from a fixed list of possibilities. ABCrz:some-option:(A B C)123z:some-option:(1 2 3)rTrz*:some action:(1 2 3)N)r CompleteListrrr/rrrr test_lists   zZshCompleterTests.test_listcCstd}|dtj}||dtgd}|dtj}||dtjgdddd}|dtj}d }|||d S) z CompleteMultiList produces zsh shell-code that completes multiple comma-separated words from a fixed list of possibilities. rrz-:some-option:_values -s , 'some-option' A B Crz-:some-option:_values -s , 'some-option' 1 2 3rTrz.*:some action:_values -s , 'some action' 1 2 3N)rCompleteMultiListrrr/)rrrexpectedrrrtest_multiLists   z ZshCompleterTests.test_multiListcCr)zd CompleteUsernames produces zsh shell-code that completes system usernames. rz:some-option:_usersrTrz*:some action:_usersN)rCompleteUsernamesrrr/rroutrrrtest_usernames  z ZshCompleterTests.test_usernamescCr)zc CompleteGroups produces zsh shell-code that completes system group names. rz:group:_groupsrTrz*:some action:_groupsN)rCompleteGroupsrrr/rrrr test_groupsrzZshCompleterTests.test_groupscCr)zU CompleteHostnames produces zsh shell-code that completes hostnames. rz:some-option:_hostsrTrz*:some action:_hostsN)rCompleteHostnamesrrr/rrrrtest_hostnames rz ZshCompleterTests.test_hostnamescCsVt}|dtj}||dtjddd}|dtj}||ddS)z CompleteUserAtHost produces zsh shell-code that completes hostnames or a word of the form @. rz:host | user@host:rTrrN)rCompleteUserAtHostrrr startswithrrrrtest_userAtHost,s z!ZshCompleterTests.test_userAtHostcCr)zv CompleteNetInterfaces produces zsh shell-code that completes system network interface names. rz:some-option:_net_interfacesrTrz*:some action:_net_interfacesN)rCompleteNetInterfacesrrr/rrrrtest_netInterfaces9rz$ZshCompleterTests.test_netInterfacesN)rr r!r6rrrrrrrrrrrrrrrs     rc@eZdZdZddZdS)CompleterNotImplementedTestszs Using an unknown shell constant with the various Completer() classes should raise NotImplementedError c Csrtjtjtjtjtjtjtjtjtj tj g }|D]}z|}Wn t y,|d}Ynw| t |jddqdS)zM Using an unknown shellType should raise NotImplementedError Nbad_shell_type)rrrrrrrrrrr BaseExceptionrRNotImplementedErrorr)rclassesclsactionrrrtest_unknownShellMs*     z.CompleterNotImplementedTests.test_unknownShellN)rr r!r6rrrrrrGs rc@s>eZdZdZGdddZddZddZdd Zd d Zd S) FlagFunctionTestsz* Tests for L{usage.flagFunction}. c@rc) zFlagFunctionTests.SomeClassz> Dummy class for L{usage.flagFunction} tests. cCdS)z A one argument method to be tested by L{usage.flagFunction}. @param a: a useless argument to satisfy the function's signature. Nr)rrrrroneArgrz"FlagFunctionTests.SomeClass.oneArgcCr)zU A no argument method to be tested by L{usage.flagFunction}. NrrrrrnoArgyrz!FlagFunctionTests.SomeClass.noArgcCr)aG A multiple arguments method to be tested by L{usage.flagFunction}. @param a: a useless argument to satisfy the function's signature. @param b: a useless argument to satisfy the function's signature. @param c: a useless argument to satisfy the function's signature. Nr)rrrrrrrmanyArgs~rz$FlagFunctionTests.SomeClass.manyArgsN)rr r!r6rrrrrrr SomeClassms  rcC|dt|jdS)zs L{usage.flagFunction} returns C{False} if the method checked allows exactly one argument. FN)assertIsr flagFunctionrrrrrr test_hasArgzFlagFunctionTests.test_hasArgcCr)zq L{usage.flagFunction} returns C{True} if the method checked allows exactly no argument. TN)rrrrrrrrr test_noArgrzFlagFunctionTests.test_noArgcCs,|tjtj|j}|dt|dS)z L{usage.flagFunction} raises L{usage.UsageError} if the method checked allows more than one argument. z$Invalid Option function for manyArgsNrRrrSrrrr/rjrexcrrrtest_tooManyArgumentssz'FlagFunctionTests.test_tooManyArgumentscCs.|tjtj|jd}|dt|dS)z L{usage.flagFunction} uses the given method name in the error message raised when the method allows too many arguments. flubudufz$Invalid Option function for flubudufNrrrrr,test_tooManyArgumentsAndSpecificErrorMessagesz>FlagFunctionTests.test_tooManyArgumentsAndSpecificErrorMessageN) rr r!r6rrrrr rrrrrhs rc@r)OptionsInternalTestsz6 Tests internal behavior of C{usage.Options}. cCsNGdddtj}|}|tgdd|jd|jd|jdddS)zs Options which are synonyms to another option are aliases towards the longest option name. c@seZdZddZeZeZdS)z;OptionsInternalTests.test_optionsAliasesOrder..OptscSr)z~ This is an option method with a very long name, that is going to be aliased. Nrrrrropt_very_very_longrzNOptionsInternalTests.test_optionsAliasesOrder..Opts.opt_very_very_longN)rr r!r  opt_shortopt_srrrrOptssr)rshortvery-very-longrrrN)rrr/dictfromkeyssynonyms)rrrrrrtest_optionsAliasesOrders z-OptionsInternalTests.test_optionsAliasesOrderN)rr r!r6rrrrrr s r N)r6twisted.pythonr twisted.trialrrrTestCaser$r7rCrUrXrdrnrrrwr|rrrrrrr rrrrs,  +; %   $!B