如何开始：使用AssertJ Swing测试Java Swing GUI [英] How to get started: testing Java Swing GUI with AssertJ Swing
问题描述
在使用Swing开发Java桌面应用程序时，我遇到了直接测试UI的需要，而不仅仅是通过单元测试来测试底层控制器/模型类。
While developing a Java desktop application with Swing, I encountered the need to test the UI directly, and not just the underlying controller/model classes via unit tests.
这个答案（关于什么是基于Swing的应用程序的最佳测试工具？）建议使用 FEST ，遗憾的是已停止使用。
但是，还有一些项目在FEST离开的地方继续进行。一个特别（在这个答案中提到）引起了我的注意，我之前在单元测试中使用过它： AssertJ 。
This answer (on "What is the best testing tool for Swing-based applications?") suggested using FEST, which is unfortunately discontinued. However, there are a few projects that continued from where FEST left of. One in particular (mentioned in this answer) caught my attention, as I used it before in unit tests: AssertJ.
显然有 AssertJ Swing ，这是基于FEST并提供一些易于使用的编写Swing UI测试的方法。
但是，进入初始/工作设置很麻烦，因为很难说从哪里开始。
Apparently there is AssertJ Swing, which is based on FEST and offers some easy to use ways of writing your Swing UI tests. But still, getting to an initial/working setup is cumbersome as it's hard to say where to start.
如何为以下示例UI创建最小测试设置，仅包含两个类？
约束：Java SE，Swing UI ，Maven项目，JUnit
Constraints: Java SE, Swing UI, Maven Project, JUnit
public class MainApp {
/**
* Run me, to use the app yourself.
*
* @param args ignored
*/
public static void main(String[] args) {
MainApp.showWindow().setSize(600, 600);
}
/**
* Internal standard method to initialize the view, returning the main JFrame (also to be used in automated tests).
*
* @return initialized JFrame instance
*/
public static MainWindow showWindow() {
MainWindow mainWindow = new MainWindow();
mainWindow.setVisible(true);
return mainWindow;
}
}
public class MainWindow extends JFrame {
public MainWindow() {
super("MainWindow");
this.setContentPane(this.createContentPane());
}
private JPanel createContentPane() {
JTextArea centerArea = new JTextArea();
centerArea.setName("Center-Area");
centerArea.setEditable(false);
JButton northButton = this.createButton("North", centerArea);
JButton southButton = this.createButton("South", centerArea);
JPanel contentPane = new JPanel(new BorderLayout());
contentPane.add(centerArea);
contentPane.add(northButton, BorderLayout.NORTH);
contentPane.add(southButton, BorderLayout.SOUTH);
return contentPane;
}
private JButton createButton(final String text, final JTextArea centerArea) {
JButton button = new JButton(text);
button.addActionListener(new ActionListener() {
@Override
public void actionPerformed(ActionEvent event) {
centerArea.setText(centerArea.getText() + text + ", ");
}
});
return button;
}
}
我知道问题本身非常广泛，因此我自己提供了一个答案 - 显示 - 包含这个特定的例子。
I'm aware that the question itself is very broad, therefore I provide an answer myself - show-casing this particular example.
推荐答案
TL; DR：示例项目可以在 GitHub 上找到。
TL;DR: the example project can be found on GitHub.
假设这是一个maven项目，你首先需要添加至少两个依赖项：
Assuming this is a maven project, you'll firstly need to add at least two dependencies:
- 一个单元测试框架（例如这里
junit- 但也可以使用testng） - 匹配的
AssertJ Swing库（例如这里assertj -swing-junit）
- A unit test framework (e.g. here
junit– but could also usetestng) - The matching
AssertJ Swinglibrary (e.g. hereassertj-swing-junit)
它可能看起来像这样（在你的 pom中.xml ：
It could look like this (in your pom.xml:
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-swing-junit</artifactId>
<version>1.2.0</version>
<scope>test</scope>
</dependency>
其次，我通常会选择一个基础测试类来将大部分测试设置与实际测试分开：
Secondly, I usually go for one base test class to separate most of the test setup from the actual tests:
/**
* Base class for all my UI tests taking care of the basic setup.
*/
public class AbstractUiTest extends AssertJSwingTestCaseTemplate {
/**
* The main entry point for any tests: the wrapped MainWindow.
*/
protected FrameFixture frame;
/**
* Installs a {@link FailOnThreadViolationRepaintManager} to catch violations of Swing threading rules.
*/
@BeforeClass
public static final void setUpOnce() {
// avoid UI test execution in a headless environment (e.g. when building in CI environment like Jenkins or TravisCI)
Assume.assumeFalse("Automated UI Test cannot be executed in headless environment", GraphicsEnvironment.isHeadless());
FailOnThreadViolationRepaintManager.install();
}
/**
* Sets up this test's fixture, starting from creation of a new <code>{@link Robot}</code>.
*
* @see #setUpRobot()
* @see #onSetUp()
*/
@Before
public final void setUp() {
// call provided AssertJSwingTestCaseTemplate.setUpRobot()
this.setUpRobot();
// initialize the graphical user interface
MainWindow mainWindow = GuiActionRunner.execute(new GuiQuery<MainWindow>() {
@Override
protected MainWindow executeInEDT() throws Exception {
return MainApp.showWindow();
}
});
this.frame = new FrameFixture(this.robot(), mainWindow);
this.frame.show();
this.frame.resizeTo(new Dimension(600, 600));
onSetUp();
}
/**
* Subclasses that need to set up their own test fixtures in this method. Called as <strong>last action</strong> during {@link #setUp()}.
*/
protected void onSetUp() {
// default: everything is already set up
}
/*****************************************************************************************
* Here you could insert further helper methods, e.g. frequently used component matchers *
*****************************************************************************************/
/**
* Cleans up any resources used in this test. After calling <code>{@link #onTearDown()}</code>, this method cleans up resources used by this
* test's <code>{@link Robot}</code>.
*
* @see #cleanUp()
* @see #onTearDown()
*/
@After
public final void tearDown() {
try {
onTearDown();
this.frame = null;
} finally {
cleanUp();
}
}
/**
* Subclasses that need to clean up resources can do so in this method. Called as <strong>first action</strong> during {@link #tearDown()}.
*/
protected void onTearDown() {
// default: nothing more to tear down
}
}
实际测试类可能如下所示：
The actual test class could look like this then:
public class MainWindowTest extends AbstractUiTest {
private JButtonFixture northButtonFixture;
private JButtonFixture southButtonFixture;
@Override
protected void onSetUp() {
this.northButtonFixture = this.frame.button(JButtonMatcher.withText("North"));
this.southButtonFixture = this.frame.button(JButtonMatcher.withText("South"));
}
@Test
public void testWithDifferingComponentMatchers() {
// use JTextComponentMatcher.any() as there is only one text input
this.frame.textBox(JTextComponentMatcher.any()).requireVisible().requireEnabled().requireNotEditable().requireEmpty();
this.northButtonFixture.requireVisible().requireEnabled().click();
// use value assigned in MainWindow class via JTextArea.setName("Center-Area") to identify component here
this.frame.textBox("Center-Area").requireText("North, ");
this.southButtonFixture.requireVisible().requireEnabled().click();
// write our own matcher
JTextComponentFixture centerArea = this.frame.textBox(new GenericTypeMatcher(JTextArea.class, true) {
@Override
protected boolean isMatching(Component component) {
return true;
}
});
centerArea.requireVisible().requireEnabled().requireText("North, South, ");
}
@Override
protected void onTearDown() {
this.northButtonFixture = null;
this.southButtonFixture = null;
}
}
一旦你在项目中有了这样的基本设置，你可能想要查看各种类型的组件匹配器，并可能在各种上面引入一些 setName（）调用。您要测试的组件，以便让您的生活更轻松。
Once you have such a basic setup in your project, you might want to look into the various kinds of component matcher there are and potentially introduce a couple setName() calls on various of your components you want to test, in order to make your life a bit easier.
这篇关于如何开始：使用AssertJ Swing测试Java Swing GUI的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！
