Ease changing Configuration properties.

Add a method to apply and display the applied Configuration

Author: joel-costigliola

src/main/java/org/assertj/core/configuration/Configuration.java

@@ -20,14 +20,13 @@
 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
 import java.util.List;
+import java.util.stream.Stream;
 
 import org.assertj.core.api.Assertions;
 import org.assertj.core.presentation.Representation;
 
 /**
- * Provider for all the configuration settings / parameters within AssertJ.
- * <p>
- * All the configuration possibilities are registered via an SPI.
+ * All configuration settings for AssertJ Core.
  *
  * @since 3.13.0
  */
@@ -44,6 +43,15 @@ public class Configuration {
   public static final boolean BARE_NAME_PROPERTY_EXTRACTION_ENABLED = true;
   public static final boolean LENIENT_DATE_PARSING = false;
 
+  private boolean comparingPrivateFields = ALLOW_COMPARING_PRIVATE_FIELDS;
+  private boolean extractingPrivateFields = ALLOW_EXTRACTING_PRIVATE_FIELDS;
+  private boolean bareNamePropertyExtraction = BARE_NAME_PROPERTY_EXTRACTION_ENABLED;
+  private boolean removeAssertJRelatedElementsFromStackTrace = REMOVE_ASSERTJ_RELATED_ELEMENTS_FROM_STACK_TRACE;
+  private boolean lenientDateParsing = LENIENT_DATE_PARSING;
+  private List<DateFormat> additionalDateFormats = emptyList();
+  private int maxLengthForSingleLineDescription = MAX_LENGTH_FOR_SINGLE_LINE_DESCRIPTION;
+  private int maxElementsForPrinting = MAX_ELEMENTS_FOR_PRINTING;
+
   /**
    * @return the default {@link Representation} that is used within AssertJ.
    */
@@ -60,88 +68,209 @@ boolean hasCustomRepresentation() {
    * <p>
    * See {@link Assertions#setAllowComparingPrivateFields(boolean)} for a detailed description.
    *
-   * @return whether private fields comparison is enabled. Default is {@value #ALLOW_COMPARING_PRIVATE_FIELDS}.
+   * @return whether private fields comparison is enabled.
    */
   public boolean comparingPrivateFieldsEnabled() {
-    return ALLOW_COMPARING_PRIVATE_FIELDS;
+    return comparingPrivateFields;
+  }
+
+  /**
+   * Sets whether private fields comparison is enabled.
+   * <p>
+   * See {@link Assertions#setAllowComparingPrivateFields(boolean)} for a detailed description.
+   * <p>
+   * Note that this change will only be effective once {@link #apply()} or {@link #applyAndDisplay()} is called.
+   *
+   * @param comparingPrivateFields whether private fields comparison is enabled.
+   */
+  public void setComparingPrivateFields(boolean comparingPrivateFields) {
+    this.comparingPrivateFields = comparingPrivateFields;
   }
 
   /**
    * Returns whether private fields comparison is enabled. Default is {@value #ALLOW_EXTRACTING_PRIVATE_FIELDS}.
    * <p>
    * See {@link Assertions#setAllowExtractingPrivateFields(boolean)} for a detailed description.
    *
-   * @return whether private fields comparison is enabled. Default is {@value #ALLOW_EXTRACTING_PRIVATE_FIELDS}.
-   *
+   * @return whether private fields comparison is enabled.
    */
   public boolean extractingPrivateFieldsEnabled() {
-    return ALLOW_EXTRACTING_PRIVATE_FIELDS;
+    return extractingPrivateFields;
+  }
+
+  /**
+   * Sets whether private fields comparison is enabled.
+   * <p>
+   * See {@link Assertions#setAllowExtractingPrivateFields(boolean)} for a detailed description.
+   * <p>
+   * Note that this change will only be effective once {@link #apply()} or {@link #applyAndDisplay()} is called.
+   *
+   * @param extractingPrivateFields whether private fields comparison is enabled.
+   */
+  public void setExtractingPrivateFields(boolean extractingPrivateFields) {
+    this.extractingPrivateFields = extractingPrivateFields;
   }
 
   /**
    * Returns whether the extractor considers bare-named property methods like {@code String name()}.
+   * Default is {@value #BARE_NAME_PROPERTY_EXTRACTION_ENABLED}.
    * <p>
    * See {@link Assertions#setExtractBareNamePropertyMethods(boolean)} for a detailed description.
    *
-   * @return Whether the extractor considers bare-named property methods like {@code String name()}. Default is {@value #BARE_NAME_PROPERTY_EXTRACTION_ENABLED}.
+   * @return whether the extractor considers bare-named property methods like {@code String name()}.
    */
   public boolean bareNamePropertyExtractionEnabled() {
-    return true;
+    return bareNamePropertyExtraction;
+  }
+
+  /**
+   * Sest whether the extractor considers bare-named property methods like {@code String name()}.
+   * <p>
+   * See {@link Assertions#setExtractBareNamePropertyMethods(boolean)} for a detailed description.
+   * <p>
+   * Note that this change will only be effective once {@link #apply()} or {@link #applyAndDisplay()} is called.
+   *
+   * @param bareNamePropertyExtraction whether the extractor considers bare-named property methods.
+   */
+  public void setBareNamePropertyExtraction(boolean bareNamePropertyExtraction) {
+    this.bareNamePropertyExtraction = bareNamePropertyExtraction;
   }
 
   /**
    * Returns whether AssertJ related elements are removed from assertion errors stack trace.
+   * Default is {@value #REMOVE_ASSERTJ_RELATED_ELEMENTS_FROM_STACK_TRACE}.
    * <p>
    * See {@link Assertions#setRemoveAssertJRelatedElementsFromStackTrace(boolean)} for a detailed description.
    *
-   * @return whether AssertJ related elements are removed from assertion errors stack trace. Default is {@value #REMOVE_ASSERTJ_RELATED_ELEMENTS_FROM_STACK_TRACE}.
+   * @return whether AssertJ related elements are removed from assertion errors stack trace.
    */
   public boolean removeAssertJRelatedElementsFromStackTraceEnabled() {
-    return REMOVE_ASSERTJ_RELATED_ELEMENTS_FROM_STACK_TRACE;
+    return removeAssertJRelatedElementsFromStackTrace;
+  }
+
+  /**
+   * Returns whether AssertJ related elements are removed from assertion errors stack trace.
+   * <p>
+   * See {@link Assertions#setRemoveAssertJRelatedElementsFromStackTrace(boolean)} for a detailed description.
+   * <p>
+   * Note that this change will only be effective once {@link #apply()} or {@link #applyAndDisplay()} is called.
+   *
+   * @param removeAssertJRelatedElementsFromStackTrace whether AssertJ related elements are removed from assertion errors stack trace.
+   */
+  public void setRemoveAssertJRelatedElementsFromStackTrace(boolean removeAssertJRelatedElementsFromStackTrace) {
+    this.removeAssertJRelatedElementsFromStackTrace = removeAssertJRelatedElementsFromStackTrace;
   }
 
   /**
    * Returns whether AssertJ will use lenient parsing mode for default date formats.
+   * Default is {@value #LENIENT_DATE_PARSING}.
    * <p>
    * See {@link Assertions#setLenientDateParsing(boolean)} for a detailed description.
    *
-   * @return whether AssertJ will use lenient parsing mode for default date formats. Default is {@value #LENIENT_DATE_PARSING}.
+   * @return whether AssertJ will use lenient parsing mode for default date formats.
    */
   public boolean lenientDateParsingEnabled() {
-    return LENIENT_DATE_PARSING;
+    return lenientDateParsing;
   }
 
   /**
-   * Returns the additional date formats AssertJ will use in date assertions.
+   * Returns whether AssertJ will use lenient parsing mode for default date formats.
+   * <p>
+   * See {@link Assertions#setLenientDateParsing(boolean)} for a detailed description.
+   * <p>
+   * Note that this change will only be effective once {@link #apply()} or {@link #applyAndDisplay()} is called.
+   *
+   * @param lenientDateParsing whether AssertJ will use lenient parsing mode for default date formats.
+   */
+  public void setLenientDateParsing(boolean lenientDateParsing) {
+    this.lenientDateParsing = lenientDateParsing;
+  }
+
+  /**
+   * AssertJ uses defaults date formats in date assertions, this property let's you register additional ones (default there are no addtional date formats).
    * <p>
    * See {@link Assertions#registerCustomDateFormat(java.text.DateFormat)} for a detailed description.
    *
-   * @return the additional date formats AssertJ will use in date assertions. Default is none.
+   * @return the date formats AssertJ will use in date assertions in addition the default ones.
    */
   public List<DateFormat> additionalDateFormats() {
-    return emptyList();
+    return additionalDateFormats;
+  }
+
+  /**
+   * Returns the additional date formats AssertJ will use in date assertions.
+   * <p>
+   * See {@link Assertions#registerCustomDateFormat(java.text.DateFormat)} for a detailed description.
+   * <p>
+   * Note that this change will only be effective once {@link #apply()} or {@link #applyAndDisplay()} is called.
+   *
+   * @param additionalDateFormats the date formats AssertJ will use in date assertions in addition the default ones.
+   */
+  public void setAdditionalDateFormats(List<DateFormat> additionalDateFormats) {
+    this.additionalDateFormats = additionalDateFormats;
+  }
+
+  /**
+   * Add the given date formats AssertJ will use in date assertions.
+   * <p>
+   * See {@link Assertions#registerCustomDateFormat(java.text.DateFormat)} for a detailed description.
+   * <p>
+   * Note that this change will only be effective once {@link #apply()} or {@link #applyAndDisplay()} is called.
+   *
+   * @param additionalDateFormats the date formats AssertJ will use in date assertions in addition the default ones.
+   */
+  public void addAdditionalDateFormats(DateFormat... additionalDateFormats) {
+    Stream.of(additionalDateFormats).forEach(this.additionalDateFormats::add);
   }
 
   /**
    * Returns the maximum length for an iterable/array to be displayed on one line.
+   * Default is {@value #MAX_LENGTH_FOR_SINGLE_LINE_DESCRIPTION}.
    * <p>
    * See {@link Assertions#setMaxLengthForSingleLineDescription(int)} for a detailed description.
    *
-   * @return the maximum length for an iterable/array to be displayed on one line. Default is {@value #MAX_LENGTH_FOR_SINGLE_LINE_DESCRIPTION}.
+   * @return the maximum length for an iterable/array to be displayed on one line.
    */
   public int maxLengthForSingleLineDescription() {
-    return MAX_LENGTH_FOR_SINGLE_LINE_DESCRIPTION;
+    return maxLengthForSingleLineDescription;
+  }
+
+  /**
+   * Sets the maximum length for an iterable/array to be displayed on one line.
+   * <p>
+   * See {@link Assertions#setMaxLengthForSingleLineDescription(int)} for a detailed description.
+   * <p>
+   * Note that this change will only be effective once {@link #apply()} or {@link #applyAndDisplay()} is called.
+   *
+   * @param maxLengthForSingleLineDescription the maximum length for an iterable/array to be displayed on one line.
+   */
+  public void setMaxLengthForSingleLineDescription(int maxLengthForSingleLineDescription) {
+    this.maxLengthForSingleLineDescription = maxLengthForSingleLineDescription;
   }
 
   /**
    * Returns the maximum length for an iterable/array to be displayed on one line.
+   * Default is {@value #MAX_ELEMENTS_FOR_PRINTING}.
    * <p>
    * See {@link Assertions#setMaxLengthForSingleLineDescription(int)} for a detailed description.
    *
-   * @return the maximum length for an iterable/array to be displayed on one line. Default is {@value #MAX_ELEMENTS_FOR_PRINTING}.
+   * @return the maximum length for an iterable/array to be displayed on one line.
    */
   public int maxElementsForPrinting() {
-    return MAX_ELEMENTS_FOR_PRINTING;
+    return maxElementsForPrinting;
+  }
+
+  /**
+   * Returns the maximum length for an iterable/array to be displayed on one line.
+   * <p>
+   * See {@link Assertions#setMaxLengthForSingleLineDescription(int)} for a detailed description.
+   * <p>
+   * Note that this change will only be effective once {@link #apply()} or {@link #applyAndDisplay()} is called.
+   *
+   * @param maxElementsForPrinting the maximum length for an iterable/array to be displayed on one line.
+   */
+  public void setMaxElementsForPrinting(int maxElementsForPrinting) {
+    this.maxElementsForPrinting = maxElementsForPrinting;
   }
 
   /**
@@ -159,8 +288,17 @@ public void apply() {
     additionalDateFormats().forEach(Assertions::registerCustomDateFormat);
   }
 
+  /**
+   * Applies this configuration to AssertJ and prints it.
+   */
+  public void applyAndDisplay() {
+    apply();
+    System.out.println(describe());
+  }
+
   public String describe() {
-    return format("- representation .................................. = %s%n" +
+    return format("Applying configuration %s%n" +
+                  "- representation .................................. = %s%n" +
                   "- comparingPrivateFieldsEnabled ................... = %s%n" +
                   "- extractingPrivateFieldsEnabled .................. = %s%n" +
                   "- bareNamePropertyExtractionEnabled ............... = %s%n" +
@@ -169,6 +307,7 @@ public String describe() {
                   "- maxLengthForSingleLineDescription ............... = %s%n" +
                   "- maxElementsForPrinting .......................... = %s%n" +
                   "- removeAssertJRelatedElementsFromStackTraceEnabled = %s%n",
+                  getClass().getName(),
                   representation(),
                   comparingPrivateFieldsEnabled(),
                   extractingPrivateFieldsEnabled(),

src/main/java/org/assertj/core/configuration/ConfigurationProvider.java

@@ -29,7 +29,6 @@
  */
 public final class ConfigurationProvider {
 
-  private static final String NEWLINE = format("%n");
   public static final ConfigurationProvider CONFIGURATION_PROVIDER = new ConfigurationProvider();
   private final Representation representation;
   private final Configuration configuration;
@@ -43,8 +42,6 @@ private ConfigurationProvider() {
     configuration = Services.get(Configuration.class, DEFAULT_CONFIGURATION);
     if (configuration != DEFAULT_CONFIGURATION) {
       configuration.apply();
-      System.out.println(NEWLINE + "AssertJ has found and applied the following registered configuration: " + configuration);
-      System.out.println(configuration.describe());
     }
   }
 

src/test/java/org/assertj/core/configuration/Configuration_describe_Test.java

@@ -26,7 +26,6 @@ public void should_give_a_human_readable_description() throws Exception {
     Configuration configuration = new NonDefaultConfiguration();
     // WHEN
     String description = configuration.describe();
-    System.out.println(description);
     // THEN
     assertThat(description).isEqualTo(format("- representation .................................. = BinaryRepresentation%n" +
                                              "- comparingPrivateFieldsEnabled ................... = false%n" +