ACE/tests/Bug_3912_Regression_Test.cpp

   1 // ============================================================================
   2 //
   3 // = LIBRARY
   4 //    tests
   5 //
   6 // = DESCRIPTION
   7 //    This test asserts that close is called on Modules during
   8 //    ACE_Service_Repository shutdown
   9 //
  10 // = AUTHOR
  11 //    Chad Beaulac <chad@objectivesolutions.com>
  12 //
  13 // ============================================================================
  14
  15 #include "test_config.h"
  16
  17 #include "ace/Log_Msg.h"
  18 #include "ace/Service_Config.h"
  19 #include "ace/Service_Repository.h"
  20 #include "ace/Service_Object.h"
  21 #include "ace/Service_Types.h"
  22 #include "ace/Task.h"
  23 #include "ace/Module.h"
  24
  25 typedef ACE_Task<ACE_SYNCH> MT_Task;
  26 typedef ACE_Module<ACE_SYNCH> MT_Module;
  27
  28 /**
  29  * We use this Task to track if close was called.
  30  */
  31 class Close_Handler : public virtual MT_Task
  32 {
  33 public:
  34
  35   Close_Handler(bool* close_called_arg)
  36   : close_called_ (close_called_arg)
  37   {
  38   }
  39
  40   virtual int close(u_long );
  41
  42 private:
  43   bool* close_called_;
  44 };
  45
  46
  47 int Close_Handler::close(u_long )
  48 {
  49   ACE_DEBUG ((LM_DEBUG,"Close_Handler::close \n"));
  50   *close_called_ = true;
  51   return 0;
  52 }
  53
  54 int
  55 run_test (int argc, ACE_TCHAR *argv[])
  56 {
  57   int status = 0;
  58   bool close_called = false;
  59   Close_Handler* close_handler = 0;
  60   ACE_NEW_RETURN(close_handler, Close_Handler (&close_called), -1);
  61
  62   ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("Opening service config\n")));
  63
  64   status = ACE_Service_Config::open (argc,
  65                                      argv,
  66                                      ACE_DEFAULT_LOGGER_KEY,
  67                                      true,
  68                                      true /*ignore def svc.conf*/);
  69   if (status != 0)
  70     {
  71       ACE_ERROR_RETURN ((LM_ERROR,
  72                         ACE_TEXT ("run_test, %p\n")
  73                         ACE_TEXT ("ACE_Service_Config::open")),
  74                         status);
  75     }
  76   else
  77     ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("Service config opened\n")));
  78
  79
  80   ACE_Service_Repository *asr = ACE_Service_Repository::instance ();
  81   if (asr == 0)
  82     ACE_ERROR_RETURN ((LM_ERROR,
  83                        ACE_TEXT ("run_test, no service repository\n")),
  84                        -1);
  85
  86   ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("Finding close test module\n")));
  87
  88   const ACE_Service_Type* st = 0;
  89   status = asr->find (ACE_TEXT ("Close_Test_Module"), &st);
  90   if (status != 0)
  91     ACE_ERROR_RETURN ((LM_ERROR,
  92                        ACE_TEXT ("run_test, %p on Close_Test_Module\n")
  93                        ACE_TEXT ("ACE_Service_Repository::find")),
  94                        status);
  95
  96   //
  97   // Put our Close_Handler Task into the Module
  98   //
  99   MT_Module* close_test_module =
 100     static_cast <MT_Module *> (st->type()->object ());
 101
 102   if (close_test_module == 0)
 103     ACE_ERROR_RETURN ((LM_ERROR,
 104                        ACE_TEXT ("run_test, no close test module\n")),
 105                        -1);
 106   close_test_module->reader (close_handler);
 107
 108   //
 109   // Remove the Module from the Stream.
 110   // This is what happens during ACE_Service_Repository::fini
 111   // We want to make sure that close is called on Modules and their Tasks
 112   // at this time to ensure proper cleanup during the shutdown sequence
 113   // by getting the close methods called so user shutdown hooks can fire.
 114   //
 115
 116   const ACE_Module_Type* module_type =
 117     static_cast< const ACE_Module_Type*>(st->type ());
 118
 119   ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("Finding close test stream\n")));
 120
 121   status = asr->find (ACE_TEXT ("Close_Test_Stream"), &st);
 122   if (status != 0)
 123   {
 124     ACE_ERROR_RETURN ((LM_ERROR,
 125                        ACE_TEXT ("run_test, %p on Close_Test_Stream\n")
 126                        ACE_TEXT ("ACE_Service_Repository::find")),
 127                        status);
 128   }
 129   const ACE_Stream_Type* close_test_stream =
 130     static_cast<const ACE_Stream_Type*> (st->type ());
 131
 132   ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("Removing module\n")));
 133
 134   ACE_Stream_Type *nc_stream = const_cast<ACE_Stream_Type*>(close_test_stream);
 135   ACE_Module_Type *nc_module = const_cast<ACE_Module_Type*>(module_type);
 136   nc_stream->remove (nc_module);
 137
 138   if (!close_called)
 139     {
 140       ACE_ERROR ((LM_ERROR, ACE_TEXT ("close not called\n")));
 141       ++status;
 142     }
 143   else
 144     {
 145       ACE_DEBUG ((LM_DEBUG, ACE_TEXT (" SUCCESS: close called\n")));
 146     }
 147   return status;
 148 }
 149
 150 int
 151 run_main(int, ACE_TCHAR *argv[])
 152 {
 153   ACE_START_TEST (ACE_TEXT ("Bug_3912_Regression_Test"));
 154
 155   ACE_TCHAR conf_file_name [MAXPATHLEN];
 156 #if defined (TEST_DIR)
 157   ACE_OS::strcpy (conf_file_name, TEST_DIR);
 158   ACE_OS::strcat (conf_file_name, ACE_DIRECTORY_SEPARATOR_STR);
 159   ACE_OS::strcat (conf_file_name, ACE_TEXT ("Bug_3912_Regression_Test.conf"));
 160 #else
 161   ACE_OS::strcpy (conf_file_name, ACE_TEXT ("Bug_3912_Regression_Test.conf"));
 162 #endif
 163
 164   ACE_TCHAR * _argv[3] = {argv[0],
 165                           const_cast<ACE_TCHAR*> (ACE_TEXT ("-f")),
 166                           const_cast<ACE_TCHAR*> (conf_file_name)};
 167
 168   ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("Starting test\n")));
 169
 170   int status = run_test (3,_argv);
 171
 172   ACE_DEBUG ((LM_DEBUG, ACE_TEXT ("Closing service config\n")));
 173
 174   ACE_Service_Config::fini_svcs ();
 175
 176   ACE_END_TEST;
 177   return status;
 178 }