Object Mentor Blog: Unit Testing C and C++ ... with Ruby and RSpec!

Unit Testing C and C++ ... with Ruby and RSpec!

Dean Wampler — Mon, 04 Feb 2008 22:08:00 -0600

If you’re writing C/C++ code, it’s natural to write your unit tests in the same language (or use C++ for your C test code). All the well-known unit testing tools take this approach.

I think we can agree that neither language offers the best developer productivity among all the language choices out there. Most of us use either language because of perceived performance requirements, institutional and industry tradition, etc.

There’s growing interest, however, in mixing languages, tools, and paradigms to get the best tool for a particular job. <shameless-plug>I’m giving a talk March 7^th at SD West on this very topic, called Polyglot and Poly-Paradigm Programming </shameless-plug>.

So, why not use a more productive language for your C or C++ unit tests? You have more freedom in your development chores than what’s required for production. Why not use Ruby’s RSpec, a Behavior-Driven Development tool for acceptance and unit testing? Or, you could use Ruby’s version of JUnit, called Test::Unit. The hard part is integrating Ruby and C/C++. If you’ve been looking for an excuse to bring Ruby (or Tcl or Python or Java or…) into your C/C++ environment, starting with development tasks is usually the path of least resistance.

I did some experimenting over the last few days to integrate RSpec using SWIG (Simplified Wrapper and Interface Generator), a tool for bridging libraries written in C and C++ to other languages, like Ruby. The Ruby section of the SWIG manual was very helpful.

My Proof-of-Concept Code

Here is a zip file of my experiment: rspec_for_cpp.zip

This is far from a complete and working solution, but I think it shows promise. See the Current Limitations section below for details.

Unzip the file into a directory. I’ll assume you named it rspec_for_cpp. You need to have gmake, gcc, SWIG and Ruby installed, along with the RSpec “gem”. Right now, it only builds on OS X and Linux (at least the configurations on my machines running those OS’s – see the discussion below). To run the build, use the following commands:

    
        $ cd rspec_for_cpp/cpp
        $ make

You should see it finish with the lines

    
        ( cd ../spec; spec *_spec.rb )
        .........

        Finished in 0.0***** seconds

        9 examples, 0 failures

Congratulations, you’ve just tested some C and C++ code with RSpec! (Or, if you didn’t succeed, see the notes in the Makefile and the discussion below.)

The Details

I’ll briefly walk you through the files in the zip and the key steps required to make it all work.

`cexample.h`

Here is a simple C header file.

    
        /* cexample.h */
        #ifndef CEXAMPLE_H
        #define CEXAMPLE_H
        #ifdef __cplusplus
         extern "C" {
        #endif
        char* returnString(char* input);
        double returnDouble(int input);
        void  doNothing();

        #ifdef __cplusplus
         }
        #endif
        #endif

Of course, in a pure C shop, you won’t need the #ifdef __cplusplus stuff. I found this was essential in my experiment when I mixed C and C++, as you might expect.

`cpp/cexample.c`

Here is the corresponding C source file.

    
        /* cexample.h */

        char* returnString(char* input) {
            return input;
        }

        double returnDouble(int input) {
            return (double) input;
        }

        void  doNothing() {}

`cpp/CppExample.h`

Here is a C++ header file.

    
        #ifndef CPPEXAMPLE_H
        #define CPPEXAMPLE_H

        #include <string>

        class CppExample 
        {
        public:
            CppExample();
            CppExample(const CppExample& foo);
            CppExample(const char* title, int flag);
            virtual ~CppExample();

            const char* title() const;
            void        title(const char* title);
            int         flag() const;
            void        flag(int value);

            static int countOfCppExamples();
        private:
            std::string _title;
            int         _flag;
        };

        #endif

`cpp/CppExample.cpp`

Here is the corresponding C++ source file.

    
        #include "CppExample.h" 

        CppExample::CppExample() : _title("") {}
        CppExample::CppExample(const CppExample& foo): _title(foo._title) {}
        CppExample::CppExample(const char* title, int flag) : _title(title), _flag(flag) {}
        CppExample::~CppExample() {}

        const char* CppExample::title() const { return _title.c_str(); }
        void        CppExample::title(const char* name) { _title = name; }

        int  CppExample::flag() const { return _flag; }
        void CppExample::flag(int value) { _flag = value; }

        int CppExample::countOfCppExamples() { return 1; }

`cpp/example.i`

Typically in SWIG, you specify a .i file to the swig command to define the module that wraps the classes and global functions, which classes and functions to expose to the target language (usually all in our case), and other assorted customization options, which are discussed in the SWIG manual. I’ll show the swig command in a minute. For now, note that I’m going to generate an example_wrap.cpp file that will function as the bridge between the languages.

Here’s my example.i, where I named the module example.

    
        %module example
        %{
            #include "cexample.h" 
            #include "CppExample.h"    
        %}
        %include "cexample.h" 
        %include "CppExample.h"

It looks odd to have header files appear twice. The code inside the %{...%} (with a ’#’ before each include) are standard C and C++ statements, etc. that will be inserted verbatim into the generated “wrapper” file, example_wrap.cpp, so that file will compile when it references anything declared in the header files. The second case, with a ’%’ before the include statements¹, tells SWIG to make all the declarations in those header files available to the target language. (You can be more selective, if you prefer…)

Following Ruby conventions, the Ruby plugin for SWIG automatically names the module with an upper case first letter (Example), but you use require 'example' to include it, as we’ll see shortly.

Building

See the cpp/Makefile for the gory details. In a nutshell, you run the swig command like this.

    
        swig -c++ -ruby -Wall -o example_wrap.cpp example.i

Next, you create a dynamically-linked library, as appropriate for your platform, so the Ruby interpreter can load the module dynamically when required. The Makefile can do this for Linux and OS X platforms. See the Ruby section of the SWIG manual for Windows specifics.

If you test-drive your code, which tends to drive you towards minimally-coupled “modules”, then you can keep your libraries and build times small, which will make the build and test cycle very fast!

`spec/cexample_spec.rb` and `spec/cppexample_spec.rb`

Finally, here are the RSpec files that exercise the C and C++ code. (Disclaimer: these aren’t the best spec files I’ve ever written. For one thing, they don’t exercise all the CppExample methods! So sue me… :)

    
        require File.dirname(__FILE__) + '/spec_helper'
        require 'example'

        describe "Example (C functions)" do
          it "should be a constant on Module" do
            Module.constants.should include('Example')
          end
          it "should have the methods defined in the C header file" do
            Example.methods.should include('returnString')
            Example.methods.should include('returnDouble')
            Example.methods.should include('doNothing')
          end
        end

        describe Example, ".returnString" do
          it "should return the input char * string as a Ruby string unchanged" do
            Example.returnString("bar!").should == "bar!" 
          end  
        end

        describe Example, ".returnDouble" do
          it "should return the input integer as a double" do
            Example.returnDouble(10).should == 10.0
          end
        end

        describe Example, ".doNothing" do
          it "should exist, but do nothing" do
            lambda { Example.doNothing }.should_not raise_error
          end
        end

and

    
    require File.dirname(__FILE__) + '/spec_helper'
    require 'example'

    describe Example::CppExample do
      it "should be a constant on module Example" do
        Example.constants.should include('CppExample')
      end
    end

    describe Example::CppExample, ".new" do
      it "should create a new object of type CppExample" do
        example = Example::CppExample.new("example1", 1)
        example.title.should == "example1" 
        example.flag.should  == 1
      end
    end

    describe Example::CppExample, "#title(value)" do
      it "should set the title" do
        example = Example::CppExample.new("example1", 1)
        example.title("title2")
        example.title.should == "title2" 
      end
    end

    describe Example::CppExample, "#flag(value)" do
      it "should set the flag" do
        example = Example::CppExample.new("example1", 1)
        example.flag(2)
        example.flag.should == 2
      end
    end

If you love RSpec like I do, this is a very compelling thing to see!

And now for the small print:

Current Limitations

As I said, this is just an experiment at this point. Volunteers to make this battle-ready would be most welcome!

General

The Example `Makefile` File

It Must Be Hand Edited for Each New or Renamed Source File

You’ve probably already solved this problem for your own make files. Just merge in the example Makefile to pick up the SWIG- and RSpec-related targets and rules.

It Only Knows How to Build Shared Libraries for Mac OS X and Linux (and Not Very Well)

Some definitions are probably unique to my OS X and Linux machines. Windows is not supported at all. However, this is also easy rectify. Start with the notes in the Makefile itself.

The `module.i` File Must Be Hand Edited for Each File Change

Since the format is simple, a make task could fill a template file with the changed list of source files during the build.

Better Automation

It should be straightforward to provide scripts, IDE/Editor shortcuts, etc. that automate some of the tasks of adding new methods and classes to your C and C++ code when you introduce them first in your “spec” files. (The true TDD way, of course.)

Specific Issues for C Code Testing

I don’t know of any other C-specific issues, so unit testing with Ruby is most viable today for C code. Although I haven’t experimented extensively, C functions and variables are easily mapped by SWIG to a Ruby module. The Ruby section of the SWIG manual discusses this mapping in some detail.

Specific Issues for C++ Code Testing

More work will be required to make this viable. It’s important to note that SWIG cannot handle all C++ constructs (although there are workarounds for most issues, if you’re committed to this approach…). For example, namespaces, nested classes, some template and some method overloading scenarios are not supported. The SWIG manual has details.

Also, during my experiment, SWIG didn’t seem to map const std::string& objects in C++ method signatures to Ruby strings, as I would have expected (char* worked fine).

Is It a Viable Approach?

Once the General issues listed above are handled, I think this approach would work very well for C code. For C++ code, there are more issues that need to be addressed, and programmers who are committed to this strategy will need to tolerate some issues (or just use C++-language tools for some scenarios).

Conclusions: Making It Development-Team Ready

I’d like to see this approach pushed to its logical limit. I think it has the potential to really improve the productivity of C and C++ developers and the quality of their test coverage, by leveraging the productivity and power of dynamically-typed languages like Ruby. If you prefer, you could use Tcl, Python, even Java instead.

License

This code is complete open and free to use. Of course, use it at your own risk; I offer it without warranty, etc., etc. When I polish it to the point of making it an “official” project, I will probably release under the Apache license.

¹ I spent a lot of time debugging problems because I had a ’#’ where I should have had a ’%’! Caveat emptor!

"Unit Testing C and C++ ... with Ruby and RSpec!" by Singles

Sun, 29 Jan 2012 11:38:55 -0600

great site, kudos

"Unit Testing C and C++ ... with Ruby and RSpec!" by san antonio dental

Sat, 24 Dec 2011 01:01:19 -0600

I have to say this post was certainly informative and contains useful content for enthusiastic visitors. I will definitely bookmark this blog for future reference and further viewing. Thanks a bunch for sharing this with us!

"Unit Testing C and C++ ... with Ruby and RSpec!" by Breguet watches

Fri, 23 Dec 2011 21:20:24 -0600

at the card

"Unit Testing C and C++ ... with Ruby and RSpec!" by music production

Wed, 07 Dec 2011 12:21:44 -0600

I am totally agreed with the commenter above me. It’s really unbelievable.

"Unit Testing C and C++ ... with Ruby and RSpec!" by hp storage servers

Wed, 16 Nov 2011 03:09:36 -0600

really nice one good article

"Unit Testing C and C++ ... with Ruby and RSpec!" by Dr Dre beats Headphones Canada

Sat, 12 Nov 2011 02:20:34 -0600

As used on the head headphones, so people not necessarily seeing the way the case for basic procedures,

"Unit Testing C and C++ ... with Ruby and RSpec!" by Beats By Dre Canada

Tue, 08 Nov 2011 20:03:40 -0600

in describing the evaluation of our Studio before it is necessary to talk about this wire to the ascension of the sound quality.

"Unit Testing C and C++ ... with Ruby and RSpec!" by christian louboutin

Thu, 03 Nov 2011 09:12:54 -0500

The professional design make you foot more comfortable. Even more tantalizing,this pattern make your legs look as long as you can,it will make you looked more attractive.Moveover,it has reasonable price.If you are a popular woman,do not miss it.

Technical details of Christian Louboutin Velours Scrunch Suede Boots Coffee:

Color: Coffee
Material: Suede
4(100mm) heel
Signature red sole x

Fashion, delicate, luxurious Christian louboutins shoes on sale, one of its series is Christian Louboutin Tall Boots, is urbanism collocation. This Christian louboutins shoes design makes people new and refreshing. Red soles shoes is personality, your charm will be wonderful performance.

"Unit Testing C and C++ ... with Ruby and RSpec!" by vintage lace wedding dresses

Wed, 05 Oct 2011 09:42:51 -0500

the best vintage lace wedding dresses show

"Unit Testing C and C++ ... with Ruby and RSpec!" by Tom

Mon, 19 Sep 2011 09:48:31 -0500

Based on integral subsystem considerations, the fully integrated test program requires considerable systems analysis and trade-off studies to arrive at the evolution of specifications over a given time period. Ekonomi

"Unit Testing C and C++ ... with Ruby and RSpec!" by Monster Cable Beats

Wed, 24 Aug 2011 04:04:12 -0500

If Monster Beats Dr Dre Headphones help in tracking down arsonists who it and didn’t get better control. In order to be able to solve crimes in time, Berlin police at present a reward of 5000 euros gather clues.

"Unit Testing C and C++ ... with Ruby and RSpec!" by Monster Cable Beats

Wed, 24 Aug 2011 04:02:29 -0500

if for the government, good at expression through other routes, and Monster Beats Dr Dre Tour should not be hurt civilians with the way to vent their emotions.

"Unit Testing C and C++ ... with Ruby and RSpec!" by Monster Cable Beats

Wed, 24 Aug 2011 03:56:21 -0500

This shows, in fact Berlin have to individual burning cars became accustomed to, Lady Gaga Heartbeats think this is mischief.

"Unit Testing C and C++ ... with Ruby and RSpec!" by beats by dre store

Tue, 23 Aug 2011 03:38:50 -0500

sense of our technological identity, a sense of who we are and what wehigh quality headphones new design headphones

"Unit Testing C and C++ ... with Ruby and RSpec!" by beats by dre store

Tue, 23 Aug 2011 03:34:26 -0500

we all need a sense of our technological identity, a sense of who we are and what we

"Unit Testing C and C++ ... with Ruby and RSpec!" by Crystal Jewellery

Thu, 18 Aug 2011 06:29:47 -0500

Great post! Nice and informative, I really enjoyed reading it and will certainly share this post with my friends . Read everything you ever wanted to know about engagement rings

"Unit Testing C and C++ ... with Ruby and RSpec!" by Dave

Fri, 29 Jul 2011 22:09:43 -0500

To get the most of out of technology we all need a sense of our technological identity, a sense of who we are and what we need to do to see to it that technology will help us get there. Tooway Pro

"Unit Testing C and C++ ... with Ruby and RSpec!" by Beth

Thu, 21 Jul 2011 15:22:32 -0500

This process can be engaged in a group, but you don’t want to influence anyone or be swayed by someone as you create your initial free-form dream list of goals. Buy and sell for free online

"Unit Testing C and C++ ... with Ruby and RSpec!" by http://www.leprechaun-software.com

Sun, 10 Jul 2011 17:20:21 -0500

Very Nice Article About Unit Testing. Thanks for the valuable information.

"Unit Testing C and C++ ... with Ruby and RSpec!" by mofei

Wed, 06 Jul 2011 20:58:21 -0500

Our goal is to meet the needs of the customer.If you buy more,we can give you some convenient.For our old customer,we will give a discount. mens sandals womens sandals size 12 narrow womens sandals harley davidson womens sandals womens sandals with arch support white womens sandals sandals for women

women sandals for cheap born womens sandals womens size 12 sandals womens sandals size 11 womens red sandals womens golf sandals keen womens sandals women sandals sale sandals women

"Unit Testing C and C++ ... with Ruby and RSpec!" by hcg diet atlanta

Sat, 18 Jun 2011 03:18:15 -0500

The theme is superb. I have just bookmarked your site. There are some conspicuous points you mentioned. It’s really worth reading. Keep going. hcg diet atlanta

"Unit Testing C and C++ ... with Ruby and RSpec!" by beats by dr dre headphones

Wed, 08 Jun 2011 20:48:19 -0500

Beats by dr dre studio with look after talk in white. extra attributes on Monster Beats By Dr. Dre Pro Headphones Black a specific tri-fold design and design and carrying circumstance which make for compact and uncomplicated safe-keeping when not in use. Beats by dr dre solo .

"Unit Testing C and C++ ... with Ruby and RSpec!" by epl stream

Sun, 05 Jun 2011 23:43:19 -0500

I think it shows promise.

"Unit Testing C and C++ ... with Ruby and RSpec!" by free live stream

Sun, 05 Jun 2011 23:42:44 -0500

a make task could fill a template file with the changed list of source files during the build

"Unit Testing C and C++ ... with Ruby and RSpec!" by Jewellery

Sat, 04 Jun 2011 05:26:23 -0500

i am happyr for your responses

Object Mentor Blog: Unit Testing C and C++ ... with Ruby and RSpec!

Unit Testing C and C++ ... with Ruby and RSpec!

My Proof-of-Concept Code

The Details

cexample.h

cpp/cexample.c

cpp/CppExample.h

cpp/CppExample.cpp

cpp/example.i

Building

spec/cexample_spec.rb and spec/cppexample_spec.rb

Current Limitations

General

The Example Makefile File

The module.i File Must Be Hand Edited for Each File Change

Better Automation

Specific Issues for C Code Testing

Specific Issues for C++ Code Testing

Is It a Viable Approach?

Conclusions: Making It Development-Team Ready

License

"Unit Testing C and C++ ... with Ruby and RSpec!" by Singles

"Unit Testing C and C++ ... with Ruby and RSpec!" by san antonio dental

"Unit Testing C and C++ ... with Ruby and RSpec!" by Breguet watches

"Unit Testing C and C++ ... with Ruby and RSpec!" by music production

"Unit Testing C and C++ ... with Ruby and RSpec!" by hp storage servers

"Unit Testing C and C++ ... with Ruby and RSpec!" by Dr Dre beats Headphones Canada

"Unit Testing C and C++ ... with Ruby and RSpec!" by Beats By Dre Canada

"Unit Testing C and C++ ... with Ruby and RSpec!" by christian louboutin

"Unit Testing C and C++ ... with Ruby and RSpec!" by vintage lace wedding dresses

"Unit Testing C and C++ ... with Ruby and RSpec!" by Tom

"Unit Testing C and C++ ... with Ruby and RSpec!" by Monster Cable Beats

"Unit Testing C and C++ ... with Ruby and RSpec!" by Monster Cable Beats

"Unit Testing C and C++ ... with Ruby and RSpec!" by Monster Cable Beats

"Unit Testing C and C++ ... with Ruby and RSpec!" by beats by dre store

"Unit Testing C and C++ ... with Ruby and RSpec!" by beats by dre store

"Unit Testing C and C++ ... with Ruby and RSpec!" by Crystal Jewellery

"Unit Testing C and C++ ... with Ruby and RSpec!" by Dave

"Unit Testing C and C++ ... with Ruby and RSpec!" by Beth

"Unit Testing C and C++ ... with Ruby and RSpec!" by http://www.leprechaun-software.com

"Unit Testing C and C++ ... with Ruby and RSpec!" by mofei

"Unit Testing C and C++ ... with Ruby and RSpec!" by hcg diet atlanta

"Unit Testing C and C++ ... with Ruby and RSpec!" by beats by dr dre headphones

"Unit Testing C and C++ ... with Ruby and RSpec!" by epl stream

"Unit Testing C and C++ ... with Ruby and RSpec!" by free live stream

"Unit Testing C and C++ ... with Ruby and RSpec!" by Jewellery

`cexample.h`

`cpp/cexample.c`

`cpp/CppExample.h`

`cpp/CppExample.cpp`

`cpp/example.i`

`spec/cexample_spec.rb` and `spec/cppexample_spec.rb`

The Example `Makefile` File

The `module.i` File Must Be Hand Edited for Each File Change