Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

Crash to Pass Toolkit

legacy-build, legacy-suggest and gen-xfakes

This repo has two scripts to help C and C++ programmers drag unwilling legacy C and C++ into a test harness.

The recipe for getting legacy C/C++ is described in TDD How-to: Get your Legacy C Into a Test Harness

legacy-build.sh

Runs the makefile in the working directory, captures the output, passes it to legacy-suggest which may make a suggestion about how to solve the current problem. If you use CppUTest, some suggestions can be cut and pasted into your makefile.

Finally, when you get to linker errors, legacy-build will generate eploding fakes to get you past linker problems and on to running your code.

Set your build so that it fails on the first error. For gcc and clang -Wfatal-errors.

So far, this has been tested on

  • ubuntu gcc version 9.3.0.
  • mac osx gcc version 7.4.0

legacy-suggest

Takes a gcc compiler error output, and filters the error, and makes a suggestion.

The suggestions handle a couple common legacy code test-build problems, like missing includes and linker errors.

legacy-gen-xfakes

Generate exploding fakes from c/c++ linker error output (used for unit testing).

For C linker errors, the resutling file can be added to the build and those link errors go away. They later turn into runtime errors as exit the test runner whenever you code executes and exploding fake. For C++ errors, you need to do some editing.

Usage

Capture the linker error output and feed it to the exploding fakes generator


$ make 2>error-output.txt
$ path/to/legacy-gen-xfakes.sh error-output.txt xfakes

legacy-gen-xfakes.sh produces three files with the supplied basename xfakes

xfakes-c.c C linkage fakes, ready to add to your build
xfakes-cpp.cpp C++ linkage fakes, edits needed
xfakes-cpp-globals.cpp C++ undefined globals, edits needed

Supported formats

  • g++ linker output
  • clang
  • Visual Studio -- best guess
  • Feel free to give me a contribution
  • All these compilers are moving target, so you may have to fiddle with it.

To be supported formats

Examples

See test/example-output/gcc-link-errors.txt for example input. The output files are found in test/golden.

A full explanation of how to use gen-xfakes is on my blog here.

Run the tests on your machine

Clone everying including the tests

$ git clone <repo>
$ git submodule update --init

Run the tests

cd tests
./all-tests.sh

About

Generate exploding fakes from c/c++ linker error output (used for unit testing)

Resources

License

Releases

No releases published

Packages

No packages published