WIP: SWTBot test case: Serial Monitor verification#1297
Conversation
WalkthroughAdds a Linux test config flash timeout, introduces a new SWTBot UI test for Serial Monitor flow, extends ProjectTestOperations with terminal/flash wait helpers, and adds a text-contains wait utility for terminal content scanning. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Tester
participant SWTBot as SWTBot Runner
participant IDE as Eclipse IDE
participant Ops as ProjectTestOperations
participant Util as TestWidgetWaitUtility
participant Console as Console View
participant Terminal as Terminal View
Tester->>SWTBot: Run NewEspressifIDFProjectSerialMonitorTest
SWTBot->>IDE: Create new ESP-IDF project
SWTBot->>IDE: Build project via context menu
Ops->>Console: viewConsole("Build Console")
Ops->>Console: Wait for build completion
SWTBot->>IDE: Open Run Configurations and Launch Flash
Ops->>Console: viewConsole("ESP-IDF Console")
Ops->>Console: waitProjectFlash (wait for "Hard resetting via RTS pin...")
Ops->>Terminal: viewTerminal("Serial", timeout)
Util->>Terminal: waitUntilTextContains("Hello", timeout)
Ops->>Terminal: Disconnect terminal
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
Poem
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
AndriiFilippov
changed the title
| public boolean test() throws Exception { | ||
|
|
||
| String terminalText = terminalView.bot().canvas().getText(); | ||
|
|
There was a problem hiding this comment.
@kolipakakondal @alirana01 hi guys !
I need your advice. I'm writing a test for the Serial Monitor but can't extract text from the Terminal view.
Using SWT Inspector, I found that the terminal content is a textCanvas , not text() or styledText() , so it returns an empty string.
Since Canvas has no methods to get the content, I’m not sure how to proceed.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (5)
tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/operations/ProjectTestOperations.java (3)
104-111: Guard disconnect action to avoid flaky failuresClicking “Disconnect Terminal Connection” without checking connection state can throw if the toolbar button isn’t present/enabled. Add a presence/enablement check or catch WidgetNotFoundException.
- SWTBotView terminalView = viewTerminal("COM5", bot, 30000); - terminalView.toolbarPushButton("Disconnect Terminal Connection").click(); + SWTBotView terminalView = viewTerminal("COM5", bot, 30000); + try { + terminalView.toolbarPushButton("Disconnect Terminal Connection").click(); + } catch (WidgetNotFoundException e) { + // Already disconnected or control not available; proceed + }
113-121: Make searched serial text configurableHard-coding "Hello" couples the helper to a specific example. Accept a parameter or read from a property (e.g., default.serial.monitor.text) to reuse across tests and targets.
- public static void findTextInSerialMonitorOutput(SWTWorkbenchBot bot) throws IOException + public static void findTextInSerialMonitorOutput(SWTWorkbenchBot bot) throws IOException { bot.sleep(5000); SWTBotView terminalView = viewTerminal("<Closed> COM5", bot, 30000); terminalView.show(); terminalView.setFocus(); - TestWidgetWaitUtility.waitUntilTextContains(bot, "Hello", terminalView, + String expected = DefaultPropertyFetcher.getStringPropertyValue("default.serial.monitor.text", "Hello"); + TestWidgetWaitUtility.waitUntilTextContains(bot, expected, terminalView, DefaultPropertyFetcher.getLongPropertyValue(DEFAULT_FLASH_WAIT_PROPERTY, 20000)); }Note: add the DefaultPropertyFetcher import.
135-141: Unused parameters in viewTerminalterminalType and timeOut are unused; either remove them or implement filtering/selection by terminal session title.
- public static SWTBotView viewTerminal(String terminalType, SWTWorkbenchBot bot, long timeOut) + public static SWTBotView viewTerminal(String terminalType, SWTWorkbenchBot bot, long timeOut) { SWTBotView view = bot.viewByPartName("Terminal"); view.show(); view.setFocus(); return view; }If keeping the signature, consider using terminalType to activate a specific CTab within the Terminal view.
tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/executable/cases/project/NewEspressifIDFProjectSerialMonitorTest.java (2)
111-111: Avoid hard-coded project name; use the variable set earlierPrevents divergence if Fixture.givenProjectNameIs changes.
- prefrencesShell.bot().tree().getTreeItem("ESP-IDF Application").getNode("NewProjectSerialMonitorTest").select(); + prefrencesShell.bot().tree().getTreeItem("ESP-IDF Application").getNode(projectName).select();
126-130: Order is okay, but consider verifying monitor readiness before disconnectYou disconnect then read text from a closed session. Usually fine, but add a short wait/assert that the terminal view has content before disconnect to reduce flakiness.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (4)
tests/com.espressif.idf.ui.test/configs/default-test-linux.properties(1 hunks)tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/common/utility/TestWidgetWaitUtility.java(2 hunks)tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/executable/cases/project/NewEspressifIDFProjectSerialMonitorTest.java(1 hunks)tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/operations/ProjectTestOperations.java(3 hunks)
🧰 Additional context used
🧬 Code graph analysis (2)
tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/executable/cases/project/NewEspressifIDFProjectSerialMonitorTest.java (4)
tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/common/WorkBenchSWTBot.java (1)
WorkBenchSWTBot(14-28)tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/operations/EnvSetupOperations.java (1)
EnvSetupOperations(12-85)tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/operations/ProjectTestOperations.java (1)
ProjectTestOperations(51-803)tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/common/utility/TestWidgetWaitUtility.java (1)
SuppressWarnings(31-325)
tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/operations/ProjectTestOperations.java (1)
tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/common/configs/DefaultPropertyFetcher.java (1)
DefaultPropertyFetcher(20-90)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: build_windows
- GitHub Check: build
- GitHub Check: build_macos
🔇 Additional comments (1)
tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/operations/ProjectTestOperations.java (1)
143-149: Flash wait relies on the wrong key (after fix above this will honor 60s Linux default)Once DEFAULT_FLASH_WAIT_PROPERTY is corrected, this will stop waiting for hours and honor default.project.flash.wait=60000.
| public static void waitUntilTextContains(SWTWorkbenchBot bot, String text, SWTBotView terminalView, long timeOut) { | ||
| terminalView.bot().waitUntil(new DefaultCondition() { | ||
| @Override | ||
| public boolean test() throws Exception { | ||
|
|
||
| String terminalText = terminalView.bot().canvas().getText(); | ||
|
|
||
| return terminalText.toLowerCase().contains(text.toLowerCase()); | ||
| } | ||
|
|
||
| @Override | ||
| public String getFailureMessage() { | ||
| return "Text not found in terminal!"; | ||
| } | ||
| }, timeOut, 3000); // Wait for up to 'timeOut' milliseconds | ||
| } |
There was a problem hiding this comment.
Terminal text read uses Canvas.getText() (nonexistent) — switch to StyledText
SWT Canvas doesn’t expose text. This will fail at runtime/compile-time depending on bindings. Use styledText like elsewhere and ensure the view is visible/focused before reading.
- public static void waitUntilTextContains(SWTWorkbenchBot bot, String text, SWTBotView terminalView, long timeOut) {
- terminalView.bot().waitUntil(new DefaultCondition() {
+ public static void waitUntilTextContains(SWTWorkbenchBot bot, String text, SWTBotView terminalView, long timeOut) {
+ terminalView.bot().waitUntil(new DefaultCondition() {
@Override
public boolean test() throws Exception {
-
- String terminalText = terminalView.bot().canvas().getText();
-
- return terminalText.toLowerCase().contains(text.toLowerCase());
+ terminalView.show();
+ terminalView.setFocus();
+ String terminalText = terminalView.bot().styledText().getText();
+ return terminalText.toLowerCase().contains(text.toLowerCase());
}
@Override
public String getFailureMessage() {
return "Text not found in terminal!";
}
- }, timeOut, 3000); // Wait for up to 'timeOut' milliseconds
+ }, timeOut, 3000);
}Optional: de-duplicate with waitUntilViewContains by reusing it for terminal checks.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| public static void waitUntilTextContains(SWTWorkbenchBot bot, String text, SWTBotView terminalView, long timeOut) { | |
| terminalView.bot().waitUntil(new DefaultCondition() { | |
| @Override | |
| public boolean test() throws Exception { | |
| String terminalText = terminalView.bot().canvas().getText(); | |
| return terminalText.toLowerCase().contains(text.toLowerCase()); | |
| } | |
| @Override | |
| public String getFailureMessage() { | |
| return "Text not found in terminal!"; | |
| } | |
| }, timeOut, 3000); // Wait for up to 'timeOut' milliseconds | |
| } | |
| public static void waitUntilTextContains(SWTWorkbenchBot bot, String text, SWTBotView terminalView, long timeOut) { | |
| terminalView.bot().waitUntil(new DefaultCondition() { | |
| @Override | |
| public boolean test() throws Exception { | |
| terminalView.show(); | |
| terminalView.setFocus(); | |
| String terminalText = terminalView.bot().styledText().getText(); | |
| return terminalText.toLowerCase().contains(text.toLowerCase()); | |
| } | |
| @Override | |
| public String getFailureMessage() { | |
| return "Text not found in terminal!"; | |
| } | |
| }, timeOut, 3000); | |
| } |
🤖 Prompt for AI Agents
In
tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/common/utility/TestWidgetWaitUtility.java
around lines 144 to 159, the method reads terminal text via
terminalView.bot().canvas().getText() which is invalid; replace that with
retrieving the StyledText widget (e.g. find the StyledText in the view's bot or
use terminalView.bot().styledText().getText()), ensure the terminal view is
visible/focused before reading (call terminalView.show() /
terminalView.setFocus() or use waitUntil on view visibility), and optionally
call the existing waitUntilViewContains helper to avoid duplication by
delegating terminal checks to it.
| public void givenNewProjectCreatedBuiltWhenFlashProjectThenCheckSerialMonitorOutput() | ||
| throws Exception | ||
| { | ||
| Fixture.givenNewEspressifIDFProjectIsSelected("EspressIf", "Espressif IDF Project"); |
There was a problem hiding this comment.
Typo breaks project template selection (“EspressIf” → “Espressif”)
Category is case-sensitive in the UI. This will fail to locate the wizard node.
- Fixture.givenNewEspressifIDFProjectIsSelected("EspressIf", "Espressif IDF Project");
+ Fixture.givenNewEspressifIDFProjectIsSelected("Espressif", "Espressif IDF Project");📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Fixture.givenNewEspressifIDFProjectIsSelected("EspressIf", "Espressif IDF Project"); | |
| Fixture.givenNewEspressifIDFProjectIsSelected("Espressif", "Espressif IDF Project"); |
🤖 Prompt for AI Agents
In
tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/executable/cases/project/NewEspressifIDFProjectSerialMonitorTest.java
around line 57, the fixture call uses the wrong-cased category string
"EspressIf" causing the UI wizard node lookup to fail; replace the string with
the correct, case-sensitive "Espressif" so the template/category matches the UI
exactly and the wizard node can be located.
| private static void whenSelectSerialPort() throws IOException | ||
| { | ||
| TestWidgetWaitUtility.waitForDialogToAppear(bot, "Serial port not found", 30000); | ||
| bot.button("OK").click(); | ||
| TestWidgetWaitUtility.waitForDialogToAppear(bot, "New ESP Target", 20000); | ||
| bot.comboBoxWithLabel("Serial Port:").setSelection("COM5 USB Serial Port (COM5)"); | ||
| TestWidgetWaitUtility.waitForOperationsInProgressToFinishAsync(bot); | ||
| bot.button("Finish").click(); | ||
| } |
There was a problem hiding this comment.
Port selection is Windows-specific (“COM5”); make it portable or property-driven
Linux/macOS won’t have COM5. Read a property and fallback to the first item to keep CI portable.
- bot.comboBoxWithLabel("Serial Port:").setSelection("COM5 USB Serial Port (COM5)");
+ String preferredPort = DefaultPropertyFetcher.getStringPropertyValue("default.serial.port.label", "");
+ if (preferredPort != null && !preferredPort.isEmpty()) {
+ bot.comboBoxWithLabel("Serial Port:").setSelection(preferredPort);
+ } else {
+ bot.comboBoxWithLabel("Serial Port:").setSelection(0); // fallback: first available
+ }Add missing import at the top of this file:
import com.espressif.idf.ui.test.common.configs.DefaultPropertyFetcher;|
|
||
| private static final String DEFAULT_PROJECT_BUILD_WAIT_PROPERTY = "default.project.build.wait"; | ||
|
|
||
| private static final String DEFAULT_FLASH_WAIT_PROPERTY = "default.project.build.wait"; |
There was a problem hiding this comment.
Wrong property key for flash timeout (causes hours-long waits)
DEFAULT_FLASH_WAIT_PROPERTY points to the build-wait key. This makes flash waits use 90,800,000 ms from the Linux config.
- private static final String DEFAULT_FLASH_WAIT_PROPERTY = "default.project.build.wait";
+ private static final String DEFAULT_FLASH_WAIT_PROPERTY = "default.project.flash.wait";📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| private static final String DEFAULT_FLASH_WAIT_PROPERTY = "default.project.build.wait"; | |
| private static final String DEFAULT_FLASH_WAIT_PROPERTY = "default.project.flash.wait"; |
🤖 Prompt for AI Agents
In
tests/com.espressif.idf.ui.test/src/com/espressif/idf/ui/test/operations/ProjectTestOperations.java
around line 56, the constant DEFAULT_FLASH_WAIT_PROPERTY is set to the
build-wait key causing flash operations to pick up the wrong (very large)
timeout; change the string value from "default.project.build.wait" to the
correct flash timeout key (e.g. "default.project.flash.wait"), update any
references if needed, and run the tests to confirm flash waits now use the
intended timeout.
1 participant
Description
SWTBot Serial Monitor test cases
Fixes # (IEP-1624)
Type of change
Please delete options that are not relevant.
Test Configuration:
Dependent components impacted by this PR:
Checklist
Summary by CodeRabbit