cn.taketoday.aot.test.agent.RuntimeHintsInvocationsAssert Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of today-core-test Show documentation
Infra Core Test
There is a newer version: 5.0.0-Draft.1
/*
 * Copyright 2017 - 2023 the original author or authors.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see [http://www.gnu.org/licenses/]
 */

package cn.taketoday.aot.test.agent;

import org.assertj.core.api.AbstractAssert;
import org.assertj.core.api.ListAssert;
import org.assertj.core.error.BasicErrorMessageFactory;
import org.assertj.core.error.ErrorMessageFactory;

import java.util.ArrayList;
import java.util.List;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import java.util.stream.Stream;

import cn.taketoday.aot.agent.RecordedInvocation;
import cn.taketoday.aot.hint.RuntimeHints;
import cn.taketoday.aot.hint.RuntimeHintsRegistrar;
import cn.taketoday.lang.Assert;
import cn.taketoday.lang.TodayStrategies;

/**
 * AssertJ {@link org.assertj.core.api.Assert assertions} that can be applied to
 * {@link RuntimeHintsInvocations}.
 *
 * @author Brian Clozel
 * @author Harry Yang
 * @since 4.0
 */
public class RuntimeHintsInvocationsAssert extends AbstractAssert {

  private final List> configurers = new ArrayList<>();

  RuntimeHintsInvocationsAssert(RuntimeHintsInvocations invocations) {
    super(invocations, RuntimeHintsInvocationsAssert.class);
  }

  public RuntimeHintsInvocationsAssert withRegistrar(RuntimeHintsRegistrar registrar) {
    this.configurers.add(hints -> registrar.registerHints(hints, getClass().getClassLoader()));
    return this;
  }

  public RuntimeHintsInvocationsAssert withStrategiesRegistrars(String location) {
    List registrars = TodayStrategies.forLocation(location).load(RuntimeHintsRegistrar.class);
    this.configurers.add(hints -> registrars.forEach(registrar -> registrar.registerHints(hints, getClass().getClassLoader())));
    return this;
  }

  private void configureRuntimeHints(RuntimeHints hints) {
    this.configurers.forEach(configurer -> configurer.accept(hints));
  }

  /**
   * Verifies that each recorded invocation match at least once hint in the provided {@link RuntimeHints}.
   * 
   * Example: 
   * RuntimeHints hints = new RuntimeHints();
   * hints.reflection().registerType(MyType.class);
   * assertThat(invocations).match(hints); 
   *
   * @param runtimeHints the runtime hints configuration to test against
   * @throws AssertionError if any of the recorded invocations has no match in the provided hints
   */
  public void match(RuntimeHints runtimeHints) {
    Assert.notNull(runtimeHints, "RuntimeHints is required");
    configureRuntimeHints(runtimeHints);
    List noMatchInvocations =
            this.actual.recordedInvocations().filter(invocation -> !invocation.matches(runtimeHints)).toList();
    if (!noMatchInvocations.isEmpty()) {
      throwAssertionError(errorMessageForInvocation(noMatchInvocations.get(0)));
    }
  }

  public ListAssert notMatching(RuntimeHints runtimeHints) {
    Assert.notNull(runtimeHints, "RuntimeHints is required");
    configureRuntimeHints(runtimeHints);
    return ListAssert.assertThatStream(this.actual.recordedInvocations()
            .filter(invocation -> !invocation.matches(runtimeHints)));
  }

  private ErrorMessageFactory errorMessageForInvocation(RecordedInvocation invocation) {
    if (invocation.isStatic()) {
      return new BasicErrorMessageFactory("%nMissing <%s> for invocation <%s>%nwith arguments %s.%nStacktrace:%n<%s>",
              invocation.getHintType().hintClassName(), invocation.getMethodReference(),
              invocation.getArguments(), formatStackTrace(invocation.getStackFrames()));
    }
    else {
      Class instanceType = (invocation.getInstance() instanceof Class clazz) ? clazz : invocation.getInstance().getClass();
      return new BasicErrorMessageFactory("%nMissing <%s> for invocation <%s> on type <%s> %nwith arguments %s.%nStacktrace:%n<%s>",
              invocation.getHintType().hintClassName(), invocation.getMethodReference(),
              instanceType, invocation.getArguments(),
              formatStackTrace(invocation.getStackFrames()));
    }
  }

  private String formatStackTrace(Stream stackTraceElements) {
    return stackTraceElements
            .map(f -> f.getClassName() + "#" + f.getMethodName()
                    + ", Line " + f.getLineNumber()).collect(Collectors.joining(System.lineSeparator()));
  }

  /**
   * Verifies that the count of recorded invocations match the expected one.
   * 
   * Example: 
   * assertThat(invocations).hasCount(42); 
   *
   * @param count the expected invocations count
   * @return {@code this} assertion object.
   * @throws AssertionError if the number of recorded invocations doesn't match the expected one
   */
  public RuntimeHintsInvocationsAssert hasCount(long count) {
    isNotNull();
    long invocationsCount = this.actual.recordedInvocations().count();
    if (invocationsCount != count) {
      throwAssertionError(new BasicErrorMessageFactory("%nNumber of recorded invocations does not match, expected <%n> but got <%n>.",
              invocationsCount, count));
    }
    return this;
  }

}