kiri_check

Description:

kiri check

kiri-check #
kiri-check is a property-based testing library for Dart.
Features #

Integrated with package:test, it can be used in the same way as regular tests.
Additionally, property-based tests can be added without modifying existing test code.
Customization of the exploration method is easy. You can specify data ranges, increase or decrease the number of
trials, and prioritize edge cases.
Supports stateful testing. You can test the behavior of a system that changes state over time.

Install #
Install the library from pub.dev using the following command:
With Dart:
dart pub add dev:kiri_check
copied to clipboard
With Flutter:
flutter pub add dev:kiri_check
copied to clipboard
Alternatively, add the library to your pubspec.yaml and run dart pub get or flutter pub get.
dev_dependencies:
kiri_check: ^1.2.0
copied to clipboard
Documentation #
Please refer to the Documentation.
Basic usage #
Properties can be implemented as tests using package:test. Assertions use functions from package:test.

Import the kiri-check library.
import 'package:kiri_check/kiri_check.dart';
copied to clipboard

Implement properties using the property function. This function takes the title of the test and the function to
execute the test as arguments.
Implement the test to validate test data using the forAll
function. This function takes an arbitrary that generates random test data as an argument.

Example:
import 'package:kiri_check/kiri_check.dart';

dynamic fizzbuzz(int n) {
// Implement me!
}

void main() {
property('FizzBuzz', () {
forAll(
integer(min: 0, max: 100),
(n) {
final result = fizzbuzz(n);
if (n % 15 == 0) {
expect(result, 'FizzBuzz');
} else if (n % 3 == 0) {
expect(result, 'Fizz');
} else if (n % 5 == 0) {
expect(result, 'Buzz');
} else {
expect(result, n.toString());
}
},
);
});
}
copied to clipboard
Stateful testing #
Stateful testing allows you to test the behavior of a system that changes state over time.
This is particularly useful for testing stateful systems like databases,
user interfaces, or any system with a complex state machine.
To perform stateful testing, in addition to importing kiri_check/kiri_check.dart, you need to
import kiri_check/stateful_test.dart.
Example:
import 'package:kiri_check/kiri_check.dart';
import 'package:kiri_check/stateful_test.dart';

// Abstract model representing accurate specifications
// with concise implementation.
final class CounterModel {
int count = 0;

void reset() {
count = 0;
}

void increment() {
count++;
}

void decrement() {
count--;
}
}

// Real system compared with the behavior of the model.
final class CounterSystem {
// Assume that it is operated in JSON object.
Map<String, int> data = {'count': 0};

int get count => data['count']!;

set count(int value) {
data['count'] = value;
}

void reset() {
data['count'] = 0;
}

void increment() {
data['count'] = data['count']! + 1;
}

void decrement() {
data['count'] = data['count']! - 1;
}
}

// Definition of stateful test content.
final class CounterBehavior extends Behavior<CounterModel, CounterSystem> {
@override
CounterModel initialState() {
return CounterModel();
}

@override
CounterSystem createSystem(CounterModel s) {
return CounterSystem();
}

@override
List<Command<CounterModel, CounterSystem>> generateCommands(CounterModel s) {
return [
Action0(
'reset',
nextState: (s) => s.reset(),
run: (system) {
system.reset();
return system.count;
},
postcondition: (s, count) => count == 0,
),
Action0(
'increment',
nextState: (s) => s.increment(),
run: (system) {
system.increment();
return system.count;
},
postcondition: (s, count) => s.count + 1 == count,
),
Action0(
'decrement',
nextState: (s) => s.decrement(),
run: (system) {
system.decrement();
return system.count;
},
postcondition: (s, count) => s.count - 1 == count,
),
];
}

@override
void destroySystem(CounterSystem system) {}
}

void main() {
property('counter', () {
// Run a stateful test.
runBehavior(CounterBehavior());
});
}
copied to clipboard
For more detailed information on stateful testing, including advanced usage and customization options, please refer
to Stateful Testing.
Known issues #

#13 Test results in IntelliJ IDEA do not reflect tearDownAll

TODO #

Example database
Replace the PRNG with xorshift to improve performance and remove dependency on current PRNG
Reimplement the cache mechanism with a reproducible PRNG using internal state

Author #
SUZUKI Tetsuya ([email protected])
License #
Apache License, Version 2.0