Expose gallery watching functionality to the public mediaGalleries API.

chrome/browser/extensions/api/media_galleries/media_galleries_watch_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.
 //
-// MediaGalleriesPrivate gallery watch API browser tests.
+// MediaGalleries gallery watch API browser tests.
 
 #include "base/file_util.h"
 #include "base/files/file_path.h"
 #include "base/files/file_path_watcher.h"
 #include "base/path_service.h"
 #include "base/run_loop.h"
 #include "base/strings/utf_string_conversions.h"
 #include "build/build_config.h"
 #include "chrome/browser/browser_process.h"
 #include "chrome/browser/extensions/extension_apitest.h"
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/browser/extensions/extension_test_message_listener.h"
 #include "chrome/browser/media_galleries/media_file_system_registry.h"
 #include "chrome/browser/media_galleries/media_galleries_preferences.h"
 #include "chrome/browser/media_galleries/media_galleries_test_util.h"
 #include "chrome/common/chrome_paths.h"
 #include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/render_view_host.h"
 #include "extensions/browser/extension_system.h"
 #include "extensions/common/extension.h"
 #include "extensions/common/switches.h"
 
 namespace {
 
 // Id of test extension from
 // chrome/test/data/extensions/api_test/|kTestExtensionPath|
 const char kTestExtensionId[] = "gceegfkgibmgpfopknlcgleimclbknie";
-const char kTestExtensionPath[] = "media_galleries_private/gallerywatch";
+const char kTestExtensionPath[] = "media_galleries/gallerywatch";
 
 // JS commands.
 const char kGetAllWatchedGalleryIdsCmd[] = "getAllWatchedGalleryIds()";
 const char kGetMediaFileSystemsCmd[] = "getMediaFileSystems()";
 const char kSetupWatchOnValidGalleriesCmd[] = "setupWatchOnValidGalleries()";
+const char kSetupWatchOnUnlistenedValidGalleriesCmd[] =
+    "setupWatchOnUnlistenedValidGalleries()";
 const char kAddGalleryChangedListenerCmd[] = "addGalleryChangedListener()";
 const char kRemoveAllGalleryWatchCmd[] = "removeAllGalleryWatch()";
 const char kRemoveGalleryChangedListenerCmd[] =
     "removeGalleryChangedListener()";
 const char kRemoveGalleryWatchCmd[] = "removeGalleryWatch()";
 const char kSetupWatchOnInvalidGalleryCmd[] = "setupWatchOnInvalidGallery()";
 
 // And JS reply messages.
 const char kAddGalleryWatchOK[] = "add_gallery_watch_ok";
 const char kGetAllGalleryWatchOK[] = "get_all_gallery_watch_ok";
 const char kGetMediaFileSystemsCallbackOK[] =
     "get_media_file_systems_callback_ok";
 const char kGetMediaFileSystemsOK[] = "get_media_file_systems_ok";
 const char kAddGalleryChangedListenerOK[] = "add_gallery_changed_listener_ok";
 const char kRemoveAllGalleryWatchOK[] = "remove_all_gallery_watch_ok";
 const char kRemoveGalleryChangedListenerOK[] =
     "remove_gallery_changed_listener_ok";
 const char kRemoveGalleryWatchOK[] = "remove_gallery_watch_ok";
 
 // Test reply messages.
 const char kNoGalleryWatchesInstalled[] = "gallery_watchers_does_not_exists";
 const char kAddGalleryWatchRequestFailed[] = "add_watch_request_failed";
+const char kAddGalleryWatchRequestRuntimeError[] =
+    "add_watch_request_runtime_error";
 const char kAddGalleryWatchRequestSucceeded[] = "add_watch_request_succeeded";
 const char kGalleryChangedEventReceived[] = "gallery_changed_event_received";
 const char kGalleryWatchesCheck[] = "gallery_watcher_checks";
 
 }  // namespace
 
 
 ///////////////////////////////////////////////////////////////////////////////
-//                 MediaGalleriesPrivateGalleryWatchApiTest                  //
+//                 MediaGalleriesGalleryWatchApiTest                         //
 ///////////////////////////////////////////////////////////////////////////////
 
-class MediaGalleriesPrivateGalleryWatchApiTest : public ExtensionApiTest {
+class MediaGalleriesGalleryWatchApiTest : public ExtensionApiTest {
  public:
-  MediaGalleriesPrivateGalleryWatchApiTest()
+  MediaGalleriesGalleryWatchApiTest()
       : extension_(NULL),
         background_host_(NULL) {
   }
-  virtual ~MediaGalleriesPrivateGalleryWatchApiTest() {}
+  virtual ~MediaGalleriesGalleryWatchApiTest() {}
 
  protected:
   // ExtensionApiTest overrides.
   virtual void SetUpCommandLine(CommandLine* command_line) OVERRIDE {
     ExtensionApiTest::SetUpCommandLine(command_line);
     command_line->AppendSwitchASCII(
         extensions::switches::kWhitelistedExtensionID,
         kTestExtensionId);
   }
   virtual void SetUpOnMainThread() OVERRIDE {
@@ skipping 87 matching lines @@
   }
 
   scoped_ptr<EnsureMediaDirectoriesExists> ensure_media_directories_exists_;
 
   base::ScopedTempDir test_gallery_;
 
   const extensions::Extension* extension_;
 
   content::RenderViewHost* background_host_;
 
-  DISALLOW_COPY_AND_ASSIGN(MediaGalleriesPrivateGalleryWatchApiTest);
+  DISALLOW_COPY_AND_ASSIGN(MediaGalleriesGalleryWatchApiTest);
 };
 
 // Crashing on OSX.
 #if defined(OS_MACOSX)

[tommycli, 2014/08/19 16:36:03]

This should not be MAYBE anymore. We should fix the OSX crash. I could
potentially be persuaded that we can do that in a separate patch though.

[Oren Blasberg, 2014/08/20 22:59:37]

Will do that in separate cl.

 #define MAYBE_BasicGalleryWatch DISABLED_BasicGalleryWatch
 #else
 #define MAYBE_BasicGalleryWatch BasicGalleryWatch
 #endif
-IN_PROC_BROWSER_TEST_F(MediaGalleriesPrivateGalleryWatchApiTest,
+IN_PROC_BROWSER_TEST_F(MediaGalleriesGalleryWatchApiTest,
                        MAYBE_BasicGalleryWatch) {
-  SetupGalleryWatches();
 
   // Add gallery watch listener.
   ExecuteCmdAndCheckReply(kAddGalleryChangedListenerCmd,
                           kAddGalleryChangedListenerOK);
 
+  SetupGalleryWatches();
+
   // Modify gallery contents.
   ExtensionTestMessageListener gallery_change_event_received(
       kGalleryChangedEventReceived, false  /* no reply */);
+
   ASSERT_TRUE(AddNewFileInTestGallery());
   if (GalleryWatchesSupported())
     EXPECT_TRUE(gallery_change_event_received.WaitUntilSatisfied());
 
   // Remove gallery watch listener.
   ExecuteCmdAndCheckReply(kRemoveGalleryChangedListenerCmd,
                           kRemoveGalleryChangedListenerOK);
 
   // Remove gallery watch request.
   if (GalleryWatchesSupported())
     ExecuteCmdAndCheckReply(kRemoveGalleryWatchCmd, kRemoveGalleryWatchOK);
 }
 
 // http://crbug.com/390979
-IN_PROC_BROWSER_TEST_F(MediaGalleriesPrivateGalleryWatchApiTest,
+IN_PROC_BROWSER_TEST_F(MediaGalleriesGalleryWatchApiTest,
                        DISABLED_RemoveListenerAndModifyGallery) {

[tommycli, 2014/08/19 16:36:03]

This should not be DISABLED anymore, since we are overhauling the test.

[Oren Blasberg, 2014/08/20 22:59:37]

Will remove it in followup CL.

   if (!GalleryWatchesSupported())
     return;
 
   SetupGalleryWatches();
 
   // Add a gallery watch listener.
   ExecuteCmdAndCheckReply(kAddGalleryChangedListenerCmd,
                           kAddGalleryChangedListenerOK);
   // Modify gallery contents.
   ExtensionTestMessageListener gallery_change_event_received(
       kGalleryChangedEventReceived, false  /* no reply */);
   ASSERT_TRUE(AddNewFileInTestGallery());
   EXPECT_TRUE(gallery_change_event_received.WaitUntilSatisfied());
 
   // Remove gallery watch listener.
   ExecuteCmdAndCheckReply(kRemoveGalleryChangedListenerCmd,
                           kRemoveGalleryChangedListenerOK);
 
   // No listener, modify gallery contents.
   ASSERT_TRUE(AddNewFileInTestGallery());
 
   // Remove gallery watch.
   ExecuteCmdAndCheckReply(kRemoveGalleryWatchCmd, kRemoveGalleryWatchOK);
 }
 
-IN_PROC_BROWSER_TEST_F(MediaGalleriesPrivateGalleryWatchApiTest,
+IN_PROC_BROWSER_TEST_F(MediaGalleriesGalleryWatchApiTest,
                        SetupGalleryWatchWithoutListeners) {
   if (!GalleryWatchesSupported())
     return;
 
-  SetupGalleryWatches();
-
-  // No listeners, modify gallery contents.
-  ExtensionTestMessageListener gallery_change_event_received(
-      kGalleryChangedEventReceived, false  /* no reply */);
-  ASSERT_TRUE(AddNewFileInTestGallery());
-
-  // Remove gallery watch.
-  ExecuteCmdAndCheckReply(kRemoveGalleryWatchCmd, kRemoveGalleryWatchOK);
+  ExtensionTestMessageListener add_watch_runtime_error_received(
+      kAddGalleryWatchRequestRuntimeError, false /* no reply */);
+  ExecuteCmdAndCheckReply(

[tommycli, 2014/08/19 16:36:02]

This concerns me since you should get multiple messages (one for each gallery),
but we proceed after getting one right?

[Oren Blasberg, 2014/08/20 22:59:37]

Done.

+      kSetupWatchOnUnlistenedValidGalleriesCmd, kAddGalleryWatchOK);
+  EXPECT_TRUE(add_watch_runtime_error_received.WaitUntilSatisfied());
 }
 
-IN_PROC_BROWSER_TEST_F(MediaGalleriesPrivateGalleryWatchApiTest,
+IN_PROC_BROWSER_TEST_F(MediaGalleriesGalleryWatchApiTest,
                        SetupGalleryChangedListenerWithoutWatchers) {
   // Add gallery watch listener.
   ExecuteCmdAndCheckReply(kAddGalleryChangedListenerCmd,
                           kAddGalleryChangedListenerOK);
 
   // Modify gallery contents. Listener should not get called because add watch
   // request was not called.
   ExtensionTestMessageListener gallery_change_event_received(
       kGalleryChangedEventReceived, false  /* no reply */);
   ASSERT_TRUE(AddNewFileInTestGallery());
 
   // Remove gallery watch listener.
   ExecuteCmdAndCheckReply(kRemoveGalleryChangedListenerCmd,
                           kRemoveGalleryChangedListenerOK);
 }
 
-IN_PROC_BROWSER_TEST_F(MediaGalleriesPrivateGalleryWatchApiTest,
+IN_PROC_BROWSER_TEST_F(MediaGalleriesGalleryWatchApiTest,
                        SetupWatchOnInvalidGallery) {
+  // Add gallery watch listener.
+  ExecuteCmdAndCheckReply(kAddGalleryChangedListenerCmd,
+                          kAddGalleryChangedListenerOK);
   // Set up a invalid gallery watch.
   ExtensionTestMessageListener invalid_gallery_watch_request_finished(
       kAddGalleryWatchRequestFailed, false  /* no reply */);
   ExecuteCmdAndCheckReply(kSetupWatchOnInvalidGalleryCmd, kAddGalleryWatchOK);
   EXPECT_TRUE(invalid_gallery_watch_request_finished.WaitUntilSatisfied());
 }
 
-IN_PROC_BROWSER_TEST_F(MediaGalleriesPrivateGalleryWatchApiTest,
+IN_PROC_BROWSER_TEST_F(MediaGalleriesGalleryWatchApiTest,
                        GetAllGalleryWatch) {
+  // Add gallery watch listener.
+  ExecuteCmdAndCheckReply(kAddGalleryChangedListenerCmd,
+                          kAddGalleryChangedListenerOK);
+
   // Gallery watchers are not yet added.
-  // chrome.mediaGalleriesPrivate.getAllGalleryWatch should return an empty
+  // chrome.mediaGalleries.getAllGalleryWatch should return an empty
   // list.
   ExtensionTestMessageListener initial_get_all_check_finished(
       kNoGalleryWatchesInstalled, false  /* no reply */);
   ExecuteCmdAndCheckReply(kGetAllWatchedGalleryIdsCmd, kGetAllGalleryWatchOK);
   EXPECT_TRUE(initial_get_all_check_finished.WaitUntilSatisfied());
 
   if (!GalleryWatchesSupported())
     return;
 
   SetupGalleryWatches();
 
-  // chrome.mediaGalleriesPrivate.getAllGalleryWatch should return the
+  // chrome.mediaGalleries.getAllGalleryWatch should return the
   // gallery identifiers.
   ExtensionTestMessageListener get_all_watched_galleries_finished(
       kGalleryWatchesCheck, false  /* no reply */);
   ExecuteCmdAndCheckReply(kGetAllWatchedGalleryIdsCmd, kGetAllGalleryWatchOK);
   EXPECT_TRUE(get_all_watched_galleries_finished.WaitUntilSatisfied());
 
   // Remove gallery watch request.
   ExecuteCmdAndCheckReply(kRemoveGalleryWatchCmd, kRemoveGalleryWatchOK);
 
   // Gallery watchers removed.
-  // chrome.mediaGalleriesPrivate.getAllGalleryWatch() should return an empty
+  // chrome.mediaGalleries.getAllGalleryWatch() should return an empty
   // list.
   ExtensionTestMessageListener final_get_all_check_finished(
       kNoGalleryWatchesInstalled, false  /* no reply */);
   ExecuteCmdAndCheckReply(kGetAllWatchedGalleryIdsCmd, kGetAllGalleryWatchOK);
   EXPECT_TRUE(final_get_all_check_finished.WaitUntilSatisfied());
 }
 
-IN_PROC_BROWSER_TEST_F(MediaGalleriesPrivateGalleryWatchApiTest,
+IN_PROC_BROWSER_TEST_F(MediaGalleriesGalleryWatchApiTest,
                        RemoveAllGalleryWatch) {
+  // Add gallery watch listener.
+  ExecuteCmdAndCheckReply(kAddGalleryChangedListenerCmd,
+                          kAddGalleryChangedListenerOK);
+
   if (!GalleryWatchesSupported())
     return;
 
   SetupGalleryWatches();
 
-  // chrome.mediaGalleriesPrivate.getAllGalleryWatch should return the watched
+  // chrome.mediaGalleries.getAllGalleryWatch should return the watched
   // gallery identifiers.
   ExtensionTestMessageListener get_all_watched_galleries_finished(
       kGalleryWatchesCheck, false  /* no reply */);
   ExecuteCmdAndCheckReply(kGetAllWatchedGalleryIdsCmd, kGetAllGalleryWatchOK);
   EXPECT_TRUE(get_all_watched_galleries_finished.WaitUntilSatisfied());
 
   // Remove all gallery watchers.
   ExecuteCmdAndCheckReply(kRemoveAllGalleryWatchCmd, kRemoveAllGalleryWatchOK);
 
-  // Gallery watchers removed. chrome.mediaGalleriesPrivate.getAllGalleryWatch
+  // Gallery watchers removed. chrome.mediaGalleries.getAllGalleryWatch
   // should return an empty list.
   ExtensionTestMessageListener final_get_all_check_finished(
       kNoGalleryWatchesInstalled, false  /* no reply */);
   ExecuteCmdAndCheckReply(kGetAllWatchedGalleryIdsCmd, kGetAllGalleryWatchOK);
   EXPECT_TRUE(final_get_all_check_finished.WaitUntilSatisfied());
 }