JavaScript executor basics in Selenium Python - Framework Patterns

Framework Mode - JavaScript executor basics

Folder Structure

selenium_python_project/
├── tests/
│   ├── test_login.py
│   ├── test_javascript_executor.py  <-- Tests using JavaScript executor
│   └── __init__.py
├── pages/
│   ├── base_page.py  <-- Contains JavaScript executor helper methods
│   ├── login_page.py
│   └── __init__.py
├── utils/
│   ├── driver_factory.py  <-- WebDriver setup and teardown
│   ├── config.py  <-- Environment and browser configs
│   └── __init__.py
├── reports/
│   └── (test reports output here)
├── conftest.py  <-- Pytest fixtures for setup
└── requirements.txt
  

Test Framework Layers

• Driver Layer: Manages WebDriver instances (in utils/driver_factory.py).
• Page Objects: Classes representing pages, with methods using JavaScript executor for advanced actions (pages/base_page.py).
• Tests: Test scripts that call page object methods, including JavaScript executor usage (tests/test_javascript_executor.py).
• Utilities: Helper functions and config management (utils/config.py).
• Configuration: Environment settings, browser options, credentials (utils/config.py).

Configuration Patterns

Use a config.py file to store environment URLs, browser choices, and credentials. Use environment variables or command-line options to switch between test environments (e.g., dev, staging, prod).

Example snippet in utils/config.py:

import os

ENV = os.getenv('TEST_ENV', 'dev')
BROWSER = os.getenv('BROWSER', 'chrome')

CONFIG = {
    'dev': {'url': 'https://dev.example.com'},
    'staging': {'url': 'https://staging.example.com'},
    'prod': {'url': 'https://example.com'}
}

BASE_URL = CONFIG[ENV]['url']

Pass browser choice to driver factory to create correct WebDriver.

Test Reporting and CI/CD Integration

• Use pytest with pytest-html plugin to generate HTML reports.
• Reports saved in reports/ folder for easy access.
• Integrate tests in CI/CD pipelines (GitHub Actions, Jenkins) to run on code push.
• Fail fast on JavaScript executor errors to catch UI issues early.

Best Practices

• Encapsulate JavaScript calls: Put JavaScript executor code inside page object methods to keep tests clean.
• Use explicit waits: Wait for elements or conditions before running JavaScript to avoid flaky tests.
• Keep JavaScript simple: Use JavaScript executor only when Selenium commands cannot perform the action.
• Handle exceptions: Catch and log JavaScript execution errors for easier debugging.
• Reuse driver instance: Pass the same WebDriver to page objects to maintain session and context.

Self Check

Where in this folder structure would you add a new method that uses JavaScript executor to scroll to an element?

Key Result

Organize Selenium Python tests with clear layers, encapsulate JavaScript executor calls in page objects, and manage configs for flexible, maintainable automation.

Practice

1. What is the main purpose of using execute_script in Selenium with Python?

easy

A. To run JavaScript code inside the browser during a test

B. To start the Selenium WebDriver server

C. To locate elements using CSS selectors

D. To take screenshots of the browser window

Solution

1. Step 1: Understand the role of execute_script

   This method allows running JavaScript code inside the browser from Selenium tests.

2. Step 2: Compare with other Selenium functions

   Other functions locate elements or control the browser, but execute_script specifically runs JS code.

3. Final Answer:

   To run JavaScript code inside the browser during a test -> Option A

4. Quick Check:

   execute_script runs JS code [OK]

Hint: Remember: execute_script runs JS code inside browser [OK]

Common Mistakes:

• Confusing execute_script with element locating methods
• Thinking execute_script starts WebDriver server
• Assuming execute_script takes screenshots

2. Which of the following is the correct syntax to run JavaScript code that returns the page title using Selenium's execute_script in Python?

easy

A. driver.execute_script('return document.title')

B. driver.execute_script(document.title)

C. driver.execute_script('document.title')

D. driver.execute_script(return document.title)

Solution

1. Step 1: Check correct string usage for JS code

   The JavaScript code must be passed as a string, so quotes are needed around 'return document.title'.

2. Step 2: Verify the return keyword usage

   To get a value back from JS, 'return' must be used inside the string.

3. Final Answer:

   driver.execute_script('return document.title') -> Option A

4. Quick Check:

   JS code as string with return keyword [OK]

Hint: Always pass JS code as a quoted string with return [OK]

Common Mistakes:

• Passing JS code without quotes
• Omitting the return keyword when expecting a value
• Using invalid syntax without quotes or return

3. What will be the output of this code snippet?

title = driver.execute_script('return document.title')
print(title)

medium

A. Prints the WebDriver object reference

B. Prints None because execute_script returns nothing

C. Prints the current page's title as a string

D. Raises a syntax error due to missing quotes

Solution

1. Step 1: Understand what execute_script returns

   When JavaScript code returns a value, execute_script returns it to Python.

2. Step 2: Analyze the JS code 'return document.title'

   This returns the page title as a string, so the variable 'title' holds that string.

3. Final Answer:

   Prints the current page's title as a string -> Option C

4. Quick Check:

   execute_script returns JS value [OK]

Hint: Return keyword in JS returns value to Python [OK]

Common Mistakes:

• Assuming execute_script returns None always
• Confusing JS code string syntax
• Expecting execute_script to print automatically

4. Identify the error in this code snippet:

driver.execute_script(return document.body.style.backgroundColor = 'red')

medium

A. Incorrect method name, should be execute_js

B. Missing quotes around the JavaScript code string

C. Cannot change background color with JavaScript

D. Syntax error due to missing parentheses

Solution

1. Step 1: Check the argument passed to execute_script

   The JavaScript code must be passed as a string, but here it is passed without quotes.

2. Step 2: Confirm method name and JS validity

   The method name is correct and changing background color with JS is valid.

3. Final Answer:

   Missing quotes around the JavaScript code string -> Option B

4. Quick Check:

   JS code must be a quoted string [OK]

Hint: Always wrap JS code in quotes for execute_script [OK]

Common Mistakes:

• Forgetting quotes around JS code
• Thinking method name is wrong
• Believing JS cannot change styles

5. You want to scroll the page down by 500 pixels using Selenium's JavaScript executor in Python. Which code snippet correctly does this?

hard

A. driver.execute_script('window.scrollTo(500, 0)')

B. driver.execute_script('scrollTo(0, 500)')

C. driver.execute_script('scrollBy(500, 0)')

D. driver.execute_script('window.scrollBy(0, 500)')

Solution

1. Step 1: Understand scrolling methods in JavaScript

   window.scrollBy(x, y) scrolls by x and y pixels relative to current position.

2. Step 2: Identify correct parameters for scrolling down

   To scroll down 500 pixels, x=0 and y=500 is correct.

3. Final Answer:

   driver.execute_script('window.scrollBy(0, 500)') -> Option D

4. Quick Check:

   scrollBy(0, 500) scrolls down 500px [OK]

Hint: Use window.scrollBy(0, pixels) to scroll down [OK]

Common Mistakes:

• Swapping x and y values
• Using scrollTo instead of scrollBy incorrectly
• Passing wrong parameters causing horizontal scroll