org.assertj.swing.junit.extension.GUITestExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of assertj-swing-junit-jupiter Show documentation

Assertj-Swing JUnit5 Jupiter extension

The newest version!

/*
 * 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.
 */
package org.assertj.swing.junit.extension;

import org.assertj.swing.junit.runner.FailureScreenshotTaker;
import org.assertj.swing.junit.runner.ImageFolderCreator;
import org.junit.jupiter.api.extension.Extension;
import org.junit.jupiter.api.extension.ExtensionContext;
import org.junit.jupiter.api.extension.InvocationInterceptor;
import org.junit.jupiter.api.extension.ReflectiveInvocationContext;

import java.lang.reflect.Method;

import static org.assertj.swing.annotation.GUITestFinder.isGUITest;
import static org.assertj.swing.junit.runner.Formatter.testNameFrom;

/**
 * Understands a JUnit 5 extension that takes a screenshot of a failed GUI test.
 * The Junit 4 runner is available in {@link org.assertj.swing.junit.runner.GUITestRunner}.
 *
 * @see assertj-swing #259
 * @author William Bakker
 */
public class GUITestExtension implements Extension, InvocationInterceptor {
  private final FailureScreenshotTaker screenshotTaker;

  @SuppressWarnings("unused")
  public GUITestExtension() {
    screenshotTaker = new FailureScreenshotTaker(new ImageFolderCreator().createImageFolder());
  }

  GUITestExtension(FailureScreenshotTaker screenshotTaker) {
    this.screenshotTaker = screenshotTaker;
  }

  @Override
  public void interceptTestMethod(Invocation invocation, ReflectiveInvocationContext invocationContext,
                                  ExtensionContext extensionContext) throws Throwable {
    try {
      invocation.proceed();
    } catch (Throwable t) {
      takeScreenshot(invocationContext.getExecutable());
      throw t;
    }
  }

  private void takeScreenshot(Method method) {
    Class testClass = method.getDeclaringClass();
    if (!(isGUITest(testClass, method))) {
      return;
    }
    screenshotTaker.saveScreenshot(testNameFrom(testClass, method));
  }
}