0.8.0

Author: JesusMcCloud

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## 0.x
 
+## 0.8.0
+* Remove `displayName` and `displayNameLength`
+* Remove deprecated `DEFAULT_TEST_NAME_MAX_LEN`
+
 ### 0.7.0 - 0.7.1
 * treat varags of `Pair<String,*>` the same as `Map<String,*>` in data-driven tests
 * TestBalloon 0.8.2

README.md

@@ -86,7 +86,7 @@ This project consists of the following modules:
 
 | TestBalloon Addons | TestBalloon                 |
 |--------------------|-----------------------------|
-| `0.7.0` - `0.7.1`  | `0.8.2+` (Kotlin `2.3.0`)   |
+| `0.7.0` - `0.8.0`  | `0.8.2+` (Kotlin `2.3.0+`)  |
 | `0.7.0-RC`         | `0.8.0-RC` (Kotlin `2.3.0`) |
 | `0.1.1`–`0.6.1`    | `0.7.1` (Kotlin `2.2.21`)   |
 | `0.1.0`            | `0.7.0` (Kotlin `2.2.21`)   |
@@ -105,19 +105,18 @@ This project consists of the following modules:
 All modules allow setting global defaults with regard to test name truncation. These properties are called:
 
 * `defaultTestNameLength`
-* `defaultDisplayNameLength`
 
 The former generally defaults to 64 characters (15 on Android). Display names are not truncated by default.
 
 Both properties can be set in two ways:
 * **globally** (e.g., `TestBalloonAddons.defaultTestNameLength = 15`)
-* **per test style** (e.g., `FreeSpec.defaultTestNameLength = 10`, `PropertyTest.defaultDisplayNameLength = 100`)
+* **per test style** (e.g., `FreeSpec.defaultTestNameLength = 10`)
 
 Per-style configuration takes precedence over global configuration. Hence, per-style configuration property setters are nullable,
 **even though their getters will never return null**, as they fall back to the global configuration properties automatically.
 
-It is also possible to set test name length and display name length for individual tests by passing the `maxLength` and
-`displayNameMaxLength` parameters, respectively. Truncated names are ellipsised in the middle, not just cut off at the end.
+It is also possible to set test name length for individual tests by passing the `maxLength` arameter.
+Truncated names are ellipsised in the middle, not just cut off at the end.
 
 **→ Check out [the full API docs](https://a-sit-plus.github.io/testballoon-addons/) for each test style for all configuration options!**
 

commons/src/commonMain/kotlin/at/asitplus/test/TestBalloonCommons.kt

@@ -32,18 +32,6 @@ object TestBalloonAddons {
      */
     var defaultTestNameMaxLength: Int = defaultMaxLen
 
-    /**
-     * The default maximum length of display names of test elements created using:
-     * * `withData`
-     * * `withDataSuites`
-     * * `checkAll`
-     * * `checkAllSuites`
-     * * FreeSoec
-     *
-     * Defaults to `-1` (= no truncation).
-     */
-    var defaultDisplayNameMaxLength: Int = -1
-
     /**
      * Hard limit of the maximum path length of a test (i.e. all layers after the root suite's FQN down to the test case).
      * The intent of this hard limit is to have tests fail in a controlled manner, in case test names
@@ -58,9 +46,3 @@ object TestBalloonAddons {
         }
 
 }
-
-@Deprecated(
-    "To be removed in 0.8.", replaceWith = ReplaceWith("TestBalloonAddons.defaultTestNameMaxLength"),
-    DeprecationLevel.WARNING
-)
-val DEFAULT_TEST_NAME_MAX_LEN: Int get() = TestBalloonAddons.defaultTestNameMaxLength

datatest/src/commonMain/kotlin/at/asitplus/test/Data.kt

@@ -26,30 +26,18 @@ object DataTest {
     var defaultTestNameMaxLength: Int? = null
         get() = field ?: TestBalloonAddons.defaultTestNameMaxLength
 
-    /**
-     * The default maximum length of test element display names (not test name).
-     * Defaults to [TestBalloonAddons.defaultDisplayNameMaxLength], but setting it here will take precedence.
-     * * `-1` means no truncation.
-     * * `null` means it will again fall back to [TestBalloonAddons.defaultDisplayNameMaxLength]
-     * 
-     * This property's getter will never return null, but fall back to [TestBalloonAddons.defaultDisplayNameMaxLength].
-     */
-    var defaultDisplayNameMaxLength: Int? = null
-        get() = field ?: TestBalloonAddons.defaultDisplayNameMaxLength
-
 }
 
 
 data class ConfiguredDataTestScope<Data>(
     private val compact: Boolean,
     private val maxLength: Int,
-    private val displayNameMaxLength: Int,
     val prefix: String,
     val testSuite: TestSuiteScope, val map: Sequence<Pair<String, Data>>,
     val testConfig: TestConfig = TestConfig,
 ) {
     operator fun minus(action: TestSuiteScope.(Data) -> Unit) =
-        testSuite.withDataSuitesInternal(map, compact, maxLength, displayNameMaxLength, prefix, testConfig, action)
+        testSuite.withDataSuitesInternal(map, compact, maxLength, prefix, testConfig, action)
 }
 
 
@@ -61,7 +49,6 @@ data class ConfiguredDataTestScope<Data>(
  * @param testConfig Optional test configuration
  * @param compact If true, only a single test element is created and the class name of the data parameter is used as test name
  * @param maxLength maximum length of test element name (not display name)
- * @param displayNameMaxLength maximum length of test element **display name**
  * @param prefix an optional prefix to add to the test name
  * @param action Test action to execute for each map value
  */
@@ -70,7 +57,6 @@ internal fun <Data> TestSuiteScope.withDataInternal(
     testConfig: TestConfig = TestConfig,
     compact: Boolean,
     maxLength: Int,
-    displayNameMaxLength: Int,
     prefix: String,
     action: suspend Test.ExecutionScope.(Data) -> Unit
 ) {
@@ -82,7 +68,6 @@ internal fun <Data> TestSuiteScope.withDataInternal(
         testSuiteInScope.checkPathLenIncluding(truncatedName)
         test(
             name = truncatedName,
-            displayName = (testName.truncated(displayNameMaxLength)),
             testConfig = testConfig
         ) {
             val errors = mutableMapOf<String, Throwable?>()
@@ -104,7 +89,6 @@ internal fun <Data> TestSuiteScope.withDataInternal(
             testSuiteInScope.checkPathLenIncluding(truncatedName)
             test(
                 name = truncatedName,
-                displayName = (name.truncated(displayNameMaxLength)),
                 testConfig = testConfig
             ) { action(d.second) }
         }
@@ -119,15 +103,13 @@ internal fun <Data> TestSuiteScope.withDataInternal(
  * @param testConfig Optional test configuration
  * @param compact If true, only a single test element is created and the class name of the data parameter is used as test name
  * @param maxLength maximum length of test element name (not display name)
- * @param displayNameMaxLength maximum length of test element **display name**
  * @param prefix an optional prefix to add to the test name
  * @param action Test suite configuration action for each data item
  */
 internal fun <Data> TestSuiteScope.withDataSuitesInternal(
     data: Sequence<Pair<String, Data>>,
     compact: Boolean,
     maxLength: Int,
-    displayNameMaxLength: Int,
     prefix: String,
     testConfig: TestConfig = TestConfig,
     action: TestSuiteScope.(Data) -> Unit
@@ -140,7 +122,6 @@ internal fun <Data> TestSuiteScope.withDataSuitesInternal(
         testSuiteInScope.checkPathLenIncluding(truncatedName)
         testSuite(
             name = truncatedName,
-            displayName = (testName.truncated(displayNameMaxLength)),
             testConfig = testConfig
         ) {
             val errors = mutableMapOf<String, Throwable?>()
@@ -162,7 +143,6 @@ internal fun <Data> TestSuiteScope.withDataSuitesInternal(
             testSuiteInScope.checkPathLenIncluding(truncatedName)
             testSuite(
                 name = truncatedName,
-                displayName = (name.truncated(displayNameMaxLength)),
                 testConfig = testConfig,
                 content = fun TestSuiteScope.() {
                     action(d.second)

datatest/src/commonMain/kotlin/at/asitplus/test/Intermediate.iterable.kt

@@ -11,21 +11,18 @@ import de.infix.testBalloon.framework.core.TestSuiteScope
  * @param data The iterable collection of test data
  * @param compact If true, only a single test element is created and the class name of the data parameter is used as test name
  * @param maxLength maximum length of test element name (not display name)
- * @param displayNameMaxLength maximum length of test element **display name**
  * @param prefix an optional prefix to add to the test name
  * @param testConfig Optional test configuration
  */
 fun <Data> TestSuiteScope.withData(
     data: Iterable<Data>,
     compact: Boolean = DataTest.compactByDefault,
     maxLength: Int = DataTest.defaultTestNameMaxLength!!,
-    displayNameMaxLength: Int = DataTest.defaultDisplayNameMaxLength!!,
     prefix: String = "",
     testConfig: TestConfig = TestConfig,
 ) = ConfiguredDataTestScope<Data>(
     compact,
     maxLength,
-    displayNameMaxLength = displayNameMaxLength,
     prefix = prefix,
     this,
     data.asSequence().map { it.toPrettyString() to it },
@@ -41,7 +38,6 @@ fun <Data> TestSuiteScope.withData(
  * @param data The iterable collection of test data
  * @param compact If true, only a single test element is created and the class name of the data parameter is used as test name
  * @param maxLength maximum length of test element name (not display name)
- * @param displayNameMaxLength maximum length of test element **display name**
  * @param prefix an optional prefix to add to the test name
  * @param testConfig Optional test configuration
  */
@@ -50,13 +46,11 @@ fun <Data> TestSuiteScope.withData(
     data: Iterable<Data>,
     compact: Boolean = DataTest.compactByDefault,
     maxLength: Int = DataTest.defaultTestNameMaxLength!!,
-    displayNameMaxLength: Int = DataTest.defaultDisplayNameMaxLength!!,
     prefix: String = "",
     testConfig: TestConfig = TestConfig,
 ) = ConfiguredDataTestScope<Data>(
     compact,
     maxLength,
-    displayNameMaxLength = displayNameMaxLength,
     prefix = prefix,
     this,
     data.asSequence().map { nameFn(it) to it },
@@ -70,24 +64,22 @@ fun <Data> TestSuiteScope.withData(
  * @param data The iterable collection of test data
  * @param compact If true, only a single test element is created and the class name of the data parameter is used as test name
  * @param maxLength maximum length of test element name (not display name)
- * @param displayNameMaxLength maximum length of test element **display name**
  * @param testConfig Optional test configuration
  * @param prefix an optional prefix to add to the test name
  * @param action Test suite configuration action for each data item
  */
+@Deprecated("will be removed in 0.9.0", ReplaceWith("withData(data, compact, maxLength, prefix, testConfig) - {}"))
 fun <Data> TestSuiteScope.withDataSuites(
     data: Iterable<Data>,
     compact: Boolean = DataTest.compactByDefault,
     maxLength: Int = DataTest.defaultTestNameMaxLength!!,
-    displayNameMaxLength: Int = DataTest.defaultDisplayNameMaxLength!!,
     prefix: String = "",
     testConfig: TestConfig = TestConfig,
     action: TestSuiteScope.(Data) -> Unit
 ) = withDataSuitesInternal(
     data.map { it.toPrettyString() to it }.asSequence(),
     compact,
     maxLength,
-    displayNameMaxLength = displayNameMaxLength,
     prefix = prefix,
     testConfig,
     action
@@ -101,25 +93,23 @@ fun <Data> TestSuiteScope.withDataSuites(
  * @param data The iterable collection of test data
  * @param compact If true, only a single test element is created and the class name of the data parameter is used as test name
  * @param maxLength maximum length of test element name (not display name)
- * @param displayNameMaxLength maximum length of test element **display name**
  * @param prefix an optional prefix to add to the test name
  * @param testConfig Optional test configuration
  * @param action Test suite configuration action for each data item
  */
+@Deprecated("will be removed in 0.9.0", ReplaceWith("withData(nameFn, data, compact, maxLength, prefix, testConfig) - {}"))
 fun <Data> TestSuiteScope.withDataSuites(
     nameFn: (Data) -> String,
     data: Iterable<Data>,
     compact: Boolean = DataTest.compactByDefault,
     maxLength: Int = DataTest.defaultTestNameMaxLength!!,
-    displayNameMaxLength: Int = DataTest.defaultDisplayNameMaxLength!!,
     prefix: String = "",
     testConfig: TestConfig = TestConfig,
     action: TestSuiteScope.(Data) -> Unit
 ) = withDataSuitesInternal(
     data.map { nameFn(it) to it }.asSequence(),
     compact,
     maxLength,
-    displayNameMaxLength = displayNameMaxLength,
     prefix = prefix,
     testConfig,
     action

datatest/src/commonMain/kotlin/at/asitplus/test/Intermediate.map.kt

@@ -12,21 +12,18 @@ import de.infix.testBalloon.framework.core.TestSuiteScope
  * @param map Map of suite names to test data
  * @param compact If true, only a single test element is created and the class name of the data parameter is used as test name
  * @param maxLength maximum length of test element name (not display name)
- * @param displayNameMaxLength maximum length of test element **display name**
  * @param prefix an optional prefix to add to the test name
  * @param testConfig Optional test configuration
  */
 fun <Data> TestSuiteScope.withData(
     map: Map<String, Data>,
     compact: Boolean = DataTest.compactByDefault,
     maxLength: Int = DataTest.defaultTestNameMaxLength!!,
-    displayNameMaxLength: Int = DataTest.defaultDisplayNameMaxLength!!,
     prefix: String = "",
     testConfig: TestConfig = TestConfig,
 ) = ConfiguredDataTestScope<Data>(
     compact,
     maxLength,
-    displayNameMaxLength = displayNameMaxLength,
     prefix = prefix,
     this,
     map.asSequence().map { (k, v) -> k to v },
@@ -41,23 +38,21 @@ fun <Data> TestSuiteScope.withData(
  * @param testConfig Optional test configuration
  * @param compact If true, only a single test element is created and the class name of the data parameter is used as test name
  * @param maxLength maximum length of test element name (not display name)
- * @param displayNameMaxLength maximum length of test element **display name**
  * @param prefix an optional prefix to add to the test name
  * @param action Test suite configuration action for each map value
  */
+@Deprecated("will be removed in 0.9.0", ReplaceWith("withData(map, compact, maxLength, prefix, testConfig) - {}"))
 fun <Data> TestSuiteScope.withDataSuites(
     map: Map<String, Data>,
     compact: Boolean = DataTest.compactByDefault,
     maxLength: Int = DataTest.defaultTestNameMaxLength!!,
-    displayNameMaxLength: Int = DataTest.defaultDisplayNameMaxLength!!,
     prefix: String = "",
     testConfig: TestConfig = TestConfig,
     action: TestSuiteScope.(Data) -> Unit
 ) = withDataSuitesInternal(
     map.map { (k, v) -> k to v }.asSequence(),
     compact,
     maxLength,
-    displayNameMaxLength = displayNameMaxLength,
     prefix = prefix,
     testConfig,
     action