summaryrefslogtreecommitdiffstats
path: root/toolkit/components/osfile/tests/xpcshell/test_osfile_async_copy.js
blob: 0c82e542f6643a41005aa26b7a8b4b56d6059df5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
"use strict";

const { OS } = ChromeUtils.import("resource://gre/modules/osfile.jsm");
const { FileUtils } = ChromeUtils.importESModule(
  "resource://gre/modules/FileUtils.sys.mjs"
);
const { NetUtil } = ChromeUtils.import("resource://gre/modules/NetUtil.jsm");

function run_test() {
  do_test_pending();
  run_next_test();
}

/**
 * A file that we know exists and that can be used for reading.
 */
var EXISTING_FILE = "test_osfile_async_copy.js";

/**
 * Fetch asynchronously the contents of a file using xpcom.
 *
 * Used for comparing xpcom-based results to os.file-based results.
 *
 * @param {string} path The _absolute_ path to the file.
 * @return {promise}
 * @resolves {string} The contents of the file.
 */
var reference_fetch_file = function reference_fetch_file(path) {
  return new Promise((resolve, reject) => {
    let file = new FileUtils.File(path);
    NetUtil.asyncFetch(
      {
        uri: NetUtil.newURI(file),
        loadUsingSystemPrincipal: true,
      },
      function(stream, status) {
        if (!Components.isSuccessCode(status)) {
          reject(status);
          return;
        }
        let result, reject;
        try {
          result = NetUtil.readInputStreamToString(stream, stream.available());
        } catch (x) {
          reject = x;
        }
        stream.close();
        if (reject) {
          reject(reject);
        } else {
          resolve(result);
        }
      }
    );
  });
};

/**
 * Compare asynchronously the contents two files using xpcom.
 *
 * Used for comparing xpcom-based results to os.file-based results.
 *
 * @param {string} a The _absolute_ path to the first file.
 * @param {string} b The _absolute_ path to the second file.
 *
 * @resolves {null}
 */
var reference_compare_files = async function reference_compare_files(a, b) {
  let a_contents = await reference_fetch_file(a);
  let b_contents = await reference_fetch_file(b);
  // Not using do_check_eq to avoid dumping the whole file to the log.
  // It is OK to === compare here, as both variables contain a string.
  Assert.ok(a_contents === b_contents);
};

/**
 * Test to ensure that OS.File.copy works.
 */
async function test_copymove(options = {}) {
  let source = OS.Path.join(await OS.File.getCurrentDirectory(), EXISTING_FILE);
  let dest = OS.Path.join(
    OS.Constants.Path.tmpDir,
    "test_osfile_async_copy_dest.tmp"
  );
  let dest2 = OS.Path.join(
    OS.Constants.Path.tmpDir,
    "test_osfile_async_copy_dest2.tmp"
  );
  try {
    // 1. Test copy.
    await OS.File.copy(source, dest, options);
    await reference_compare_files(source, dest);
    // 2. Test subsequent move.
    await OS.File.move(dest, dest2);
    await reference_compare_files(source, dest2);
    // 3. Check that the moved file was really moved.
    Assert.equal(await OS.File.exists(dest), false);
  } finally {
    await removeTestFile(dest);
    await removeTestFile(dest2);
  }
}

// Regular copy test.
add_task(test_copymove);
// Userland copy test.
add_task(test_copymove.bind(null, { unixUserland: true }));

add_task(do_test_finished);