Media Galleries API Picasa: Make PicasaDataProvider handle async PMP and INI parsing robustly.

chrome/browser/media_galleries/fileapi/picasa/picasa_data_provider_browsertest.cc

+// Copyright 2013 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/file_util.h"
+#include "base/files/scoped_temp_dir.h"
+#include "base/memory/ref_counted.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/message_loop/message_loop.h"
+#include "base/run_loop.h"
+#include "chrome/browser/media_galleries/fileapi/media_file_system_backend.h"
+#include "chrome/browser/media_galleries/fileapi/picasa/picasa_data_provider.h"
+#include "chrome/browser/media_galleries/fileapi/safe_picasa_albums_indexer.h"
+#include "chrome/common/media_galleries/picasa_types.h"
+#include "chrome/common/media_galleries/pmp_test_helper.h"
+#include "chrome/test/base/in_process_browser_test.h"
+#include "content/public/test/test_browser_thread.h"
+
+using chrome::MediaFileSystemBackend;
+
+namespace picasa {
+
+namespace {
+
+void WriteTestAlbumTable(PmpTestHelper* test_helper,
+                         base::FilePath test_folder_1_path,
+                         base::FilePath test_folder_2_path) {
+  std::vector<uint32> category_vector;
+  category_vector.push_back(kAlbumCategoryFolder);
+  category_vector.push_back(kAlbumCategoryInvalid);
+  category_vector.push_back(kAlbumCategoryAlbum);
+  category_vector.push_back(kAlbumCategoryFolder);
+  category_vector.push_back(kAlbumCategoryAlbum);
+
+  std::vector<double> date_vector;
+  date_vector.push_back(0.0);
+  date_vector.push_back(0.0);
+  date_vector.push_back(0.0);
+  date_vector.push_back(0.0);
+  date_vector.push_back(0.0);
+
+  std::vector<std::string> filename_vector;
+  filename_vector.push_back(test_folder_1_path.AsUTF8Unsafe());
+  filename_vector.push_back("");
+  filename_vector.push_back("");
+  filename_vector.push_back(test_folder_2_path.AsUTF8Unsafe());
+  filename_vector.push_back("");
+
+  std::vector<std::string> name_vector;
+  name_vector.push_back(test_folder_1_path.BaseName().AsUTF8Unsafe());
+  name_vector.push_back("");
+  name_vector.push_back("Album 1 Name");
+  name_vector.push_back(test_folder_2_path.BaseName().AsUTF8Unsafe());
+  name_vector.push_back("Album 2 Name");
+
+  std::vector<std::string> token_vector;
+  token_vector.push_back("");
+  token_vector.push_back("");
+  token_vector.push_back(std::string(kAlbumTokenPrefix) + "uid3");
+  token_vector.push_back("");
+  token_vector.push_back(std::string(kAlbumTokenPrefix) + "uid5");
+
+  std::vector<std::string> uid_vector;
+  uid_vector.push_back("uid1");
+  uid_vector.push_back("uid2");
+  uid_vector.push_back("uid3");
+  uid_vector.push_back("uid4");
+  uid_vector.push_back("uid5");
+
+  ASSERT_TRUE(test_helper->WriteColumnFileFromVector(
+      "category", PMP_TYPE_UINT32, category_vector));
+  ASSERT_TRUE(test_helper->WriteColumnFileFromVector(
+      "date", PMP_TYPE_DOUBLE64, date_vector));
+  ASSERT_TRUE(test_helper->WriteColumnFileFromVector(
+      "filename", PMP_TYPE_STRING, filename_vector));
+  ASSERT_TRUE(test_helper->WriteColumnFileFromVector(
+      "name", PMP_TYPE_STRING, name_vector));
+  ASSERT_TRUE(test_helper->WriteColumnFileFromVector(
+      "token", PMP_TYPE_STRING, token_vector));
+  ASSERT_TRUE(test_helper->WriteColumnFileFromVector(
+      "uid", PMP_TYPE_STRING, uid_vector));
+}
+
+void WriteAlbumsImagesIndex(const base::FilePath& test_folder_1_path,
+                            const base::FilePath& test_folder_2_path) {
+  const char folder_1_test_ini[] =
+      "[InBoth.jpg]\n"
+      "albums=uid3,uid5\n"
+      "[InSecondAlbumOnly.jpg]\n"
+      "albums=uid5\n";
+  ASSERT_TRUE(
+      file_util::WriteFile(test_folder_1_path.AppendASCII(kPicasaINIFilename),
+                           folder_1_test_ini,
+                           arraysize(folder_1_test_ini)));
+
+  const char folder_2_test_ini[] =
+      "[InFirstAlbumOnly.jpg]\n"
+      "albums=uid3\n";
+  ASSERT_TRUE(
+      file_util::WriteFile(test_folder_2_path.AppendASCII(kPicasaINIFilename),
+                           folder_2_test_ini,
+                           arraysize(folder_2_test_ini)));
+}
+
+void VerifyAlbumTable(PicasaDataProvider* data_provider,
+                      base::FilePath test_folder_1_path,
+                      base::FilePath test_folder_2_path) {
+  scoped_ptr<AlbumMap> folders = data_provider->GetFolders();
+  ASSERT_TRUE(folders.get());
+  EXPECT_EQ(2u, folders->size());
+
+  AlbumMap::const_iterator folder_1 = folders->find(
+      test_folder_1_path.BaseName().AsUTF8Unsafe() + " 1899-12-30");
+  EXPECT_NE(folders->end(), folder_1);
+  EXPECT_EQ(test_folder_1_path.BaseName().AsUTF8Unsafe(),
+            folder_1->second.name);
+  EXPECT_EQ(test_folder_1_path, folder_1->second.path);
+  EXPECT_EQ("uid1", folder_1->second.uid);
+
+  AlbumMap::const_iterator folder_2 = folders->find(
+      test_folder_2_path.BaseName().AsUTF8Unsafe() + " 1899-12-30");
+  EXPECT_NE(folders->end(), folder_2);
+  EXPECT_EQ(test_folder_2_path.BaseName().AsUTF8Unsafe(),
+            folder_2->second.name);
+  EXPECT_EQ(test_folder_2_path, folder_2->second.path);
+  EXPECT_EQ("uid4", folder_2->second.uid);
+
+  scoped_ptr<AlbumMap> albums = data_provider->GetAlbums();
+  ASSERT_TRUE(albums.get());
+  EXPECT_EQ(2u, albums->size());
+
+  AlbumMap::const_iterator album_1 = albums->find("Album 1 Name 1899-12-30");
+  EXPECT_NE(albums->end(), album_1);
+  EXPECT_EQ("Album 1 Name", album_1->second.name);
+  EXPECT_EQ(base::FilePath(), album_1->second.path);
+  EXPECT_EQ("uid3", album_1->second.uid);
+
+  AlbumMap::const_iterator album_2 = albums->find("Album 2 Name 1899-12-30");
+  EXPECT_NE(albums->end(), album_2);
+  EXPECT_EQ("Album 2 Name", album_2->second.name);
+  EXPECT_EQ(base::FilePath(), album_2->second.path);
+  EXPECT_EQ("uid5", album_2->second.uid);
+}
+
+void VerifyAlbumsImagesIndex(PicasaDataProvider* data_provider,
+                             base::FilePath test_folder_1_path,
+                             base::FilePath test_folder_2_path) {
+  base::PlatformFileError error;
+  scoped_ptr<AlbumImages> album_1_images =
+      data_provider->FindAlbumImages("uid3", &error);
+  ASSERT_TRUE(album_1_images);
+  EXPECT_EQ(base::PLATFORM_FILE_OK, error);
+  EXPECT_EQ(2u, album_1_images->size());
+  EXPECT_NE(album_1_images->end(), album_1_images->find("InBoth.jpg"));
+  EXPECT_EQ(test_folder_1_path.AppendASCII("InBoth.jpg"),
+            (*album_1_images)["InBoth.jpg"]);
+  EXPECT_NE(album_1_images->end(),
+            album_1_images->find("InFirstAlbumOnly.jpg"));
+  EXPECT_EQ(test_folder_2_path.AppendASCII("InFirstAlbumOnly.jpg"),
+            (*album_1_images)["InFirstAlbumOnly.jpg"]);
+
+  scoped_ptr<AlbumImages> album_2_images =
+      data_provider->FindAlbumImages("uid5", &error);
+  ASSERT_TRUE(album_2_images);
+  EXPECT_EQ(base::PLATFORM_FILE_OK, error);
+  EXPECT_EQ(2u, album_2_images->size());
+  EXPECT_NE(album_2_images->end(), album_2_images->find("InBoth.jpg"));
+  EXPECT_EQ(test_folder_1_path.AppendASCII("InBoth.jpg"),
+            (*album_2_images)["InBoth.jpg"]);
+  EXPECT_NE(album_2_images->end(),
+            album_2_images->find("InSecondAlbumOnly.jpg"));
+  EXPECT_EQ(test_folder_1_path.AppendASCII("InSecondAlbumOnly.jpg"),
+            (*album_2_images)["InSecondAlbumOnly.jpg"]);
+}
+
+}  // namespace
+
+class PicasaDataProviderTest : public InProcessBrowserTest {
+ public:
+  PicasaDataProviderTest() : test_helper_(kPicasaAlbumTableName) {}
+  virtual ~PicasaDataProviderTest() {}
+
+ protected:
+  // Runs on the MediaTaskRunner and designed to be overridden by subclasses.
+  virtual void InitializeTestData() {}
+
+  void RunTest() {
+    DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI));
+    base::RunLoop loop;
+    quit_closure_ = loop.QuitClosure();
+    MediaFileSystemBackend::MediaTaskRunner()->PostTask(
+        FROM_HERE,
+        base::Bind(&PicasaDataProviderTest::SetupFoldersAndDataProvider,
+                   base::Unretained(this)));
+    MediaFileSystemBackend::MediaTaskRunner()->PostTask(
+        FROM_HERE,
+        base::Bind(&PicasaDataProviderTest::InitializeTestData,
+                   base::Unretained(this)));
+    MediaFileSystemBackend::MediaTaskRunner()->PostTask(
+        FROM_HERE,
+        base::Bind(&PicasaDataProviderTest::StartTestOnMediaTaskRunner,
+                   base::Unretained(this)));
+    loop.Run();
+  }
+
+  virtual PicasaDataProvider::DataType RequestedDataType() const = 0;
+
+  // Start the test. The data provider is refreshed before calling StartTest
+  // and the result of the refresh is passed in.
+  virtual void VerifyRefreshResults(bool parse_success) {};
+
+  void TestDone() {
+    DCHECK(MediaFileSystemBackend::CurrentlyOnMediaTaskRunnerThread());
+
+    // The data provider must be destructed on the MediaTaskRunner. This is done
+    // in a posted task rather than directly because TestDone is called by
+    // PicasaDataProvider. The callee should not destroy the caller.
+    MediaFileSystemBackend::MediaTaskRunner()->PostTask(
+        FROM_HERE,
+        base::Bind(&PicasaDataProviderTest::DestructDataProviderThenQuit,
+                   base::Unretained(this)));
+  }
+
+  const base::FilePath& test_folder_1_path() { return test_folder_1_.path(); }
+  const base::FilePath& test_folder_2_path() { return test_folder_2_.path(); }
+
+  PmpTestHelper* test_helper() { return &test_helper_; }
+
+  PicasaDataProvider* data_provider() const {
+    return picasa_data_provider_.get();
+  }
+
+ private:
+  void SetupFoldersAndDataProvider() {
+    DCHECK(MediaFileSystemBackend::CurrentlyOnMediaTaskRunnerThread());
+    ASSERT_TRUE(test_folder_1_.CreateUniqueTempDir());
+    ASSERT_TRUE(test_folder_2_.CreateUniqueTempDir());
+    ASSERT_TRUE(test_helper_.Init());
+    picasa_data_provider_.reset(
+        new PicasaDataProvider(test_helper_.GetTempDirPath()));
+  }
+
+  virtual void StartTestOnMediaTaskRunner() {
+    DCHECK(MediaFileSystemBackend::CurrentlyOnMediaTaskRunnerThread());
+
+    data_provider()->RefreshData(
+        RequestedDataType(),
+        base::Bind(&PicasaDataProviderTest::VerifyRefreshResults,
+                   base::Unretained(this)));
+  }
+
+  void DestructDataProviderThenQuit() {
+    DCHECK(MediaFileSystemBackend::CurrentlyOnMediaTaskRunnerThread());
+    picasa_data_provider_.reset();
+    content::BrowserThread::PostTask(
+        content::BrowserThread::UI, FROM_HERE, quit_closure_);
+  }
+
+  base::ScopedTempDir test_folder_1_;
+  base::ScopedTempDir test_folder_2_;
+
+  PmpTestHelper test_helper_;
+  scoped_ptr<PicasaDataProvider> picasa_data_provider_;
+
+  base::Closure quit_closure_;
+
+  DISALLOW_COPY_AND_ASSIGN(PicasaDataProviderTest);
+};
+
+class PicasaDataProviderNoDatabaseGetListTest : public PicasaDataProviderTest {
+ protected:
+  virtual PicasaDataProvider::DataType RequestedDataType() const OVERRIDE {
+    return PicasaDataProvider::LIST_OF_ALBUMS_AND_FOLDERS_DATA;
+  }
+  virtual void VerifyRefreshResults(bool parse_success) OVERRIDE {
+    EXPECT_FALSE(parse_success);
+    TestDone();
+  }
+};
+
+IN_PROC_BROWSER_TEST_F(PicasaDataProviderNoDatabaseGetListTest,
+                       NoDatabaseGetList) {
+  RunTest();
+}
+
+class PicasaDataProviderNoDatabaseGetAlbumsImagesTest
+    : public PicasaDataProviderTest {
+ protected:
+  virtual PicasaDataProvider::DataType RequestedDataType() const OVERRIDE {
+    return PicasaDataProvider::ALBUMS_IMAGES_DATA;
+  }
+  virtual void VerifyRefreshResults(bool parse_success) OVERRIDE {
+    EXPECT_FALSE(parse_success);
+    TestDone();
+  }
+};
+
+IN_PROC_BROWSER_TEST_F(PicasaDataProviderNoDatabaseGetAlbumsImagesTest,
+                       NoDatabaseGetAlbumsImages) {
+  RunTest();
+}
+
+class PicasaDataProviderGetListTest : public PicasaDataProviderTest {
+ protected:
+  virtual void InitializeTestData() OVERRIDE {
+    WriteTestAlbumTable(
+        test_helper(), test_folder_1_path(), test_folder_2_path());
+  }
+
+  virtual PicasaDataProvider::DataType RequestedDataType() const OVERRIDE {
+    return PicasaDataProvider::LIST_OF_ALBUMS_AND_FOLDERS_DATA;
+  }
+
+  virtual void VerifyRefreshResults(bool parse_success) OVERRIDE {
+    ASSERT_TRUE(parse_success);
+    VerifyAlbumTable(
+        data_provider(), test_folder_1_path(), test_folder_2_path());
+    TestDone();
+  }
+};
+
+IN_PROC_BROWSER_TEST_F(PicasaDataProviderGetListTest, GetListTest) {
+  RunTest();
+}
+
+class PicasaDataProviderGetAlbumsImagesTest : public PicasaDataProviderTest {
+ protected:
+  virtual void InitializeTestData() OVERRIDE {
+    WriteTestAlbumTable(
+        test_helper(), test_folder_1_path(), test_folder_2_path());
+    WriteAlbumsImagesIndex(test_folder_1_path(), test_folder_2_path());
+  }
+
+  virtual PicasaDataProvider::DataType RequestedDataType() const OVERRIDE {
+    return PicasaDataProvider::ALBUMS_IMAGES_DATA;
+  }
+
+  virtual void VerifyRefreshResults(bool parse_success) OVERRIDE {
+    ASSERT_TRUE(parse_success);
+    VerifyAlbumTable(
+        data_provider(), test_folder_1_path(), test_folder_2_path());
+    VerifyAlbumsImagesIndex(
+        data_provider(), test_folder_1_path(), test_folder_2_path());
+    TestDone();
+  }
+};
+
+IN_PROC_BROWSER_TEST_F(PicasaDataProviderGetAlbumsImagesTest,
+                       GetAlbumsImagesTest) {
+  RunTest();
+}
+
+class PicasaDataProviderMultipleMixedCallbacksTest
+    : public PicasaDataProviderTest {
+ public:
+  PicasaDataProviderMultipleMixedCallbacksTest()
+      : list_callbacks_called_(0), albums_images_callbacks_called_(0) {}
+
+  virtual void InitializeTestData() OVERRIDE {
+    WriteTestAlbumTable(
+        test_helper(), test_folder_1_path(), test_folder_2_path());
+    WriteAlbumsImagesIndex(test_folder_1_path(), test_folder_2_path());
+  }
+
+  virtual PicasaDataProvider::DataType RequestedDataType() const OVERRIDE {
+    return PicasaDataProvider::ALBUMS_IMAGES_DATA;
+  }
+
+ protected:
+  virtual void ListCallback(int expected_list_callbacks_called,
+                            bool parse_success) {
+    ASSERT_TRUE(parse_success);
+    ASSERT_EQ(expected_list_callbacks_called, ++list_callbacks_called_);
+    VerifyAlbumTable(
+        data_provider(), test_folder_1_path(), test_folder_2_path());
+    CheckTestDone();
+  }
+
+  virtual void AlbumsImagesCallback(int expected_albums_images_callbacks_called,
+                                    bool parse_success) {
+    ASSERT_TRUE(parse_success);
+    ASSERT_EQ(expected_albums_images_callbacks_called,
+              ++albums_images_callbacks_called_);
+    VerifyAlbumsImagesIndex(
+        data_provider(), test_folder_1_path(), test_folder_2_path());
+    CheckTestDone();
+  }
+
+ private:
+  void CheckTestDone() {
+    ASSERT_LE(list_callbacks_called_, 2);
+    ASSERT_LE(albums_images_callbacks_called_, 2);
+    if (list_callbacks_called_ == 2 && albums_images_callbacks_called_ == 2)
+      TestDone();
+  }
+
+  virtual void StartTestOnMediaTaskRunner() OVERRIDE {
+    DCHECK(MediaFileSystemBackend::CurrentlyOnMediaTaskRunnerThread());
+
+    data_provider()->RefreshData(
+        PicasaDataProvider::LIST_OF_ALBUMS_AND_FOLDERS_DATA,
+        base::Bind(&PicasaDataProviderMultipleMixedCallbacksTest::ListCallback,
+                   base::Unretained(this),
+                   1));
+    data_provider()->RefreshData(
+        PicasaDataProvider::ALBUMS_IMAGES_DATA,
+        base::Bind(
+            &PicasaDataProviderMultipleMixedCallbacksTest::AlbumsImagesCallback,
+            base::Unretained(this),
+            1));
+    data_provider()->RefreshData(
+        PicasaDataProvider::LIST_OF_ALBUMS_AND_FOLDERS_DATA,
+        base::Bind(&PicasaDataProviderMultipleMixedCallbacksTest::ListCallback,
+                   base::Unretained(this),
+                   2));
+    data_provider()->RefreshData(
+        PicasaDataProvider::ALBUMS_IMAGES_DATA,
+        base::Bind(
+            &PicasaDataProviderMultipleMixedCallbacksTest::AlbumsImagesCallback,
+            base::Unretained(this),
+            2));
+  }
+
+  int list_callbacks_called_;
+  int albums_images_callbacks_called_;
+};
+
+IN_PROC_BROWSER_TEST_F(PicasaDataProviderMultipleMixedCallbacksTest,
+                       MultipleMixedCallbacks) {
+  RunTest();
+}
+
+class PicasaDataProviderInvalidateSimpleTest : public PicasaDataProviderTest {
+ protected:
+  virtual void FirstListCallback(bool parse_success) {
+    ASSERT_FALSE(parse_success);
+    WriteTestAlbumTable(
+        test_helper(), test_folder_1_path(), test_folder_2_path());
+
+    // TODO(tommycli): Remove this line once database is under file watch.
+    data_provider()->InvalidateData();
+
+    // Have to post this, otherwise this will run the callback immediately.
+    MediaFileSystemBackend::MediaTaskRunner()->PostTask(
+        FROM_HERE,
+        base::Bind(
+            &PicasaDataProvider::RefreshData,
+            base::Unretained(data_provider()),
+            RequestedDataType(),
+            base::Bind(
+                &PicasaDataProviderInvalidateSimpleTest::SecondListCallback,
+                base::Unretained(this))));
+  }
+
+  virtual void SecondListCallback(bool parse_success) {
+    ASSERT_TRUE(parse_success);
+    VerifyAlbumTable(
+        data_provider(), test_folder_1_path(), test_folder_2_path());
+    TestDone();
+  }
+
+  virtual PicasaDataProvider::DataType RequestedDataType() const OVERRIDE {
+    return PicasaDataProvider::ALBUMS_IMAGES_DATA;
+  }
+
+ private:
+  virtual void StartTestOnMediaTaskRunner() OVERRIDE {
+    DCHECK(MediaFileSystemBackend::CurrentlyOnMediaTaskRunnerThread());
+
+    data_provider()->RefreshData(
+        RequestedDataType(),
+        base::Bind(&PicasaDataProviderInvalidateSimpleTest::FirstListCallback,
+                   base::Unretained(this)));
+  }
+};
+
+IN_PROC_BROWSER_TEST_F(PicasaDataProviderInvalidateSimpleTest,
+                       InvalidateSimpleTest) {
+  RunTest();
+}
+
+class PicasaDataProviderInvalidateInflightTableReaderTest
+    : public PicasaDataProviderGetListTest {
+ private:
+  virtual void StartTestOnMediaTaskRunner() OVERRIDE {
+    DCHECK(MediaFileSystemBackend::CurrentlyOnMediaTaskRunnerThread());
+
+    // Temporarily empty the database path to guarantee that the first utility
+    // process will fail to read the database.
+    data_provider()->SetDatabasePathForTesting(base::FilePath());
+    data_provider()->RefreshData(
+        RequestedDataType(),
+        base::Bind(&PicasaDataProviderInvalidateInflightTableReaderTest::
+                       VerifyRefreshResults,
+                   base::Unretained(this)));
+
+    // Now restore the database path and invalidate the inflight table reader.
+    data_provider()->SetDatabasePathForTesting(test_helper()->GetTempDirPath());
+    data_provider()->InvalidateData();
+
+    // VerifyRefreshResults callback should receive correct results now.
+  }
+};
+
+IN_PROC_BROWSER_TEST_F(PicasaDataProviderInvalidateInflightTableReaderTest,
+                       InvalidateInflightTableReaderTest) {
+  RunTest();
+}
+
+class PicasaDataProviderInvalidateInflightAlbumsIndexerTest
+    : public PicasaDataProviderGetAlbumsImagesTest {
+ protected:
+  virtual void ListCallback(bool parse_success) {
+    ASSERT_TRUE(parse_success);
+
+    // Empty the album maps to guarantee that the first utility process will
+    // give incorrect results.
+    data_provider()->SetAlbumMapsForTesting(AlbumMap(), AlbumMap());
+    data_provider()->RefreshData(
+        PicasaDataProvider::ALBUMS_IMAGES_DATA,
+        base::Bind(&PicasaDataProviderInvalidateInflightAlbumsIndexerTest::
+                       VerifyRefreshResults,
+                   base::Unretained(this)));
+
+    // Now invalidate all the data. The album maps will be re-read.
+    data_provider()->InvalidateData();
+
+    // VerifyRefreshResults callback should receive correct results now.
+  }
+
+ private:
+  virtual void StartTestOnMediaTaskRunner() OVERRIDE {
+    DCHECK(MediaFileSystemBackend::CurrentlyOnMediaTaskRunnerThread());
+
+    data_provider()->RefreshData(
+        PicasaDataProvider::LIST_OF_ALBUMS_AND_FOLDERS_DATA,
+        base::Bind(&PicasaDataProviderInvalidateInflightAlbumsIndexerTest::
+                       ListCallback,
+                   base::Unretained(this)));
+  }
+};
+
+IN_PROC_BROWSER_TEST_F(PicasaDataProviderInvalidateInflightAlbumsIndexerTest,
+                       InvalidateInflightAlbumsIndexerTest) {
+  RunTest();
+}
+
+}  // namespace picasa