Rename DefaultComponentInstaller to ComponentInstaller.
R: [email protected]
Bug: 767550
Change-Id: Ifac822a561e4769da625530e0e06a22c7ce74ba5
Reviewed-on: https://chromium-review.googlesource.com/677472
Reviewed-by: Joshua Pawlicki <[email protected]>
Reviewed-by: Chris Hamilton <[email protected]>
Commit-Queue: Sorin Jianu <[email protected]>
Cr-Commit-Position: refs/heads/master@{#504076}
diff --git a/components/component_updater/component_installer_unittest.cc b/components/component_updater/component_installer_unittest.cc
new file mode 100644
index 0000000..ec4aad9
--- /dev/null
+++ b/components/component_updater/component_installer_unittest.cc
@@ -0,0 +1,328 @@
+// Copyright 2016 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 <iterator>
+#include <string>
+#include <utility>
+#include <vector>
+
+#include "base/callback.h"
+#include "base/files/file_path.h"
+#include "base/files/file_util.h"
+#include "base/macros.h"
+#include "base/memory/ptr_util.h"
+#include "base/memory/ref_counted.h"
+#include "base/path_service.h"
+#include "base/run_loop.h"
+#include "base/task_scheduler/post_task.h"
+#include "base/test/scoped_path_override.h"
+#include "base/test/scoped_task_environment.h"
+#include "base/threading/thread_task_runner_handle.h"
+#include "base/version.h"
+#include "components/component_updater/component_installer.h"
+#include "components/component_updater/component_updater_paths.h"
+#include "components/component_updater/component_updater_service.h"
+#include "components/component_updater/component_updater_service_internal.h"
+#include "components/update_client/component_unpacker.h"
+#include "components/update_client/crx_update_item.h"
+#include "components/update_client/test_configurator.h"
+#include "components/update_client/update_client.h"
+#include "components/update_client/update_client_errors.h"
+#include "testing/gmock/include/gmock/gmock.h"
+#include "testing/gtest/include/gtest/gtest.h"
+
+using ComponentUnpacker = update_client::ComponentUnpacker;
+using Configurator = update_client::Configurator;
+using CrxUpdateItem = update_client::CrxUpdateItem;
+using TestConfigurator = update_client::TestConfigurator;
+using UpdateClient = update_client::UpdateClient;
+
+using ::testing::_;
+using ::testing::Invoke;
+
+namespace component_updater {
+
+namespace {
+
+// This hash corresponds to jebgalgnebhfojomionfpkfelancnnkf.crx.
+const uint8_t kSha256Hash[] = {0x94, 0x16, 0x0b, 0x6d, 0x41, 0x75, 0xe9, 0xec,
+ 0x8e, 0xd5, 0xfa, 0x54, 0xb0, 0xd2, 0xdd, 0xa5,
+ 0x6e, 0x05, 0x6b, 0xe8, 0x73, 0x47, 0xf6, 0xc4,
+ 0x11, 0x9f, 0xbc, 0xb3, 0x09, 0xb3, 0x5b, 0x40};
+
+constexpr base::FilePath::CharType relative_install_dir[] =
+ FILE_PATH_LITERAL("fake");
+
+base::FilePath test_file(const char* file) {
+ base::FilePath path;
+ PathService::Get(base::DIR_SOURCE_ROOT, &path);
+ return path.AppendASCII("components")
+ .AppendASCII("test")
+ .AppendASCII("data")
+ .AppendASCII("update_client")
+ .AppendASCII(file);
+}
+
+class MockUpdateClient : public UpdateClient {
+ public:
+ MockUpdateClient() {}
+ MOCK_METHOD1(AddObserver, void(Observer* observer));
+ MOCK_METHOD1(RemoveObserver, void(Observer* observer));
+ MOCK_METHOD3(Install,
+ void(const std::string& id,
+ const CrxDataCallback& crx_data_callback,
+ const Callback& callback));
+ MOCK_METHOD3(Update,
+ void(const std::vector<std::string>& ids,
+ const CrxDataCallback& crx_data_callback,
+ const Callback& callback));
+ MOCK_CONST_METHOD2(GetCrxUpdateState,
+ bool(const std::string& id, CrxUpdateItem* update_item));
+ MOCK_CONST_METHOD1(IsUpdating, bool(const std::string& id));
+ MOCK_METHOD0(Stop, void());
+ MOCK_METHOD4(SendUninstallPing,
+ void(const std::string& id,
+ const base::Version& version,
+ int reason,
+ const Callback& callback));
+
+ private:
+ ~MockUpdateClient() override {}
+};
+
+class FakeInstallerPolicy : public ComponentInstallerPolicy {
+ public:
+ FakeInstallerPolicy() {}
+ ~FakeInstallerPolicy() override {}
+
+ bool VerifyInstallation(const base::DictionaryValue& manifest,
+ const base::FilePath& dir) const override {
+ return true;
+ }
+
+ bool SupportsGroupPolicyEnabledComponentUpdates() const override {
+ return true;
+ }
+
+ bool RequiresNetworkEncryption() const override { return true; }
+
+ update_client::CrxInstaller::Result OnCustomInstall(
+ const base::DictionaryValue& manifest,
+ const base::FilePath& install_dir) override {
+ return update_client::CrxInstaller::Result(0);
+ }
+
+ void ComponentReady(
+ const base::Version& version,
+ const base::FilePath& install_dir,
+ std::unique_ptr<base::DictionaryValue> manifest) override {}
+
+ base::FilePath GetRelativeInstallDir() const override {
+ return base::FilePath(relative_install_dir);
+ }
+
+ void GetHash(std::vector<uint8_t>* hash) const override { GetPkHash(hash); }
+
+ std::string GetName() const override { return "fake name"; }
+
+ update_client::InstallerAttributes GetInstallerAttributes() const override {
+ update_client::InstallerAttributes installer_attributes;
+ installer_attributes["ap"] = "fake-ap";
+ installer_attributes["is-enterprise"] = "1";
+ return installer_attributes;
+ }
+
+ std::vector<std::string> GetMimeTypes() const override {
+ return std::vector<std::string>();
+ }
+
+ private:
+ static void GetPkHash(std::vector<uint8_t>* hash) {
+ hash->assign(std::begin(kSha256Hash), std::end(kSha256Hash));
+ }
+};
+
+class ComponentInstallerTest : public testing::Test {
+ public:
+ ComponentInstallerTest();
+ ~ComponentInstallerTest() override;
+
+ MockUpdateClient& update_client() { return *update_client_; }
+ ComponentUpdateService* component_updater() {
+ return component_updater_.get();
+ }
+ scoped_refptr<TestConfigurator> configurator() const { return config_; }
+ base::Closure quit_closure() const { return quit_closure_; }
+
+ protected:
+ void RunThreads();
+ void Unpack(const base::FilePath& crx_path);
+ ComponentUnpacker::Result result() const { return result_; }
+
+ private:
+ void UnpackComplete(const ComponentUnpacker::Result& result);
+
+ base::test::ScopedTaskEnvironment scoped_task_environment_;
+ const scoped_refptr<base::SingleThreadTaskRunner> main_thread_task_runner_ =
+ base::ThreadTaskRunnerHandle::Get();
+ base::RunLoop runloop_;
+ base::Closure quit_closure_ = runloop_.QuitClosure();
+
+ scoped_refptr<TestConfigurator> config_ =
+ base::MakeRefCounted<TestConfigurator>();
+ scoped_refptr<MockUpdateClient> update_client_ =
+ base::MakeRefCounted<MockUpdateClient>();
+ std::unique_ptr<ComponentUpdateService> component_updater_;
+ ComponentUnpacker::Result result_;
+};
+
+ComponentInstallerTest::ComponentInstallerTest() {
+ EXPECT_CALL(update_client(), AddObserver(_)).Times(1);
+ component_updater_ =
+ base::MakeUnique<CrxUpdateService>(config_, update_client_);
+}
+
+ComponentInstallerTest::~ComponentInstallerTest() {
+ EXPECT_CALL(update_client(), RemoveObserver(_)).Times(1);
+ component_updater_.reset();
+}
+
+void ComponentInstallerTest::RunThreads() {
+ runloop_.Run();
+}
+
+void ComponentInstallerTest::Unpack(const base::FilePath& crx_path) {
+ auto component_unpacker = base::MakeRefCounted<ComponentUnpacker>(
+ std::vector<uint8_t>(std::begin(kSha256Hash), std::end(kSha256Hash)),
+ crx_path, nullptr, nullptr);
+ component_unpacker->Unpack(base::Bind(&ComponentInstallerTest::UnpackComplete,
+ base::Unretained(this)));
+ RunThreads();
+}
+
+void ComponentInstallerTest::UnpackComplete(
+ const ComponentUnpacker::Result& result) {
+ result_ = result;
+
+ EXPECT_EQ(update_client::UnpackerError::kNone, result_.error);
+ EXPECT_EQ(0, result_.extended_error);
+
+ main_thread_task_runner_->PostTask(FROM_HERE, quit_closure_);
+}
+
+} // namespace
+
+// Tests that the component metadata is propagated from the component installer
+// and its component policy, through the instance of the CrxComponent, to the
+// component updater service.
+TEST_F(ComponentInstallerTest, RegisterComponent) {
+ class LoopHandler {
+ public:
+ LoopHandler(int max_cnt, const base::Closure& quit_closure)
+ : max_cnt_(max_cnt), quit_closure_(quit_closure) {}
+
+ void OnUpdate(const std::vector<std::string>& ids,
+ const UpdateClient::CrxDataCallback& crx_data_callback,
+ const Callback& callback) {
+ callback.Run(update_client::Error::NONE);
+ static int cnt = 0;
+ ++cnt;
+ if (cnt >= max_cnt_)
+ quit_closure_.Run();
+ }
+
+ private:
+ const int max_cnt_;
+ base::Closure quit_closure_;
+ };
+
+ base::ScopedPathOverride scoped_path_override(DIR_COMPONENT_USER);
+
+ const std::string id("jebgalgnebhfojomionfpkfelancnnkf");
+
+ // Quit after one update check has been fired.
+ LoopHandler loop_handler(1, quit_closure());
+ EXPECT_CALL(update_client(), Update(_, _, _))
+ .WillRepeatedly(Invoke(&loop_handler, &LoopHandler::OnUpdate));
+
+ EXPECT_CALL(update_client(), GetCrxUpdateState(id, _)).Times(1);
+ EXPECT_CALL(update_client(), Stop()).Times(1);
+
+ auto installer = base::MakeRefCounted<ComponentInstaller>(
+ base::MakeUnique<FakeInstallerPolicy>());
+ installer->Register(component_updater(), base::Closure());
+
+ RunThreads();
+
+ CrxUpdateItem item;
+ EXPECT_TRUE(component_updater()->GetComponentDetails(id, &item));
+ const CrxComponent& component(item.component);
+
+ update_client::InstallerAttributes expected_attrs;
+ expected_attrs["ap"] = "fake-ap";
+ expected_attrs["is-enterprise"] = "1";
+
+ EXPECT_EQ(
+ std::vector<uint8_t>(std::begin(kSha256Hash), std::end(kSha256Hash)),
+ component.pk_hash);
+ EXPECT_EQ(base::Version("0.0.0.0"), component.version);
+ EXPECT_TRUE(component.fingerprint.empty());
+ EXPECT_STREQ("fake name", component.name.c_str());
+ EXPECT_EQ(expected_attrs, component.installer_attributes);
+ EXPECT_TRUE(component.requires_network_encryption);
+ EXPECT_TRUE(component.supports_group_policy_enable_component_updates);
+}
+
+// Tests that the unpack path is removed when the install succeeded.
+TEST_F(ComponentInstallerTest, UnpackPathInstallSuccess) {
+ auto installer = base::MakeRefCounted<ComponentInstaller>(
+ base::MakeUnique<FakeInstallerPolicy>());
+
+ Unpack(test_file("jebgalgnebhfojomionfpkfelancnnkf.crx"));
+
+ const auto unpack_path = result().unpack_path;
+ EXPECT_TRUE(base::DirectoryExists(unpack_path));
+
+ auto manifest = update_client::ReadManifest(unpack_path);
+
+ base::ScopedPathOverride scoped_path_override(DIR_COMPONENT_USER);
+ base::FilePath base_dir;
+ EXPECT_TRUE(PathService::Get(DIR_COMPONENT_USER, &base_dir));
+ base_dir = base_dir.Append(relative_install_dir);
+ EXPECT_TRUE(base::CreateDirectory(base_dir));
+ const auto result = installer->Install(std::move(manifest), unpack_path);
+ EXPECT_EQ(0, result.error);
+ EXPECT_FALSE(base::PathExists(unpack_path));
+
+ EXPECT_CALL(update_client(), Stop()).Times(1);
+}
+
+// Tests that the unpack path is removed when the install failed.
+TEST_F(ComponentInstallerTest, UnpackPathInstallError) {
+ auto installer = base::MakeRefCounted<ComponentInstaller>(
+ base::MakeUnique<FakeInstallerPolicy>());
+
+ Unpack(test_file("jebgalgnebhfojomionfpkfelancnnkf.crx"));
+
+ const auto unpack_path = result().unpack_path;
+ EXPECT_TRUE(base::DirectoryExists(unpack_path));
+
+ auto manifest = update_client::ReadManifest(unpack_path);
+
+ // Test the precondition that DIR_COMPONENT_USER is not registered with
+ // the path service.
+ base::FilePath base_dir;
+ EXPECT_FALSE(PathService::Get(DIR_COMPONENT_USER, &base_dir));
+
+ // Calling |Install| fails since DIR_COMPONENT_USER does not exist.
+ const auto result = installer->Install(std::move(manifest), unpack_path);
+ EXPECT_EQ(
+ static_cast<int>(update_client::InstallError::NO_DIR_COMPONENT_USER),
+ result.error);
+ EXPECT_FALSE(base::PathExists(unpack_path));
+
+ EXPECT_CALL(update_client(), Stop()).Times(1);
+}
+
+} // namespace component_updater