@cloudant/couchbackup 2.9.12-SNAPSHOT.136 → 2.9.12

package/.scannerwork/scanner-report/source-30.txt

@@ -18,45 +18,113 @@
 const fs = require('fs');
 const u = require('./citestutils.js');
 
-describe('Event tests', function() {
-  it('should get a finished event when using stdout', function(done) {
-    u.setTimeout(this, 40);
-    // Use the API so we can get events
-    const params = { useApi: true };
-    const backup = u.testBackup(params, 'animaldb', process.stdout, function(err) {
-      if (err) {
-        done(err);
-      }
+[{ useApi: true }, { useApi: false }].forEach(function(params) {
+  describe(u.scenario('Basic backup and restore', params), function() {
+    it('should backup animaldb to a file correctly', function(done) {
+      // Allow up to 40 s to backup and compare (it should be much faster)!
+      u.setTimeout(this, 40);
+      const actualBackup = `./${this.fileName}`;
+      // Create a file and backup to it
+      const output = fs.createWriteStream(actualBackup);
+      output.on('open', function() {
+        u.testBackup(params, 'animaldb', output, function(err) {
+          if (err) {
+            done(err);
+          } else {
+            u.readSortAndDeepEqual(actualBackup, './test/fixtures/animaldb_expected.json', done);
+          }
+        });
+      });
     });
-    backup.on('finished', function() {
-      try {
-        // Test will time out if the finished event is not emitted
-        done();
-      } catch (err) {
-        done(err);
-      }
+
+    it('should restore animaldb to a database correctly', function(done) {
+      // Allow up to 60 s to restore and compare (again it should be faster)!
+      u.setTimeout(this, 60);
+      const input = fs.createReadStream('./test/fixtures/animaldb_expected.json');
+      const dbName = this.dbName;
+      input.on('open', function() {
+        u.testRestore(params, input, dbName, function(err) {
+          if (err) {
+            done(err);
+          } else {
+            u.dbCompare('animaldb', dbName, done);
+          }
+        });
+      });
     });
-  });
-  it('should get a finished event when using file output', function(done) {
-    u.setTimeout(this, 40);
-    // Use the API so we can get events
-    const params = { useApi: true };
-    const actualBackup = `./${this.fileName}`;
-    // Create a file and backup to it
-    const output = fs.createWriteStream(actualBackup);
-    output.on('open', function() {
-      const backup = u.testBackup(params, 'animaldb', output, function(err) {
-        if (err) {
-          done(err);
-        }
+
+    it('should execute a shallow mode backup successfully', function(done) {
+      // Allow 30 s
+      u.setTimeout(this, 30);
+      const actualBackup = `./${this.fileName}`;
+      const output = fs.createWriteStream(actualBackup);
+      // Add the shallow mode option
+      const p = u.p(params, { opts: { mode: 'shallow' } });
+      output.on('open', function() {
+        u.testBackup(p, 'animaldb', output, function(err) {
+          if (err) {
+            done(err);
+          } else {
+            u.readSortAndDeepEqual(actualBackup, './test/fixtures/animaldb_expected_shallow.json', done);
+          }
+        });
+      });
+    });
+
+    describe(u.scenario('Buffer size tests', params), function() {
+      it('should backup/restore animaldb with the same buffer size', function(done) {
+        // Allow up to 60 s for backup and restore of animaldb
+        u.setTimeout(this, 60);
+        const actualBackup = `./${this.fileName}`;
+        const logFile = `./${this.fileName}` + '.log';
+        const p = u.p(params, { opts: { log: logFile, bufferSize: 1 } });
+        u.testBackupAndRestoreViaFile(p, 'animaldb', actualBackup, this.dbName, done);
+      });
+      it('should backup/restore animaldb with backup buffer > restore buffer', function(done) {
+        // Allow up to 60 s for backup and restore of animaldb
+        u.setTimeout(this, 60);
+        const actualBackup = `./${this.fileName}`;
+        const logFile = `./${this.fileName}` + '.log';
+        const dbName = this.dbName;
+        const p = u.p(params, { opts: { log: logFile, bufferSize: 2 } }); // backup
+        const q = u.p(params, { opts: { bufferSize: 1 } }); // restore
+        u.testBackupToFile(p, 'animaldb', actualBackup, function(err) {
+          if (err) {
+            done(err);
+          } else {
+            // restore
+            u.testRestoreFromFile(q, actualBackup, dbName, function(err) {
+              if (!err) {
+                u.dbCompare('animaldb', dbName, done);
+              } else {
+                done(err);
+              }
+            });
+          }
+        });
       });
-      backup.on('finished', function() {
-        try {
-          // Test will time out if the finished event is not emitted
-          done();
-        } catch (err) {
-          done(err);
-        }
+      it('should backup/restore animaldb with backup buffer < restore buffer', function(done) {
+        // Allow up to 60 s for backup and restore of animaldb
+        u.setTimeout(this, 60);
+        const actualBackup = `./${this.fileName}`;
+        const logFile = `./${this.fileName}` + '.log';
+        const dbName = this.dbName;
+        const p = u.p(params, { opts: { log: logFile, bufferSize: 1 } }); // backup
+        const q = u.p(params, { opts: { bufferSize: 2 } }); // restore
+        u.testBackupToFile(p, 'animaldb', actualBackup, function(err) {
+          if (err) {
+            done(err);
+          } else {
+            // restore
+            u.testRestoreFromFile(q, actualBackup, dbName, function(err) {
+              if (!err) {
+                u.dbCompare('animaldb', dbName, done);
+              } else {
+                done(err);
+              }
+            });
+          }
+        });
       });
     });
   });

package/.scannerwork/scanner-report/source-42.txt

@@ -1,4 +1,4 @@
-// Copyright © 2017 IBM Corp. All rights reserved.
+// Copyright © 2017, 2021 IBM Corp. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -12,22 +12,354 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-/* global describe it */
+/* global describe afterEach before after it */
 'use strict';
 
 const assert = require('assert');
-const logfilesummary = require('../includes/logfilesummary.js');
-
-describe('#unit Fetching summary from the log file', function() {
-  it('should fetch a summary correctly', function(done) {
-    logfilesummary('./test/fixtures/test.log', function(err, data) {
-      assert.ok(!err);
-      assert.ok(data);
-      assert.strictEqual(data.changesComplete, true);
-      assert.strictEqual(typeof data.batches, 'object');
-      assert.strictEqual(Object.keys(data.batches).length, 2);
-      assert.deepStrictEqual(data.batches['1'], true);
-      assert.deepStrictEqual(data.batches['4'], true);
+const parser = require('../includes/parser.js');
+
+describe('#unit Default parameters', function() {
+  let processEnvCopy;
+  let processArgvCopy;
+
+  before('Set process data for test', function() {
+    // Copy env and argv so we can reset them after the tests
+    processEnvCopy = JSON.parse(JSON.stringify(process.env));
+    processArgvCopy = JSON.parse(JSON.stringify(process.argv));
+
+    // setup environment variables
+    process.env.COUCH_URL = 'http://user:pass@myurl.com';
+    process.env.COUCH_DATABASE = 'mydb';
+    process.env.COUCH_BUFFER_SIZE = '1000';
+    process.env.COUCH_PARALLELISM = '20';
+    process.env.COUCH_REQUEST_TIMEOUT = '20000';
+    process.env.COUCH_LOG = 'my.log';
+    process.env.COUCH_RESUME = 'true';
+    process.env.COUCH_OUTPUT = 'myfile.txt';
+    process.env.COUCH_MODE = 'shallow';
+    process.env.CLOUDANT_IAM_API_KEY = 'ABC123-ZYX987_cba789-xyz321';
+    process.env.COUCH_QUIET = 'true';
+  });
+
+  after('Reset process data', function() {
+    process.env = processEnvCopy;
+    process.argv = processArgvCopy;
+  });
+
+  afterEach(function() {
+    delete require.cache[require.resolve('commander')];
+  });
+
+  describe('Backup command-line', function() {
+    it('respects the COUCH_URL env variable if the --url backup command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.url, 'string');
+      assert.strictEqual(program.url, process.env.COUCH_URL);
+      done();
+    });
+
+    it('respects the COUCH_DATABASE env variable if the --db backup command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.db, 'string');
+      assert.strictEqual(program.db, process.env.COUCH_DATABASE);
+      done();
+    });
+
+    it('respects the COUCH_BUFFER_SIZE env variable if the --buffer-size backup command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.bufferSize, 'number');
+      assert.strictEqual(program.bufferSize, parseInt(process.env.COUCH_BUFFER_SIZE, 10));
+      done();
+    });
+
+    it('respects the COUCH_PARALLELISM env variable if the --parallelism backup command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.parallelism, 'number');
+      assert.strictEqual(program.parallelism, parseInt(process.env.COUCH_PARALLELISM, 10));
+      done();
+    });
+
+    it('respects the COUCH_REQUEST_TIMEOUT env variable if the --request-timeout backup command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.requestTimeout, 'number');
+      assert.strictEqual(program.requestTimeout, parseInt(process.env.COUCH_REQUEST_TIMEOUT, 10));
+      done();
+    });
+
+    it('respects the CLOUDANT_IAM_API_KEY env variable if the --iam-api-key backup command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.iamApiKey, 'string');
+      assert.strictEqual(program.iamApiKey, process.env.CLOUDANT_IAM_API_KEY);
+      done();
+    });
+
+    it('respects the COUCH_LOG env variable if the --log backup command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.log, 'string');
+      assert.strictEqual(program.log, process.env.COUCH_LOG);
+      done();
+    });
+
+    it('respects the COUCH_RESUME env variable if the --resume backup command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.resume, 'boolean');
+      assert.strictEqual(program.resume, true);
+      done();
+    });
+
+    it('respects the COUCH_OUTPUT env variable if the --output backup command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.output, 'string');
+      assert.strictEqual(program.output, process.env.COUCH_OUTPUT);
+      done();
+    });
+
+    it('respects the COUCH_MODE env variable if the --mode backup command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.mode, 'string');
+      assert.strictEqual(program.mode, process.env.COUCH_MODE);
+      done();
+    });
+
+    it('respects the COUCH_QUIET env variable if the --quiet backup command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.quiet, 'boolean');
+      assert.strictEqual(program.quiet, true);
+      done();
+    });
+
+    it('respects the backup --url command-line parameter', function(done) {
+      const url = 'http://user:pass@myurl2.com';
+      process.argv = ['node', 'test', '--url', url];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.url, 'string');
+      assert.strictEqual(program.url, url);
+      done();
+    });
+
+    it('respects the backup --db command-line parameter', function(done) {
+      const db = 'mydb2';
+      process.argv = ['node', 'test', '--db', db];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.db, 'string');
+      assert.strictEqual(program.db, db);
+      done();
+    });
+
+    it('respects the backup --buffer-size command-line parameter', function(done) {
+      const bufferSize = 500;
+      process.argv = ['node', 'test', '--buffer-size', bufferSize];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.bufferSize, 'number');
+      assert.strictEqual(program.bufferSize, bufferSize);
+      done();
+    });
+
+    it('respects the backup --parallelism command-line parameter', function(done) {
+      const parallelism = 10;
+      process.argv = ['node', 'test', '--parallelism', parallelism];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.parallelism, 'number');
+      assert.strictEqual(program.parallelism, parallelism);
+      done();
+    });
+
+    it('respects the backup --request-timeout command-line parameter', function(done) {
+      const requestTimeout = 10000;
+      process.argv = ['node', 'test', '--request-timeout', requestTimeout];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.requestTimeout, 'number');
+      assert.strictEqual(program.requestTimeout, requestTimeout);
+      done();
+    });
+
+    it('respects the backup --iam-api-key command-line parameter', function(done) {
+      const key = '123abc-789zyx_CBA987-XYZ321';
+      process.argv = ['node', 'test', '--iam-api-key', key];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.iamApiKey, 'string');
+      assert.strictEqual(program.iamApiKey, key);
+      done();
+    });
+
+    it('respects the backup --log command-line parameter', function(done) {
+      const filename = 'my2.log';
+      process.argv = ['node', 'test', '--log', filename];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.log, 'string');
+      assert.strictEqual(program.log, filename);
+      done();
+    });
+
+    it('respects the backup --resume command-line parameter', function(done) {
+      process.argv = ['node', 'test', '--resume'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.resume, 'boolean');
+      assert.strictEqual(program.resume, true);
+      done();
+    });
+
+    it('respects the backup --output command-line parameter', function(done) {
+      const filename = 'myfile2.txt';
+      process.argv = ['node', 'test', '--output', filename];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.output, 'string');
+      assert.strictEqual(program.output, filename);
+      done();
+    });
+
+    it('respects the backup --mode full command-line parameter', function(done) {
+      process.argv = ['node', 'test', '--mode', 'full'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.mode, 'string');
+      assert.strictEqual(program.mode, 'full');
+      done();
+    });
+
+    it('respects the backup --mode shallow command-line parameter', function(done) {
+      process.argv = ['node', 'test', '--mode', 'shallow'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.mode, 'string');
+      assert.strictEqual(program.mode, 'shallow');
+      done();
+    });
+
+    it('respects the backup --quiet command-line parameter', function(done) {
+      process.argv = ['node', 'test', '--quiet'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.quiet, 'boolean');
+      assert.strictEqual(program.quiet, true);
+      done();
+    });
+  });
+
+  describe('Restore command-line', function() {
+    it('respects the COUCH_URL env variable if the --url restore command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseRestoreArgs();
+      assert.strictEqual(typeof program.url, 'string');
+      assert.strictEqual(program.url, process.env.COUCH_URL);
+      done();
+    });
+
+    it('respects the COUCH_DATABASE env variable if the --db restore command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseRestoreArgs();
+      assert.strictEqual(typeof program.db, 'string');
+      assert.strictEqual(program.db, process.env.COUCH_DATABASE);
+      done();
+    });
+
+    it('respects the COUCH_BUFFER_SIZE env variable if the --buffer-size restore command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseRestoreArgs();
+      assert.strictEqual(typeof program.bufferSize, 'number');
+      assert.strictEqual(program.bufferSize, parseInt(process.env.COUCH_BUFFER_SIZE, 10));
+      done();
+    });
+
+    it('respects the COUCH_PARALLELISM env variable if the --parallelism restore command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseRestoreArgs();
+      assert.strictEqual(typeof program.parallelism, 'number');
+      assert.strictEqual(program.parallelism, parseInt(process.env.COUCH_PARALLELISM, 10));
+      done();
+    });
+
+    it('respects the COUCH_REQUEST_TIMEOUT env variable if the --request-timeout restore command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseRestoreArgs();
+      assert.strictEqual(typeof program.requestTimeout, 'number');
+      assert.strictEqual(program.requestTimeout, parseInt(process.env.COUCH_REQUEST_TIMEOUT, 10));
+      done();
+    });
+
+    it('respects the CLOUDANT_IAM_API_KEY env variable if the --iam-api-key restore command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseRestoreArgs();
+      assert.strictEqual(typeof program.iamApiKey, 'string');
+      assert.strictEqual(program.iamApiKey, process.env.CLOUDANT_IAM_API_KEY);
+      done();
+    });
+
+    it('respects the COUCH_QUIET env variable if the --quiet restorer command-line parameter is missing', function(done) {
+      process.argv = ['node', 'test'];
+      const program = parser.parseBackupArgs();
+      assert.strictEqual(typeof program.quiet, 'boolean');
+      assert.strictEqual(program.quiet, true);
+      done();
+    });
+
+    it('respects the restore --url command-line parameter', function(done) {
+      const url = 'https://a:b@myurl3.com';
+      process.argv = ['node', 'test', '--url', url];
+      const program = parser.parseRestoreArgs();
+      assert.strictEqual(typeof program.url, 'string');
+      assert.strictEqual(program.url, url);
+      done();
+    });
+
+    it('respects the restore --db command-line parameter', function(done) {
+      const db = 'mydb3';
+      process.argv = ['node', 'test', '--db', db];
+      const program = parser.parseRestoreArgs();
+      assert.strictEqual(typeof program.db, 'string');
+      assert.strictEqual(program.db, db);
+      done();
+    });
+
+    it('respects the restore --buffer-size command-line parameter', function(done) {
+      const bufferSize = 250;
+      process.argv = ['node', 'test', '--buffer-size', bufferSize];
+      const program = parser.parseRestoreArgs();
+      assert.strictEqual(typeof program.bufferSize, 'number');
+      assert.strictEqual(program.bufferSize, bufferSize);
+      done();
+    });
+
+    it('respects the restore --parallelism command-line parameter', function(done) {
+      const parallelism = 5;
+      process.argv = ['node', 'test', '--parallelism', parallelism];
+      const program = parser.parseRestoreArgs();
+      assert.strictEqual(typeof program.parallelism, 'number');
+      assert.strictEqual(program.parallelism, parallelism);
+      done();
+    });
+
+    it('respects the restore --request-timeout command-line parameter', function(done) {
+      const requestTimeout = 10000;
+      process.argv = ['node', 'test', '--request-timeout', requestTimeout];
+      const program = parser.parseRestoreArgs();
+      assert.strictEqual(typeof program.requestTimeout, 'number');
+      assert.strictEqual(program.requestTimeout, requestTimeout);
+      done();
+    });
+
+    it('respects the restore --iam-api-key command-line parameter', function(done) {
+      const key = '123abc-789zyx_CBA987-XYZ321';
+      process.argv = ['node', 'test', '--iam-api-key', key];
+      const program = parser.parseRestoreArgs();
+      assert.strictEqual(typeof program.iamApiKey, 'string');
+      assert.strictEqual(program.iamApiKey, key);
+      done();
+    });
+
+    it('respects the restore --quiet command-line parameter', function(done) {
+      process.argv = ['node', 'test', '--quiet'];
+      const program = parser.parseRestoreArgs();
+      assert.strictEqual(typeof program.quiet, 'boolean');
+      assert.strictEqual(program.quiet, true);
       done();
     });
   });