thinline 0.1.0

A parser and builder for function-unittests written in comment sections for C-language family.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

<p align="center">
    <img src="./.github/logo.png">
</p>
<p align="center">
    <a href="https://travis-ci.org/Drogglbecher/thinline"><img alt="Travis Status" src="https://travis-ci.org/Drogglbecher/thinline.svg"></a>
    <a href="https://ci.appveyor.com/project/Drogglbecher/thinline"><img alt="Appveyor Status" src="https://ci.appveyor.com/api/projects/status/r3ldomvr2plv336t/branch/master?svg=true"></a>
    <a href="https://coveralls.io/github/Drogglbecher/thinline?branch=master"><img alt="Test Coverage" src="https://coveralls.io/repos/github/Drogglbecher/thinline/badge.svg?branch=master"></a>
    <a href="https://drogglbecher.github.io/thinline"><img alt="Documentation" src="https://img.shields.io/badge/master_doc-thinline-blue.svg"></a>
    <a href="https://github.com/Drogglbecher/thinline/blob/master/LICENSE"><img alt="License Apache 2" src="https://img.shields.io/badge/license-Apache%202-blue.svg"></a>
</p>

## 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](https://www.rust-lang.org/en-US/install.html) installation and its package
manager [cargo](https://crates.io/install). Depending on your OS you can install them via the package manager you
like the most. Besides this you can use [rustup](https://rustup.rs/) 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](https://github.com/google/googletest).

Besides this _thinline_ uses the [rust clang implementation](https://github.com/KyleMayes/clang-rs), so please make
sure to also fulfill its [requirements](https://github.com/KyleMayes/clang-sys#dependencies).

### 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](#preparation-and-configuration) 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
```