Source/Base/PerfMonitor/OSGPerfMonitorTest.cpp

   1 /*---------------------------------------------------------------------------*\
   2  *                                OpenSG                                     *
   3  *                                                                           *
   4  *                                                                           *
   5  *               Copyright (C) 2000-2006 by the OpenSG Forum                 *
   6  *                                                                           *
   7  *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
   8  *                                                                           *
   9 \*---------------------------------------------------------------------------*/
  10 /*---------------------------------------------------------------------------*\
  11  *                                License                                    *
  12  *                                                                           *
  13  * This library is free software; you can redistribute it and/or modify it   *
  14  * under the terms of the GNU Library General Public License as published    *
  15  * by the Free Software Foundation, version 2.                               *
  16  *                                                                           *
  17  * This library is distributed in the hope that it will be useful, but       *
  18  * WITHOUT ANY WARRANTY; without even the implied warranty of                *
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
  20  * Library General Public License for more details.                          *
  21  *                                                                           *
  22  * You should have received a copy of the GNU Library General Public         *
  23  * License along with this library; if not, write to the Free Software       *
  24  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
  25  *                                                                           *
  26 \*---------------------------------------------------------------------------*/
  27 /*---------------------------------------------------------------------------*\
  28  *                                Changes                                    *
  29  *                                                                           *
  30  *                                                                           *
  31  *                                                                           *
  32  *                                                                           *
  33  *                                                                           *
  34  *                                                                           *
  35 \*---------------------------------------------------------------------------*/
  36
  37 #include <UnitTest++.h>
  38
  39 // Unit tests for Performance monitoring code
  40
  41 #include "OSGConfig.h"
  42 #include "OSGPerfMonitor.h"
  43 #include "OSGPerfMonitorGuard.h"
  44
  45 #include <boost/filesystem/operations.hpp>
  46
  47 namespace bf = boost::filesystem;
  48
  49 SUITE(PerfMonitorTests)
  50 {
  51
  52 struct PerfFileFixture
  53 {
  54    PerfFileFixture()
  55    {
  56       OSG::PerfMonitor::the()->reset();
  57       OSG::PerfMonitor::the()->enable(false);
  58
  59       test_file = bf::path("test_perf.data");
  60       bf::remove(test_file);
  61    }
  62
  63    ~PerfFileFixture()
  64    {
  65       bf::remove(test_file);
  66    }
  67
  68    bf::path test_file;
  69 };
  70
  71
  72 TEST_FIXTURE(PerfFileFixture, TestInitialization)
  73 {
  74    OSG::PerfMonitor::the()->reset();
  75    CHECK_EQUAL(OSG::PerfMonitor::the()->mSamples.size(), 0);
  76    CHECK_EQUAL(OSG::PerfMonitor::the()->getEnabled(), false);
  77    CHECK_EQUAL((void*)OSG::PerfMonitor::the()->mOutFile, (void*)NULL);
  78 }
  79
  80
  81 TEST_FIXTURE(PerfFileFixture, TestSample)
  82 {
  83    OSG::PerfMonitor::the()->reset();
  84    CHECK_EQUAL(OSG::PerfMonitor::the()->mSamples.size(), 0);
  85    OSG::PerfMonitor::the()->sample(OSG::PerfMonitorBase::MARK, "test");
  86    CHECK_EQUAL(OSG::PerfMonitor::the()->mSamples.size(), 0);
  87
  88    OSG::PerfMonitor::the()->enable(true);
  89    OSG::PerfMonitor::the()->sample(OSG::PerfMonitorBase::MARK, "test");
  90    CHECK_EQUAL(OSG::PerfMonitor::the()->mSamples.size(), 1);
  91 }
  92
  93 TEST_FIXTURE(PerfFileFixture, TestPerfGuards)
  94 {
  95    OSG::PerfMonitor::the()->reset();
  96    OSG::PerfMonitor::the()->enable(true);
  97
  98    CHECK(OSG::PerfMonitor::the()->mSamples.size() == 0);
  99
 100    // Single scope test
 101    {
 102    OSG::PerfMonitorGuard g("test_scope");
 103       CHECK_EQUAL(1, OSG::PerfMonitor::the()->mSamples.size());
 104    }
 105    CHECK_EQUAL(2, OSG::PerfMonitor::the()->mSamples.size());
 106
 107    // Test nested scopes
 108    {
 109    OSG::PerfMonitorGuard g("test_outer_scope");
 110       CHECK_EQUAL(3, OSG::PerfMonitor::the()->mSamples.size());
 111       {
 112       OSG::PerfMonitorGuard g("test_inner_scope");
 113          CHECK_EQUAL(4, OSG::PerfMonitor::the()->mSamples.size());
 114       }
 115       CHECK_EQUAL(5, OSG::PerfMonitor::the()->mSamples.size());
 116    }
 117    CHECK_EQUAL(6, OSG::PerfMonitor::the()->mSamples.size());
 118 }
 119
 120 TEST_FIXTURE(PerfFileFixture, TestPerfOutput)
 121 {
 122    OSG::PerfMonitor::the()->reset();
 123    OSG::PerfMonitor::the()->enable(true);
 124
 125    CHECK(!bf::exists(test_file));
 126
 127    OSG::PerfMonitor::the()->setOutputFile(test_file.native_file_string());
 128    CHECK(bf::exists(test_file));
 129
 130    OSG::PerfMonitor::the()->sample(OSG::PerfMonitorBase::ENTER, "test", 21.0);
 131    OSG::PerfMonitor::the()->flushOutput();
 132    OSG::PerfMonitor::the()->setOutputFile("");
 133    CHECK(bf::exists(test_file));
 134
 135    // TODO: Add test to look at the file output
 136 }
 137
 138 TEST_FIXTURE(PerfFileFixture, TestFlushing)
 139 {
 140    OSG::PerfMonitor::the()->reset();
 141    OSG::PerfMonitor::the()->enable(true);
 142    OSG::PerfMonitor::the()->setOutputFlushRate(10);
 143    CHECK_EQUAL(0, OSG::PerfMonitor::the()->mSamples.size());
 144
 145    // Check that size grows
 146    for(unsigned i=1; i<5; i++)
 147    {
 148       OSG::PerfMonitor::the()->sample(OSG::PerfMonitorBase::MARK, "test");
 149       OSG::PerfMonitor::the()->updateFrame();  // Adds frame sample
 150       CHECK_EQUAL(i*2, OSG::PerfMonitor::the()->mSamples.size());
 151    }
 152
 153    // Check that this one causes a flush
 154    OSG::PerfMonitor::the()->sample(OSG::PerfMonitorBase::MARK, "test");
 155    CHECK_EQUAL(9, OSG::PerfMonitor::the()->mSamples.size());
 156    OSG::PerfMonitor::the()->updateFrame();
 157    CHECK_EQUAL(0, OSG::PerfMonitor::the()->mSamples.size());
 158 }
 159
 160
 161 /*
 162 TEST_FIXTURE(FileFixture, CreateOSBFile)
 163 {
 164    OSG::NodePtr n = OSG::Node::create();
 165
 166    CHECK(!bf::exists(test_file));
 167    OSG::SceneFileHandler::the()->write(n, test_file.native_file_string().c_str());
 168    CHECK(bf::exists(test_file));
 169
 170    OSG::NodePtr new_n =
 171       OSG::SceneFileHandler::the()->read(test_file.native_file_string().c_str());
 172    CHECK(new_n != OSGNullFC);
 173 }
 174
 175 TEST_FIXTURE(FileFixture, CreateOSBTree)
 176 {
 177    // Test larger tree
 178    OSG::NodePtr base_node  = OSG::Node::create();
 179    base_node->setCore(OSG::Group::create());
 180    OSG::NodePtr child_node = OSG::Node::create();
 181    child_node->setCore(OSG::Group::create());
 182
 183    base_node->addChild(child_node);
 184
 185    CHECK(!bf::exists(test_file));
 186    OSG::SceneFileHandler::the()->write(base_node, test_file.native_file_string().c_str());
 187    CHECK(bf::exists(test_file));
 188
 189    OSG::NodePtr new_n =
 190       OSG::SceneFileHandler::the()->read(test_file.native_file_string().c_str());
 191    CHECK(new_n != OSGNullFC);
 192    CHECK(new_n->getCore() != OSGNullFC);
 193    CHECK(new_n->getNChildren() == 1);
 194    CHECK(new_n->getChild(0) != OSGNullFC);
 195    CHECK(new_n->getChild(0)->getCore() != OSGNullFC);
 196 }
 197 */
 198
 199
 200
 201 } // SUITE
 202