KaneAI - World’s First E2E Software Testing Agent.Signup for Private Beta Join TestMu Conference

How to use ignoringAllOverriddenEquals method of org.assertj.core.api.RecursiveComparisonAssert class

Best Assertj code snippet using org.assertj.core.api.RecursiveComparisonAssert.ignoringAllOverriddenEquals

Source:RecursiveComparisonConfiguration.java

...215  }216  /**217   * Force a recursive comparison on all fields (except java types).218   * <p>219   * See {@link RecursiveComparisonAssert#ignoringAllOverriddenEquals()} for examples.220   */221  public void ignoreAllOverriddenEquals() {222    ignoreAllOverriddenEquals = true;223  }224  /**225   * Force a recursive comparison on all fields (except java types).226   * <p>227   * See {@link RecursiveComparisonAssert#usingOverriddenEquals()} for examples.228   */229  public void useOverriddenEquals() {230    ignoreAllOverriddenEquals = false;231  }232  /**233   * Adds the given fields to the list of fields to force a recursive comparison on.234   * <p>235   * See {@link RecursiveComparisonAssert#ignoringOverriddenEqualsForFields(String...) RecursiveComparisonAssert#ignoringOverriddenEqualsForFields(String...)} for examples.236   *237   * @param fields the fields to force a recursive comparison on.238   */239  public void ignoreOverriddenEqualsForFields(String... fields) {240    List<String> fieldLocations = list(fields);241    ignoredOverriddenEqualsForFields.addAll(fieldLocations);242  }243  /**244   * Adds the given regexes to the list of regexes used find the fields to force a recursive comparison on.245   * <p>246   * See {@link RecursiveComparisonAssert#ignoringOverriddenEqualsForFieldsMatchingRegexes(String...) RecursiveComparisonAssert#ignoringOverriddenEqualsForFieldsMatchingRegexes(String...)} for examples.247   *248   * @param regexes regexes used to specify the fields we want to force a recursive comparison on.249   */250  public void ignoreOverriddenEqualsForFieldsMatchingRegexes(String... regexes) {251    ignoredOverriddenEqualsForFieldsMatchingRegexes.addAll(Stream.of(regexes)252                                                                 .map(Pattern::compile)253                                                                 .collect(toList()));254  }255  /**256   * Adds the given types to the list of types to force a recursive comparison on.257   * <p>258   * See {@link RecursiveComparisonAssert#ignoringOverriddenEqualsForTypes(Class...) RecursiveComparisonAssert#ignoringOverriddenEqualsForTypes(Class...)} for examples.259   *260   * @param types the types to the list of types to force a recursive comparison on.261   */262  public void ignoreOverriddenEqualsForTypes(Class<?>... types) {263    ignoredOverriddenEqualsForTypes.addAll(list(types));264  }265  @VisibleForTesting266  boolean getIgnoreCollectionOrder() {267    return ignoreCollectionOrder;268  }269  /**270   * Sets whether to ignore collection order in the comparison.271   * <p>272   * See {@link RecursiveComparisonAssert#ignoringCollectionOrder()} for code examples.273   *274   * @param ignoreCollectionOrder whether to ignore collection order in the comparison.275   */276  public void ignoreCollectionOrder(boolean ignoreCollectionOrder) {277    this.ignoreCollectionOrder = ignoreCollectionOrder;278  }279  /**280   * Adds the given fields to the list of the object under test fields to ignore collection order in the recursive comparison.281   * <p>282   * See {@link RecursiveComparisonAssert#ignoringCollectionOrderInFields(String...) RecursiveComparisonAssert#ignoringCollectionOrderInFields(String...)} for examples.283   *284   * @param fieldsToIgnoreCollectionOrder the fields of the object under test to ignore collection order in the comparison.285   */286  public void ignoreCollectionOrderInFields(String... fieldsToIgnoreCollectionOrder) {287    List<String> fieldLocations = list(fieldsToIgnoreCollectionOrder);288    ignoredCollectionOrderInFields.addAll(fieldLocations);289  }290  /**291   * Returns the list of the object under test fields to ignore collection order in the recursive comparison.292   *293   * @return the list of the object under test fields to ignore collection order in the recursive comparison.294   */295  public Set<String> getIgnoredCollectionOrderInFields() {296    return ignoredCollectionOrderInFields;297  }298  /**299   * Adds the given regexes to the list of regexes used to find the object under test fields to ignore collection order in the recursive comparison.300   * <p>301   * See {@link RecursiveComparisonAssert#ignoringCollectionOrderInFieldsMatchingRegexes(String...) RecursiveComparisonAssert#ignoringCollectionOrderInFieldsMatchingRegexes(String...)} for examples.302   *303   * @param regexes regexes used to find the object under test fields to ignore collection order in in the comparison.304   */305  public void ignoreCollectionOrderInFieldsMatchingRegexes(String... regexes) {306    ignoredCollectionOrderInFieldsMatchingRegexes.addAll(Stream.of(regexes)307                                                               .map(Pattern::compile)308                                                               .collect(toList()));309  }310  /**311   * Returns the list of regexes used to find the object under test fields to ignore collection order in the recursive comparison.312   *313   * @return the list of regexes used to find the object under test fields to ignore collection order in the recursive comparison.314   */315  public List<Pattern> getIgnoredCollectionOrderInFieldsMatchingRegexes() {316    return ignoredCollectionOrderInFieldsMatchingRegexes;317  }318  /**319   * Registers the given {@link Comparator} to compare the fields with the given type.320   * <p>321   * Comparators registered with this method have less precedence than comparators registered with {@link #registerComparatorForFields(Comparator, String...)}.322   * <p>323   * Note that registering a {@link Comparator} for a given type will override the previously registered BiPredicate/Comparator (if any).324   * <p>325   * See {@link RecursiveComparisonAssert#withComparatorForType(Comparator, Class)} for examples.326   *327   * @param <T> the class type to register a comparator for328   * @param comparator the {@link java.util.Comparator Comparator} to use to compare the given type329   * @param type the type to be compared with the given comparator.330   * @throws NullPointerException if the given comparator is null.331   */332  public <T> void registerComparatorForType(Comparator<? super T> comparator, Class<T> type) {333    requireNonNull(comparator, "Expecting a non null Comparator");334    typeComparators.put(type, comparator);335  }336  /**337   * Registers the given {@link BiPredicate} to compare the fields with the given type.338   * <p>339   * BiPredicates specified with this method have less precedence than the ones registered with {@link #registerEqualsForFields(BiPredicate, String...)}340   * or comparators registered with {@link #registerComparatorForFields(Comparator, String...)}.341   * <p>342   * Note that registering a {@link BiPredicate} for a given type will override the previously registered BiPredicate/Comparator (if any).343   * <p>344   * See {@link RecursiveComparisonAssert#withEqualsForType(BiPredicate, Class)} for examples.345   *346   * @param <T> the class type to register a comparator for347   * @param equals the equals implementation to compare the given type348   * @param type the type to be compared with the given equals implementation .349   * @throws NullPointerException if the given BiPredicate is null.350   * @since 3.17.0351   */352  @SuppressWarnings("unchecked")353  public <T> void registerEqualsForType(BiPredicate<? super T, ? super T> equals, Class<T> type) {354    registerComparatorForType(toComparator(equals), type);355  }356  /**357   * Registers the given {@link Comparator} to compare the fields at the given locations.358   * <p>359   * The fields must be specified from the root object, for example if {@code Foo} has a {@code Bar} field and both have an {@code id} field,360   * one can register a comparator for Foo and Bar's {@code id} by calling:361   * <pre><code class='java'> registerComparatorForFields(idComparator, "foo.id", "foo.bar.id")</code></pre>362   * <p>363   * Comparators registered with this method have precedence over comparators registered with {@link #registerComparatorForType(Comparator, Class)}.364   * <p>365   * Note that registering a {@link Comparator} for a given field will override the previously registered BiPredicate/Comparator (if any).366   * <p>367   * See {@link RecursiveComparisonAssert#withComparatorForFields(Comparator, String...) RecursiveComparisonAssert#withComparatorForFields(Comparator, String...)} for examples.368   *369   * @param comparator the {@link java.util.Comparator Comparator} to use to compare the given field370   * @param fieldLocations the locations from the root object of the fields the comparator should be used for371   * @throws NullPointerException if the given comparator is null.372   */373  public void registerComparatorForFields(Comparator<?> comparator, String... fieldLocations) {374    requireNonNull(comparator, "Expecting a non null Comparator");375    Stream.of(fieldLocations).forEach(fieldLocation -> fieldComparators.registerComparator(fieldLocation, comparator));376  }377  /**378   * Registers the given {@link BiPredicate} to compare the fields at the given locations.379   * <p>380   * The fields must be specified from the root object, for example if {@code Foo} has a {@code Bar} field and both have an {@code id} field,381   * one can register a BiPredicate for Foo and Bar's {@code id} by calling:382   * <pre><code class='java'> registerEqualsForFields(idBiPredicate, "foo.id", "foo.bar.id")</code></pre>383   * <p>384   * BiPredicates registered with this method have precedence over the ones registered with {@link #registerEqualsForType(BiPredicate, Class)}385   * or the comparators registered with {@link #registerComparatorForType(Comparator, Class)}.386   * <p>387   * Note that registering a {@link BiPredicate} for a given field will override the previously registered BiPredicate/Comparator (if any).388   * <p>389   * See {@link RecursiveComparisonAssert#withEqualsForFields(BiPredicate, String...) RecursiveComparisonAssert#withEqualsForFields(BiPredicate, String...)} for examples.390   *391   * @param equals the equals implementation to compare the given fields.392   * @param fieldLocations the locations from the root object of the fields the comparator should be used for393   * @throws NullPointerException if the given BiPredicate is null.394   * @since 3.17.0395   */396  public void registerEqualsForFields(BiPredicate<?, ?> equals, String... fieldLocations) {397    registerComparatorForFields(toComparator(equals), fieldLocations);398  }399  /**400   * Sets whether the recursive comparison will check that actual's type is compatible with expected's type (the same applies for each field).401   * Compatible means that the expected's type is the same or a subclass of actual's type.402   * <p>403   * See {@link RecursiveComparisonAssert#withStrictTypeChecking()} for code examples.404   *405   * @param strictTypeChecking whether the recursive comparison will check that actual's type is compatible with expected's type.406   */407  public void strictTypeChecking(boolean strictTypeChecking) {408    this.strictTypeChecking = strictTypeChecking;409  }410  public boolean isInStrictTypeCheckingMode() {411    return strictTypeChecking;412  }413  public List<Pattern> getIgnoredFieldsRegexes() {414    return ignoredFieldsRegexes;415  }416  public List<Class<?>> getIgnoredOverriddenEqualsForTypes() {417    return ignoredOverriddenEqualsForTypes;418  }419  public List<String> getIgnoredOverriddenEqualsForFields() {420    return ignoredOverriddenEqualsForFields;421  }422  public List<Pattern> getIgnoredOverriddenEqualsForFieldsMatchingRegexes() {423    return ignoredOverriddenEqualsForFieldsMatchingRegexes;424  }425  public Stream<Entry<String, Comparator<?>>> comparatorByFields() {426    return fieldComparators.comparatorByFields();427  }428  @Override429  public String toString() {430    return multiLineDescription(CONFIGURATION_PROVIDER.representation());431  }432  @Override433  public int hashCode() {434    return java.util.Objects.hash(fieldComparators, ignoreAllActualEmptyOptionalFields, ignoreAllActualNullFields,435                                  ignoreAllExpectedNullFields, ignoreAllOverriddenEquals, ignoreCollectionOrder,436                                  ignoredCollectionOrderInFields, ignoredCollectionOrderInFieldsMatchingRegexes, ignoredFields,437                                  ignoredFieldsRegexes, ignoredOverriddenEqualsForFields, ignoredOverriddenEqualsForTypes,438                                  ignoredOverriddenEqualsForFieldsMatchingRegexes, ignoredTypes, strictTypeChecking,439                                  typeComparators);440  }441  @Override442  public boolean equals(Object obj) {443    if (this == obj) return true;444    if (obj == null) return false;445    if (getClass() != obj.getClass()) return false;446    RecursiveComparisonConfiguration other = (RecursiveComparisonConfiguration) obj;447    return java.util.Objects.equals(fieldComparators, other.fieldComparators)448           && ignoreAllActualEmptyOptionalFields == other.ignoreAllActualEmptyOptionalFields449           && ignoreAllActualNullFields == other.ignoreAllActualNullFields450           && ignoreAllExpectedNullFields == other.ignoreAllExpectedNullFields451           && ignoreAllOverriddenEquals == other.ignoreAllOverriddenEquals452           && ignoreCollectionOrder == other.ignoreCollectionOrder453           && java.util.Objects.equals(ignoredCollectionOrderInFields, other.ignoredCollectionOrderInFields)454           && java.util.Objects.equals(ignoredFields, other.ignoredFields)455           && java.util.Objects.equals(ignoredFieldsRegexes, other.ignoredFieldsRegexes)456           && java.util.Objects.equals(ignoredOverriddenEqualsForFields, other.ignoredOverriddenEqualsForFields)457           && java.util.Objects.equals(ignoredOverriddenEqualsForTypes, other.ignoredOverriddenEqualsForTypes)458           && java.util.Objects.equals(ignoredOverriddenEqualsForFieldsMatchingRegexes,459                                       other.ignoredOverriddenEqualsForFieldsMatchingRegexes)460           && java.util.Objects.equals(ignoredTypes, other.ignoredTypes) && strictTypeChecking == other.strictTypeChecking461           && java.util.Objects.equals(typeComparators, other.typeComparators)462           && java.util.Objects.equals(ignoredCollectionOrderInFieldsMatchingRegexes,463                                       other.ignoredCollectionOrderInFieldsMatchingRegexes);464  }465  public String multiLineDescription(Representation representation) {466    StringBuilder description = new StringBuilder();467    describeIgnoreAllActualNullFields(description);468    describeIgnoreAllActualEmptyOptionalFields(description);469    describeIgnoreAllExpectedNullFields(description);470    describeIgnoredFields(description);471    describeIgnoredFieldsRegexes(description);472    describeIgnoredFieldsForTypes(description);473    describeOverriddenEqualsMethodsUsage(description, representation);474    describeIgnoreCollectionOrder(description);475    describeIgnoredCollectionOrderInFields(description);476    describeIgnoredCollectionOrderInFieldsMatchingRegexes(description);477    describeRegisteredComparatorByTypes(description);478    describeRegisteredComparatorForFields(description);479    describeTypeCheckingStrictness(description);480    return description.toString();481  }482  boolean shouldIgnore(DualValue dualValue) {483    FieldLocation fieldLocation = dualValue.fieldLocation;484    return matchesAnIgnoredField(fieldLocation)485           || matchesAnIgnoredFieldRegex(fieldLocation)486           || shouldIgnoreFieldBasedOnFieldValue(dualValue);487  }488  Set<String> getNonIgnoredActualFieldNames(DualValue dualValue) {489    Set<String> actualFieldsNames = Objects.getFieldsNames(dualValue.actual.getClass());490    // we are doing the same as shouldIgnore(DualValue dualValue) but in two steps for performance reasons:491    // - we filter first ignored field by names that don't need building DualValues492    // - then we filter field DualValues with the remaining criteria that need to get the field value493    // DualValues are built introspecting fields which is expensive.494    return actualFieldsNames.stream()495                            // evaluate field name ignoring criteria on dualValue field location + field name496                            .filter(fieldName -> !shouldIgnoreFieldBasedOnFieldLocation(dualValue.fieldLocation.field(fieldName)))497                            .map(fieldName -> dualValueForField(dualValue, fieldName))498                            // evaluate field value ignoring criteria499                            .filter(fieldDualValue -> !shouldIgnoreFieldBasedOnFieldValue(fieldDualValue))500                            // back to field name501                            .map(DualValue::getFieldName)502                            .filter(fieldName -> !fieldName.isEmpty())503                            .collect(toSet());504  }505  // non accessible stuff506  private boolean shouldIgnoreFieldBasedOnFieldValue(DualValue dualValue) {507    return matchesAnIgnoredNullField(dualValue)508           || matchesAnIgnoredFieldType(dualValue)509           || matchesAnIgnoredEmptyOptionalField(dualValue);510  }511  private boolean shouldIgnoreFieldBasedOnFieldLocation(FieldLocation fieldLocation) {512    return matchesAnIgnoredField(fieldLocation) || matchesAnIgnoredFieldRegex(fieldLocation);513  }514  private static DualValue dualValueForField(DualValue parentDualValue, String fieldName) {515    Object actualFieldValue = COMPARISON.getSimpleValue(fieldName, parentDualValue.actual);516    // no guarantees we have a field in expected named as fieldName517    Object expectedFieldValue;518    try {519      expectedFieldValue = COMPARISON.getSimpleValue(fieldName, parentDualValue.expected);520    } catch (@SuppressWarnings("unused") Exception e) {521      // set the field to null to express it is absent, this not 100% accurate as the value could be null522      // but it works to evaluate if dualValue should be ignored with matchesAnIgnoredFieldType523      expectedFieldValue = null;524    }525    FieldLocation fieldLocation = parentDualValue.fieldLocation.field(fieldName);526    return new DualValue(fieldLocation, actualFieldValue, expectedFieldValue);527  }528  boolean hasCustomComparator(DualValue dualValue) {529    String fieldName = dualValue.getConcatenatedPath();530    if (hasComparatorForField(fieldName)) return true;531    if (dualValue.actual == null && dualValue.expected == null) return false;532    // best effort assuming actual and expected have the same type (not 100% true as we can compare object of differennt types)533    Class<?> valueType = dualValue.actual != null ? dualValue.actual.getClass() : dualValue.expected.getClass();534    return hasComparatorForType(valueType);535  }536  boolean shouldIgnoreOverriddenEqualsOf(DualValue dualValue) {537    // we must compare java basic types otherwise the recursive comparison loops infinitely!538    if (dualValue.isActualJavaType()) return false;539    // enums don't have fields, comparing them field by field has no sense, we need to use equals which is overridden and final540    if (dualValue.isActualAnEnum()) return false;541    return ignoreAllOverriddenEquals542           || matchesAnIgnoredOverriddenEqualsField(dualValue.fieldLocation)543           || (dualValue.actual != null && shouldIgnoreOverriddenEqualsOf(dualValue.actual.getClass()));544  }545  @VisibleForTesting546  boolean shouldIgnoreOverriddenEqualsOf(Class<? extends Object> clazz) {547    return matchesAnIgnoredOverriddenEqualsRegex(clazz) || matchesAnIgnoredOverriddenEqualsType(clazz);548  }549  boolean shouldIgnoreCollectionOrder(FieldLocation fieldLocation) {550    return ignoreCollectionOrder551           || matchesAnIgnoredCollectionOrderInField(fieldLocation)552           || matchesAnIgnoredCollectionOrderInFieldRegex(fieldLocation);553  }554  private void describeIgnoredFieldsRegexes(StringBuilder description) {555    if (!ignoredFieldsRegexes.isEmpty())556      description.append(format("- the fields matching the following regexes were ignored in the comparison: %s%n",557                                describeRegexes(ignoredFieldsRegexes)));558  }559  private void describeIgnoredFields(StringBuilder description) {560    if (!ignoredFields.isEmpty())561      description.append(format("- the following fields were ignored in the comparison: %s%n", describeIgnoredFields()));562  }563  private void describeIgnoredFieldsForTypes(StringBuilder description) {564    if (!ignoredTypes.isEmpty())565      description.append(format("- the following types were ignored in the comparison: %s%n", describeIgnoredTypes()));566  }567  private void describeIgnoreAllActualNullFields(StringBuilder description) {568    if (ignoreAllActualNullFields) description.append(format("- all actual null fields were ignored in the comparison%n"));569  }570  private void describeIgnoreAllActualEmptyOptionalFields(StringBuilder description) {571    if (getIgnoreAllActualEmptyOptionalFields())572      description.append(format("- all actual empty optional fields were ignored in the comparison (including Optional, OptionalInt, OptionalLong and OptionalDouble)%n"));573  }574  private void describeIgnoreAllExpectedNullFields(StringBuilder description) {575    if (ignoreAllExpectedNullFields) description.append(format("- all expected null fields were ignored in the comparison%n"));576  }577  private void describeOverriddenEqualsMethodsUsage(StringBuilder description, Representation representation) {578    String header = ignoreAllOverriddenEquals579        ? "- no overridden equals methods were used in the comparison (except for java types)"580        : "- overridden equals methods were used in the comparison";581    description.append(header);582    if (isConfiguredToIgnoreSomeButNotAllOverriddenEqualsMethods()) {583      description.append(format(" except for:%n"));584      describeIgnoredOverriddenEqualsMethods(description, representation);585    } else {586      description.append(format("%n"));587    }588  }589  private void describeIgnoredOverriddenEqualsMethods(StringBuilder description, Representation representation) {590    if (!ignoredOverriddenEqualsForFields.isEmpty())591      description.append(format("%s the following fields: %s%n", INDENT_LEVEL_2,592                                describeIgnoredOverriddenEqualsForFields()));593    if (!ignoredOverriddenEqualsForTypes.isEmpty())594      description.append(format("%s the following types: %s%n", INDENT_LEVEL_2,595                                describeIgnoredOverriddenEqualsForTypes(representation)));596    if (!ignoredOverriddenEqualsForFieldsMatchingRegexes.isEmpty())597      description.append(format("%s the types matching the following regexes: %s%n", INDENT_LEVEL_2,598                                describeRegexes(ignoredOverriddenEqualsForFieldsMatchingRegexes)));599  }600  private String describeIgnoredOverriddenEqualsForTypes(Representation representation) {601    List<String> fieldsDescription = ignoredOverriddenEqualsForTypes.stream()602                                                                    .map(representation::toStringOf)603                                                                    .collect(toList());604    return join(fieldsDescription).with(", ");605  }606  private String describeIgnoredOverriddenEqualsForFields() {607    return join(ignoredOverriddenEqualsForFields).with(", ");608  }609  private void describeIgnoreCollectionOrder(StringBuilder description) {610    if (ignoreCollectionOrder) description.append(format("- collection order was ignored in all fields in the comparison%n"));611  }612  private void describeIgnoredCollectionOrderInFields(StringBuilder description) {613    if (!ignoredCollectionOrderInFields.isEmpty())614      description.append(format("- collection order was ignored in the following fields in the comparison: %s%n",615                                describeIgnoredCollectionOrderInFields()));616  }617  private void describeIgnoredCollectionOrderInFieldsMatchingRegexes(StringBuilder description) {618    if (!ignoredCollectionOrderInFieldsMatchingRegexes.isEmpty())619      description.append(format("- collection order was ignored in the fields matching the following regexes in the comparison: %s%n",620                                describeRegexes(ignoredCollectionOrderInFieldsMatchingRegexes)));621  }622  private boolean matchesAnIgnoredOverriddenEqualsRegex(Class<?> clazz) {623    if (ignoredOverriddenEqualsForFieldsMatchingRegexes.isEmpty()) return false; // shortcut624    String canonicalName = clazz.getCanonicalName();625    return ignoredOverriddenEqualsForFieldsMatchingRegexes.stream()626                                                          .anyMatch(regex -> regex.matcher(canonicalName).matches());627  }628  private boolean matchesAnIgnoredOverriddenEqualsType(Class<?> clazz) {629    return ignoredOverriddenEqualsForTypes.contains(clazz);630  }631  private boolean matchesAnIgnoredOverriddenEqualsField(FieldLocation fieldLocation) {632    return ignoredOverriddenEqualsForFields.stream().anyMatch(fieldLocation::matches);633  }634  private boolean matchesAnIgnoredNullField(DualValue dualValue) {635    return (ignoreAllActualNullFields && dualValue.actual == null)636           || (ignoreAllExpectedNullFields && dualValue.expected == null);637  }638  private boolean matchesAnIgnoredEmptyOptionalField(DualValue dualValue) {639    return ignoreAllActualEmptyOptionalFields640           && dualValue.isActualFieldAnEmptyOptionalOfAnyType();641  }642  private boolean matchesAnIgnoredFieldRegex(FieldLocation fieldLocation) {643    return ignoredFieldsRegexes.stream()644                               .anyMatch(regex -> regex.matcher(fieldLocation.getPathToUseInRules()).matches());645  }646  private boolean matchesAnIgnoredFieldType(DualValue dualValue) {647    Object actual = dualValue.actual;648    if (actual != null) return ignoredTypes.contains(actual.getClass());649    Object expected = dualValue.expected;650    // actual is null => we can't evaluate its type, we can only reliably check dualValue.expected's type if651    // strictTypeChecking is enabled which guarantees expected is of the same type.652    if (strictTypeChecking && expected != null) return ignoredTypes.contains(expected.getClass());653    // if strictTypeChecking is disabled, we can't safely ignore the field (if we did, we would ignore all null fields!).654    return false;655  }656  private boolean matchesAnIgnoredField(FieldLocation fieldLocation) {657    return ignoredFields.stream().anyMatch(fieldLocation::matches);658  }659  private boolean matchesAnIgnoredCollectionOrderInField(FieldLocation fieldLocation) {660    return ignoredCollectionOrderInFields.stream().anyMatch(fieldLocation::matches);661  }662  private boolean matchesAnIgnoredCollectionOrderInFieldRegex(FieldLocation fieldLocation) {663    String pathToUseInRules = fieldLocation.getPathToUseInRules();664    return ignoredCollectionOrderInFieldsMatchingRegexes.stream().anyMatch(regex -> regex.matcher(pathToUseInRules).matches());665  }666  private String describeIgnoredFields() {667    return join(ignoredFields).with(", ");668  }669  private String describeIgnoredTypes() {670    List<String> typesDescription = ignoredTypes.stream()671                                                .map(Class::getName)672                                                .collect(toList());673    return join(typesDescription).with(", ");674  }675  private String describeIgnoredCollectionOrderInFields() {676    return join(ignoredCollectionOrderInFields).with(", ");677  }678  private String describeRegexes(List<Pattern> regexes) {679    List<String> fieldsDescription = regexes.stream()680                                            .map(Pattern::pattern)681                                            .collect(toList());682    return join(fieldsDescription).with(", ");683  }684  private boolean isConfiguredToIgnoreSomeButNotAllOverriddenEqualsMethods() {685    boolean ignoreSomeOverriddenEqualsMethods = !ignoredOverriddenEqualsForFieldsMatchingRegexes.isEmpty()686                                                || !ignoredOverriddenEqualsForTypes.isEmpty()687                                                || !ignoredOverriddenEqualsForFields.isEmpty();688    return !ignoreAllOverriddenEquals && ignoreSomeOverriddenEqualsMethods;689  }690  private void describeRegisteredComparatorByTypes(StringBuilder description) {691    if (!typeComparators.isEmpty()) {692      description.append(format("- these types were compared with the following comparators:%n"));693      describeComparatorForTypes(description);694    }695  }696  private void describeComparatorForTypes(StringBuilder description) {697    typeComparators.comparatorByTypes()698                   .map(this::formatRegisteredComparatorByType)699                   .forEach(description::append);700  }701  private String formatRegisteredComparatorByType(Entry<Class<?>, Comparator<?>> next) {702    return format("%s %s -> %s%n", INDENT_LEVEL_2, next.getKey().getName(), next.getValue());703  }704  private void describeRegisteredComparatorForFields(StringBuilder description) {705    if (!fieldComparators.isEmpty()) {706      description.append(format("- these fields were compared with the following comparators:%n"));707      describeComparatorForFields(description);708      if (!typeComparators.isEmpty()) {709        description.append(format("- field comparators take precedence over type comparators.%n"));710      }711    }712  }713  private void describeComparatorForFields(StringBuilder description) {714    fieldComparators.comparatorByFields()715                    .map(this::formatRegisteredComparatorForField)716                    .forEach(description::append);717  }718  private String formatRegisteredComparatorForField(Entry<String, Comparator<?>> comparatorForField) {719    return format("%s %s -> %s%n", INDENT_LEVEL_2, comparatorForField.getKey(), comparatorForField.getValue());720  }721  private void describeTypeCheckingStrictness(StringBuilder description) {722    String str = strictTypeChecking723        ? "- actual and expected objects and their fields were considered different when of incompatible types (i.e. expected type does not extend actual's type) even if all their fields match, for example a Person instance will never match a PersonDto (call strictTypeChecking(false) to change that behavior).%n"724        : "- actual and expected objects and their fields were compared field by field recursively even if they were not of the same type, this allows for example to compare a Person to a PersonDto (call strictTypeChecking(true) to change that behavior).%n";725    description.append(format(str));726  }727  /**728   * Creates builder to build {@link RecursiveComparisonConfiguration}.729   * @return created builder730   */731  public static Builder builder() {732    return new Builder();733  }734  /**735   * Builder to build {@link RecursiveComparisonConfiguration}.736   */737  public static final class Builder {738    private boolean strictTypeChecking;739    private boolean ignoreAllActualNullFields;740    private boolean ignoreAllActualEmptyOptionalFields;741    private boolean ignoreAllExpectedNullFields;742    private String[] ignoredFields = {};743    private String[] ignoredFieldsMatchingRegexes = {};744    private Class<?>[] ignoredTypes = {};745    private Class<?>[] ignoredOverriddenEqualsForTypes = {};746    private String[] ignoredOverriddenEqualsForFields = {};747    private String[] ignoredOverriddenEqualsForFieldsMatchingRegexes = {};748    private boolean ignoreAllOverriddenEquals;749    private boolean ignoreCollectionOrder;750    private String[] ignoredCollectionOrderInFields = {};751    private String[] ignoredCollectionOrderInFieldsMatchingRegexes = {};752    private TypeComparators typeComparators = new TypeComparators();753    private FieldComparators fieldComparators = new FieldComparators();754    private Builder() {}755    /**756     * Sets whether the recursive comparison will check that actual's type is compatible with expected's type (the same applies for each field).757     * Compatible means that the expected's type is the same or a subclass of actual's type.758     * <p>759     * See {@link RecursiveComparisonAssert#withStrictTypeChecking()} for code examples.760     *761     * @param strictTypeChecking whether the recursive comparison will check that actual's type is compatible with expected's type.762     * @return this builder.763     */764    public Builder withStrictTypeChecking(boolean strictTypeChecking) {765      this.strictTypeChecking = strictTypeChecking;766      return this;767    }768    /**769     * Sets whether actual null fields are ignored in the recursive comparison.770     * <p>771     * See {@link RecursiveComparisonAssert#ignoringActualNullFields()} for code examples.772     *773     * @param ignoreAllActualNullFields whether to ignore actual null fields in the recursive comparison774     * @return this builder.775     */776    public Builder withIgnoreAllActualNullFields(boolean ignoreAllActualNullFields) {777      this.ignoreAllActualNullFields = ignoreAllActualNullFields;778      return this;779    }780    /**781     * Sets whether actual empty optional fields are ignored in the recursive comparison.782     * <p>783     * See {@link RecursiveComparisonAssert#ignoringActualEmptyOptionalFields()} for code examples.784     *785     * @param ignoreAllActualEmptyOptionalFields whether to ignore actual empty optional fields in the recursive comparison786     * @return this builder.787     */788    public Builder withIgnoreAllActualEmptyOptionalFields(boolean ignoreAllActualEmptyOptionalFields) {789      this.ignoreAllActualEmptyOptionalFields = ignoreAllActualEmptyOptionalFields;790      return this;791    }792    /**793     * Sets whether expected null fields are ignored in the recursive comparison.794     * <p>795     * See {@link RecursiveComparisonAssert#ignoringExpectedNullFields()} for code examples.796     *797     * @param ignoreAllExpectedNullFields whether to ignore expected null fields in the recursive comparison798     * @return this builder.799     */800    public Builder withIgnoreAllExpectedNullFields(boolean ignoreAllExpectedNullFields) {801      this.ignoreAllExpectedNullFields = ignoreAllExpectedNullFields;802      return this;803    }804    /**805     * Adds the given fields to the list of the object under test fields to ignore in the recursive comparison. Nested fields can be specified like this: home.address.street.806     * <p>807     * See {@link RecursiveComparisonAssert#ignoringFields(String...) RecursiveComparisonAssert#ignoringFields(String...)} for examples.808     *809     * @param fieldsToIgnore the fields of the object under test to ignore in the comparison.810     * @return this builder.811     */812    public Builder withIgnoredFields(String... fieldsToIgnore) {813      this.ignoredFields = fieldsToIgnore;814      return this;815    }816    /**817     * Allows to ignore in the recursive comparison the object under test fields matching the given regexes. The given regexes are added to the already registered ones.818     * <p>819     * See {@link RecursiveComparisonAssert#ignoringFieldsMatchingRegexes(String...) RecursiveComparisonAssert#ignoringFieldsMatchingRegexes(String...)} for examples.820     *821     * @param regexes regexes used to ignore fields in the comparison.822     * @return this builder.823     */824    public Builder withIgnoredFieldsMatchingRegexes(String... regexes) {825      this.ignoredFieldsMatchingRegexes = regexes;826      return this;827    }828    /**829     * Adds the given types to the list of the object under test fields types to ignore in the recursive comparison.830     * The fields are ignored if their types exactly match one of the ignored types, if a field is a subtype of an ignored type it won't be ignored.831     * <p>832     * Note that if some object under test fields are null, they are not ignored by this method as their type can't be evaluated.833     * <p>834     * See {@link RecursiveComparisonAssert#ignoringFields(String...) RecursiveComparisonAssert#ignoringFieldsOfTypes(Class...)} for examples.835     *836     * @param types the types of the object under test to ignore in the comparison.837     * @return this builder.838     */839    public Builder withIgnoredFieldsOfTypes(Class<?>... types) {840      this.ignoredTypes = types;841      return this;842    }843    /**844     * Adds the given types to the list of types to force a recursive comparison on.845     * <p>846     * See {@link RecursiveComparisonAssert#ignoringOverriddenEqualsForTypes(Class...) RecursiveComparisonAssert#ignoringOverriddenEqualsForTypes(Class...)} for examples.847     *848     * @param types the types to the list of types to force a recursive comparison on.849     * @return this builder.850     */851    public Builder withIgnoredOverriddenEqualsForTypes(Class<?>... types) {852      this.ignoredOverriddenEqualsForTypes = types;853      return this;854    }855    /**856     * Adds the given fields to the list of fields to force a recursive comparison on.857     * <p>858     * See {@link RecursiveComparisonAssert#ignoringOverriddenEqualsForFields(String...) RecursiveComparisonAssert#ignoringOverriddenEqualsForFields(String...)} for examples.859     *860     * @param fields the fields to force a recursive comparison on.861     * @return this builder.862     */863    public Builder withIgnoredOverriddenEqualsForFields(String... fields) {864      this.ignoredOverriddenEqualsForFields = fields;865      return this;866    }867    /**868     * Adds the given regexes to the list of regexes used find the fields to force a recursive comparison on.869     * <p>870     * See {@link RecursiveComparisonAssert#ignoringOverriddenEqualsForFieldsMatchingRegexes(String...) RecursiveComparisonAssert#ignoringOverriddenEqualsForFieldsMatchingRegexes(String...)} for examples.871     *872     * @param regexes regexes used to specify the fields we want to force a recursive comparison on.873     * @return this builder.874     */875    public Builder withIgnoredOverriddenEqualsForFieldsMatchingRegexes(String... regexes) {876      this.ignoredOverriddenEqualsForFieldsMatchingRegexes = regexes;877      return this;878    }879    /**880     * Force a recursive comparison on all fields (except java types) if true.881     * <p>882     * See {@link RecursiveComparisonAssert#ignoringAllOverriddenEquals()} for examples.883     *884     * @param ignoreAllOverriddenEquals whether to force a recursive comparison on all fields (except java types) or not.885     * @return this builder.886     */887    public Builder withIgnoreAllOverriddenEquals(boolean ignoreAllOverriddenEquals) {888      this.ignoreAllOverriddenEquals = ignoreAllOverriddenEquals;889      return this;890    }891    /**892     * Sets whether to ignore collection order in the comparison.893     * <p>894     * See {@link RecursiveComparisonAssert#ignoringCollectionOrder()} for code examples.895     *896     * @param ignoreCollectionOrder whether to ignore collection order in the comparison....

Source:RecursiveComparisonAssert.java

...76   * <ol>77   * <li> {@link #ignoringOverriddenEqualsForTypes(Class...)} Any fields of these classes are compared recursively</li>78   * <li> {@link #ignoringOverriddenEqualsForFields(String...)} Any given fields are compared recursively</li>79   * <li> {@link #ignoringOverriddenEqualsForFieldsMatchingRegexes(String...)} Any fields matching one of these regexes are compared recursively</li>80   * <li> {@link #ignoringAllOverriddenEquals()} except for java types, all fields are compared field by field recursively.</li>81   * </ol>82   * <strong>Recursive comparison and cycles</strong>83   * <p>84   * The recursive comparison handles cycles.85   * <p>86   * <strong>Comparator used in the recursive comparison</strong>87   * <p>88   * By default {@code floats} are compared with a precision of 1.0E-6 and {@code doubles} with 1.0E-15.89   * <p>90   * You can specify a custom comparator or equals BiPredicate per (nested) fields or type with the methods below (but before calling {@code isEqualTo} otherwise this has no effect!):91   * <ol>92   * <li> {@link #withEqualsForType(BiPredicate, Class)} for a given type</li>93   * <li> {@link #withComparatorForType(Comparator, Class)} for a given type</li>94   * <li> {@link #withComparatorForFields(Comparator, String...) withComparatorForFields(Comparator, String...)} for one or multiple fields</li>95   * <li> {@link #withComparatorForFields(Comparator, String...) withComparatorForFields(Comparator, String...)} for one or multiple fields</li>96   * </ol>97   * <p>98   * Note that field comparators always take precedence over type comparators.99   * <p>100   * <strong>Example</strong>101   * <p>102   * Here is a basic example with a default {@link RecursiveComparisonConfiguration}, you can find other examples for each of the method changing the recursive comparison behavior103   * like {@link #ignoringFields(String...)}.104   * <pre><code class='java'> public class Person {105   *   String name;106   *   double height;107   *   Home home = new Home();108   * }109   *110   * public class Home {111   *   Address address = new Address();112   *   Date ownedSince;113   * }114   *115   * public static class Address {116   *   int number;117   *   String street;118   * }119   *120   * Person sherlock = new Person("Sherlock", 1.80);121   * sherlock.home.ownedSince = new Date(123);122   * sherlock.home.address.street = "Baker Street";123   * sherlock.home.address.number = 221;124   *125   * Person sherlock2 = new Person("Sherlock", 1.80);126   * sherlock2.home.ownedSince = new Date(123);127   * sherlock2.home.address.street = "Baker Street";128   * sherlock2.home.address.number = 221;129   *130   * // assertion succeeds as the data of both objects are the same.131   * assertThat(sherlock).usingRecursiveComparison()132   *                     .isEqualTo(sherlock2);</code></pre>133   *134   * @param expected the object to compare {@code actual} to.135   * @return {@code this} assertion object.136   * @throws AssertionError if the actual object is {@code null}.137   * @throws AssertionError if the actual and the given objects are not deeply equal property/field by property/field.138   * @throws IntrospectionError if one property/field to compare can not be found.139   */140  @Override141  public SELF isEqualTo(Object expected) {142    // deals with both actual and expected being null143    if (actual == expected) return myself;144    if (expected == null) {145      // for the assertion to pass, actual must be null but this is not the case since actual != expected146      // => we fail expecting actual to be null147      objects.assertNull(info, actual);148    }149    // at this point expected is not null, which means actual must not be null for the assertion to pass150    objects.assertNotNull(info, actual);151    // at this point both actual and expected are not null, we can compare them recursively!152    List<ComparisonDifference> differences = determineDifferencesWith(expected);153    if (!differences.isEmpty()) throw objects.getFailures().failure(info, shouldBeEqualByComparingFieldByFieldRecursively(actual,154                                                                                                                          expected,155                                                                                                                          differences,156                                                                                                                          recursiveComparisonConfiguration,157                                                                                                                          info.representation()));158    return myself;159  }160  /**161   * Asserts that actual object is not equal to the given object based on a recursive property/field by property/field comparison162   * (including inherited ones).163   * <p>164   * This is typically useful when actual's {@code equals} was not overridden.165   * <p>166   * The comparison is <b>not symmetrical</b> since it is <b>limited to actual's fields</b>, the algorithm gather all167   * actual's fields and then compare them to the corresponding expected's fields.<br>168   * It is then possible for the expected object to have more fields than actual which is handy when comparing169   * a base type to a subtype.170   * <p>171   * This method is based on {@link #isEqualTo(Object)}, you can check out more usages in that method.172   * <p>173   * Example174   * <pre><code class='java'> // equals not overridden in TolkienCharacter175   * TolkienCharacter frodo = new TolkienCharacter("Frodo", 33, HOBBIT);176   * TolkienCharacter frodoClone = new TolkienCharacter("Frodo", 33, HOBBIT);177   * TolkienCharacter youngFrodo = new TolkienCharacter("Frodo", 22, HOBBIT);178   *179   * // Pass as equals compares object references180   * assertThat(frodo).isNotEqualTo(frodoClone);181   *182   * // Fail as frodo and frodoClone are equals when doing a field by field comparison.183   * assertThat(frodo).usingRecursiveComparison()184   *                  .isNotEqualTo(frodoClone);185   *186   * // Pass as one the age fields differ between frodo and youngFrodo.187   * assertThat(frodo).usingRecursiveComparison()188   *                  .isNotEqualTo(youngFrodo);</code></pre>189   *190   * @param other the object to compare {@code actual} to.191   * @return {@code this} assertions object192   * @throws AssertionError if the actual object and the given objects are both {@code null}.193   * @throws AssertionError if the actual and the given objects are equals property/field by property/field recursively.194   * @see #isEqualTo(Object)195   * @since 3.17.0196   */197  @Override198  public SELF isNotEqualTo(Object other) {199    if (actual == other) throw objects.getFailures().failure(info,200                                                             shouldNotBeEqualComparingFieldByFieldRecursively(actual, other,201                                                                                                              recursiveComparisonConfiguration,202                                                                                                              info.representation()));203    if (other != null && actual != null) {204      List<ComparisonDifference> differences = determineDifferencesWith(other);205      if (differences.isEmpty())206        throw objects.getFailures().failure(info,207                                            shouldNotBeEqualComparingFieldByFieldRecursively(actual, other,208                                                                                             recursiveComparisonConfiguration,209                                                                                             info.representation()));210    }211    // either one of actual or other was null (but not both) or there were no differences212    return myself;213  }214  /**215   * Makes the recursive comparison to ignore all <b>actual null fields</b> (but note that the expected object null fields are used in the comparison).216   * <p>217   * Example:218   * <pre><code class='java'> public class Person {219   *   String name;220   *   double height;221   *   Home home = new Home();222   * }223   *224   * public class Home {225   *   Address address = new Address();226   * }227   *228   * public static class Address {229   *   int number;230   *   String street;231   * }232   *233   * Person noName = new Person(null, 1.80);234   * noName.home.address.street = null;235   * noName.home.address.number = 221;236   *237   * Person sherlock = new Person("Sherlock", 1.80);238   * sherlock.home.address.street = "Baker Street";239   * sherlock.home.address.number = 221;240   *241   * // assertion succeeds as name and home.address.street fields are ignored in the comparison242   * assertThat(noName).usingRecursiveComparison()243   *                   .ignoringActualNullFields()244   *                   .isEqualTo(sherlock);245   *246   * // assertion fails as name and home.address.street fields are populated for sherlock but not for noName.247   * assertThat(sherlock).usingRecursiveComparison()248   *                     .ignoringActualNullFields()249   *                     .isEqualTo(noName);</code></pre>250   *251   * @return this {@link RecursiveComparisonAssert} to chain other methods.252   */253  @CheckReturnValue254  public SELF ignoringActualNullFields() {255    recursiveComparisonConfiguration.setIgnoreAllActualNullFields(true);256    return myself;257  }258  /**259   * Makes the recursive comparison to ignore all <b>actual empty optional fields</b> (including {@link Optional}, {@link OptionalInt}, {@link OptionalLong} and {@link OptionalDouble}),260   * note that the expected object empty optional fields are not ignored, this only applies to actual's fields.261   * <p>262   * Example:263   * <pre><code class='java'> public class Person {264   *   String name;265   *   OptionalInt age;266   *   OptionalLong id;267   *   OptionalDouble height;268   *   Home home = new Home();269   * }270   *271   * public class Home {272   *   String address;273   *   Optional&lt;String&gt; phone;274   * }275   *276   * Person homerWithoutDetails = new Person("Homer Simpson");277   * homerWithoutDetails.home.address.street = "Evergreen Terrace";278   * homerWithoutDetails.home.address.number = 742;279   * homerWithoutDetails.home.phone = Optional.empty();280   * homerWithoutDetails.age = OptionalInt.empty();281   * homerWithoutDetails.id = OptionalLong.empty();282   * homerWithoutDetails.height = OptionalDouble.empty();283   *284   * Person homerWithDetails = new Person("Homer Simpson");285   * homerWithDetails.home.address.street = "Evergreen Terrace";286   * homerWithDetails.home.address.number = 742;287   * homerWithDetails.home.phone = Optional.of("(939) 555-0113");288   * homerWithDetails.age = OptionalInt.of(39);289   * homerWithDetails.id = OptionalLong.of(123456);290   * homerWithDetails.height = OptionalDouble.of(1.83);291   *292   * // assertion succeeds as phone is ignored in the comparison293   * assertThat(homerWithoutDetails).usingRecursiveComparison()294   *                                .ignoringActualEmptyOptionalFields()295   *                                .isEqualTo(homerWithDetails);296   *297   * // assertion fails as phone, age, id and height are not ignored and are populated for homerWithDetails but not for homerWithoutDetails.298   * assertThat(homerWithDetails).usingRecursiveComparison()299   *                             .ignoringActualEmptyOptionalFields()300   *                             .isEqualTo(homerWithoutDetails);</code></pre>301   *302   * @return this {@link RecursiveComparisonAssert} to chain other methods.303   */304  @CheckReturnValue305  public SELF ignoringActualEmptyOptionalFields() {306    recursiveComparisonConfiguration.setIgnoreAllActualEmptyOptionalFields(true);307    return myself;308  }309  /**310   * Makes the recursive comparison to ignore all <b>expected null fields</b>.311   * <p>312   * Example:313   * <pre><code class='java'> public class Person {314   *   String name;315   *   double height;316   *   Home home = new Home();317   * }318   *319   * public class Home {320   *   Address address = new Address();321   * }322   *323   * public static class Address {324   *   int number;325   *   String street;326   * }327   *328   * Person sherlock = new Person("Sherlock", 1.80);329   * sherlock.home.address.street = "Baker Street";330   * sherlock.home.address.number = 221;331   *332   * Person noName = new Person(null, 1.80);333   * noName.home.address.street = null;334   * noName.home.address.number = 221;335   *336   * // assertion succeeds as name and home.address.street fields are ignored in the comparison337   * assertThat(sherlock).usingRecursiveComparison()338   *                     .ignoringExpectedNullFields()339   *                     .isEqualTo(noName);340   *341   * // assertion fails as name and home.address.street fields are populated for sherlock but not for noName.342   * assertThat(noName).usingRecursiveComparison()343   *                   .ignoringExpectedNullFields()344   *                   .isEqualTo(sherlock);</code></pre>345   *346   * @return this {@link RecursiveComparisonAssert} to chain other methods.347   */348  @CheckReturnValue349  public SELF ignoringExpectedNullFields() {350    recursiveComparisonConfiguration.setIgnoreAllExpectedNullFields(true);351    return myself;352  }353  /**354   * Makes the recursive comparison to ignore the given object under test fields. Nested fields can be specified like this: {@code home.address.street}.355   * <p>356   * Example:357   * <pre><code class='java'> public class Person {358   *   String name;359   *   double height;360   *   Home home = new Home();361   * }362   *363   * public class Home {364   *   Address address = new Address();365   * }366   *367   * public static class Address {368   *   int number;369   *   String street;370   * }371   *372   * Person sherlock = new Person("Sherlock", 1.80);373   * sherlock.home.address.street = "Baker Street";374   * sherlock.home.address.number = 221;375   *376   * Person noName = new Person(null, 1.80);377   * noName.home.address.street = null;378   * noName.home.address.number = 221;379   *380   * // assertion succeeds as name and home.address.street fields are ignored in the comparison381   * assertThat(sherlock).usingRecursiveComparison()382   *                     .ignoringFields("name", "home.address.street")383   *                     .isEqualTo(noName);384   *385   * // assertion fails as home.address.street fields differ and is not ignored.386   * assertThat(sherlock).usingRecursiveComparison()387   *                     .ignoringFields("name")388   *                     .isEqualTo(noName);</code></pre>389   *390   * @param fieldsToIgnore the fields of the object under test to ignore in the comparison.391   * @return this {@link RecursiveComparisonAssert} to chain other methods.392   */393  @CheckReturnValue394  public SELF ignoringFields(String... fieldsToIgnore) {395    recursiveComparisonConfiguration.ignoreFields(fieldsToIgnore);396    return myself;397  }398  /**399   * Makes the recursive comparison to ignore the object under test fields matching the given regexes.400   * <p>401   * Nested fields can be specified by using dots like this: {@code home\.address\.street} ({@code \} is used to escape402   * dots since they have a special meaning in regexes).403   * <p>404   * Example:405   * <pre><code class='java'> public class Person {406   *   String name;407   *   double height;408   *   Home home = new Home();409   * }410   *411   * public class Home {412   *   Address address = new Address();413   * }414   *415   * public static class Address {416   *   int number;417   *   String street;418   * }419   *420   * Person sherlock = new Person("Sherlock", 1.80);421   * sherlock.home.address.street = "Baker Street";422   * sherlock.home.address.number = 221;423   *424   * Person noName = new Person(null, 1.80);425   * noName.home.address.street = "Butcher Street";426   * noName.home.address.number = 222;427   *428   * // assertion succeeds as name and all home fields are ignored in the comparison429   * assertThat(sherlock).usingRecursiveComparison()430   *                     .ignoringFieldsMatchingRegexes("n.me", "home.*")431   *                     .isEqualTo(noName);432   *433   * // although home fields are ignored, assertion fails as name fields differ.434   * assertThat(sherlock).usingRecursiveComparison()435   *                     .ignoringFieldsMatchingRegexes("home.*")436   *                     .isEqualTo(noName);</code></pre>437   *438   * @param regexes regexes used to ignore fields in the comparison.439   * @return this {@link RecursiveComparisonAssert} to chain other methods.440   */441  @CheckReturnValue442  public SELF ignoringFieldsMatchingRegexes(String... regexes) {443    recursiveComparisonConfiguration.ignoreFieldsMatchingRegexes(regexes);444    return myself;445  }446  /**447   * Makes the recursive comparison to ignore the object under test fields of the given types.448   * The fields are ignored if their types <b>exactly match one of the ignored types</b>, for example if a field is a subtype of an ignored type it is not ignored.449   * <p>450   * If some object under test fields are null it is not possible to evaluate their types unless in {@link #withStrictTypeChecking() strictTypeChecking mode},451   * in that case the corresponding expected field's type is evaluated instead but if strictTypeChecking mode is disabled then null fields are not ignored.452   * <p>453   * Example:454   * <pre><code class='java'> public class Person {455   *   String name;456   *   double height;457   *   Home home = new Home();458   * }459   *460   * public class Home {461   *   Address address = new Address();462   * }463   *464   * public static class Address {465   *   int number;466   *   String street;467   * }468   *469   * Person sherlock = new Person("Sherlock", 1.80);470   * sherlock.home.address.street = "Baker Street";471   * sherlock.home.address.number = 221;472   *473   * Person sherlock2 = new Person("Sherlock", 1.90);474   * sherlock2.home.address.street = "Butcher Street";475   * sherlock2.home.address.number = 221;476   *477   * // assertion succeeds as we ignore Address and height478   * assertThat(sherlock).usingRecursiveComparison()479   *                     .ignoringFieldsOfTypes(double.class, Address.class)480   *                     .isEqualTo(sherlock2);481   *482   * // now this assertion fails as expected since the home.address.street fields and height differ483   * assertThat(sherlock).usingRecursiveComparison()484   *                     .isEqualTo(sherlock2);</code></pre>485   *486   * @param typesToIgnore the types we want to ignore in the object under test fields.487   * @return this {@link RecursiveComparisonAssert} to chain other methods.488   */489  public RecursiveComparisonAssert<?> ignoringFieldsOfTypes(Class<?>... typesToIgnore) {490    recursiveComparisonConfiguration.ignoreFieldsOfTypes(typesToIgnore);491    return myself;492  }493  /**494   * This method instructs the recursive comparison to compare recursively all fields including the one whose type have overridden equals,495   * <b>except fields with java types</b> (at some point we need to compare something!).496   * <p>497   * Since 3.17.0 this is the default behavior for recursive comparisons, to revert to the previous behavior call {@link #usingOverriddenEquals()}.498   * <p>499   * Example:500   * <pre><code class='java'> public class Person {501   *   String name;502   *   double height;503   *   Home home = new Home();504   * }505   *506   * public class Home {507   *   Address address = new Address();508   * }509   *510   * public static class Address {511   *   int number;512   *   String street;513   *514   *   // only compares number, ouch!515   *   {@literal @}Override516   *   public boolean equals(final Object other) {517   *     if (!(other instanceof Address)) return false;518   *     Address castOther = (Address) other;519   *     return Objects.equals(number, castOther.number);520   *   }521   * }522   *523   * Person sherlock = new Person("Sherlock", 1.80);524   * sherlock.home.address.street = "Baker Street";525   * sherlock.home.address.number = 221;526   *527   * Person sherlock2 = new Person("Sherlock", 1.80);528   * sherlock2.home.address.street = "Butcher Street";529   * sherlock2.home.address.number = 221;530   *531   * // Assertion succeeds because:532   * // - overridden equals are used533   * // - Address has overridden equals and does not compare street fields.534   * assertThat(sherlock).usingRecursiveComparison()535   *                     .usingOverriddenEquals()536   *                     .isEqualTo(sherlock2);537   *538   * // To avoid using Address overridden equals, don't call usingOverriddenEquals() or call ignoringAllOverriddenEquals()539   * // (calling ignoringAllOverriddenEquals() is actually not required as this is the default behavior).540   * // This assertion fails as it will compare home.address.street fields which differ541   * assertThat(sherlock).usingRecursiveComparison()542   *                      //.ignoringAllOverriddenEquals() // not needed as this is the default543   *                     .isEqualTo(sherlock2);</code></pre>544   *545   * @return this {@link RecursiveComparisonAssert} to chain other methods.546   */547  public SELF ignoringAllOverriddenEquals() {548    recursiveComparisonConfiguration.ignoreAllOverriddenEquals();549    return myself;550  }551  /**552   * By default the recursive comparison compare recursively all fields including the ones whose type have overridden equals553   * <b>except fields with java types</b> (at some point we need to compare something!).554   * <p>555   * This method instructs the recursive comparison to use overridden equals.556   * <p>557   * Example:558   * <pre><code class='java'> public class Person {559   *   String name;560   *   double height;561   *   Home home = new Home();...

ignoringAllOverriddenEquals

Using AI Code Generation

1package org.example;2import static org.assertj.core.api.Assertions.assertThat;3import static org.assertj.core.api.Assertions.within;4import java.util.ArrayList;5import java.util.Arrays;6import java.util.List;7import org.assertj.core.api.RecursiveComparisonAssert;8import org.junit.jupiter.api.Test;9public class RecursiveComparisonAssertTest {10    public void testRecursiveComparisonAssert() {11        List<Child> actual = new ArrayList<>();12        actual.add(new Child("child1", 1));13        actual.add(new Child("child2", 2));14        actual.add(new Child("child3", 3));15        actual.add(new Child("child4", 4));16        actual.add(new Child("child5", 5));17        List<Child> expected = new ArrayList<>();18        expected.add(new Child("child1", 1));19        expected.add(new Child("child2", 2));20        expected.add(new Child("child3", 3));21        expected.add(new Child("child4", 4));22        expected.add(new Child("child5", 5));23        RecursiveComparisonAssert recursiveComparisonAssert = assertThat(actual).usingRecursiveComparison();24        recursiveComparisonAssert.ignoringAllOverriddenEquals();25        recursiveComparisonAssert.isEqualTo(expected);26    }27}28package org.example;29public class Child {30    private String name;31    private int age;32    public Child(String name, int age) {33        this.name = name;34        this.age = age;35    }36    public boolean equals(Object obj) {37        if (obj == this) {38            return true;39        }40        if (obj == null || obj.getClass() != this.getClass()) {41            return false;42        }43        Child child = (Child) obj;44        return name.equals(child.name) && age == child.age;45    }46    public int hashCode() {47        return name.hashCode() + age;48    }49}50  [Child{name='child1', age=1}, Child{name='child2', age=2}, Child{name='child3', age=3}, Child{name='child4', age=4}, Child{name='child5', age=5}]51  [Child{name='child1', age=1}, Child{name='child2', age=2}, Child{name='child3', age

ignoringAllOverriddenEquals

Using AI Code Generation

1package org.example;2import static org.assertj.core.api.Assertions.assertThat;3{4    public static void main( String[] args )5    {6        Person person1 = new Person("John", "Doe");7        Person person2 = new Person("John", "Doe");8        assertThat(person1).usingRecursiveComparison().ignoringAllOverriddenEquals().isEqualTo(person2);9    }10}11package org.example;12public class Person {13    private final String firstName;14    private final String lastName;15    public Person(String firstName, String lastName) {16        this.firstName = firstName;17        this.lastName = lastName;18    }19    public boolean equals(Object obj) {20        return true;21    }22}23Expected :Person(firstName=John, lastName=Doe)24Actual   :Person(firstName=John, lastName=Doe)25Your name to display (optional):26Your name to display (optional):27package org.example;28import static org.assertj.core.api.Assertions.assertThat;29{30    public static void main( String[] args )31    {32        Person person1 = new Person("John", "Doe");33        Person person2 = new Person("John", "Doe");34        assertThat(person1).usingRecursiveComparison().ignoringAllOverriddenEquals().isEqualTo(person2);35    }36}37package org.example;38public class Person {39    private final String firstName;40    private final String lastName;41    public Person(String firstName, String lastName) {42        this.firstName = firstName;43        this.lastName = lastName;44    }45    public boolean equals(Object obj) {46        return true;47    }48}49Expected :Person(firstName=John, lastName=Doe)50Actual   :Person(firstName=John, lastName=Doe)51Your name to display (optional):

ignoringAllOverriddenEquals

Using AI Code Generation

1import org.assertj.core.api.RecursiveComparisonAssert;2import org.assertj.core.api.RecursiveComparisonConfiguration;3import org.assertj.core.api.Assertions;4import java.util.List;5import java.util.ArrayList;6public class 1 {7    public static void main(String[] args) {8        List<String> list1 = new ArrayList<>();9        list1.add("A");10        list1.add("B");11        List<String> list2 = new ArrayList<>();12        list2.add("A");13        list2.add("B");14        list2.add("C");15        RecursiveComparisonConfiguration configuration = RecursiveComparisonConfiguration.builder()16                .withIgnoredFields("list1", "list2")17                .build();18        Assertions.assertThat(list1).usingRecursiveComparison(configuration).ignoringAllOverriddenEquals().isEqualTo(list2);19    }20}

ignoringAllOverriddenEquals

Using AI Code Generation

1public class RecursiveComparisonAssertIgnoringAllOverriddenEquals {2    public static void main(String[] args) {3        Person person = new Person("John", "Doe", 30);4        Person person1 = new Person("John", "Doe", 30);5        assertThat(person).usingRecursiveComparison().ignoringAllOverriddenEquals().isEqualTo(person1);6    }7}8public class Person {9    private String firstName;10    private String lastName;11    private int age;12    public Person(String firstName, String lastName, int age) {13        this.firstName = firstName;14        this.lastName = lastName;15        this.age = age;16    }17    public boolean equals(Object o) {18        if (this == o) return true;19        if (!(o instanceof Person)) return false;20        Person person = (Person) o;21                firstName.equals(person.firstName) &&22                lastName.equals(person.lastName);23    }24    public int hashCode() {25        return Objects.hash(firstName, lastName, age);26    }27}28  Person(firstName=John, lastName=Doe, age=30)29  Person(firstName=John, lastName=Doe, age=30)30at org.assertj.core.api.recursive.comparison.RecursiveComparisonAssert_isEqualTo_Test.should_pass_when_using_ignoring_all_overridden_equals(RecursiveComparisonAssert_isEqualTo_Test.java:51)

ignoringAllOverriddenEquals

Using AI Code Generation

1package org.example;2import org.assertj.core.api.RecursiveComparisonAssert;3import org.junit.jupiter.api.Test;4import org.junit.jupiter.api.extension.ExtendWith;5import org.mockito.junit.jupiter.MockitoExtension;6import java.util.ArrayList;7import java.util.List;8import static org.assertj.core.api.Assertions.assertThat;9@ExtendWith(MockitoExtension.class)10public class AssertJTest {11    public void test() {12        List<String> list1 = new ArrayList<>();13        list1.add("A");14        list1.add("B");15        list1.add("C");16        list1.add("D");17        List<String> list2 = new ArrayList<>();18        list2.add("A");19        list2.add("B");20        list2.add("C");21        list2.add("D");22        assertThat(list1).usingRecursiveComparison().ignoringAllOverriddenEquals().isEqualTo(list2);23    }24}25package org.example;26import org.assertj.core.api.RecursiveComparisonAssert;27import org.junit.jupiter.api.Test;28import org.junit.jupiter.api.extension.ExtendWith;29import org.mockito.junit.jupiter.MockitoExtension;30import static org.assertj.core.api.Assertions.assertThat;31@ExtendWith(MockitoExtension.class)32public class AssertJTest {33    public void test() {34        Employee employee1 = new Employee("A", 1, 1000);35        Employee employee2 = new Employee("A", 1, 1000);36        assertThat(employee1).usingRecursiveComparison().ignoringAllOverriddenEquals().isEqualTo(employee2);37    }38}39package org.example;40import org.assertj.core.api.RecursiveComparisonAssert;41import org.junit.jupiter.api.Test;42import org.junit.jupiter.api.extension.ExtendWith;43import org.mockito.junit.jupiter.MockitoExtension;44import static org.assertj.core.api.Assertions.assertThat;45@ExtendWith(MockitoExtension.class)

ignoringAllOverriddenEquals

Using AI Code Generation

1import org.assertj.core.api.Assertions;2import org.assertj.core.api.RecursiveComparisonAssert;3import org.assertj.core.api.RecursiveComparisonConfiguration;4import org.junit.Test;5public class AssertJExample {6   public void test() {7      RecursiveComparisonConfiguration recursiveComparisonConfiguration = RecursiveComparisonConfiguration.builder()8            .withIgnoredFields("overriddenEquals").build();9      RecursiveComparisonAssert recursiveComparisonAssert = Assertions.assertThat(new ObjectWithOverriddenEquals())10            .usingRecursiveComparison(recursiveComparisonConfiguration);11      recursiveComparisonAssert.ignoringAllOverriddenEquals();12   }13   class ObjectWithOverriddenEquals {14      public boolean equals(Object obj) {15         return true;16      }17   }18}

ignoringAllOverriddenEquals

Using AI Code Generation

1import org.assertj.core.api.Assertions;2import org.assertj.core.api.RecursiveComparisonAssert;3public class Test {4    static class A {5        int i;6        public A(int i) {7            this.i = i;8        }9    }10    static class B extends A {11        int j;12        public B(int i, int j) {13            super(i);14            this.j = j;15        }16    }17    public static void main(String[] args) {18        RecursiveComparisonAssert<B> recursiveComparisonAssert = Assertions.assertThat(new B(1, 2)).ignoringAllOverriddenEquals();19        recursiveComparisonAssert.isEqualTo(new B(1, 2));20    }21}22at org.assertj.core.api.AbstractAssert.isEqualTo(AbstractAssert.java:82)23at Test.main(Test.java:20)24Recommended Posts: AssertJ - ignoringAllOverriddenEquals() method in RecursiveComparisonAssert class25AssertJ - ignoringOverriddenEquals() method in RecursiveComparisonAssert class26AssertJ - ignoringFields() method in RecursiveComparisonAssert class27AssertJ - ignoringFieldsOfTypes() method in RecursiveComparisonAssert class28AssertJ - ignoringActualNullFields() method in RecursiveComparisonAssert class29AssertJ - ignoringExpectedNullFields() method in RecursiveComparisonAssert class30AssertJ - ignoringCollectionOrder() method in RecursiveComparisonAssert class31AssertJ - ignoringCollectionOrderInFields() method in RecursiveComparisonAssert class32AssertJ - ignoringFieldsOfTypes() method in RecursiveComparisonConfiguration class33AssertJ - ignoringFields() method in RecursiveComparisonConfiguration class34AssertJ - ignoringOverriddenEquals() method in RecursiveComparisonConfiguration class35AssertJ - ignoringAllOverriddenEquals() method in RecursiveComparisonConfiguration class36AssertJ - ignoringActualNullFields() method in RecursiveComparisonConfiguration class37AssertJ - ignoringExpectedNullFields() method in RecursiveComparisonConfiguration class38AssertJ - ignoringCollectionOrder() method in RecursiveComparisonConfiguration class39AssertJ - ignoringCollectionOrderInFields() method in RecursiveComparisonConfiguration

ignoringAllOverriddenEquals

Using AI Code Generation

1import org.assertj.core.api.RecursiveComparisonAssert;2import org.assertj.core.api.Assertions;3import org.assertj.core.api.RecursiveComparisonConfiguration;4import org.assertj.core.internal.RecursiveComparisonConfigurationBuilder;5public class Test {6    public static void main(String[] args) {7        RecursiveComparisonConfiguration configuration = new RecursiveComparisonConfigurationBuilder().ignoreAllOverriddenEquals().build();8        RecursiveComparisonAssert recursiveComparisonAssert = Assertions.assertThat(new Person("John", 25)).usingRecursiveComparison(configuration);9        System.out.println(recursiveComparisonAssert);10    }11}12Recommended Posts: AssertJ | usingRecursiveComparison() method of RecursiveComparisonAssert class13AssertJ | isEqualToIgnoringGivenFields() method of RecursiveComparisonAssert class14AssertJ | isEqualToUsingRecursiveComparison() method of RecursiveComparisonAssert class15AssertJ | isEqualToComparingOnlyGivenFields() met

ignoringAllOverriddenEquals

Using AI Code Generation

1import org.assertj.core.api.RecursiveComparisonAssert;2import org.assertj.core.api.Assertions;3import java.util.*;4public class RecursiveComparisonAssert_ignoringAllOverriddenEquals {5    public static void main(String[] args) {6        List<String> list1 = new ArrayList<>();7        list1.add("Hello");8        list1.add("World");9        List<String> list2 = new ArrayList<>();10        list2.add("Hello");11        list2.add("World");12        RecursiveComparisonAssert<Object> recursiveComparisonAssert = Assertions.assertThat(list1);13        recursiveComparisonAssert.ignoringAllOverriddenEquals().isEqualTo(list2);14        System.out.println("Assertion passed");15    }16}17import org.assertj.core.api.recursive.comparison.RecursiveComparisonConfiguration;18import org.assertj.core.api.Assertions;19import java.util.*;20public class RecursiveComparisonConfiguration_ignoringAllOverriddenEquals {21    public static void main(String[] args) {22        List<String> list1 = new ArrayList<>();23        list1.add("Hello");24        list1.add("World");25        List<String> list2 = new ArrayList<>();26        list2.add("Hello");27        list2.add("World");28        RecursiveComparisonConfiguration recursiveComparisonConfiguration = new RecursiveComparisonConfiguration();29        recursiveComparisonConfiguration.ignoringAllOverriddenEquals();30        Assertions.assertThat(list1).usingRecursiveComparison().isEqualTo(list2);31        System.out.println("Assertion passed");32    }33}

ignoringAllOverriddenEquals

Using AI Code Generation

1import org.assertj.core.api.RecursiveComparisonAssert;2public class IgnoreAllOverriddenEquals {3    public static void main(String[] args) {4        RecursiveComparisonAssert recursiveComparisonAssert = new RecursiveComparisonAssert(new Object());5        recursiveComparisonAssert.ignoringAllOverriddenEquals();6    }7}

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.