File download handling in Selenium Python - Framework Patterns

Framework Mode - File download handling

Folder Structure

project-root/
├── src/
│   ├── pages/
│   │   └── download_page.py
│   ├── tests/
│   │   └── test_file_download.py
│   ├── utils/
│   │   └── file_helpers.py
│   └── config/
│       └── config.py
├── downloads/  # Folder where files are saved during tests
├── requirements.txt
└── pytest.ini

Test Framework Layers

• Driver Layer: Selenium WebDriver setup with custom options to handle file downloads automatically (e.g., setting download directory, disabling download prompts).
• Page Objects: Classes representing pages with methods to trigger file downloads and verify UI elements.
• Tests: Test cases that use page objects to perform download actions and validate downloaded files.
• Utilities: Helper functions for file system operations like checking if a file exists, waiting for download completion, and cleaning up files.
• Configuration: Settings for download folder path, browser preferences, and environment variables.

Configuration Patterns

• Download Directory: Define a fixed folder (e.g., downloads/) in config.py to store downloaded files during tests.
• Browser Options: Use Selenium browser options to set preferences like download.default_directory and disable download dialogs.
• Environment Variables: Allow overriding download folder path or browser type via environment variables for flexibility.
• Cleanup: Implement setup and teardown hooks to clear the download folder before and after tests to avoid stale files.

Test Reporting and CI/CD Integration

• Use pytest with plugins like pytest-html to generate readable test reports showing pass/fail status of download tests.
• Log file download status and file existence checks clearly in test output for easy debugging.
• Integrate tests into CI pipelines (e.g., GitHub Actions, Jenkins) ensuring the download folder is writable and cleaned before runs.
• Fail tests explicitly if the expected file is not found or download times out, so CI reports failures clearly.

Best Practices

1. Use Explicit Waits: Wait for the file to appear in the download folder instead of fixed sleep times to make tests reliable.
2. Isolate Downloads: Use a dedicated download folder per test run to avoid conflicts and stale files.
3. Clean Up: Always delete downloaded files after tests to keep environment clean.
4. Configure Browser Properly: Set browser preferences to disable download popups and auto-save files to the desired folder.
5. Validate File Content: When possible, check file size or content to confirm correct download, not just file presence.

Self Check

Where in this folder structure would you add a helper function to wait for a file to finish downloading?

Key Result

Organize Selenium Python tests with clear folder structure, browser config for downloads, utilities for file checks, and clean reporting.

Practice

1. What is the main purpose of setting browser preferences in Selenium for file downloads?

easy

A. To specify the folder where downloaded files are saved automatically

B. To speed up the browser loading time

C. To change the browser's theme

D. To disable JavaScript on the page

Solution

1. Step 1: Understand browser preferences role

   Browser preferences let you control how downloads behave, like where files save.

2. Step 2: Identify the correct purpose

   Setting preferences to specify download folder avoids manual prompts and saves files automatically.

3. Final Answer:

   To specify the folder where downloaded files are saved automatically -> Option A

4. Quick Check:

   Download folder control = A [OK]

Hint: Remember: preferences set download folder and disable prompts [OK]

Common Mistakes:

• Thinking preferences speed up browser loading
• Confusing download folder with browser theme
• Assuming preferences disable JavaScript

2. Which of the following is the correct way to set Firefox preferences in Selenium to automatically download PDF files to a folder without prompt?

easy

A. profile.set_preference('browser.download.folderList', '2')

B. profile.set_preference('browser.download.folderList', 2)

C. profile.set_preference('browser.download.folderList', True)

D. profile.set_preference('browser.download.folderList', None)

Solution

1. Step 1: Recall Firefox preference for download folder

   The 'browser.download.folderList' preference expects an integer: 0 (desktop), 1 (default), 2 (custom folder).

2. Step 2: Choose correct data type and value

   Using integer 2 sets a custom folder; string or other types cause errors.

3. Final Answer:

   profile.set_preference('browser.download.folderList', 2) -> Option B

4. Quick Check:

   Integer 2 for custom folder = B [OK]

Hint: Use integer 2, not string, for custom download folder [OK]

Common Mistakes:

• Passing '2' as string instead of integer
• Using boolean True instead of integer
• Passing None which disables setting

3. Given this Selenium Python code snippet, what will be the output if the file is downloaded successfully?

import os
from selenium import webdriver

options = webdriver.FirefoxOptions()
profile = webdriver.FirefoxProfile()
profile.set_preference('browser.download.folderList', 2)
profile.set_preference('browser.download.dir', '/tmp/downloads')
profile.set_preference('browser.helperApps.neverAsk.saveToDisk', 'application/pdf')
driver = webdriver.Firefox(firefox_profile=profile, options=options)
driver.get('http://example.com/sample.pdf')

file_path = '/tmp/downloads/sample.pdf'
print(os.path.exists(file_path))

medium

A. True

B. False

C. SyntaxError

D. FileNotFoundError

Solution

1. Step 1: Analyze download setup

   Preferences set to save PDF automatically to '/tmp/downloads'.

2. Step 2: Check file existence print

   After download, os.path.exists returns True if file is present.

3. Final Answer:

   True -> Option A

4. Quick Check:

   File exists after download = True [OK]

Hint: os.path.exists returns True if file is saved correctly [OK]

Common Mistakes:

• Assuming print outputs file path string
• Expecting False without download
• Confusing syntax or runtime errors

4. Identify the error in this Selenium Python code for downloading a CSV file:

profile = webdriver.FirefoxProfile()
profile.set_preference('browser.download.folderList', 2)
profile.set_preference('browser.download.dir', '/tmp/downloads')
profile.set_preference('browser.helperApps.neverAsk.saveToDisk', 'text/csv')
driver = webdriver.Firefox(profile)
driver.get('http://example.com/data.csv')

medium

A. Missing options parameter in webdriver.Firefox()

B. Download folder path must be absolute

C. Incorrect argument name; should be firefox_profile=profile

D. Wrong MIME type for CSV files

Solution

1. Step 1: Check webdriver.Firefox() usage

   Firefox expects profile passed as firefox_profile=profile, not just profile.

2. Step 2: Confirm other settings

   MIME type 'text/csv' and folder path are correct; no options parameter needed here.

3. Final Answer:

   Incorrect argument name; should be firefox_profile=profile -> Option C

4. Quick Check:

   Use firefox_profile=profile argument = D [OK]

Hint: Pass profile with firefox_profile=profile keyword [OK]

Common Mistakes:

• Passing profile as positional argument
• Changing MIME type unnecessarily
• Using relative folder path

5. You want to verify that a file named 'report.xlsx' has been downloaded successfully using Selenium Python. Which approach is best to confirm the download in an automated test?

hard

A. Check the page source for the file name

B. Check the browser's download history via Selenium API

C. Wait for an alert popup confirming download

D. Use os.path.exists() to check the file in the download folder

Solution

1. Step 1: Understand Selenium's download verification limits

   Selenium cannot access browser download history or alerts for downloads.

2. Step 2: Use file system check

   Checking file existence with os.path.exists() in the download folder confirms the file saved.

3. Final Answer:

   Use os.path.exists() to check the file in the download folder -> Option D

4. Quick Check:

   File system check confirms download = A [OK]

Hint: Verify downloads by checking file presence on disk [OK]

Common Mistakes:

• Trying to read browser download history
• Waiting for non-existent alert popups
• Searching page source for downloaded file