Writing to files (cy.writeFile) in Cypress - Framework Patterns

Framework Mode - Writing to files (cy.writeFile)

Folder Structure

cypress/
├── e2e/                  # Test specs
│   └── writeFile.spec.js # Tests using cy.writeFile
├── fixtures/             # Test data files
│   └── example.json
├── support/              # Custom commands and utilities
│   ├── commands.js       # Custom Cypress commands
│   └── index.js          # Support file loaded before tests
cypress.config.js         # Cypress configuration file

Test Framework Layers

• Test Specs (cypress/e2e): Contains test files that use cy.writeFile to write data to files during tests.
• Fixtures (cypress/fixtures): Stores static test data files that tests can read or write to.
• Support (cypress/support): Contains reusable commands and utilities. You can add custom commands to wrap cy.writeFile for reuse.
• Configuration (cypress.config.js): Defines environment variables, base URLs, and file paths used in tests.

Configuration Patterns

• Environment Variables: Use env in cypress.config.js to store file paths or data to write, e.g., env: { outputFile: 'cypress/fixtures/output.json' }.
• Dynamic File Paths: Use environment variables in tests to write files to different locations based on environment (dev, staging, prod).
• Credentials & Sensitive Data: Avoid writing sensitive data to files unless encrypted or in secure folders.
• Example cypress.config.js snippet:

  import { defineConfig } from 'cypress'
  
  export default defineConfig({
    e2e: {
      env: {
        outputFile: 'cypress/fixtures/output.json'
      },
      baseUrl: 'https://example.com'
    }
  })
  

Test Reporting and CI/CD Integration

• Test Reports: Use Cypress reporters (like Mochawesome) to generate readable test reports after running tests that write files.
• File Output Verification: Include assertions in tests to verify that cy.writeFile successfully created or updated files.
• CI/CD: Configure CI pipelines (GitHub Actions, Jenkins) to run Cypress tests and archive output files as artifacts for review.
• Cleanup: Optionally add cleanup steps in CI to remove or archive files created by cy.writeFile to keep workspace clean.

Best Practices

• Use Absolute or Configured Paths: Avoid hardcoding file paths in tests; use config or env variables for flexibility.
• Validate File Writes: Always assert the file content after writing to ensure data integrity.
• Keep Tests Idempotent: Clean or overwrite files before writing to avoid flaky tests.
• Use Fixtures for Test Data: Write to fixtures folder when generating test data files to keep project organized.
• Secure Sensitive Data: Do not write passwords or secrets to files unless encrypted or masked.

Self Check

Where in this folder structure would you add a new utility function to simplify writing JSON data to files using cy.writeFile?

Key Result

Organize Cypress tests with clear folder layers, use config for file paths, validate writes, and integrate reporting for reliable file writing tests.

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