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