Media Galleries: Run API tests in a temp directory with an injected common.js file. Avoid the need …

chrome/browser/extensions/api/media_galleries/media_galleries_apitest.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+#include "base/auto_reset.h"
 #include "base/file_util.h"
 #include "base/files/scoped_temp_dir.h"
 #include "base/json/json_writer.h"
 #include "base/path_service.h"
 #include "base/safe_numerics.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/values.h"
 #include "chrome/browser/apps/app_browsertest_util.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/extensions/extension_system.h"
@@ skipping 60 matching lines @@
     PlatformAppBrowserTest::TearDownOnMainThread();
   }
 
   bool RunMediaGalleriesTest(const std::string& extension_name) {
     base::ListValue empty_list_value;
     return RunMediaGalleriesTestWithArg(extension_name, empty_list_value);
   }
 
   bool RunMediaGalleriesTestWithArg(const std::string& extension_name,
                                     const base::ListValue& custom_arg_value) {
+    const char kTestDir[] = "api_test/media_galleries/";
+    base::FilePath from_dir =
+        test_data_dir_.AppendASCII(kTestDir + extension_name);
+    base::ScopedTempDir temp_dir;
+    if (!temp_dir.CreateUniqueTempDir())
+      return false;
+
+    if (!base::CopyDirectory(from_dir, temp_dir.path(), true))
+      return false;
+
+    base::FilePath common_js_path(GetCommonDataDir().AppendASCII("common.js"));
+    base::FilePath inject_js_path(temp_dir.path().AppendASCII(extension_name)
+                                                 .AppendASCII("common.js"));
+    if (!base::CopyFile(common_js_path, inject_js_path))
+      return false;
+
     const char* custom_arg = NULL;
     std::string json_string;
     if (!custom_arg_value.empty()) {
       base::JSONWriter::Write(&custom_arg_value, &json_string);
       custom_arg = json_string.c_str();
     }
 
-    const char kTestDir[] = "api_test/media_galleries/";
-    return RunPlatformAppTestWithArg(kTestDir + extension_name, custom_arg);
+    base::AutoReset<base::FilePath> reset(&test_data_dir_, temp_dir.path());

[tommycli, 2013/09/24 23:26:10]

This override and the above copying logic probably belongs in its own inner
class.

You can put a nice name on it like InjectCommonScriptIntoTest (there's probably
a better name for this) - just so it's obvious what's going on.

Also it would only operate on a subset of the below tests.

[Lei Zhang, 2013/09/24 23:41:57]

I would like to just make common.js available to all MG API tests. One should be
able to just write MG tests and take advantage of it without thinking about
whether it has been injected or not.

+    return RunPlatformAppTestWithArg(extension_name, custom_arg);
   }
 
   void AttachFakeDevice() {
     device_id_ = StorageInfo::MakeDeviceId(
         StorageInfo::REMOVABLE_MASS_STORAGE_WITH_DCIM, kDeviceId);
 
     StorageMonitor::GetInstance()->receiver()->ProcessAttach(
         StorageInfo(device_id_, base::string16(), kDevicePath,
                     ASCIIToUTF16(kDeviceName), base::string16(),
                     base::string16(), 0));
     content::RunAllPendingInMessageLoop();
   }
 
   void DetachFakeDevice() {
     StorageMonitor::GetInstance()->receiver()->ProcessDetach(device_id_);
     content::RunAllPendingInMessageLoop();
   }
 
   void PopulatePicturesDirectoryTestData() {
     if (ensure_media_directories_exist_->num_galleries() == 0)
       return;
 
-    base::FilePath test_data_path =
-        test_data_dir_.AppendASCII("api_test")
-                      .AppendASCII("media_galleries")
-                      .AppendASCII("common");
+    base::FilePath test_data_path(GetCommonDataDir());
     base::FilePath write_path;
     ASSERT_TRUE(PathService::Get(chrome::DIR_USER_PICTURES, &write_path));
 
     // Valid file, should show up in JS as a FileEntry.
     ASSERT_TRUE(base::CopyFile(test_data_path.AppendASCII("test.jpg"),
                                write_path.AppendASCII("test.jpg")));
 
     // Invalid file, should not show up as a FileEntry in JS at all.
     ASSERT_TRUE(base::CopyFile(test_data_path.AppendASCII("test.txt"),
                                write_path.AppendASCII("test.txt")));
 
     int64 file_size;
     ASSERT_TRUE(file_util::GetFileSize(test_data_path.AppendASCII("test.jpg"),
                                        &file_size));
     test_jpg_size_ = base::checked_numeric_cast<int>(file_size);
   }
 
+  base::FilePath GetCommonDataDir() const {
+    return test_data_dir_.AppendASCII("api_test")
+                         .AppendASCII("media_galleries")
+                         .AppendASCII("common");
+  }
+
   int num_galleries() const {
     return ensure_media_directories_exist_->num_galleries();
   }
 
   int test_jpg_size() const { return test_jpg_size_; }
 
  private:
   std::string device_id_;
   int test_jpg_size_;
   scoped_ptr<EnsureMediaDirectoriesExists> ensure_media_directories_exist_;
 };
 
 IN_PROC_BROWSER_TEST_F(MediaGalleriesPlatformAppBrowserTest,
                        MediaGalleriesNoAccess) {
+  base::ScopedTempDir temp_dir;
+  ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
+  MakeFakeMediaGalleryForTest(browser()->profile(), temp_dir.path());
+
   base::ListValue custom_args;
-  custom_args.AppendInteger(num_galleries());
+  custom_args.AppendInteger(num_galleries() + 1);
 
   ASSERT_TRUE(RunMediaGalleriesTestWithArg("no_access", custom_args))
       << message_;
 }
 
 IN_PROC_BROWSER_TEST_F(MediaGalleriesPlatformAppBrowserTest, NoGalleriesRead) {
   ASSERT_TRUE(RunMediaGalleriesTest("no_galleries")) << message_;
 }
 
 IN_PROC_BROWSER_TEST_F(MediaGalleriesPlatformAppBrowserTest,
@@ skipping 13 matching lines @@
 
 IN_PROC_BROWSER_TEST_F(MediaGalleriesPlatformAppBrowserTest,
                        MediaGalleriesCopyTo) {
   base::ScopedTempDir temp_dir;
   ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
   MakeFakeMediaGalleryForTest(browser()->profile(), temp_dir.path());
   ASSERT_TRUE(RunMediaGalleriesTest("copy_to_access")) << message_;
 }
 
 IN_PROC_BROWSER_TEST_F(MediaGalleriesPlatformAppBrowserTest,
-                       MediaGalleriesCopyToNoAccess) {
-  base::ScopedTempDir temp_dir;
-  ASSERT_TRUE(temp_dir.CreateUniqueTempDir());
-  MakeFakeMediaGalleryForTest(browser()->profile(), temp_dir.path());
-  ASSERT_TRUE(RunMediaGalleriesTest("copy_to_access/no_access")) << message_;
-}
-
-IN_PROC_BROWSER_TEST_F(MediaGalleriesPlatformAppBrowserTest,
                        MediaGalleriesAccessAttached) {
   AttachFakeDevice();
 
   base::ListValue custom_args;
   custom_args.AppendInteger(num_galleries() + 1);
   custom_args.AppendString(kDeviceName);
 
   ASSERT_TRUE(RunMediaGalleriesTestWithArg("access_attached", custom_args))
       << message_;
 
   DetachFakeDevice();
 }
 
 IN_PROC_BROWSER_TEST_F(MediaGalleriesPlatformAppBrowserTest,
                        GetFilesystemMetadata) {
   ASSERT_TRUE(RunMediaGalleriesTest("metadata")) << message_;
 }