scons-tool-cxxtestgen 0.2.0

SCons tool for cxxtestgen command

SCons tool for cxxtestgen command.

Installation

There are few ways to install this tool for your project.

From pypi

This method may be preferable if you build your project under a virtualenv. To add cxxtestgen tool from pypi, type (within your wirtualenv):

pip install scons-tool-loader scons-tool-cxxtestgen

or, if your project uses pipenv:

pipenv install --dev scons-tool-loader scons-tool-cxxtestgen

Alternatively, you may add this to your Pipfile

[dev-packages]
scons-tool-loader = "*"
scons-tool-cxxtestgen = "*"

The tool will be installed as a namespaced package sconstool.cxxtestgen in project’s virtual environment. You may further use scons-tool-loader to load the tool.

As a git submodule

1. Create new git repository:

   mkdir /tmp/prj && cd /tmp/prj
   touch README.rst
   git init

2. Add the scons-tool-cxxtestgen as a submodule:

   git submodule add git://github.com/ptomulik/scons-tool-cxxtestgen.git site_scons/site_tools/cxxtestgen

3. For python 2.x, create __init__.py in site_tools directory:

   touch site_scons/site_tools/__init__.py

   this will allow to directly import site_tools.cxxtestgen (this may be required by other tools).

Usage example

1. Create simple test file

   // MyTestSuite1.t.h
   #include <cxxtest/TestSuite.h>
   class MyTestSuite1 : public CxxTest::TestSuite
   {
   public:
     void testAddition(void)
     {
       TS_ASSERT(1 + 1 > 1);
       TS_ASSERT_EQUALS(1 + 1, 2);
     }
   };

2. Create simple SConstruct file

   # SConstruct
   # TODO: uncomment following lines if the tool is installed via pip/pipenv
   # import sconstool.loader
   # sconstool.loader.extend_toolpath(transparent=True)
   env = Environment(tools = ['cxxtestgen'])
   env.CxxTestGen('MyTestSuite')

3. Try it out:

   scons

Builders

• CxxTestGen([target], sources, **kw) - invokes cxxtestgetn ....

• CxxTestGenPart([target], sources, **kw) - invokes cxxtestgen --part ..., this is used to generate *.t.cpp files which define tests but have no main().

• CxxTestGenRoot(target, **kw) - invokes cxxtestgen --root ..., this pseudo-builder generates the root *.t.cpp file that provides the main() function, should be used in pair with CxxTestGenPart.

Construction variables used

The following SCons construction variables might be used to customize the cxxtestgen tool.

Name	Description
CXXTESTBINPATH	search path for cxxtest executables/scripts; by default it includes the following locations: $CXXTESTINSTALLDIR/bin, $CXXTESTINSTALLDIR/python/python3/scripts, $CXXTESTINSTALLDIR/python/scripts, in that order.
CXXTESTGEN	path to cxxtestgen python script; by default it will contain a result of search, first in $CXXTESTBINPATH, then in SCons PATH.
CXXTESTGENFLAGS	additional flags to be passed to cxxtestgen.
CXXTESTGENPYTHON	python interpreter to be used to run cxxtestgen; by default it is being chosen automatically; python3 is preferred, but if the cxxtestgen seems to not support it, python2 is picked up; if neither python3 nor python2 are available in standard SCons search PATH, sys.executable (the interpreter running SCons script) is used.
CXXTESTGENRUNNER	name of the listener class for cxxtestgen (used as --runner=$CXXTESTGENRUNNER); defaults to ErrorPrinter.
CXXTESTGENSUFFIX	suffix for files produced by cxxtestgen (.t.cpp).
CXXTESTGENSRCSUFFIX	suffix of cxxtestgen’s input files (.t.h).
CXXTESTINSTALLDIR	root directory of custom cxxtest installation; defaults to #/cxxtest, where # is the project’s top-level directory.

LICENSE

Copyright (c) 2018-2020 by Paweł Tomulik <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE