@cloudant/couchbackup 2.9.13 → 2.9.14-SNAPSHOT.147

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

@@ -1,509 +1,281 @@
-<testsuites name="test">
-  <testsuite name="#unit Validate arguments" tests="33" errors="0" failures="0" skipped="0" timestamp="2023-09-28T16:52:41" time="0.106">
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid URL type" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns no error for valid URL type" time="0.028">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid (no host) URL" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid (no protocol) URL" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid (wrong protocol) URL" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid (no path) URL" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid (no protocol, no host) URL" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid buffer size type" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for zero buffer size" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for float buffer size" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns no error for valid buffer size type" time="0.008">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid log type" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns no error for valid log type" time="0.005">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid mode type" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid mode string" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns no error for valid mode type" time="0.005">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid output type" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns no error for valid output type" time="0.005">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid parallelism type" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for zero parallelism" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for float parallelism" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns no error for valid parallelism type" time="0.005">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid request timeout type" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for zero request timeout" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for float request timout" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns no error for valid request timeout type" time="0.004">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid resume type" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns no error for valid resume type" time="0.004">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for invalid key type" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="returns error for key and URL credentials supplied" time="0">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="warns for log arg in shallow mode" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="warns for resume arg in shallow mode" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Validate arguments" name="warns for parallism arg in shallow mode" time="0.001">
-    </testcase>
-  </testsuite>
-  <testsuite name="Basic backup and restore using API" tests="3" errors="0" failures="0" skipped="0" timestamp="2023-09-28T16:52:41" time="4.51">
-    <testcase classname="test.Basic backup and restore using API" name="should backup animaldb to a file correctly" time="0.916">
-      <system-out><![CDATA[{ total: 15 }
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Basic backup and restore using API" name="should restore animaldb to a database correctly" time="1.818">
-      <system-out><![CDATA[{ total: 15 }
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Basic backup and restore using API" name="should execute a shallow mode backup successfully" time="0.625">
-      <system-out><![CDATA[{ total: 11 }
-]]></system-out>
-    </testcase>
-  </testsuite>
-  <testsuite name="Basic backup and restore using API Buffer size tests using API" tests="3" errors="0" failures="0" skipped="0" timestamp="2023-09-28T16:52:46" time="11.54">
-    <testcase classname="test.Basic backup and restore using API Buffer size tests using API" name="should backup/restore animaldb with the same buffer size" time="3.707">
-      <system-out><![CDATA[{ total: 15 }
-{ total: 15 }
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Basic backup and restore using API Buffer size tests using API" name="should backup/restore animaldb with backup buffer &gt; restore buffer" time="3.467">
-      <system-out><![CDATA[{ total: 15 }
-{ total: 15 }
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Basic backup and restore using API Buffer size tests using API" name="should backup/restore animaldb with backup buffer &lt; restore buffer" time="3.553">
-      <system-out><![CDATA[{ total: 15 }
-{ total: 15 }
-]]></system-out>
-    </testcase>
-  </testsuite>
-  <testsuite name="Basic backup and restore using CLI" tests="3" errors="0" failures="0" skipped="0" timestamp="2023-09-28T16:52:57" time="6.237">
-    <testcase classname="test.Basic backup and restore using CLI" name="should backup animaldb to a file correctly" time="1.604">
-      <system-out><![CDATA[Backup process close 0 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Basic backup and restore using CLI" name="should restore animaldb to a database correctly" time="2.479">
-    </testcase>
-    <testcase classname="test.Basic backup and restore using CLI" name="should execute a shallow mode backup successfully" time="1.347">
-      <system-out><![CDATA[Backup process close 0 null
-]]></system-out>
-    </testcase>
-  </testsuite>
-  <testsuite name="Basic backup and restore using CLI Buffer size tests using CLI" tests="3" errors="0" failures="0" skipped="0" timestamp="2023-09-28T16:53:03" time="16.64">
-    <testcase classname="test.Basic backup and restore using CLI Buffer size tests using CLI" name="should backup/restore animaldb with the same buffer size" time="5.347">
-      <system-out><![CDATA[Backup process close 0 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Basic backup and restore using CLI Buffer size tests using CLI" name="should backup/restore animaldb with backup buffer &gt; restore buffer" time="5.516">
-      <system-out><![CDATA[Backup process close 0 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Basic backup and restore using CLI Buffer size tests using CLI" name="should backup/restore animaldb with backup buffer &lt; restore buffer" time="4.973">
-      <system-out><![CDATA[Backup process close 0 null
-]]></system-out>
-    </testcase>
-  </testsuite>
-  <testsuite name="Compression tests using API" tests="3" errors="0" failures="0" skipped="0" timestamp="2023-09-28T16:53:20" time="6.535">
-    <testcase classname="test.Compression tests using API" name="should backup animaldb to a compressed file" time="0.872">
-      <system-out><![CDATA[{ total: 15 }
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Compression tests using API" name="should backup and restore animaldb via a compressed file" time="2.662">
-      <system-out><![CDATA[{ total: 15 }
-{ total: 15 }
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Compression tests using API" name="should backup and restore animaldb via a compressed stream" time="2.185">
-      <system-out><![CDATA[{ total: 15 }
-{ total: 15 }
-]]></system-out>
-    </testcase>
-  </testsuite>
-  <testsuite name="Compression tests using CLI" tests="3" errors="0" failures="0" skipped="0" timestamp="2023-09-28T16:53:27" time="9.995">
-    <testcase classname="test.Compression tests using CLI" name="should backup animaldb to a compressed file" time="1.608">
-      <system-out><![CDATA[Backup process close 0 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Compression tests using CLI" name="should backup and restore animaldb via a compressed file" time="4.502">
-      <system-out><![CDATA[Backup process close 0 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Compression tests using CLI" name="should backup and restore animaldb via a compressed stream" time="3.08">
-      <system-out><![CDATA[Backup process close 0 null
-]]></system-out>
-    </testcase>
-  </testsuite>
-  <testsuite name="End to end backup and restore using API" tests="2" errors="0" failures="0" skipped="0" timestamp="2023-09-28T16:53:37" time="323.445">
-    <testcase classname="test.End to end backup and restore using API" name="should backup and restore animaldb" time="2.188">
-      <system-out><![CDATA[{ total: 15 }
-{ total: 15 }
-]]></system-out>
-    </testcase>
-    <testcase classname="test.End to end backup and restore using API" name="should backup and restore largedb1g #slow" time="320.482">
-      <system-out><![CDATA[{ total: 522948 }
-{ total: 522948 }
-]]></system-out>
-    </testcase>
-  </testsuite>
-  <testsuite name="End to end backup and restore using CLI" tests="2" errors="0" failures="0" skipped="0" timestamp="2023-09-28T16:59:00" time="510.889">
-    <testcase classname="test.End to end backup and restore using CLI" name="should backup and restore animaldb" time="2.936">
-      <system-out><![CDATA[Backup process close 0 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.End to end backup and restore using CLI" name="should backup and restore largedb1g #slow" time="507.181">
-      <system-out><![CDATA[Backup process close 0 null
-]]></system-out>
-    </testcase>
-  </testsuite>
-  <testsuite name="Encryption tests" tests="1" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:07:31" time="4.587">
-    <testcase classname="test.Encryption tests" name="should backup and restore animaldb via an encrypted file" time="4.326">
-      <system-out><![CDATA[Backup process close 0 null
-]]></system-out>
-    </testcase>
-  </testsuite>
-  <testsuite name="Write error tests" tests="1" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:07:36" time="0.274">
-    <testcase classname="test.Write error tests" name="calls callback with error set when stream is not writeable" time="0.009">
-    </testcase>
-  </testsuite>
-  <testsuite name="Event tests" tests="2" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:07:36" time="2.274">
-    <testcase classname="test.Event tests" name="should get a finished event when using stdout" time="0.859">
-    </testcase>
-    <testcase classname="test.Event tests" name="should get a finished event when using file output" time="0.873">
-    </testcase>
-  </testsuite>
-  <testsuite name="Resume tests using API" tests="3" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:07:38" time="5.199">
-    <testcase classname="test.Resume tests using API" name="should create a log file" time="0.864">
-      <system-out><![CDATA[{ total: 15 }
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Resume tests using API" name="should restore corrupted animaldb to a database correctly" time="1.754">
-      <system-out><![CDATA[{ total: 15 }
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Resume tests using API" name="should restore resumed animaldb with blank line to a database correctly" time="1.774">
-      <system-out><![CDATA[{ total: 15 }
-]]></system-out>
-    </testcase>
-  </testsuite>
-  <testsuite name="Resume tests using CLI" tests="3" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:07:43" time="7.511">
-    <testcase classname="test.Resume tests using CLI" name="should create a log file" time="1.812">
-      <system-out><![CDATA[Backup process close 0 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Resume tests using CLI" name="should restore corrupted animaldb to a database correctly" time="2.391">
-    </testcase>
-    <testcase classname="test.Resume tests using CLI" name="should restore resumed animaldb with blank line to a database correctly" time="2.515">
-    </testcase>
-  </testsuite>
-  <testsuite name="Resume tests" tests="2" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:07:51" time="34.835">
-    <testcase classname="test.Resume tests" name="should correctly backup and restore backup10m" time="17.193">
-      <system-out><![CDATA[Backup process close null SIGTERM
-Backup process close 0 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.Resume tests" name="should correctly backup and restore backup10m using --output" time="17.107">
-      <system-out><![CDATA[Backup process close null SIGTERM
-Backup process close 0 null
-]]></system-out>
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Configuration" tests="12" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:08:26" time="0.012">
-    <testcase classname="test.#unit Configuration" name="respects the COUCH_URL env variable" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Configuration" name="respects the COUCH_DATABASE env variable" time="0">
-    </testcase>
-    <testcase classname="test.#unit Configuration" name="respects the COUCH_BUFFER_SIZE env variable" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Configuration" name="respects the COUCH_PARALLELISM env variable" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Configuration" name="respects the COUCH_REQUEST_TIMEOUT env variable" time="0">
-    </testcase>
-    <testcase classname="test.#unit Configuration" name="respects the CLOUDANT_IAM_API_KEY env variable" time="0">
-    </testcase>
-    <testcase classname="test.#unit Configuration" name="respects the CLOUDANT_IAM_TOKEN_URL env variable" time="0">
-    </testcase>
-    <testcase classname="test.#unit Configuration" name="respects the COUCH_LOG env variable" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Configuration" name="respects the COUCH_RESUME env variable" time="0">
-    </testcase>
-    <testcase classname="test.#unit Configuration" name="respects the COUCH_OUTPUT env variable" time="0">
-    </testcase>
-    <testcase classname="test.#unit Configuration" name="respects the COUCH_MODE env variable" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Configuration" name="respects the COUCH_QUIET env variable" time="0">
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Fatal errors using API for backup" tests="10" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:08:26" time="0.075">
-    <testcase classname="test.#unit Fatal errors using API for backup" name="should terminate when DB does not exist" time="0.01">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for backup" name="should terminate on BulkGetError" time="0.008">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for backup" name="should terminate on Unauthorized existence check" time="0.003">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for backup" name="should terminate on Forbidden no _reader" time="0.003">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for backup" name="should terminate on _bulk_get HTTPFatalError" time="0.018">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for backup" name="should terminate on NoLogFileName" time="0">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for backup" name="should terminate on LogDoesNotExist" time="0">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for backup" name="should terminate on IncompleteChangesInLogFile" time="0.007">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for backup" name="should terminate on _changes HTTPFatalError" time="0.01">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for backup" name="should terminate on SpoolChangesError" time="0.011">
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Fatal errors using API for restore" tests="9" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:08:26" time="0.151">
-    <testcase classname="test.#unit Fatal errors using API for restore" name="should terminate on Unauthorized db existence check" time="0.007">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for restore" name="should terminate on Forbidden no _writer" time="0.013">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for restore" name="should terminate on RestoreDatabaseNotFound" time="0.005">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for restore" name="should terminate on notEmptyDBErr when database is not empty" time="0.006">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for restore" name="should terminate on notEmptyDBErr when database is not new" time="0.006">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for restore" name="should terminate on _bulk_docs HTTPFatalError" time="0.012">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for restore" name="should terminate on _bulk_docs HTTPFatalError from system database" time="0.035">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for restore" name="should terminate on _bulk_docs HTTPFatalError large stream" time="0.042">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using API for restore" name="should terminate on multiple _bulk_docs HTTPFatalError" time="0.014">
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Fatal errors using CLI for backup" tests="10" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:08:26" time="6.426">
-    <testcase classname="test.#unit Fatal errors using CLI for backup" name="should terminate when DB does not exist" time="0.643">
-      <system-out><![CDATA[Backup process close 10 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for backup" name="should terminate on BulkGetError" time="0.62">
-      <system-out><![CDATA[Backup process close 50 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for backup" name="should terminate on Unauthorized existence check" time="0.607">
-      <system-out><![CDATA[Backup process close 11 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for backup" name="should terminate on Forbidden no _reader" time="0.596">
-      <system-out><![CDATA[Backup process close 12 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for backup" name="should terminate on _bulk_get HTTPFatalError" time="0.612">
-      <system-out><![CDATA[Backup process close 40 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for backup" name="should terminate on NoLogFileName" time="0.488">
-      <system-out><![CDATA[Backup process close 20 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for backup" name="should terminate on LogDoesNotExist" time="0.507">
-      <system-out><![CDATA[Backup process close 21 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for backup" name="should terminate on IncompleteChangesInLogFile" time="0.696">
-      <system-out><![CDATA[Backup process close 22 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for backup" name="should terminate on _changes HTTPFatalError" time="1.025">
-      <system-out><![CDATA[Backup process close 40 null
-]]></system-out>
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for backup" name="should terminate on SpoolChangesError" time="0.622">
-      <system-out><![CDATA[Backup process close 30 null
-]]></system-out>
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Fatal errors using CLI for restore" tests="9" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:08:32" time="5.638">
-    <testcase classname="test.#unit Fatal errors using CLI for restore" name="should terminate on Unauthorized db existence check" time="0.723">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for restore" name="should terminate on Forbidden no _writer" time="0.589">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for restore" name="should terminate on RestoreDatabaseNotFound" time="0.589">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for restore" name="should terminate on notEmptyDBErr when database is not empty" time="0.574">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for restore" name="should terminate on notEmptyDBErr when database is not new" time="0.568">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for restore" name="should terminate on _bulk_docs HTTPFatalError" time="0.604">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for restore" name="should terminate on _bulk_docs HTTPFatalError from system database" time="0.665">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for restore" name="should terminate on _bulk_docs HTTPFatalError large stream" time="0.686">
-    </testcase>
-    <testcase classname="test.#unit Fatal errors using CLI for restore" name="should terminate on multiple _bulk_docs HTTPFatalError" time="0.628">
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Fetching batches from a log file" tests="1" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:08:38" time="0.003">
-    <testcase classname="test.#unit Fetching batches from a log file" name="should fetch multiple batches correctly" time="0.001">
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Fetching summary from the log file" tests="1" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:08:38" time="0.002">
-    <testcase classname="test.#unit Fetching summary from the log file" name="should fetch a summary correctly" time="0.001">
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Default parameters Backup command-line" tests="23" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:08:38" time="0.055">
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the COUCH_URL env variable if the --url backup command-line parameter is missing" time="0.016">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the COUCH_DATABASE env variable if the --db backup command-line parameter is missing" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the COUCH_BUFFER_SIZE env variable if the --buffer-size backup command-line parameter is missing" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the COUCH_PARALLELISM env variable if the --parallelism backup command-line parameter is missing" time="0">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the COUCH_REQUEST_TIMEOUT env variable if the --request-timeout backup command-line parameter is missing" time="0">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the CLOUDANT_IAM_API_KEY env variable if the --iam-api-key backup command-line parameter is missing" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the COUCH_LOG env variable if the --log backup command-line parameter is missing" time="0.003">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the COUCH_RESUME env variable if the --resume backup command-line parameter is missing" time="0.002">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the COUCH_OUTPUT env variable if the --output backup command-line parameter is missing" time="0.002">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the COUCH_MODE env variable if the --mode backup command-line parameter is missing" time="0.002">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the COUCH_QUIET env variable if the --quiet backup command-line parameter is missing" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the backup --url command-line parameter" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the backup --db command-line parameter" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the backup --buffer-size command-line parameter" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the backup --parallelism command-line parameter" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the backup --request-timeout command-line parameter" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the backup --iam-api-key command-line parameter" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the backup --log command-line parameter" time="0">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the backup --resume command-line parameter" time="0">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the backup --output command-line parameter" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the backup --mode full command-line parameter" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the backup --mode shallow command-line parameter" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Backup command-line" name="respects the backup --quiet command-line parameter" time="0">
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Default parameters Restore command-line" tests="14" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:08:38" time="0.015">
-    <testcase classname="test.#unit Default parameters Restore command-line" name="respects the COUCH_URL env variable if the --url restore command-line parameter is missing" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Restore command-line" name="respects the COUCH_DATABASE env variable if the --db restore command-line parameter is missing" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Restore command-line" name="respects the COUCH_BUFFER_SIZE env variable if the --buffer-size restore command-line parameter is missing" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Restore command-line" name="respects the COUCH_PARALLELISM env variable if the --parallelism restore command-line parameter is missing" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Restore command-line" name="respects the COUCH_REQUEST_TIMEOUT env variable if the --request-timeout restore command-line parameter is missing" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Restore command-line" name="respects the CLOUDANT_IAM_API_KEY env variable if the --iam-api-key restore command-line parameter is missing" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Restore command-line" name="respects the COUCH_QUIET env variable if the --quiet restorer command-line parameter is missing" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Restore command-line" name="respects the restore --url command-line parameter" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Restore command-line" name="respects the restore --db command-line parameter" time="0.001">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Restore command-line" name="respects the restore --buffer-size command-line parameter" time="0">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Restore command-line" name="respects the restore --parallelism command-line parameter" time="0">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Restore command-line" name="respects the restore --request-timeout command-line parameter" time="0">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Restore command-line" name="respects the restore --iam-api-key command-line parameter" time="0.002">
-    </testcase>
-    <testcase classname="test.#unit Default parameters Restore command-line" name="respects the restore --quiet command-line parameter" time="0.001">
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Check request headers" tests="1" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:08:38" time="0.005">
-    <testcase classname="test.#unit Check request headers" name="should have a couchbackup user-agent" time="0.005">
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Check request response error callback" tests="8" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:08:38" time="10.616">
-    <testcase classname="test.#unit Check request response error callback" name="should not callback with error for 200 response" time="0.005">
-    </testcase>
-    <testcase classname="test.#unit Check request response error callback" name="should callback with error after 3 500 responses" time="2.016">
-    </testcase>
-    <testcase classname="test.#unit Check request response error callback" name="should callback with error after 3 POST 503 responses" time="2.019">
-    </testcase>
-    <testcase classname="test.#unit Check request response error callback" name="should callback with error after 3 429 responses" time="2.017">
-    </testcase>
-    <testcase classname="test.#unit Check request response error callback" name="should callback with fatal error for 404 response" time="0.004">
-    </testcase>
-    <testcase classname="test.#unit Check request response error callback" name="should callback with same error for no status code error response" time="2.027">
-    </testcase>
-    <testcase classname="test.#unit Check request response error callback" name="should retry request if HTTP request gets timed out" time="0.511">
-    </testcase>
-    <testcase classname="test.#unit Check request response error callback" name="should callback with error code ESOCKETTIMEDOUT if 3 HTTP requests gets timed out" time="2.01">
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Check request response error callback #unit Check credentials" tests="1" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:08:49" time="0.012">
-    <testcase classname="test.#unit Check request response error callback #unit Check credentials" name="should properly decode username and password" time="0.012">
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Perform backup using shallow backup" tests="3" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:08:49" time="0.57">
-    <testcase classname="test.#unit Perform backup using shallow backup" name="should perform a shallow backup" time="0.026">
-    </testcase>
-    <testcase classname="test.#unit Perform backup using shallow backup" name="should perform a shallow backup with transient error" time="0.528">
-    </testcase>
-    <testcase classname="test.#unit Perform backup using shallow backup" name="should fail to perform a shallow backup on fatal error" time="0.015">
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Check spool changes" tests="4" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:08:49" time="15.814">
-    <testcase classname="test.#unit Check spool changes" name="should terminate on request error" time="2.014">
-    </testcase>
-    <testcase classname="test.#unit Check spool changes" name="should terminate on bad HTTP status code response" time="2.011">
-    </testcase>
-    <testcase classname="test.#unit Check spool changes" name="should keep collecting changes" time="2.34">
-    </testcase>
-    <testcase classname="test.#unit Check spool changes" name="should keep collecting sparse changes" time="9.445">
-    </testcase>
-  </testsuite>
-  <testsuite name="Longer spool changes checks" tests="1" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:09:05" time="48.961">
-    <testcase classname="test.Longer spool changes checks" name="#slow should keep collecting changes (25M)" time="48.69">
-    </testcase>
-  </testsuite>
-  <testsuite name="#unit Check database restore writer" tests="6" errors="0" failures="0" skipped="0" timestamp="2023-09-28T17:09:54" time="4.099">
-    <testcase classname="test.#unit Check database restore writer" name="should complete successfully" time="0.024">
-    </testcase>
-    <testcase classname="test.#unit Check database restore writer" name="should terminate on a fatal error" time="0.007">
-    </testcase>
-    <testcase classname="test.#unit Check database restore writer" name="should retry on transient errors" time="2.017">
-    </testcase>
-    <testcase classname="test.#unit Check database restore writer" name="should fail after 3 transient errors" time="2.017">
-    </testcase>
-    <testcase classname="test.#unit Check database restore writer" name="should restore shallow backups without rev info successfully" time="0.022">
-    </testcase>
-    <testcase classname="test.#unit Check database restore writer" name="should get a batch error for non-empty array response with new_edits false" time="0.008">
-    </testcase>
-  </testsuite>
-</testsuites>
+// 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.
+// 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.
+'use strict';
+
+const async = require('async');
+const events = require('events');
+const fs = require('fs');
+const error = require('./error.js');
+const spoolchanges = require('./spoolchanges.js');
+const logfilesummary = require('./logfilesummary.js');
+const logfilegetbatches = require('./logfilegetbatches.js');
+
+/**
+ * Read documents from a database to be backed up.
+ *
+ * @param {string} db - `@cloudant/cloudant` DB object for source database.
+ * @param {number} blocksize - number of documents to download in single request
+ * @param {number} parallelism - number of concurrent downloads
+ * @param {string} log - path to log file to use
+ * @param {boolean} resume - whether to resume from an existing log file
+ * @returns EventEmitter with following events:
+ *  - `received` - called with a block of documents to write to backup
+ *  - `error` - on error
+ *  - `finished` - when backup process is finished (either complete or errored)
+ */
+module.exports = function(db, options) {
+  const ee = new events.EventEmitter();
+  const start = new Date().getTime(); // backup start time
+  const batchesPerDownloadSession = 50; // max batches to read from log file for download at a time (prevent OOM)
+
+  function proceedWithBackup() {
+    if (options.resume) {
+      // pick up from existing log file from previous run
+      downloadRemainingBatches(options.log, db, ee, start, batchesPerDownloadSession, options.parallelism);
+    } else {
+      // create new log file and process
+      spoolchanges(db, options.log, options.bufferSize, ee, function(err) {
+        if (err) {
+          ee.emit('error', err);
+        } else {
+          downloadRemainingBatches(options.log, db, ee, start, batchesPerDownloadSession, options.parallelism);
+        }
+      });
+    }
+  }
+
+  validateBulkGetSupport(db, function(err) {
+    if (err) {
+      return ee.emit('error', err);
+    } else {
+      proceedWithBackup();
+    }
+  });
+
+  return ee;
+};
+
+/**
+ * Validate /_bulk_get support for a specified database.
+ *
+ * @param {string} db - nodejs-cloudant db
+ * @param {function} callback - called on completion with signature (err)
+ */
+function validateBulkGetSupport(db, callback) {
+  db.service.postBulkGet({ db: db.db, docs: [] }).then(() => { callback(); }).catch(err => {
+    err = error.convertResponseError(err, function(err) {
+      switch (err.status) {
+        case undefined:
+          // There was no status code on the error
+          return err;
+        case 404:
+          return new error.BackupError('BulkGetError', 'Database does not support /_bulk_get endpoint');
+        default:
+          return new error.HTTPError(err);
+      }
+    });
+    callback(err);
+  });
+}
+
+/**
+ * Download remaining batches in a log file, splitting batches into sets
+ * to avoid enqueueing too many in one go.
+ *
+ * @param {string} log - log file name to maintain download state
+ * @param {string} db - nodejs-cloudant db
+ * @param {events.EventEmitter} ee - event emitter to emit received events on
+ * @param {time} startTime - start time for backup process
+ * @param {number} batchesPerDownloadSession - max batches to enqueue for
+ *  download at a time. As batches contain many doc IDs, this helps avoid
+ *  exhausting memory.
+ * @param {number} parallelism - number of concurrent downloads
+ * @returns function to call do download remaining batches with signature
+ *  (err, {batches: batch, docs: doccount}) {@see spoolchanges}.
+ */
+function downloadRemainingBatches(log, db, ee, startTime, batchesPerDownloadSession, parallelism) {
+  let total = 0; // running total of documents downloaded so far
+  let noRemainingBatches = false;
+
+  // Generate a set of batches (up to batchesPerDownloadSession) to download from the
+  // log file and download them. Set noRemainingBatches to `true` for last batch.
+  function downloadSingleBatchSet(done) {
+    // Fetch the doc IDs for the batches in the current set to
+    // download them.
+    function batchSetComplete(err, data) {
+      if (!err) {
+        total = data.total;
+      }
+      done(err);
+    }
+    function processRetrievedBatches(err, batches) {
+      if (!err) {
+        // process them in parallelised queue
+        processBatchSet(db, parallelism, log, batches, ee, startTime, total, batchSetComplete);
+      } else {
+        batchSetComplete(err);
+      }
+    }
+
+    readBatchSetIdsFromLogFile(log, batchesPerDownloadSession, function(err, batchSetIds) {
+      if (err) {
+        ee.emit('error', err);
+        // Stop processing changes file for fatal errors
+        noRemainingBatches = true;
+        done();
+      } else {
+        if (batchSetIds.length === 0) {
+          noRemainingBatches = true;
+          return done();
+        }
+        logfilegetbatches(log, batchSetIds, processRetrievedBatches);
+      }
+    });
+  }
+
+  // Return true if all batches in log file have been downloaded
+  function isFinished(callback) { callback(null, noRemainingBatches); }
+
+  function onComplete() {
+    ee.emit('finished', { total: total });
+  }
+
+  async.doUntil(downloadSingleBatchSet, isFinished, onComplete);
+}
+
+/**
+ * Return a set of uncompleted download batch IDs from the log file.
+ *
+ * @param {string} log - log file path
+ * @param {number} batchesPerDownloadSession - maximum IDs to return
+ * @param {function} callback - sign (err, batchSetIds array)
+ */
+function readBatchSetIdsFromLogFile(log, batchesPerDownloadSession, callback) {
+  logfilesummary(log, function processSummary(err, summary) {
+    if (!err) {
+      if (!summary.changesComplete) {
+        callback(new error.BackupError('IncompleteChangesInLogFile',
+          'WARNING: Changes did not finish spooling'));
+        return;
+      }
+      if (Object.keys(summary.batches).length === 0) {
+        return callback(null, []);
+      }
+
+      // batch IDs are the property names of summary.batches
+      const batchSetIds = getPropertyNames(summary.batches, batchesPerDownloadSession);
+      callback(null, batchSetIds);
+    } else {
+      callback(err);
+    }
+  });
+}
+
+/**
+ * Download a set of batches retrieved from a log file. When a download is
+ * complete, add a line to the logfile indicating such.
+ *
+ * @param {any} db - nodejs-cloudant database
+ * @param {any} parallelism - number of concurrent requests to make
+ * @param {any} log - log file to drive downloads from
+ * @param {any} batches - batches to download
+ * @param {any} ee - event emitter for progress. This funciton emits
+ *  received and error events.
+ * @param {any} start - time backup started, to report deltas
+ * @param {any} grandtotal - count of documents downloaded prior to this set
+ *  of batches
+ * @param {any} callback - completion callback, (err, {total: number}).
+ */
+function processBatchSet(db, parallelism, log, batches, ee, start, grandtotal, callback) {
+  let hasErrored = false;
+  let total = grandtotal;
+
+  // queue to process the fetch requests in an orderly fashion using _bulk_get
+  const q = async.queue(function(payload, done) {
+    const output = [];
+    const thisBatch = payload.batch;
+    delete payload.batch;
+    delete payload.command;
+
+    function logCompletedBatch(batch) {
+      if (log) {
+        fs.appendFile(log, ':d batch' + thisBatch + '\n', done);
+      } else {
+        done();
+      }
+    }
+
+    // do the /db/_bulk_get request
+    db.service.postBulkGet({
+      db: db.db,
+      revs: true,
+      docs: payload.docs
+    }).then(response => {
+      // create an output array with the docs returned
+      response.result.results.forEach(function(d) {
+        if (d.docs) {
+          d.docs.forEach(function(doc) {
+            if (doc.ok) {
+              output.push(doc.ok);
+            }
+          });
+        }
+      });
+      total += output.length;
+      const t = (new Date().getTime() - start) / 1000;
+      ee.emit('received', {
+        batch: thisBatch,
+        data: output,
+        length: output.length,
+        time: t,
+        total: total
+      }, q, logCompletedBatch);
+    }).catch(err => {
+      if (!hasErrored) {
+        hasErrored = true;
+        err = error.convertResponseError(err);
+        // Kill the queue for fatal errors
+        q.kill();
+        ee.emit('error', err);
+      }
+      done();
+    });
+  }, parallelism);
+
+  for (const i in batches) {
+    q.push(batches[i]);
+  }
+
+  q.drain(function() {
+    callback(null, { total: total });
+  });
+}
+
+/**
+ * Returns first N properties on an object.
+ *
+ * @param {object} obj - object with properties
+ * @param {number} count - number of properties to return
+ */
+function getPropertyNames(obj, count) {
+  // decide which batch numbers to deal with
+  const batchestofetch = [];
+  let j = 0;
+  for (const i in obj) {
+    batchestofetch.push(parseInt(i));
+    j++;
+    if (j >= count) break;
+  }
+  return batchestofetch;
+}