Test.Cleveland.Doc.Common

Utilities for testing documentations sanity.

These tests serve to ensure that documentation generation is not broken and that user follows sane documentation structure (e.g. contract should be named, some entities require description, e.t.c).

Documentation

data DocTest

Test case for contract documentation.

Constructors

DocTest

Fields

• dtDeclLoc :: SrcLoc

  Declaration location, used to distinguish different test predicates. This is primarily used in excludeDocTest.

• dtDesc :: String

  Description of predicate, which you put to testCase.

• dtSuite :: HasCallStack => ContractDoc -> Assertion

  Test itself.

Instances

Buildable DocTest

Defined in Test.Cleveland.Doc.Common

Methods

build :: DocTest -> Builder

Eq DocTest

Defined in Test.Cleveland.Doc.Common

Methods

(==) :: DocTest -> DocTest -> Bool

(/=) :: DocTest -> DocTest -> Bool

mkDocTest :: HasCallStack => String -> (HasCallStack => ContractDoc -> Assertion) -> DocTest

Construct DocTest.

Note: you should not declare helpers with this function rather use it directly in every test suite.

excludeDocTest :: HasCallStack => DocTest -> [DocTest] -> [DocTest]

Exclude given test suite.

excludeDocTests :: [DocTest] -> [DocTest] -> [DocTest]

Calling excludeDocTests tests toExclude returns all test suites from tests which are not present in toExclude.

runDocTests :: (ContainsDoc code, HasCallStack) => [DocTest] -> code -> [TestTree]

Finalize test suites.

expectDocTestFailure :: ContainsDoc code => DocTest -> code -> Assertion

Ensure that DocTest check fires on given contract. Used in tests on this module.

Utilities

allContractLayers :: ContractDoc -> [(Maybe SomeDocItem, DocBlock)]

Collect all doc groups (created with DocGroup instruction) within a contract recursively. The result will contain grouping doc item itself (unless we are at root) and its subcontents.

allContractDocItems :: DocItem d => ContractDoc -> [d]

Collect all doc items (atomic and grouping) recursively.

Misc

buildDocTest :: ContainsDoc a => a -> ContractDoc

Like buildDoc, but does not require documentation to be finalized.

buildMarkdownDocTest :: ContainsDoc a => a -> LText

Like buildMarkdownDoc, but does not require documentation to be finalized.