001 /*
002 * Copyright 2008-2015 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.javafx.JavaFXGriffonApplication;
022 import org.codehaus.griffon.runtime.core.DefaultGriffonApplication;
023 import org.codehaus.griffon.runtime.javafx.TestJavaFXGriffonApplication;
024 import org.junit.rules.MethodRule;
025 import org.junit.runners.model.FrameworkMethod;
026 import org.junit.runners.model.Statement;
027 import org.testfx.api.FxToolkit;
028
029 import javax.annotation.Nonnull;
030 import java.util.concurrent.TimeoutException;
031
032 import static com.jayway.awaitility.Awaitility.await;
033 import static griffon.javafx.test.TestContext.getTestContext;
034 import static griffon.util.GriffonNameUtils.requireNonBlank;
035 import static java.util.Objects.requireNonNull;
036
037 /**
038 * A JUnit Rule that starts an application for each test method.
039 *
040 * @author Andres Almiray
041 * @since 2.3.0
042 */
043 public class GriffonTestFXRule extends TestFX implements MethodRule {
044 protected String windowName;
045 protected String[] startupArgs;
046 protected Class<? extends TestJavaFXGriffonApplication> applicationClass;
047
048 public GriffonTestFXRule(@Nonnull String windowName) {
049 this(TestJavaFXGriffonApplication.class, windowName, DefaultGriffonApplication.EMPTY_ARGS);
050 }
051
052 public GriffonTestFXRule(@Nonnull Class<? extends TestJavaFXGriffonApplication> applicationClass, @Nonnull String windowName) {
053 this(applicationClass, windowName, DefaultGriffonApplication.EMPTY_ARGS);
054 }
055
056 public GriffonTestFXRule(@Nonnull Class<? extends TestJavaFXGriffonApplication> applicationClass, @Nonnull String windowName, @Nonnull String[] startupArgs) {
057 this.applicationClass = requireNonNull(applicationClass, "Argument 'applicationClass' must not be null");
058 this.windowName = requireNonBlank(windowName, "Argument 'windowName' cannot be blank");
059 requireNonNull(startupArgs, "Argument 'startupArgs' must not be null");
060 this.startupArgs = new String[startupArgs.length];
061 System.arraycopy(startupArgs, 0, this.startupArgs, 0, startupArgs.length);
062 if (!Environment.isSystemSet()) {
063 System.setProperty(Environment.KEY, Environment.TEST.getName());
064 }
065 }
066
067 @Override
068 public Statement apply(final Statement base, final FrameworkMethod method, final Object target) {
069 initialize(target);
070
071 return new Statement() {
072 @Override
073 public void evaluate() throws Throwable {
074 FxToolkit.registerPrimaryStage();
075
076 JavaFXGriffonApplication application = (JavaFXGriffonApplication) FxToolkit.setupApplication(applicationClass);
077 WindowShownHandler startingWindow = new WindowShownHandler(windowName);
078 application.getEventRouter().addEventListener(ApplicationEvent.WINDOW_SHOWN.getName(), startingWindow);
079 application.getInjector().injectMembers(target);
080
081 await().until(() -> startingWindow.isShowing());
082
083 before(application, target);
084 try {
085 base.evaluate();
086 } finally {
087 after(application, target);
088 }
089 }
090 };
091 }
092
093 protected void initialize(Object target) {
094 getTestContext().setTestCase(target);
095 getTestContext().setWindowName(windowName);
096 }
097
098 protected void before(@Nonnull JavaFXGriffonApplication application, @Nonnull Object target) throws Throwable {
099
100 }
101
102 protected void after(@Nonnull JavaFXGriffonApplication application, @Nonnull Object target) throws TimeoutException {
103 application.shutdown();
104 FxToolkit.cleanupApplication(application);
105 }
106
107 private static class WindowShownHandler implements RunnableWithArgs {
108 private final String windowName;
109 private boolean showing;
110
111 private WindowShownHandler(String windowName) {
112 this.windowName = windowName;
113 }
114
115 public boolean isShowing() {
116 return showing;
117 }
118
119 @Override
120 public void run(Object... args) {
121 if (args != null && args.length > 0 && args[0] instanceof CharSequence) {
122 showing = windowName.equals(String.valueOf(args[0]));
123 }
124 }
125 }
126 }
|