How to use parseContainerPath method in Appium Xcuitest Driver

...53 * @param {string} base64Data - Base-64 encoded content of the file to be uploaded.54 */55async function pushFileToSimulator (device, remotePath, base64Data) {56  if (remotePath.startsWith(CONTAINER_PATH_MARKER)) {57    const [bundleId, dstPath] = await parseContainerPath(remotePath,58      async (x) => await getAppContainer(device.udid, x));59    log.info(`Parsed bundle identifier '${bundleId}' from '${remotePath}'. ` +60             `Will put the data into '${dstPath}'`);61    if (!await fs.exists(path.dirname(dstPath))) {62      log.debug(`The destination folder '${path.dirname(dstPath)}' does not exist. Creating...`);63      await fs.mkdirp(path.dirname(dstPath));64    }65    await fs.writeFile(dstPath, new Buffer(base64Data, 'base64').toString('binary'), 'binary');66    return;67  }68  const dstFolder = await tempDir.tempDir();69  const dstPath = path.resolve(dstFolder, path.basename(remotePath));70  try {71    await fs.writeFile(dstPath, new Buffer(base64Data, 'base64').toString('binary'), 'binary');72    await addMedia(device.udid, dstPath);73  } finally {74    await fs.rimraf(dstFolder);75  }76}77/**78 * Save the given base64 data chunk as a binary file on the device under test.79 * ifuse/osxfuse should be installed and configured on the target machine in order80 * for this function to work properly. Read https://github.com/libimobiledevice/ifuse81 * and https://github.com/osxfuse/osxfuse/wiki/FAQ for more details.82 *83 * @param {Object} device - The device object, which represents the device under test.84 *                          This object is expected to have the `udid` property containing the85 *                          valid device ID.86 * @param {string} remotePath - The remote path on the device. This variable can be prefixed with87 *                              bundle id, so then the file will be uploaded to the corresponding88 *                              application container instead of the default media folder, for example89 *                              '@com.myapp.bla/RelativePathInContainer/111.png'. The '@' character at the90 *                              beginning of the argument is mandatory in such case.91 * @param {string} base64Data - Base-64 encoded content of the file to be uploaded.92 */93async function pushFileToRealDevice (device, remotePath, base64Data) {94  await verifyIFusePresence();95  const mntRoot = await tempDir.tempDir();96  let isUnmountSuccessful = true;97  try {98    let dstPath = path.resolve(mntRoot, remotePath);99    let ifuseArgs = ['-u', device.udid, mntRoot];100    if (remotePath.startsWith(CONTAINER_PATH_MARKER)) {101      const [bundleId, pathInContainer] = await parseContainerPath(remotePath, mntRoot);102      dstPath = pathInContainer;103      log.info(`Parsed bundle identifier '${bundleId}' from '${remotePath}'. ` +104               `Will put the data into '${dstPath}'`);105      ifuseArgs = ['-u', device.udid, '--container', bundleId, mntRoot];106    }107    await mountDevice(device, ifuseArgs);108    isUnmountSuccessful = false;109    try {110      if (!await fs.exists(path.dirname(dstPath))) {111        log.debug(`The destination folder '${path.dirname(dstPath)}' does not exist. Creating...`);112        await fs.mkdirp(path.dirname(dstPath));113      }114      await fs.writeFile(dstPath, new Buffer(base64Data, 'base64').toString('binary'), 'binary');115    } finally {116      await exec('umount', [mntRoot]);117      isUnmountSuccessful = true;118    }119  } finally {120    if (isUnmountSuccessful) {121      await fs.rimraf(mntRoot);122    } else {123      log.warn(`Umount has failed, so not removing '${mntRoot}'`);124    }125  }126}127/**128 * Get the content of given file from iOS Simulator and return it as base-64 encoded string.129 *130 * @param {Object} device - The device object, which represents the device under test.131 *                          This object is expected to have the `udid` property containing the132 *                          valid device ID.133 * @param {string} remotePath - The path to a file, which exists in the corresponding application134 *                              container on Simulator. The expected format of this string:135 *                              @<app_bundle_id>/<path_to_the_file_inside_container>136 * @returns {string} Base-64 encoded content of the file.137 */138async function pullFileFromSimulator (device, remotePath) {139  if (!remotePath.startsWith(CONTAINER_PATH_MARKER)) {140    log.errorAndThrow(`Only pulling files from application containers is supported for iOS Simulator. ` +141                      `Provide the remote path in format @<bundle_id>/<path_to_the_file_in_its_container>`);142  }143  const [bundleId, dstPath] = await parseContainerPath(remotePath,144    async (x) => await getAppContainer(device.udid, x));145  log.info(`Parsed bundle identifier '${bundleId}' from '${remotePath}'. ` +146           `Will get the data from '${dstPath}'`);147  if (!await fs.exists(dstPath)) {148    log.errorAndThrow(`The remote file at '${dstPath}' does not exist`);149  }150  const data = await fs.readFile(dstPath);151  return new Buffer(data).toString('base64');152}153/**154 * Get the content of given file from the real device under test and return it as base-64 encoded string.155 *156 * @param {Object} device - The device object, which represents the device under test.157 *                          This object is expected to have the `udid` property containing the158 *                          valid device ID.159 * @param {string} remotePath - The path to an existing remote file on the device. This variable can be prefixed with160 *                              bundle id, so then the file will be downloaded from the corresponding161 *                              application container instead of the default media folder, for example162 *                              '@com.myapp.bla/RelativePathInContainer/111.png'. The '@' character at the163 *                              beginning of the argument is mandatory in such case.164 * @return {string} Base-64 encoded content of the remote file165 */166async function pullFileFromRealDevice (device, remotePath) {167  await verifyIFusePresence();168  const mntRoot = await tempDir.tempDir();169  let isUnmountSuccessful = true;170  try {171    let dstPath = path.resolve(mntRoot, remotePath);172    let ifuseArgs = ['-u', device.udid, mntRoot];173    if (remotePath.startsWith(CONTAINER_PATH_MARKER)) {174      const [bundleId, pathInContainer] = await parseContainerPath(remotePath, mntRoot);175      dstPath = pathInContainer;176      log.info(`Parsed bundle identifier '${bundleId}' from '${remotePath}'. ` +177               `Will get the data from '${dstPath}'`);178      ifuseArgs = ['-u', device.udid, '--container', bundleId, mntRoot];179    }180    await mountDevice(device, ifuseArgs);181    isUnmountSuccessful = false;182    try {183      if (!await fs.exists(dstPath)) {184        log.errorAndThrow(`The remote file at '${dstPath}' does not exist`);185      }186      const data = await fs.readFile(dstPath);187      return new Buffer(data).toString('base64');188    } finally {...

...64 */65async function pushFileToSimulator (device, remotePath, base64Data) {66  const buffer = Buffer.from(base64Data, 'base64');67  if (remotePath.startsWith(CONTAINER_PATH_MARKER)) {68    const [bundleId, dstPath] = await parseContainerPath(remotePath,69      async (x) => await getAppContainer(device.udid, x));70    log.info(`Parsed bundle identifier '${bundleId}' from '${remotePath}'. ` +71             `Will put the data into '${dstPath}'`);72    if (!await fs.exists(path.dirname(dstPath))) {73      log.debug(`The destination folder '${path.dirname(dstPath)}' does not exist. Creating...`);74      await mkdirp(path.dirname(dstPath));75    }76    await fs.writeFile(dstPath, buffer, 'binary');77    return;78  }79  const dstFolder = await tempDir.openDir();80  const dstPath = path.resolve(dstFolder, path.basename(remotePath));81  try {82    await fs.writeFile(dstPath, buffer, 'binary');83    await addMedia(device.udid, dstPath);84  } finally {85    await fs.rimraf(dstFolder);86  }87}88/**89 * Save the given base64 data chunk as a binary file on the device under test.90 * ifuse/osxfuse should be installed and configured on the target machine in order91 * for this function to work properly. Read https://github.com/libimobiledevice/ifuse92 * and https://github.com/osxfuse/osxfuse/wiki/FAQ for more details.93 *94 * @param {Object} device - The device object, which represents the device under test.95 *                          This object is expected to have the `udid` property containing the96 *                          valid device ID.97 * @param {string} remotePath - The remote path on the device. This variable can be prefixed with98 *                              bundle id, so then the file will be uploaded to the corresponding99 *                              application container instead of the default media folder, for example100 *                              '@com.myapp.bla/RelativePathInContainer/111.png'. The '@' character at the101 *                              beginning of the argument is mandatory in such case.102 * @param {string} base64Data - Base-64 encoded content of the file to be uploaded.103 */104async function pushFileToRealDevice (device, remotePath, base64Data) {105  await verifyIFusePresence();106  const mntRoot = await tempDir.openDir();107  let isUnmountSuccessful = true;108  try {109    let dstPath = path.resolve(mntRoot, remotePath);110    let ifuseArgs = ['-u', device.udid, mntRoot];111    if (remotePath.startsWith(CONTAINER_PATH_MARKER)) {112      const [bundleId, pathInContainer] = await parseContainerPath(remotePath, mntRoot);113      dstPath = pathInContainer;114      log.info(`Parsed bundle identifier '${bundleId}' from '${remotePath}'. ` +115               `Will put the data into '${dstPath}'`);116      ifuseArgs = ['-u', device.udid, '--container', bundleId, mntRoot];117    } else {118      verifyIsSubPath(dstPath, mntRoot);119    }120    await mountDevice(device, ifuseArgs);121    isUnmountSuccessful = false;122    try {123      if (!await fs.exists(path.dirname(dstPath))) {124        log.debug(`The destination folder '${path.dirname(dstPath)}' does not exist. Creating...`);125        await mkdirp(path.dirname(dstPath));126      }127      await fs.writeFile(dstPath, new Buffer(base64Data, 'base64').toString('binary'), 'binary');128    } finally {129      await exec('umount', [mntRoot]);130      isUnmountSuccessful = true;131    }132  } finally {133    if (isUnmountSuccessful) {134      await fs.rimraf(mntRoot);135    } else {136      log.warn(`Umount has failed, so not removing '${mntRoot}'`);137    }138  }139}140/**141 * Get the content of given file from iOS Simulator and return it as base-64 encoded string.142 *143 * @param {Object} device - The device object, which represents the device under test.144 *                          This object is expected to have the `udid` property containing the145 *                          valid device ID.146 * @param {string} remotePath - The path to a file, which exists in the corresponding application147 *                              container on Simulator. The expected format of this string:148 *                              @<app_bundle_id>/<path_to_the_file_inside_container>149 * @returns {string} Base-64 encoded content of the file.150 */151async function pullFileFromSimulator (device, remotePath) {152  if (!remotePath.startsWith(CONTAINER_PATH_MARKER)) {153    log.errorAndThrow(`Only pulling files from application containers is supported for iOS Simulator. ` +154                      `Provide the remote path in format @<bundle_id>/<path_to_the_file_in_its_container>`);155  }156  const [bundleId, dstPath] = await parseContainerPath(remotePath,157    async (x) => await getAppContainer(device.udid, x));158  log.info(`Parsed bundle identifier '${bundleId}' from '${remotePath}'. ` +159           `Will get the data from '${dstPath}'`);160  if (!await fs.exists(dstPath)) {161    log.errorAndThrow(`The remote file at '${dstPath}' does not exist`);162  }163  const data = await fs.readFile(dstPath);164  return new Buffer(data).toString('base64');165}166/**167 * Get the content of given file from the real device under test and return it as base-64 encoded string.168 *169 * @param {Object} device - The device object, which represents the device under test.170 *                          This object is expected to have the `udid` property containing the171 *                          valid device ID.172 * @param {string} remotePath - The path to an existing remote file on the device. This variable can be prefixed with173 *                              bundle id, so then the file will be downloaded from the corresponding174 *                              application container instead of the default media folder, for example175 *                              '@com.myapp.bla/RelativePathInContainer/111.png'. The '@' character at the176 *                              beginning of the argument is mandatory in such case.177 * @return {string} Base-64 encoded content of the remote file178 */179async function pullFileFromRealDevice (device, remotePath) {180  await verifyIFusePresence();181  const mntRoot = await tempDir.openDir();182  let isUnmountSuccessful = true;183  try {184    let dstPath = path.resolve(mntRoot, remotePath);185    let ifuseArgs = ['-u', device.udid, mntRoot];186    if (remotePath.startsWith(CONTAINER_PATH_MARKER)) {187      const [bundleId, pathInContainer] = await parseContainerPath(remotePath, mntRoot);188      dstPath = pathInContainer;189      log.info(`Parsed bundle identifier '${bundleId}' from '${remotePath}'. ` +190               `Will get the data from '${dstPath}'`);191      ifuseArgs = ['-u', device.udid, '--container', bundleId, mntRoot];192    } else {193      verifyIsSubPath(dstPath, mntRoot);194    }195    await mountDevice(device, ifuseArgs);196    isUnmountSuccessful = false;197    try {198      if (!await fs.exists(dstPath)) {199        log.errorAndThrow(`The remote file at '${dstPath}' does not exist`);200      }201      const data = await fs.readFile(dstPath);...

...50                      `'${remotePath}' is given instead`);51  }52  let tmpDestination = null;53  if (remotePath.startsWith(CONTAINER_PATH_MARKER)) {54    const [packageId, pathInContainer] = parseContainerPath(remotePath);55    log.debug(`Parsed package identifier '${packageId}' from '${remotePath}'. Will get the data from '${pathInContainer}'`);56    tmpDestination = `/data/local/tmp/${path.posix.basename(pathInContainer)}`;57    try {58      await this.adb.shell(['run-as', packageId, `chmod 777 '${escapePath(pathInContainer)}'`]);59      await this.adb.shell(['cp', '-f', pathInContainer, tmpDestination]);60    } catch (e) {61      log.errorAndThrow(`Cannot access the container of '${packageId}' application. ` +62                        `Is the application installed and has 'debuggable' build option set to true? ` +63                        `Original error: ${e.message}`);64    }65  }66  const localFile = await tempDir.path({prefix: 'appium', suffix: '.tmp'});67  try {68    await this.adb.pull(tmpDestination || remotePath, localFile);69    return (await util.toInMemoryBase64(localFile)).toString();70  } finally {71    if (await fs.exists(localFile)) {72      await fs.unlink(localFile);73    }74    if (tmpDestination) {75      await this.adb.shell(['rm', '-f', tmpDestination]);76    }77  }78};79/**80 * Pushed the given data to a file on the remote device81 * It is required, that a package has debugging flag enabled82 * in order to access its files.83 *84 * @param {string} remotePath The full path to the remote file or85 * a file inside a package bundle86 * @param {string} base64Data Base64 encoded data to be written to the87 * remote file. The remote file will be silently overridden if it already exists.88 * @throws {Error} If there was an error while pushing the data89 */90commands.pushFile = async function pushFile (remotePath, base64Data) {91  if (remotePath.endsWith('/')) {92    log.errorAndThrow(`It is expected that remote path points to a file and not to a folder. ` +93                      `'${remotePath}' is given instead`);94  }95  const localFile = await tempDir.path({prefix: 'appium', suffix: '.tmp'});96  if (_.isArray(base64Data)) {97    // some clients (ahem) java, send a byte array encoding utf8 characters98    // instead of a string, which would be infinitely better!99    base64Data = Buffer.from(base64Data).toString('utf8');100  }101  const content = Buffer.from(base64Data, 'base64');102  let tmpDestination = null;103  try {104    await fs.writeFile(localFile, content.toString('binary'), 'binary');105    if (remotePath.startsWith(CONTAINER_PATH_MARKER)) {106      const [packageId, pathInContainer] = parseContainerPath(remotePath);107      log.debug(`Parsed package identifier '${packageId}' from '${remotePath}'. Will put the data into '${pathInContainer}'`);108      tmpDestination = `/data/local/tmp/${path.posix.basename(pathInContainer)}`;109      try {110        await this.adb.shell(111          ['run-as', packageId, `mkdir -p '${escapePath(path.posix.dirname(pathInContainer))}'`]112        );113        await this.adb.shell(['run-as', packageId, `touch '${escapePath(pathInContainer)}'`]);114        await this.adb.shell(['run-as', packageId, `chmod 777 '${escapePath(pathInContainer)}'`]);115        await this.adb.push(localFile, tmpDestination);116        await this.adb.shell(['cp', '-f', tmpDestination, pathInContainer]);117      } catch (e) {118        log.errorAndThrow(`Cannot access the container of '${packageId}' application. ` +119                          `Is the application installed and has 'debuggable' build option set to true? ` +120                          `Original error: ${e.message}`);121      }122    } else {123      // adb push creates folders and overwrites existing files.124      await this.adb.push(localFile, remotePath);125      // if we have pushed a file, it might be a media file, so ensure that126      // apps know about it127      log.info('After pushing media file, broadcasting media scan intent');128      try {129        await this.adb.shell(['am', 'broadcast', '-a',130          ANDROID_MEDIA_RESCAN_INTENT, '-d', `file://${remotePath}`]);131      } catch (e) {132        log.warn(`Got error broadcasting media scan intent: ${e.message}; ignoring`);133      }134    }135  } finally {136    if (await fs.exists(localFile)) {137      await fs.unlink(localFile);138    }139    if (tmpDestination) {140      await this.adb.shell(['rm', '-f', tmpDestination]);141    }142  }143};144/**145 * Pulls the whole folder from the remote device146 *147 * @param {string} remotePath The full path to a folder on the148 * remote device or a folder inside an application bundle149 * @returns {string} Base64-encoded and zipped content of the folder150 * @throws {Error} If there was a failure while getting the folder content151 */152commands.pullFolder = async function pullFolder (remotePath) {153  let localFolder = await tempDir.path({prefix: 'appium'});154  await this.adb.pull(remotePath, localFolder);155  return (await zip.toInMemoryZip(localFolder, {156    encodeToBase64: true,157  })).toString();158};159/**160 * Deletes the given folder or file from the remote device161 *162 * @param {ADB} adb163 * @param {string} remotePath The full path to the remote folder164 * or file (folder names must end with a single slash)165 * @throws {Error} If the provided remote path is invalid or166 * the package content cannot be accessed167 * @returns {boolean} `true` if the remote item has been successfully deleted.168 * If the remote path is valid, but the remote path does not exist169 * this function return `false`.170 */171async function deleteFileOrFolder (adb, remotePath) {172  const performRemoteFsCheck = async (p, op, runAs = null) => {173    const passFlag = '__PASS__';174    const checkCmd = `[ -${op} '${escapePath(p)}' ] && echo ${passFlag}`;175    const fullCmd = runAs ? `run-as ${runAs} ${checkCmd}` : checkCmd;176    try {177      return _.includes(await adb.shell([fullCmd]), passFlag);178    } catch (ign) {179      return false;180    }181  };182  const isFile = async (p, runAs = null) => await performRemoteFsCheck(p, 'f', runAs);183  const isDir = async (p, runAs = null) => await performRemoteFsCheck(p, 'd', runAs);184  const isPresent = async (p, runAs = null) => await performRemoteFsCheck(p, 'e', runAs);185  let dstPath = remotePath;186  let pkgId = null;187  if (remotePath.startsWith(CONTAINER_PATH_MARKER)) {188    const [packageId, pathInContainer] = parseContainerPath(remotePath);189    log.debug(`Parsed package identifier '${packageId}' from '${remotePath}'`);190    dstPath = pathInContainer;191    pkgId = packageId;192  }193  if (pkgId) {194    try {195      await adb.shell(['run-as', pkgId, 'ls']);196    } catch (e) {197      log.errorAndThrow(`Cannot access the container of '${pkgId}' application. ` +198        `Is the application installed and has 'debuggable' build option set to true? ` +199        `Original error: ${e.message}`);200    }201  }202  if (!await isPresent(dstPath, pkgId)) {...

...9describe('file-movement', function () {10  describe('parseContainerPath', function () {11    it('should parse with container', async function () {12      const mntRoot = await tempDir.openDir();13      const {bundleId, pathInContainer, containerType} = await parseContainerPath('@io.appium.example:app/Documents/file.txt', mntRoot);14      bundleId.should.eql('io.appium.example');15      pathInContainer.should.eql(`${mntRoot}/Documents/file.txt`);16      containerType.should.eql('app');17    });18    it('should parse with container root', async function () {19      const mntRoot = await tempDir.openDir();20      const {bundleId, pathInContainer, containerType} = await parseContainerPath('@io.appium.example:documents/', mntRoot);21      bundleId.should.eql('io.appium.example');22      pathInContainer.should.eql(mntRoot);23      containerType.should.eql('documents');24    });25    it('should parse without container', async function () {26      const mntRoot = await tempDir.openDir();27      const {bundleId, pathInContainer, containerType} = await parseContainerPath('@io.appium.example/Documents/file.txt', mntRoot);28      bundleId.should.eql('io.appium.example');29      pathInContainer.should.eql(`${mntRoot}/Documents/file.txt`);30      should.equal(containerType, null);31    });32    it('should raise an error if no container path', async function () {33      const mntRoot = await tempDir.openDir();34      await parseContainerPath('@io.appium.example:documents', mntRoot).should.eventually.be.rejected;35    });36  });37  describe('getAvailableBundleIds', withMocks({services, fs}, (mocks) => {38    afterEach(function () {39      mocks.verify();40    });41    it('get available bundleIds with items', async function () {42      mocks.services.expects('startInstallationProxyService')43      .withExactArgs('12345')44        .returns({45          listApplications () {46            return {47              'com.apple.Keynote': {48                UIFileSharingEnabled: true...

...27  execute(callback) {28    if (!safe) {29      return callback(new Error('App not registered'));30    }31    const containerPath = parseContainerPath(this.networkPath);32    return safe.auth.getAccessContainerInfo(accessContainers.public)33      .then((mdata) => mdata.get(containerPath.target))34      .then((val) => safe.mutableData.newPublic(val.buf, typetag))35      .then((mdata) => {36        const nfs = mdata.emulateAs('NFS');37        return nfs.create(fs.readFileSync(this.localPath))38          .then((file) => nfs.insert(containerPath.file, file));39      })40      .then(() => callback(null, {41        isFile: true,42        isCompleted: true,43        size: fs.statSync(this.localPath).size44      }))45      .catch(callback);...