# FileSystem
Extends Helper
Helper for testing filesystem. Can be easily used to check file structures:
I.amInPath('test');
I.seeFile('codecept.js');
I.seeInThisFile('FileSystem');
I.dontSeeInThisFile("WebDriver");
# Configuration
Enable helper in config file:
helpers: {
FileSystem: {},
}
# Methods
# amInPath
Enters a directory In local filesystem. Starts from a current directory
# Parameters
openPath
string (opens new window)
# dontSeeFileContentsEqual
Checks that contents of file found by seeFile
doesn't equal to text.
# Parameters
text
string (opens new window)encoding
string (opens new window)
# dontSeeInThisFile
Checks that file found by seeFile
doesn't include text.
# Parameters
text
string (opens new window)encoding
string (opens new window)
# grabFileNames
Returns file names in current directory.
I.handleDownloads();
I.click('Download Files');
I.amInPath('output/downloads');
const downloadedFileNames = I.grabFileNames();
# seeFile
Checks that file exists
# Parameters
# seeFileContentsEqual
Checks that contents of file found by seeFile
equal to text.
# Parameters
text
string (opens new window)encoding
string (opens new window)
# seeFileContentsEqualReferenceFile
Checks that contents of the file found by seeFile
equal to contents of the file at pathToReferenceFile
.
# Parameters
pathToReferenceFile
string (opens new window)encoding
string (opens new window)encodingReference
string (opens new window)
# seeFileNameMatching
Checks that file with a name including given text exists in the current directory.
I.handleDownloads();
I.click('Download as PDF');
I.amInPath('output/downloads');
I.seeFileNameMatching('.pdf');
# Parameters
# seeInThisFile
Checks that file found by seeFile
includes a text.
# Parameters
text
string (opens new window)encoding
string (opens new window)
# waitForFile
Waits for the file to be present in the current directory.
I.handleDownloads('downloads/largeFilesName.txt');
I.click('Download large File');
I.amInPath('output/downloads');
I.waitForFile('largeFilesName.txt', 10); // wait 10 seconds for file
# Parameters
name
string (opens new window)sec
number (opens new window) seconds to wait
# writeToFile
Writes text to file