michael@0: /* Any copyright is dedicated to the Public Domain.
michael@0:  * http://creativecommons.org/publicdomain/zero/1.0/ */
michael@0: 
michael@0: "use strict";
michael@0: 
michael@0: let {utils: Cu} = Components;
michael@0: 
michael@0: let SHARED_PATH;
michael@0: 
michael@0: let EXISTING_FILE = do_get_file("xpcshell.ini").path;
michael@0: 
michael@0: add_task(function* init() {
michael@0:   do_get_profile();
michael@0:   SHARED_PATH = OS.Path.join(OS.Constants.Path.profileDir, "test_osfile_read.tmp");
michael@0: });
michael@0: 
michael@0: 
michael@0: // Check that OS.File.read() is executed after the previous operation
michael@0: add_test_pair(function* ordering() {
michael@0:   let string1 = "Initial state " + Math.random();
michael@0:   let string2 = "After writing " + Math.random();
michael@0:   yield OS.File.writeAtomic(SHARED_PATH, string1);
michael@0:   OS.File.writeAtomic(SHARED_PATH, string2);
michael@0:   let string3 = yield OS.File.read(SHARED_PATH, { encoding: "utf-8" });
michael@0:   do_check_eq(string3, string2);
michael@0: });
michael@0: 
michael@0: add_test_pair(function* read_write_all() {
michael@0:   let DEST_PATH = SHARED_PATH + Math.random();
michael@0:   let TMP_PATH = DEST_PATH + ".tmp";
michael@0: 
michael@0:   let test_with_options = function(options, suffix) {
michael@0:     return Task.spawn(function*() {
michael@0:       do_print("Running test read_write_all with options " + JSON.stringify(options));
michael@0:       let TEST = "read_write_all " + suffix;
michael@0: 
michael@0:       let optionsBackup = JSON.parse(JSON.stringify(options));
michael@0: 
michael@0:       // Check that read + writeAtomic performs a correct copy
michael@0:       let currentDir = yield OS.File.getCurrentDirectory();
michael@0:       let pathSource = OS.Path.join(currentDir, EXISTING_FILE);
michael@0:       let contents = yield OS.File.read(pathSource);
michael@0:       do_check_true(!!contents); // Content is not empty
michael@0: 
michael@0:       let bytesWritten = yield OS.File.writeAtomic(DEST_PATH, contents, options);
michael@0:       do_check_eq(contents.byteLength, bytesWritten); // Correct number of bytes written
michael@0: 
michael@0:       // Check that options are not altered
michael@0:       do_check_eq(JSON.stringify(options), JSON.stringify(optionsBackup));
michael@0:       yield reference_compare_files(pathSource, DEST_PATH, TEST);
michael@0: 
michael@0:       // Check that temporary file was removed or never created exist
michael@0:       do_check_false(new FileUtils.File(TMP_PATH).exists());
michael@0: 
michael@0:       // Check that writeAtomic fails if noOverwrite is true and the destination
michael@0:       // file already exists!
michael@0:       let view = new Uint8Array(contents.buffer, 10, 200);
michael@0:       try {
michael@0:         let opt = JSON.parse(JSON.stringify(options));
michael@0:         opt.noOverwrite = true;
michael@0:         yield OS.File.writeAtomic(DEST_PATH, view, opt);
michael@0:         do_throw("With noOverwrite, writeAtomic should have refused to overwrite file (" + suffix + ")");
michael@0:       } catch (err if err instanceof OS.File.Error && err.becauseExists) {
michael@0:         do_print("With noOverwrite, writeAtomic correctly failed (" + suffix + ")");
michael@0:       }
michael@0:       yield reference_compare_files(pathSource, DEST_PATH, TEST);
michael@0: 
michael@0:       // Check that temporary file was removed or never created
michael@0:       do_check_false(new FileUtils.File(TMP_PATH).exists());
michael@0: 
michael@0:       // Now write a subset
michael@0:       let START = 10;
michael@0:       let LENGTH = 100;
michael@0:       view = new Uint8Array(contents.buffer, START, LENGTH);
michael@0:       bytesWritten = yield OS.File.writeAtomic(DEST_PATH, view, options);
michael@0:       do_check_eq(bytesWritten, LENGTH);
michael@0: 
michael@0:       let array2 = yield OS.File.read(DEST_PATH);
michael@0:       let view1 = new Uint8Array(contents.buffer, START, LENGTH);
michael@0:       do_check_eq(view1.length, array2.length);
michael@0:       let decoder = new TextDecoder();
michael@0:       do_check_eq(decoder.decode(view1), decoder.decode(array2));
michael@0: 
michael@0: 
michael@0:       // Cleanup.
michael@0:       yield OS.File.remove(DEST_PATH);
michael@0:       yield OS.File.remove(TMP_PATH);
michael@0:     });
michael@0:   };
michael@0: 
michael@0:   yield test_with_options({tmpPath: TMP_PATH}, "Renaming, not flushing");
michael@0:   yield test_with_options({tmpPath: TMP_PATH, flush: true}, "Renaming, flushing");
michael@0:   yield test_with_options({}, "Not renaming, not flushing");
michael@0:   yield test_with_options({flush: true}, "Not renaming, flushing");
michael@0: });
michael@0: 
michael@0: 
michael@0: function run_test() {
michael@0:   run_next_test();
michael@0: }