Scheduler/Scheduler.test.cc

   1
   2 // $Id$
   3 //
   4 // Copyright (C) 2006
   5 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   6 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   7 //     Stefan Bund <g0dil@berlios.de>
   8 //
   9 // This program is free software; you can redistribute it and/or modify
  10 // it under the terms of the GNU General Public License as published by
  11 // the Free Software Foundation; either version 2 of the License, or
  12 // (at your option) any later version.
  13 //
  14 // This program is distributed in the hope that it will be useful,
  15 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 // GNU General Public License for more details.
  18 //
  19 // You should have received a copy of the GNU General Public License
  20 // along with this program; if not, write to the
  21 // Free Software Foundation, Inc.,
  22 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23
  24 // Unit tests
  25
  26 //#include "scheduler.test.hh"
  27 //#include "scheduler.test.ih"
  28
  29 // Custom includes
  30 #include <sys/types.h>
  31 #include <signal.h>
  32 #include <sys/wait.h>
  33 #include <unistd.h>
  34 #include <sys/socket.h>
  35 #include <sys/un.h>
  36 #include <errno.h>
  37 #include <string.h>
  38 #include <iostream>
  39 #include <boost/bind.hpp>
  40
  41 #include "Scheduler.hh"
  42
  43 #include "../Utils/auto_unit_test.hh"
  44 #include <boost/test/test_tools.hpp>
  45
  46 #define prefix_
  47 ///////////////////////////////cc.p////////////////////////////////////////
  48
  49 using namespace senf;
  50
  51 namespace {
  52
  53     char const * SOCK_PATH = "/tmp/sched_test.sock";
  54
  55     void error(char const * fn, char const * proc="")
  56     {
  57         std::cerr << "\n" << proc << fn << ": " << strerror(errno) << std::endl;
  58     }
  59
  60     void fail(char const * fn)
  61     {
  62         error(fn,"server: ");
  63         _exit(1);
  64     }
  65
  66     void server()
  67     {
  68         int sock = socket(PF_UNIX,SOCK_STREAM,0);
  69         if (sock<0) fail("socket");
  70         struct sockaddr_un sun;
  71         memset(&sun,0,sizeof(sun));
  72         sun.sun_family = AF_UNIX;
  73         strcpy(sun.sun_path,SOCK_PATH);
  74         if (bind(sock,(struct sockaddr*)&sun,sizeof(sun))<0) fail("bind");
  75         if (listen(sock,1)<0) fail("listen");
  76         int conn = accept(sock,0,0);
  77         if (conn < 0) fail("accept");
  78
  79         ///////////////////////////////////////////////////////////////////////////
  80
  81         if (write(conn,"READ",4)<0) fail("write");
  82         char buffer[1024];
  83         int size =  read(conn,buffer,1024);
  84         if (size<0) fail("read");
  85         if (size == 5) {
  86             buffer[5] = 0;
  87             if (strcmp(buffer,"WRITE")==0) {
  88                 if (write(conn,"OK",2)<0) fail("write");
  89             } else
  90                 if (write(conn,"FAIL",4)<0) fail("write");
  91         } else
  92             if (write(conn,"FAIL",4)<0) fail("write");
  93
  94         ///////////////////////////////////////////////////////////////////////////
  95
  96         close(conn);
  97         close(sock);
  98     }
  99
 100     int start_server()
 101     {
 102         unlink(SOCK_PATH);
 103         int pid = fork();
 104         if (pid == 0) {
 105             server();
 106             _exit(0);
 107         }
 108         if (pid < 0) {
 109             error("fork");
 110             return 0;
 111         }
 112
 113         sleep(1); // Wait for the server socket to be opened
 114         return pid;
 115     }
 116
 117     bool stop_server(int pid)
 118     {
 119         sleep(1); // Wait for the server to terminate
 120         if (kill(pid,SIGTERM)<0) {
 121             error("kill");
 122             return false;
 123         }
 124         int status = 0;
 125         if (waitpid(pid,&status,0)<0) {
 126             error("waitpid");
 127             return false;
 128         }
 129         unlink(SOCK_PATH);
 130         if (WIFSIGNALED(status)) {
 131             std::cerr << "\nserver terminated with signal " << WTERMSIG(status) << std::endl;
 132             return false;
 133         }
 134         if (WEXITSTATUS(status)!=0) {
 135             std::cerr << "\nserver terminated with exit status " << WEXITSTATUS(status) << std::endl;
 136             return false;
 137         }
 138         return true;
 139     }
 140
 141     char buffer[1024];
 142     int size;
 143     int event;
 144
 145     void callback(int fd, int ev)
 146     {
 147         event = ev;
 148         switch (event & Scheduler::EV_ALL) {
 149         case Scheduler::EV_READ:
 150             size = recv(fd,buffer,1024,0);
 151             break;
 152         case Scheduler::EV_PRIO:
 153             size = recv(fd,buffer,1024,MSG_OOB);
 154             Scheduler::instance().terminate();
 155             break;
 156         case Scheduler::EV_WRITE:
 157             size = write(fd,buffer,size);
 158             Scheduler::instance().terminate();
 159             break;
 160         }
 161         Scheduler::instance().terminate();
 162     }
 163
 164     bool timeoutCalled = false;
 165     void timeout()
 166     {
 167         timeoutCalled = true;
 168         Scheduler::instance().terminate();
 169     }
 170
 171     struct HandleWrapper
 172     {
 173         HandleWrapper(int fd,std::string const & tag) : fd_(fd), tag_(tag) {}
 174         int fd_;
 175         std::string tag_;
 176     };
 177
 178     int retrieve_filehandle(HandleWrapper const & handle)
 179     {
 180         return handle.fd_;
 181     }
 182
 183     void handleCallback(HandleWrapper const & handle, int event)
 184     {
 185         if (handle.tag_ != "TheTag")
 186             return;
 187         callback(handle.fd_,event);
 188     }
 189
 190     bool is_close(ClockService::clock_type a, ClockService::clock_type b)
 191     {
 192         return (a<b ? b-a : a-b) < ClockService::milliseconds(100);
 193     }
 194
 195     ClockService::clock_type sigtime (0);
 196
 197     void sigusr(siginfo_t const &)
 198     {
 199         sigtime = ClockService::now();
 200         Scheduler::instance().terminate();
 201     }
 202
 203     void delay(unsigned long milliseconds)
 204     {
 205         struct timespec ts;
 206         ts.tv_sec = milliseconds / 1000;
 207         ts.tv_nsec = (milliseconds % 1000) * 1000000;
 208         while (nanosleep(&ts,&ts) < 0 && errno == EINTR) ;
 209     }
 210
 211     void blockingHandler()
 212     {
 213         delay(2200);
 214         Scheduler::instance().terminate();
 215     }
 216
 217 }
 218
 219 BOOST_AUTO_UNIT_TEST(testScheduler)
 220 {
 221     int pid = start_server();
 222     BOOST_REQUIRE (pid);
 223
 224     int sock = socket(PF_UNIX,SOCK_STREAM,0);
 225     if (sock<0) {
 226         error("socket");
 227         BOOST_FAIL("socket");
 228     }
 229     struct sockaddr_un sun;
 230     memset(&sun,0,sizeof(sun));
 231     sun.sun_family = AF_UNIX;
 232     strcpy(sun.sun_path,SOCK_PATH);
 233
 234     if (connect(sock,(struct sockaddr*)&sun,sizeof(sun))<0) {
 235         error("connect");
 236         BOOST_FAIL("connect");
 237     }
 238
 239     ///////////////////////////////////////////////////////////////////////////
 240
 241     BOOST_CHECK_NO_THROW( Scheduler::instance() );
 242
 243     {
 244         senf::scheduler::FdEvent fde1 ("testFdEvent", boost::bind(&callback, sock, _1),
 245                                       sock, senf::scheduler::FdEvent::EV_READ);
 246         event = Scheduler::EV_NONE;
 247         BOOST_CHECK_NO_THROW( Scheduler::instance().process() );
 248         BOOST_CHECK_EQUAL( event, Scheduler::EV_READ );
 249         BOOST_REQUIRE_EQUAL( size, 4 );
 250         buffer[size]=0;
 251         BOOST_CHECK_EQUAL( buffer, "READ" );
 252
 253         HandleWrapper handle(sock,"TheTag");
 254         senf::scheduler::FdEvent fde2 ("testFdEvent", boost::bind(&handleCallback,handle,_1),
 255                                       handle, senf::scheduler::FdEvent::EV_WRITE);
 256         strcpy(buffer,"WRITE");
 257         size=5;
 258         event = Scheduler::EV_NONE;
 259         BOOST_CHECK_NO_THROW( Scheduler::instance().process() );
 260         BOOST_CHECK_EQUAL( event, Scheduler::EV_WRITE );
 261
 262         SENF_CHECK_NO_THROW( fde2.disable() );
 263         event = Scheduler::EV_NONE;
 264         sleep(1);
 265         BOOST_CHECK_NO_THROW( Scheduler::instance().process() );
 266         BOOST_CHECK_EQUAL( event, Scheduler::EventId(Scheduler::EV_READ|Scheduler::EV_HUP) );
 267         BOOST_REQUIRE_EQUAL( size, 2 );
 268         buffer[size]=0;
 269         BOOST_CHECK_EQUAL( buffer, "OK" );
 270     }
 271
 272     {
 273         senf::scheduler::TimerEvent timer1 ("testTimer1", &timeout,
 274                                             ClockService::now()+ClockService::milliseconds(200));
 275         senf::scheduler::TimerEvent timer2 ("testTimer2", &timeout,
 276                                             ClockService::now()+ClockService::milliseconds(400));
 277
 278         event = Scheduler::EV_NONE;
 279         ClockService::clock_type t (ClockService::now());
 280         BOOST_CHECK_NO_THROW( Scheduler::instance().process() );
 281         BOOST_CHECK_PREDICATE( is_close, (ClockService::now()-t) (ClockService::milliseconds(200)) );
 282         BOOST_CHECK( timeoutCalled );
 283         BOOST_CHECK( ! timer1.enabled() );
 284         BOOST_CHECK_EQUAL( event, Scheduler::EV_NONE );
 285         BOOST_CHECK_PREDICATE( is_close, (ClockService::now()) (Scheduler::instance().eventTime()) );
 286         timeoutCalled = false;
 287         BOOST_CHECK_NO_THROW( Scheduler::instance().process() );
 288         BOOST_CHECK_PREDICATE( is_close, (ClockService::now()-t) (ClockService::milliseconds(400)) );
 289         BOOST_CHECK( timeoutCalled );
 290         BOOST_CHECK_EQUAL( event, Scheduler::EV_NONE );
 291         BOOST_CHECK( ! timer2.enabled() );
 292
 293         BOOST_WARN_MESSAGE( false, "A 'Scheduler task hanging' error is expected to be signaled here." );
 294         BOOST_CHECK_NO_THROW( timer1.action(&blockingHandler) );
 295         BOOST_CHECK_NO_THROW( timer1.timeout(ClockService::now()) );
 296         BOOST_CHECK_NO_THROW( Scheduler::instance().process() );
 297         BOOST_CHECK_EQUAL( Scheduler::instance().hangCount(), 1u );
 298     }
 299
 300     {
 301         senf::scheduler::TimerEvent timer ("testWatchdog", &timeout,
 302                                            ClockService::now()+ClockService::milliseconds(400));
 303         senf::scheduler::SignalEvent sig (SIGUSR1, &sigusr);
 304
 305         ClockService::clock_type t = ClockService::now();
 306         ::kill(::getpid(), SIGUSR1);
 307         delay(100);
 308         BOOST_CHECK_NO_THROW( Scheduler::instance().process() );
 309         BOOST_CHECK_PREDICATE( is_close, (ClockService::now()) (t+ClockService::milliseconds(200)) );
 310         BOOST_CHECK_PREDICATE( is_close, (sigtime) (t+ClockService::milliseconds(200)) );
 311         BOOST_CHECK_NO_THROW( Scheduler::instance().process() );
 312     }
 313
 314     ///////////////////////////////////////////////////////////////////////////
 315
 316     close(sock);
 317
 318     BOOST_CHECK (stop_server(pid));
 319 }
 320
 321 ///////////////////////////////cc.e////////////////////////////////////////
 322 #undef prefix_
 323
 324 \f
 325 // Local Variables:
 326 // mode: c++
 327 // fill-column: 100
 328 // c-file-style: "senf"
 329 // indent-tabs-mode: nil
 330 // ispell-local-dictionary: "american"
 331 // compile-command: "scons -u test"
 332 // comment-column: 40
 333 // End: