src/tests/testUfs.cc

   1 #define SQUID_UNIT_TEST 1
   2 #include "squid.h"
   3
   4 #include "DiskIO/DiskIOModule.h"
   5 #include "fs/ufs/UFSSwapDir.h"
   6 #include "globals.h"
   7 #include "HttpHeader.h"
   8 #include "HttpReply.h"
   9 #include "Mem.h"
  10 #include "MemObject.h"
  11 #include "RequestFlags.h"
  12 #include "SquidConfig.h"
  13 #include "Store.h"
  14 #include "SwapDir.h"
  15 #include "testStoreSupport.h"
  16 #include "testUfs.h"
  17
  18 #if HAVE_STDEXCEPT
  19 #include <stdexcept>
  20 #endif
  21
  22 #define TESTDIR "testUfs_Store"
  23
  24 CPPUNIT_TEST_SUITE_REGISTRATION( testUfs );
  25
  26 typedef RefCount<Fs::Ufs::UFSSwapDir> SwapDirPointer;
  27 extern REMOVALPOLICYCREATE createRemovalPolicy_lru;     /* XXX fails with --enable-removal-policies=heap */
  28
  29 static void
  30 addSwapDir(SwapDirPointer aStore)
  31 {
  32     allocate_new_swapdir(&Config.cacheSwap);
  33     Config.cacheSwap.swapDirs[Config.cacheSwap.n_configured] = aStore.getRaw();
  34     ++Config.cacheSwap.n_configured;
  35 }
  36
  37 /* TODO make this a cbdata class */
  38
  39 static bool cbcalled;
  40
  41 static void
  42 searchCallback(void *cbdata)
  43 {
  44     cbcalled = true;
  45 }
  46
  47 void
  48 testUfs::commonInit()
  49 {
  50     static bool inited = false;
  51
  52     if (inited)
  53         return;
  54
  55     Config.Store.avgObjectSize = 1024;
  56
  57     Config.Store.objectsPerBucket = 20;
  58
  59     Config.Store.maxObjectSize = 2048;
  60
  61     Config.store_dir_select_algorithm = xstrdup("round-robin");
  62
  63     Config.replPolicy = new RemovalPolicySettings;
  64
  65     Config.replPolicy->type = xstrdup ("lru");
  66
  67     /* garh garh */
  68     storeReplAdd("lru", createRemovalPolicy_lru);
  69
  70     Mem::Init();
  71
  72     comm_init();
  73
  74     httpHeaderInitModule();     /* must go before any header processing (e.g. the one in errorInitialize) */
  75
  76     httpReplyInitModule();      /* must go before accepting replies */
  77
  78     inited = true;
  79 }
  80
  81 void
  82 testUfs::testUfsSearch()
  83 {
  84     /* test sequence
  85      * make a valid working ufs swapdir
  86      * put two entries in it and sync logs
  87      * search the ufs dir
  88      * check the entries we find are what we want
  89      */
  90
  91     if (0 > system ("rm -rf " TESTDIR))
  92         throw std::runtime_error("Failed to clean test work directory");
  93
  94     Store::Root(new StoreController);
  95
  96     SwapDirPointer aStore (new Fs::Ufs::UFSSwapDir("ufs", "Blocking"));
  97
  98     aStore->IO = new Fs::Ufs::UFSStrategy(DiskIOModule::Find("Blocking")->createStrategy());
  99
 100     addSwapDir(aStore);
 101
 102     commonInit();
 103     mem_policy = createRemovalPolicy(Config.replPolicy);
 104
 105     char *path=xstrdup(TESTDIR);
 106
 107     char *config_line=xstrdup("100 1 1");
 108
 109     visible_appname_string = xstrdup(PACKAGE "/" VERSION);
 110
 111     ConfigParser::SetCfgLine(config_line);
 112
 113     aStore->parse(0, path);
 114     store_maxobjsize = 1024*1024*2;
 115
 116     safe_free(path);
 117
 118     safe_free(config_line);
 119
 120     /* ok, ready to create */
 121     aStore->create();
 122
 123     /* ok, ready to use - inits store & hash too */
 124     Store::Root().init();
 125
 126     /* our swapdir must be scheduled to rebuild */
 127     CPPUNIT_ASSERT_EQUAL(2, StoreController::store_dirs_rebuilding);
 128
 129     /* rebuild is a scheduled event */
 130     StockEventLoop loop;
 131
 132     while (StoreController::store_dirs_rebuilding)
 133         loop.runOnce();
 134
 135     /* cannot use loop.run(); as the loop will never idle: the store-dir
 136      * clean() scheduled event prevents it
 137      */
 138
 139     /* nothing left to rebuild */
 140     CPPUNIT_ASSERT_EQUAL(0, StoreController::store_dirs_rebuilding);
 141
 142     /* add an entry */
 143     {
 144         /* Create "vary" base object */
 145         RequestFlags flags;
 146         flags.cachable = true;
 147         StoreEntry *pe = storeCreateEntry("dummy url", "dummy log url", flags, Http::METHOD_GET);
 148         HttpReply *rep = (HttpReply *) pe->getReply();  // bypass const
 149         rep->setHeaders(Http::scOkay, "dummy test object", "x-squid-internal/test", 0, -1, squid_curtime + 100000);
 150
 151         pe->setPublicKey();
 152
 153         pe->buffer();
 154         /* TODO: remove this when the metadata is separated */
 155         {
 156             Packer p;
 157             packerToStoreInit(&p, pe);
 158             pe->getReply()->packHeadersInto(&p);
 159             packerClean(&p);
 160         }
 161
 162         pe->flush();
 163         pe->timestampsSet();
 164         pe->complete();
 165         pe->swapOut();
 166         CPPUNIT_ASSERT_EQUAL(0, pe->swap_dirn);
 167         CPPUNIT_ASSERT_EQUAL(0, pe->swap_filen);
 168         pe->unlock("testUfs::testUfsSearch vary");
 169     }
 170
 171     storeDirWriteCleanLogs(0);
 172
 173     /* here we cheat: we know that UFSSwapDirs search off disk. If we did an init call to a new
 174      * swapdir instance, we'd not be testing a clean build.
 175      */
 176     StoreSearchPointer search = aStore->search (NULL, NULL); /* search for everything in the store */
 177
 178     /* nothing should be immediately available */
 179 #if 0
 180
 181     CPPUNIT_ASSERT_EQUAL(false, search->next());
 182 #endif
 183
 184     CPPUNIT_ASSERT_EQUAL(false, search->error());
 185     CPPUNIT_ASSERT_EQUAL(false, search->isDone());
 186     CPPUNIT_ASSERT_EQUAL(static_cast<StoreEntry *>(NULL), search->currentItem());
 187
 188     /* trigger a callback */
 189     cbcalled = false;
 190     search->next(searchCallback, NULL);
 191     CPPUNIT_ASSERT_EQUAL(true, cbcalled);
 192
 193     /* we should have access to a entry now, that matches the entry we had before */
 194     //CPPUNIT_ASSERT_EQUAL(false, search->next());
 195     CPPUNIT_ASSERT_EQUAL(false, search->error());
 196     CPPUNIT_ASSERT_EQUAL(false, search->isDone());
 197     CPPUNIT_ASSERT(search->currentItem() != NULL);
 198
 199     /* trigger another callback */
 200     cbcalled = false;
 201     search->next(searchCallback, NULL);
 202     CPPUNIT_ASSERT_EQUAL(true, cbcalled);
 203
 204     /* now we should have no error, we should have finished and have no current item */
 205     //CPPUNIT_ASSERT_EQUAL(false, search->next());
 206     CPPUNIT_ASSERT_EQUAL(false, search->error());
 207     CPPUNIT_ASSERT_EQUAL(true, search->isDone());
 208     CPPUNIT_ASSERT_EQUAL(static_cast<StoreEntry *>(NULL), search->currentItem());
 209
 210     Store::Root(NULL);
 211
 212     free_cachedir(&Config.cacheSwap);
 213
 214     /* todo: here we should test a dirty rebuild */
 215
 216     safe_free(Config.replPolicy->type);
 217     delete Config.replPolicy;
 218
 219     if (0 > system ("rm -rf " TESTDIR))
 220         throw std::runtime_error("Failed to clean test work directory");
 221 }
 222
 223 /* The UFS store should always configure an IO engine even if none is
 224  * supplied on the configuration line.
 225  */
 226 void
 227 testUfs::testUfsDefaultEngine()
 228 {
 229     /* boring common test boilerplate */
 230     if (0 > system ("rm -rf " TESTDIR))
 231         throw std::runtime_error("Failed to clean test work directory");
 232
 233     // This assertion may fail if previous test cases fail.
 234     // Apparently, CPPUNIT_ASSERT* failure may prevent destructors of local
 235     // objects such as "StorePointer aRoot" from being called.
 236     CPPUNIT_ASSERT(!store_table); // or StoreHashIndex ctor will abort below
 237
 238     Store::Root(new StoreController);
 239     SwapDirPointer aStore (new Fs::Ufs::UFSSwapDir("ufs", "Blocking"));
 240     addSwapDir(aStore);
 241     commonInit();
 242     Config.replPolicy = new RemovalPolicySettings;
 243     Config.replPolicy->type = xstrdup ("lru");
 244     mem_policy = createRemovalPolicy(Config.replPolicy);
 245
 246     char *path=xstrdup(TESTDIR);
 247     char *config_line=xstrdup("100 1 1");
 248     ConfigParser::SetCfgLine(config_line);
 249     aStore->parse(0, path);
 250     safe_free(path);
 251     safe_free(config_line);
 252     CPPUNIT_ASSERT(aStore->IO->io != NULL);
 253
 254     Store::Root(NULL);
 255     free_cachedir(&Config.cacheSwap);
 256     safe_free(Config.replPolicy->type);
 257     delete Config.replPolicy;
 258
 259     if (0 > system ("rm -rf " TESTDIR))
 260         throw std::runtime_error("Failed to clean test work directory");
 261 }