Writing to files (cy.writeFile) in Cypress - Cheat Sheet & Quick Revision

Recall & Review

beginner

What does cy.writeFile() do in Cypress?

cy.writeFile() writes data to a file on your computer during a test. It helps save information like test results or configurations.

beginner

How do you write a simple string to a file using cy.writeFile()?

Use cy.writeFile('path/to/file.txt', 'Hello World') to write the text 'Hello World' into the file.

intermediate

Can cy.writeFile() overwrite existing files or append to them?

By default, cy.writeFile() overwrites the file. To append, you must use the { flag: 'a' } option.

beginner

What types of data can you write with cy.writeFile()?

You can write strings, JSON objects, or arrays. Cypress will convert JSON objects to string format automatically.

beginner

Why is writing files useful in automated tests?

Writing files helps save test data, logs, or snapshots. It allows sharing info between tests or debugging test failures.

What is the default behavior of cy.writeFile() when writing to an existing file?

A It appends data to the file

B It overwrites the file

C It throws an error

D It creates a backup before writing

By default, cy.writeFile() overwrites the existing file content.

Which option allows cy.writeFile() to append data instead of overwriting?

A { mode: 'append' }

B { flag: 'w' }

C { append: true }

D { flag: 'a' }

The { flag: 'a' } option tells Cypress to append data to the file.

Which data type can cy.writeFile() NOT write directly?

A DOM element

B JSON object

C Array

D String

cy.writeFile() cannot write DOM elements directly; it writes strings or JSON serializable data.

What is a common use of cy.writeFile() in testing?

A To read user input

B To execute JavaScript code

C To save test logs or data

D To style the webpage

Writing files is useful to save logs or test data for later review.

How do you write a JSON object to a file with cy.writeFile()?

A Pass the object directly; Cypress converts it automatically

B Use <code>cy.readFile()</code> instead

C Use <code>JSON.parse()</code> before writing

D Convert it to string manually before writing

Cypress automatically converts JSON objects to string format when writing files.

Explain how to use cy.writeFile() to save test data and how to append data instead of overwriting.

Think about file path, data, and options parameters.

Describe why writing files during tests can help with debugging and test data management.

Consider real-life situations where you want to keep records.

Practice

1. What is the main purpose of cy.writeFile() in Cypress testing?

easy

A. To delete a file after a test

B. To read data from a file during a test

C. To save data to a file during a test

D. To open a file in the browser

Solution

1. Step 1: Understand the function's role

   cy.writeFile() is used to save or write data into a file during Cypress tests.

2. Step 2: Differentiate from similar functions

   cy.readFile() reads data, but cy.writeFile() writes data. Deleting or opening files is not its purpose.

3. Final Answer:

   To save data to a file during a test -> Option C

4. Quick Check:

   Write data = A [OK]

Hint: Remember: writeFile writes, readFile reads [OK]

Common Mistakes:

• Confusing writeFile with readFile
• Thinking it deletes files
• Assuming it opens files in browser

2. Which of the following is the correct syntax to write the string 'Hello World' to a file named 'greeting.txt' using cy.writeFile()?

easy

A. cy.writeFile('greeting.txt', {text: 'Hello World'})

B. cy.writeFile('greeting.txt', 'Hello World')

C. cy.writeFile('greeting.txt' => 'Hello World')

D. cy.writeFile('greeting.txt', ['Hello World'])

Solution

1. Step 1: Identify correct parameter usage

   cy.writeFile() takes the file path as first argument and the content as second argument, which can be a string.

2. Step 2: Check syntax correctness

   cy.writeFile('greeting.txt', 'Hello World') uses correct syntax: file path string and content string separated by a comma.

3. Final Answer:

   cy.writeFile('greeting.txt', 'Hello World') -> Option B

4. Quick Check:

   Correct syntax uses comma between path and content [OK]

Hint: Use comma between file path and content [OK]

Common Mistakes:

• Using arrow (=>) instead of comma
• Passing content inside an object unnecessarily
• Passing content as an array instead of string

3. Consider the following Cypress code snippet:

cy.writeFile('data.json', { name: 'Alice', age: 30 })
cy.readFile('data.json').then((content) => {
  console.log(content.age)
})

What will be printed in the console?

medium

A. undefined

B. Alice

C. { name: 'Alice', age: 30 }

D. 30

Solution

1. Step 1: Understand what is written to the file

   The object { name: 'Alice', age: 30 } is saved to 'data.json'.

2. Step 2: Understand what is logged

   The code reads the file and logs content.age, which is 30.

3. Final Answer:

   30 -> Option D

4. Quick Check:

   Accessing content.age logs 30 [OK]

Hint: Read file content and access property to get value [OK]

Common Mistakes:

• Expecting the whole object to print
• Confusing name and age values
• Assuming undefined because of async

4. You wrote this code to save JSON data:

cy.writeFile('user.json', '{"name": "Bob", "age": 25}')

But when you read the file, you get a string instead of an object. What is the problem?

medium

A. The JSON data is passed as a string, not as an object

B. The file path is incorrect

C. cy.writeFile cannot write JSON data

D. The file extension must be .txt

Solution

1. Step 1: Analyze the data argument

   The data is passed as a JSON string, not as a JavaScript object.

2. Step 2: Understand how cy.writeFile handles data

   If you pass a string, it writes it as a string. To write JSON, pass an object directly.

3. Final Answer:

   The JSON data is passed as a string, not as an object -> Option A

4. Quick Check:

   Pass object, not string, to write JSON [OK]

Hint: Pass object, not JSON string, to write JSON files [OK]

Common Mistakes:

• Passing JSON as string instead of object
• Blaming file path without checking data
• Thinking file extension affects JSON writing

5. You want to append a new line 'Test passed' to an existing file 'results.txt' using cy.writeFile(). Which code snippet correctly appends the text without overwriting the file?

hard

A. cy.writeFile('results.txt', 'Test passed', { flag: 'a+' })

B. cy.writeFile('results.txt', 'Test passed')

C. cy.writeFile('results.txt', 'Test passed', { overwrite: false })

D. cy.writeFile('results.txt', 'Test passed', { append: true })

Solution

1. Step 1: Understand file writing flags

   To append text, the file must be opened with append flag, which is 'a+' in Node.js.

2. Step 2: Check Cypress options for cy.writeFile

   Cypress supports passing { flag: 'a+' } to append instead of overwrite.

3. Final Answer:

   cy.writeFile('results.txt', 'Test passed', { flag: 'a+' }) -> Option A

4. Quick Check:

   Use flag 'a+' to append text [OK]

Hint: Use { flag: 'a+' } option to append text [OK]

Common Mistakes:

• Omitting flag option causes overwrite
• Using non-existent options like append: true
• Assuming overwrite: false appends text