1a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)// Copyright 2013 The Chromium Authors. All rights reserved. 2a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 3a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)// found in the LICENSE file. 4a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 5a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#ifndef CHROME_BROWSER_EXTENSIONS_API_IMAGE_WRITER_PRIVATE_TEST_UTILS_H_ 6a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#define CHROME_BROWSER_EXTENSIONS_API_IMAGE_WRITER_PRIVATE_TEST_UTILS_H_ 7a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 81320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci#include "base/files/file_util.h" 95d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)#include "base/files/scoped_temp_dir.h" 10a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#include "base/message_loop/message_loop.h" 11a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#include "base/run_loop.h" 12a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)#include "chrome/browser/extensions/api/image_writer_private/image_writer_utility_client.h" 13a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#include "chrome/browser/extensions/api/image_writer_private/operation_manager.h" 14a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#include "content/public/test/test_browser_thread_bundle.h" 15a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)#include "content/public/test/test_utils.h" 16a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#include "testing/gmock/include/gmock/gmock.h" 17a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#include "testing/gtest/include/gtest/gtest.h" 18a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 19cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#if defined(OS_CHROMEOS) 20cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "chromeos/disks/disk_mount_manager.h" 21cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#include "chromeos/disks/mock_disk_mount_manager.h" 22cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#endif 23cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 24a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)namespace extensions { 25a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)namespace image_writer { 26a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 27a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)const char kDummyExtensionId[] = "DummyExtension"; 28a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 295d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// Default file size to use in tests. Currently 32kB. 305d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)const int kTestFileSize = 32 * 1024; 315d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// Pattern to use in the image file. 325d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)const int kImagePattern = 0x55555555; // 01010101 335d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// Pattern to use in the device file. 345d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)const int kDevicePattern = 0xAAAAAAAA; // 10101010 355d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 365d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// A mock around the operation manager for tracking callbacks. Note that there 375d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)// are non-virtual methods on this class that should not be called in tests. 38a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)class MockOperationManager : public OperationManager { 39a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) public: 40a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) MockOperationManager(); 41a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) explicit MockOperationManager(content::BrowserContext* context); 42a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) virtual ~MockOperationManager(); 43a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 44a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) MOCK_METHOD3(OnProgress, void(const ExtensionId& extension_id, 45a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) image_writer_api::Stage stage, 46a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) int progress)); 47a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) // Callback for completion events. 48a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) MOCK_METHOD1(OnComplete, void(const std::string& extension_id)); 49a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 50a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) // Callback for error events. 51a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) MOCK_METHOD4(OnError, void(const ExtensionId& extension_id, 52a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) image_writer_api::Stage stage, 53a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) int progress, 54a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) const std::string& error_message)); 55a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)}; 56a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 57cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#if defined(OS_CHROMEOS) 58cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// A fake for the DiskMountManager that will successfully call the unmount 59cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)// callback. 60cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)class FakeDiskMountManager : public chromeos::disks::MockDiskMountManager { 61cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) public: 62cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) FakeDiskMountManager(); 63cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual ~FakeDiskMountManager(); 64cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 65cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) virtual void UnmountDeviceRecursively( 66cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const std::string& device_path, 67cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) const UnmountDeviceRecursivelyCallbackType& callback) OVERRIDE; 68cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 69cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) private: 70cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) DiskMap disks_; 71cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)}; 72cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles)#endif 73cedac228d2dd51db4b79ea1e72c7f249408ee061Torne (Richard Coles) 74a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles)class FakeImageWriterClient : public ImageWriterUtilityClient { 75a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) public: 76a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) FakeImageWriterClient(); 77a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 78a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) virtual void Write(const ProgressCallback& progress_callback, 79a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) const SuccessCallback& success_callback, 80a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) const ErrorCallback& error_callback, 81a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) const base::FilePath& source, 82a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) const base::FilePath& target) OVERRIDE; 83a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 84a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) virtual void Verify(const ProgressCallback& progress_callback, 85a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) const SuccessCallback& success_callback, 86a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) const ErrorCallback& error_callback, 87a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) const base::FilePath& source, 88a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) const base::FilePath& target) OVERRIDE; 89a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 90a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) virtual void Cancel(const CancelCallback& cancel_callback) OVERRIDE; 91a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 92a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) virtual void Shutdown() OVERRIDE; 93a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 94116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Sets a callback for when a Write call is made. 95116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch void SetWriteCallback(const base::Closure& write_callback); 96116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Sets a callback for when a Verify call is made. 97116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch void SetVerifyCallback(const base::Closure& verify_callback); 98116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 99116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Triggers the progress callback. 100a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) void Progress(int64 progress); 101116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Triggers the success callback. 102a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) void Success(); 103116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Triggers the error callback. 104a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) void Error(const std::string& message); 105116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Triggers the cancel callback. 106a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) void Cancel(); 107a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 108a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) private: 109a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) virtual ~FakeImageWriterClient(); 110a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 111a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) ProgressCallback progress_callback_; 112a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) SuccessCallback success_callback_; 113a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) ErrorCallback error_callback_; 114a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) CancelCallback cancel_callback_; 1155d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 116116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch base::Closure write_callback_; 117116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch base::Closure verify_callback_; 118116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch}; 119a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 120116680a4aac90f2aa7413d9095a592090648e557Ben Murdochclass ImageWriterTestUtils { 121116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch public: 122116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch ImageWriterTestUtils(); 123116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch virtual ~ImageWriterTestUtils(); 124a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 125a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) // Verifies that the data in image_path was written to the file at 126a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) // device_path. This is different from base::ContentsEqual because the device 127a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) // may be larger than the image. 128116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch bool ImageWrittenToDevice(); 1295d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1305d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // Fills |file| with |length| bytes of |pattern|, overwriting any existing 1315d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) // data. 1325d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) bool FillFile(const base::FilePath& file, 1335d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const int pattern, 1345d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) const int length); 1355d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 136116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Set up the test utils, creating temporary folders and such. 137116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Note that browser tests should use the alternate form and pass "true" as an 138116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // argument. 139116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch virtual void SetUp(); 140116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // Set up the test utils, creating temporary folders and such. If 141116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // |is_browser_test| is true then it will use alternate initialization 142116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // appropriate for a browser test. This should be run in 143116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch // |SetUpInProcessBrowserTestFixture|. 144116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch virtual void SetUp(bool is_browser_test); 145116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 146116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch virtual void TearDown(); 147116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 148116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch const base::FilePath& GetTempDir(); 149116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch const base::FilePath& GetImagePath(); 150116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch const base::FilePath& GetDevicePath(); 151116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 152116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch#if !defined(OS_CHROMEOS) 153116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch FakeImageWriterClient* GetUtilityClient(); 154116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch#endif 155116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 156116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch protected: 157a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) base::ScopedTempDir temp_dir_; 158a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) base::FilePath test_image_path_; 159a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) base::FilePath test_device_path_; 160a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) 161116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch#if !defined(OS_CHROMEOS) 162116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch scoped_refptr<FakeImageWriterClient> client_; 163116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch#endif 164116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch}; 165116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 166116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch// Base class for unit tests that manages creating image and device files. 167116680a4aac90f2aa7413d9095a592090648e557Ben Murdochclass ImageWriterUnitTestBase : public testing::Test { 168116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch protected: 169116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch ImageWriterUnitTestBase(); 170116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch virtual ~ImageWriterUnitTestBase(); 171116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 172116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch virtual void SetUp() OVERRIDE; 173116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch virtual void TearDown() OVERRIDE; 174116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 175116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch ImageWriterTestUtils test_utils_; 176116680a4aac90f2aa7413d9095a592090648e557Ben Murdoch 177a1401311d1ab56c4ed0a474bd38c108f75cb0cd9Torne (Richard Coles) private: 178a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) content::TestBrowserThreadBundle thread_bundle_; 179a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)}; 180a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 181a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)} // namespace image_writer 182a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)} // namespace extensions 183a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles) 184a3f6a49ab37290eeeb8db0f41ec0f1cb74a68be7Torne (Richard Coles)#endif // CHROME_BROWSER_EXTENSIONS_API_IMAGE_WRITER_PRIVATE_TEST_UTILS_H_ 185