tfRdZddlZddlmZddlmZmZddlmZm Z m Z ddl m Z m Z mZmZddlmZGdd eZGd d e Zd ZGddejZGddejZGddejZGdde jZGdde jZGddeZdZGdde jZGdde jZ Gdd e jZ!Gd!d"eZ"d#Z#d$Z$dS)%z* Test cases for twisted.python._shellcomp N)BytesIO)ListOptional) _shellcompreflectusage) CompleteFiles CompleteList Completer Completions)unittestceZdZdZdZdS)ZshScriptTestMetaz* Metaclass of ZshScriptTestMixin. cd}d|vr"|dD]\}}|||}||d|z<t||||S)Ncfd}|S)Nc&t|S)N)test_genZshFunction)selfcmdName optionsFQPNs a/var/www/surfInsights/venv3-11/lib/python3.11/site-packages/twisted/python/test/test_shellcomp.pyrunTestz.makeTest..runTests*4+FFF)rrrs`` rmakeTestz+ZshScriptTestMeta.__new__..makeTests/ G G G G G GNr generateFortest_genZshFunction_)type__new__)clsnamebasesattrsrrrtests rrzZshScriptTestMeta.__new__ss    E ! !(-m(< ? ?$x55:>,w677||Cue444rN)__name__ __module__ __qualname____doc__rrrrrrs-55555rrceZdZdZdS)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(rrrr*r*(srr*) metaclassc t}|tjd| t j|}n)#t $r}tjd|d}~wwxYw | gd| dn3#t$r}tjd|fd}~wt$rYnwxYw| d|dt|d| d|t%|d r|jD]\}}}} | |d d d g| dn3#t$r}tjd |fd}~wt$rYnwxYw| d|dt|d| d||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. _shellCompFilez.Couldn't import or instantiate Options class: N--_shell-completionzsh:2zSystemExit not raisedz&ImportError calling parseOptions(): %sr subCommandsr/r0zzsh:3z4ImportError calling parseOptions() on subcommand: %s)rpatchrOptionsrnamedAny Exceptionr SkipTest parseOptionsfail ImportError SystemExitseek assertEquallenreadtruncatehasattrr3 flushWarnings) rrr outputFileoecmdshortparserdocs rrr;sJJJu}. ;;; )G [ ) ) + +    EFQ H    + ;;;<<< )**** PPP H1$OOO      OOAQJOOA..//000OOAq-  "'(} " " #C 3R)>HIII 12222   'MPQt     OOA      QJOOA$6$6 7 7 8 8 8 OOA       ! ! ! ! sSA A4A//A48B%% C/C CC+F G $F:: G  G c`eZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdS)ZshTestsz' Tests for zsh completion code ct}tj|dt}tjj}|tjj| |j|| |j ttjj | |j tjj tjj }|tjj | |j || |jtjjdS)zi Are `compData' attributes you can place on Options classes picked up correctly? aceN)FighterAceExtendedOptionsrZshArgumentsGeneratorrFighterAceOptionscompData descriptionscopyupdater>multiUsesetmutuallyExclusive optActions extraActions)roptsagrSrYs rtest_accumulateMetadataz ZshTests.test_accumulateMetadatas0 )**  -dE799 E E(1>CCEE 5>KLLL ,777 c*;*D*M&N&NOOO   "3"<"N   '/:??AA 3<GHHH  333 *;*D*QRRRRRrcGddt}|}tj|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. c6eZdZgdgZegdgZdS)GZshTests.test_mutuallyExclusiveCornerCase..OddFighterAceOptions)anatraNz0Select the Anatra DS as your dogfighter aircraft)rafokkeralbatrosspadbristolrXN)r%r&r'optFlagsr rRrrrOddFighterAceOptionsr`sE UTTH#{#V#V#V"WHHHrrhrN>bfsrdrarbre>arirjrkrdrbrerc>rlrjrkrdrarbrc>rlrirkrdrarerc>rlrirjrarbrerc)rcrarerbrdN)rOrrPrr>excludes)rrhr[r\expecteds r test_mutuallyExclusiveCornerCasez)ZshTests.test_mutuallyExclusiveCornerCases     #<   $#%%  -dE799 E EONNSSSNNNNNNNNN    h/////rc>t}tj|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) rNnocrash difficultyN)rOrrPrassertInflagNameToDefinitionallOptionsNameToDefinitionparamNameToDefinition)rr[r\s r test_accumulateAdditionalOptionsz)ZshTests.test_accumulateAdditionalOptionss )**  -dE799 E E i!8999 i!>??? lB$<=== lB$ABBBBBrcBGddt}|ttj|dt Gddt}|ttj|dt dS)z\ Using a parameter/flag name that doesn't exist will raise an error c*eZdZeddiZdS)0ZshTests.test_verifyZshNames..TmpOptionsdetaillN)rYr%r&r'r rRrrr TmpOptionsrzs%"{y$.?@@@HHHrr}rNc(eZdZedgZdS)1ZshTests.test_verifyZshNames..TmpOptions2)foobarrfNr|rrr TmpOptions2rs%#{n5EFFFHHHrrN)rO assertRaises ValueErrorrrPr)rr}rs rtest_verifyZshNameszZshTests.test_verifyZshNamess  A A A A A2 A A A   8**,,wyy    G G G G G3 G G G    , KMM  II      rcVt}|tjd||tdgdt }|t|j| t| dS)zt Generate a completion function, and test the textual output against a known correct output r-argv)sillyr/r0r1N) rr4rr5sysSimpleProgOptionsrr<r9r> testOutput1getvaluerrDr[s r test_zshCodezZshTests.test_zshCodes YY  5="2J??? 3 M M MNNN "" *d&7888 j&9&9&;&;<<<< testOutput2rrs rtest_zshCodeWithSubszZshTests.test_zshCodeWithSubss YY  5="2J??? 3 N N NOOO(** *d&7888 j&9&9&;&;<<<<r?r@rs rtest_incompleteCommandLinez#ZshTests.test_incompleteCommandLines YY  5="2J??? ""          C  2 23344444rct}|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-serverr0rrr2N) rr4rr5rQrr<r9r=r>r?r@rArs r test_incompleteCommandLine_case2z)ZshTests.test_incompleteCommandLine_case2sYY  5="2J??? ""          C  2 233444rc\t}|tjd|t }|t |jgd|d| dt| ddS)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-subcommandrr0zzsh:4rr2Nrrs r test_incompleteCommandLine_case3z)ZshTests.test_incompleteCommandLine_case34sYY  5="2J??? ""          C  2 23344444rc\t}|tjd|t }|t |jgd|d| dt| ddS)z Ensure the optimization which skips building the subcommand list under certain conditions isn't broken. r-)z--albar0r1rr2Nrrs rtest_skipSubcommandListz ZshTests.test_skipSubcommandListOs YY  5="2J??? ""  )+U+U+U     C  2 23344444rct}tj|dd}|d}||ddS)zY Test corner case fetching an option description from a method docstring rNNr)rQrrPgetDescriptionr>)rr[argGendescrs rtest_poorlyDescribedOptMethodz&ZshTests.test_poorlyDescribedOptMethod_sT!""1$tDD%%g.. (((((rcGddtj}t}|}||d||t |jgddS)zu A C{Completer} with repeat=True may only be used as the last item in the extraActions list. cleZdZejejdejgZdS)2ZshTests.test_brokenActions..BrokenActionsT)repeat)rZN)r%r&r'rr r rRrrr BrokenActionsrrsH(u(-eoT:::OEO.Options)flagrjA flag)parampNA paramcdSzjunk descriptionNrrs ropt_flagz>ZshTests.test_optMethodsDontOverride..Options.opt_flagrcdSrr)rrs r opt_paramz?ZshTests.test_optMethodsDontOverride..Options.opt_paramrrN)r%r&r'rg optParametersrrrrrr5rsN///0H<<<=M ' ' ' ' ' ' ' 'rr5rNNrrrr)rr5rrPr>r)rr5r[rs rtest_optMethodsDontOverridez$ZshTests.test_optMethodsDontOverride~s  ' ' ' ' 'em ' ' 'wyy1$tDD ..v66AAA ..w77CCCCCrN)r%r&r'r(r]rorwrrrrrrrrrrrrrrLrLsSSS.000> C C C   6 = = = = = =5552>5556555 ) ) )   $DDDDDrrLceZdZdZdS) EscapeTestsctj}d}|||dd}|||ddS)z5 Verify _shellcomp.escape() function $z'$'z A--'$"\`--Bz"A--'\$\"\\\`--B"N)rescaper>)rescr$s r test_escapezEscapeTests.test_escapesY TE*** T$=>>>>>rN)r%r&r'rrrrrrs# ? ? ? ? ?rrceZdZdZdZdS)CompleterNotImplementedTestsz Test that using an unknown shell constant with SubcommandAction raises NotImplementedError The other Completer() subclasses are tested in test_usage.py cptj}|t|jdddS)zM Using an unknown shellType should raise NotImplementedError Nbad_shell_type)rSubcommandActionrNotImplementedError _shellCode)ractions rtest_unknownShellz.CompleterNotImplementedTests.test_unknownShellsA,..  !2D:J     rN)r%r&r'r(rrrrrrs-     rrc&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(rgrrrrrrsA UTTH   MMMrrc eZdZUdZgdgdgdgdgdgdgdgZeeeeed <gd gd gZ eeeeed <d de dggZ e ddddggdgde dgiedgZdZdS)rQzB Command-line options for an imaginary `Fighter Ace` game )rbrjz2Select the Fokker Dr.I as your dogfighter aircraft)rcrlz5Select the Albatros D-III as your dogfighter aircraft)rdrkz1Select the SPAD S.VII as your dogfighter aircraft)reriz4Select 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)rg)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)rbrcrdrer12345zsaved game file to loadrrSrVrXrYrZcdS) Nrrs r opt_sillyzFighterAceOptions.opt_sillyrr)r%r&r'r(rgrrstr__annotations__rrr3r r r rRrrrrrQrQsH NMMRRRJJJPPP@@@NNNMMM+Hd4 &' QPPJJJ0M4Xc]+, 402QRK{!2>VWWDDDEll,?+@AAB#m*CDDDE HrrQcheZdZdZgdgZgdgZeddidedi Zd Z d Z d S) rOz 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)rSrYcdS)z8 Select that you can't crash your plane Nrrs r opt_nocrashz%FighterAceExtendedOptions.opt_nocrashrrcdS)z+ How tough are you? (1-10) Nr)rrrs ropt_difficultyz(FighterAceExtendedOptions.opt_difficultyrrN) r%r&r'r(rgrr r rRrrrrrrOrOs SRRSHQQQM{!#;<#YY5L%M%M%MNH         rrOc(tgddS)N)12rz Accuracy'`?r)r rrr_accuracyActionr s } = = ==rc eZdZdZgdgdgdgZgdgdgZeddd d gd d ggegd dede dgZ dZ dS)rz> 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))accuracyrlrz"Select the level of accuracy (1-3)zColor onzOptimization level)rrrrr)rrr4rz Optimization?r)rrz output filercdS)zM usage.Options does not recognize single-letter opt_ methods Nrrs ropt_XzSimpleProgOptions.opt_X+rrN) r%r&r'r(rgrr r rr rRrrrrrrs /..222MMMH NMMDDDM {);OPP#V,-(L)))(   $m-8889   H     rrceZdZgdgZdS)SimpleProgSub1)sub-optrkz Sub Opt OneNr%r&r'rgrrrrr1///0HHHrrceZdZgdgZdS)SimpleProgSub2)rrkz Sub Opt TwoNrrrrrr5rrrcHeZdZdgddggZdgddggdgZdd ed gd d ed ggZd S) rz some-optionz other-optionrEz some-paramz other-paramr)z another-paramPzYet Another Paramsub1Nz Sub Command 1sub2z Sub Command 2)r%r&r'rgrrrr3rrrrr9s_.#!67H  333M ~7 ~7KKKrrs#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(riortypingrrtwisted.pythonrrrtwisted.python.usager r r r twisted.trialr rrr*rTestCaserLrrr5rrQrOrrrrrrrrrrr s  !!!!!!!!5555555555TTTTTTTTTTTT""""""55555555,#4&AAAHSDSDSDSDSDx SDSDSDl ? ? ? ? ?(# ? ? ?     8#4   &em$""""" """J     1   8>>>          F11111U]11111111U]111      1    &  r