FileSystem.md

permalink	editLink	sidebar	title
/helpers/FileSystem	false	auto	FileSystem

FileSystem

Extends Helper

Helper for testing filesystem. Can be easily used to check file structures:

I.amInPath('test');
I.seeFile('codecept.json');
I.seeInThisFile('FileSystem');
I.dontSeeInThisFile("WebDriverIO");

Methods

amInPath

Enters a directory In local filesystem. Starts from a current directory

Parameters

• openPath string

dontSeeFileContentsEqual

Checks that contents of file found by seeFile doesn't equal to text.

Parameters

• text string
• encoding string

dontSeeInThisFile

Checks that file found by seeFile doesn't include text.

Parameters

• text string
• encoding string

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

• name string

seeFileContentsEqual

Checks that contents of file found by seeFile equal to text.

Parameters

• text string
• encoding string

seeFileContentsEqualReferenceFile

Checks that contents of the file found by seeFile equal to contents of the file at pathToReferenceFile.

Parameters

• pathToReferenceFile string
• encoding string
• encodingReference string

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

• text

seeInThisFile

Checks that file found by seeFile includes a text.

Parameters

• text string
• encoding string

waitForFile

Waits for file to be present in current directory.

I.handleDownloads();
I.click('Download large File');
I.amInPath('output/downloads');
I.waitForFile('largeFilesName.txt', 10); // wait 10 seconds for file

Parameters

• name string
• sec number seconds to wait

writeToFile

Writes test to file

Parameters

• name string
• text string

getFileContents

Parameters

• file string
• encoding string

Returns string

isFileExists

Parameters

• file string
• timeout number

Returns Promise<any>