@ -1,10 +1,11 @@
import { promises as fs } from 'fs' ; import fsExtra from 'fs-extra ' ;
import { join } from 'path' ; import { join } from 'path' ;
import archiver from 'archiver' ; import archiver from 'archiver' ;
import { tmpdir } from 'o s' ; import { PassThrough } from 'stream ' ;
import { unzip , zip } from './zip' ; import { unzip , zip } from './zip' ;
jest . mock ( 'fs-extra' , ( ) = > jest . requireActual ( 'fs-extra' ) ) ; const fsMock = fsExtra as jest . Mocked < typeof fsExtra > ;
const archiverMock = archiver as jest . Mocked < any > ;
describe ( 'unzip' , ( ) = > { describe ( 'unzip' , ( ) = > {
it ( "fail to unzip something that isn't a zip" , async ( ) = > { it ( "fail to unzip something that isn't a zip" , async ( ) = > {
@ -13,105 +14,94 @@ describe('unzip', () => {
) . rejects . toThrow ( ) ; ) . rejects . toThrow ( ) ;
} ) ; } ) ;
it ( 'unzips test.zip' , async ( ) = > {
const destination = join ( tmpdir ( ) , 'zip-test-' + Date . now ( ) ) ;
await unzip ( join ( __dirname , 'tests' , 'resources' , 'test.zip' ) , destination ) ;
const entries = await fs . readdir ( destination , { withFileTypes : true } ) ;
expect ( entries . map ( e = > e . name ) ) . toContain ( 'foo.json' ) ;
expect ( entries . map ( e = > e . name ) ) . toContain ( 'bar.txt' ) ;
expect ( entries . map ( e = > e . name ) ) . toContain ( 'baz' ) ;
const fooFile = entries . find ( e = > e . name === 'foo.json' ) ;
const barFile = entries . find ( e = > e . name === 'bar.txt' ) ;
const bazDir = entries . find ( e = > e . name === 'baz' ) ;
expect ( fooFile ) . toBeDefined ( ) ;
expect ( barFile ) . toBeDefined ( ) ;
expect ( bazDir ) . toBeDefined ( ) ;
expect ( fooFile ? . isFile ( ) ) . toBeTruthy ( ) ;
expect ( barFile ? . isFile ( ) ) . toBeTruthy ( ) ;
expect ( bazDir ? . isDirectory ( ) ) . toBeTruthy ( ) ;
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const bazEntries = await fs . readdir ( join ( destination , bazDir ! . name ) , {
withFileTypes : true ,
} ) ;
expect ( bazEntries ) . toHaveLength ( 1 ) ;
expect ( bazEntries . map ( e = > e . name ) ) . toContain ( 'qux.ts' ) ;
const qux = await fs . readFile ( join ( destination , 'baz' , 'qux.ts' ) ) ;
expect ( qux . toString ( 'utf-8' ) ) . toBe ( 'console.log("qux");\n' ) ;
const bar = await fs . readFile ( join ( destination , 'bar.txt' ) ) ;
expect ( bar . toString ( 'utf-8' ) ) . toBe ( 'bar\n' ) ;
const foo = await fs . readFile ( join ( destination , 'foo.json' ) ) ;
expect ( foo . toString ( 'utf-8' ) ) . toBe ( JSON . stringify ( { foo : 2 } , null , 4 ) + '\n' ) ;
} ) ;
it ( "fails to unzip something that doesn't exist" , async ( ) = > { it ( "fails to unzip something that doesn't exist" , async ( ) = > {
return expect ( unzip ( 'foobar' , 'bazfoo' ) ) . rejects . toThrow ( ) ; return expect ( unzip ( 'foobar' , 'bazfoo' ) ) . rejects . toThrow ( ) ;
} ) ; } ) ;
} ) ; } ) ;
describe ( 'zip' , ( ) = > { describe ( 'zip' , ( ) = > {
it ( 'zips objects' , async ( ) = > { // it('zips objects', async () => {
const objects : Array < { name : string ; object : any } > = [ // const objects: Array<{ name: string; object: any }> = [
{ // {
name : 'firstObject' , // name: 'firstObject',
object : 2 , // object: 2,
} , // },
{ // {
name : 'secondObject' , // name: 'secondObject',
object : { baz : 'baz' } , // object: { baz: 'baz' },
} , // },
{ // {
name : 'thirdObject' , // name: 'thirdObject',
object : [ 2 , { foo : 'foo' } , false ] , // object: [2, { foo: 'foo' }, false],
} , // },
] ; // ];
const zipped = join ( tmpdir ( ) , ` zip-test- ${ Date . now ( ) } .zip ` ) ; // const zipped = join(tmpdir(), `zip-test-${Date.now()}.zip`);
await zip ( { // await zip({
destination : zipped , // destination: zipped,
objects , // objects,
paths : [ ] , // paths: [],
} ) ; // });
const unzipped = join ( tmpdir ( ) , ` zip-test- ${ Date . now ( ) } ` ) ; // const unzipped = join(tmpdir(), `zip-test-${Date.now()}`);
await unzip ( zipped , unzipped ) ; // await unzip(zipped, unzipped);
for ( const obj of objects ) { // for (const obj of objects) {
const read = await fs // const read = await fsExtra
. readFile ( join ( unzipped , obj . name ) ) // .readFile(join(unzipped, obj.name))
. then ( read = > JSON . parse ( read . toString ( 'utf-8' ) ) ) ; // .then(read => JSON.parse(read.toString('utf-8')));
expect ( read ) . toEqual ( obj . object ) ; // expect(read).toEqual(obj.object);
} // }
// });
// it('zips paths', async () => {
// const files = [
// join(__dirname, 'tests', 'resources', 'bar.txt'),
// join(__dirname, 'tests', 'resources', 'foo.json'),
// join(__dirname, 'tests', 'resources', 'baz'),
// ];
// const zipped = join(tmpdir(), `zip-test-${Date.now()}.zip`);
// await zip({ destination: zipped, objects: [], paths: files });
// const unzipped = join(tmpdir(), `zip-test-${Date.now()}`);
// await unzip(zipped, unzipped);
// const entries = await fs..readdir(unzipped, { withFileTypes: true });
// const bar = entries.find(e => e.name === 'bar.txt');
// const baz = entries.find(e => e.name === 'baz');
// const foo = entries.find(e => e.name === 'foo.json');
// expect(bar?.isFile()).toBeTruthy();
// expect(baz?.isDirectory()).toBeTruthy();
// expect(foo?.isFile()).toBeTruthy();
// });
it ( 'should fail if there is an archiver error' , async ( ) = > {
fsMock . createWriteStream . mockReturnValueOnce ( new PassThrough ( ) as any ) ;
const promise = zip ( 'source' , 'destination' ) ;
// emit an error after a small delay
const mockError = new Error ( 'test-error' ) ;
setTimeout ( ( ) = > {
archiverMock . mockEmit ( 'error' , mockError ) ;
} , 100 ) ;
await expect ( promise ) . rejects . toEqual ( mockError ) ;
} ) ; } ) ;
it ( 'zips paths' , async ( ) = > { it ( 'should fail if there is an archiver warning' , async ( ) = > {
const files = [ fsMock . createWriteStream . mockReturnValueOnce ( new PassThrough ( ) as any ) ;
join ( __dirname , 'tests' , 'resources' , 'bar.txt' ) ,
join ( __dirname , 'tests' , 'resources' , 'foo.json' ) ,
join ( __dirname , 'tests' , 'resources' , 'baz' ) ,
] ;
const zipped = join ( tmpdir ( ) , ` zip-test- ${ Date . now ( ) } .zip ` ) ;
await zip ( { destination : zipped , objects : [ ] , paths : files } ) ;
const unzipped = join ( tmpdir ( ) , ` zip-test- ${ Date . now ( ) } ` ) ;
await unzip ( zipped , unzipped ) ;
const entries = await fs . readdir ( unzipped , { withFileTypes : true } ) ; const promise = zip ( 'source' , 'destination' ) ;
const bar = entries . find ( e = > e . name === 'bar.txt' ) ; // emit an error after a small delay
const baz = entries . find ( e = > e . name === 'baz' ) ; const mockError = new Error ( 'test-warning' ) ;
const foo = entries . find ( e = > e . name === 'foo.json' ) ; setTimeout ( ( ) = > {
archiverMock . mockEmit ( 'warning' , mockError ) ;
} , 100 ) ;
expect ( bar ? . isFile ( ) ) . toBeTruthy ( ) ; await expect ( promise ) . rejects . toEqual ( mockError ) ;
expect ( baz ? . isDirectory ( ) ) . toBeTruthy ( ) ;
expect ( foo ? . isFile ( ) ) . toBeTruthy ( ) ;
} ) ; } ) ;
} ) ; } ) ;
Torkel Rogstad
5 years ago
jamaljsr