// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license. // deno-lint-ignore-file no-deprecated-deno-api import { assert, assertEquals, assertRejects, assertThrows, } from "./test_util.ts"; import { copy } from "../../../test_util/std/streams/copy.ts"; Deno.test(function filesStdioFileDescriptors() { assertEquals(Deno.stdin.rid, 0); assertEquals(Deno.stdout.rid, 1); assertEquals(Deno.stderr.rid, 2); }); Deno.test({ permissions: { read: true } }, async function filesCopyToStdout() { const filename = "cli/tests/testdata/assets/fixture.json"; const file = await Deno.open(filename); assert(file.rid > 2); const bytesWritten = await copy(file, Deno.stdout); const fileSize = Deno.statSync(filename).size; assertEquals(bytesWritten, fileSize); file.close(); }); Deno.test({ permissions: { read: true } }, async function filesIter() { const filename = "cli/tests/testdata/assets/hello.txt"; const file = await Deno.open(filename); let totalSize = 0; for await (const buf of Deno.iter(file)) { totalSize += buf.byteLength; } assertEquals(totalSize, 12); file.close(); }); Deno.test( { permissions: { read: true } }, async function filesIterCustomBufSize() { const filename = "cli/tests/testdata/assets/hello.txt"; const file = await Deno.open(filename); let totalSize = 0; let iterations = 0; for await (const buf of Deno.iter(file, { bufSize: 6 })) { totalSize += buf.byteLength; iterations += 1; } assertEquals(totalSize, 12); assertEquals(iterations, 2); file.close(); }, ); Deno.test({ permissions: { read: true } }, function filesIterSync() { const filename = "cli/tests/testdata/assets/hello.txt"; const file = Deno.openSync(filename); let totalSize = 0; for (const buf of Deno.iterSync(file)) { totalSize += buf.byteLength; } assertEquals(totalSize, 12); file.close(); }); Deno.test( { permissions: { read: true } }, function filesIterSyncCustomBufSize() { const filename = "cli/tests/testdata/assets/hello.txt"; const file = Deno.openSync(filename); let totalSize = 0; let iterations = 0; for (const buf of Deno.iterSync(file, { bufSize: 6 })) { totalSize += buf.byteLength; iterations += 1; } assertEquals(totalSize, 12); assertEquals(iterations, 2); file.close(); }, ); Deno.test(async function readerIter() { // ref: https://github.com/denoland/deno/issues/2330 const encoder = new TextEncoder(); class TestReader implements Deno.Reader { #offset = 0; #buf: Uint8Array; constructor(s: string) { this.#buf = new Uint8Array(encoder.encode(s)); } read(p: Uint8Array): Promise { const n = Math.min(p.byteLength, this.#buf.byteLength - this.#offset); p.set(this.#buf.slice(this.#offset, this.#offset + n)); this.#offset += n; if (n === 0) { return Promise.resolve(null); } return Promise.resolve(n); } } const reader = new TestReader("hello world!"); let totalSize = 0; for await (const buf of Deno.iter(reader)) { totalSize += buf.byteLength; } assertEquals(totalSize, 12); }); Deno.test(async function readerIterSync() { // ref: https://github.com/denoland/deno/issues/2330 const encoder = new TextEncoder(); class TestReader implements Deno.ReaderSync { #offset = 0; #buf: Uint8Array; constructor(s: string) { this.#buf = new Uint8Array(encoder.encode(s)); } readSync(p: Uint8Array): number | null { const n = Math.min(p.byteLength, this.#buf.byteLength - this.#offset); p.set(this.#buf.slice(this.#offset, this.#offset + n)); this.#offset += n; if (n === 0) { return null; } return n; } } const reader = new TestReader("hello world!"); let totalSize = 0; for await (const buf of Deno.iterSync(reader)) { totalSize += buf.byteLength; } assertEquals(totalSize, 12); }); Deno.test( { permissions: { read: true, write: true }, }, function openSyncMode() { const path = Deno.makeTempDirSync() + "/test_openSync.txt"; const file = Deno.openSync(path, { write: true, createNew: true, mode: 0o626, }); file.close(); const pathInfo = Deno.statSync(path); if (Deno.build.os !== "windows") { assertEquals(pathInfo.mode! & 0o777, 0o626 & ~Deno.umask()); } }, ); Deno.test( { permissions: { read: true, write: true }, }, async function openMode() { const path = (await Deno.makeTempDir()) + "/test_open.txt"; const file = await Deno.open(path, { write: true, createNew: true, mode: 0o626, }); file.close(); const pathInfo = Deno.statSync(path); if (Deno.build.os !== "windows") { assertEquals(pathInfo.mode! & 0o777, 0o626 & ~Deno.umask()); } }, ); Deno.test( { permissions: { read: true, write: true }, }, function openSyncUrl() { const tempDir = Deno.makeTempDirSync(); const fileUrl = new URL( `file://${ Deno.build.os === "windows" ? "/" : "" }${tempDir}/test_open.txt`, ); const file = Deno.openSync(fileUrl, { write: true, createNew: true, mode: 0o626, }); file.close(); const pathInfo = Deno.statSync(fileUrl); if (Deno.build.os !== "windows") { assertEquals(pathInfo.mode! & 0o777, 0o626 & ~Deno.umask()); } Deno.removeSync(tempDir, { recursive: true }); }, ); Deno.test( { permissions: { read: true, write: true }, }, async function openUrl() { const tempDir = await Deno.makeTempDir(); const fileUrl = new URL( `file://${ Deno.build.os === "windows" ? "/" : "" }${tempDir}/test_open.txt`, ); const file = await Deno.open(fileUrl, { write: true, createNew: true, mode: 0o626, }); file.close(); const pathInfo = Deno.statSync(fileUrl); if (Deno.build.os !== "windows") { assertEquals(pathInfo.mode! & 0o777, 0o626 & ~Deno.umask()); } Deno.removeSync(tempDir, { recursive: true }); }, ); Deno.test( { permissions: { write: false } }, async function writePermFailure() { const filename = "tests/hello.txt"; const openOptions: Deno.OpenOptions[] = [{ write: true }, { append: true }]; for (const options of openOptions) { await assertRejects(async () => { await Deno.open(filename, options); }, Deno.errors.PermissionDenied); } }, ); Deno.test(async function openOptions() { const filename = "cli/tests/testdata/assets/fixture.json"; await assertRejects( async () => { await Deno.open(filename, { write: false }); }, Error, "OpenOptions requires at least one option to be true", ); await assertRejects( async () => { await Deno.open(filename, { truncate: true, write: false }); }, Error, "'truncate' option requires 'write' option", ); await assertRejects( async () => { await Deno.open(filename, { create: true, write: false }); }, Error, "'create' or 'createNew' options require 'write' or 'append' option", ); await assertRejects( async () => { await Deno.open(filename, { createNew: true, append: false }); }, Error, "'create' or 'createNew' options require 'write' or 'append' option", ); }); Deno.test({ permissions: { read: false } }, async function readPermFailure() { await assertRejects(async () => { await Deno.open("package.json", { read: true }); }, Deno.errors.PermissionDenied); }); Deno.test( { permissions: { write: true } }, async function writeNullBufferFailure() { const tempDir = Deno.makeTempDirSync(); const filename = tempDir + "hello.txt"; const w = { write: true, truncate: true, create: true, }; const file = await Deno.open(filename, w); // writing null should throw an error await assertRejects( async () => { // deno-lint-ignore no-explicit-any await file.write(null as any); }, ); // TODO(bartlomieju): Check error kind when dispatch_minimal pipes errors properly file.close(); await Deno.remove(tempDir, { recursive: true }); }, ); Deno.test( { permissions: { write: true, read: true } }, async function readNullBufferFailure() { const tempDir = Deno.makeTempDirSync(); const filename = tempDir + "hello.txt"; const file = await Deno.open(filename, { read: true, write: true, truncate: true, create: true, }); // reading into an empty buffer should return 0 immediately const bytesRead = await file.read(new Uint8Array(0)); assert(bytesRead === 0); // reading file into null buffer should throw an error await assertRejects(async () => { // deno-lint-ignore no-explicit-any await file.read(null as any); }, TypeError); // TODO(bartlomieju): Check error kind when dispatch_minimal pipes errors properly file.close(); await Deno.remove(tempDir, { recursive: true }); }, ); Deno.test( { permissions: { write: false, read: false } }, async function readWritePermFailure() { const filename = "tests/hello.txt"; await assertRejects(async () => { await Deno.open(filename, { read: true }); }, Deno.errors.PermissionDenied); }, ); Deno.test( { permissions: { write: true, read: true } }, async function openNotFound() { await assertRejects( async () => { await Deno.open("bad_file_name"); }, Deno.errors.NotFound, `open 'bad_file_name'`, ); }, ); Deno.test( { permissions: { write: true, read: true } }, function openSyncNotFound() { assertThrows( () => { Deno.openSync("bad_file_name"); }, Deno.errors.NotFound, `open 'bad_file_name'`, ); }, ); Deno.test( { permissions: { read: true, write: true } }, async function createFile() { const tempDir = await Deno.makeTempDir(); const filename = tempDir + "/test.txt"; const f = await Deno.create(filename); let fileInfo = Deno.statSync(filename); assert(fileInfo.isFile); assert(fileInfo.size === 0); const enc = new TextEncoder(); const data = enc.encode("Hello"); await f.write(data); fileInfo = Deno.statSync(filename); assert(fileInfo.size === 5); f.close(); // TODO(bartlomieju): test different modes await Deno.remove(tempDir, { recursive: true }); }, ); Deno.test( { permissions: { read: true, write: true } }, async function createFileWithUrl() { const tempDir = await Deno.makeTempDir(); const fileUrl = new URL( `file://${Deno.build.os === "windows" ? "/" : ""}${tempDir}/test.txt`, ); const f = await Deno.create(fileUrl); let fileInfo = Deno.statSync(fileUrl); assert(fileInfo.isFile); assert(fileInfo.size === 0); const enc = new TextEncoder(); const data = enc.encode("Hello"); await f.write(data); fileInfo = Deno.statSync(fileUrl); assert(fileInfo.size === 5); f.close(); await Deno.remove(tempDir, { recursive: true }); }, ); Deno.test( { permissions: { read: true, write: true } }, async function createSyncFile() { const tempDir = await Deno.makeTempDir(); const filename = tempDir + "/test.txt"; const f = Deno.createSync(filename); let fileInfo = Deno.statSync(filename); assert(fileInfo.isFile); assert(fileInfo.size === 0); const enc = new TextEncoder(); const data = enc.encode("Hello"); await f.write(data); fileInfo = Deno.statSync(filename); assert(fileInfo.size === 5); f.close(); // TODO(bartlomieju): test different modes await Deno.remove(tempDir, { recursive: true }); }, ); Deno.test( { permissions: { read: true, write: true } }, async function createSyncFileWithUrl() { const tempDir = await Deno.makeTempDir(); const fileUrl = new URL( `file://${Deno.build.os === "windows" ? "/" : ""}${tempDir}/test.txt`, ); const f = Deno.createSync(fileUrl); let fileInfo = Deno.statSync(fileUrl); assert(fileInfo.isFile); assert(fileInfo.size === 0); const enc = new TextEncoder(); const data = enc.encode("Hello"); await f.write(data); fileInfo = Deno.statSync(fileUrl); assert(fileInfo.size === 5); f.close(); await Deno.remove(tempDir, { recursive: true }); }, ); Deno.test( { permissions: { read: true, write: true } }, async function openModeWrite() { const tempDir = Deno.makeTempDirSync(); const encoder = new TextEncoder(); const filename = tempDir + "hello.txt"; const data = encoder.encode("Hello world!\n"); let file = await Deno.open(filename, { create: true, write: true, truncate: true, }); // assert file was created let fileInfo = Deno.statSync(filename); assert(fileInfo.isFile); assertEquals(fileInfo.size, 0); // write some data await file.write(data); fileInfo = Deno.statSync(filename); assertEquals(fileInfo.size, 13); // assert we can't read from file let thrown = false; try { const buf = new Uint8Array(20); await file.read(buf); } catch (_e) { thrown = true; } finally { assert(thrown, "'w' mode shouldn't allow to read file"); } file.close(); // assert that existing file is truncated on open file = await Deno.open(filename, { write: true, truncate: true, }); file.close(); const fileSize = Deno.statSync(filename).size; assertEquals(fileSize, 0); await Deno.remove(tempDir, { recursive: true }); }, ); Deno.test( { permissions: { read: true, write: true } }, async function openModeWriteRead() { const tempDir = Deno.makeTempDirSync(); const encoder = new TextEncoder(); const filename = tempDir + "hello.txt"; const data = encoder.encode("Hello world!\n"); const file = await Deno.open(filename, { write: true, truncate: true, create: true, read: true, }); const seekPosition = 0; // assert file was created let fileInfo = Deno.statSync(filename); assert(fileInfo.isFile); assertEquals(fileInfo.size, 0); // write some data await file.write(data); fileInfo = Deno.statSync(filename); assertEquals(fileInfo.size, 13); const buf = new Uint8Array(20); // seeking from beginning of a file const cursorPosition = await file.seek(seekPosition, Deno.SeekMode.Start); assertEquals(seekPosition, cursorPosition); const result = await file.read(buf); assertEquals(result, 13); file.close(); await Deno.remove(tempDir, { recursive: true }); }, ); Deno.test({ permissions: { read: true } }, async function seekStart() { const filename = "cli/tests/testdata/assets/hello.txt"; const file = await Deno.open(filename); const seekPosition = 6; // Deliberately move 1 step forward await file.read(new Uint8Array(1)); // "H" // Skipping "Hello " // seeking from beginning of a file plus seekPosition const cursorPosition = await file.seek(seekPosition, Deno.SeekMode.Start); assertEquals(seekPosition, cursorPosition); const buf = new Uint8Array(6); await file.read(buf); const decoded = new TextDecoder().decode(buf); assertEquals(decoded, "world!"); file.close(); }); Deno.test({ permissions: { read: true } }, async function seekStartBigInt() { const filename = "cli/tests/testdata/assets/hello.txt"; const file = await Deno.open(filename); const seekPosition = 6n; // Deliberately move 1 step forward await file.read(new Uint8Array(1)); // "H" // Skipping "Hello " // seeking from beginning of a file plus seekPosition const cursorPosition = await file.seek(seekPosition, Deno.SeekMode.Start); assertEquals(seekPosition, BigInt(cursorPosition)); const buf = new Uint8Array(6); await file.read(buf); const decoded = new TextDecoder().decode(buf); assertEquals(decoded, "world!"); file.close(); }); Deno.test({ permissions: { read: true } }, function seekSyncStart() { const filename = "cli/tests/testdata/assets/hello.txt"; const file = Deno.openSync(filename); const seekPosition = 6; // Deliberately move 1 step forward file.readSync(new Uint8Array(1)); // "H" // Skipping "Hello " // seeking from beginning of a file plus seekPosition const cursorPosition = file.seekSync(seekPosition, Deno.SeekMode.Start); assertEquals(seekPosition, cursorPosition); const buf = new Uint8Array(6); file.readSync(buf); const decoded = new TextDecoder().decode(buf); assertEquals(decoded, "world!"); file.close(); }); Deno.test({ permissions: { read: true } }, async function seekCurrent() { const filename = "cli/tests/testdata/assets/hello.txt"; const file = await Deno.open(filename); // Deliberately move 1 step forward await file.read(new Uint8Array(1)); // "H" // Skipping "ello " const seekPosition = 5; // seekPosition is relative to current cursor position after read const cursorPosition = await file.seek(seekPosition, Deno.SeekMode.Current); assertEquals(seekPosition + 1, cursorPosition); const buf = new Uint8Array(6); await file.read(buf); const decoded = new TextDecoder().decode(buf); assertEquals(decoded, "world!"); file.close(); }); Deno.test({ permissions: { read: true } }, function seekSyncCurrent() { const filename = "cli/tests/testdata/assets/hello.txt"; const file = Deno.openSync(filename); // Deliberately move 1 step forward file.readSync(new Uint8Array(1)); // "H" // Skipping "ello " const seekPosition = 5; // seekPosition is relative to current cursor position after read const cursorPosition = file.seekSync(seekPosition, Deno.SeekMode.Current); assertEquals(seekPosition + 1, cursorPosition); const buf = new Uint8Array(6); file.readSync(buf); const decoded = new TextDecoder().decode(buf); assertEquals(decoded, "world!"); file.close(); }); Deno.test({ permissions: { read: true } }, async function seekEnd() { const filename = "cli/tests/testdata/assets/hello.txt"; const file = await Deno.open(filename); const seekPosition = -6; // seek from end of file that has 12 chars, 12 - 6 = 6 const cursorPosition = await file.seek(seekPosition, Deno.SeekMode.End); assertEquals(6, cursorPosition); const buf = new Uint8Array(6); await file.read(buf); const decoded = new TextDecoder().decode(buf); assertEquals(decoded, "world!"); file.close(); }); Deno.test({ permissions: { read: true } }, function seekSyncEnd() { const filename = "cli/tests/testdata/assets/hello.txt"; const file = Deno.openSync(filename); const seekPosition = -6; // seek from end of file that has 12 chars, 12 - 6 = 6 const cursorPosition = file.seekSync(seekPosition, Deno.SeekMode.End); assertEquals(6, cursorPosition); const buf = new Uint8Array(6); file.readSync(buf); const decoded = new TextDecoder().decode(buf); assertEquals(decoded, "world!"); file.close(); }); Deno.test({ permissions: { read: true } }, async function seekMode() { const filename = "cli/tests/testdata/assets/hello.txt"; const file = await Deno.open(filename); await assertRejects( async () => { await file.seek(1, -1 as unknown as Deno.SeekMode); }, TypeError, "Invalid seek mode", ); // We should still be able to read the file // since it is still open. const buf = new Uint8Array(1); await file.read(buf); // "H" assertEquals(new TextDecoder().decode(buf), "H"); file.close(); }); Deno.test( { permissions: { read: true, write: true } }, function fileTruncateSyncSuccess() { const filename = Deno.makeTempDirSync() + "/test_fileTruncateSync.txt"; const file = Deno.openSync(filename, { create: true, read: true, write: true, }); file.truncateSync(20); assertEquals(Deno.readFileSync(filename).byteLength, 20); file.truncateSync(5); assertEquals(Deno.readFileSync(filename).byteLength, 5); file.truncateSync(-5); assertEquals(Deno.readFileSync(filename).byteLength, 0); file.close(); Deno.removeSync(filename); }, ); Deno.test( { permissions: { read: true, write: true } }, async function fileTruncateSuccess() { const filename = Deno.makeTempDirSync() + "/test_fileTruncate.txt"; const file = await Deno.open(filename, { create: true, read: true, write: true, }); await file.truncate(20); assertEquals((await Deno.readFile(filename)).byteLength, 20); await file.truncate(5); assertEquals((await Deno.readFile(filename)).byteLength, 5); await file.truncate(-5); assertEquals((await Deno.readFile(filename)).byteLength, 0); file.close(); await Deno.remove(filename); }, ); Deno.test({ permissions: { read: true } }, function fileStatSyncSuccess() { const file = Deno.openSync("README.md"); const fileInfo = file.statSync(); assert(fileInfo.isFile); assert(!fileInfo.isSymlink); assert(!fileInfo.isDirectory); assert(fileInfo.size); assert(fileInfo.atime); assert(fileInfo.mtime); // The `birthtime` field is not available on Linux before kernel version 4.11. assert(fileInfo.birthtime || Deno.build.os === "linux"); file.close(); }); Deno.test(async function fileStatSuccess() { const file = await Deno.open("README.md"); const fileInfo = await file.stat(); assert(fileInfo.isFile); assert(!fileInfo.isSymlink); assert(!fileInfo.isDirectory); assert(fileInfo.size); assert(fileInfo.atime); assert(fileInfo.mtime); // The `birthtime` field is not available on Linux before kernel version 4.11. assert(fileInfo.birthtime || Deno.build.os === "linux"); file.close(); }); Deno.test({ permissions: { read: true } }, async function readableStream() { const filename = "cli/tests/testdata/assets/hello.txt"; const file = await Deno.open(filename); assert(file.readable instanceof ReadableStream); const chunks = []; for await (const chunk of file.readable) { chunks.push(chunk); } assertEquals(chunks.length, 1); assertEquals(chunks[0].byteLength, 12); }); Deno.test( { permissions: { read: true } }, async function readableStreamTextEncoderPipe() { const filename = "cli/tests/testdata/assets/hello.txt"; const file = await Deno.open(filename); const readable = file.readable.pipeThrough(new TextDecoderStream()); const chunks = []; for await (const chunk of readable) { chunks.push(chunk); } assertEquals(chunks.length, 1); assertEquals(chunks[0].length, 12); }, ); Deno.test( { permissions: { read: true, write: true } }, async function writableStream() { const path = await Deno.makeTempFile(); const file = await Deno.open(path, { write: true }); assert(file.writable instanceof WritableStream); const readable = new ReadableStream({ start(controller) { controller.enqueue(new TextEncoder().encode("hello ")); controller.enqueue(new TextEncoder().encode("world!")); controller.close(); }, }); await readable.pipeTo(file.writable); const res = await Deno.readTextFile(path); assertEquals(res, "hello world!"); }, ); Deno.test( { permissions: { read: true, write: true } }, async function readTextFileNonUtf8() { const path = await Deno.makeTempFile(); const file = await Deno.open(path, { write: true }); await file.write(new TextEncoder().encode("hello ")); await file.write(new Uint8Array([0xC0])); file.close(); const res = await Deno.readTextFile(path); const resSync = Deno.readTextFileSync(path); assertEquals(res, resSync); assertEquals(res, "hello \uFFFD"); }, ); Deno.test( { permissions: { read: true } }, async function fsFileExplicitResourceManagement() { let file2: Deno.FsFile; { using file = await Deno.open("cli/tests/testdata/assets/hello.txt"); file2 = file; const stat = file.statSync(); assert(stat.isFile); } assertThrows(() => file2.statSync(), Deno.errors.BadResource); }, ); Deno.test( { permissions: { read: true } }, async function fsFileExplicitResourceManagementManualClose() { using file = await Deno.open("cli/tests/testdata/assets/hello.txt"); file.close(); assertThrows(() => file.statSync(), Deno.errors.BadResource); // definitely closed // calling [Symbol.dispose] after manual close is a no-op }, );