org.assertj.swing.fixture.package-info Maven / Gradle / Ivy
Show all versions of assertj-swing Show documentation
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*
* Copyright 2012-2018 the original author or authors.
*/
/**
*
* Public API, source of AssertJ-Swing's power and flexibility. Although you can use the
* {@link org.assertj.swing.core.BasicRobot} directly, it is too low-level and requires, in our opinion, too much code.
* AssertJ-Swing fixtures can simplify creation and maintenance of functional GUI tests by:
*
*
*
* - providing reliable lookup of GUI components (by component name or using custom criteria)
* - simulating user events on GUI components
* - providing assertion methods about the state of GUI components
*
*
*
* The following example shows how easy is to use AssertJ-Swing fixtures. The test verifies that an error message is
* displayed if the user enters her username but forgets to enter her password.
*
*
*
* private {@link org.assertj.swing.fixture.FrameFixture} window;
*
* @Before
* public void setUp() {
* window = new FrameFixture(new LoginWindow());
* window.show();
* }
*
* @After
* public void tearDown() {
* window.cleanUp();
* }
*
* @Test
* public void shouldCopyTextInLabelWhenClickingButton() {
* window.textBox("username").enterText("some.user");
* window.button("login").click();
* window.optionPane().requireErrorMessage().requireMessage("Please enter your password");
* }
*
*
*
* The test uses a {@link org.assertj.swing.fixture.FrameFixture} to launch the GUI to test ({@code LoginWindow}) and
* find the GUI components in such window. This is the recommended way to use AssertJ-Swing. We could also use
* individual fixtures to simulate user events, but it would result in more code to write and maintain:
*
*
*
* private {@link org.assertj.swing.core.BasicRobot} robot;
*
* @Before
* public void setUp() {
* robot = BasicRobot.robotWithNewAwtHierarchy();
* robot.showWindow(new LoginWindow());
* }
*
* @After
* public void tearDown() {
* robot.cleanUp();
* }
*
* @Test
* public void shouldCopyTextInLabelWhenClickingButton() {
* new {@link org.assertj.swing.fixture.JTextComponentFixture}(robot, "username").enterText("some.user");
* new {@link org.assertj.swing.fixture.JButtonFixture}(robot, "login").click();
* new {@link org.assertj.swing.fixture.JOptionPaneFixture}(robot).requireErrorMessage().requireMessage("Please enter your password");
* }
*
*
*
* Note: It is very important to clean up resources used by AssertJ-Swing (keyboard, mouse and opened
* windows) after each test; otherwise, the AssertJ-Swing robot will keep control of them and can make your computer
* pretty much unusable. To clean up resources call the method 'cleanUp' from {@link org.assertj.swing.core.BasicRobot},
* {@link org.assertj.swing.fixture.FrameFixture} or {@link org.assertj.swing.fixture.DialogFixture}.
*
*
* Each fixture has the name of the GUI component it can control plus the word "Fixture" at the end. For
* example, {@link org.assertj.swing.fixture.JButtonFixture} can simulate user events on {@code JButton}s.
*
*
* @author Alex Ruiz
*/
package org.assertj.swing.fixture;