arangodb/js/client/modules/@arangodb/testsuites/dump_encrypted.js

/* jshint strict: false, sub: true */
/* global print */
'use strict';

// //////////////////////////////////////////////////////////////////////////////
// / DISCLAIMER
// /
// / Copyright 2016 ArangoDB GmbH, Cologne, Germany
// / Copyright 2014 triagens GmbH, Cologne, Germany
// /
// / Licensed under the Apache License, Version 2.0 (the "License")
// / you may not use this file except in compliance with the License.
// / You may obtain a copy of the License at
// /
// /     http://www.apache.org/licenses/LICENSE-2.0
// /
// / Unless required by applicable law or agreed to in writing, software
// / distributed under the License is distributed on an "AS IS" BASIS,
// / WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// / See the License for the specific language governing permissions and
// / limitations under the License.
// /
// / Copyright holder is ArangoDB GmbH, Cologne, Germany
// /
// / @author Jan Steemann
// //////////////////////////////////////////////////////////////////////////////

const functionsDocumentation = {
  'dump_encrypted': 'encrypted dump tests'
};
const optionsDocumentation = [
  '   - `skipEncrypted` : if set to true the encryption tests are skipped',
];

const pu = require('@arangodb/process-utils');
const tu = require('@arangodb/test-utils');
const fs = require('fs');
const _ = require('lodash');

const CYAN = require('internal').COLORS.COLOR_CYAN;
const RESET = require('internal').COLORS.COLOR_RESET;

function dumpEncrypted(options) {
  let cluster;

  if (options.cluster) {
    cluster = '-cluster';
  } else {
    cluster = '';
  }
  
  if (options.skipEncrypted === true) {
    print('skipping encryption tests!');
    return {
      failed: 0,
      dump_encrypted: {
        failed: 0,
        status: true,
        skipped: true
      }
    };
  } // if

  const storageEngine = options.storageEngine;

  print(CYAN + 'Encrypted dump tests...' + RESET);

  let instanceInfo = pu.startInstance('tcp', options, {}, 'dump_encrypted');

  if (instanceInfo === false) {
    return {
      failed: 1,
      dump: {
        status: false,
        message: 'failed to start server!'
      }
    };
  }

  print(CYAN + Date() + ': Setting up' + RESET);

  let results = { failed: 1 };
  results.setup = tu.runInArangosh(options, instanceInfo,
    tu.makePathUnix('js/server/tests/dump/dump-setup' + cluster + '.js'));
  results.setup.failed = 1;

  let keyFile = fs.join(instanceInfo.rootDir, 'secret-key');
  fs.write(keyFile, 'DER-HUND-der-hund-der-hund-der-h'); // must be exactly 32 chars long

  if (pu.arangod.check.instanceAlive(instanceInfo, options) &&
    (results.setup.status === true)) {
    results.setup.failed = 0;

    print(CYAN + Date() + ': Encrypted Dump and Restore - dump' + RESET);

    let dumpOptions = _.clone(options);
    dumpOptions.encrypted = true;
    results.dump = pu.run.arangoDumpRestore(dumpOptions, instanceInfo, 'dump',
      'UnitTestsDumpSrc');
    results.dump.failed = 1;
    if (pu.arangod.check.instanceAlive(instanceInfo, options) &&
      (results.dump.status === true)) {
      results.dump.failed = 0;

      print(CYAN + Date() + ': Encrypted Dump and Restore - restore' + RESET);

      results.restore = pu.run.arangoDumpRestore(dumpOptions, instanceInfo, 'restore',
        'UnitTestsDumpDst');
      results.restore.failed = 1;
      if (pu.arangod.check.instanceAlive(instanceInfo, options) &&
        (results.restore.status === true)) {
        results.restore.failed = 0;

        print(CYAN + Date() + ': Encrypted Dump and Restore - dump after restore' + RESET);

        results.test = tu.runInArangosh(options, instanceInfo,
          tu.makePathUnix('js/server/tests/dump/dump-' + storageEngine + cluster + '.js'), {
            'server.database': 'UnitTestsDumpDst'
          });
        results.test.failed = 1;
        if (pu.arangod.check.instanceAlive(instanceInfo, options) &&
          (results.test.status === true)) {
          results.test.failed = 0;

          print(CYAN + Date() + ': Encrypted Dump and Restore - teardown' + RESET);

          results.tearDown = tu.runInArangosh(options, instanceInfo,
                                              tu.makePathUnix('js/server/tests/dump/dump-teardown' + cluster + '.js'));
          results.tearDown.failed = 1;
          if (results.tearDown.status) {
            results.tearDown.failed = 0;
            results.failed = 0;
          }
        }
      }
    }
  }

  print(CYAN + 'Shutting down...' + RESET);
  pu.shutdownInstance(instanceInfo, options);
  print(CYAN + 'done.' + RESET);

  print();

  return results;
}

function setup(testFns, defaultFns, opts, fnDocs, optionsDoc) {
  // turn off encryption tests by default. only enable them in enterprise version
  opts['skipEncrypted'] = true;
  let version = {};
  if (global.ARANGODB_CLIENT_VERSION) {
    version = global.ARANGODB_CLIENT_VERSION(true);
    if (version['enterprise-version']) {
      opts['skipEncrypted'] = false;
    }
  }
  testFns['dump_encrypted'] = dumpEncrypted;
  defaultFns.push('dump_encrypted');
  for (var attrname in functionsDocumentation) { fnDocs[attrname] = functionsDocumentation[attrname]; }
  for (var i = 0; i < optionsDocumentation.length; i++) { optionsDoc.push(optionsDocumentation[i]); }
}

exports.setup = setup;