package testo-util

  1. Overview
  2. Docs
On This Page
  1. Test tags

Module Testo_util.TagSource

Test tags

A tag contributes to describing what a test is about in addition to the test's name and category. Additionally, it allows for the precise selection of a group of tests via the command line.

Sourcetype t = private string

Tags are strings. This is nice and extensible, but to prevent misspellings and conflicts, we require them to be registered using declare.

Sourceval declare : string -> t

Create and register a tag. This function raises exceptions if used improperly.

A tag must be created exactly once. It must be a non-empty dot-separated sequence of lowercase alphanumeric identifiers ([a-z_][a-z_0-9]*).

Sourceval list : unit -> t list

List all the registered tags.

Sourceval compare : t -> t -> int

Compare two tags in ASCII (alphabetic) order.

Sourceval equal : t -> t -> bool

Determine if two tags are equal.

Sourceval to_string : t -> string

Convert the tag back to the original string.

Sourceval of_string_opt : string -> t option

Convert a tag from a string, failing is the tag wasn't declared.

Sourceval show : t -> string

Convert the tag to human-readable form (which happens to be the same as the original string).