From 810e531508b7534e01577b5c2da2a3a07deb547f Mon Sep 17 00:00:00 2001
From: Ichthyostega <prg@ichthyostega.de>
Date: Sun, 18 Jan 2009 16:59:24 +0100
Subject: [PATCH] perpare a test (which of course currently fails)....

---
 tests/40components.tests               |   4 +
 tests/lib/Makefile.am                  |   1 +
 tests/lib/singletonsubclasstest.cpp    |   1 +
 tests/lib/thread-wrapper-join-test.cpp | 141 +++++++++++++++++++++++++
 4 files changed, 147 insertions(+)
 create mode 100644 tests/lib/thread-wrapper-join-test.cpp

diff --git a/tests/40components.tests b/tests/40components.tests
index 6ed448349..ba14f909f 100644
--- a/tests/40components.tests
+++ b/tests/40components.tests
@@ -337,6 +337,10 @@ return: 0
 END
 
 
+PLANNED "Waiting on Thread termination" ThreadWrapperJoin_test  <<END
+END
+
+
 TEST "Starting and stopping subsystems" SubsystemRunner_test  <<END
 out: -----singleSubsys_complete_cycle-----
 out: -----singleSubsys_start_failure-----
diff --git a/tests/lib/Makefile.am b/tests/lib/Makefile.am
index 52dff04b0..21f6f92e6 100644
--- a/tests/lib/Makefile.am
+++ b/tests/lib/Makefile.am
@@ -64,6 +64,7 @@ test_lib_SOURCES =						\
 	$(testlib_srcdir)/sync-locking-test.cpp			\
 	$(testlib_srcdir)/sync-waiting-test.cpp			\
 	$(testlib_srcdir)/thread-wrapper-test.cpp		\
+	$(testlib_srcdir)/thread-wrapper-join-test.cpp		\
 	$(testlib_srcdir)/test/cmdlinewrappertest.cpp		\
 	$(testlib_srcdir)/test/testoptiontest.cpp		\
 	$(testlib_srcdir)/vectortransfertest.cpp		\
diff --git a/tests/lib/singletonsubclasstest.cpp b/tests/lib/singletonsubclasstest.cpp
index 1b9097c44..7200ab082 100644
--- a/tests/lib/singletonsubclasstest.cpp
+++ b/tests/lib/singletonsubclasstest.cpp
@@ -121,6 +121,7 @@ namespace lumiera
                  << string (t1)   << "\n";
             
 #ifdef DEBUG
+            /////////////////////////////////////////////////////////////////////////////////////////////TODO: better way of detecting debug builds
             verify_error_detection ();
 #endif
           } 
diff --git a/tests/lib/thread-wrapper-join-test.cpp b/tests/lib/thread-wrapper-join-test.cpp
new file mode 100644
index 000000000..97f6e0c0e
--- /dev/null
+++ b/tests/lib/thread-wrapper-join-test.cpp
@@ -0,0 +1,141 @@
+/*
+  ThreadWrapperJoin(Test)  -  wait blocking on termination of a thread
+ 
+  Copyright (C)         Lumiera.org
+    2008,               Hermann Vosseler <Ichthyostega@web.de>
+ 
+  This program is free software; you can redistribute it and/or
+  modify it under the terms of the GNU General Public License as
+  published by the Free Software Foundation; either version 2 of the
+  License, or (at your option) any later version.
+ 
+  This program is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+ 
+  You should have received a copy of the GNU General Public License
+  along with this program; if not, write to the Free Software
+  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ 
+* *****************************************************/
+
+
+#include "lib/test/run.hpp"
+
+#include "include/symbol.hpp"
+#include "backend/thread-wrapper.hpp"
+#include "lib/error.hpp"
+#include "lib/sync.hpp"
+
+#include <tr1/functional>
+
+using std::tr1::bind;
+using test::Test;
+
+
+
+namespace lib {
+  namespace test {
+  
+    /**************************************************************************
+     * @test use the Lumiera backend to create some new threads, additionally
+     *       passing an condition variable for waiting on thread termination. 
+     *       Actually this is implemented as creating and passing a JoinHandle.
+     * 
+     * @see lib::Thread
+     * @see threads.h
+     */
+    class ThreadWrapperJoin_test : public Test
+      {
+        
+        virtual void
+        run (Arg)
+          {
+            simpleUse ();
+            wrongUse ();
+          }
+        
+        
+        volatile int aValue_;         ///< state to be modified by the other thread 
+        
+        void
+        theAction (int secretValue)   ///< to be run in a new thread...
+          {
+            sleep(1);
+            aValue_ =  secretValue+42;
+          }
+        
+        
+        void
+        simpleUse ()
+          {
+            aValue_=0;
+            int mySecret = (rand() % 1000) - 500;
+            
+            JoinHandle waitingHandle;
+            
+            Thread("test Thread joining",
+                   bind (&ThreadWrapperJoin_test::theAction, this, mySecret),
+                   waitingHandle);    
+                                      // note binding and thread wrapper already destroyed
+            
+            waitingHandle.join();     // blocks until theAction() is done
+            
+            ASSERT (aValue_ == mySecret+42);
+          }
+        
+        
+        void
+        wrongUse ()
+          {
+            JoinHandle waitingHandle;
+            
+            Thread("test Thread joining-1",
+                   bind (&ThreadWrapperJoin_test::theAction, this, 111));    
+                                      // note we "forget" to pass the JoinHandle
+            try 
+              { 
+                waitingHandle.join(); // protocol error: handle wasn't passed for starting a Thread; 
+                NOTREACHED;
+              }
+            catch (lumiera::error::Logic& logo)
+              { lumiera_error(); }
+            
+            
+            Thread("test Thread joining-2",
+                   bind (&ThreadWrapperJoin_test::theAction, this, 222),
+                   waitingHandle);    // this time we pass it....
+            
+#ifdef DEBUG
+            /////////////////////////////////////////////////////////////////////////////////////////////TODO: better way of detecting debug builds
+            try
+              {
+                Thread("test Thread joining-3",
+                       bind (&ThreadWrapperJoin_test::theAction, this, 333),
+                       waitingHandle);    // but then pass it again for another thread....
+                NOTREACHED;
+              }
+            catch (...)
+              {
+                ASSERT (lumiera_error() == lumiera::error::LUMIERA_ERROR_ASSERTION);
+              }
+#endif            
+            
+            // note: the waitingHandle goes out of scope here,
+            // which unblocks the second thread. The first thread wasn't blocked,
+            // while the third thread wasn't created at all.
+          }
+        
+      };
+    
+    
+    
+    /** Register this test class... */
+    LAUNCHER (ThreadWrapperJoin_test, "function common");
+    
+    
+    
+  } // namespace test
+
+} // namespace lib