blob: 9e2cdd18d40a74a8098ceebbea7462f5fa62c573 [file] [log] [blame]
//
// Copyright (C) 2011 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#include "update_engine/omaha_response_handler_action.h"
#include <memory>
#include <string>
#include <base/files/file_util.h>
#include <base/files/scoped_temp_dir.h>
#include <brillo/message_loops/fake_message_loop.h>
#include <gtest/gtest.h>
#include "update_engine/common/constants.h"
#include "update_engine/common/platform_constants.h"
#include "update_engine/common/test_utils.h"
#include "update_engine/common/utils.h"
#include "update_engine/fake_system_state.h"
#include "update_engine/mock_payload_state.h"
#include "update_engine/payload_consumer/payload_constants.h"
#include "update_engine/update_manager/mock_policy.h"
using chromeos_update_engine::test_utils::System;
using chromeos_update_engine::test_utils::WriteFileString;
using chromeos_update_manager::EvalStatus;
using chromeos_update_manager::FakeUpdateManager;
using chromeos_update_manager::MockPolicy;
using std::string;
using testing::_;
using testing::DoAll;
using testing::Return;
using testing::SetArgPointee;
namespace chromeos_update_engine {
class OmahaResponseHandlerActionTest : public ::testing::Test {
protected:
void SetUp() override {
FakeBootControl* fake_boot_control = fake_system_state_.fake_boot_control();
fake_boot_control->SetPartitionDevice(
kLegacyPartitionNameKernel, 0, "/dev/sdz2");
fake_boot_control->SetPartitionDevice(
kLegacyPartitionNameRoot, 0, "/dev/sdz3");
fake_boot_control->SetPartitionDevice(
kLegacyPartitionNameKernel, 1, "/dev/sdz4");
fake_boot_control->SetPartitionDevice(
kLegacyPartitionNameRoot, 1, "/dev/sdz5");
}
// Return true iff the OmahaResponseHandlerAction succeeded.
// If out is non-null, it's set w/ the response from the action.
bool DoTest(const OmahaResponse& in,
const string& deadline_file,
InstallPlan* out);
// Pointer to the Action, valid after |DoTest|, released when the test is
// finished.
std::unique_ptr<OmahaResponseHandlerAction> action_;
// Captures the action's result code, for tests that need to directly verify
// it in non-success cases.
ErrorCode action_result_code_;
FakeSystemState fake_system_state_;
// "Hash+"
const brillo::Blob expected_hash_ = {0x48, 0x61, 0x73, 0x68, 0x2b};
};
class OmahaResponseHandlerActionProcessorDelegate
: public ActionProcessorDelegate {
public:
OmahaResponseHandlerActionProcessorDelegate()
: code_(ErrorCode::kError), code_set_(false) {}
void ActionCompleted(ActionProcessor* processor,
AbstractAction* action,
ErrorCode code) {
if (action->Type() == OmahaResponseHandlerAction::StaticType()) {
code_ = code;
code_set_ = true;
}
}
ErrorCode code_;
bool code_set_;
};
namespace {
const char* const kLongName =
"very_long_name_and_no_slashes-very_long_name_and_no_slashes"
"very_long_name_and_no_slashes-very_long_name_and_no_slashes"
"very_long_name_and_no_slashes-very_long_name_and_no_slashes"
"very_long_name_and_no_slashes-very_long_name_and_no_slashes"
"very_long_name_and_no_slashes-very_long_name_and_no_slashes"
"very_long_name_and_no_slashes-very_long_name_and_no_slashes"
"very_long_name_and_no_slashes-very_long_name_and_no_slashes"
"-the_update_a.b.c.d_DELTA_.tgz";
const char* const kBadVersion = "don't update me";
const char* const kPayloadHashHex = "486173682b";
} // namespace
bool OmahaResponseHandlerActionTest::DoTest(const OmahaResponse& in,
const string& test_deadline_file,
InstallPlan* out) {
brillo::FakeMessageLoop loop(nullptr);
loop.SetAsCurrent();
ActionProcessor processor;
OmahaResponseHandlerActionProcessorDelegate delegate;
processor.set_delegate(&delegate);
ObjectFeederAction<OmahaResponse> feeder_action;
feeder_action.set_obj(in);
if (in.update_exists && in.version != kBadVersion) {
string expected_hash;
for (const auto& package : in.packages)
expected_hash += package.hash + ":";
EXPECT_CALL(*(fake_system_state_.mock_prefs()),
SetString(kPrefsUpdateCheckResponseHash, expected_hash))
.WillOnce(Return(true));
int slot = 1 - fake_system_state_.fake_boot_control()->GetCurrentSlot();
string key = kPrefsChannelOnSlotPrefix + std::to_string(slot);
EXPECT_CALL(*(fake_system_state_.mock_prefs()), SetString(key, testing::_))
.WillOnce(Return(true));
}
string current_url = in.packages.size() ? in.packages[0].payload_urls[0] : "";
EXPECT_CALL(*(fake_system_state_.mock_payload_state()), GetCurrentUrl())
.WillRepeatedly(Return(current_url));
action_.reset(new OmahaResponseHandlerAction(
&fake_system_state_,
(test_deadline_file.empty() ? constants::kOmahaResponseDeadlineFile
: test_deadline_file)));
BondActions(&feeder_action, action_.get());
ObjectCollectorAction<InstallPlan> collector_action;
BondActions(action_.get(), &collector_action);
processor.EnqueueAction(&feeder_action);
processor.EnqueueAction(action_.get());
processor.EnqueueAction(&collector_action);
processor.StartProcessing();
EXPECT_TRUE(!processor.IsRunning())
<< "Update test to handle non-async actions";
if (out)
*out = collector_action.object();
EXPECT_TRUE(delegate.code_set_);
action_result_code_ = delegate.code_;
return delegate.code_ == ErrorCode::kSuccess;
}
TEST_F(OmahaResponseHandlerActionTest, SimpleTest) {
string test_deadline_file;
CHECK(utils::MakeTempFile("omaha_response_handler_action_unittest-XXXXXX",
&test_deadline_file,
nullptr));
ScopedPathUnlinker deadline_unlinker(test_deadline_file);
{
OmahaResponse in;
in.update_exists = true;
in.version = "a.b.c.d";
in.packages.push_back(
{.payload_urls = {"http://foo/the_update_a.b.c.d.tgz"},
.size = 12,
.hash = kPayloadHashHex});
in.more_info_url = "http://more/info";
in.prompt = false;
in.deadline = "20101020";
InstallPlan install_plan;
EXPECT_TRUE(DoTest(in, test_deadline_file, &install_plan));
EXPECT_EQ(in.packages[0].payload_urls[0], install_plan.download_url);
EXPECT_EQ(expected_hash_, install_plan.payloads[0].hash);
EXPECT_EQ(1U, install_plan.target_slot);
string deadline;
EXPECT_TRUE(utils::ReadFile(test_deadline_file, &deadline));
EXPECT_EQ("20101020", deadline);
struct stat deadline_stat;
EXPECT_EQ(0, stat(test_deadline_file.c_str(), &deadline_stat));
EXPECT_EQ(
static_cast<mode_t>(S_IFREG | S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH),
deadline_stat.st_mode);
EXPECT_EQ(in.version, install_plan.version);
}
{
OmahaResponse in;
in.update_exists = true;
in.version = "a.b.c.d";
in.packages.push_back(
{.payload_urls = {"http://foo/the_update_a.b.c.d.tgz"},
.size = 12,
.hash = kPayloadHashHex});
in.more_info_url = "http://more/info";
in.prompt = true;
InstallPlan install_plan;
// Set the other slot as current.
fake_system_state_.fake_boot_control()->SetCurrentSlot(1);
EXPECT_TRUE(DoTest(in, test_deadline_file, &install_plan));
EXPECT_EQ(in.packages[0].payload_urls[0], install_plan.download_url);
EXPECT_EQ(expected_hash_, install_plan.payloads[0].hash);
EXPECT_EQ(0U, install_plan.target_slot);
string deadline;
EXPECT_TRUE(utils::ReadFile(test_deadline_file, &deadline) &&
deadline.empty());
EXPECT_EQ(in.version, install_plan.version);
}
{
OmahaResponse in;
in.update_exists = true;
in.version = "a.b.c.d";
in.packages.push_back(
{.payload_urls = {kLongName}, .size = 12, .hash = kPayloadHashHex});
in.more_info_url = "http://more/info";
in.prompt = true;
in.deadline = "some-deadline";
InstallPlan install_plan;
fake_system_state_.fake_boot_control()->SetCurrentSlot(0);
EXPECT_TRUE(DoTest(in, test_deadline_file, &install_plan));
EXPECT_EQ(in.packages[0].payload_urls[0], install_plan.download_url);
EXPECT_EQ(expected_hash_, install_plan.payloads[0].hash);
EXPECT_EQ(1U, install_plan.target_slot);
string deadline;
EXPECT_TRUE(utils::ReadFile(test_deadline_file, &deadline));
EXPECT_EQ("some-deadline", deadline);
EXPECT_EQ(in.version, install_plan.version);
}
}
TEST_F(OmahaResponseHandlerActionTest, NoUpdatesTest) {
OmahaResponse in;
in.update_exists = false;
InstallPlan install_plan;
EXPECT_FALSE(DoTest(in, "", &install_plan));
EXPECT_TRUE(install_plan.partitions.empty());
}
TEST_F(OmahaResponseHandlerActionTest, MultiPackageTest) {
OmahaResponse in;
in.update_exists = true;
in.version = "a.b.c.d";
in.packages.push_back({.payload_urls = {"http://package/1"},
.size = 1,
.hash = kPayloadHashHex});
in.packages.push_back({.payload_urls = {"http://package/2"},
.size = 2,
.hash = kPayloadHashHex});
in.more_info_url = "http://more/info";
InstallPlan install_plan;
EXPECT_TRUE(DoTest(in, "", &install_plan));
EXPECT_EQ(in.packages[0].payload_urls[0], install_plan.download_url);
EXPECT_EQ(2u, install_plan.payloads.size());
EXPECT_EQ(in.packages[0].size, install_plan.payloads[0].size);
EXPECT_EQ(in.packages[1].size, install_plan.payloads[1].size);
EXPECT_EQ(expected_hash_, install_plan.payloads[0].hash);
EXPECT_EQ(expected_hash_, install_plan.payloads[1].hash);
EXPECT_EQ(in.version, install_plan.version);
}
TEST_F(OmahaResponseHandlerActionTest, HashChecksForHttpTest) {
OmahaResponse in;
in.update_exists = true;
in.version = "a.b.c.d";
in.packages.push_back(
{.payload_urls = {"http://test.should/need/hash.checks.signed"},
.size = 12,
.hash = kPayloadHashHex});
in.more_info_url = "http://more/info";
// Hash checks are always skipped for non-official update URLs.
EXPECT_CALL(*(fake_system_state_.mock_request_params()),
IsUpdateUrlOfficial())
.WillRepeatedly(Return(true));
InstallPlan install_plan;
EXPECT_TRUE(DoTest(in, "", &install_plan));
EXPECT_EQ(in.packages[0].payload_urls[0], install_plan.download_url);
EXPECT_EQ(expected_hash_, install_plan.payloads[0].hash);
EXPECT_TRUE(install_plan.hash_checks_mandatory);
EXPECT_EQ(in.version, install_plan.version);
}
TEST_F(OmahaResponseHandlerActionTest, HashChecksForUnofficialUpdateUrl) {
OmahaResponse in;
in.update_exists = true;
in.version = "a.b.c.d";
in.packages.push_back(
{.payload_urls = {"http://url.normally/needs/hash.checks.signed"},
.size = 12,
.hash = kPayloadHashHex});
in.more_info_url = "http://more/info";
EXPECT_CALL(*(fake_system_state_.mock_request_params()),
IsUpdateUrlOfficial())
.WillRepeatedly(Return(false));
InstallPlan install_plan;
EXPECT_TRUE(DoTest(in, "", &install_plan));
EXPECT_EQ(in.packages[0].payload_urls[0], install_plan.download_url);
EXPECT_EQ(expected_hash_, install_plan.payloads[0].hash);
EXPECT_FALSE(install_plan.hash_checks_mandatory);
EXPECT_EQ(in.version, install_plan.version);
}
TEST_F(OmahaResponseHandlerActionTest,
HashChecksForOfficialUrlUnofficialBuildTest) {
// Official URLs for unofficial builds (dev/test images) don't require hash.
OmahaResponse in;
in.update_exists = true;
in.version = "a.b.c.d";
in.packages.push_back(
{.payload_urls = {"http://url.normally/needs/hash.checks.signed"},
.size = 12,
.hash = kPayloadHashHex});
in.more_info_url = "http://more/info";
EXPECT_CALL(*(fake_system_state_.mock_request_params()),
IsUpdateUrlOfficial())
.WillRepeatedly(Return(true));
fake_system_state_.fake_hardware()->SetIsOfficialBuild(false);
InstallPlan install_plan;
EXPECT_TRUE(DoTest(in, "", &install_plan));
EXPECT_EQ(in.packages[0].payload_urls[0], install_plan.download_url);
EXPECT_EQ(expected_hash_, install_plan.payloads[0].hash);
EXPECT_FALSE(install_plan.hash_checks_mandatory);
EXPECT_EQ(in.version, install_plan.version);
}
TEST_F(OmahaResponseHandlerActionTest, HashChecksForHttpsTest) {
OmahaResponse in;
in.update_exists = true;
in.version = "a.b.c.d";
in.packages.push_back(
{.payload_urls = {"https://test.should/need/hash.checks.signed"},
.size = 12,
.hash = kPayloadHashHex});
in.more_info_url = "http://more/info";
EXPECT_CALL(*(fake_system_state_.mock_request_params()),
IsUpdateUrlOfficial())
.WillRepeatedly(Return(true));
InstallPlan install_plan;
EXPECT_TRUE(DoTest(in, "", &install_plan));
EXPECT_EQ(in.packages[0].payload_urls[0], install_plan.download_url);
EXPECT_EQ(expected_hash_, install_plan.payloads[0].hash);
EXPECT_FALSE(install_plan.hash_checks_mandatory);
EXPECT_EQ(in.version, install_plan.version);
}
TEST_F(OmahaResponseHandlerActionTest, HashChecksForBothHttpAndHttpsTest) {
OmahaResponse in;
in.update_exists = true;
in.version = "a.b.c.d";
in.packages.push_back(
{.payload_urls = {"http://test.should.still/need/hash.checks",
"https://test.should.still/need/hash.checks"},
.size = 12,
.hash = kPayloadHashHex});
in.more_info_url = "http://more/info";
EXPECT_CALL(*(fake_system_state_.mock_request_params()),
IsUpdateUrlOfficial())
.WillRepeatedly(Return(true));
InstallPlan install_plan;
EXPECT_TRUE(DoTest(in, "", &install_plan));
EXPECT_EQ(in.packages[0].payload_urls[0], install_plan.download_url);
EXPECT_EQ(expected_hash_, install_plan.payloads[0].hash);
EXPECT_TRUE(install_plan.hash_checks_mandatory);
EXPECT_EQ(in.version, install_plan.version);
}
TEST_F(OmahaResponseHandlerActionTest, ChangeToMoreStableChannelTest) {
OmahaResponse in;
in.update_exists = true;
in.version = "a.b.c.d";
in.packages.push_back({.payload_urls = {"https://MoreStableChannelTest"},
.size = 1,
.hash = kPayloadHashHex});
in.more_info_url = "http://more/info";
// Create a uniquely named test directory.
base::ScopedTempDir tempdir;
ASSERT_TRUE(tempdir.CreateUniqueTempDir());
OmahaRequestParams params(&fake_system_state_);
fake_system_state_.fake_hardware()->SetIsOfficialBuild(false);
params.set_root(tempdir.GetPath().value());
params.set_current_channel("canary-channel");
// The ImageProperties in Android uses prefs to store MutableImageProperties.
#ifdef __ANDROID__
EXPECT_CALL(*fake_system_state_.mock_prefs(), SetBoolean(_, true))
.WillOnce(Return(true));
#endif // __ANDROID__
EXPECT_TRUE(params.SetTargetChannel("stable-channel", true, nullptr));
params.UpdateDownloadChannel();
EXPECT_TRUE(params.ShouldPowerwash());
fake_system_state_.set_request_params(&params);
InstallPlan install_plan;
EXPECT_TRUE(DoTest(in, "", &install_plan));
EXPECT_TRUE(install_plan.powerwash_required);
}
TEST_F(OmahaResponseHandlerActionTest, ChangeToLessStableChannelTest) {
OmahaResponse in;
in.update_exists = true;
in.version = "a.b.c.d";
in.packages.push_back({.payload_urls = {"https://LessStableChannelTest"},
.size = 15,
.hash = kPayloadHashHex});
in.more_info_url = "http://more/info";
// Create a uniquely named test directory.
base::ScopedTempDir tempdir;
ASSERT_TRUE(tempdir.CreateUniqueTempDir());
OmahaRequestParams params(&fake_system_state_);
fake_system_state_.fake_hardware()->SetIsOfficialBuild(false);
params.set_root(tempdir.GetPath().value());
params.set_current_channel("stable-channel");
// The ImageProperties in Android uses prefs to store MutableImageProperties.
#ifdef __ANDROID__
EXPECT_CALL(*fake_system_state_.mock_prefs(), SetBoolean(_, false))
.WillOnce(Return(true));
#endif // __ANDROID__
EXPECT_TRUE(params.SetTargetChannel("canary-channel", false, nullptr));
params.UpdateDownloadChannel();
EXPECT_FALSE(params.ShouldPowerwash());
fake_system_state_.set_request_params(&params);
InstallPlan install_plan;
EXPECT_TRUE(DoTest(in, "", &install_plan));
EXPECT_FALSE(install_plan.powerwash_required);
}
TEST_F(OmahaResponseHandlerActionTest, P2PUrlIsUsedAndHashChecksMandatory) {
OmahaResponse in;
in.update_exists = true;
in.version = "a.b.c.d";
in.packages.push_back(
{.payload_urls = {"https://would.not/cause/hash/checks"},
.size = 12,
.hash = kPayloadHashHex});
in.more_info_url = "http://more/info";
OmahaRequestParams params(&fake_system_state_);
// We're using a real OmahaRequestParams object here so we can't mock
// IsUpdateUrlOfficial(), but setting the update URL to the AutoUpdate test
// server will cause IsUpdateUrlOfficial() to return true.
params.set_update_url(constants::kOmahaDefaultAUTestURL);
fake_system_state_.set_request_params(&params);
EXPECT_CALL(*fake_system_state_.mock_payload_state(),
SetUsingP2PForDownloading(true));
string p2p_url = "http://9.8.7.6/p2p";
EXPECT_CALL(*fake_system_state_.mock_payload_state(), GetP2PUrl())
.WillRepeatedly(Return(p2p_url));
EXPECT_CALL(*fake_system_state_.mock_payload_state(),
GetUsingP2PForDownloading())
.WillRepeatedly(Return(true));
InstallPlan install_plan;
EXPECT_TRUE(DoTest(in, "", &install_plan));
EXPECT_EQ(expected_hash_, install_plan.payloads[0].hash);
EXPECT_EQ(p2p_url, install_plan.download_url);
EXPECT_TRUE(install_plan.hash_checks_mandatory);
}
TEST_F(OmahaResponseHandlerActionTest, SystemVersionTest) {
OmahaResponse in;
in.update_exists = true;
in.version = "a.b.c.d";
in.system_version = "b.c.d.e";
in.packages.push_back({.payload_urls = {"http://package/1"},
.size = 1,
.hash = kPayloadHashHex});
in.packages.push_back({.payload_urls = {"http://package/2"},
.size = 2,
.hash = kPayloadHashHex});
in.more_info_url = "http://more/info";
InstallPlan install_plan;
EXPECT_TRUE(DoTest(in, "", &install_plan));
EXPECT_EQ(in.packages[0].payload_urls[0], install_plan.download_url);
EXPECT_EQ(2u, install_plan.payloads.size());
EXPECT_EQ(in.packages[0].size, install_plan.payloads[0].size);
EXPECT_EQ(in.packages[1].size, install_plan.payloads[1].size);
EXPECT_EQ(expected_hash_, install_plan.payloads[0].hash);
EXPECT_EQ(expected_hash_, install_plan.payloads[1].hash);
EXPECT_EQ(in.version, install_plan.version);
EXPECT_EQ(in.system_version, install_plan.system_version);
}
TEST_F(OmahaResponseHandlerActionTest, TestDeferredByPolicy) {
OmahaResponse in;
in.update_exists = true;
in.version = "a.b.c.d";
in.packages.push_back({.payload_urls = {"http://foo/the_update_a.b.c.d.tgz"},
.size = 12,
.hash = kPayloadHashHex});
// Setup the UpdateManager to disallow the update.
FakeClock fake_clock;
MockPolicy* mock_policy = new MockPolicy(&fake_clock);
FakeUpdateManager* fake_update_manager =
fake_system_state_.fake_update_manager();
fake_update_manager->set_policy(mock_policy);
EXPECT_CALL(*mock_policy, UpdateCanBeApplied(_, _, _, _, _))
.WillOnce(
DoAll(SetArgPointee<3>(ErrorCode::kOmahaUpdateDeferredPerPolicy),
Return(EvalStatus::kSucceeded)));
// Perform the Action. It should "fail" with kOmahaUpdateDeferredPerPolicy.
InstallPlan install_plan;
EXPECT_FALSE(DoTest(in, "", &install_plan));
EXPECT_EQ(ErrorCode::kOmahaUpdateDeferredPerPolicy, action_result_code_);
// Verify that DoTest() didn't set the output install plan.
EXPECT_EQ("", install_plan.version);
// Copy the underlying InstallPlan from the Action (like a real Delegate).
install_plan = action_->install_plan();
// Now verify the InstallPlan that was generated.
EXPECT_EQ(in.packages[0].payload_urls[0], install_plan.download_url);
EXPECT_EQ(expected_hash_, install_plan.payloads[0].hash);
EXPECT_EQ(1U, install_plan.target_slot);
EXPECT_EQ(in.version, install_plan.version);
}
} // namespace chromeos_update_engine