thinline 0.1.0

A parser and builder for function-unittests written in comment sections for C-language family.
docs.rs failed to build thinline-0.1.0
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.
Visit the last successful build: thinline-0.3.1

Description

Thinline is a project for handling and executing unittests written in function comment sections for C/C++. It's currently under development and has an early alpha state.

Installation

Requirements

To use thinline you need a valid Rust installation and its package manager cargo. Depending on your OS you can install them via the package manager you like the most. Besides this you can use rustup if you want but keep in mind that this can conflict with already existing installations of rust, so uninstall them first. It is also necessary to have a g++ installed to build your unittest later on (when running thinline with --dry-run you don't need this since the testfiles are only created). When you want to execute the examples out of the box you should make sure you have cmake and make and google test.

Besides this thinline uses the rust clang implementation, so please make sure to also fulfill its requirements.

Manual installation

Just clone this repo and then this simple installation command should be enough:

cargo install

CLI-Usage

The usage of the CLI-tool is basically simple. When preparation is done thinline --help prints the usage:

USAGE:
    thinline [FLAGS] [OPTIONS] <SOURCE-DIR>
FLAGS:
    -b, --build      Executes the build script steps given in the project thinline setting file.
    -d, --dry-run    Creates only the test files in the projects .thinline folder without exexcuting them.
    -h, --help       Prints help information
    -V, --version    Prints version information
    -v               Set the verbosity level (`v` -> DEBUG, `vv` -> TRACE)
OPTIONS:
    -p, --project-config <YAML_FILE>    The name of the yaml file where the C/C++ project parameters for thinline are
                                        stored. This file has to be at <SOURCE-DIR>. [default: .thinline.yml]
ARGS:
    <SOURCE-DIR>    The directory where the sources for test-extraction are located