解决Selenium测试WebSocket应用并发执行失败的问题

本文探讨了selenium测试websocket应用时，单个测试通过但并发执行失败的常见问题。核心原因在于websocket服务器在测试结束后未正确关闭，导致端口占用和资源冲突。教程将详细分析此问题，并提供在测试清理阶段优雅关闭服务器的解决方案，确保测试隔离性和稳定性。

引言：Selenium测试WebSocket应用时的并发挑战

在使用Selenium进行Web应用程序的自动化测试时，如果应用涉及到WebSocket通信，可能会遇到一些特定于环境的问题。一个常见的场景是，当您独立运行每个测试用例时，它们都能成功通过，但一旦将多个测试用例组合起来并发执行（例如，通过JUnit的测试套件或IDE的批量运行功能），则除了第一个测试用例外，后续的测试用例会失败，并抛出如 org.openqa.selenium.ElementNotInteractableException 这样的异常。这种现象通常伴随着WebSocket服务器未能成功启动的迹象。

问题分析：资源冲突与测试隔离性

为了更好地理解这个问题，我们首先回顾一下典型的测试设置。一个使用Selenium测试WebSocket应用的场景通常包括：

客户端页面 (HTML/JavaScript): 包含WebSocket客户端代码，用于连接到服务器并进行交互。WebSocket服务器 (Java): 监听特定端口，处理客户端的WebSocket连接和消息。Selenium测试框架 (Java/JUnit): 启动浏览器，加载客户端页面，并通过模拟用户操作来验证应用功能。

在提供的代码示例中，@BeforeEach 方法负责在每个测试用例开始前初始化环境，包括启动ChromeDriver和创建并启动一个监听8800端口的Server实例。@AfterEach 方法则负责在每个测试用例结束后关闭ChromeDriver。

public class Test {    WebDriver driver1;    String path = "path/web.html";    Path sampleFile;    Server server;    JavascriptExecutor js1;    @BeforeAll    static void setupClass() {        WebDriverManager.chromedriver().setup();    }    @BeforeEach    void setup() throws InterruptedException {        driver1 = new ChromeDriver();        js1 = (JavascriptExecutor) driver1;        sampleFile = Paths.get(path);        server = new Server(8800); // 在每个测试前启动服务器        server.start();    }    @AfterEach    void teardown() throws InterruptedException {        driver1.quit(); // 仅关闭浏览器    }    @Test    void row41() throws InterruptedException {        driver1.get(sampleFile.toUri().toString());        driver1.findElement(By.id("startButton")).click();        // ... some other operations        assertEquals(2, server.getNextPlayer());    }    @Test    void row42() throws InterruptedException {        driver1.get(sampleFile.toUri().toString());        driver1.findElement(By.id("startButton")).click();        // ... some other operations    }}

当单个测试用例运行时，例如 row41()，@BeforeEach 会启动服务器，测试执行，@AfterEach 关闭浏览器。由于JVM进程仍在运行，但没有其他测试尝试使用同一端口，因此一切正常。

然而，当多个测试用例（如 row41() 和 row42()）在同一个JVM进程中连续运行时，问题就出现了：

第一个测试 (row41) 执行： setup() 方法成功启动WebSocket服务器，占用端口8800。测试顺利完成。tearDown() 执行： 仅关闭了浏览器实例 driver1，但没有关闭之前启动的WebSocket服务器实例 server。这意味着端口8800仍然被第一个测试用例的服务器实例占用。第二个测试 (row42) 执行： setup() 方法尝试再次启动一个新的WebSocket服务器实例，并绑定到端口8800。由于该端口已被占用，新的服务器实例将无法成功启动（通常会静默失败或抛出绑定异常，但在此场景中，由于WebSocketServer的实现细节，它可能只是未能完全初始化，导致 onStart() 方法中的打印语句不执行）。客户端连接失败： 客户端HTML页面尝试连接 ws://localhost:8800，但由于没有活动的服务器监听该端口，连接会失败。页面元素不可交互： 客户端页面中的 startButton 按钮可能依赖于WebSocket连接状态来改变其可见性或可交互性。当WebSocket连接失败时，按钮可能保持隐藏或禁用状态，导致Selenium尝试点击时抛出 ElementNotInteractableException。

核心原因： 测试用例之间缺乏隔离性，特别是共享资源（如网络端口）未能被正确清理和释放。

解决方案：在每个测试后关闭WebSocket服务器

解决此问题的关键在于确保在每个测试用例执行完毕后，所有由该测试用例启动的资源（包括WebSocket服务器）都被正确地关闭和释放。这可以通过在 @AfterEach 方法中添加服务器关闭逻辑来实现。

1. 修改 tearDown() 方法

在 tearDown() 方法中，除了关闭 WebDriver 实例外，还需要调用 server.stop() 来优雅地关闭WebSocket服务器。

Fireflies.ai

自动化会议记录和笔记工具，可以帮助你的团队记录、转录、搜索和分析语音对话。

145 查看详情

import org.junit.jupiter.api.AfterEach;import org.junit.jupiter.api.BeforeAll;import org.junit.jupiter.api.BeforeEach;import org.junit.jupiter.api.Test;import org.openqa.selenium.*;import org.openqa.selenium.chrome.ChromeDriver;import io.github.bonigarcia.wdm.WebDriverManager;import java.nio.file.Path;import java.nio.file.Paths;import static org.junit.jupiter.api.Assertions.*;public class TestClass { // 建议类名不要直接使用Test，避免与JUnit的@Test注解混淆    WebDriver driver1;    String path = "path/web.html"; // 请替换为您的HTML文件实际路径    Path sampleFile;    Server server; // 您的WebSocket服务器实例    JavascriptExecutor js1;    @BeforeAll    static void setupClass() {        WebDriverManager.chromedriver().setup();    }    @BeforeEach    void setup() throws InterruptedException {        driver1 = new ChromeDriver();        js1 = (JavascriptExecutor) driver1;        sampleFile = Paths.get(path);        // 确保服务器在每个测试开始前启动        server = new Server(8800);        server.start();        // 可以在此处添加一个短暂的等待，确保服务器完全启动并监听        Thread.sleep(500);     }    @AfterEach    void teardown() throws InterruptedException {        if (driver1 != null) {            driver1.quit(); // 关闭WebDriver实例        }        if (server != null) {            // 优雅地关闭WebSocket服务器，释放端口            // 可以选择带超时参数的stop方法，例如 server.stop(1000)            server.stop();             // 可以在此处添加一个短暂的等待，确保服务器完全关闭            Thread.sleep(500);         }    }    @Test    void testRow41() throws InterruptedException {        driver1.get(sampleFile.toUri().toString());        // 确保页面加载并WebSocket连接建立        // 可以使用显式等待等待按钮可见或WebSocket连接状态        // 例如：WebDriverWait wait = new WebDriverWait(driver1, Duration.ofSeconds(10));        // wait.until(ExpectedConditions.visibilityOfElementLocated(By.id("startButton")));        driver1.findElement(By.id("startButton")).click();        // ... some other operations        // 假设getNextPlayer()是Server类的一个方法        // assertEquals(2, server.getNextPlayer());     }    @Test    void testRow42() throws InterruptedException {        driver1.get(sampleFile.toUri().toString());        // 确保页面加载并WebSocket连接建立        driver1.findElement(By.id("startButton")).click();        // ... some other operations    }}

2. WebSocket服务器代码 (示例，保持原有结构)

import org.java_websocket.WebSocket;import org.java_websocket.handshake.ClientHandshake;import org.java_websocket.server.WebSocketServer;import java.io.IOException;import java.net.InetSocketAddress;import java.util.*;public class Server extends WebSocketServer {    public Server(int port) {        super(new InetSocketAddress(port));    }    @Override    public void onStart() {        System.out.println("Server started on port " + getPort() + "!");        setConnectionLostTimeout(0);        setConnectionLostTimeout(500);    }    @Override    public void onOpen(WebSocket conn, ClientHandshake handshake) {        System.out.println("New connection from " + conn.getRemoteSocketAddress());        // ...    }    @Override    public void onClose(WebSocket conn, int code, String reason, boolean remote) {        System.out.println("Closed connection to " + conn.getRemoteSocketAddress() + " with exit code " + code + " reason " + reason);        // ...    }    @Override    public onMessage(WebSocket conn, String message) {        System.out.println("Received message from " + conn.getRemoteSocketAddress() + ": " + message);        // ...    }    @Override    public void onError(WebSocket conn, Exception ex) {        System.err.println("An error occurred on connection " + conn.getRemoteSocketAddress() + ":" + ex);        // ...    }    // 假设您有类似的方法来获取游戏状态    public int getNextPlayer() {        // ... 实现获取下一个玩家逻辑        return 0;     }}

3. 页面HTML (示例，保持原有结构)

        
START
        var webSocket; // 声明为全局变量或确保在函数中可访问        var startButton = document.getElementById("startButton");        function initWebSocket() {            webSocket = new WebSocket("ws://localhost:8800");            webSocket.onopen = function(event){ wsOpen(event);};            webSocket.onmessage = function(event){ wsGetMessage(event);};            webSocket.onclose = function(event){ wsClose(event);};            webSocket.onerror = function(event){ wsError(event);};        }        // 在页面加载完成后初始化WebSocket连接        window.onload = function() {            initWebSocket();        };        function start(){            if (webSocket && webSocket.readyState === WebSocket.OPEN) {                wsSendMessage("start,"+player_id); // 假设player_id已定义                startButton.innerText = "STARTED";                startButton.disabled="true";            } else {                console.warn("WebSocket is not open. Cannot send message.");            }        }        function wsSendMessage(message){            webSocket.send(message);        }        function wsOpen(event) {            console.log("WebSocket connection opened.");            startButton.style.visibility = "visible"; // 连接成功后显示按钮            startButton.disabled = false; // 启用按钮        }        function wsGetMessage(event) {            console.log("Received message: " + event.data);            // ...        }        function wsClose(event) {            console.log("WebSocket connection closed.");            startButton.style.visibility = "hidden"; // 连接关闭后隐藏按钮            startButton.disabled = true; // 禁用按钮        }        function wsError(event) {            console.error("WebSocket error: ", event);            startButton.style.visibility = "hidden"; // 错误时隐藏按钮            startButton.disabled = true; // 禁用按钮        }    

在HTML页面中，我们稍微调整了WebSocket的初始化逻辑，确保在页面加载后尝试建立连接，并且在连接成功时才显示并启用 startButton。这与测试失败时按钮不可交互的现象相符。

注意事项与最佳实践

资源清理的完整性： 确保所有在 @BeforeEach 中初始化的资源都在 @AfterEach 中得到妥善清理。这包括但不限于WebDriver实例、自定义服务器、文件句柄、数据库连接等。

显式等待： 对于依赖异步操作（如WebSocket连接建立）才能交互的页面元素，应使用Selenium的显式等待 (WebDriverWait 和 ExpectedConditions)，而不是简单的 Thread.sleep()。这能提高测试的健壮性和执行效率。

import org.openqa.selenium.support.ui.WebDriverWait;import org.openqa.selenium.support.ui.ExpectedConditions;import java.time.Duration;// 在测试方法中WebDriverWait wait = new WebDriverWait(driver1, Duration.ofSeconds(10));wait.until(ExpectedConditions.visibilityOfElementLocated(By.id("startButton")));driver1.findElement(By.id("startButton")).click();

服务器关闭超时： WebSocketServer.stop() 方法通常有一个带超时参数的版本，例如 server.stop(1000)，它会尝试在指定时间内优雅地关闭服务器。如果超时，则会强制关闭。这有助于防止测试因服务器无法关闭而长时间挂起。

端口冲突处理： 如果您的测试环境确实需要更复杂的端口管理（例如，在同一台机器上并行运行多个测试套件，每个套件都需要自己的WebSocket服务器），可以考虑动态分配端口，或者使用测试容器（Testcontainers）等工具来提供隔离的测试环境。

日志记录： 确保WebSocket服务器和客户端都有足够的日志输出，以便在问题发生时能够快速诊断。例如，WebSocket服务器的 onStart() 方法打印出它监听的端口号，可以帮助确认服务器是否成功启动。

总结

在Selenium自动化测试中，确保测试用例之间的隔离性至关重要。对于涉及网络通信和自定义服务器的复杂应用，这意味着不仅要管理浏览器实例，还要正确地启动和关闭所有相关的服务。通过在JUnit的 @AfterEach 方法中显式调用WebSocket服务器的 stop() 方法，我们可以有效解决因端口占用导致的并发测试失败问题，从而构建更稳定、可靠的自动化测试套件。遵循这些最佳实践，将有助于提升测试的效率和准确性。

以上就是解决Selenium测试WebSocket应用并发执行失败的问题的详细内容，更多请关注创想鸟其它相关文章！