Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use removeAssertJRelatedElementsFromStackTrace method of org.assertj.core.util.Throwables class

Best Assertj code snippet using org.assertj.core.util.Throwables.removeAssertJRelatedElementsFromStackTrace

Source:Failures.java

...47  }48  /**49   * flag indicating whether or not we remove elements related to AssertJ from assertion error stack trace.50   */51  private boolean removeAssertJRelatedElementsFromStackTrace = true;52  /**53   * Sets whether we remove elements related to AssertJ from assertion error stack trace.54   * 55   * @param removeAssertJRelatedElementsFromStackTrace flag56   */57  public void setRemoveAssertJRelatedElementsFromStackTrace(boolean removeAssertJRelatedElementsFromStackTrace) {58	this.removeAssertJRelatedElementsFromStackTrace = removeAssertJRelatedElementsFromStackTrace;59  }60  @VisibleForTesting61  Failures() {62  }63  /**64   * Creates a <code>{@link AssertionError}</code> following this pattern:65   * <ol>66   * <li>creates a <code>{@link AssertionError}</code> using <code>{@link AssertionInfo#overridingErrorMessage()}</code>67   * as the error message if such value is not {@code null}, or</li>68   * <li>uses the given <code>{@link AssertionErrorFactory}</code> to create an <code>{@link AssertionError}</code>,69   * prepending the value of <code>{@link AssertionInfo#description()}</code> to the error message</li>70   * </ol>71   * 72   * @param info contains information about the failed assertion.73   * @param factory knows how to create {@code AssertionError}s.74   * @return the created <code>{@link AssertionError}</code>.75   */76  public AssertionError failure(AssertionInfo info, AssertionErrorFactory factory) {77	AssertionError error = failureIfErrorMessageIsOverridden(info);78	if (error != null) return error;79	printThreadDumpIfNeeded();80	return factory.newAssertionError(info.description(), info.representation());81  }82  /**83   * Creates a <code>{@link AssertionError}</code> following this pattern:84   * <ol>85   * <li>creates a <code>{@link AssertionError}</code> using <code>{@link AssertionInfo#overridingErrorMessage()}</code>86   * as the error message if such value is not {@code null}, or</li>87   * <li>uses the given <code>{@link ErrorMessageFactory}</code> to create the detail message of the88   * <code>{@link AssertionError}</code>, prepending the value of <code>{@link AssertionInfo#description()}</code> to89   * the error message</li>90   * </ol>91   * 92   * @param info contains information about the failed assertion.93   * @param message knows how to create detail messages for {@code AssertionError}s.94   * @return the created <code>{@link AssertionError}</code>.95   */96  public AssertionError failure(AssertionInfo info, ErrorMessageFactory message) {97	AssertionError error = failureIfErrorMessageIsOverridden(info);98	if (error != null) return error;99	AssertionError assertionError = new AssertionError(message.create(info.description(), info.representation()));100	removeAssertJRelatedElementsFromStackTraceIfNeeded(assertionError);101	printThreadDumpIfNeeded();102	return assertionError;103  }104  public AssertionError failureIfErrorMessageIsOverridden(AssertionInfo info) {105	String overridingErrorMessage = info.overridingErrorMessage();106	return isNullOrEmpty(overridingErrorMessage) ? null :107	    failure(MessageFormatter.instance().format(info.description(), info.representation(), overridingErrorMessage));108  }109  /**110   * Creates a <code>{@link AssertionError}</code> using the given {@code String} as message.111   * <p>112   * It filters the AssertionError stack trace be default, to have full stack trace use113   * {@link #setRemoveAssertJRelatedElementsFromStackTrace(boolean)}.114   * 115   * @param message the message of the {@code AssertionError} to create.116   * @return the created <code>{@link AssertionError}</code>.117   */118  public AssertionError failure(String message) {119	AssertionError assertionError = new AssertionError(message);120	removeAssertJRelatedElementsFromStackTraceIfNeeded(assertionError);121	printThreadDumpIfNeeded();122	return assertionError;123  }124  private void printThreadDumpIfNeeded() {125	if (printThreadDump) System.err.println(threadDumpDescription());126  }127/**128   * If is {@link #removeAssertJRelatedElementsFromStackTrace} is true, it filters the stack trace of the given {@link AssertionError} 129   * by removing stack trace elements related to AssertJ in order to get a more readable stack trace.130   * <p>131   * See example below :132   * <pre><code class='java'> --------------- stack trace not filtered -----------------133org.junit.ComparisonFailure: expected:<'[Ronaldo]'> but was:<'[Messi]'>134  at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)135  at sun.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:39)136  at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:27)137  at java.lang.reflect.Constructor.newInstance(Constructor.java:501)138  at org.assertj.core.error.ConstructorInvoker.newInstance(ConstructorInvoker.java:34)139  at org.assertj.core.error.ShouldBeEqual.newComparisonFailure(ShouldBeEqual.java:111)140  at org.assertj.core.error.ShouldBeEqual.comparisonFailure(ShouldBeEqual.java:103)141  at org.assertj.core.error.ShouldBeEqual.newAssertionError(ShouldBeEqual.java:81)142  at org.assertj.core.internal.Failures.failure(Failures.java:76)143  at org.assertj.core.internal.Objects.assertEqual(Objects.java:116)144  at org.assertj.core.api.AbstractAssert.isEqualTo(AbstractAssert.java:74)145  at examples.StackTraceFilterExample.main(StackTraceFilterExample.java:13)146  147--------------- stack trace filtered -----------------148org.junit.ComparisonFailure: expected:<'[Ronaldo]'> but was:<'[Messi]'>149  at sun.reflect.NativeConstructorAccessorImpl.newInstance0(Native Method)150  at sun.reflect.NativeConstructorAccessorImpl.newInstance(NativeConstructorAccessorImpl.java:39)151  at sun.reflect.DelegatingConstructorAccessorImpl.newInstance(DelegatingConstructorAccessorImpl.java:27)152  at examples.StackTraceFilterExample.main(StackTraceFilterExample.java:20)</code></pre>153   * 154   * Method is public because we need to call it from {@link ShouldBeEqual#newAssertionError(Description, org.assertj.core.presentation.Representation)} that is building a junit ComparisonFailure by reflection.155   *  156   * @param assertionError the {@code AssertionError} to filter stack trace if option is set.157   */158  public void removeAssertJRelatedElementsFromStackTraceIfNeeded(AssertionError assertionError) {159	if (removeAssertJRelatedElementsFromStackTrace) {160	  Throwables.removeAssertJRelatedElementsFromStackTrace(assertionError);161	}162  }163  /**164   * Set the flag indicating that in case of a failure a threaddump is printed out.165   */166  public void enablePrintThreadDump() {167	printThreadDump = true;168  }169  private String threadDumpDescription() {170	StringBuilder threadDumpDescription = new StringBuilder();171	ThreadMXBean threadMXBean = ManagementFactory.getThreadMXBean();172	ThreadInfo[] threadInfos = threadMXBean.dumpAllThreads(true, true);173	for (ThreadInfo threadInfo : threadInfos) {174	  threadDumpDescription.append(format("\"%s\"%n\tjava.lang.Thread.State: %s",...