Drag and drop file upload in Cypress - Framework Patterns

Framework Mode - Drag and drop file upload

Folder Structure

  cypress/
  ├── e2e/
  │   ├── dragDropUpload.spec.js       # Test files for drag and drop upload
  │   └── otherFeature.spec.js
  ├── fixtures/
  │   └── sampleFile.png               # Sample files for upload tests
  ├── support/
  │   ├── commands.js                  # Custom commands (e.g., drag and drop upload)
  │   ├── e2e.js                      # Global support file
  │   └── selectors.js                 # Locators for page elements
  └── cypress.config.js                # Cypress configuration file
  

Test Framework Layers

• Test Layer: Contains test scripts in cypress/e2e/ that use drag and drop upload commands.
• Page Objects / Selectors: Defined in cypress/support/selectors.js to keep locators organized and reusable.
• Custom Commands: In cypress/support/commands.js, implement reusable drag and drop file upload commands to simulate user actions.
• Fixtures: Store sample files in cypress/fixtures/ to use for upload testing.
• Configuration: cypress.config.js manages environment settings, base URL, and test options.

Configuration Patterns

• Environment Variables: Use cypress.env.json or cypress.config.js to set different URLs or credentials for dev, staging, and production.
• Browser Selection: Configure browsers in cypress.config.js or via CLI flags to test drag and drop across Chrome, Firefox, etc.
• File Paths: Use relative paths to cypress/fixtures/ for test files to keep tests portable and maintainable.
• Timeouts and Retries: Adjust in config to handle slow drag and drop UI responses.

Test Reporting and CI/CD Integration

• Use built-in Cypress Dashboard or plugins like mochawesome for detailed HTML reports showing pass/fail of drag and drop upload tests.
• Integrate Cypress tests into CI pipelines (GitHub Actions, Jenkins, GitLab CI) to run drag and drop upload tests on every commit or pull request.
• Configure screenshots and video recording on test failures to help debug drag and drop issues.
• Use tags or test grouping to run only drag and drop upload tests when needed.

Best Practices

• Use Custom Commands: Encapsulate drag and drop file upload logic in commands.js for reuse and clarity.
• Keep Locators Simple and Stable: Use data attributes (e.g., data-cy) for drag and drop targets to avoid brittle selectors.
• Use Fixtures for Test Files: Store upload files in fixtures to keep tests consistent and easy to update.
• Explicit Assertions: After upload, assert visible UI changes or API responses to confirm success.
• Handle Asynchronous UI: Use Cypress commands like should and wait to handle drag and drop delays reliably.

Self Check

Where would you add a new custom command to simulate drag and drop file upload in this Cypress framework structure?

Key Result

Organize Cypress drag and drop file upload tests with clear folder structure, custom commands, fixtures, and robust configuration.

Practice

1. What is the main purpose of using subjectType: 'drag-n-drop' in Cypress file upload tests?

easy

A. To simulate dragging and dropping a file into an upload area

B. To select a file from the file system dialog

C. To upload files using a URL link

D. To test keyboard navigation on file inputs

Solution

1. Step 1: Understand the drag-n-drop simulation

   The subjectType: 'drag-n-drop' option in Cypress simulates the user dragging a file and dropping it into a target area, mimicking real user behavior.

2. Step 2: Differentiate from other upload methods

   This differs from selecting a file via a dialog or uploading by URL, which are not drag-and-drop actions.

3. Final Answer:

   To simulate dragging and dropping a file into an upload area -> Option A

4. Quick Check:

   Drag-n-drop simulation = To simulate dragging and dropping a file into an upload area [OK]

Hint: Drag-n-drop means simulating file drag into upload box [OK]

Common Mistakes:

• Confusing drag-n-drop with file dialog selection
• Thinking it uploads files from URLs
• Assuming it tests keyboard navigation

2. Which of the following is the correct Cypress command syntax to drag and drop a file named example.png into an element with selector #dropzone?

easy

A. cy.get('#dropzone').attachFile('example.png', { subjectType: 'drag-n-drop' })

B. cy.get('#dropzone').uploadFile('example.png', { dragDrop: true })

C. cy.get('#dropzone').dragFile('example.png')

D. cy.get('#dropzone').attachFile('example.png')

Solution

1. Step 1: Identify the correct command and options

   The Cypress plugin for file upload uses attachFile with the option { subjectType: 'drag-n-drop' } to simulate drag and drop.

2. Step 2: Verify selector and file name usage

   The command targets #dropzone and attaches example.png correctly with the required option.

3. Final Answer:

   cy.get('#dropzone').attachFile('example.png', { subjectType: 'drag-n-drop' }) -> Option A

4. Quick Check:

   attachFile + subjectType drag-n-drop = cy.get('#dropzone').attachFile('example.png', { subjectType: 'drag-n-drop' }) [OK]

Hint: Use attachFile with subjectType 'drag-n-drop' for drag-drop [OK]

Common Mistakes:

• Using non-existent commands like uploadFile or dragFile
• Omitting the subjectType option
• Using attachFile without drag-n-drop option

3. Given the following Cypress test code snippet, what will be the result if the file testfile.pdf is successfully dropped?

cy.get('#upload-area').attachFile('testfile.pdf', { subjectType: 'drag-n-drop' })
cy.get('#upload-message').should('contain.text', 'Upload successful')

medium

A. The test fails because the selector #upload-message is incorrect

B. The test fails because attachFile does not support drag-n-drop

C. The test passes only if the file is smaller than 1MB

D. The test passes if the upload message contains 'Upload successful'

Solution

1. Step 1: Understand the attachFile usage

   The code uses attachFile with subjectType: 'drag-n-drop' correctly to simulate dropping testfile.pdf.

2. Step 2: Check the assertion on upload message

   The test asserts that the element with #upload-message contains the text 'Upload successful', which indicates a successful upload.

3. Final Answer:

   The test passes if the upload message contains 'Upload successful' -> Option D

4. Quick Check:

   Correct attachFile + assertion = The test passes if the upload message contains 'Upload successful' [OK]

Hint: Check assertion text after attachFile drag-n-drop [OK]

Common Mistakes:

• Assuming attachFile doesn't support drag-n-drop
• Ignoring the assertion on upload message
• Confusing selector correctness without context

4. You wrote this Cypress test to drag and drop a file but it fails with an error: attachFile is not a function. What is the most likely cause?

cy.get('#dropzone').attachFile('file.txt', { subjectType: 'drag-n-drop' })

medium

A. The selector '#dropzone' is incorrect

B. The Cypress file upload plugin is not installed or imported

C. The file 'file.txt' does not exist in the fixtures folder

D. The subjectType option is misspelled

Solution

1. Step 1: Analyze the error message

   The error attachFile is not a function means Cypress does not recognize the attachFile command.

2. Step 2: Identify missing plugin or import

   This usually happens if the Cypress file upload plugin is not installed or the command is not imported in commands.js.

3. Final Answer:

   The Cypress file upload plugin is not installed or imported -> Option B

4. Quick Check:

   attachFile error = missing plugin/import [OK]

Hint: attachFile error means missing plugin or import [OK]

Common Mistakes:

• Blaming selector without checking plugin
• Assuming file missing causes attachFile error
• Ignoring plugin installation step

5. You want to test drag and drop file upload for multiple files at once using Cypress. Which approach correctly simulates dropping two files named img1.png and img2.png into the element .upload-area?

hard

A. cy.get('.upload-area').attachFile('img1.png').attachFile('img2.png', { subjectType: 'drag-n-drop' })

B. cy.get('.upload-area').attachFile('img1.png,img2.png', { subjectType: 'drag-n-drop' })

C. cy.get('.upload-area').attachFile(['img1.png', 'img2.png'], { subjectType: 'drag-n-drop' })

D. cy.get('.upload-area').attachFile(['img1.png', 'img2.png'])

Solution

1. Step 1: Understand multiple file upload syntax

   The Cypress attachFile command accepts an array of file names to upload multiple files at once.

2. Step 2: Include drag-n-drop option for simulation

   To simulate drag and drop, the option { subjectType: 'drag-n-drop' } must be included.

3. Step 3: Verify correct usage of array and options

   cy.get('.upload-area').attachFile(['img1.png', 'img2.png'], { subjectType: 'drag-n-drop' }) correctly passes an array of files and the drag-n-drop option together.

4. Final Answer:

   cy.get('.upload-area').attachFile(['img1.png', 'img2.png'], { subjectType: 'drag-n-drop' }) -> Option C

5. Quick Check:

   Multiple files + drag-n-drop = cy.get('.upload-area').attachFile(['img1.png', 'img2.png'], { subjectType: 'drag-n-drop' }) [OK]

Hint: Use array of files with drag-n-drop option for multiple uploads [OK]

Common Mistakes:

• Passing files as comma-separated string instead of array
• Calling attachFile twice instead of once with array
• Omitting drag-n-drop option for simulation