components/cronet/android/test/src/org/chromium/net/TestFilesInstaller.java

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 package org.chromium.net;
   6
   7 import android.content.Context;
   8 import android.content.res.AssetManager;
   9 import android.util.Log;
  10
  11 import org.chromium.base.PathUtils;
  12 import org.chromium.base.annotations.SuppressFBWarnings;
  13
  14 import java.io.File;
  15 import java.io.FileOutputStream;
  16 import java.io.IOException;
  17 import java.io.InputStream;
  18 import java.io.OutputStream;
  19
  20 /**
  21  * Helper class to install test files.
  22  */
  23 public final class TestFilesInstaller {
  24     private static final String TAG = "TestFilesInstaller";
  25     // Name of the asset directory in which test files are stored.
  26     private static final String TEST_FILE_ASSET_PATH = "test";
  27
  28     /**
  29      * Installs test files if files have not been installed.
  30      */
  31     public static void installIfNeeded(Context context) {
  32         if (areFilesInstalled(context)) {
  33             return;
  34         }
  35         try {
  36             install(context, TEST_FILE_ASSET_PATH);
  37         } catch (IOException e) {
  38             // Make the test app crash and fail early.
  39             throw new RuntimeException(e);
  40         }
  41     }
  42
  43     /**
  44      * Returns the installed path of the test files.
  45      */
  46     public static String getInstalledPath(Context context) {
  47         return PathUtils.getDataDirectory(context) + "/" + TEST_FILE_ASSET_PATH;
  48     }
  49
  50     /**
  51      * Returns whether test files are installed.
  52      */
  53     public static boolean areFilesInstalled(Context context) {
  54         // Checking for file directory is fine even when new files are added,
  55         // because the app will be re-installed and app data will be cleared.
  56         File directory = new File(getInstalledPath(context));
  57         return directory.exists();
  58     }
  59
  60     /**
  61      * Installs test files that are included in {@code path}.
  62      * @params context Application context
  63      * @params path
  64      */
  65     private static void install(Context context, String path) throws IOException {
  66         AssetManager assetManager = context.getAssets();
  67         String files[] = assetManager.list(path);
  68         Log.i(TAG, "Loading " + path + " ...");
  69         String root = PathUtils.getDataDirectory(context);
  70         if (files.length == 0) {
  71             // The path is a file, so copy the file now.
  72             copyTestFile(assetManager, path, root + "/" + path);
  73         } else {
  74             // The path is a directory, so recursively handle its files, since
  75             // the directory can contain subdirectories.
  76             String fullPath = root + "/" + path;
  77             File dir = new File(fullPath);
  78             if (!dir.exists()) {
  79                 Log.i(TAG, "Creating directory " + fullPath + " ...");
  80                 if (!dir.mkdir()) {
  81                     throw new IOException("Directory not created.");
  82                 }
  83             }
  84             for (int i = 0; i < files.length; i++) {
  85                 install(context, path + "/" + files[i]);
  86             }
  87         }
  88     }
  89     /**
  90      * Copies a file from assets to the device's file system.
  91      * @param assetManager AssetManager of the application.
  92      * @param srcFilePath the source file path in assets.
  93      * @param destFilePath the destination file path.
  94      * @throws IllegalStateException if the destination file already exists.
  95      */
  96     @SuppressFBWarnings("OBL_UNSATISFIED_OBLIGATION_EXCEPTION_EDGE")
  97     private static void copyTestFile(AssetManager assetManager,
  98                                      String srcFilePath,
  99                                      String destFilePath) throws IOException {
 100         File destFile = new File(destFilePath);
 101         if (destFile.exists()) {
 102             throw new IllegalStateException(srcFilePath + " already exists");
 103         }
 104         OutputStream out = new FileOutputStream(destFilePath);
 105         InputStream in = assetManager.open(srcFilePath);
 106
 107         byte[] buffer = new byte[1024];
 108         int read;
 109         while ((read = in.read(buffer)) != -1) {
 110             out.write(buffer, 0, read);
 111         }
 112         in.close();
 113         out.flush();
 114         out.close();
 115     }
 116 }