001 /*
002 * Copyright 2008-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016 package griffon.javafx.test;
017
018 import griffon.core.ApplicationEvent;
019 import griffon.core.RunnableWithArgs;
020 import griffon.core.env.Environment;
021 import griffon.exceptions.GriffonException;
022 import griffon.javafx.JavaFXGriffonApplication;
023 import javafx.stage.Window;
024 import org.awaitility.Duration;
025 import org.codehaus.griffon.runtime.core.DefaultGriffonApplication;
026 import org.codehaus.griffon.runtime.javafx.TestJavaFXGriffonApplication;
027 import org.junit.rules.TestRule;
028 import org.junit.runner.Description;
029 import org.junit.runners.model.Statement;
030 import org.testfx.api.FxToolkit;
031
032 import javax.annotation.Nonnull;
033 import javax.annotation.Nullable;
034 import java.util.concurrent.TimeoutException;
035
036 import static griffon.javafx.test.TestContext.getTestContext;
037 import static griffon.util.GriffonNameUtils.requireNonBlank;
038 import static java.util.Objects.requireNonNull;
039 import static java.util.concurrent.TimeUnit.SECONDS;
040 import static org.awaitility.Awaitility.await;
041
042 /**
043 * A JUnit Rule that starts the application once per test class.
044 * Use it in combination with {@code FunctionalJavaFXRunner}.
045 *
046 * @author Andres Almiray
047 * @see griffon.javafx.test.FunctionalJavaFXRunner
048 * @since 2.3.0
049 */
050 public class GriffonTestFXClassRule extends TestFX implements TestRule {
051 protected String windowName;
052 protected Duration timeout;
053 protected String[] startupArgs;
054 protected Class<? extends TestJavaFXGriffonApplication> applicationClass;
055 protected JavaFXGriffonApplication application;
056 private boolean failures = false;
057
058 public GriffonTestFXClassRule(@Nonnull String windowName) {
059 this(TestJavaFXGriffonApplication.class, windowName, new Duration(10, SECONDS), DefaultGriffonApplication.EMPTY_ARGS);
060 }
061
062 public GriffonTestFXClassRule(@Nonnull String windowName, @Nonnull Duration timeout) {
063 this(TestJavaFXGriffonApplication.class, windowName, timeout, DefaultGriffonApplication.EMPTY_ARGS);
064 }
065
066 public GriffonTestFXClassRule(@Nonnull Class<? extends TestJavaFXGriffonApplication> applicationClass, @Nonnull String windowName) {
067 this(applicationClass, windowName, new Duration(10, SECONDS), DefaultGriffonApplication.EMPTY_ARGS);
068 }
069
070 public GriffonTestFXClassRule(@Nonnull Class<? extends TestJavaFXGriffonApplication> applicationClass, @Nonnull String windowName, @Nonnull Duration timeout) {
071 this(applicationClass, windowName, timeout, DefaultGriffonApplication.EMPTY_ARGS);
072 }
073
074 public GriffonTestFXClassRule(@Nonnull Class<? extends TestJavaFXGriffonApplication> applicationClass, @Nonnull String windowName, @Nonnull String[] startupArgs) {
075 this(applicationClass, windowName, new Duration(10, SECONDS), DefaultGriffonApplication.EMPTY_ARGS);
076 }
077
078 public GriffonTestFXClassRule(@Nonnull Class<? extends TestJavaFXGriffonApplication> applicationClass, @Nonnull String windowName, @Nonnull Duration timeout, @Nonnull String[] startupArgs) {
079 this.applicationClass = requireNonNull(applicationClass, "Argument 'applicationClass' must not be null");
080 this.windowName = requireNonBlank(windowName, "Argument 'windowName' cannot be blank");
081 this.timeout = requireNonNull(timeout, "Argument 'timeout' cannot be blank");
082 requireNonNull(startupArgs, "Argument 'startupArgs' must not be null");
083 this.startupArgs = new String[startupArgs.length];
084 System.arraycopy(startupArgs, 0, this.startupArgs, 0, startupArgs.length);
085 if (!Environment.isSystemSet()) {
086 System.setProperty(Environment.KEY, Environment.TEST.getName());
087 }
088 }
089
090 public void setup() {
091 initialize();
092
093 try {
094 FxToolkit.registerPrimaryStage();
095
096 application = (JavaFXGriffonApplication) FxToolkit.setupApplication(applicationClass);
097 WindowShownHandler startingWindow = new WindowShownHandler(windowName);
098 application.getEventRouter().addEventListener(ApplicationEvent.WINDOW_SHOWN.getName(), startingWindow);
099
100 await().timeout(timeout).until(startingWindow::isShowing);
101 } catch (TimeoutException e) {
102 throw new GriffonException("An error occurred while starting up the application", e);
103 }
104 }
105
106 public void cleanup() {
107 if (application != null) {
108 application.shutdown();
109 try {
110 FxToolkit.cleanupApplication(application);
111 } catch (TimeoutException e) {
112 throw new GriffonException("An error occurred while shutting down the application", e);
113 } finally {
114 application = null;
115 }
116 }
117 }
118
119 @Override
120 public Statement apply(Statement base, Description description) {
121 return new Statement() {
122 @Override
123 public void evaluate() throws Throwable {
124 setup();
125 try {
126 base.evaluate();
127 } finally {
128 cleanup();
129 }
130 }
131 };
132 }
133
134 public void injectMembers(@Nonnull Object target) {
135 requireNonNull(target, "Argument 'target' must not be null");
136 application.getInjector().injectMembers(target);
137 }
138
139 public boolean hasFailures() {
140 return failures;
141 }
142
143 public void setFailures(boolean failures) {
144 this.failures = failures;
145 }
146
147 @Nullable
148 public <W extends Window> W managedWindow(@Nonnull String name) {
149 return (W) application.getWindowManager().findWindow(name);
150 }
151
152 protected void initialize() {
153 getTestContext().setWindowName(windowName);
154 }
155
156 private static class WindowShownHandler implements RunnableWithArgs {
157 private final String windowName;
158 private boolean showing;
159
160 private WindowShownHandler(String windowName) {
161 this.windowName = windowName;
162 }
163
164 public boolean isShowing() {
165 return showing;
166 }
167
168 @Override
169 public void run(Object... args) {
170 if (args != null && args.length > 0 && args[0] instanceof CharSequence) {
171 showing = windowName.equals(String.valueOf(args[0]));
172 }
173 }
174 }
175 }
|