Skip to content

SWTBot test case: SDKconfig Editor #1123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AndriiFilippov merged 1 commit into from
Feb 3, 2025
Merged

SWTBot test case: SDKconfig Editor #1123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 42 additions & 15 deletions ...essif.idf.ui.test/src/com/espressif/idf/ui/test/common/utility/TestWidgetWaitUtility.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public String getFailureMessage()
}
}, 99000000, 3000);
}

public static void waitForOperationsInProgressToFinishSync(SWTWorkbenchBot bot)
{
bot.viewById(IPageLayout.ID_PROGRESS_VIEW).show();
Expand Down Expand Up @@ -111,7 +111,7 @@ public String getFailureMessage()
}
}, 99000000, 500);
}

/**
* Waits until the specified view contains the provided text, the view must contain a styled text
*
Expand Down Expand Up @@ -213,27 +213,31 @@ public String getFailureMessage()
* @param dialogTitle The title of the dialog to look for
* @param timeout Time to wait in ms before throwing {@link WidgetNotFoundException}
*/
public static void waitUntilDialogIsNotVisible(SWTWorkbenchBot workbenchBot, String dialogTitle, long timeout)
public static void waitForDialogToAppear(SWTWorkbenchBot workbenchBot, String dialogTitle, long timeout)
{
workbenchBot.waitUntil(new DefaultCondition()
{

@Override
public boolean test() throws Exception
{
SWTBotShell swtBotShell = workbenchBot.activeShell();
return swtBotShell.getText().contains(dialogTitle);
for (SWTBotShell shell : workbenchBot.shells())
{
if (shell.getText().contains(dialogTitle))
{
return true; // Dialog is now visible
}
}
return false; // Dialog is not yet visible
}

@Override
public String getFailureMessage()
{
return "View with title: " + dialogTitle + " not found";
return "Dialog with title: " + dialogTitle + " did not appear in time.";
}
}, timeout);
}



/**
* Waits while the provided bot has a dialog with the title visible
*
Expand All @@ -245,33 +249,56 @@ public static void waitWhileDialogIsVisible(SWTWorkbenchBot workbenchBot, String
{
workbenchBot.waitWhile(new DefaultCondition()
{
@Override
public boolean test() throws Exception
{
for (SWTBotShell shell : workbenchBot.shells())
{
if (shell.getText().contains(dialogTitle))
{
return true;
}
}
return false;
}

@Override
public String getFailureMessage()
{
return "Dialog with title: " + dialogTitle + " did not close in time.";
}
}, timeout);
}

public static void waitForSDKConfigurationTab(SWTWorkbenchBot workbenchBot, long timeout)
{
workbenchBot.waitUntil(new DefaultCondition()
{
@Override
public boolean test() throws Exception
{
SWTBotShell swtBotShell = workbenchBot.activeShell();
return swtBotShell.getText().contains(dialogTitle);
return workbenchBot.cTabItem("SDK Configuration (sdkconfig)").isActive();
}

@Override
public String getFailureMessage()
{
return "View with title: " + dialogTitle + " not found";
return "SDK Configuration tab did not open in time.";
}
}, timeout);
}

private static OperationResponse getOperationResponse()
{
TestWidgetWaitUtility testWidgetWaitUtility = new TestWidgetWaitUtility();
return testWidgetWaitUtility.getOperationResponseObject();
}

private OperationResponse getOperationResponseObject()
{
return new OperationResponse();
}

private class OperationResponse
{
private boolean itemStillPending = true;
Expand Down
4 changes: 2 additions & 2 deletions .../idf/ui/test/executable/cases/project/NewEspressifIDFProjectPartitionTableEditorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,13 +171,13 @@ private static void whenProjectIsBuiltUsingContextMenu() throws IOException
private static void whenOpenPartitionTableEditor() throws IOException
{
ProjectTestOperations.launchCommandUsingContextMenu(projectName, bot, "Partition Table Editor");
TestWidgetWaitUtility.waitUntilDialogIsNotVisible(bot, "Partition Table Editor", 10000);
TestWidgetWaitUtility.waitForDialogToAppear(bot, "Partition Table Editor", 10000);
}

private static void whenOpenEmptyPartitionTableEditor() throws IOException
{
ProjectTestOperations.launchCommandUsingContextMenu(projectName, bot, "Partition Table Editor");
TestWidgetWaitUtility.waitUntilDialogIsNotVisible(bot, "Information", 10000);
TestWidgetWaitUtility.waitForDialogToAppear(bot, "Information", 10000);
}

private static void ThenInformationMessagePopUp() throws IOException
Expand Down
240 changes: 240 additions & 0 deletions ...m/espressif/idf/ui/test/executable/cases/project/NewEspressifIDFProjectSDKconfigTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,240 @@
/*******************************************************************************
* Copyright 2025 Espressif Systems (Shanghai) PTE LTD. All rights reserved.
* Use is subject to license terms.
*******************************************************************************/
package com.espressif.idf.ui.test.executable.cases.project;

import static org.junit.Assert.assertTrue;

import java.io.IOException;

import org.eclipse.swtbot.eclipse.finder.SWTWorkbenchBot;

import org.eclipse.swtbot.eclipse.finder.widgets.SWTBotView;
import org.eclipse.swtbot.swt.finder.junit.SWTBotJunit4ClassRunner;
import org.junit.After;
import org.junit.BeforeClass;
import org.junit.FixMethodOrder;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.MethodSorters;

import com.espressif.idf.ui.test.common.WorkBenchSWTBot;
import com.espressif.idf.ui.test.common.utility.TestWidgetWaitUtility;
import com.espressif.idf.ui.test.operations.EnvSetupOperations;
import com.espressif.idf.ui.test.operations.ProjectTestOperations;

/**
* Test class to test the project creation, build and basic operations
*
* @author Andrii Filippov
*
*/
@SuppressWarnings("restriction")
@RunWith(SWTBotJunit4ClassRunner.class)
@FixMethodOrder(MethodSorters.NAME_ASCENDING)
public class NewEspressifIDFProjectSDKconfigTest
{
@BeforeClass
public static void beforeTestClass() throws Exception
{
Fixture.loadEnv();
}

@After
public void afterEachTest()
{
Fixture.cleanTestEnv();
}

@Test
public void givenNewProjectIsCreatedThenTestFullSDKconfigWorkflowForNewProject() throws Exception
{
Fixture.givenNewEspressifIDFProjectIsSelected("EspressIf", "Espressif IDF Project");
Fixture.givenProjectNameIs("NewProjectSDKconfigTest");
Fixture.whenNewProjectIsSelected();
Fixture.thenSDKconfigFileIsPresent();
Fixture.whenSDKconfigFileOpenedViaDoubleClickthenVerifiedthenClosed();
Fixture.whenSDKconfigFileOpenedViaContextMenuthenVerifiedthenClosed();
Fixture.whenSDKconfigFileOpenedEditedSavedthenReopenedAndChecked();
Fixture.whenSDKconfigFileDeletedWhenBuildProjectThenSDKconfigFileGeneratedAndVerified();
}

@Test
public void givenNewProjectIsCreatedWhenSDKconfigFileOpenedEditedSavedThenBuiltReopenedAndChecked() throws Exception
{
Fixture.givenNewEspressifIDFProjectIsSelected("EspressIf", "Espressif IDF Project");
Fixture.givenProjectNameIs("NewProjectSDKconfigTest2");
Fixture.whenNewProjectIsSelected();
Fixture.whenSDKconfigFileOpenedEditedSaved();
Fixture.whenProjectIsBuiltUsingContextMenu();
Fixture.whenSDKconfigFileOpenedUsingContextMenu();
Fixture.thenCheckChangesAreSaved();
}

private static class Fixture
{
private static SWTWorkbenchBot bot;
private static String category;
private static String subCategory;
private static String projectName;

private static void loadEnv() throws Exception
{
bot = WorkBenchSWTBot.getBot();
EnvSetupOperations.setupEspressifEnv(bot);
bot.sleep(1000);
Comment thread
AndriiFilippov marked this conversation as resolved.
ProjectTestOperations.deleteAllProjects(bot);
}

public static void whenSDKconfigFileOpenedViaDoubleClickthenVerifiedthenClosed() throws Exception
{
whenSDKconfigFileOpenedUsingDoubleClick();
thenSDKconfigFileContentChecked();
thenSDKconfigShellClosed();
}

public static void whenSDKconfigFileOpenedViaContextMenuthenVerifiedthenClosed() throws Exception
{
whenSDKconfigFileOpenedUsingContextMenu();
thenSDKconfigFileContentChecked();
thenSDKconfigShellClosed();
}

public static void whenSDKconfigFileOpenedEditedSavedthenReopenedAndChecked() throws Exception
{
whenSDKconfigFileOpenedUsingContextMenu();
thenSDKconfigFileContentEdited();
whenSDKconfigFileIsSaved();
whenSDKconfigFileOpenedUsingContextMenu();
thenCheckChangesAreSaved();
thenSDKconfigShellClosed();
}

private static void whenSDKconfigFileOpenedEditedSaved() throws Exception
{
whenSDKconfigFileOpenedUsingContextMenu();
thenSDKconfigFileContentEdited();
whenSDKconfigFileIsSaved();
}

private static void whenSDKconfigFileDeletedWhenBuildProjectThenSDKconfigFileGeneratedAndVerified()
throws Exception
{
bot.tree().getTreeItem(projectName).getNode("sdkconfig").select();
bot.tree().getTreeItem(projectName).getNode("sdkconfig").contextMenu("Delete").click();
bot.shell("Delete Resources").bot().button("OK").click();
bot.sleep(1000);
ProjectTestOperations.launchCommandUsingContextMenu(projectName, bot, "Refresh");
thenSDKconfigFileIsAbsent();
whenProjectIsBuiltUsingContextMenu();
thenSDKconfigFileIsPresent();
whenSDKconfigFileOpenedViaContextMenuthenVerifiedthenClosed();
}

private static void givenNewEspressifIDFProjectIsSelected(String category, String subCategory)
{
Fixture.category = category;
Fixture.subCategory = subCategory;
}

private static void givenProjectNameIs(String projectName)
{
Fixture.projectName = projectName;
}

private static void whenNewProjectIsSelected() throws Exception
{
ProjectTestOperations.setupProject(projectName, category, subCategory, bot);
TestWidgetWaitUtility.waitForOperationsInProgressToFinishSync(bot);
SWTBotView projectExplorView = bot.viewByTitle("Project Explorer");
projectExplorView.show();
projectExplorView.setFocus();
bot.tree().getTreeItem(projectName).select();
bot.tree().getTreeItem(projectName).expand();
bot.sleep(1000);
Comment thread
AndriiFilippov marked this conversation as resolved.
}

private static void whenProjectIsBuiltUsingContextMenu() throws IOException
{
ProjectTestOperations.buildProjectUsingContextMenu(projectName, bot);
ProjectTestOperations.waitForProjectBuild(bot);
}

private static void thenSDKconfigFileIsPresent() throws IOException
{
assertTrue(bot.tree().getTreeItem(projectName).getNode("sdkconfig") != null);
}

private static void thenSDKconfigFileIsAbsent() throws IOException
{
assertTrue(!bot.tree().getTreeItem(projectName).getNodes().contains("sdkconfig"));
}

private static void whenSDKconfigFileOpenedUsingDoubleClick() throws IOException
{
bot.tree().getTreeItem(projectName).getNode("sdkconfig").doubleClick();
TestWidgetWaitUtility.waitWhileDialogIsVisible(bot, "Progress Information", 40000);
TestWidgetWaitUtility.waitForSDKConfigurationTab(bot, 5000);
}

private static void whenSDKconfigFileOpenedUsingContextMenu() throws IOException
{
ProjectTestOperations.launchCommandUsingContextMenu(projectName, bot, "Menu Config");
TestWidgetWaitUtility.waitWhileDialogIsVisible(bot, "Progress Information", 40000);
TestWidgetWaitUtility.waitForSDKConfigurationTab(bot, 5000);
}

private static void thenSDKconfigFileContentChecked() throws Exception
{
bot.cTabItem("SDK Configuration (sdkconfig)").activate();
TestWidgetWaitUtility.waitForTreeItem("Partition Table", bot.tree(1), bot);
bot.tree(1).getTreeItem("Partition Table").click();
bot.sleep(1000);
assertTrue(bot.textWithLabel("Offset of partition table (hex)").getText().matches("0x8000"));
}

private static void thenSDKconfigFileContentEdited() throws Exception
{
bot.cTabItem("SDK Configuration (sdkconfig)").activate();
TestWidgetWaitUtility.waitForTreeItem("Partition Table", bot.tree(1), bot);
bot.tree(1).getTreeItem("Partition Table").click();
bot.sleep(1000);
bot.textWithLabel("Offset of partition table (hex)").setText("0x4000");
bot.comboBoxWithLabel("Partition Table").setSelection("Custom partition table CSV");
bot.checkBox("Generate an MD5 checksum for the partition table").click();
}

private static void thenSDKconfigShellClosed() throws IOException
{
bot.cTabItem("SDK Configuration (sdkconfig)").close();
}

private static void whenSDKconfigFileIsSaved() throws IOException
{
bot.cTabItem("*SDK Configuration (sdkconfig)").activate();
bot.cTabItem("*SDK Configuration (sdkconfig)").close();
bot.sleep(5000);
TestWidgetWaitUtility.waitForDialogToAppear(bot, "Save Resource", 5000);
bot.shell("Save Resource").bot().button("Save").click();
}

private static void thenCheckChangesAreSaved() throws Exception
{
bot.cTabItem("SDK Configuration (sdkconfig)").activate();
TestWidgetWaitUtility.waitForTreeItem("Partition Table", bot.tree(1), bot);
bot.tree(1).getTreeItem("Partition Table").click();
bot.sleep(2000);
assertTrue(bot.textWithLabel("Offset of partition table (hex)").getText().matches("0x4000"));
assertTrue(bot.comboBoxWithLabel("Partition Table").selection().equals("Custom partition table CSV"));
assertTrue(!bot.checkBox("Generate an MD5 checksum for the partition table").isChecked());
}

private static void cleanTestEnv()
{
TestWidgetWaitUtility.waitForOperationsInProgressToFinishAsync(bot);
ProjectTestOperations.closeAllProjects(bot);
ProjectTestOperations.deleteAllProjects(bot);
}
}
}