deno.land / std@0.167.0 / archive / tar_test.ts
نووسراو ببینە
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license./** * Tar test * * **test summary** * - create a tar archive in memory containing output.txt and dir/tar.ts. * - read and deflate a tar archive containing output.txt * * **to run this test** * deno run --allow-read archive/tar_test.ts */import { assert, assertEquals, assertExists } from "../testing/asserts.ts";
import { dirname, fromFileUrl, resolve } from "../path/mod.ts";import { Tar, TarEntry, Untar } from "./tar.ts";import type { TarEntry as TarEntryType, TarHeader, TarMeta } from "./tar.ts";import { Buffer } from "../io/buffer.ts";import { copy } from "../streams/copy.ts";import { readAll } from "../streams/read_all.ts";
const moduleDir = dirname(fromFileUrl(import.meta.url));const testdataDir = resolve(moduleDir, "testdata");const filePath = resolve(testdataDir, "example.txt");
interface TestEntry { name: string; content?: Uint8Array; filePath?: string;}
async function createTar(entries: TestEntry[]): Promise<Tar> { const tar = new Tar(); // put data on memory for (const file of entries) { let options;
if (file.content) { options = { reader: new Buffer(file.content), contentSize: file.content.byteLength, }; } else { options = { filePath: file.filePath }; }
await tar.append(file.name, options); }
return tar;}
Deno.test("createTarArchive", async function () { // initialize const tar = new Tar();
// put data on memory const content = new TextEncoder().encode("hello tar world!"); await tar.append("output.txt", { reader: new Buffer(content), contentSize: content.byteLength, });
// put a file await tar.append("dir/tar.ts", { filePath });
// write tar data to a buffer const writer = new Buffer(); const wrote = await copy(tar.getReader(), writer);
/** * 3072 = 512 (header) + 512 (content) + 512 (header) + 512 (content) * + 1024 (footer) */ assertEquals(wrote, 3072);});
Deno.test("deflateTarArchive", async function () { const fileName = "output.txt"; const text = "hello tar world!";
// create a tar archive const tar = new Tar(); const content = new TextEncoder().encode(text); await tar.append(fileName, { reader: new Buffer(content), contentSize: content.byteLength, });
// read data from a tar archive const untar = new Untar(tar.getReader()); const result = await untar.extract(); assert(result !== null); const untarText = new TextDecoder("utf-8").decode(await readAll(result));
assertEquals(await untar.extract(), null); // EOF // tests assertEquals(result.fileName, fileName); assertEquals(untarText, text);});
Deno.test("appendFileWithLongNameToTarArchive", async function (): Promise< void> { // 9 * 15 + 13 = 148 bytes const fileName = "long-file-name/".repeat(10) + "file-name.txt"; const text = "hello tar world!";
// create a tar archive const tar = new Tar(); const content = new TextEncoder().encode(text); await tar.append(fileName, { reader: new Buffer(content), contentSize: content.byteLength, });
// read data from a tar archive const untar = new Untar(tar.getReader()); const result = await untar.extract(); assert(result !== null); assert(!result.consumed); const untarText = new TextDecoder("utf-8").decode(await readAll(result)); assert(result.consumed);
// tests assertEquals(result.fileName, fileName); assertEquals(untarText, text);});
Deno.test("untarAsyncIterator", async function () { const entries: TestEntry[] = [ { name: "output.txt", content: new TextEncoder().encode("hello tar world!"), }, { name: "dir/tar.ts", filePath, }, ];
const tar = await createTar(entries);
// read data from a tar archive const untar = new Untar(tar.getReader());
let lastEntry; for await (const entry of untar) { const expected = entries.shift(); assert(expected);
let content = expected.content; if (expected.filePath) { content = await Deno.readFile(expected.filePath); } assertEquals(content, await readAll(entry)); assertEquals(expected.name, entry.fileName);
if (lastEntry) assert(lastEntry.consumed); lastEntry = entry; } assert(lastEntry); assert(lastEntry.consumed); assertEquals(entries.length, 0);});
Deno.test("untarAsyncIteratorWithoutReadingBody", async function (): Promise< void> { const entries: TestEntry[] = [ { name: "output.txt", content: new TextEncoder().encode("hello tar world!"), }, { name: "dir/tar.ts", filePath, }, ];
const tar = await createTar(entries);
// read data from a tar archive const untar = new Untar(tar.getReader());
for await (const entry of untar) { const expected = entries.shift(); assert(expected); assertEquals(expected.name, entry.fileName); }
assertEquals(entries.length, 0);});
Deno.test( "untarAsyncIteratorWithoutReadingBodyFromFileReader", async function () { const entries: TestEntry[] = [ { name: "output.txt", content: new TextEncoder().encode("hello tar world!"), }, { name: "dir/tar.ts", filePath, }, ];
const outputFile = resolve(testdataDir, "test.tar");
const tar = await createTar(entries); const file = await Deno.open(outputFile, { create: true, write: true }); await copy(tar.getReader(), file); file.close();
const reader = await Deno.open(outputFile, { read: true }); // read data from a tar archive const untar = new Untar(reader);
for await (const entry of untar) { const expected = entries.shift(); assert(expected); assertEquals(expected.name, entry.fileName); }
reader.close(); await Deno.remove(outputFile); assertEquals(entries.length, 0); },);
Deno.test("untarAsyncIteratorFromFileReader", async function () { const entries: TestEntry[] = [ { name: "output.txt", content: new TextEncoder().encode("hello tar world!"), }, { name: "dir/tar.ts", filePath, }, ];
const outputFile = resolve(testdataDir, "test.tar");
const tar = await createTar(entries); const file = await Deno.open(outputFile, { create: true, write: true }); await copy(tar.getReader(), file); file.close();
const reader = await Deno.open(outputFile, { read: true }); // read data from a tar archive const untar = new Untar(reader);
for await (const entry of untar) { const expected = entries.shift(); assert(expected);
let content = expected.content; if (expected.filePath) { content = await Deno.readFile(expected.filePath); }
assertEquals(content, await readAll(entry)); assertEquals(expected.name, entry.fileName); }
reader.close(); await Deno.remove(outputFile); assertEquals(entries.length, 0);});
Deno.test( "untarAsyncIteratorReadingLessThanRecordSize", async function () { // record size is 512 const bufSizes = [1, 53, 256, 511];
for (const bufSize of bufSizes) { const entries: TestEntry[] = [ { name: "output.txt", content: new TextEncoder().encode("hello tar world!".repeat(100)), }, // Need to test at least two files, to make sure the first entry doesn't over-read // Causing the next to fail with: checksum error { name: "deni.txt", content: new TextEncoder().encode("deno!".repeat(250)), }, ];
const tar = await createTar(entries);
// read data from a tar archive const untar = new Untar(tar.getReader());
for await (const entry of untar) { const expected = entries.shift(); assert(expected); assertEquals(expected.name, entry.fileName);
const writer = new Buffer(); while (true) { const buf = new Uint8Array(bufSize); const n = await entry.read(buf); if (n === null) break;
await writer.write(buf.subarray(0, n)); } assertEquals(writer.bytes(), expected!.content); }
assertEquals(entries.length, 0); } },);
Deno.test("untarLinuxGeneratedTar", async function () { const filePath = resolve(testdataDir, "deno.tar"); const file = await Deno.open(filePath, { read: true });
type ExpectedEntry = TarMeta & { content?: Uint8Array };
const expectedEntries: ExpectedEntry[] = [ { fileName: "archive/", fileSize: 0, fileMode: 509, mtime: 1591800767, uid: 1001, gid: 1001, owner: "deno", group: "deno", type: "directory", }, { fileName: "archive/deno/", fileSize: 0, fileMode: 509, mtime: 1591799635, uid: 1001, gid: 1001, owner: "deno", group: "deno", type: "directory", }, { fileName: "archive/deno/land/", fileSize: 0, fileMode: 509, mtime: 1591799660, uid: 1001, gid: 1001, owner: "deno", group: "deno", type: "directory", }, { fileName: "archive/deno/land/land.txt", fileMode: 436, fileSize: 5, mtime: 1591799660, uid: 1001, gid: 1001, owner: "deno", group: "deno", type: "file", content: new TextEncoder().encode("land\n"), }, { fileName: "archive/file.txt", fileMode: 436, fileSize: 5, mtime: 1591799626, uid: 1001, gid: 1001, owner: "deno", group: "deno", type: "file", content: new TextEncoder().encode("file\n"), }, { fileName: "archive/deno.txt", fileMode: 436, fileSize: 5, mtime: 1591799642, uid: 1001, gid: 1001, owner: "deno", group: "deno", type: "file", content: new TextEncoder().encode("deno\n"), }, ];
const untar = new Untar(file);
for await (const entry of untar) { const expected = expectedEntries.shift(); assert(expected); const content = expected.content; delete expected.content;
assertEquals({ ...entry }, expected);
if (content) { assertEquals(content, await readAll(entry)); } }
file.close();});
Deno.test("directoryEntryType", async function () { const tar = new Tar();
tar.append("directory/", { reader: new Buffer(), contentSize: 0, type: "directory", });
const filePath = resolve(testdataDir); tar.append("archive/testdata/", { filePath, });
const outputFile = resolve(testdataDir, "directory_type_test.tar"); const file = await Deno.open(outputFile, { create: true, write: true }); await copy(tar.getReader(), file); file.close();
const reader = await Deno.open(outputFile, { read: true }); const untar = new Untar(reader); for await (const entry of untar) { assertEquals(entry.type, "directory"); }
reader.close(); await Deno.remove(outputFile);});
Deno.test({ name: "test TarEntry", // only: true, fn() { // test TarEntry class assertExists(TarEntry); // Test TarEntry type const bufSizes = [1, 53, 256, 511]; const header: TarHeader = { test: new Uint8Array(bufSizes), }; const content = new TextEncoder().encode("hello tar world!"); const reader = new Buffer(content); const tarMeta = { fileName: "archive/", fileSize: 0, fileMode: 509, mtime: 1591800767, uid: 1001, gid: 1001, owner: "deno", group: "deno", type: "directory", }; const tarEntry: TarEntryType = new TarEntry(tarMeta, header, reader); assertExists(tarEntry); },});
std
Version Info
a year ago
