Tag function for Parameterized testing with Markdown table.
MIT License
This library provide Tag functions for Parameterized testing with Markdown-like table.
This is inspired by jest-each.
Install with npm:
npm install parameterized-table-template
import * as assert from "assert";
import { parameterizedTableTag } from "parameterized-table-template";
describe("example", () => {
describe("sum tests", () => {
// function for testing
const sum = (x, y) => x + y;
// generate tests
parameterizedTableTag`
first | second | expected
${1} | ${2} | ${3}
${2} | ${1} | ${3}
${2} | ${2} | ${4}
`.forEach(({ first, second, expected }) => {
it(`${first} + ${second} = ${expected}`, () => {
assert.strictEqual(sum(first, second), expected);
});
});
});
});
Notes: For TypeScript User
// parameterizedTableTag allow to pass generics type
parameterizedTableTag<{ first: number, second: number, expected: number }>`
first | second | expected
${1} | ${2} | ${3}
${2} | ${1} | ${3}
${2} | ${2} | ${4}
`.forEach(({ first, second, expected }) => {
it(`${first} + ${second} = ${expected}`, () => {
assert.strictEqual(sum(first, second), expected);
});
});
parameterizedTableTag
: object[]
parameterizedTableTag
is a Tag functions.
It return array of object that is defined in table.
parameterizedTableTag
takes a tagged template string with:
|
${value}
syntax.const table = parameterizedTableTag`
first | second | expected
${1} | ${2} | ${3}
${2} | ${1} | ${3}
${2} | ${2} | ${4}
`;
/*
[
{
"expected": 3,
"first": 1,
"second": 2
},
{
"expected": 3,
"first": 2,
"second": 1
},
{
"expected": 4,
"first": 2,
"second": 2
}
]
*/
See Releases page.
Install devDependencies and Run npm test
:
npm test
Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
git checkout -b my-new-feature
git commit -am 'Add some feature'
git push origin my-new-feature
MIT azu
It is based on jest-each.