parameterized_test 1.0.0

Simple package that helps with executing parameterized tests. Inspired by JUnit ParameterizedTest.

🧪 Parameterized test

Supercharge your Dart testing with parameterized_test! Built on top of the dart test package, this JUnit ParameterizedTest inspired package wrap around group and test to take your testing to the next level!

Table of contents

• Features
• Installation
• Usage
• Examples
• How it works
• Additional information

Features ✨

• ✅ Run a test multiple times based on provide parameter list.

• ✅ Uses dart test package under the hood.

• ✅ Type cast test parameters used in the tests.

• ✅ Include test options for parameter_test.

• ✅ Include test options per parameters.

• ❌ No CSV parsing is supported. Its only possible to use Lists with actual values.

Installation

dev_dependencies:                    
  parameterized_test: [latest-version] 

Usage

Instead of using groups or test you can now use parameterizedTest and supply it list of test parameters to use in the same test. To specify the test body use TestParametersX that matches the same amount of test parameters for 1 test. For example when the test has 2 parameters actual and expected use TestParameters2 for supplying the test body. The package offers TestParameters classes up to 10 parameters. Instead of writing TestParameters completely it also possible to use typedef's p1..p10.

Examples

Example parameterizedTest with 1 parameter:

parameterizedTest(
  'Number are less than 4 tests',
  [
    1,
    2,
    3,
  ],
  p1((int number) {
    final result = number < 4;
    expect(result, true);
  }),
);

Example parameterizedTest with 2 parameters:

parameterizedTest(
  'Amount of letters tests',
  [
    ['kiwi', 4],
    ['apple', 5],
    ['banana', 6],
  ],
  p2((String word, int length) {
    expect(word.length, length);
  }),
);

Example parameterizedTest with extra test options for a value:

parameterizedTest(
  'Amount of letters',
  [
    ['kiwi', 4],
    ['apple', 5],
    ['banana', 6].withTestOptions(skip: true),
  ],
  p2((String word, int length) {
    expect(word.length, length);
  }),
);

Example parameterizedTest with test enum values:

enum AwesomeEnum { such, woow, much, skill}

parameterizedTest(
  'Doge enum tests',
  AwesomeEnum.values,
  p1((AwesomeEnum doge) {
    final result = doge.name.length >= 4;
    expect(result, true);
  }),
);

How it works

parameterized_test is basically a wrapper that executes a group test and loops over the provide List of test values. Each set of values is cast to the specified type inside the body. Which is wrapped inside a test.

parameterizedTest(
  'Amount of letters',
  [
    ['kiwi', 4],
    ['apple', 5],
    ['banana', 6],
  ],
  p2((String word, int length) {
    expect(word.length, length);
  }),
);

The above example roughly translates to:

group('Amount of letter', () {
  final testValues = [
    ['kiwi', 4],
    ['apple', 5],
    ['banana', 6],
  ],

  for(final testValue in testValues){
    test(testValue.toString(), () {
      final String word = testValue[0] as String;
      final int length = testValue[1] as int;
      
      expect(word.length, length);
    });
  }
});

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.

For example:

class MyParameters implements TestParameters{
  const MyParameters(this.body);

  @override
  final dynamic Function(A1, A2) body;

  @override
  final int count = 2;

  @override
  void mapBody<R>(Iterable<R> values) {
  final A1 a1 = values.elementAt(0) as A1;
  final A2 a2 = values.elementAt(1) as A2;
  body(a1, a2);
  }
  }
  
}

Additional information

Its just a simple wrapper to easily execute tests multiple times with different values. Feel free to leave some feedback or open an pull request :)