layout	doc
title	Filesystem Module - Codeception - Documentation

For additional reference, please review the source

Module for testing local filesystem. Fork it to extend the module for FTP, Amazon S3, others.

• Maintainer: davert
• Stability: stable
• Contact: codecept@davert.mail.ua

Module was developed to test Codeception itself.

Enters a directory In local filesystem. Project root directory is used by default

• param $path

Erases directory contents

{% highlight php %}

cleanDir('logs'); ?>

{% endhighlight %}

• param $dirname

Copies directory with all contents

{% highlight php %}

copyDir('vendor','old_vendor'); ?>

{% endhighlight %}

• param $src
• param $dst

Deletes directory with all subdirectories

{% highlight php %}

deleteDir('vendor'); ?>

{% endhighlight %}

• param $dirname

Deletes a file

{% highlight php %}

deleteFile('composer.lock'); ?>

{% endhighlight %}

• param $filename

Deletes a file

Checks if file does not exists in path

• param $filename
• param string $path

Checks If opened file doesn't contain text in it

{% highlight php %}

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

{% endhighlight %}

• param $text

Opens a file and stores it's content.

Usage:

{% highlight php %}

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

{% endhighlight %}

• param $filename

Checks the strict matching of file contents. Unlike seeInThisFile will fail if file has something more then 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

Checks if file exists in path. Opens a file when it's exists

{% highlight php %}

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

{% endhighlight %}

• param $filename
• param string $path

Checks If opened file has text in it.

Usage:

{% highlight php %}

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

{% endhighlight %}

• param $text

Saves contents to file

• param $filename
• param $contents