makeTestSuite(): TestSuite
Creates a new test suite based on the config. The test suite should be exported from JS files, either as a default, or named export.
- path* (string \| !Array<string>): The path to the mask result file or directory. Can also pass an array of paths.
- config* MaskConfig: Configuration for making test suites.
The exported test suite will be run with _Zoroaster_ Context-Testing Framework. The simplest form of a mask is to use the `getResults` property, which acts as a template for test cases, which will receive the inputs (e.g., `input`) from the mask result as properties of the `this` context, and the contexts via the arguments. The output will be compared to the `expected` property of the mask.
_For example, given the following function:_
```js
import read from '@wrote/read'
/**
* An example function that reads a file.
* @param {string} path The path to the file to read.
* @param {string} input The string to prepend.
*/
const fn = async (path, input) => {
const res = await read(path)
return `${input}: ${res}`
}
export default fn
```
_Zoroaster can test it using a mask:_
| Mask | Mask Result |
|---|---|
| ```js /* yarn example/ */ import makeTestSuite from '@zoroaster/mask' import fn from '../../src' class Context { /** * Returns the path to the fixture. */ get fixture() { return 'example/test/fixture/test.txt' } } export default makeTestSuite('example/test/result', { context: Context, /** * @param {Context} t */ async getResults({ fixture }) { const res = await fn(fixture, this.input) return res }, }) ``` | ```markdown ## runs the test hello world /* expected */ hello world: this is a test /**/ ## fails the test hello world /* expected */ not hello world: this is a test /**/ ``` |
stream.Transform \| Promise<!stream.Transform>) | A possibly async function which returns a _Transform_ stream to be ended with the input specified in the mask's result. Its output will be accumulated and compared against the expected output of the mask. | - |
| getReadable | (this: MaskContext, ...args: Context[]) => !(
stream.Readable \| Promise<!stream.Readable>) | A possibly async function which returns a _Readable_ stream constructed with the input from the mask. Its output will be stored in memory and compared against the expected output of the mask. | - |
| getThrowsConfig | (this: MaskContext, ...args: Context[]) => _assertThrows.Config | A function which should return a configuration for [`assert-throws`](https://github.com/artdecocode/assert-throws), including `fn` and `args`, when testing an error. | - |
| mapActual | (result: *) => string | The function to get a value to test against `expected` mask property from results returned by `getResults`. | - |
| assertResults | (actual: *, expected: !Object<string, *>) => (!Promise \| undefined) | A possibly async function containing any addition assertions on the results. The results from `getResults` and a map of expected values extracted from the mask's result (where `jsonProps` are parsed into JS objects) will be passed as arguments. | - |
!child_process.ForkOptions | Options for the forked processed, such as `ENV` and `cwd`. | - |
| inputs | !Array<!Array<(!RegExp \| string)>> | Inputs to push to `stdin` when `stdout` writes data. The inputs are kept on stack, and taken off the stack when the RegExp matches the written data, e.g., `[[/question/, 'answer'], [/question2/, 'answer2']]`. | - |
| stderrInputs | !Array<!Array<(!RegExp \| string)>> | Inputs to push to `stdin` when `stderr` writes data (similar to `inputs`), e.g., `[[/question/, 'answer'], [/question2/, 'answer2']]`. | - |
| log | (boolean \| { stderr: !(stream.Writable \| NodeJS.WriteStream), stdout: !(stream.Writable \| NodeJS.WriteStream) }) | Whether to pipe data from `stdout`, `stderr` to the process's streams. If an object is passed, the output will be piped to streams specified as its `stdout` and `stderr` properties. | `false` |
| includeAnswers | boolean | Whether to add the answers to the `stderr` and `stdout` output. | `true` |
| stripAnsi | boolean | Remove ANSI escape sequences from the `stdout` and `stderr` prior to checking of the result. | `true` |
| normaliseOutputs | boolean | On Windows, updates all `\n` to `\r\n`, as `console.log` only prints `\n`. | `false` |
| preprocess | (Preprocessor \| ForkPreprocessor) | The function to run on `stdout` and `stderr` before comparing it to the output. Pass an object with `stdout` and `stderr` properties for individual pre-processors. | - |
| getArgs | (this: Object, forkArgs: !Array<string>, ...contexts: Context[]) => !(Array<string> \| Promise<!Array<string>>) | The function to extend arguments to pass the fork based on the parsed mask input and contexts. The `this` context is set to the passed properties. | - |
| getOptions | (this: Object, ...contexts: Context[]) => !child_process.ForkOptions | The function to get options for the fork, such as `ENV` and `cwd`, based on contexts. The `this` context is set to the passed properties. | - |
`function(string): string` __`Preprocessor`__: The function which processes fork's outputs before returning them for asserts.
__`ForkPreprocessor`__: An object with `stdout` and `stderr` preprocessors.
| Name | Type | Description |
| ------ | ----------------------------------- | ------------------------------------------------------------------------------------------------------ |
| stdout | (stdout: string) => string | How to process `stdout` before asserts. |
| stderr | (stdout: string) => string | How to process `stderr` before asserts, for example, you can strip `\r` symbols with `clearr` package. |
|
Β© Art Decoβ’ for ContextTesting 2020 |
|
 |
|---|
