3~hyMdZddlZddlmZmZddlmZddlmZm Z m Z m Z m Z ddl mZddlmZGddZGd d eZGd d eZGd dZGddZeddGddZy)au This module contains helpers/fixtures to assist in testing Fabric-driven code. It is not intended for production use, and pulls in some test-oriented dependencies as needed. You can install an 'extra' variant of Fabric to get these dependencies if you aren't already using them for your own testing purposes: ``pip install fabric[testing]``. .. note:: If you're using pytest for your test suite, you may be interested in grabbing ``fabric[pytest]`` instead, which encompasses the dependencies of both this module and the `fabric.testing.fixtures` module, which contains pytest fixtures. .. versionadded:: 2.1 N)chainrepeat)BytesIO)Mock PropertyMockcallpatchANY) deprecatedc$eZdZdZddZdZdZy)Commanda Data record specifying params of a command execution to mock/expect. :param str cmd: Command string to expect. If not given, no expectations about the command executed will be set up. Default: ``None``. :param bytes out: Data yielded as remote stdout. Default: ``b""``. :param bytes err: Data yielded as remote stderr. Default: ``b""``. :param int exit: Remote exit code. Default: ``0``. :param int waits: Number of calls to the channel's ``exit_status_ready`` that should return ``False`` before it then returns ``True``. Default: ``0`` (``exit_status_ready`` will return ``True`` immediately). .. versionadded:: 2.1 NcX||_||_||_||_||_||_yN)cmdouterrin_exitwaits)selfrrrrrrs \/var/www/peopleoo.sandbox-dev.co.uk/venv/lib/python3.12/site-packages/fabric/testing/base.py__init__zCommand.__init__5s,  cbdj|jj|jS)Nz <{} cmd={!r}>)format __class____name__rrs r__repr__zCommand.__repr__=s%%%dnn&=&=txxHHrc^|jj|jxsty)zj Assert that the ``channel`` was used to run this command. .. versionadded:: 2.7 N) exec_commandassert_called_withrr rchannels rexpect_executionzCommand.expect_executionBs //C@r)NrrNrr)r __module__ __qualname____doc__rrr%rrr r s*I Arr ceZdZdZdZy) ShellCommandzg A pseudo-command that expects an interactive shell to be executed. .. versionadded:: 2.7 c8|jjyr) invoke_shellassert_called_once_withr#s rr%zShellCommand.expect_executionRs446rN)rr&r'r(r%r)rrr+r+Ks  7rr+c:eZdZdZfdZdZdZdZdZxZ S) MockChannelz Mock subclass that tracks state for its ``recv(_stderr)?`` methods. Turns out abusing function closures inside MockRemote to track this state only worked for 1 command per session! .. versionadded:: 2.1 ctj|d|jdtj|d|jdtj|dtt ||i|y)N__stdoutstdout__stderrstderr_stdin)object __setattr__poprsuperr)rargskwargsrs rrzMockChannel.__init__`sa 4VZZ-AB4VZZ-AB4795 $)&)rc tdi|S)Nr))r)rr<s r_get_child_mockzMockChannel._get_child_mockis~f~rcLtj|dj|S)Nr2r7__getattribute__readrcounts rrecvzMockChannel.recvm &&tZ8==eDDrcLtj|dj|S)Nr4r@rCs r recv_stderrzMockChannel.recv_stderrprFrcLtj|dj|S)Nr6)r7rAwrite)rdatas rsendallzMockChannel.sendallss &&tX6<rErHrL __classcell__)rs@rr0r0Vs$*EECrr0cheZdZdZ d dZdZdZeddd Zd Z d Z y) Sessionak A mock remote session of a single connection and 1 or more command execs. Allows quick configuration of expected remote state, and also helps generate the necessary test mocks used by `MockRemote` itself. Only useful when handed into `MockRemote`. The parameters ``cmd``, ``out``, ``err``, ``exit`` and ``waits`` are all shorthand for the same constructor arguments for a single anonymous `.Command`; see `.Command` for details. To give fully explicit `.Command` objects, use the ``commands`` parameter. :param str user: :param str host: :param int port: Sets up expectations that a connection will be generated to the given user, host and/or port. If ``None`` (default), no expectations are generated / any value is accepted. :param commands: Iterable of `.Command` objects, used when mocking nontrivial sessions involving >1 command execution per host. Default: ``None``. .. note:: Giving ``cmd``, ``out`` etc alongside explicit ``commands`` is not allowed and will result in an error. :param bool enable_sftp: Whether to enable basic SFTP mocking support. :param transfers: None if no transfers to expect; otherwise, should be a list of dicts of the form ``{"method": "get|put", **kwargs}`` where ``**kwargs`` are the kwargs expected in the relevant `~paramiko.sftp_client.SFTPClient` method. (eg: ``{"method": "put", "localpath": "/some/path"}``) .. versionadded:: 2.1 .. versionchanged:: 3.2 Added the ``enable_sftp`` and ``transfers`` parameters. Nc p|xs|xs |xs| xs| } |r | r td|xs|xs| |_||_||_||_||_| r=i}|||d<|||d<|||d<|||d<| | |d<| | |d<t di|g|_|j st g|_| |_| |_y) NzAYou can't give both 'commands' and individual Command parameters!rrrrrrr)) ValueError guard_onlyhostuserportcommandsr _enable_sftp transfers)rrSrTrUrVrrrrrr enable_sftprXparamsr<s rrzSession.__init__s 33s3d3e &  (;3;)<     F #u  #u  #u  #u !%v "'w$.v./DM}}$YKDM'"rc^t}|jj}td}t |t |_g}|jD]}tt|jt|j}|j|j_ttd|jtd}||j _|j%|||j&_|j(r|j+|||_||_y)a Mocks `~paramiko.client.SSHClient` and `~paramiko.channel.Channel`. Specifically, the client will expect itself to be connected to ``self.host`` (if given), the channels will be associated with the client's `~paramiko.transport.Transport`, and the channels will expect/provide command-execution behavior as specified on the `.Command` objects supplied to this `.Session`. The client is then attached as ``self.client`` and the channels as ``self.channels``. :returns: ``None`` - this is mostly a "deferred setup" method and callers will just reference the above attributes (and call more methods) as needed. .. versionadded:: 2.1 T) side_effect)r3r5FN)r get_transport return_valuerrtypeactiverVr0rrrrrecv_exit_statusrrexit_status_readyr\append open_sessionrW _start_sftpclientchannels)rrf transportactivesrgcommandr$readiess rgenerate_mockszSession.generate_mockss(((55 ,".'!BY}} %G"w{{+GGKK4HG5.fake_abspath$%%bgg&6&6t&<= =r/remotebasenamesplitjoinru)r os_patcherstart path_patcher open_sftpr^sftprtabspathr\getcwdstatst_moderssepgetattr)rrfmock_osrrw fake_modenames rrezSession._start_sftps 45//'')!"89 !!++888 D > ,8 (#,   )2 &,5 !!)ff = MD6=bggt6LGGLL$ ' 3 Mr3.2zGThis method has been renamed to `safety_check` & will be removed in 4.0versionreasonc"|jSr) safety_checkrs r sanity_checkzSession.sanity_check-s   ""rc&|jry|jj}|j|jjj|j xst |jxst |jxst g}t|j|jD]f\}}|jt|j||js>|j j#|jk(rfJ|j$j&j(}||k(sJ|j*xsgD];}|j-d}t/|j0|}|j2di|=y)N)usernamehostnamerU)r$methodr))rRrfr]r.connectrTr rSrUziprgrVrcrr%rr6getvaluer^rdcall_args_listrXr9rrassert_any_call) rrh session_opensr$rjcallstransfer method_namers rrzSession.safety_check4sQ ?? KK-- ))+ 33YY%#YY%#!c 4  #DMM4== A @ GW   (  $ $W $ 5{{~~..0GKK??? @&&33BB %%%," /H",,x0KTYY 4F "F " " .X . /rct|dr|jjt|dr|jjyy)zU Stop any internal per-session mocks. .. versionadded:: 3.2 rrN)hasattrrstoprrs rrz Session.stop\s? 4 & OO " 4 (    " " $ )r) NNNNNNNNNNFN) rr&r'r(rrlredeprecated_no_docstringrrrr)rrrOrOwsj'V       1#f;!zM8X# #&/P %rrOcbeZdZdZddZdZdZdZdZe dd d Z d Z d Z d Z y) MockRemoteaW Class representing mocked remote SSH/SFTP state. It supports stop/start style patching (useful for doctests) but then wraps that in a more convenient/common contextmanager pattern (useful in most other situations). The latter is also leveraged by the `fabric.testing.fixtures` module, recommended if you're using pytest. Note that the `expect` and `expect_sessions` methods automatically call `start`, so you won't normally need to do so by hand. By default, a single anonymous/internal `Session` is created, for convenience (eg mocking out SSH functionality as a safety measure). Users requiring detailed remote session expectations can call methods like `expect` or `expect_sessions`, which wipe that anonymous Session & set up a new one instead. .. versionadded:: 2.1 .. versionchanged:: 3.2 Added the ``enable_sftp`` init kwarg to enable mocking both SSH and SFTP at the same time. .. versionchanged:: 3.2 Added contextmanager semantics to the class, so you don't have to remember to call `safety`/`stop`. cH||_|jt|y)N)rY)rWexpect_sessionsrO)rrYs rrzMockRemote.__init__s' W=>rct|jd|j|jt|i|dS)z Convenience method for creating & 'expect'ing a single `Session`. Returns the single `MockChannel` yielded by that Session. .. versionadded:: 2.1 rYr) setdefaultrWrrO)rr;r<s rexpectzMockRemote.expects: -):):;##GT$z#MockRemote.start..s+N1AJJ+Ns) r patcherrrrlrcrfr\listr from_iterable)rr SSHClientclientssessionrs rrzMockRemote.starts"''D!EE wMMO }} +G  " " $ NN7>> * + !( +++N +NNOrct|dsy|jj|jD]}|jy)zI Stop patching SSHClient. .. versionadded:: 2.1 rN)rrrrrrs rrzMockRemote.stops=tY'  }} G LLN rrzAThis method has been renamed to `safety` & will be removed in 4.0rc"|jS)zq Run post-execution sanity checks (usually 'was X called' tests.) .. versionadded:: 2.1 )safetyrs rsanityzMockRemote.sanitys{{}rcF|jD]}|jy)zx Run post-execution safety checks (eg ensuring expected calls happened). .. versionadded:: 3.2 N)rrrs rrzMockRemote.safetys# }} #G  " #rc|Srr)rs r __enter__zMockRemote.__enter__s rcp |j|jy#|jwxYwr)rr)rexcs r__exit__zMockRemote.__exit__s#  KKM IIKDIIKs#5N)F)rr&r'r(rrrrrr rrrrr)rrrrhsO6? A$0 R #rrrzhThis class has been merged with `MockRemote` which can now handle SFTP mocking too. Please switch to it!rc$eZdZdZddZdZdZy)MockSFTPz Class managing mocked SFTP remote state. Used in start/stop fashion in eg doctests; wrapped in the SFTP fixtures in conftest.py for main use. .. versionadded:: 2.1 c*|r|jyyr)r)r autostarts rrzMockSFTP.__init__s  JJL rctd|_td|_td|_|jj }|jj }|jj |j j j }d}||jj_ d|j_d}||jj _ ||jj _ tj|_dD]5}ttj|t|j|_ 7||fS)Nrnrroc^djtjj|Srqrrrvs rrwz$MockSFTP.start..fake_abspathrxrryrzr{)r rclient_patcherrrr^rrtrr\rrrrsrr)rrClientrrwrrs rrzMockSFTP.starts 45#$AB!"89//'')$$**, !"",,99 > ,8 (#,   )2 &,5 !!)ff = MD6=bggt6LGGLL$ ' 3 MW}rc|jj|jj|jjyr)rrrrrs rrz MockSFTP.stops6    "  rN)T)rr&r'r(rrrr)rrrrs >!rr)r(rs itertoolsrrior unittest.mockrrrr r deprecated.sphinxr deprecated.classicrr r+r0rOrrr)rrrs" #>>(D)A)AX777C$CBn%n%b@@F  u0!0! 0!r