$FreeBSD$

Smoke testing of base utilities
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Test generation tool made as a part of Google Summer of Code '17 with FreeBSD (https://summerofcode.withgoogle.com/projects/#6426676740227072).
Refer the FreeBSD wiki (https://wiki.freebsd.org/SummerOfCode2017/SmokeTestingOfBaseUtilities) for an overview and updates.
A brief description and implementation details: https://lists.freebsd.org/pipermail/soc-status/2017-July/001079.html.
The diagram "architecture.png" briefly summarizes how different components fit with the testcase-generator.

Project layout
~~~~~~~~~~~~~~

.
├── annotations
│   └── ........................:: Annotation files (generated/user-defined)
├── scripts
│   └── ........................:: Helper scripts
├── architecture.png ...........:: A brief architecture diagram
├── add_testcase.cpp ...........:: Testcase generator
├── generate_license.cpp .......:: Customized license generator
├── generate_test.cpp ..........:: Test generator
├── logging.cpp ................:: Logger
├── read_annotations.cpp .......:: Annotation parser
└── utils.cpp ..................:: Index generator

- - -

Dependencies
~~~~~~~~~~~~
* Boost C++ libraries: The tool was tested to work with the port "boost-all-1.64.0".
* Kyua

Instructions
~~~~~~~~~~~~
* The tool needs to know about the utilities in src which don't already have tests. The list of all such utilities can be generated via -

    	make fetch_utils

  This will generate the file "scripts/utils_list".

* For generating the tests, execute the following -

  	make clean
  	make && make run