U T‚gÆÆã@sôdZddlZddlZddlZddlZddlZddlZddlZddlm Z m Z ddl m Z ddl mZddlmZddlmZddlmZmZdd lmZdd lmZmZmZmZmZdd lmZdd l m!Z!dd l"m#Z#ddl$m%Z%ddl&m'Z'ddl(m)Z)ddl*m+Z+ddl,m-Z-ddl.m/Z/e-dƒZ0e-dƒZ1e0rªz\ddl2m3Z3ddl4m5Z5ddl6m7Z7ddl8m9Z9ddl:m;Z;mZ>ddlm?Z?Wne@k r¨YnXdZAde1e0e Bed¡fkrÊdZAe eAdƒGd d!„d!e/ƒƒZCGd"d#„d#e/ƒZDGd$d%„d%e!ƒZEGd&d'„d'ƒZFGd(d)„d)ƒZGeeƒGd*d+„d+e ƒƒZHe eAdƒGd,d-„d-e/ƒƒZIGd.d/„d/ƒZJGd0d1„d1ejKƒZLGd2d3„d3eƒZMe eAdƒGd4d5„d5eMƒƒZNe eAdƒGd6d7„d7eMƒƒZOe eAdƒe e+d8ƒ d9ƒe e+d:ƒ d;ƒGdz* Tests for L{twisted.conch.scripts.cftp}. éN)ÚBytesIOÚ TextIOWrapper)ÚskipIf)Ú implementer)Úls)Ú ISFTPFile)ÚFileTransferTestAvatarÚ SFTPTestBase)Úportal)ÚdeferÚerrorÚ interfacesÚprotocolÚreactor)ÚClock)ÚStringTransport)ÚgetProcessOutputAndValue)Úlog)Ú UserDatabase)ÚFilePath)Úwhich)Ú requireModule)ÚTestCaseÚ cryptographyztwisted.conch.unix)Úcftp)Ú SSHSession)Ú filetransfer)ÚEXTENDED_DATA_STDERR)Ú test_conchÚtest_ssh)Ú FakeStdio)ÚFileTransferForTestAvatarFTz*don't run w/o spawnProcess or cryptographyc@s:eZdZdZddœdd„Zddœdd„Zddœdd „ZdS) ÚSSHSessionTestsz= Tests for L{twisted.conch.scripts.cftp.SSHSession}. N)ÚreturncCs<tƒ|_tƒ|_|j|j_tƒ|_t|jƒ|_|j|j_dS©N)r ÚstdiorÚchannelrÚ stderrBufferrÚstderr©Úself©r+ú@/tmp/pip-unpacked-wheel-1_7di8ic/twisted/conch/test/test_cftp.pyÚsetUp>s   zSSHSessionTests.setUpcCs|j ¡| |jj¡dS)z| L{twisted.conch.scripts.cftp.SSHSession.eofReceived} loses the write half of its stdio connection. N)r&Z eofReceivedÚ assertTruer%Z writeConnLostr)r+r+r,Útest_eofReceivedFs z SSHSessionTests.test_eofReceivedcCs:d}| d¡}|j t|d¡| |j ¡|d¡dS)zÉ L{twisted.conch.scripts.cftp.SSHSession.extReceived} decodes stderr data using UTF-8 with the "backslashescape" error handling and writes the result to its own stderr. u☃úutf-8óÿs\xffN)Úencoder&Z extReceivedrÚ assertEqualr'Úgetvalue)r*Z errorTextZ errorBytesr+r+r,Útest_extReceivedStderrNs þþz&SSHSessionTests.test_extReceivedStderr)Ú__name__Ú __module__Ú __qualname__Ú__doc__r-r/r5r+r+r+r,r"8sr"c @s¶eZdZdZeeddƒdkr dZdd„Zdd„Zd d „Z d d „Z d d„Z e   ¡Zz6ze  e jd¡Wne jk r~dZYnXdZW5e  e je¡Xeedƒdd„ƒZdd„ZdS)Ú ListingTestszƒ Tests for L{lsLine}, the function which generates an entry for a file or directory in an SFTP I{ls} command's output. ÚtzsetNz8Cannot test timestamp formatting code without time.tzsetcshdˆ_‡fdd„}ˆ td|¡dtjkrRˆ tjtjdtjd¡ˆ tj ¡ndd„}ˆ |¡dS) zo Patch the L{ls} module's time function so the results of L{lsLine} are deterministic. iÍ[csˆjSr$)Únowr+r)r+r,ÚfakeTimepsz$ListingTests.setUp..fakeTimeÚtimeÚTZcSs.z tjd=Wntk r YnXt ¡dS)Nr?)ÚosÚenvironÚKeyErrorr>r;r+r+r+r,Úcleanup|s  z#ListingTests.setUp..cleanupN) r<Úpatchrr@rAÚ addCleanupÚoperatorÚsetitemr>r;)r*r=rCr+r)r,r-is  zListingTests.setUpcCs|tjd<t ¡t d|¡S)zl Call L{ls.lsLine} after setting the timezone to C{timezone} and return the result. r?Úfoo)r@rAr>r;rZlsLine)r*ÚtimezoneÚstatr+r+r,Ú _lsInTimezone†s zListingTests._lsInTimezonec CsT|jd}t dddddddd|df ¡}| | d|¡d¡| | d|¡d¡dS)z‘ A file with an mtime six months (approximately) or more in the past has a listing including a low-resolution timestamp. é€rúAmerica/New_Yorkz;!--------- 0 0 0 0 Apr 26 1973 fooúPacific/Aucklandz;!--------- 0 0 0 0 Apr 27 1973 fooN©r<r@Ú stat_resultr3rK©r*ÚthenrJr+r+r,Ú test_oldFile‘s  þ þzListingTests.test_oldFilec CsX|jdd}t dddddddd|df ¡}| | d|¡d¡| | d|¡d¡dS) úæ A file with a high-resolution timestamp which falls on a day of the month which can be represented by one decimal digit is formatted with one padding 0 to preserve the columns which come after it. rLi€—rrMz;!--------- 0 0 0 0 May 01 1973 foorNz;!--------- 0 0 0 0 May 02 1973 fooNrOrQr+r+r,Útest_oldSingleDigitDayOfMonth£s þ þz*ListingTests.test_oldSingleDigitDayOfMonthc CsT|jd}t dddddddd|df ¡}| | d|¡d¡| | d|¡d¡dS)z¨ A file with an mtime fewer than six months (approximately) in the past has a listing including a high-resolution timestamp excluding the year. 逛zrrMú;!--------- 0 0 0 0 Aug 28 17:33 foorNú;!--------- 0 0 0 0 Aug 29 09:33 fooNrOrQr+r+r,Ú test_newFile·s  þ þzListingTests.test_newFileú es_AR.UTF8TFz'The es_AR.UTF8 locale is not installed.c Cs||jd}t dddddddd|df ¡}t ¡}t tjd¡| tjtj|¡| |  d|¡d¡| |  d|¡d¡dS) zC The month name in the date is locale independent. rVrrZrMrWrNrXN) r<r@rPÚlocaleÚ getlocaleÚ setlocaleÚLC_ALLrEr3rK)r*rRrJÚ currentLocaler+r+r,Útest_localeIndependentÖs  þ þz#ListingTests.test_localeIndependentc CsX|jdd}t dddddddd|df ¡}| | d|¡d¡| | d|¡d¡dS) rTrViFrrMz;!--------- 0 0 0 0 Sep 01 17:33 foorNz;!--------- 0 0 0 0 Sep 02 09:33 fooNrOrQr+r+r,Útest_newSingleDigitDayOfMonthís þ þz*ListingTests.test_newSingleDigitDayOfMonth)r6r7r8r9Úgetattrr>Úskipr-rKrSrUrYr[r\r_r]r^ÚErrorZ localeSkiprr`rar+r+r+r,r:`s&   r:cs eZdZdZ‡fdd„Z‡ZS)ÚInMemorySSHChannelzp Minimal implementation of a L{SSHChannel} like class which only reads and writes data from memory. cs||_d|_tƒ ¡dS)zt @param conn: The SSH connection associated with this channel. @type conn: L{SSHConnection} rN)ÚconnZ localClosedÚsuperÚ__init__)r*rf©Ú __class__r+r,rhszInMemorySSHChannel.__init__)r6r7r8r9rhÚ __classcell__r+r+rir,resrec@s(eZdZdZdd„Zdd„Zdd„ZdS) ÚFilesystemAccessExpectationszC A test helper used to support expected filesystem access. cCs i|_dSr$©Ú_cacher)r+r+r,rhsz%FilesystemAccessExpectations.__init__cCs||j||f<dS)zü @param path: Path at which the stream is requested. @type path: L{str} @param path: Flags with which the stream is requested. @type path: L{str} @param stream: A stream. @type stream: C{File} Nrm)r*ÚpathÚflagsÚstreamr+r+r,Úputs z FilesystemAccessExpectations.putcCs|j ||f¡S)a Remove a stream from the memory. @param path: Path at which the stream is requested. @type path: L{str} @param path: Flags with which the stream is requested. @type path: L{str} @return: A stream. @rtype: C{File} )rnÚpop)r*rorpr+r+r,rs(s z FilesystemAccessExpectations.popN)r6r7r8r9rhrrrsr+r+r+r,rlsrlc@s eZdZdZdd„Zdd„ZdS)ÚInMemorySFTPClienta' A L{filetransfer.FileTransferClient} which does filesystem operations in memory, without touching the local disc or the network interface. @ivar _availableFiles: File like objects which are available to the SFTP client. @type _availableFiles: L{FilesystemRegister} cCs t|ƒ|_dddœ|_||_dS)Néé )ÚrequestsÚ buffersize)reÚ transportÚoptionsÚ_availableFiles)r*ZavailableFilesr+r+r,rhBs  þzInMemorySFTPClient.__init__cCs|j ||¡S)z} @see: L{filetransfer.FileTransferClient.openFile}. Retrieve and remove cached file based on flags. )r{rs)r*ÚfilenamerpÚattrsr+r+r,ÚopenFileJszInMemorySFTPClient.openFileN)r6r7r8r9rhr~r+r+r+r,rt8s rtc@sHeZdZdZdd„Zdd„Zdd„Zdd „Zd d „Zd d „Z dd„Z dS)ÚInMemoryRemoteFilez; An L{ISFTPFile} which handles all data in memory. cCs||_t |¡dS)zL @param name: Name of this file. @type name: L{str} N)Únamerrh)r*r€r+r+r,rhYszInMemoryRemoteFile.__init__cCs| |¡| |¡t |¡S)z/ @see: L{ISFTPFile.writeChunk} )ÚseekÚwriter Úsucceed)r*ÚstartÚdatar+r+r,Ú writeChunkas  zInMemoryRemoteFile.writeChunkcCs d|_dS)zo @see: L{ISFTPFile.writeChunk} Keeps data after file was closed to help with testing. TN)Ú_closedr)r+r+r,ÚcloseiszInMemoryRemoteFile.closecCsdSr$r+r)r+r+r,ÚgetAttrsqszInMemoryRemoteFile.getAttrscCsdSr$r+)r*ÚoffsetÚlengthr+r+r,Ú readChunkuszInMemoryRemoteFile.readChunkcCsdSr$r+)r*r}r+r+r,ÚsetAttrsyszInMemoryRemoteFile.setAttrscCs t |¡S)zb Get current data of file. Allow reading data event when file is closed. )rr4r)r+r+r,r4}szInMemoryRemoteFile.getvalueN) r6r7r8r9rhr†rˆr‰rŒrr4r+r+r+r,rSsrc@s¤eZdZdZdd„Zdd„Zdd„Zdd „Zd d „Zd d „Z dd„Z dd„Z dd„Z dd„Z dd„Zdd„Zd)dd„Zd*dd „Zd!d"„Zd#d$„Zd%d&„Zd'd(„ZdS)+ÚStdioClientTestsz( Tests for L{cftp.StdioClient}. cCsTtƒ|_t|jƒ}t |¡|_d|j_tƒ|_|j_ |  dd¡|jjj |j_ dS)zm Create a L{cftp.StdioClient} hooked up to dummy transport and a fake user database. ú/iôéN) rlÚfakeFilesystemrtrÚ StdioClientÚclientZcurrentDirectoryrÚdatabaseÚ_pwdÚsetKnownConsoleSizery)r*Z sftpClientr+r+r,r-Œs   zStdioClientTests.setUpc Cs@|j t ¡dt ¡dddtj¡|j  d¡}|  |j d¡|S)zs The I{exec} command runs its arguments locally in a child process using the user's shell. ÚsecretéÒrHÚbarzexec print(1 + 2)s3 ) r”ÚaddUserÚgetpassÚgetuserr@ÚgetuidÚsysÚ executabler“Ú_dispatchCommandÚ addCallbackr3©r*Údr+r+r,Ú test_execŸsÿ zStdioClientTests.test_execc Cs>|j t ¡dt ¡dddd¡|j d¡}| |j d¡|S)zr If the local user has no shell, the I{exec} command runs its arguments using I{/bin/sh}. r—r˜rHr™Úzexec echo helloóhello © r”ršr›rœr@rr“r r¡r3r¢r+r+r,Útest_execWithoutShell¬sÿ z&StdioClientTests.test_execWithoutShellc Cs>|j t ¡dt ¡dddd¡|j d¡}| |j d¡|S)zO The I{exec} command is run for lines which start with C{"!"}. r—r˜rHr™z/bin/shz !echo hellor¦r§r¢r+r+r,Ú test_bang¹sÿ zStdioClientTests.test_bangcs2ddl‰G‡‡‡fdd„dƒ}| td|ƒ¡dS)a For the duration of this test, patch C{cftp}'s C{fcntl} module to return a fixed width and height. @param width: the width in characters @type width: L{int} @param height: the height in characters @type height: L{int} rNcseZdZ‡‡‡fdd„ZdS)z7StdioClientTests.setKnownConsoleSize..FakeFcntlcs&|ˆjkr| d¡t dˆˆdd¡S)Nz#Only window-size queries supported.Z4Hr)Ú TIOCGWINSZZfailÚstructÚpack)r*ÚfdÚoptZmutate©ÚheightÚttyÚwidthr+r,ÚioctlÓs  z=StdioClientTests.setKnownConsoleSize..FakeFcntl.ioctlN)r6r7r8r³r+r¯r+r,Ú FakeFcntlÒsr´Zfcntl)r±rDr)r*r²r°r´r+r¯r,r–Ås z$StdioClientTests.setKnownConsoleSizecCs‚| dd¡tƒ}|j_tdƒ}d|_t |¡}d|_|  ¡}|  d¡|j d7_ |j  ||¡d}|  |jj ¡|¡d S) a( L{StdioClient._printProgressBar} prints a progress description, including percent done, amount transferred, transfer rate, and time remaining, all based the given start time, the given L{FileWrapper}'s progress information and the reactor's current time. rvé"óxósamplei(g@is# b'sample' 40% 4.0kB 2.0kBps 00:03 N)r–rr“rrr€rÚ FileWrapperÚsizeÚsecondsZadvanceÚtotalÚ_printProgressBarr3ryÚvalue©r*ZclockÚwrappedÚwrapperZ startTimeÚresultr+r+r,Útest_printProgressBarReportingÚs   z/StdioClientTests.test_printProgressBarReportingcCsd| dd¡tƒ}|j_tdƒ}d|_t |¡}| ¡}|j  ||¡d}|  |jj   ¡|¡dS)z½ L{StdioClient._printProgressBar} prints a progress description that indicates 0 bytes transferred if no bytes have been transferred and no time has passed. rvrµr¶r·s! b'sample' 0% 0.0B 0.0Bps 00:00 N) r–rr“rrr€rr¸rºr¼r3ryr½r¾r+r+r,Útest_printProgressBarNoProgressòs  z0StdioClientTests.test_printProgressBarNoProgresscCsL| dd¡tƒ}d|_t |¡}|j |d¡d}| ||jj  ¡¡dS)z5 Print the progress for empty files. rvrµs empty-filers% b'empty-file'100% 0.0B 0.0Bps 00:00 N) r–rr€rr¸r“r¼r3ryr½)r*r¿rÀrÁr+r+r,Útest_printProgressBarEmptyFiles  z/StdioClientTests.test_printProgressBarEmptyFilecCs|j d¡}| d|¡dS)zK Returns empty value for both filename and remaining data. z )r¥r¥N©r“Z _getFilenamer3©r*rÁr+r+r,Útest_getFilenameEmptys z&StdioClientTests.test_getFilenameEmptycCs|j d¡}| d|¡dS)zd Returns empty value for remaining data when line contains only a filename. ú only-local)rÈr¥NrÅrÆr+r+r,Útest_getFilenameOnlyLocals z*StdioClientTests.test_getFilenameOnlyLocalcCs|j d¡}| d|¡dS)ze Returns filename and remaining data striped of leading and trailing spaces. z local remote file )Úlocalz remote fileNrÅrÆr+r+r,Útest_getFilenameNotQuoted#s z*StdioClientTests.test_getFilenameNotQuotedcCs|j d¡}| d|¡dS)z‰ Returns filename and remaining data not striped of leading and trailing spaces when quoted paths are requested. z" " local file " " remote file " )z local file z" remote file "NrÅrÆr+r+r,Útest_getFilenameQuoted,s z'StdioClientTests.test_getFilenameQuotedNóc Cs4|dkr| ¡}t|dƒ}| |¡W5QRX|S)ab Create a local file and return its path. When `path` is L{None}, it will create a new temporary file. @param path: Optional path for the new file. @type path: L{str} @param content: Content to be written in the new file. @type content: L{bytes} @return: Path to the newly create file. NÚwb)ÚmktempÚopenr‚)r*roÚcontentÚfiler+r+r,ÚmakeFile5s  zStdioClientTests.makeFileFcCsj|jj ¡}| d¡}| d¡}g}g}|D]þ\}}}g} |D]} |  |›d| ›¡q>|  d|›d|›¡| | ¡| d¡ d¡ d¡} | dd …} | d  d ¡ d ¡} |  | ¡g}| dd …D]H} |  ¡  dd ¡d} |  ¡ dd ¡} | | d›d| d  ¡›¡qÈ| | d ¡| |¡q,|rH|  t |ƒt |ƒ¡n |  ||¡|  dt |ƒd ¡dS)a Check output of cftp client for a put request. @param transfers: List with tuple of (local, remote, progress). @param randomOrder: When set to C{True}, it will ignore the order in which put reposes are received r0z ú z Transferred z to rú NéÿÿÿÿÚ éruz5There are still put responses which were not checked.) r“ryr½ÚdecodeÚsplitÚappendrsÚstripÚextendÚrsplitr3ÚsortedÚlen)r*Z transfersÚ randomOrderÚoutputÚexpectedOutputZ actualOutputrÊÚremoteÚexpectedZexpectedTransferÚlineZ progressPartsÚactualÚlastZactualTransferr+r+r,ÚcheckPutMessageIs<      "  ýz StdioClientTests.checkPutMessagecCs²d}|j|d}tjtjBtjB}tj dtj |¡¡}t |ƒ}|j   ||t   |¡¡d|jjjd<|j |¡}| |¡| || ¡¡| |j¡| ||dddgfg¡dS) z A name based on local path is used when remote path is not provided. The progress is updated while chunks are transferred. s Test Content)rÑrrvrxz 76% 10.0Bz 100% 13.0BN)rÓrÚ FXF_WRITEÚ FXF_CREATÚ FXF_TRUNCr@roÚjoinÚbasenamerr‘rrr rƒr“rzÚcmd_PUTÚsuccessResultOfr3r4r.r‡ré)r*rÑÚ localPathrpÚ remoteNameÚ remoteFileÚdeferredr+r+r,Útest_cmd_PUTSingleNoRemotePath†s    ÿz/StdioClientTests.test_cmd_PUTSingleNoRemotePathcCs’| ¡}tjtjBtjB}d}t|ƒ}|j ||t  |¡¡|j   |›d|›d¡}|  |¡|  ||dgfg¡| |j¡| d| ¡¡dS)z€ Remote path is extracted from first filename after local file. Any other data in the line is ignored. z /remote-pathrÔz ignoredú 100% 0.0BrÍN)rÓrrêrërìrr‘rrr rƒr“rïrðrér.r‡r3r4)r*rñrpròrórôr+r+r,Útest_cmd_PUTSingleRemotePathžs  z-StdioClientTests.test_cmd_PUTSingleRemotePathc Cs| ¡}tj |¡}d}tj |¡}|jtj ||¡d}tjtjBtj B}d|›}d|›}t |ƒ} t |ƒ} |j   ||t  | ¡¡|j   ||t  | ¡¡|j tj |d¡¡} | | ¡| | j¡| d|  ¡¡| | j¡| d|  ¡¡|j||dgf||dgfgddd S) z„ When a gobbing expression is used local files are transferred with remote file names based on local names. ú second-name©rorÚ*rÍröT©ráN)rÓr@rorîÚdirnamerírrêrërìrr‘rrr rƒr“rïrðr.r‡r3r4ré) r*ÚfirstÚ firstNameÚ secondNameÚparentÚsecondrpÚfirstRemotePathÚsecondRemotePathÚfirstRemoteFileÚsecondRemoteFilerôr+r+r,Ú test_cmd_PUTMultipleNoRemotePath±s8    ÿ     þûz1StdioClientTests.test_cmd_PUTMultipleNoRemotePathc Cs | ¡}tj |¡}d}tj |¡}|jtj ||¡d}tjtjBtj B}t |ƒ}t |ƒ}d|›} d|›} |j   | |t  |¡¡|j   | |t  |¡¡|j d tj |d¡¡¡} | | ¡| |j¡| d| ¡¡| |j¡| d| ¡¡|j||dgf||dgfgdd d S) zõ When a gobbing expression is used local files are transferred with remote file names based on local names. when a remote folder is requested remote paths are composed from remote path and local filename. rørùz/remote/z {} remoterúrÍröTrûN)rÓr@rorîrürírrêrërìrr‘rrr rƒr“rïÚformatrðr.r‡r3r4ré) r*rýrþrÿrrrprrrrrôr+r+r,Ú"test_cmd_PUTMultipleWithRemotePathÔs8    ÿ     þûz3StdioClientTests.test_cmd_PUTMultipleWithRemotePath)NrÍ)F)r6r7r8r9r-r¤r¨r©r–rÂrÃrÄrÇrÉrËrÌrÓrérõr÷rrr+r+r+r,rŽ†s&       =#rŽc@seZdZdd„Zdd„ZdS)ÚFileTransferTestRealmcCs ||_dSr$)ÚtestDir)r*r r+r+r,rhûszFileTransferTestRealm.__init__cGst|jƒ}|d|dd„fS)NrcSsdSr$r+r+r+r+r,ÚrÍz5FileTransferTestRealm.requestAvatar..)rr )r*ZavatarIDZmindr Úar+r+r,Ú requestAvatarþs z#FileTransferTestRealm.requestAvatarN)r6r7r8rhr r+r+r+r,r úsr c@s`eZdZdZdd„Zdd„Zdd„Zdd „Zd d „Zd d „Z dd„Z dd„Z dd„Z dd„Z dS)ÚSFTPTestProcessz³ Protocol for testing cftp. Provides an interface between Python (where all the tests are) and the cftp client process (which does the work that is being tested). cCs$| ¡||_d|_d|_d|_dS)zr @param onOutReceived: A L{Deferred} to be fired as soon as data is received from stdout. NF)Ú clearBufferÚ onOutReceivedÚ onProcessEndÚ_expectingCommandÚ _processEnded)r*rr+r+r,rh s zSFTPTestProcess.__init__cCsd|_g|_d|_dS)zR Clear any buffered data received from stdout. Should be private. rÍN)ÚbufferÚ_linesReceivedÚ _lineBufferr)r+r+r,rszSFTPTestProcess.clearBuffercCsrt d|¡|j| d¡}| d¡|_|j |¡|jdk rX|jd}|_| |¡|j |7_ |  ¡dS)zO Called by Twisted when the cftp client prints data to stdout. zgot %ró rÖN) rÚmsgrrÚrsrrÝrÚcallbackrÚ_checkForCommand)r*r…Úlinesr£r+r+r,Ú outReceiveds    zSFTPTestProcess.outReceivedcCs^d}|jrZ|j|krZd |j¡}| |¡r:|t|ƒd…}| ¡|jd}|_| |¡dS)Nscftp> r)rrrírÚ startswithràrr)r*ÚpromptÚbufr£r+r+r,r.s  z SFTPTestProcess._checkForCommandcCst d|¡dS)zO Called by Twisted when the cftp client prints data to stderr. zerr: %sN)rr)r*r…r+r+r,Ú errReceived8szSFTPTestProcess.errReceivedcCs|jS)zQ Return the contents of the buffer of data received from stdout. )rr)r+r+r,Ú getBuffer>szSFTPTestProcess.getBuffercCs<t ¡|_| ¡t|tƒr&| d¡}|j |d¡|jS)a¬ Issue the given command via the cftp client. Return a C{Deferred} that fires when the server returns a result. Note that the C{Deferred} will callback even if the server returns some kind of error. @param command: A string containing an sftp command. @return: A C{Deferred} that fires when the sftp server returns a result. The payload is the server's response string. r0r) r ÚDeferredrrÚ isinstanceÚstrr2ryr‚©r*Úcommandr+r+r,Ú runCommandDs   zSFTPTestProcess.runCommandcs(t d¡‰‡‡fdd„|Dƒ}t |¡S)ax Run each command in sequence and return a Deferred that fires when all commands are completed. @param commands: A list of strings containing sftp commands. @return: A C{Deferred} that fires when all commands are completed. The payload is a list of response strings from the server, in the same order as the commands. rucsg|]}ˆ ˆj|¡‘qSr+)Úrunr')Ú.0r&©r*Zsemr+r,Ú bsz-SFTPTestProcess.runScript..)r ZDeferredSemaphoreZ gatherResults)r*ÚcommandsÚdlr+r*r,Ú runScriptVs zSFTPTestProcess.runScriptcCs,|jrt d¡St ¡|_|j d¡|jS)zø Kill the process if it is still running. If the process is still running, sends a KILL signal to the transport and returns a C{Deferred} which fires when L{processEnded} is called. @return: a C{Deferred}. NÚKILL)rr rƒr"rryÚ signalProcessr)r+r+r,Ú killProcesses    zSFTPTestProcess.killProcesscCs(d|_|jr$|jd}|_| d¡dS)zF Called by Twisted when the cftp client process ends. TN)rrr)r*Úreasonr£r+r+r,Ú processEndedtszSFTPTestProcess.processEndedN)r6r7r8r9rhrrrr r!r'r.r1r3r+r+r+r,rs  rc@s4eZdZdd„Zdd„Zdd„Zdd„Zd d „Zd S) ÚCFTPClientTestBasec Cs€tddƒ}| tj¡W5QRXtddƒ}| tj¡W5QRXt dd¡tddƒ}| dtj¡W5QRXt |¡S)Nú rsa_test.pubrÎÚrsa_testi€Úkh_tests 127.0.0.1 ) rÐr‚rZpublicRSA_opensshZprivateRSA_opensshr@Úchmodr r-©r*Úfr+r+r,r-s    zCFTPClientTestBase.setUpcCsFt|jƒ}t |¡}| t ¡¡t ¡}||_tj d|dd|_ dS)Nrz 127.0.0.1)Z interface) r r r ZPortalZregisterCheckerrZconchTestPublicKeyCheckerZConchTestServerFactoryrZ listenTCPÚserver)r*ÚrealmÚpZfacr+r+r,Ú startServer‰s   zCFTPClientTestBase.startServercCsHt|jjdƒs| d¡Sd|jjj_t |jjjjj ¡}|  |j¡|S)NÚprotoru) Úhasattrr;ÚfactoryÚ _cbStopServerr?ÚexpectedLoseConnectionr Ú maybeDeferredryZloseConnectionr¡r¢r+r+r,Ú stopServer‘s    zCFTPClientTestBase.stopServercCst |jj¡Sr$)r rDr;Ú stopListening©r*Úignoredr+r+r,rB™sz CFTPClientTestBase._cbStopServerc Cs8dD](}zt |¡Wqtk r*YqXqt |¡S)N)r5r6r7)r@ÚremoveÚ BaseExceptionr ÚtearDownr9r+r+r,rKœs zCFTPClientTestBase.tearDownN)r6r7r8r-r>rErBrKr+r+r+r,r4~s  r4c@sºeZdZdZdd„Zdd„Zdd„Zdd „Zd d „Zd d „Z dd„Z dd„Z dd„Z d-dd„Z dd„Zdd„Zdd„Zdd„Zdd „Zd!d"„Zd#d$„Zd%d&„Zd'd(„Zd)d*„Zd+d,„ZdS).ÚOurServerCmdLineClientTestszí Functional tests which launch a SFTP server over TCP on localhost and check cftp command line interface using a spawned process. Due to the spawned process you can not add a debugger breakpoint for the client code. c s0t ˆ¡ˆ ¡d}ˆj ¡j}tj|| ¡dd}t   dt j ›d|›¡t  ¡}t|ƒˆ_| ‡fdd„¡tj ¡}tj t j¡|d<g}i}|D]"}t|tƒr´| d ¡}| |¡qœ|D]<}||} t|tƒrä| d ¡}t| tƒrø|  d ¡} | ||<qÄt   |¡t   |¡tjˆjt j ||d |S) Nz‚-p %i -l testuser --known-hosts kh_test --user-authentications publickey --host-key-algorithms ssh-rsa -i rsa_test -a -v 127.0.0.1r©Úmodúrunning rÔcs ˆj ¡Sr$)ÚprocessProtocolr©Ú_r)r+r,r ÂrÍz3OurServerCmdLineClientTests.setUp..Ú PYTHONPATHr0©Úenv)r4r-r>r;ÚgetHostÚportrÚ _makeArgsrÚrrržrŸr r"rrPr¡r@rAÚcopyÚpathsepríror#r$r2rÛrZ spawnProcess) r*ÚcmdsrWr£rUZ encodedCmdsZ encodedEnvÚcmdÚvarÚvalr+r)r,r-¯sD ÿ             ÿz!OurServerCmdLineClientTests.setUpcsˆ ¡}| ‡fdd„¡|S)Ncs ˆj ¡Sr$)rPr1rQr)r+r,r ÛrÍz6OurServerCmdLineClientTests.tearDown..)rEr¡r¢r+r)r,rKÙsz$OurServerCmdLineClientTests.tearDowncCs.z|jj d¡Wntjk r(YnXdS)Nr/)rPryr0r ZProcessExitedAlreadyrGr+r+r,Ú _killProcessÞsz(OurServerCmdLineClientTests._killProcesscCs |j |¡S)z¼ Run the given command with the cftp client. Return a C{Deferred} that fires when the command is complete. Payload is the server's output for that command. )rPr'r%r+r+r,r'äsz&OurServerCmdLineClientTests.runCommandcGs |j |¡S)zÓ Run the given commands with the cftp client. Returns a C{Deferred} that fires when the commands are all complete. The C{Deferred}'s payload is a list of output for each command. )rPr.)r*r,r+r+r,r.ìsz%OurServerCmdLineClientTests.runScriptcCsL|j}| ddddd¡}dd„}| |¡| |j|jt ¡d|jg¡|S)zý Test that 'pwd' reports the current remote directory, that 'lpwd' reports the current local directory, and that changing to a subdirectory then changing to its parent leaves you in the original remote directory. ÚpwdZlpwdzcd testDirectoryúcd ..cSsDg}|D]"}t|tƒr | d¡}| |¡q|dd…|dd…S)zH Callback function for handling command output. r0Néé)r#ÚbytesrÙrÛ)râr[r\r+r+r,Ú cmdOutputÿs    z8OurServerCmdLineClientTests.testCdPwd..cmdOutputr¥)r r.r¡r3ror@Úgetcwd)r*ZhomeDirr£rer+r+r,Ú testCdPwdôs  z%OurServerCmdLineClientTests.testCdPwdcs&‡fdd„}ˆ dddd¡}| |¡S)zŒ Check that 'ls -l' output includes the access permissions and that this output changes appropriately with 'chmod'. csZˆ ¡ˆ |d d¡¡ˆ |dd¡ˆ |d d¡|d¡ˆ |dd¡dS)Nrs -rw-r--r--rurÍrØs ----------rb)ÚflushLoggedErrorsr.rr3©Úresultsr)r+r,Ú_checks z7OurServerCmdLineClientTests.testChAttrs.._checkzls -l testfile1zchmod 0 testfile1zchmod 644 testfile1©r.r¡©r*rkr£r+r)r,Ú testChAttrss üz'OurServerCmdLineClientTests.testChAttrscs@‡fdd„}ˆ ddˆj ¡ddd¡}| dd „¡| |¡S) zŽ Check 'ls' works as expected. Checks for wildcards, hidden files, listing directories and listing empty directories. cspˆ |dddddg¡ˆ |dddddg¡ˆ |dddg¡ˆ |dd ddg¡ˆ |d d g¡dS) Nró testDirectoryótestRemoveFileótestRenameFileó testfile1rurØrbs.testHiddenFilercrÍ©r3rir)r+r,rk*s þ þÿz4OurServerCmdLineClientTests.testList.._checkrzls ../zls *Filez ls -a *Filezls -l testDirectorycSsdd„|DƒS)NcSsg|]}| d¡‘qS)r)rÚ)r)Úxr+r+r,r+@szJOurServerCmdLineClientTests.testList....r+)Úxsr+r+r,r @rÍz6OurServerCmdLineClientTests.testList..)r.r rîr¡rmr+r)r,ÚtestList$s  ûz$OurServerCmdLineClientTests.testListcCsD| d¡}t d¡ d¡ ¡}t|tƒr2| d¡}| |j |¡|S)zB Check that running the '?' command returns help. ú?Nr¥r0) r'rr’Zcmd_HELPrÜr#r$r2r¡r3)r*r£ZhelpTextr+r+r,ÚtestHelpCs    z$OurServerCmdLineClientTests.testHelpNcCs| | ¡| ¡|¡dS)zg Assert that the files at C{name1} and C{name2} contain exactly the same data. N)r3Z getContent)r*Zname1Zname2rr+r+r,ÚassertFilesEqualOsz,OurServerCmdLineClientTests.assertFilesEqualcsld ˆjjˆjj¡‰tˆtƒr(ˆ d¡‰‡‡fdd„}ˆ dˆjj›d¡}| |¡| ‡fdd„¡|S) z³ Test that 'get' saves the remote file to the correct local location, that the output of 'get' is correct and that 'rm' actually removes the file. z)Transferred {}/testfile1 to {}/test file2r0cs8ˆ | ˆ¡¡ˆ ˆj d¡ˆj d¡d¡ˆ d¡S)NÚ testfile1ú test file2z get failedzrm "test file2")r.Úendswithryr Úchildr'©rÁ©rãr*r+r,Ú _checkGetds  ýz6OurServerCmdLineClientTests.testGet.._checkGetzget testfile1 "z /test file2"csˆ ˆj d¡ ¡¡S)Nr{©Z assertFalser r}ÚexistsrQr)r+r,r prÍz5OurServerCmdLineClientTests.testGet..)rr ror#r$r2r'r¡)r*r€r£r+rr,ÚtestGetVsþ     ÿz#OurServerCmdLineClientTests.testGetcs ‡fdd„}ˆ d¡}| |¡S)zQ Test that 'get' works correctly when given wildcard parameters. cs8ˆ ˆj d¡tdƒd¡ˆ ˆj d¡tdƒd¡dS)NÚtestRemoveFileútestRemoveFile get failedÚtestRenameFileútestRenameFile get failed)ryr r}r)rHr)r+r,rkys ý ýz;OurServerCmdLineClientTests.testWildcardGet.._checkz get testR*)r'r¡rmr+r)r,ÚtestWildcardGetts z+OurServerCmdLineClientTests.testWildcardGetcshdˆj ¡jdˆj ¡jd‰‡‡fdd„}ˆ dˆjj›d¡}| |¡| ‡fdd „¡|S) z— Check that 'put' uploads files correctly and that they can be successfully removed. Also check the output of the put command. s Transferred s/testfile1 to s /test"file2cs6ˆ ˆj d¡ˆj d¡¡ˆ | ˆ¡¡ˆ d¡S)Nrzú test"file2zrm "test\"file2")ryr r}r.r|r'r~rr+r,Ú _checkPut–s  ÿz6OurServerCmdLineClientTests.testPut.._checkPutúput z/testfile1 "test\"file2"csˆ ˆj d¡ ¡¡S)Nr‰rrQr)r+r,r  rÍz5OurServerCmdLineClientTests.testPut..)r Ú asBytesModeror'r¡)r*rŠr£r+rr,ÚtestPutˆs" ÿþ ýüÿ  ÿz#OurServerCmdLineClientTests.testPutc s„ˆj d¡jdd}| d¡W5QRXˆj d¡jdd}| d¡W5QRX‡fdd„}ˆ d ˆjj›d ¡}| |¡|S) zb Check that 'put' uploads files correctly when overwriting a longer file. Ú shorterFileÚw©ÚmodeóaÚ longerFileóbbcs ˆ ˆj d¡ˆj d¡¡dS)NrŽr“)ryr r}r~r)r+r,rŠ¯s ÿzEOurServerCmdLineClientTests.test_putOverLongerFile.._checkPutr‹z/shorterFile longerFile)r r}rÐr‚r'ror¡©r*r:rŠr£r+r)r,Útest_putOverLongerFile¤s  z2OurServerCmdLineClientTests.test_putOverLongerFilec s˜ˆj d¡‰ˆ ¡ˆ d¡jdd}| d¡W5QRXˆj d¡jdd}| d¡W5QRX‡‡fdd„}ˆ d ˆjj›d ¡}| |¡|S) z˜ Check that 'put' uploads files correctly when overwriting a longer file and you use a wildcard to specify the files to upload. ÚdirrÒrrr’r”csˆ ˆ d¡ˆj d¡¡dS)NrÒ)ryr}r r~©r*ZsomeDirr+r,rŠÅszMOurServerCmdLineClientTests.test_putMultipleOverLongerFile.._checkPutr‹z/dir/*)r r}ZcreateDirectoryrÐr‚r'ror¡r•r+r˜r,Útest_putMultipleOverLongerFile¸s  z:OurServerCmdLineClientTests.test_putMultipleOverLongerFilecs>‡fdd„}ˆ ddˆjj›ddˆj ¡¡}| |¡|S)zÍ What happens if you issue a 'put' command and include a wildcard (i.e. '*') in parameter? Check that all files matching the wildcard are uploaded to the correct directory. cshˆ |dd¡ˆ |dd¡ˆ ˆj d¡ˆj ¡ d¡d¡ˆ ˆj d¡ˆj ¡ d¡d¡dS)NrrÍrØr„r…r†r‡)r3ryr r}rrir)r+r,ÚcheckÓs ý ýz:OurServerCmdLineClientTests.testWildcardPut..checkrar‹z/testR*zcd %s)r.r rorîr¡)r*ršr£r+r)r,ÚtestWildcardPutÌs  ý z+OurServerCmdLineClientTests.testWildcardPutcs4‡fdd„}ˆ dd¡}| |¡| ˆjd¡|S)z  Test that 'ln' creates a file which appears as a link in the output of 'ls'. Check that removing the new file succeeds without output. cs8ˆ ¡ˆ |dd¡ˆ |d d¡d¡ˆ d¡S)NrrÍruólz link failedz rm testLink)rhr3r.rr'rir)r+r,rkðsz4OurServerCmdLineClientTests.testLink.._checkzln testLink testfile1zls -l testLinkrÍ©r.r¡r3rmr+r)r,ÚtestLinkês    z$OurServerCmdLineClientTests.testLinkcs4‡fdd„}ˆ dd¡}| |¡| ˆjd¡|S)zV Test that we can create and remove directories with the cftp client. cs.ˆ |dd¡ˆ |d d¡¡ˆ d¡S)NrrÍruódzrmdir testMakeDirectory)r3r.rr'rir)r+r,rksz?OurServerCmdLineClientTests.testRemoteDirectory.._checkúmkdir testMakeDirectoryzls -l testMakeDirector?rÍrrmr+r)r,ÚtestRemoteDirectoryûs    z/OurServerCmdLineClientTests.testRemoteDirectorycs&‡fdd„}ˆ dd¡}| |¡|S)z— Test that a C{mkdir} on an existing directory fails with the appropriate error, and doesn't log an useless error server side. cs$ˆ |dd¡ˆ |dd¡dS)NrrÍrusremote error 11: mkdir failedrsrir)r+r,rkszHOurServerCmdLineClientTests.test_existingRemoteDirectory.._checkr rlrmr+r)r,Útest_existingRemoteDirectory s   z8OurServerCmdLineClientTests.test_existingRemoteDirectorycsHˆ dˆjj›d¡}| ˆjd¡| ‡fdd„¡| ˆjd¡|S)z Test that we can create a directory locally and remove it with the cftp client. This test works because the 'remote' server is running out of a local directory. zlmkdir z/testLocalDirectoryrÍcs ˆ d¡S)Nzrmdir testLocalDirectory)r'rQr)r+r,r  rÍz@OurServerCmdLineClientTests.testLocalDirectory..)r'r ror¡r3r¢r+r)r,ÚtestLocalDirectorys z.OurServerCmdLineClientTests.testLocalDirectorycs4‡fdd„}ˆ dd¡}| |¡| ˆjd¡|S)z1 Test that we can rename a file. cs*ˆ |dd¡ˆ |dd¡ˆ d¡S)NrrÍrus testfile2zrename testfile2 testfile1)r3r'rir)r+r,rk)sz6OurServerCmdLineClientTests.testRename.._checkzrename testfile1 testfile2z ls testfile?rÍrrmr+r)r,Ú testRename$s    z&OurServerCmdLineClientTests.testRename)N)r6r7r8r9r-rKr_r'r.rgrnrvrxryrƒrˆrr–r™r›ržr¡r¢r£r¤r+r+r+r,rL¥s,*  rLc@s@eZdZdZdd„Zdd„Zdd„Zdd „Zd d „Zd d „Z dS)ÚOurServerBatchFileTestszm Functional tests which launch a SFTP server over localhost and checks csftp in batch interface. cCst |¡| ¡dSr$©r4r-r>r)r+r+r,r-;s zOurServerBatchFileTests.setUpcCst |¡| ¡Sr$)r4rKrEr)r+r+r,rK?s z OurServerBatchFileTests.tearDownc sÐ| ¡‰tˆdƒ}| |¡W5QRX|j ¡j}d|ˆf}tj| ¡dddd…}t   dt j ›d|›¡t j ¡}t j t j¡|d<d|jj_tt j ||d }‡fd d „}| d d „¡| |¡|S)Nrzˆ-p %i -l testuser --known-hosts kh_test --user-authentications publickey --host-key-algorithms ssh-rsa -i rsa_test -a -v -b %s 127.0.0.1rrMrurOrÔrSrTcst ˆ¡|Sr$)r@rI©Úres©Úfnr+r,Ú_cleanupZs z9OurServerBatchFileTests._getBatchOutput.._cleanupcSs|dS)Nrr+r§r+r+r,r ^rÍz9OurServerBatchFileTests._getBatchOutput..)rÏrÐr‚r;rVrWrrXrÚrrržrŸr@rArYrZrírorArCrr¡ZaddBoth)r*r:ÚfprWr[rUr£r«r+r©r,Ú_getBatchOutputCs"  ø     z'OurServerBatchFileTests._getBatchOutputcs(d}‡fdd„}ˆ |¡}| |¡|S)zš Test whether batch file function of cftp ('cftp -b batchfile'). This works by treating the file as a list of commands to be run. z pwd ls exit csT| d¡}t dt|ƒ¡ˆ ˆj ¡j|d¡ˆ |dd…dddd g¡dS) NrzRES %srurbéþÿÿÿrorprqrr) rÚrrÚreprÚassertInr rŒror3r§r)r+r,Ú_cbCheckResultms   þz=OurServerBatchFileTests.testBatchFile.._cbCheckResult©r­r¡©r*r[r±r£r+r)r,Ú testBatchFilecs   z%OurServerBatchFileTests.testBatchFilecs(d}‡fdd„}ˆ |¡}| |¡|S)zO Test that an error in the batch file stops running the batch. zchown 0 missingFile pwd exit csˆ ˆj ¡j|¡dSr$)Z assertNotInr rŒror§r)r+r,r±ƒsz9OurServerBatchFileTests.testError.._cbCheckResultr²r³r+r)r,Ú testErrorzs    z!OurServerBatchFileTests.testErrorcs(d}‡fdd„}ˆ |¡}| |¡|S)z_ Test that a minus sign '-' at the front of a line ignores any errors. z-chown 0 missingFile pwd exit csˆ ˆj ¡j|¡dSr$)r°r rŒror§r)r+r,r±”sz@OurServerBatchFileTests.testIgnoredError.._cbCheckResultr²r³r+r)r,ÚtestIgnoredErrorŠs    z(OurServerBatchFileTests.testIgnoredErrorN) r6r7r8r9r-rKr­r´rµr¶r+r+r+r,r¥4s r¥Ússhz$no ssh command-line client availableÚsftpz%no sftp command-line client availablec@s(eZdZdZdd„Zdd„Zdd„ZdS) ÚOurServerSftpClientTestsz@ Test the sftp server against sftp command line client. cCst |¡| ¡Sr$r¦r)r+r+r,r-¤s zOurServerSftpClientTests.setUpcCs| ¡Sr$)rEr)r+r+r,rK¨sz!OurServerSftpClientTests.tearDownc s²ttjƒ}ˆ ¡}t|dƒ}| d¡W5QRXˆj ¡j}t j ‰‡fdd„}ˆ  t d|¡dˆjj _ ddd d d d d d d d d d|fd|df}‡fdd„}td||ƒ}| |¡S)a Test the return of extended attributes by the server: the sftp client should ignore them, but still be able to parse the response correctly. This test is mainly here to check that L{filetransfer.FILEXFER_ATTR_EXTENDED} has the correct value. rz ls . exitcsˆ||ƒ}d|d<|S)Nr™Zext_foor+)r*Úsr})Ú oldGetAttrr+r,Ú _getAttrs¾s zCOurServerSftpClientTests.test_extendedAttributes.._getAttrsr¼Tz-Fz /dev/nullz-ozIdentitiesOnly=yeszIdentityFile=rsa_testzUserKnownHostsFile=kh_testzHostKeyAlgorithms=ssh-rsazPort=%iz-bztestuser@127.0.0.1cs:ˆ |dd|d d¡¡dD]}ˆ ||d¡q dS)NrØrruÚascii)rorprqrr)r3rÙr°)rÁÚir)r+r,ršÛsz?OurServerSftpClientTests.test_extendedAttributes..checkr¸)Údictr@rArÏrÐr‚r;rVrWr!r¼rDrArCrr¡) r*rUrªr:rWr¼Úargsršr£r+)r»r*r,Útest_extendedAttributes«s8     ñ z0OurServerSftpClientTests.test_extendedAttributesN)r6r7r8r9r-rKrÁr+r+r+r,r¹œsr¹)Qr9r›r[rFr@r«ržr>ÚiorrZunittestrZzope.interfacerZ twisted.conchrZtwisted.conch.interfacesrZ$twisted.conch.test.test_filetransferrr Z twisted.credr Ztwisted.internetr r r rrZtwisted.internet.taskrZtwisted.internet.testingrZtwisted.internet.utilsrZtwisted.pythonrZtwisted.python.fakepwdrZtwisted.python.filepathrZtwisted.python.procutilsrZtwisted.python.reflectrZtwisted.trial.unittestrrÚunixZtwisted.conch.scriptsrZtwisted.conch.scripts.cftprZtwisted.conch.sshrZtwisted.conch.ssh.connectionrZtwisted.conch.testrrZtwisted.conch.test.test_conchr r!Ú ImportErrorZ skipTestsZIReactorProcessr"r:rerlrtrrŽr ZProcessProtocolrr4rLr¥r¹r+r+r+r,Ús†                   '#&2u {'g