Merge pull request #17 from DutchCodingCompany/feature/custom_test_naming

Guldem · web-flow · commit ce147e29e6b8 · 2024-03-05T09:52:42.000+01:00
Adding custom description builder
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,24 @@
+## 1.1.3
+ - Added `CustomDescriptionBuilder` to build custom test description for all executed tests.
+   For example:
+   ```dart
+   parameterizedTest2(
+     'Test with custom description',
+     [
+      [1, 2],
+      [3, 4],
+     ],
+     (int a, int b) => expect(a+b, isPositive),
+     customDiscriptionBuilder: (groupDescription, index, values) => '🚀[$index] $groupDescription: <<${values.join('|')}>>',
+   );
+   ```
+   
+  Prints:
+```
+Test with custom description 🚀[1] Test with custom description: <<1|2>>
+Test with custom description 🚀[2] Test with custom description: <<3|4>>
+```
+
 ## 1.1.2
  - Added #13: String values are wrapped with quotes in test output. This makes it easier to see if a string value is empty or contains spaces.
  - Updated lints package
diff --git a/README.md b/README.md
@@ -166,6 +166,30 @@ group('Amount of letter', () {
 });
 ```
 
+## Changing test description output
+By default the test description contains the test value used within the tests. This can be override by using `customDescriptionBuilder`.
+
+When normally running parameterized tests with description 'My parameterized test' and the values `[['first', 'second', true], ['third', 'fourth', false]]` the test description output looks something like this:
+```
+My parameterized test [ 'first', 'second', true ]
+My parameterized test [ 'third', 'fourth', false ]
+```
+
+When defining a `customDescriptionBuilder` like this:
+```dart
+...
+customDiscriptionBuilder: (groupDescription, index, values) => '🚀[$index] $groupDescription: <<${values.join('|')}>>',
+...
+```
+
+The output will look like this:
+```
+My parameterized test 🚀[1] My parameterized test: <<first|second|true>>
+My parameterized test 🚀[2] My parameterized test: <<third|fourth|false>>
+```
+
+>Note: the first 'My parameterized test' is because parameterized tests make use of a group test. Most IDE's will group this for you and only show the second part.
+
 ## Extending parameters
 
 Currently the package supports `TestParameters` classes up to 10 arguments. If need to more arguments within a test than this is possible by implementing the `TestParameters` class.
diff --git a/lib/src/parameterized_group_base.dart b/lib/src/parameterized_group_base.dart
@@ -60,5 +60,6 @@ void parameterizedGroup(
       onPlatform: onPlatform,
       retry: retry,
     ),
+    null,
   ).executeGroup(body);
 }
diff --git a/lib/src/parameterized_test_base.dart b/lib/src/parameterized_test_base.dart
@@ -2,6 +2,7 @@ import 'package:meta/meta.dart';
 import 'package:test/test.dart';
 
 import 'test_options/group_test_options.dart';
+import 'test_options/value_with_test_options.dart';
 import 'test_parameters.dart';
 import 'value_source.dart';
 
@@ -34,6 +35,8 @@ void parameterizedTest(
   /// The test body which is executed for each test value.
   /// See [TestParameters] for more info on different bodies.
   TestParameters body, {
+  /// Provide a custom description builder which will build the description for all the test values test executed.
+  CustomDescriptionBuilder? customDescriptionBuilder,
   dynamic Function()? setUp,
 
   /// Provide a tearDown function to the `group` test.
@@ -58,5 +61,6 @@ void parameterizedTest(
       onPlatform: onPlatform,
       retry: retry,
     ),
+    customDescriptionBuilder,
   ).executeTests(body);
 }
diff --git a/lib/src/parameterized_test_numeric.dart b/lib/src/parameterized_test_numeric.dart
@@ -2,6 +2,7 @@ import 'package:meta/meta.dart';
 import 'package:test/test.dart';
 
 import '../parameterized_test.dart';
+import 'test_options/value_with_test_options.dart';
 
 /// Parameterized test with 1 input arguments. See [parameterizedTest] for more info.
 @isTestGroup
@@ -15,6 +16,8 @@ void parameterizedTest1<A1>(
   /// The test body which is executed for each test value.
   /// See [TestParameters] for more info on different bodies.
   dynamic Function(A1) body, {
+  /// Provide a custom description builder which will build the description for all the test values test executed.
+  CustomDescriptionBuilder? customDescriptionBuilder,
   dynamic Function()? setUp,
 
   /// Provide a tearDown function to the `group` test.
@@ -30,6 +33,7 @@ void parameterizedTest1<A1>(
       description,
       values,
       p1(body),
+      customDescriptionBuilder: customDescriptionBuilder,
       setUp: setUp,
       tearDown: tearDown,
       testOn: testOn,
@@ -52,6 +56,8 @@ void parameterizedTest2<A1, A2>(
   /// The test body which is executed for each test value.
   /// See [TestParameters] for more info on different bodies.
   dynamic Function(A1, A2) body, {
+  /// Provide a custom description builder which will build the description for all the test values test executed.
+  CustomDescriptionBuilder? customDescriptionBuilder,
   dynamic Function()? setUp,
 
   /// Provide a tearDown function to the `group` test.
@@ -67,6 +73,7 @@ void parameterizedTest2<A1, A2>(
       description,
       values,
       p2(body),
+      customDescriptionBuilder: customDescriptionBuilder,
       setUp: setUp,
       tearDown: tearDown,
       testOn: testOn,
@@ -89,6 +96,8 @@ void parameterizedTest3<A1, A2, A3>(
   /// The test body which is executed for each test value.
   /// See [TestParameters] for more info on different bodies.
   dynamic Function(A1, A2, A3) body, {
+  /// Provide a custom description builder which will build the description for all the test values test executed.
+  CustomDescriptionBuilder? customDescriptionBuilder,
   dynamic Function()? setUp,
 
   /// Provide a tearDown function to the `group` test.
@@ -104,6 +113,7 @@ void parameterizedTest3<A1, A2, A3>(
       description,
       values,
       p3(body),
+      customDescriptionBuilder: customDescriptionBuilder,
       setUp: setUp,
       tearDown: tearDown,
       testOn: testOn,
@@ -126,6 +136,8 @@ void parameterizedTest4<A1, A2, A3, A4>(
   /// The test body which is executed for each test value.
   /// See [TestParameters] for more info on different bodies.
   dynamic Function(A1, A2, A3, A4) body, {
+  /// Provide a custom description builder which will build the description for all the test values test executed.
+  CustomDescriptionBuilder? customDescriptionBuilder,
   dynamic Function()? setUp,
 
   /// Provide a tearDown function to the `group` test.
@@ -141,6 +153,7 @@ void parameterizedTest4<A1, A2, A3, A4>(
       description,
       values,
       p4(body),
+      customDescriptionBuilder: customDescriptionBuilder,
       setUp: setUp,
       tearDown: tearDown,
       testOn: testOn,
@@ -163,6 +176,8 @@ void parameterizedTest5<A1, A2, A3, A4, A5>(
   /// The test body which is executed for each test value.
   /// See [TestParameters] for more info on different bodies.
   dynamic Function(A1, A2, A3, A4, A5) body, {
+  /// Provide a custom description builder which will build the description for all the test values test executed.
+  CustomDescriptionBuilder? customDescriptionBuilder,
   dynamic Function()? setUp,
 
   /// Provide a tearDown function to the `group` test.
@@ -178,6 +193,7 @@ void parameterizedTest5<A1, A2, A3, A4, A5>(
       description,
       values,
       p5(body),
+      customDescriptionBuilder: customDescriptionBuilder,
       setUp: setUp,
       tearDown: tearDown,
       testOn: testOn,
@@ -200,6 +216,8 @@ void parameterizedTest6<A1, A2, A3, A4, A5, A6>(
   /// The test body which is executed for each test value.
   /// See [TestParameters] for more info on different bodies.
   dynamic Function(A1, A2, A3, A4, A5, A6) body, {
+  /// Provide a custom description builder which will build the description for all the test values test executed.
+  CustomDescriptionBuilder? customDescriptionBuilder,
   dynamic Function()? setUp,
 
   /// Provide a tearDown function to the `group` test.
@@ -215,6 +233,7 @@ void parameterizedTest6<A1, A2, A3, A4, A5, A6>(
       description,
       values,
       p6(body),
+      customDescriptionBuilder: customDescriptionBuilder,
       setUp: setUp,
       tearDown: tearDown,
       testOn: testOn,
@@ -237,6 +256,8 @@ void parameterizedTest7<A1, A2, A3, A4, A5, A6, A7>(
   /// The test body which is executed for each test value.
   /// See [TestParameters] for more info on different bodies.
   dynamic Function(A1, A2, A3, A4, A5, A6, A7) body, {
+  /// Provide a custom description builder which will build the description for all the test values test executed.
+  CustomDescriptionBuilder? customDescriptionBuilder,
   dynamic Function()? setUp,
 
   /// Provide a tearDown function to the `group` test.
@@ -252,6 +273,7 @@ void parameterizedTest7<A1, A2, A3, A4, A5, A6, A7>(
       description,
       values,
       p7(body),
+      customDescriptionBuilder: customDescriptionBuilder,
       setUp: setUp,
       tearDown: tearDown,
       testOn: testOn,
@@ -274,6 +296,8 @@ void parameterizedTest8<A1, A2, A3, A4, A5, A6, A7, A8>(
   /// The test body which is executed for each test value.
   /// See [TestParameters] for more info on different bodies.
   dynamic Function(A1, A2, A3, A4, A5, A6, A7, A8) body, {
+  /// Provide a custom description builder which will build the description for all the test values test executed.
+  CustomDescriptionBuilder? customDescriptionBuilder,
   dynamic Function()? setUp,
 
   /// Provide a tearDown function to the `group` test.
@@ -289,6 +313,7 @@ void parameterizedTest8<A1, A2, A3, A4, A5, A6, A7, A8>(
       description,
       values,
       p8(body),
+      customDescriptionBuilder: customDescriptionBuilder,
       setUp: setUp,
       tearDown: tearDown,
       testOn: testOn,
@@ -311,6 +336,8 @@ void parameterizedTest9<A1, A2, A3, A4, A5, A6, A7, A8, A9>(
   /// The test body which is executed for each test value.
   /// See [TestParameters] for more info on different bodies.
   dynamic Function(A1, A2, A3, A4, A5, A6, A7, A8, A9) body, {
+  /// Provide a custom description builder which will build the description for all the test values test executed.
+  CustomDescriptionBuilder? customDescriptionBuilder,
   dynamic Function()? setUp,
 
   /// Provide a tearDown function to the `group` test.
@@ -326,6 +353,7 @@ void parameterizedTest9<A1, A2, A3, A4, A5, A6, A7, A8, A9>(
       description,
       values,
       p9(body),
+      customDescriptionBuilder: customDescriptionBuilder,
       setUp: setUp,
       tearDown: tearDown,
       testOn: testOn,
@@ -348,6 +376,8 @@ void parameterizedTest10<A1, A2, A3, A4, A5, A6, A7, A8, A9, A10>(
   /// The test body which is executed for each test value.
   /// See [TestParameters] for more info on different bodies.
   dynamic Function(A1, A2, A3, A4, A5, A6, A7, A8, A9, A10) body, {
+  /// Provide a custom description builder which will build the description for all the test values test executed.
+  CustomDescriptionBuilder? customDescriptionBuilder,
   dynamic Function()? setUp,
 
   /// Provide a tearDown function to the `group` test.
@@ -363,6 +393,7 @@ void parameterizedTest10<A1, A2, A3, A4, A5, A6, A7, A8, A9, A10>(
       description,
       values,
       p10(body),
+      customDescriptionBuilder: customDescriptionBuilder,
       setUp: setUp,
       tearDown: tearDown,
       testOn: testOn,
diff --git a/lib/src/test_options/value_with_test_options.dart b/lib/src/test_options/value_with_test_options.dart
@@ -1,13 +1,26 @@
 import 'group_test_options.dart';
 import 'test_options.dart';
 
+typedef CustomDescriptionBuilder = String Function(
+    Object groupDescription, int index, Iterable<dynamic> values);
+
 class ValueWithTestOptions extends Iterable<dynamic> {
-  ValueWithTestOptions(this.value, this.testOptions);
+  ValueWithTestOptions(
+    this.value,
+    this.testOptions, {
+    this.groupDescription = '',
+    this.index = 0,
+    this.customDiscriptionBuilder,
+  });
 
   final Iterable<dynamic> value;
   final TestOptions testOptions;
+  final int index;
+  final Object groupDescription;
+  final CustomDescriptionBuilder? customDiscriptionBuilder;
 
   String get description =>
+      customDiscriptionBuilder?.call(groupDescription, index, value) ??
       '[ ${value.map((e) => e is String ? '\'$e\'' : e.toString()).join(', ')} ]';
 
   @override
@@ -21,4 +34,21 @@ class ValueWithTestOptions extends Iterable<dynamic> {
         tags: testOptions.tags,
         timeout: testOptions.timeout,
       );
+
+  ValueWithTestOptions copyWith({
+    Iterable<dynamic>? value,
+    TestOptions? testOptions,
+    int? index,
+    Object? groupDescription,
+    CustomDescriptionBuilder? customDiscriptionBuilder,
+  }) {
+    return ValueWithTestOptions(
+      value ?? this.value,
+      testOptions ?? this.testOptions,
+      groupDescription: groupDescription ?? this.groupDescription,
+      index: index ?? this.index,
+      customDiscriptionBuilder:
+          customDiscriptionBuilder ?? this.customDiscriptionBuilder,
+    );
+  }
 }
diff --git a/lib/src/util/test_value_helpers.dart b/lib/src/util/test_value_helpers.dart
@@ -37,14 +37,34 @@ void validityCheck(Iterable<dynamic> values, int length) {
 Iterable<ValueWithTestOptions> wrap(
   Iterable<dynamic> values,
   TestOptions defaultTestOptions,
+  Object groupDescription,
+  CustomDescriptionBuilder? customDiscriptionBuilder,
 ) {
+  int index = 0;
   return values.map((e) {
+    index++;
     if (e is ValueWithTestOptions) {
-      return e;
+      return e.copyWith(
+        index: index,
+        groupDescription: groupDescription,
+        customDiscriptionBuilder: customDiscriptionBuilder,
+      );
     } else if (e is Iterable<dynamic>) {
-      return ValueWithTestOptions(e, defaultTestOptions);
+      return ValueWithTestOptions(
+        e,
+        defaultTestOptions,
+        index: index,
+        groupDescription: groupDescription,
+        customDiscriptionBuilder: customDiscriptionBuilder,
+      );
     } else {
-      return ValueWithTestOptions([e], defaultTestOptions);
+      return ValueWithTestOptions(
+        [e],
+        defaultTestOptions,
+        index: index,
+        groupDescription: groupDescription,
+        customDiscriptionBuilder: customDiscriptionBuilder,
+      );
     }
   });
 }
diff --git a/lib/src/value_source.dart b/lib/src/value_source.dart
@@ -8,10 +8,18 @@ import 'util/test_value_helpers.dart';
 abstract class ValueSource implements TestSource {
   factory ValueSource(
     Iterable<dynamic> values,
-    GroupTestOptions groupTestOptions, [
+    GroupTestOptions groupTestOptions,
+    CustomDescriptionBuilder? customDiscriptionBuilder, [
     TestOptions defaultTestOptions = const TestOptions(),
   ]) =>
-      _ValueSourceImpl(wrap(values, defaultTestOptions), groupTestOptions);
+      _ValueSourceImpl(
+          wrap(
+            values,
+            defaultTestOptions,
+            groupTestOptions.description,
+            customDiscriptionBuilder,
+          ),
+          groupTestOptions);
 }
 
 class _ValueSourceImpl implements ValueSource {
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: parameterized_test
 description: Simple package that helps with executing parameterized tests. Inspired by JUnit ParameterizedTest.
-version: 1.1.2
+version: 1.1.3
 homepage: https://www.github.com/DutchCodingCompany/parameterized_test
 
 environment:
diff --git a/test/test_options/value_with_test_options_test.dart b/test/test_options/value_with_test_options_test.dart
diff --git a/test/util/test_value_helpers_test.dart b/test/util/test_value_helpers_test.dart
diff --git a/test/value_source_test.dart b/test/value_source_test.dart

Original file line number	Diff line number	Diff line change
`@@ -60,5 +60,6 @@ void parameterizedGroup(`
`60`	`60`	`onPlatform: onPlatform,`
`61`	`61`	`retry: retry,`
`62`	`62`	`),`
	`63`	`+ null,`
`63`	`64`	`).executeGroup(body);`
`64`	`65`	`}`