DataTransferSessionTest.cpp 113 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/******************************************************************************
 *
 * This file is part of the Castor project.
 * See http://castor.web.cern.ch/castor
 *
 * Copyright (C) 2003  CERN
 * 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * 
 *
 * @author Castor Dev team, castor-dev@cern.ch
 *****************************************************************************/

24
25
26
27
#define __STDC_CONSTANT_MACROS // For using stdint macros (stdint is included
// by inttypes.h, so we shoot first)
#include <stdint.h>
#include <inttypes.h>
28
#include <gtest/gtest.h>
29

30
#include "castor/messages/TapeserverProxyDummy.hpp"
31
#include "castor/tape/tapeserver/daemon/DataTransferSession.hpp"
32
#include "castor/tape/tapeserver/daemon/VolumeInfo.hpp"
33
34
#include "castor/tape/tapeserver/system/Wrapper.hpp"
#include "castor/tape/tapeserver/file/File.hpp"
35
#include "castor/tape/tapeserver/drive/FakeDrive.hpp"
36
#include "catalogue/InMemoryCatalogue.hpp"
37
38
#include "catalogue/OracleCatalogue.hpp"
#include "catalogue/OracleCatalogueSchema.hpp"
39
#include "common/exception/Exception.hpp"
40
#include "common/log/DummyLogger.hpp"
41
#include "common/log/StringLogger.hpp"
42
#include "common/log/StdoutLogger.hpp"
43
#include "common/make_unique.hpp"
44
#include "common/processCap/ProcessCapDummy.hpp"
45
#include "common/threading/Thread.hpp"
46
#include "common/utils/utils.hpp"
47
#include "mediachanger/MediaChangerFacade.hpp"
48
49
//#include "smc_struct.h"
//#include "scheduler/DummyScheduler.hpp"
50
#include "scheduler/OStoreDB/OStoreDBFactory.hpp"
51
#include "scheduler/MountType.hpp"
52
//#include "nameserver/NameServer.hpp"
53
#include "scheduler/Scheduler.hpp"
54
55
56
#include "scheduler/testingMocks/MockRetrieveMount.hpp"
#include "scheduler/testingMocks/MockArchiveJob.hpp"
#include "scheduler/testingMocks/MockArchiveMount.hpp"
57
#include "tests/TempFile.hpp"
58
#include "objectstore/BackendRadosTestSwitch.hpp"
59
#include "CleanerSession.hpp"
60

61
#include <dirent.h>
62
#include <fcntl.h>
63
#include <stdexcept>
Eric Cano's avatar
Eric Cano committed
64
65
66
#include <sys/mman.h>
#include <sys/types.h>
#include <sys/stat.h>
67
68
#include <unistd.h>
#include <zlib.h>
Eric Cano's avatar
Eric Cano committed
69

70
using namespace castor::tape::tapeserver;
71
using namespace castor::tape::tapeserver::daemon;
72

Eric Cano's avatar
Eric Cano committed
73
namespace unitTests {
74

75
76
77
78
79
const uint32_t DISK_FILE_OWNER_UID = 9751;
const uint32_t DISK_FILE_GID = 9752;
const uint32_t DISK_FILE_SOME_USER = 9753;
const uint32_t DISK_FILE_SOME_GROUP = 9754;

80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
namespace {

/**
 * This structure is used to parameterize scheduler tests.
 */
struct DataTransferSessionTestParam {
  cta::SchedulerDatabaseFactory &dbFactory;

  DataTransferSessionTestParam(
    cta::SchedulerDatabaseFactory &dbFactory):
    dbFactory(dbFactory) {
 }
}; // struct DataTransferSessionTest

}

/**
 * The data transfer test is a parameterized test.  It takes a pair of name server
 * and scheduler database factories as a parameter.
 */
class DataTransferSessionTest: public ::testing::TestWithParam<DataTransferSessionTestParam> {
public:
  
103
  DataTransferSessionTest():
104
    m_dummyLog("dummy", "dummy"){
105
  }
106

107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

  class FailedToGetCatalogue: public std::exception {
  public:
    const char *what() const throw() {
      return "Failed to get catalogue";
    }
  };

  class FailedToGetScheduler: public std::exception {
  public:
    const char *what() const throw() {
      return "Failed to get scheduler";
    }
  };

122
123
124
125
126
127
128
129
130
#undef USE_ORACLE_CATALOGUE
#ifdef USE_ORACLE_CATALOGUE
  class OracleCatalogueExposingConnection: public cta::catalogue::OracleCatalogue {
  public:
    template <typename...Ts> OracleCatalogueExposingConnection(Ts&...args): cta::catalogue::OracleCatalogue(args...) {}
    cta::rdbms::Conn getConn() { return m_connPool.getConn(); }
  };
#endif
  
131
132
133
134
    virtual void SetUp() {
    using namespace cta;

    const DataTransferSessionTestParam &param = GetParam();
135
    const uint64_t nbConns = 1;
136
    const uint64_t nbArchiveFileListingConns = 1;
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
#ifdef USE_ORACLE_CATALOGUE
    cta::rdbms::Login login=cta::rdbms::Login::parseFile("/etc/cta/cta-catalogue.conf");
    
    m_catalogue = cta::make_unique<OracleCatalogueExposingConnection>(m_dummyLog, login.username, login.password, login.database,
        nbConns, nbArchiveFileListingConns, maxTriesToConnect);
    try {
      // If we decide to create an oracle catalogue, we have to prepare it.
      // This is a striped down version of CreateSchemaCmd.
      OracleCatalogueExposingConnection & oracleCatalogue = dynamic_cast<OracleCatalogueExposingConnection &>(*m_catalogue);
      auto conn=oracleCatalogue.getConn();
      for (auto &name: conn.getTableNames())
        if (name=="CTA_CATALOGUE") throw cta::exception::Exception("In SetUp(): schema is already populated.");
      cta::catalogue::OracleCatalogueSchema schema;
      conn.executeNonQueries(schema.sql);
    } catch (std::bad_cast &) {}
#else
153
    //m_catalogue = cta::make_unique<catalogue::SchemaCreatingSqliteCatalogue>(m_tempSqliteFile.path(), nbConns);
154
    m_catalogue = cta::make_unique<catalogue::InMemoryCatalogue>(m_dummyLog, nbConns, nbArchiveFileListingConns);
155
#endif
156
    m_db = param.dbFactory.create(m_catalogue);
157
    m_scheduler = cta::make_unique<Scheduler>(*m_catalogue, *m_db, 5, 2*1000*1000);
158
    
159
160
    strncpy(m_tmpDir, "/tmp/DataTransferSessionTestXXXXXX", sizeof(m_tmpDir));
    if(!mkdtemp(m_tmpDir)) {
161
      const std::string errMsg = cta::utils::errnoToString(errno);
162
163
164
165
166
167
      std::ostringstream msg;
      msg << "Failed to create directory with template"
        " /tmp/DataTransferSessionTestXXXXXX: " << errMsg;
      bzero(m_tmpDir, sizeof(m_tmpDir));
      throw cta::exception::Exception(msg.str());
    }
168
    
169
170
171
    struct stat statBuf;
    bzero(&statBuf, sizeof(statBuf));
    if(stat(m_tmpDir, &statBuf)) {
172
      const std::string errMsg = cta::utils::errnoToString(errno);
173
174
175
176
177
178
179
180
      std::ostringstream msg;
      msg << "Failed to stat directory " << m_tmpDir << ": " << errMsg;
      throw cta::exception::Exception(msg.str());
    }

    std::ostringstream cmd;
    cmd << "touch " << m_tmpDir << "/hello";
    system(cmd.str().c_str());
181
182
  }

183
184
185
186
187
  virtual void TearDown() {
    m_scheduler.reset();
    m_catalogue.reset();
    m_db.reset();
    
188
189
190
191
192
193
194
    // If Setup() created a temporary directory
    if(m_tmpDir) {

      // Openn the directory
      std::unique_ptr<DIR, std::function<int(DIR*)>>
        dir(opendir(m_tmpDir), closedir);
      if(NULL == dir.get()) {
195
        const std::string errMsg = cta::utils::errnoToString(errno);
196
197
198
199
200
201
202
203
204
205
206
207
        std::ostringstream msg;
        msg << "Failed to open directory " << m_tmpDir << ": " << errMsg;
        throw cta::exception::Exception(msg.str());
      }

      // Delete each of the files within the directory
      struct dirent *entry = NULL;
      while((entry = readdir(dir.get()))) {
        const std::string entryName(entry->d_name);
        if(entryName != "." && entryName != "..") {
          const std::string entryPath = std::string(m_tmpDir) + "/" + entryName;
          if(unlink(entryPath.c_str())) {
208
            const std::string errMsg = cta::utils::errnoToString(errno);
209
210
211
212
213
214
215
216
217
            std::ostringstream msg;
            msg << "Failed to unlink " << entryPath;
            throw cta::exception::Exception(msg.str());
          }
        }
      }

      // Delete the now empty directory
      if(rmdir(m_tmpDir)) {
218
        const std::string errMsg = cta::utils::errnoToString(errno);
219
220
221
222
223
        std::ostringstream msg;
        msg << "Failed to delete directory " << m_tmpDir << ": " << errMsg;
        throw cta::exception::Exception(msg.str());
      }
    }
224
  }
225

226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
  cta::catalogue::Catalogue &getCatalogue() {
    cta::catalogue::Catalogue *const ptr = m_catalogue.get();
    if(NULL == ptr) {
      throw FailedToGetCatalogue();
    }
    return *ptr;
  }
    
  cta::Scheduler &getScheduler() {
    cta::Scheduler *const ptr = m_scheduler.get();
    if(NULL == ptr) {
      throw FailedToGetScheduler();
    }
    return *ptr;
  }
  
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
  cta::catalogue::CreateTapeAttributes getDefaultTape(){
    cta::catalogue::CreateTapeAttributes tape;
    tape.vid = s_vid;
    tape.mediaType = s_mediaType;
    tape.vendor = s_vendor;
    tape.logicalLibraryName = s_libraryName;
    tape.tapePoolName = s_tapePoolName;
    tape.full = false;
    tape.disabled = false;
    tape.readOnly = false;
    tape.state = cta::common::dataStructures::Tape::STATE_TO_STRING_MAP.at(cta::common::dataStructures::Tape::ACTIVE);
    tape.comment = "Comment";
    return tape;
  }
  
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
  void setupDefaultCatalogue() {
    using namespace cta;
    auto & catalogue=getCatalogue();

    const std::string mountPolicyName = "mount_group";
    const uint64_t archivePriority = 1;
    const uint64_t minArchiveRequestAge = 2;
    const uint64_t retrievePriority = 3;
    const uint64_t minRetrieveRequestAge = 4;
    const uint64_t maxDrivesAllowed = 5;
    const std::string mountPolicyComment = "create mount group";

    ASSERT_TRUE(catalogue.getMountPolicies().empty());

    catalogue.createMountPolicy(
      s_adminOnAdminHost,
      mountPolicyName,
      archivePriority,
      minArchiveRequestAge,
      retrievePriority,
      minRetrieveRequestAge,
      maxDrivesAllowed,
      mountPolicyComment);

    const std::list<common::dataStructures::MountPolicy> groups = catalogue.getMountPolicies();
    ASSERT_EQ(1, groups.size());
    const common::dataStructures::MountPolicy group = groups.front();
    ASSERT_EQ(mountPolicyName, group.name);
    ASSERT_EQ(archivePriority, group.archivePriority);
    ASSERT_EQ(minArchiveRequestAge, group.archiveMinRequestAge);
    ASSERT_EQ(retrievePriority, group.retrievePriority);
    ASSERT_EQ(minRetrieveRequestAge, group.retrieveMinRequestAge);
    ASSERT_EQ(maxDrivesAllowed, group.maxDrivesAllowed);
    ASSERT_EQ(mountPolicyComment, group.comment);

    const std::string ruleComment = "create requester mount-rule";
    catalogue.createRequesterMountRule(s_adminOnAdminHost, mountPolicyName, s_diskInstance, s_userName, ruleComment);

    const std::list<common::dataStructures::RequesterMountRule> rules = catalogue.getRequesterMountRules();
    ASSERT_EQ(1, rules.size());

    const common::dataStructures::RequesterMountRule rule = rules.front();

    ASSERT_EQ(s_userName, rule.name);
    ASSERT_EQ(mountPolicyName, rule.mountPolicy);
    ASSERT_EQ(ruleComment, rule.comment);
    ASSERT_EQ(s_adminOnAdminHost.username, rule.creationLog.username);
    ASSERT_EQ(s_adminOnAdminHost.host, rule.creationLog.host);
    ASSERT_EQ(rule.creationLog, rule.lastModificationLog);

307
308
309
310
311
    cta::common::dataStructures::VirtualOrganization vo;
    vo.name = "vo";
    vo.comment = "comment";
    catalogue.createVirtualOrganization(s_adminOnAdminHost,vo);
    
312
313
314
    common::dataStructures::StorageClass storageClass;
    storageClass.name = s_storageClassName;
    storageClass.nbCopies = 1;
315
    storageClass.vo.name = vo.name;
316
317
318
319
320
321
    storageClass.comment = "create storage class";
    m_catalogue->createStorageClass(s_adminOnAdminHost, storageClass);

    const uint16_t nbPartialTapes = 1;
    const std::string tapePoolComment = "Tape-pool comment";
    const bool tapePoolEncryption = false;
322
    const cta::optional<std::string> tapePoolSupply("value for the supply pool mechanism");
323
324
    
    ASSERT_NO_THROW(catalogue.createTapePool(s_adminOnAdminHost, s_tapePoolName, vo.name, nbPartialTapes, tapePoolEncryption,
325
      tapePoolSupply, tapePoolComment));
326
    const uint32_t copyNb = 1;
327
    const std::string archiveRouteComment = "Archive-route comment";
328
    catalogue.createArchiveRoute(s_adminOnAdminHost, s_storageClassName, copyNb, s_tapePoolName,
329
      archiveRouteComment);
330
331
332
    
    cta::catalogue::MediaType mediaType;
    mediaType.name = s_mediaType;
333
    mediaType.capacityInBytes = 12345678;
334
    mediaType.cartridge = "cartridge";
335
336
337
    mediaType.minLPos = 2696;
    mediaType.maxLPos = 171097;
    mediaType.nbWraps = 112;
338
339
    mediaType.comment = "comment";
    catalogue.createMediaType(s_adminOnAdminHost,mediaType);
340
  }
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
  
  /**
   * Returns the map of Fseqs given by RAO from a string containing CTA logs
   * @param log the string containing the CTA logs
   * @return the map that gives for each RAO call, the associated ordered Fseqs according to the RAO algorithm result
   */
  std::map<size_t, std::vector<std::string>> getRAOFseqs(const std::string & log){
    std::map<size_t,std::vector<std::string>> ret;
    std::string logCopy = log;
    std::string recallRAOOrderMsg = "Recall order of FSEQs using RAO: ";
    size_t recallRAOOrderMsgSize = recallRAOOrderMsg.size();
    size_t posRAOMsg = logCopy.find(recallRAOOrderMsg);
    size_t i = 0;
    while(posRAOMsg != std::string::npos){
      size_t posFirstFseq = posRAOMsg + recallRAOOrderMsgSize;
      size_t posLastFseq = logCopy.find("\"",posFirstFseq);
      std::string stringFseq = logCopy.substr(posFirstFseq,posLastFseq - posFirstFseq);
      cta::utils::splitString(stringFseq,' ',ret[i]);
      logCopy = logCopy.substr(posLastFseq);
      posRAOMsg = logCopy.find(recallRAOOrderMsg);
      i++;
    }
    return ret;
  }
365
366
367
368
369
370
371
372
373
374
375
376
377
378

private:

  // Prevent copying
  DataTransferSessionTest(const DataTransferSessionTest &) = delete;

  // Prevent assignment
  DataTransferSessionTest & operator= (const DataTransferSessionTest &) = delete;

  std::unique_ptr<cta::SchedulerDatabase> m_db;
  std::unique_ptr<cta::catalogue::Catalogue> m_catalogue;
  std::unique_ptr<cta::Scheduler> m_scheduler;
  
protected:
379
380
  cta::log::DummyLogger m_dummyLog;

381
382
383
384
385
386
387
  // Default parameters for storage classes, etc...
  const std::string s_userName = "user_name";
  const std::string s_diskInstance = "disk_instance";
  const std::string s_storageClassName = "TestStorageClass";
  const cta::common::dataStructures::SecurityIdentity s_adminOnAdminHost = { "admin1", "host1" };
  const std::string s_tapePoolName = "TestTapePool";
  const std::string s_libraryName = "TestLogicalLibrary";
388
  const std::string s_vid = "TstVid"; // We really need size <= 6 characters due to tape label format.
389
  const std::string s_mediaType = "LTO7M";
390
  const std::string s_vendor = "TestVendor";
391
  //TempFile m_tempSqliteFile;
392
393
394
395
396
397
398
  /**
   * Temporary directory created with mkdtemp that will be used to contain the
   * destination remote files of the tests that need to create them.
   *
   * Please note that a new temporary directory is created and deleted for each
   * test by the Setup() and TearDown() methods.
   */
399
  char m_tmpDir[100];
400

401
402
}; // class DataTransferSessionTest

403
TEST_P(DataTransferSessionTest, DataTransferSessionGooddayRecall) {
Eric Cano's avatar
Eric Cano committed
404
  // 0) Prepare the logger for everyone
405
  cta::log::StringLogger logger("dummy", "tapeServerUnitTest",cta::log::DEBUG);
406
  cta::log::LogContext logContext(logger);
Eric Cano's avatar
Eric Cano committed
407
  
408
  setupDefaultCatalogue();
409
  // 1) prepare the fake scheduler
410
  std::string vid = s_vid;
411
412
  // cta::MountType::Enum mountType = cta::MountType::RETRIEVE;

413
414
  // 3) Prepare the necessary environment (logger, plus system wrapper), 
  castor::tape::System::mockWrapper mockSys;
415
416
  mockSys.delegateToFake();
  mockSys.disableGMockCallsCounting();
417
  mockSys.fake.setupForVirtualDriveSLC6();
418
419
420
  //delete is unnecessary
  //pointer with ownership will be passed to the application,
  //which will do the delete 
421
  mockSys.fake.m_pathToDrive["/dev/nst0"] = new castor::tape::tapeserver::drive::FakeDrive;
422
423

  // 4) Create the scheduler
424
425
  auto & catalogue = getCatalogue();
  auto & scheduler = getScheduler();
426
  
427
  // Always use the same requester
428
  const cta::common::dataStructures::SecurityIdentity requester;
429
430
431
432

  // List to remember the path of each remote file so that the existance of the
  // files can be tested for at the end of the test
  std::list<std::string> remoteFilePaths;
433
  
434
435
  // 5) Create the environment for the migration to happen (library + tape) 
    const std::string libraryComment = "Library comment";
436
  const bool libraryIsDisabled = false;
437
  catalogue.createLogicalLibrary(s_adminOnAdminHost, s_libraryName,
438
    libraryIsDisabled, libraryComment);
439
440
441
442
443
444
  {
    auto libraries = catalogue.getLogicalLibraries();
    ASSERT_EQ(1, libraries.size());
    ASSERT_EQ(s_libraryName, libraries.front().name);
    ASSERT_EQ(libraryComment, libraries.front().comment);
  }
445
446

  {
447
    auto tape = getDefaultTape();
448
449
    catalogue.createTape(s_adminOnAdminHost, tape);
  }
450
  
451
  // 6) Prepare files for reading by writing them to the mock system
452
453
454
  {
    // Label the tape
    castor::tape::tapeFile::LabelSession ls(*mockSys.fake.m_pathToDrive["/dev/nst0"], 
455
        s_vid, false);
456
457
    mockSys.fake.m_pathToDrive["/dev/nst0"]->rewind();
    // And write to it
458
    castor::tape::tapeserver::daemon::VolumeInfo volInfo;
459
    volInfo.vid=s_vid;
460
    castor::tape::tapeFile::WriteSession ws(*mockSys.fake.m_pathToDrive["/dev/nst0"],
461
       volInfo , 0, true, false);
462
463
464

    // Write a few files on the virtual tape and modify the archive name space
    // so that it is in sync
465
    uint8_t data[1000];
466
    size_t archiveFileSize=sizeof(data);
467
468
    castor::tape::SCSI::Structures::zeroStruct(&data);
    for (int fseq=1; fseq <= 10 ; fseq ++) {
469
470
      // Create a path to a remote destination file
      std::ostringstream remoteFilePath;
471
      remoteFilePath << "file://" << m_tmpDir << "/test" << fseq;
472
473
      remoteFilePaths.push_back(remoteFilePath.str());

474
      // Create an archive file entry in the archive namespace
475
476
477
478
      auto tapeFileWrittenUP = cta::make_unique<cta::catalogue::TapeFileWritten>();
      auto &tapeFileWritten=*tapeFileWrittenUP;
      std::set<cta::catalogue::TapeItemWrittenPointer> tapeFileWrittenSet;
      tapeFileWrittenSet.insert(tapeFileWrittenUP.release());
479
      
480
      // Write the file to tape
481
      cta::MockArchiveMount mam(catalogue);
Eric Cano's avatar
Eric Cano committed
482
      std::unique_ptr<cta::ArchiveJob> aj(new cta::MockArchiveJob(&mam, catalogue));
483
484
485
      aj->tapeFile.fSeq = fseq;
      aj->archiveFile.archiveFileID = fseq;
      castor::tape::tapeFile::WriteFile wf(&ws, *aj, archiveFileSize);
486
      tapeFileWritten.blockId = wf.getBlockId();
487
      // Write the data (one block)
488
      wf.write(data, archiveFileSize);
489
490
      // Close the file
      wf.close();
491

492
493
      // Create file entry in the archive namespace
      tapeFileWritten.archiveFileId=fseq;
Michael Davis's avatar
Michael Davis committed
494
      tapeFileWritten.checksumBlob.insert(cta::checksum::ADLER32, cta::utils::getAdler32(data, archiveFileSize));
495
496
497
498
      tapeFileWritten.vid=volInfo.vid;
      tapeFileWritten.size=archiveFileSize;
      tapeFileWritten.fSeq=fseq;
      tapeFileWritten.copyNb=1;
499
500
      tapeFileWritten.diskInstance = s_diskInstance;
      tapeFileWritten.diskFileId = fseq;
501
      
502
503
      tapeFileWritten.diskFileOwnerUid = DISK_FILE_SOME_USER;
      tapeFileWritten.diskFileGid = DISK_FILE_SOME_GROUP;
504
505
      tapeFileWritten.storageClassName = s_storageClassName;
      tapeFileWritten.tapeDrive = "drive0";
506
      catalogue.filesWrittenToTape(tapeFileWrittenSet);
507

508
      // Schedule the retrieval of the file
Daniele Kruse's avatar
Daniele Kruse committed
509
      std::string diskInstance="disk_instance";
510
511
      cta::common::dataStructures::RetrieveRequest rReq;
      rReq.archiveFileID=fseq;
512
513
      rReq.requester.name = s_userName;
      rReq.requester.group = "someGroup";
514
      rReq.dstURL = remoteFilePaths.back();
515
      rReq.diskFileInfo.path = "path/to/file";
Michael Davis's avatar
Michael Davis committed
516
      rReq.isVerifyOnly = false;
517
      std::list<std::string> archiveFilePaths;
518
      scheduler.queueRetrieve(diskInstance, rReq, logContext);
519
520
    }
  }
521
  scheduler.waitSchedulerDbSubthreadsComplete();
522
523
    
  // 6) Report the drive's existence and put it up in the drive register.
524
  cta::tape::daemon::TpconfigLine driveConfig("T10D6116", "TestLogicalLibrary", "/dev/tape_T10D6116", "manual");
525
  cta::common::dataStructures::DriveInfo driveInfo;
526
  driveInfo.driveName=driveConfig.unitName;
527
528
  driveInfo.logicalLibrary=driveConfig.logicalLibrary;
  driveInfo.host=="host";
529
  // We need to create the drive in the registry before being able to put it up.
530
  scheduler.reportDriveStatus(driveInfo, cta::common::dataStructures::MountType::NoMount, cta::common::dataStructures::DriveStatus::Down, logContext);
531
532
533
534
  cta::common::dataStructures::DesiredDriveState driveState;
  driveState.up = true;
  driveState.forceDown = false;
  scheduler.setDesiredDriveState(s_adminOnAdminHost, driveConfig.unitName, driveState, logContext);
535
536

  // 7) Create the data transfer session
537
538
539
540
541
542
  DataTransferConfig castorConf;
  castorConf.bufsz = 1024*1024; // 1 MB memory buffers
  castorConf.nbBufs = 10;
  castorConf.bulkRequestRecallMaxBytes = UINT64_C(100)*1000*1000*1000;
  castorConf.bulkRequestRecallMaxFiles = 1000;
  castorConf.nbDiskThreads = 1;
543
  castorConf.tapeLoadTimeout = 300;
544
  cta::log::DummyLogger dummyLog("dummy", "dummy");
545
  cta::mediachanger::MediaChangerFacade mc(dummyLog);
546
  cta::server::ProcessCap capUtils;
547
  castor::messages::TapeserverProxyDummy initialProcess;
548
  castor::tape::tapeserver::daemon::DataTransferSession sess("tapeHost", logger, mockSys,
549
    driveConfig, mc, initialProcess, capUtils, castorConf, scheduler);
550

551
  // 8) Run the data transfer session
552
  sess.execute();
553

554
  // 9) Check the session git the correct VID
555
  ASSERT_EQ(s_vid, sess.getVid());
556

557
  // 10) Check the remote files exist and have the correct size
558
  for(auto & path: remoteFilePaths) {
559
560
    struct stat statBuf;
    bzero(&statBuf, sizeof(statBuf));
561
    const int statRc = stat(path.substr(7).c_str(), &statBuf); //remove the "file://" for stat-ing
562
    ASSERT_EQ(0, statRc);
563
    ASSERT_EQ(1000, statBuf.st_size); //same size of data
564
  }
565
566
567
568

  // 10) Check logs
  std::string logToCheck = logger.getLog();
  logToCheck += "";
569
  ASSERT_NE(std::string::npos,logToCheck.find("MSG=\"Tape session started\" thread=\"TapeRead\" tapeDrive=\"T10D6116\" tapeVid=\"TstVid\" "
570
                                              "mountId=\"1\" vo=\"vo\" mediaType=\"LTO7M\" tapePool=\"TestTapePool\" "
571
572
                                              "logicalLibrary=\"TestLogicalLibrary\" mountType=\"Retrieve\" vendor=\"TestVendor\" "
                                              "capacityInBytes=\"12345678\""));
573
  ASSERT_NE(std::string::npos, logToCheck.find("firmwareVersion=\"123A\" serialNumber=\"123456\" "
574
575
                                               "mountTotalCorrectedReadErrors=\"5\" mountTotalReadBytesProcessed=\"4096\" "
                                               "mountTotalUncorrectedReadErrors=\"1\" mountTotalNonMediumErrorCounts=\"2\""));
576
  ASSERT_NE(std::string::npos, logToCheck.find("firmwareVersion=\"123A\" serialNumber=\"123456\" lifetimeMediumEfficiencyPrct=\"100\" "
577
578
579
580
                                               "mountReadEfficiencyPrct=\"100\" mountWriteEfficiencyPrct=\"100\" "
                                               "mountReadTransients=\"10\" "
                                               "mountServoTemps=\"10\" mountServoTransients=\"5\" mountTemps=\"100\" "
                                               "mountTotalReadRetries=\"25\" mountTotalWriteRetries=\"25\" mountWriteTransients=\"10\""));
581
}
582
583
584
585
586
587
588

TEST_P(DataTransferSessionTest, DataTransferSessionWrongRecall) {
  // This test is the same as the previous one, with 
  // wrong parameters set for the recall, so that we fail 
  // to recall the first file and cancel the second.

  // 0) Prepare the logger for everyone
589
  cta::log::StringLogger logger("dummy","tapeServerUnitTest",cta::log::DEBUG);
590
  cta::log::LogContext logContext(logger);
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
  
  setupDefaultCatalogue();
  // 1) prepare the fake scheduler
  std::string vid = s_vid;
  // cta::MountType::Enum mountType = cta::MountType::RETRIEVE;

  // 3) Prepare the necessary environment (logger, plus system wrapper), 
  castor::tape::System::mockWrapper mockSys;
  mockSys.delegateToFake();
  mockSys.disableGMockCallsCounting();
  mockSys.fake.setupForVirtualDriveSLC6();
  //delete is unnecessary
  //pointer with ownership will be passed to the application,
  //which will do the delete 
  mockSys.fake.m_pathToDrive["/dev/nst0"] = new castor::tape::tapeserver::drive::FakeDrive;

  // 4) Create the scheduler
  auto & catalogue = getCatalogue();
  auto & scheduler = getScheduler();

  // Always use the same requester
  const cta::common::dataStructures::SecurityIdentity requester;

  // List to remember the path of each remote file so that the existance of the
  // files can be tested for at the end of the test
  std::list<std::string> remoteFilePaths;
  
  // 5) Create the environment for the migration to happen (library + tape) 
    const std::string libraryComment = "Library comment";
620
  const bool libraryIsDisabled = false;
621
  catalogue.createLogicalLibrary(s_adminOnAdminHost, s_libraryName,
622
    libraryIsDisabled, libraryComment);
623
624
625
626
627
628
  {
    auto libraries = catalogue.getLogicalLibraries();
    ASSERT_EQ(1, libraries.size());
    ASSERT_EQ(s_libraryName, libraries.front().name);
    ASSERT_EQ(libraryComment, libraries.front().comment);
  }
629
630

  {
631
    auto tape = getDefaultTape();
632
633
    catalogue.createTape(s_adminOnAdminHost, tape);
  }
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
  
  // 6) Prepare files for reading by writing them to the mock system
  {
    // Label the tape
    castor::tape::tapeFile::LabelSession ls(*mockSys.fake.m_pathToDrive["/dev/nst0"], 
        s_vid, false);
    mockSys.fake.m_pathToDrive["/dev/nst0"]->rewind();
    // And write to it
    castor::tape::tapeserver::daemon::VolumeInfo volInfo;
    volInfo.vid=s_vid;
    castor::tape::tapeFile::WriteSession ws(*mockSys.fake.m_pathToDrive["/dev/nst0"],
       volInfo , 0, true, false);

    // Write a few files on the virtual tape and modify the archive name space
    // so that it is in sync
    uint8_t data[1000];
    castor::tape::SCSI::Structures::zeroStruct(&data);
    int fseq=1;
    {
      // Create a path to a remote destination file
      std::ostringstream remoteFilePath;
      remoteFilePath << "file://" << m_tmpDir << "/test" << fseq;
      remoteFilePaths.push_back(remoteFilePath.str());
      
      // Write the file to tape
      const uint64_t archiveFileSize = 1000;
      cta::MockArchiveMount mam(catalogue);
661
      cta::MockRetrieveMount mrm(catalogue);
Eric Cano's avatar
Eric Cano committed
662
      std::unique_ptr<cta::ArchiveJob> aj(new cta::MockArchiveJob(&mam, catalogue));
663
664
665
666
667
668
669
670
      aj->tapeFile.fSeq = fseq;
      aj->archiveFile.archiveFileID = 1000 + fseq;
      castor::tape::tapeFile::WriteFile wf(&ws, *aj, archiveFileSize);
      // Write the data (one block)
      wf.write(data, sizeof(data));
      // Close the file
      wf.close();
      
671
672
673
674
675
676
677
      {
        // Create a fictious file record on the tape to allow adding one to fseq=2 afterwards.
        auto tapeFileWrittenUP = cta::make_unique<cta::catalogue::TapeFileWritten>();
        auto &tapeFileWritten=*tapeFileWrittenUP;
        std::set<cta::catalogue::TapeItemWrittenPointer> tapeFileWrittenSet;
        tapeFileWrittenSet.insert(tapeFileWrittenUP.release());
        tapeFileWritten.archiveFileId=666;
Michael Davis's avatar
Michael Davis committed
678
        tapeFileWritten.checksumBlob.insert(cta::checksum::ADLER32, cta::checksum::ChecksumBlob::HexToByteArray("0xDEADBEEF"));
679
680
681
682
683
684
685
        tapeFileWritten.vid=volInfo.vid;
        tapeFileWritten.size=archiveFileSize;
        tapeFileWritten.fSeq=fseq;
        tapeFileWritten.blockId=0;
        tapeFileWritten.copyNb=1;
        tapeFileWritten.diskInstance = s_diskInstance;
        tapeFileWritten.diskFileId = std::to_string(fseq);
686
687
        tapeFileWritten.diskFileOwnerUid = DISK_FILE_SOME_USER;
        tapeFileWritten.diskFileGid = DISK_FILE_SOME_GROUP;
688
689
690
691
        tapeFileWritten.storageClassName = s_storageClassName;
        tapeFileWritten.tapeDrive = "drive0";
        catalogue.filesWrittenToTape(tapeFileWrittenSet);
      }
692
      
693
694
695
696
697
698
699
      {
        // Create an archive file entry in the archive catalogue
        auto tapeFileWrittenUP = cta::make_unique<cta::catalogue::TapeFileWritten>();
        auto &tapeFileWritten=*tapeFileWrittenUP;
        std::set<cta::catalogue::TapeItemWrittenPointer> tapeFileWrittenSet;
        tapeFileWrittenSet.insert(tapeFileWrittenUP.release());
        tapeFileWritten.archiveFileId=1000 + fseq;
Michael Davis's avatar
Michael Davis committed
700
        tapeFileWritten.checksumBlob.insert(cta::checksum::ADLER32, cta::utils::getAdler32(data, archiveFileSize));
701
702
703
704
705
706
707
        tapeFileWritten.vid=volInfo.vid;
        tapeFileWritten.size=archiveFileSize;
        tapeFileWritten.fSeq=fseq + 1;
        tapeFileWritten.blockId=wf.getBlockId() + 10000;
        tapeFileWritten.copyNb=1;
        tapeFileWritten.diskInstance = s_diskInstance;
        tapeFileWritten.diskFileId = std::to_string(fseq + 1);
708
        
709
710
        tapeFileWritten.diskFileOwnerUid = DISK_FILE_SOME_USER;
        tapeFileWritten.diskFileGid = DISK_FILE_SOME_GROUP;
711
712
713
714
        tapeFileWritten.storageClassName = s_storageClassName;
        tapeFileWritten.tapeDrive = "drive0";
        catalogue.filesWrittenToTape(tapeFileWrittenSet);
      }
715
716
717
718
719
720
721
722
723

      // Schedule the retrieval of the file
      std::string diskInstance="disk_instance";
      cta::common::dataStructures::RetrieveRequest rReq;
      rReq.archiveFileID=1000 + fseq;
      rReq.requester.name = s_userName;
      rReq.requester.group = "someGroup";
      rReq.dstURL = remoteFilePaths.back();
      std::list<std::string> archiveFilePaths;
724
      scheduler.queueRetrieve(diskInstance, rReq, logContext);
725
726
    }
  }
727
  scheduler.waitSchedulerDbSubthreadsComplete();
728
729
  
  // 6) Report the drive's existence and put it up in the drive register.
730
  cta::tape::daemon::TpconfigLine driveConfig("T10D6116", "TestLogicalLibrary", "/dev/tape_T10D6116", "manual");
731
  cta::common::dataStructures::DriveInfo driveInfo;
732
  driveInfo.driveName=driveConfig.unitName;
733
734
  driveInfo.logicalLibrary=driveConfig.logicalLibrary;
  driveInfo.host=="host";
735
  // We need to create the drive in the registry before being able to put it up.
736
  scheduler.reportDriveStatus(driveInfo, cta::common::dataStructures::MountType::NoMount, cta::common::dataStructures::DriveStatus::Down, logContext);
737
738
739
740
  cta::common::dataStructures::DesiredDriveState driveState;
  driveState.up = true;
  driveState.forceDown = false;
  scheduler.setDesiredDriveState(s_adminOnAdminHost, driveConfig.unitName, driveState, logContext);
741
742
743
744
745
746
747
748

  // 7) Create the data transfer session
  DataTransferConfig castorConf;
  castorConf.bufsz = 1024*1024; // 1 MB memory buffers
  castorConf.nbBufs = 10;
  castorConf.bulkRequestRecallMaxBytes = UINT64_C(100)*1000*1000*1000;
  castorConf.bulkRequestRecallMaxFiles = 1000;
  castorConf.nbDiskThreads = 1;
749
  castorConf.tapeLoadTimeout = 300;
750
  cta::log::DummyLogger dummyLog("dummy", "dummy");
751
  cta::mediachanger::MediaChangerFacade mc(dummyLog);
752
  cta::server::ProcessCap capUtils;
753
754
  castor::messages::TapeserverProxyDummy initialProcess;
  DataTransferSession sess("tapeHost", logger, mockSys,
755
    driveConfig, mc, initialProcess, capUtils, castorConf, scheduler);
756
757

  // 8) Run the data transfer session
758
  sess.execute();
759
760
761
762
763
764
765

  // 9) Check the session git the correct VID
  ASSERT_EQ(s_vid, sess.getVid());

  // 10) Check the remote files exist and have the correct size
  std::string temp = logger.getLog();
  ASSERT_NE(std::string::npos, logger.getLog().find("trying to position beyond the end of data"));
766
767
768
769

  // 11) Check logs for drive statistics
  std::string logToCheck = logger.getLog();
  logToCheck += "";
770
  ASSERT_NE(std::string::npos, logToCheck.find("firmwareVersion=\"123A\" serialNumber=\"123456\" "
771
772
                                               "mountTotalCorrectedReadErrors=\"5\" mountTotalReadBytesProcessed=\"4096\" "
                                               "mountTotalUncorrectedReadErrors=\"1\" mountTotalNonMediumErrorCounts=\"2\""));
773
  ASSERT_NE(std::string::npos, logToCheck.find("firmwareVersion=\"123A\" serialNumber=\"123456\" lifetimeMediumEfficiencyPrct=\"100\" "
774
775
776
777
                                               "mountReadEfficiencyPrct=\"100\" mountWriteEfficiencyPrct=\"100\" "
                                               "mountReadTransients=\"10\" "
                                               "mountServoTemps=\"10\" mountServoTransients=\"5\" mountTemps=\"100\" "
                                               "mountTotalReadRetries=\"25\" mountTotalWriteRetries=\"25\" mountWriteTransients=\"10\""));
778
779
}

780
781
TEST_P(DataTransferSessionTest, DataTransferSessionRAORecall) {
  // 0) Prepare the logger for everyone
782
  cta::log::StringLogger logger("dummy","tapeServerUnitTest",cta::log::DEBUG);
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
  cta::log::LogContext logContext(logger);
  
  setupDefaultCatalogue();
  // 1) prepare the fake scheduler
  std::string vid = s_vid;
  // cta::MountType::Enum mountType = cta::MountType::RETRIEVE;

  // 3) Prepare the necessary environment (logger, plus system wrapper), 
  castor::tape::System::mockWrapper mockSys;
  mockSys.delegateToFake();
  mockSys.disableGMockCallsCounting();
  mockSys.fake.setupForVirtualDriveSLC6();
  //delete is unnecessary
  //pointer with ownership will be passed to the application,
  //which will do the delete 
  mockSys.fake.m_pathToDrive["/dev/nst0"] = new castor::tape::tapeserver::drive::FakeDrive;

  // 4) Create the scheduler
  auto & catalogue = getCatalogue();
  auto & scheduler = getScheduler();
  
  // Always use the same requester
  const cta::common::dataStructures::SecurityIdentity requester;

  // List to remember the path of each remote file so that the existance of the
  // files can be tested for at the end of the test
  std::list<std::string> remoteFilePaths;
  
  // 5) Create the environment for the migration to happen (library + tape) 
    const std::string libraryComment = "Library comment";
813
  const bool libraryIsDisabled = false;
814
  catalogue.createLogicalLibrary(s_adminOnAdminHost, s_libraryName,
815
    libraryIsDisabled, libraryComment);
816
817
818
819
820
821
  {
    auto libraries = catalogue.getLogicalLibraries();
    ASSERT_EQ(1, libraries.size());
    ASSERT_EQ(s_libraryName, libraries.front().name);
    ASSERT_EQ(libraryComment, libraries.front().comment);
  }
822
823

  {
824
    auto tape = getDefaultTape();
825
826
    catalogue.createTape(s_adminOnAdminHost, tape);
  }
827

Cristina Moraru's avatar
Cristina Moraru committed
828
829
  int MAX_RECALLS = 50;
  int MAX_BULK_RECALLS = 31;
830
831
  std::map<size_t,std::vector<std::string>> expectedRAOFseqOrder;
  //RAO for the fake drive is a std::reverse
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
  // 6) Prepare files for reading by writing them to the mock system
  {
    // Label the tape
    castor::tape::tapeFile::LabelSession ls(*mockSys.fake.m_pathToDrive["/dev/nst0"], 
        s_vid, false);
    mockSys.fake.m_pathToDrive["/dev/nst0"]->rewind();
    // And write to it
    castor::tape::tapeserver::daemon::VolumeInfo volInfo;
    volInfo.vid=s_vid;
    castor::tape::tapeFile::WriteSession ws(*mockSys.fake.m_pathToDrive["/dev/nst0"],
       volInfo , 0, true, false);

    // Write a few files on the virtual tape and modify the archive name space
    // so that it is in sync
    uint8_t data[1000];
    size_t archiveFileSize=sizeof(data);
    castor::tape::SCSI::Structures::zeroStruct(&data);
    int fseq;
    for (fseq=1; fseq <= MAX_RECALLS ; fseq ++) {
851
      expectedRAOFseqOrder[fseq / MAX_BULK_RECALLS].push_back(std::to_string(fseq));
852
853
854
855
856
857
      // Create a path to a remote destination file
      std::ostringstream remoteFilePath;
      remoteFilePath << "file://" << m_tmpDir << "/test" << fseq;
      remoteFilePaths.push_back(remoteFilePath.str());

      // Create an archive file entry in the archive namespace
858
859
860
861
      auto tapeFileWrittenUP = cta::make_unique<cta::catalogue::TapeFileWritten>();
      auto &tapeFileWritten=*tapeFileWrittenUP;
      std::set<cta::catalogue::TapeItemWrittenPointer> tapeFileWrittenSet;
      tapeFileWrittenSet.insert(tapeFileWrittenUP.release());
862
863
864
      
      // Write the file to tape
      cta::MockArchiveMount mam(catalogue);
Eric Cano's avatar
Eric Cano committed
865
      std::unique_ptr<cta::ArchiveJob> aj(new cta::MockArchiveJob(&mam, catalogue));
866
867
868
869
870
871
872
873
874
875
876
      aj->tapeFile.fSeq = fseq;
      aj->archiveFile.archiveFileID = fseq;
      castor::tape::tapeFile::WriteFile wf(&ws, *aj, archiveFileSize);
      tapeFileWritten.blockId = wf.getBlockId();
      // Write the data (one block)
      wf.write(data, archiveFileSize);
      // Close the file
      wf.close();

      // Create file entry in the archive namespace
      tapeFileWritten.archiveFileId=fseq;
Michael Davis's avatar
Michael Davis committed
877
      tapeFileWritten.checksumBlob.insert(cta::checksum::ADLER32, cta::utils::getAdler32(data, archiveFileSize));
878
879
880
881
882
883
      tapeFileWritten.vid=volInfo.vid;
      tapeFileWritten.size=archiveFileSize;
      tapeFileWritten.fSeq=fseq;
      tapeFileWritten.copyNb=1;
      tapeFileWritten.diskInstance = s_diskInstance;
      tapeFileWritten.diskFileId = fseq;
884
      
885
886
      tapeFileWritten.diskFileOwnerUid = DISK_FILE_SOME_USER;
      tapeFileWritten.diskFileGid = DISK_FILE_SOME_GROUP;
887
888
      tapeFileWritten.storageClassName = s_storageClassName;
      tapeFileWritten.tapeDrive = "drive0";
889
      catalogue.filesWrittenToTape(tapeFileWrittenSet);
890
891
892
893
894
895
896
897

      // Schedule the retrieval of the file
      std::string diskInstance="disk_instance";
      cta::common::dataStructures::RetrieveRequest rReq;
      rReq.archiveFileID=fseq;
      rReq.requester.name = s_userName;
      rReq.requester.group = "someGroup";
      rReq.dstURL = remoteFilePaths.back();
Michael Davis's avatar
Michael Davis committed
898
      rReq.isVerifyOnly = false;
899
900
901
      std::list<std::string> archiveFilePaths;
      scheduler.queueRetrieve(diskInstance, rReq, logContext);

902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
    }
  }
  //As RAO with the fakedrive is a std::reverse of the vector of the files given in parameter,
  //we reverse all expected fseqs vectors
  std::reverse(expectedRAOFseqOrder[0].begin(),expectedRAOFseqOrder[0].end());
  std::reverse(expectedRAOFseqOrder[1].begin(),expectedRAOFseqOrder[1].end());
  scheduler.waitSchedulerDbSubthreadsComplete();
    
  // 6) Report the drive's existence and put it up in the drive register.
  cta::tape::daemon::TpconfigLine driveConfig("T10D6116", "TestLogicalLibrary", "/dev/tape_T10D6116", "manual");
  cta::common::dataStructures::DriveInfo driveInfo;
  driveInfo.driveName=driveConfig.unitName;
  driveInfo.logicalLibrary=driveConfig.rawLibrarySlot;
  // We need to create the drive in the registry before being able to put it up.
  scheduler.reportDriveStatus(driveInfo, cta::common::dataStructures::MountType::NoMount, cta::common::dataStructures::DriveStatus::Down, logContext);
  cta::common::dataStructures::DesiredDriveState driveState;
  driveState.up = true;
  driveState.forceDown = false;
  scheduler.setDesiredDriveState(s_adminOnAdminHost, driveConfig.unitName, driveState, logContext);
921

922
923
924
925
926
927
928
929
  // 7) Create the data transfer session
  DataTransferConfig castorConf;
  castorConf.bufsz = 1024*1024; // 1 MB memory buffers
  castorConf.nbBufs = 10;
  castorConf.bulkRequestRecallMaxBytes = UINT64_C(100)*1000*1000*1000;
  castorConf.bulkRequestRecallMaxFiles = MAX_BULK_RECALLS - 1;
  castorConf.nbDiskThreads = 1;
  castorConf.useRAO = true;
930
  castorConf.tapeLoadTimeout = 300;
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
  cta::log::DummyLogger dummyLog("dummy", "dummy");
  cta::mediachanger::MediaChangerFacade mc(dummyLog);
  cta::server::ProcessCap capUtils;
  castor::messages::TapeserverProxyDummy initialProcess;
  castor::tape::tapeserver::daemon::DataTransferSession sess("tapeHost", logger, mockSys,
    driveConfig, mc, initialProcess, capUtils, castorConf, scheduler);

  // 8) Run the data transfer session
  sess.execute();

  // 9) Check the session git the correct VID
  ASSERT_EQ(s_vid, sess.getVid());

  // 10) Check the remote files exist and have the correct size
  for(auto & path: remoteFilePaths) {
    struct stat statBuf;
    bzero(&statBuf, sizeof(statBuf));
    const int statRc = stat(path.substr(7).c_str(), &statBuf); //remove the "file://" for stat-ing
    ASSERT_EQ(0, statRc);
    ASSERT_EQ(1000, statBuf.st_size); //same size of data
  }

  // 10) Check logs
  std::string logToCheck = logger.getLog();
  logToCheck += "";
  ASSERT_NE(std::string::npos, logToCheck.find("firmwareVersion=\"123A\" serialNumber=\"123456\" "
                                               "mountTotalCorrectedReadErrors=\"5\" mountTotalReadBytesProcessed=\"4096\" "
                                               "mountTotalUncorrectedReadErrors=\"1\" mountTotalNonMediumErrorCounts=\"2\""));
  ASSERT_NE(std::string::npos, logToCheck.find("firmwareVersion=\"123A\" serialNumber=\"123456\" lifetimeMediumEfficiencyPrct=\"100\" "
                                               "mountReadEfficiencyPrct=\"100\" mountWriteEfficiencyPrct=\"100\" "
                                               "mountReadTransients=\"10\" "
                                               "mountServoTemps=\"10\" mountServoTransients=\"5\" mountTemps=\"100\" "
                                               "mountTotalReadRetries=\"25\" mountTotalWriteRetries=\"25\" mountWriteTransients=\"10\""));
  
  ASSERT_EQ(expectedRAOFseqOrder,getRAOFseqs(logToCheck));
}

TEST_P(DataTransferSessionTest, DataTransferSessionRAORecallLinearAlgorithm) {
  // 0) Prepare the logger for everyone
  cta::log::StringLogger logger("dummy","tapeServerUnitTest",cta::log::DEBUG);
  cta::log::LogContext logContext(logger);
  
  setupDefaultCatalogue();
  // 1) prepare the fake scheduler
  std::string vid = s_vid;
  // cta::MountType::Enum mountType = cta::MountType::RETRIEVE;

  // 3) Prepare the necessary environment (logger, plus system wrapper), 
  castor::tape::System::mockWrapper mockSys;
  mockSys.delegateToFake();
  mockSys.disableGMockCallsCounting();
  mockSys.fake.setupForVirtualDriveSLC6();
  //delete is unnecessary
  //pointer with ownership will be passed to the application,
  //which will do the delete 
  mockSys.fake.m_pathToDrive["/dev/nst0"] = new castor::tape::tapeserver::drive::FakeNonRAODrive;

  // 4) Create the scheduler
  auto & catalogue = getCatalogue();
  auto & scheduler = getScheduler();
  
  // Always use the same requester
  const cta::common::dataStructures::SecurityIdentity requester;

  // List to remember the path of each remote file so that the existance of the
  // files can be tested for at the end of the test
  std::list<std::string> remoteFilePaths;
  
  // 5) Create the environment for the migration to happen (library + tape) 
    const std::string libraryComment = "Library comment";
  const bool libraryIsDisabled = false;
  catalogue.createLogicalLibrary(s_adminOnAdminHost, s_libraryName,
    libraryIsDisabled, libraryComment);
  {
    auto libraries = catalogue.getLogicalLibraries();
    ASSERT_EQ(1, libraries.size());
    ASSERT_EQ(s_libraryName, libraries.front().name);
    ASSERT_EQ(libraryComment, libraries.front().comment);
  }

  {
1012
    auto tape = getDefaultTape();
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
    catalogue.createTape(s_adminOnAdminHost, tape);
  }

  int MAX_RECALLS = 50;
  int MAX_BULK_RECALLS = 31;
  std::map<size_t,std::vector<std::string>> expectedRAOOrder;
  // 6) Prepare files for reading by writing them to the mock system
  {
    // Label the tape
    castor::tape::tapeFile::LabelSession ls(*mockSys.fake.m_pathToDrive["/dev/nst0"], 
        s_vid, false);
    mockSys.fake.m_pathToDrive["/dev/nst0"]->rewind();
    // And write to it
    castor::tape::tapeserver::daemon::VolumeInfo volInfo;
    volInfo.vid=s_vid;
    castor::tape::tapeFile::WriteSession ws(*mockSys.fake.m_pathToDrive["/dev/nst0"],
       volInfo , 0, true, false);

    // Write a few files on the virtual tape and modify the archive name space
    // so that it is in sync
    uint8_t data[1000];
    size_t archiveFileSize=sizeof(data);
    castor::tape::SCSI::Structures::zeroStruct(&data);
    int fseq;
    //For the RAO orders we will have two rao calls : first with 30 files,
    //the second with 20 files
    for (fseq=1; fseq <= MAX_RECALLS ; fseq ++) {
      expectedRAOOrder[fseq / MAX_BULK_RECALLS].push_back(std::to_string(fseq));
      // Create a path to a remote destination file
      std::ostringstream remoteFilePath;
      remoteFilePath << "file://" << m_tmpDir << "/test" << fseq;
      remoteFilePaths.push_back(remoteFilePath.str());

      // Create an archive file entry in the archive namespace
      auto tapeFileWrittenUP = cta::make_unique<cta::catalogue::TapeFileWritten>();
      auto &tapeFileWritten=*tapeFileWrittenUP;
      std::set<cta::catalogue::TapeItemWrittenPointer> tapeFileWrittenSet;
      tapeFileWrittenSet.insert(tapeFileWrittenUP.release());
      
      // Write the file to tape
      cta::MockArchiveMount mam(catalogue);
      std::unique_ptr<cta::ArchiveJob> aj(new cta::MockArchiveJob(&mam, catalogue));
      aj->tapeFile.fSeq = fseq;
      aj->archiveFile.archiveFileID = fseq;
      castor::tape::tapeFile::WriteFile wf(&ws, *aj, archiveFileSize);
      tapeFileWritten.blockId = wf.getBlockId();
      // Write the data (one block)
      wf.write(data, archiveFileSize);
      // Close the file
      wf.close();

      // Create file entry in the archive namespace
      tapeFileWritten.archiveFileId=fseq;
      tapeFileWritten.checksumBlob.insert(cta::checksum::ADLER32, cta::utils::getAdler32(data, archiveFileSize));
      tapeFileWritten.vid=volInfo.vid;
      tapeFileWritten.size=archiveFileSize;
      tapeFileWritten.fSeq=fseq;
      tapeFileWritten.copyNb=1;
      tapeFileWritten.diskInstance = s_diskInstance;
      tapeFileWritten.diskFileId = fseq;
      
      tapeFileWritten.diskFileOwnerUid = DISK_FILE_SOME_USER;
      tapeFileWritten.diskFileGid = DISK_FILE_SOME_GROUP;
      tapeFileWritten.storageClassName = s_storageClassName;
      tapeFileWritten.tapeDrive = "drive0";
      catalogue.filesWrittenToTape(tapeFileWrittenSet);

      // Schedule the retrieval of the file
      std::string diskInstance="disk_instance";
      cta::common::dataStructures::RetrieveRequest rReq;
      rReq.archiveFileID=fseq;
      rReq.requester.name = s_userName;
      rReq.requester.group = "someGroup";
      rReq.dstURL = remoteFilePaths.back();
Michael Davis's avatar
Michael Davis committed
1087
      rReq.isVerifyOnly = false;
1088
1089
      std::list<std::string> archiveFilePaths;
      scheduler.queueRetrieve(diskInstance, rReq, logContext);
1090
1091
    }
  }
1092
  scheduler.waitSchedulerDbSubthreadsComplete();
1093
1094
1095
1096
1097
1098
1099
    
  // 6) Report the drive's existence and put it up in the drive register.
  cta::tape::daemon::TpconfigLine driveConfig("T10D6116", "TestLogicalLibrary", "/dev/tape_T10D6116", "manual");
  cta::common::dataStructures::DriveInfo driveInfo;
  driveInfo.driveName=driveConfig.unitName;
  driveInfo.logicalLibrary=driveConfig.rawLibrarySlot;
  // We need to create the drive in the registry before being able to put it up.
1100
  scheduler.reportDriveStatus(driveInfo, cta::common::dataStructures::MountType::NoMount, cta::common::dataStructures::DriveStatus::Down, logContext);
1101
1102
1103
1104
  cta::common::dataStructures::DesiredDriveState driveState;
  driveState.up = true;
  driveState.forceDown = false;
  scheduler.setDesiredDriveState(s_adminOnAdminHost, driveConfig.unitName, driveState, logContext);
1105
1106
1107
1108
1109
1110
1111
1112
1113

  // 7) Create the data transfer session
  DataTransferConfig castorConf;
  castorConf.bufsz = 1024*1024; // 1 MB memory buffers
  castorConf.nbBufs = 10;
  castorConf.bulkRequestRecallMaxBytes = UINT64_C(100)*1000*1000*1000;
  castorConf.bulkRequestRecallMaxFiles = MAX_BULK_RECALLS - 1;
  castorConf.nbDiskThreads = 1;
  castorConf.useRAO = true;
1114
  castorConf.raoLtoAlgorithm = "linear";
1115
  castorConf.tapeLoadTimeout = 300;
1116
  cta::log::DummyLogger dummyLog("dummy", "dummy");
1117
1118
1119
1120
  cta::mediachanger::MediaChangerFacade mc(dummyLog);
  cta::server::ProcessCap capUtils;
  castor::messages::TapeserverProxyDummy initialProcess;
  castor::tape::tapeserver::daemon::DataTransferSession sess("tapeHost", logger, mockSys,
1121
    driveConfig, mc, initialProcess, capUtils, castorConf, scheduler);
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148

  // 8) Run the data transfer session
  sess.execute();

  // 9) Check the session git the correct VID
  ASSERT_EQ(s_vid, sess.getVid());

  // 10) Check the remote files exist and have the correct size
  for(auto & path: remoteFilePaths) {
    struct stat statBuf;
    bzero(&statBuf, sizeof(statBuf));
    const int statRc = stat(path.substr(7).c_str(), &statBuf); //remove the "file://" for stat-ing
    ASSERT_EQ(0, statRc);
    ASSERT_EQ(1000, statBuf.st_size); //same size of data
  }

  // 10) Check logs
  std::string logToCheck = logger.getLog();
  logToCheck += "";
  ASSERT_NE(std::string::npos, logToCheck.find("firmwareVersion=\"123A\" serialNumber=\"123456\" "
                                               "mountTotalCorrectedReadErrors=\"5\" mountTotalReadBytesProcessed=\"4096\" "
                                               "mountTotalUncorrectedReadErrors=\"1\" mountTotalNonMediumErrorCounts=\"2\""));
  ASSERT_NE(std::string::npos, logToCheck.find("firmwareVersion=\"123A\" serialNumber=\"123456\" lifetimeMediumEfficiencyPrct=\"100\" "
                                               "mountReadEfficiencyPrct=\"100\" mountWriteEfficiencyPrct=\"100\" "
                                               "mountReadTransients=\"10\" "
                                               "mountServoTemps=\"10\" mountServoTransients=\"5\" mountTemps=\"100\" "
                                               "mountTotalReadRetries=\"25\" mountTotalWriteRetries=\"25\" mountWriteTransients=\"10\""));
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
  
  ASSERT_EQ(expectedRAOOrder,getRAOFseqs(logToCheck));
}

TEST_P(DataTransferSessionTest, DataTransferSessionRAORecallRAOAlgoDoesNotExistShouldApplyLinear) {
  // 0) Prepare the logger for everyone
  cta::log::StringLogger logger("dummy","tapeServerUnitTest",cta::log::DEBUG);
  cta::log::LogContext logContext(logger);
  
  setupDefaultCatalogue();
  // 1) prepare the fake scheduler
  std::string vid = s_vid;
  // cta::MountType::Enum mountType = cta::MountType::RETRIEVE;

  // 3) Prepare the necessary environment (logger, plus system wrapper), 
  castor::tape::System::mockWrapper mockSys;
  mockSys.delegateToFake();
  mockSys.disableGMockCallsCounting();
  mockSys.fake.setupForVirtualDriveSLC6();
  //delete is unnecessary
  //pointer with ownership will be passed to the application,
  //which will do the delete 
  mockSys.fake.m_pathToDrive["/dev/nst0"] = new castor::tape::tapeserver::drive::FakeNonRAODrive;

  // 4) Create the scheduler
  auto & catalogue = getCatalogue();
  auto & scheduler = getScheduler();
  
  // Always use the same requester
  const cta::common::dataStructures::SecurityIdentity requester;

  // List to remember the path of each remote file so that the existance of the
  // files can be tested for at the end of the test
  std::list<std::string> remoteFilePaths;
  
  // 5) Create the environment for the migration to happen (library + tape) 
    const std::string libraryComment = "Library comment";
  const bool libraryIsDisabled = false;
  catalogue.createLogicalLibrary(s_adminOnAdminHost, s_libraryName,
    libraryIsDisabled, libraryComment);
  {
    auto libraries = catalogue.getLogicalLibraries();
    ASSERT_EQ(1, libraries.size());
    ASSERT_EQ(s_libraryName, libraries.front().name);
    ASSERT_EQ(libraryComment, libraries.front().comment);
  }

  {
1197
    auto tape = getDefaultTape();
1198
    catalogue.createTape(s_adminOnAdminHost, tape);