Skip to content

FTP.md

Latest commit

 

History

History
471 lines (282 loc) · 8.74 KB

FTP.md

File metadata and controls

471 lines (282 loc) · 8.74 KB
layout title
doc
FTP - Codeception - Documentation

Works with SFTP/FTP servers.

In order to test the contents of a specific file stored on any remote FTP/SFTP system this module downloads a temporary file to the local system. The temporary directory is defined by default as {% highlight yaml %} tests/_data {% endhighlight %} to specify a different directory set the tmp config option to your chosen path.

Don't forget to create the folder and ensure its writable.

Supported and tested FTP types are:

  • FTP
  • SFTP

Connection uses php build in FTP client for FTP, connection to SFTP uses phpseclib pulled in using composer.

For SFTP, add phpseclib to require list. {% highlight yaml %} "require": { "phpseclib/phpseclib": "0.3.6" }

{% endhighlight %}

Status

Config

  • type: ftp - type of connection ftp/sftp (defaults to ftp).
  • host required - hostname/ip address of the ftp server.
  • port: 21 - port number for the ftp server
  • timeout: 90 - timeout settings for connecting the ftp server.
  • user: anonymous - user to access ftp server, defaults to anonymous authentication.
  • password - password, defaults to empty for anonymous.
  • key - path to RSA key for sftp.
  • tmp - path to local directory for storing tmp files.
  • passive: true - Turns on or off passive mode (FTP only)
  • cleanup: true - remove tmp files from local directory on completion.

Example

Example (FTP)
modules:
   enabled: [FTP]
   config:
      FTP:
         type: ftp
         host: '127.0.0.1'
         port: 21
         timeout: 120
         user: 'root'
         password: 'root'
         key: ~/.ssh/id_rsa
         tmp: 'tests/_data/ftp'
         passive: true
         cleanup: false
Example (SFTP)
modules:
   enabled: [FTP]
   config:
      FTP:
         type: sftp
         host: '127.0.0.1'
         port: 22
         timeout: 120
         user: 'root'
         password: 'root'
         key: ''
         tmp: 'tests/_data/ftp'
         cleanup: false

This module extends the Filesystem module, file contents methods are inherited from this module.

amInPath

Enters a directory on the ftp system - FTP root directory is used by default

  • param $path

cleanDir

Erases directory contents on the FTP/SFTP server

{% highlight php %}

cleanDir('logs'); ?>

{% endhighlight %}

  • param $dirname

copyDir

Currently not supported in this module, overwrite inherited method

  • param $src
  • param $dst

deleteDir

Deletes directory with all subdirectories on the remote FTP/SFTP server

{% highlight php %}

deleteDir('vendor'); ?>

{% endhighlight %}

  • param $dirname

deleteFile

Deletes a file on the remote FTP/SFTP system

{% highlight php %}

deleteFile('composer.lock'); ?>

{% endhighlight %}

  • param $filename

deleteThisFile

Deletes a file

dontSeeFileFound

Checks if file does not exist in path on the remote FTP/SFTP system

  • param $filename
  • param string $path

dontSeeFileFoundMatches

Checks if file does not exist in path on the remote FTP/SFTP system, using regular expression as filename. DOES NOT OPEN the file when it's exists

  • param $regex
  • param string $path

dontSeeInThisFile

Checks If opened file doesn't contain text in it

{% highlight php %}

openFile('composer.json'); $I->dontSeeInThisFile('codeception/codeception'); ?>

{% endhighlight %}

  • param $text

grabDirectory

Grabber method to return current working directory

{% highlight php %}

grabDirectory(); ?>

{% endhighlight %}

  • return string

grabFileCount

Grabber method for returning file/folders count in directory

{% highlight php %}

grabFileCount(); $count = $I->grabFileCount('TEST', false); // Include . .. .thumbs.db ?>

{% endhighlight %}

  • param string $path
  • param bool $ignore - suppress '.', '..' and '.thumbs.db'
  • return int

grabFileList

Grabber method for returning file/folders listing in an array

{% highlight php %}

grabFileList(); $count = $I->grabFileList('TEST', false); // Include . .. .thumbs.db ?>

{% endhighlight %}

  • param string $path
  • param bool $ignore - suppress '.', '..' and '.thumbs.db'
  • return array

grabFileModified

Grabber method to return last modified timestamp

{% highlight php %}

grabFileModified('test.txt'); ?>

{% endhighlight %}

  • param $filename
  • return bool

grabFileSize

Grabber method to return file size

{% highlight php %}

grabFileSize('test.txt'); ?>

{% endhighlight %}

  • param $filename
  • return bool

loginAs

Change the logged in user mid-way through your test, this closes the current connection to the server and initialises and new connection.

On initiation of this modules you are automatically logged into the server using the specified config options or defaulted to anonymous user if not provided.

{% highlight php %}

loginAs('user','password'); ?>

{% endhighlight %}

  • param String $user
  • param String $password

makeDir

Create a directory on the server

{% highlight php %}

makeDir('vendor'); ?>

{% endhighlight %}

  • param $dirname

openFile

Opens a file (downloads from the remote FTP/SFTP system to a tmp directory for processing) and stores it's content.

Usage:

{% highlight php %}

openFile('composer.json'); $I->seeInThisFile('codeception/codeception'); ?>

{% endhighlight %}

  • param $filename

renameDir

Rename/Move directory on the FTP/SFTP server

{% highlight php %}

renameDir('vendor', 'vendor_old'); ?>

{% endhighlight %}

  • param $dirname
  • param $rename

renameFile

Rename/Move file on the FTP/SFTP server

{% highlight php %}

renameFile('composer.lock', 'composer_old.lock'); ?>

{% endhighlight %}

  • param $filename
  • param $rename

seeFileContentsEqual

Checks the strict matching of file contents. Unlike seeInThisFile will fail if file has something more than expected lines. Better to use with HEREDOC strings. Matching is done after removing "\r" chars from file content.

{% highlight php %}

openFile('process.pid'); $I->seeFileContentsEqual('3192'); ?>

{% endhighlight %}

  • param $text

seeFileFound

Checks if file exists in path on the remote FTP/SFTP system. DOES NOT OPEN the file when it's exists

{% highlight php %}

seeFileFound('UserModel.php','app/models'); ?>

{% endhighlight %}

  • param $filename
  • param string $path

seeFileFoundMatches

Checks if file exists in path on the remote FTP/SFTP system, using regular expression as filename. DOES NOT OPEN the file when it's exists

{% highlight php %}

seeFileFoundMatches('/^UserModel_([0-9]{6}).php$/','app/models'); ?>

{% endhighlight %}

  • param $regex
  • param string $path

seeInThisFile

Checks If opened file has text in it.

Usage:

{% highlight php %}

openFile('composer.json'); $I->seeInThisFile('codeception/codeception'); ?>

{% endhighlight %}

  • param $text

seeNumberNewLines

Checks If opened file has the number of new lines.

Usage:

{% highlight php %}

openFile('composer.json'); $I->seeNumberNewLines(5); ?>

{% endhighlight %}

  • param int $number New lines

writeToFile

Saves contents to tmp file and uploads the FTP/SFTP system. Overwrites current file on server if exists.

{% highlight php %}

writeToFile('composer.json', 'some data here'); ?>

{% endhighlight %}

  • param $filename
  • param $contents

 

Module reference is taken from the source code. Help us to improve documentation. Edit module reference