README
¶
gotestmd
Tool to generate go tests based on markdown files.
Usages
Generate suites with default bash runner:
gotestmd INPUT_DIR OUTPUT_DIR
Generate suites that using a custom runner:
gotestmd INPUT_DIR OUTPUT_DIR BASE_PKG
Makrdown syntax
#Run- OPTIONAL - Contains any text andbashsteps. Can be any level, should be used once in a file.#Cleanup- OPTIONAL - Containsbashsteps. Can be any level, should be used once in a file.#Requires- OPTIONAL - Contains a list of required dependencies in format markdown links.#Includes- OPTIONAL -Contains a list of using examples in context of this example in format markdown links.
To generate minimal suite required one of sections: Run or Cleanup or Requires.
Examples
See at examples
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
gotestmd
Package gotestmd contains roots command of gotestmd
|
Package gotestmd contains roots command of gotestmd |
|
internal
|
|
|
config
Package config contains gotestmd configuration
|
Package config contains gotestmd configuration |
|
generator
Package generator contains templates and generating logic for suites
|
Package generator contains templates and generating logic for suites |
|
linker
Package linker provides a linker to add links between examples
|
Package linker provides a linker to add links between examples |
|
parser
Package parser provides a markdown file reader and model
|
Package parser provides a markdown file reader and model |
|
pkg
|
|
|
bash
Package bash provides bash command helpers
|
Package bash provides bash command helpers |
|
suites/shell
Package shell provides shell helpers and shell based suites
|
Package shell provides shell helpers and shell based suites |
Click to show internal directories.
Click to hide internal directories.