Network interception (CDP) in Selenium Java - Framework Patterns

Framework Mode - Network interception (CDP)

Folder Structure

src/
└── test/
    └── java/
        └── com/
            └── example/
                ├── base/
                │   └── WebDriverManager.java       # Manages WebDriver and CDP sessions
                ├── pages/
                │   └── LoginPage.java             # Page Object Model classes
                ├── tests/
                │   └── LoginTest.java             # Test classes using CDP for network interception
                ├── utils/
                │   └── NetworkInterceptor.java   # Helper for CDP network interception
                └── config/
                    └── ConfigReader.java         # Reads environment and browser configs

Test Framework Layers

• Driver Layer: WebDriverManager.java handles browser setup and creates CDP sessions for network interception.
• Page Objects: Classes like LoginPage.java encapsulate UI elements and user actions.
• Tests: Test classes (e.g., LoginTest.java) use page objects and invoke network interception to verify requests/responses.
• Utilities: NetworkInterceptor.java provides methods to start, monitor, and analyze network traffic via CDP.
• Configuration: ConfigReader.java manages environment variables, browser types, and credentials for flexible test runs.

Configuration Patterns

• Environment Setup: Use property files or environment variables to define URLs, credentials, and environment types (dev, staging, prod).
• Browser Selection: Configure browser type (Chrome) and enable CDP support in WebDriverManager.
• CDP Session Initialization: WebDriverManager creates a DevTools session to enable network interception before tests run.
• Credentials Management: Store sensitive data securely outside the codebase, accessed via ConfigReader.

Test Reporting and CI/CD Integration

• Use TestNG or JUnit reports to capture test execution results including network interception validations.
• Integrate with CI/CD pipelines (Jenkins, GitHub Actions) to run tests on code commits and pull requests.
• Capture network logs and attach them to test reports for debugging failed tests.
• Use screenshots and logs to enhance report clarity when network interception detects unexpected requests or responses.

Framework Design Principles

1. Separate Concerns: Keep network interception logic in utility classes, not mixed with page objects or tests.
2. Reusable CDP Sessions: Initialize DevTools sessions once per test or suite to improve performance.
3. Explicit Waits for Network Events: Use waits or listeners to ensure network requests are captured before assertions.
4. Data-Driven Testing: Use external data sources to test different network scenarios and payloads.
5. Secure Configuration: Avoid hardcoding sensitive info; use environment variables or encrypted files.

Self Check

Where in this folder structure would you add a new utility class to mock network responses using CDP?

Key Result

Use a layered Selenium Java framework with WebDriverManager handling CDP sessions and utilities managing network interception separately.

Practice

1. What is the main purpose of using Network Interception with Selenium DevTools Protocol (CDP)?

easy

A. To replace Selenium WebDriver with a faster browser engine

B. To speed up test execution by skipping UI rendering

C. To monitor and control network requests and responses during tests

D. To automatically generate test data from network traffic

Solution

1. Step 1: Understand Network Interception

   Network interception allows tests to watch and manipulate network traffic between the browser and server.

2. Step 2: Identify the purpose in Selenium CDP context

   Selenium's DevTools Protocol integration enables listening to and controlling network events during tests.

3. Final Answer:

   To monitor and control network requests and responses during tests -> Option C

4. Quick Check:

   Network interception = monitor and control traffic [OK]

Hint: Network interception means watching and controlling web traffic [OK]

Common Mistakes:

• Thinking it speeds up tests by skipping UI
• Confusing it with test data generation
• Assuming it replaces WebDriver

2. Which Java code snippet correctly creates a DevTools session to enable network interception in Selenium 4+?

easy

A. DevTools devTools = driver.getDevTools(); devTools.startSession(); Network.enable();

B. DevTools devTools = new DevTools(); devTools.startSession(); devTools.enableNetwork();

C. DevTools devTools = driver.createDevTools(); devTools.start(); Network.enable();

D. DevTools devTools = driver.getDevTools(); devTools.createSession(); devTools.send(Network.enable(Optional.empty(), Optional.empty(), Optional.empty()));

Solution

1. Step 1: Check correct DevTools session creation

   In Selenium 4+, use driver.getDevTools() and then createSession() to start.

2. Step 2: Verify enabling network interception

   Use devTools.send(Network.enable(Optional.empty(), Optional.empty(), Optional.empty())) to enable network events.

3. Final Answer:

   DevTools devTools = driver.getDevTools(); devTools.createSession(); devTools.send(Network.enable(Optional.empty(), Optional.empty(), Optional.empty())); -> Option D

4. Quick Check:

   Use getDevTools(), createSession(), then send Network.enable [OK]

Hint: Use driver.getDevTools() then createSession() before enabling network [OK]

Common Mistakes:

• Trying to instantiate DevTools with new keyword
• Calling Network.enable() without devTools.send()
• Missing createSession() call

3. Given the following code snippet, what will be printed when a network request is intercepted?

DevTools devTools = driver.getDevTools();
devTools.createSession();
devTools.send(Network.enable(Optional.empty(), Optional.empty(), Optional.empty()));
devTools.addListener(Network.requestWillBeSent(), request -> {
    System.out.println("Request URL: " + request.getRequest().getUrl());
});
// Browser navigates to https://example.com

medium

A. Request URL: https://example.com/

B. Request URL: null

C. No output because listener is not added correctly

D. Compilation error due to missing imports

Solution

1. Step 1: Understand listener setup

   The listener is added to Network.requestWillBeSent event, printing the URL of each request.

2. Step 2: Predict output on navigating to example.com

   When browser navigates, a request is sent to https://example.com/, triggering the listener and printing the URL.

3. Final Answer:

   Request URL: https://example.com/ -> Option A

4. Quick Check:

   Listener prints request URL on navigation [OK]

Hint: Listener prints URL of each request sent during navigation [OK]

Common Mistakes:

• Assuming listener won't trigger without explicit start
• Expecting null URL in request
• Thinking listener setup is incorrect

4. Identify the error in this Selenium Java code snippet for blocking image requests using CDP:

DevTools devTools = driver.getDevTools();
devTools.createSession();
devTools.send(Network.enable(Optional.empty(), Optional.empty(), Optional.empty()));
devTools.addListener(Network.requestWillBeSent(), request -> {
    if(request.getRequest().getUrl().endsWith(".png")) {
        devTools.send(Network.setBlockedURLs(List.of(request.getRequest().getUrl())));
    }
});

medium

A. Calling setBlockedURLs inside the listener causes repeated blocking calls

B. Missing call to devTools.createSession() before enabling network

C. Using endsWith(".png") is invalid for URL filtering

D. Network.enable() should not be called with Optional.empty()

Solution

1. Step 1: Analyze listener behavior

   The listener calls setBlockedURLs every time a request ends with .png, causing repeated calls.

2. Step 2: Understand correct usage of setBlockedURLs

   setBlockedURLs should be called once with all URLs to block, not repeatedly inside the listener.

3. Final Answer:

   Calling setBlockedURLs inside the listener causes repeated blocking calls -> Option A

4. Quick Check:

   setBlockedURLs called repeatedly inside listener is wrong [OK]

Hint: Call setBlockedURLs once, not inside each request event [OK]

Common Mistakes:

• Calling setBlockedURLs repeatedly inside listener
• Forgetting to create session before enabling network
• Misusing string methods for URL filtering

5. You want to modify the response body of a JSON API call during a Selenium test using CDP. Which approach correctly achieves this?

hard

A. Use Network.requestWillBeSent to change the request URL to a local JSON file

B. Enable Network.requestIntercepted event, fetch response body, modify it, then use Network.continueInterceptedRequest with modified body

C. Call Network.setBlockedURLs to block the API call and serve a local file instead

D. Modify the DOM after page load to replace JSON data

Solution

1. Step 1: Understand response modification with CDP

   To modify a response, intercept it, get the body, change it, and continue with the new content.

2. Step 2: Identify correct event and method usage

   Use Network.requestIntercepted to detect response, fetch body, then Network.continueInterceptedRequest to send modified response.

3. Final Answer:

   Enable Network.requestIntercepted event, fetch response body, modify it, then use Network.continueInterceptedRequest with modified body -> Option B

4. Quick Check:

   Modify response by intercepting and continuing with new body [OK]

Hint: Intercept response, modify body, then continue intercepted request [OK]

Common Mistakes:

• Trying to modify request instead of response
• Blocking URL instead of modifying response
• Changing DOM instead of network response