How to use zip.assertValidZip method in Appium Base Driver

...237  }238  return result;239}240async function unzipApp (zipPath, dstRoot, supportedAppExtensions) {241  await zip.assertValidZip(zipPath);242  if (!_.isArray(supportedAppExtensions)) {243    supportedAppExtensions = [supportedAppExtensions];244  }245  const tmpRoot = await tempDir.openDir();246  try {247    logger.debug(`Unzipping '${zipPath}'`);248    await zip.extractAllTo(zipPath, tmpRoot);249    const allExtractedItems = await walkDir(tmpRoot);250    logger.debug(`Extracted ${allExtractedItems.length} item(s) from '${zipPath}'`);251    const isSupportedAppItem = (relativePath) => supportedAppExtensions.includes(path.extname(relativePath))252      || _.some(supportedAppExtensions, (x) => relativePath.includes(`${x}${path.sep}`));253    const itemsToKeep = allExtractedItems254      .map((itemPath) => path.relative(tmpRoot, itemPath))255      .filter((relativePath) => isSupportedAppItem(relativePath))...

...168 *                          The file will be overridden if it already exists.169 */170manifestMethods.insertManifest = async function insertManifest (manifest, srcApk, dstApk) {171  log.debug(`Inserting manifest '${manifest}', src: '${srcApk}', dst: '${dstApk}'`);172  await zip.assertValidZip(srcApk);173  await unzipFile(`${manifest}.apk`);174  const manifestName = path.basename(manifest);175  try {176    await this.initAapt();177    await fs.copyFile(srcApk, dstApk);178    log.debug('Moving manifest');179    try {180      await exec(this.binaries.aapt, [181        'remove', dstApk, manifestName182      ]);183    } catch (ign) {}184    await exec(this.binaries.aapt, [185      'add', dstApk, manifestName186    ], {cwd: path.dirname(manifest)});...

...33    });34  });35  describe('assertValidZip', function () {36    it('should not throw an error if a valid ZIP file is passed', async function () {37      await zip.assertValidZip(zippedFilePath).should.eventually.be.fulfilled;38    });39    it('should throw an error if the file does not exist', async function () {40      await zip.assertValidZip('blabla').should.eventually.be.rejected;41    });42    it('should throw an error if the file is invalid', async function () {43      await zip.assertValidZip(path.resolve(assetsPath, 'unzipped', 'test-dir', 'a.txt')).should.eventually.be.rejected;44    });45  });46  describe('readEntries()', function () {47    const expectedEntries = [48      {name: 'unzipped/'},49      {name: 'unzipped/test-dir/'},50      {name: 'unzipped/test-dir/a.txt', contents: 'Hello World'},51      {name: 'unzipped/test-dir/b.txt', contents: 'Foo Bar'},52    ];53    it('should iterate entries (directories and files) of zip file', async function () {54      let i = 0;55      await zip.readEntries(zippedFilePath, async ({entry, extractEntryTo}) => {56        entry.fileName.should.equal(expectedEntries[i].name);57        // If it's a file, test that we can extract it to a temporary directory and that the contents are correct...

1import B from 'bluebird';2import nodeExtract from 'extract-zip';3import yauzl from 'yauzl';4import archiver from 'archiver';5import { createWriteStream } from 'fs';6import path from 'path';7import { mkdirp } from '../lib/mkdirp';8import stream from 'stream';9import fs from './fs';10const extract = B.promisify(nodeExtract);11const open = B.promisify(yauzl.open);12const ZIP_MAGIC = 'PK';13/**14 * Extract zipfile to a directory15 *16 * @param {string} zipFilePath The full path to the source ZIP file17 * @param {string} destDir The full path to the destination folder18 */19async function extractAllTo (zipFilePath, destDir) {20  return await extract(zipFilePath, {dir: destDir});21}22/**23 * Extract a single zip entry to a directory24 *25 * @param {Streamable} zipFile The source ZIP stream26 * @param {yauzl.ZipEntry} entry The entry instance27 * @param {string} destDir The full path to the destination folder28 */29async function _extractEntryTo (zipFile, entry, destDir) {30  const dstPath = path.resolve(destDir, entry.fileName);31  // Create dest directory if doesn't exist already32  if (/\/$/.test(entry.fileName)) {33    if (!await fs.exists(dstPath)) {34      await mkdirp(dstPath);35    }36    return;37  } else if (!await fs.exists(path.dirname(dstPath))) {38    await mkdirp(path.dirname(dstPath));39  }40  // Create a write stream41  const writeStream = createWriteStream(dstPath, {flags: 'w'});42  const writeStreamPromise = new B((resolve, reject) => {43    writeStream.once('finish', resolve);44    writeStream.once('error', reject);45  });46  // Create zipReadStream and pipe data to the write stream47  // (for some odd reason B.promisify doesn't work on zipfile.openReadStream, it causes an error 'closed')48  const zipReadStream = await new B((resolve, reject) => {49    zipFile.openReadStream(entry, (err, readStream) => err ? reject(err) : resolve(readStream));50  });51  const zipReadStreamPromise = new B((resolve, reject) => {52    zipReadStream.once('end', resolve);53    zipReadStream.once('error', reject);54  });55  zipReadStream.pipe(writeStream);56  // Wait for the zipReadStream and writeStream to end before returning57  return await B.all([58    zipReadStreamPromise,59    writeStreamPromise,60  ]);61}62/**63 * @typedef {Object} ZipEntry64 * @property {yauzl.ZipEntry} entry The actual entry instance65 * @property {function} extractEntryTo An async function, which accepts one parameter.66 * This parameter contains the destination folder path to which this function is going to extract the entry.67 */68/**69 * Get entries for a zip folder70 *71 * @param {string} zipFilePath The full path to the source ZIP file72 * @param {function} onEntry Callback when entry is read.73 * The callback is expected to accept one argument of ZipEntry type.74 * The iteration through the source zip file will bi terminated as soon as75 * the result of this function equals to `false`.76 */77async function readEntries (zipFilePath, onEntry) {78  // Open a zip file and start reading entries79  const zipfile = await open(zipFilePath, {lazyEntries: true});80  const zipReadStreamPromise = new B((resolve, reject) => {81    zipfile.once('end', resolve);82    zipfile.once('error', reject);83    // On each entry, call 'onEntry' and then read the next entry84    zipfile.on('entry', async (entry) => {85      const res = await onEntry({86        entry,87        extractEntryTo: async (destDir) => await _extractEntryTo(zipfile, entry, destDir)88      });89      if (res === false) {90        return zipfile.emit('end');91      }92      zipfile.readEntry();93    });94  });95  zipfile.readEntry();96  // Wait for the entries to finish being iterated through97  return await zipReadStreamPromise;98}99/**100 * Converts contents of local directory to an in-memory .zip buffer101 *102 * @param {string} srcDir The full path to the folder being zipped103 * @returns {Buffer} Zipped content of the source folder as memory buffer104 */105async function toInMemoryZip (srcDir) {106  // Create a writable stream that zip buffers will be streamed to107  const zipBufferArr = [];108  const zipWriteStream = new stream.Writable({109    write: (buffer, encoding, next) => {110      zipBufferArr.push(buffer);111      next();112    },113  });114  const zipWriteStreamPromise = new B((resolve) => {115    // Don't need to do error handling since this writeStream is in-memory and doesn't emit any errors116    zipWriteStream.once('finish', resolve);117  });118  // Zip 'srcDir' and stream it to the above writable stream119  const archive = archiver('zip', {120    zlib: {level: 9}121  });122  const archiveStreamPromise = new B((resolve, reject) => {123    archive.once('finish', resolve);124    archive.once('error', (errStr) => reject(new Error(`Failed to zip directory ${srcDir}: ${errStr}`)));125  });126  archive.directory(srcDir, false);127  archive.pipe(zipWriteStream);128  archive.finalize();129  // Wait for the streams to finish130  await B.all([archiveStreamPromise, zipWriteStreamPromise]);131  // Return the array of zip buffers concatenated into one buffer132  return Buffer.concat(zipBufferArr);133}134/**135 * Verifies whether the given file is a valid ZIP archive136 *137 * @param {string} filePath - Full path to the file138 * @throws {Error} If the file does not exist or is not a valid ZIP archive139 */140async function assertValidZip (filePath) {141  if (!await fs.exists(filePath)) {142    throw new Error(`The file at '${filePath}' does not exist`);143  }144  const {size} = await fs.stat(filePath);145  if (size < 4) {146    throw new Error(`The file at '${filePath}' is too small to be a ZIP archive`);147  }148  const fd = await fs.open(filePath, 'r');149  try {150    const buffer = Buffer.alloc(ZIP_MAGIC.length);151    await fs.read(fd, buffer, 0, ZIP_MAGIC.length, 0);152    const signature = buffer.toString('ascii');153    if (signature !== ZIP_MAGIC) {154      throw new Error(`The file signature '${signature}' of '${filePath}' ` +155        `is not equal to the expected ZIP archive signature '${ZIP_MAGIC}'`);156    }157    return true;158  } finally {159    await fs.close(fd);160  }161}162export { extractAllTo, readEntries, toInMemoryZip, _extractEntryTo, assertValidZip };...

1import { zip, fs, tempDir } from 'appium-support';2import { configureApp, isPackageOrBundle, duplicateKeys, parseCapsArray } from '../../lib/basedriver/helpers';3import chai from 'chai';4import chaiAsPromised from 'chai-as-promised';5import sinon from 'sinon';6chai.use(chaiAsPromised);7const should = chai.should();8describe('helpers', function () {9  describe('#isPackageOrBundle', function () {10    it('should accept packages and bundles', function () {11      isPackageOrBundle('io.appium.testapp').should.be.true;12    });13    it('should not accept non-packages or non-bundles', function () {14      isPackageOrBundle('foo').should.be.false;15      isPackageOrBundle('/path/to/an.app').should.be.false;16      isPackageOrBundle('/path/to/an.apk').should.be.false;17    });18  });19  describe('#duplicateKeys', function () {20    it('should translate key in an object', function () {21      duplicateKeys({'foo': 'hello world'}, 'foo', 'bar').should.eql({'foo': 'hello world', 'bar': 'hello world'});22    });23    it('should translate key in an object within an object', function () {24      duplicateKeys({'key': {'foo': 'hello world'}}, 'foo', 'bar').should.eql({'key': {'foo': 'hello world', 'bar': 'hello world'}});25    });26    it('should translate key in an object with an array', function () {27      duplicateKeys([28        {'key': {'foo': 'hello world'}},29        {'foo': 'HELLO WORLD'}30      ], 'foo', 'bar').should.eql([31        {'key': {'foo': 'hello world', 'bar': 'hello world'}},32        {'foo': 'HELLO WORLD', 'bar': 'HELLO WORLD'}33      ]);34    });35    it('should duplicate both keys', function () {36      duplicateKeys({37        'keyOne': {38          'foo': 'hello world',39        },40        'keyTwo': {41          'bar': 'HELLO WORLD',42        },43      }, 'foo', 'bar').should.eql({44        'keyOne': {45          'foo': 'hello world',46          'bar': 'hello world',47        },48        'keyTwo': {49          'bar': 'HELLO WORLD',50          'foo': 'HELLO WORLD',51        }52      });53    });54    it('should not do anything to primitives', function () {55      [0, 1, -1, true, false, null, undefined, '', 'Hello World'].forEach((item) => {56        should.equal(duplicateKeys(item), item);57      });58    });59    it('should rename keys on big complex objects', function () {60      const input = [61        {'foo': 'bar'},62        {63          hello: {64            world: {65              'foo': 'BAR',66            }67          },68          foo: 'bahr'69        },70        'foo',71        null,72        073      ];74      const expectedOutput = [75        {'foo': 'bar', 'FOO': 'bar'},76        {77          hello: {78            world: {79              'foo': 'BAR',80              'FOO': 'BAR',81            }82          },83          foo: 'bahr',84          FOO: 'bahr'85        },86        'foo',87        null,88        089      ];90      duplicateKeys(input, 'foo', 'FOO').should.deep.equal(expectedOutput);91    });92  });93  describe('#configureApp', function () {94    let sandbox;95    beforeEach(function () {96      sandbox = sinon.createSandbox();97      sandbox.stub(zip, 'extractAllTo').resolves();98      sandbox.stub(zip, 'assertValidZip').resolves();99      sandbox.stub(fs, 'mv').resolves();100      sandbox.stub(fs, 'exists').resolves(true);101      sandbox.stub(fs, 'hash').resolves('0xDEADBEEF');102      sandbox.stub(fs, 'glob').resolves(['/path/to/an.apk']);103      sandbox.stub(fs, 'rimraf').resolves();104      sandbox.stub(fs, 'stat').resolves({105        isDirectory: () => false,106      });107      sandbox.stub(tempDir, 'openDir').resolves('/some/dir');108    });109    afterEach(function () {110      sandbox.restore();111    });112    it('should pass "useSystemUnzip" flag through to appium-support', async function () {113      await configureApp('/path/to/an.apk.zip', '.apk');114      zip.extractAllTo.getCall(0).lastArg.useSystemUnzip.should.be.true;115    });116  });117});118describe('parseCapsArray', function () {119  it('should parse string into array', function () {120    parseCapsArray('/tmp/my/app.zip').should.eql(['/tmp/my/app.zip']);121  });122  it('should parse array as string into array', function () {123    parseCapsArray('["/tmp/my/app.zip"]').should.eql(['/tmp/my/app.zip']);124    parseCapsArray('["/tmp/my/app.zip","/tmp/my/app2.zip"]').should.eql([125      '/tmp/my/app.zip',126      '/tmp/my/app2.zip'127    ]);128  });129  it('should return an array without change', function () {130    parseCapsArray(['a', 'b']).should.eql(['a', 'b']);131  });...