Merge pull request #18 from mat007/static-mock-objects-pattern

Static mock objects pattern

.gitignore

@@ -1,2 +1,3 @@
 bin
 out
+build/xsl

.travis.yml

@@ -28,8 +28,13 @@ addons:
   apt:
     packages:
     - xsltproc
+    - docbook-xsl
+    - docbook-xml
 
 before_install:
+    - DOCBOOK_XSL_DIR=/usr/share/xml/docbook/stylesheet/docbook-xsl
+    - DOCBOOK_DTD_DIR=/usr/share/xml/docbook/schema/dtd/4.2
+
     # Set this to the name of your Boost library
     # Autodetect library name by using the following code: - PROJECT_TO_TEST=$(basename $(pwd))
     - PROJECT_TO_TEST=$(basename $(pwd))

build/build.bat

@@ -6,13 +6,6 @@ rem Distributed under the Boost Software License, Version 1.0.
 rem (See accompanying file LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt)
 
 setlocal
-goto Start
-
-:Error
-color 00
-goto :eof
-
-:Start
 
 rem error if BOOST_ROOT not set
 set BOOST=%BOOST_ROOT%
@@ -20,7 +13,7 @@ set BOOST=%BOOST_ROOT%
 pushd ..\test
 %BOOST%\b2 -q %*
 popd
-if errorlevel 1 goto Error
+if errorlevel 1 exit /b %ERRORLEVEL%
 
 set BOOSTBOOK_DIR=..\bin\turtle\boostbook
 xcopy /Y /S /Q /I %BOOST%\tools\boostbook\xsl %BOOSTBOOK_DIR%\xsl
@@ -29,9 +22,8 @@ xcopy /Y /S /Q /I boostbook %BOOSTBOOK_DIR%
 xcopy /Y /S /Q /I %BOOST%\doc\src\boostbook.css ..\doc\html
 xcopy /Y /S /Q /I %BOOST%\doc\src\images\*.png ..\doc\html\images
 xcopy /Y /S /Q /I %BOOST%\doc\src\images\callouts\*.png ..\doc\html\images\callouts
-if errorlevel 1 goto Error
+if errorlevel 1 exit /b %ERRORLEVEL%
 pushd ..\doc
 %BOOST%\b2 -q %*
 popd
-
-:End
+if errorlevel 1 exit /b %ERRORLEVEL%

build/vc100/turtle.vcxproj

@@ -19,13 +19,13 @@
     </ProjectConfiguration>
   </ItemGroup>
   <ItemGroup>
+    <ClInclude Include="..\..\include\turtle\cleanup.hpp" />
     <ClInclude Include="..\..\include\turtle\config.hpp" />
     <ClInclude Include="..\..\include\turtle\constraint.hpp" />
     <ClInclude Include="..\..\include\turtle\constraints.hpp" />
     <ClInclude Include="..\..\include\turtle\detail\action.hpp" />
     <ClInclude Include="..\..\include\turtle\detail\addressof.hpp" />
     <ClInclude Include="..\..\include\turtle\detail\child.hpp" />
-    <ClInclude Include="..\..\include\turtle\detail\cleanup.hpp" />
     <ClInclude Include="..\..\include\turtle\detail\context.hpp" />
     <ClInclude Include="..\..\include\turtle\detail\expectation_template.hpp" />
     <ClInclude Include="..\..\include\turtle\detail\formatter.hpp" />

build/vc100/turtle.vcxproj.filters

@@ -115,9 +115,6 @@
     <ClInclude Include="..\..\include\turtle\detail\child.hpp">
       <Filter>Source Files\detail</Filter>
     </ClInclude>
-    <ClInclude Include="..\..\include\turtle\detail\cleanup.hpp">
-      <Filter>Source Files\detail</Filter>
-    </ClInclude>
     <ClInclude Include="..\..\include\turtle\detail\context.hpp">
       <Filter>Source Files\detail</Filter>
     </ClInclude>
@@ -127,5 +124,8 @@
     <ClInclude Include="..\..\include\turtle\detail\formatter.hpp">
       <Filter>Source Files\detail</Filter>
     </ClInclude>
+    <ClInclude Include="..\..\include\turtle\cleanup.hpp">
+      <Filter>Source Files</Filter>
+    </ClInclude>
   </ItemGroup>
 </Project>

doc/example/patterns_static_objects.cpp

@@ -0,0 +1,67 @@
+// http://turtle.sourceforge.net
+//
+// Copyright Mathieu Champlon 2015
+//
+// Distributed under the Boost Software License, Version 1.0.
+// (See accompanying file LICENSE_1_0.txt or copy at
+// http://www.boost.org/LICENSE_1_0.txt)
+
+//[ static_objects_problem
+#define BOOST_AUTO_TEST_MAIN
+#include <boost/test/auto_unit_test.hpp>
+#include <turtle/mock.hpp>
+#include <ostream>
+
+namespace
+{
+    struct my_class
+    {
+        my_class( int i )
+            : i_( i )
+        {}
+
+        int i_;
+    };
+
+    std::ostream& operator<<( std::ostream& os, const my_class* c )
+    {
+        return os << "my_class " << c->i_; // the 'c' pointer must be valid when logging
+    }
+
+    MOCK_FUNCTION( f, 1, void( my_class* ) ) // being static 'f' outlive the test case
+}
+
+BOOST_AUTO_TEST_CASE( static_objects_problem )
+{
+    my_class c( 42 );
+    MOCK_EXPECT( f ).once().with( &c ); // the set expectation will also outlive the test case and leak into other test cases using 'f'
+} // the 'c' instance goes out of scope and the '&c' pointer becomes dangling
+//]
+
+//[ static_objects_partial_solution
+struct fixture
+{
+    ~fixture()
+    {
+        mock::reset(); // the use of a fixture ensures the reset will prevent the expectations from leaking into other test cases
+    }
+};
+
+BOOST_FIXTURE_TEST_CASE( static_object_partial_solution, fixture )
+{
+    my_class c( 42 );
+    MOCK_EXPECT( f ).once().with( &c );
+    f( &c );
+    mock::verify(); // verify the expectations before local objects are destroyed and before the fixture resets them
+}
+//]
+
+//[ static_objects_solution
+BOOST_FIXTURE_TEST_CASE( static_objects_solution, mock::cleanup ) // actually the library includes a ready to use fixture just like the one described
+{
+    my_class c( 42 );
+    MOCK_EXPECT( f ).once().with( &c );
+    f( &c );
+    mock::verify();
+}
+//]

doc/patterns.qbk

@@ -6,6 +6,7 @@
  /]
 
 [section Patterns]
+[import example/patterns_static_objects.cpp]
 [import example/patterns_async_call.cpp]
 [import example/patterns_retrieve_cref.cpp]
 [import example/patterns_invoke_functor.cpp]
@@ -13,6 +14,22 @@
 
 This section highlights not-so-obvious features of the library gathered from real use cases.
 
+[section Managing static mock objects]
+
+Problem :
+
+[static_objects_problem]
+
+Partial solution :
+
+[static_objects_partial_solution]
+
+Solution :
+
+[static_objects_solution]
+
+[endsect]
+
 [section Waiting for an asynchronous call]
 
 Problem :

doc/reference.qbk

@@ -165,7 +165,7 @@ Synopsis :
  
  MOCK_STATIC_METHOD_TPL( [calling convention] name, arity, signature[, identifier] ) // must be used if the signature uses a template parameter of the class, if 'identifier' is omitted it will default to 'name'
 
-[note A static object is used behind the scene in order to keep track of the expectations of a mock static method, therefore to ensure all tests run in isolation it is strongly suggested to manually [link turtle.reference.verification verify] and [link turtle.reference.reset reset] the static method at the end of each test.]
+[note A static object is used behind the scene in order to keep track of the expectations of a mock static method, therefore to ensure all tests run in isolation it is strongly suggested to manually [link turtle.reference.verification verify] and [link turtle.reference.reset reset] the static method at the end of each test, see the related [link turtle.patterns.managing_static_mock_objects pattern section].]
 
 [note In case of a calling convention specified, all four parameters must be provided.]
 
@@ -275,7 +275,7 @@ Synopsis :
 
  MOCK_FUNCTION( [calling convention] name, arity, signature[, identifier] ) // if 'identifier' is omitted it will default to 'name'
 
-[note A static object is used behind the scene in order to keep track of the expectations of a mock function, therefore to ensure all tests run in isolation it is strongly suggested to manually [link turtle.reference.verification verify] and [link turtle.reference.reset reset] the mock function at the end of each test.]
+[note A static object is used behind the scene in order to keep track of the expectations of a mock function, therefore to ensure all tests run in isolation it is strongly suggested to manually [link turtle.reference.verification verify] and [link turtle.reference.reset reset] the mock function at the end of each test, see the related [link turtle.patterns.managing_static_mock_objects pattern section].]
 
 [note In case of a calling convention specified, all four parameters must be provided.]
 

include/turtle/cleanup.hpp

@@ -9,29 +9,28 @@
 #ifndef MOCK_CLEANUP_HPP_INCLUDED
 #define MOCK_CLEANUP_HPP_INCLUDED
 
-#include "../config.hpp"
+#include "config.hpp"
+#include "verify.hpp"
+#include "reset.hpp"
 #ifdef MOCK_USE_BOOST_TEST
-#include "../verify.hpp"
-#include "../reset.hpp"
 #include <boost/test/unit_test_suite.hpp>
+#endif
 
 namespace mock
-{
-namespace detail
 {
     struct cleanup
     {
         ~cleanup()
         {
-            // see https://svn.boost.org/trac/boost/ticket/5563
-            //mock::verify();
             mock::reset();
         }
     };
+
+#ifdef MOCK_USE_BOOST_TEST
     BOOST_GLOBAL_FIXTURE( cleanup );
-}
+#endif
+
 } // mock
 
-#endif // MOCK_USE_BOOST_TEST
 
 #endif // MOCK_CLEANUP_HPP_INCLUDED

include/turtle/mock.hpp

@@ -13,12 +13,12 @@
 #include "object.hpp"
 #include "reset.hpp"
 #include "verify.hpp"
+#include "cleanup.hpp"
 #include "detail/functor.hpp"
 #include "detail/function.hpp"
 #include "detail/type_name.hpp"
 #include "detail/signature.hpp"
 #include "detail/parameter.hpp"
-#include "detail/cleanup.hpp"
 #include <boost/preprocessor/repetition/repeat.hpp>
 #include <boost/preprocessor/stringize.hpp>
 #include <boost/utility/identity_type.hpp>