---
layout: doc
title: Filesystem - Codeception - Documentation
---
# Filesystem
Module for testing local filesystem.
Fork it to extend the module for FTP, Amazon S3, others.
### Status
* Maintainer: **davert**
* Stability: **stable**
* Contact: codecept@davert.mail.ua
Module was developed to test Codeception itself.
### Actions
#### amInPath
Enters a directory In local filesystem.
Project root directory is used by default
* `param string` $path
#### cleanDir
Erases directory contents
{% highlight php %}
cleanDir('logs');
?>
{% endhighlight %}
* `param string` $dirname
#### copyDir
Copies directory with all contents
{% highlight php %}
copyDir('vendor','old_vendor');
?>
{% endhighlight %}
* `param string` $src
* `param string` $dst
#### deleteDir
Deletes directory with all subdirectories
{% highlight php %}
deleteDir('vendor');
?>
{% endhighlight %}
* `param string` $dirname
#### deleteFile
Deletes a file
{% highlight php %}
deleteFile('composer.lock');
?>
{% endhighlight %}
* `param string` $filename
#### deleteThisFile
Deletes a file
#### dontSeeFileFound
Checks if file does not exist in path
* `param string` $filename
* `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 string` $text
#### openFile
Opens a file and stores it's content.
Usage:
{% highlight php %}
openFile('composer.json');
$I->seeInThisFile('codeception/codeception');
?>
{% endhighlight %}
* `param string` $filename
#### 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 string` $text
#### seeFileFound
Checks if file exists in path.
Opens a file when it's exists
{% highlight php %}
seeFileFound('UserModel.php','app/models');
?>
{% endhighlight %}
* `param string` $filename
* `param string` $path
#### seeInThisFile
Checks If opened file has `text` in it.
Usage:
{% highlight php %}
openFile('composer.json');
$I->seeInThisFile('codeception/codeception');
?>
{% endhighlight %}
* `param string` $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
#### seeThisFileMatches
Checks that contents of currently opened file matches $regex
* `param string` $regex
#### writeToFile
Saves contents to file
* `param string` $filename
* `param string` $contents