Data Matrix
!
DataMatrix
日本語
Diligent developer, is it your work to crete many lengthy code for unit tests?
Let's be lazy.
Write all
(Before) |
Too long and duplicated
it('[morning] boy (max): discount 50%', () => {
const service = new FooService();
const discount = service.calcDiscount('morning', true, 10);
expect(discount).toEqual(-0.5);
});
it('[morning] boy (above): no discount', () => {
const service = new FooService();
const discount = service.calcDiscount('morning', true, 11);
expect(discount).toEqual(0.0);
});
it('[morning] senior man (under): no discount', () => {
const service = new FooService();
const discount = service.calcDiscount('morning', true, 64);
expect(discount).toEqual(0.0);
});
...
|
List
(Before) |
Still duplicated
const tests = [
{ time: 'morning', isMale: true, age: 10, expect: -0.5, label: '[morning] boy ...' },
{ time: 'morning', isMale: true, age: 11, expect: 0.0, label: '[morning] boy ...' },
{ time: 'morning', isMale: true, age: 64, expect: 0.0, label: '[morning] senior ...' },
...
];
for (const test of tests) {
it(test.label, () => {
...
|
Data matrix
(After) |
Readable and no duplication
const tests = buildDataMatrix([
[
'time isMale age expect label', // Header
], [//-------------------------------------------------------
['morning', true, 10, -0.5, '[morning] boy ...'],
[ 11, 0.0, '[morning] boy ...'],
[ 64, 0.0, '[morning] senior ...'],
...
]
])
for (const test of tests) {
it(test.label, () => {
...
|
What?
Data list creator for JavaScript and TypeScript.
Why?
- Less code: you don't have to write lengthy code any more for unit test
- Readable: less code helps you to understand test cases and find mistake
- Learning cost: basic takes only 1 step, full function takes 5 only steps to learn
Quick start
``
js
import { buildDataMatrix } from '@working-sloth/data-matrix';
// define test param
type Test = { time: string, isMale: boolean; age: number, expect: number, label: string };
// buildDataMatrix convert the matrix to test list
const tests = buildDataMatrix(
[
['time', 'isMale', 'age', 'expect', 'label'] // Header
], [//-------------------------------------------------------
// Lacking values will be filled from LEFT to RIGHT with previous value
['morning', true, 10, -0.5, '[morning] boy (max): discount 50%'],
[/morning/ /true/ 11, 0.0, '[morning] boy (above): no discount'],
[ 64, 0.0, '[morning] senior man (under): no discount'],
[ 65, -0.5, '[morning] senior man (min): discount 50%'],
[ false, 10, -0.5, '[morning] girl (max): discount 50%'],
[ /false/ 11, 0.0, '[morning] girl (above): no discount'],
...
]
);
// Test loop
for (const test of tests) {
it(test.label, () => {
// Given
const service = new FooService();
// When
const discount = service.calcDiscount(test.time, test.isMale, test.age);
// Then
expect(discount).toEqual(test.expect);
});
}
``
Other samples
I have a truly marvelous sample of this case which this margin is too narrow to contain.
See samples
Schedule
- Crate docs: someday
- Extension for VS Code (matrix formatter & header generator): someday
- Rest: every day
- Sleep: every day
- Be clever and lazy: soon
- Be stupid and diligent: never
If you aren't satisfied
-
Open an issue such as "question" or "enhancement"
- e-mail: koba.work.work1127@gmail.com