search

mirage / alcotest

A lightweight and colourful test framework
ISC License
456 stars 80 forks source link

Document `filter` parameter of `with_options` #340

Closed MisterDA closed 2 years ago

MisterDA commented 2 years ago

The parameter ?filter:( name:string -> index:int -> [ `Run | `Skip ] ) isn't documented, and I don't understand well whether it's referring to the name of the test (as a list of test cases) or a test case. I suppose it's a test, and the index refers to the index of a test case in a test.

craigfe commented 2 years ago

I suppose it's a test, and the index refers to the index of a test case in a test.

Indeed :slightly_smiling_face: The parameter exists in order to support the test subcommand of Alcotest binaries, which runs a regex over name and checks that index belongs to a given set:

SYNOPSIS
       test.exe test [OPTION]... [NAME_REGEX] [TESTCASES]

ARGUMENTS
       NAME_REGEX
           A regular expression matching the names of tests to run

       TESTCASES
           A comma-separated list of test case numbers (and ranges of numbers)
           to run, e.g: '4,6-10,19'. When specifying ranges, both '-' and '..'
           are accepted as valid separators.

A contribution to improve the API doc is very welcome. Filtering test cases will hopefully become clearer (or at least less arbitrary) with the introduction of the nestable test API.