blob: 5bf2223c5d23d604de21c08189d77cee6197a2a4 [file] [log] [blame]
// Copyright (c) 2012 The Chromium OS 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 "shill/dhcp_config.h"
#include <base/bind.h>
#include <base/file_util.h>
#include <base/scoped_temp_dir.h>
#include <base/stringprintf.h>
#include <chromeos/dbus/service_constants.h>
#include <gtest/gtest.h>
#include "shill/dbus_adaptor.h"
#include "shill/dhcp_provider.h"
#include "shill/event_dispatcher.h"
#include "shill/mock_control.h"
#include "shill/mock_dhcp_proxy.h"
#include "shill/mock_glib.h"
#include "shill/mock_log.h"
#include "shill/mock_minijail.h"
#include "shill/property_store_unittest.h"
#include "shill/proxy_factory.h"
using base::Bind;
using base::Unretained;
using std::string;
using std::vector;
using testing::_;
using testing::AnyNumber;
using testing::ContainsRegex;
using testing::Return;
using testing::SetArgumentPointee;
using testing::Test;
namespace shill {
namespace {
const char kDeviceName[] = "eth0";
const char kHostName[] = "hostname";
const char kLeaseFileSuffix[] = "leasefilesuffix";
const bool kArpGateway = true;
} // namespace {}
class DHCPConfigTest : public PropertyStoreTest {
public:
DHCPConfigTest()
: proxy_(new MockDHCPProxy()),
proxy_factory_(this),
minijail_(new MockMinijail()),
config_(new DHCPConfig(&control_,
dispatcher(),
DHCPProvider::GetInstance(),
kDeviceName,
kHostName,
kLeaseFileSuffix,
kArpGateway,
glib())) {}
virtual void SetUp() {
config_->proxy_factory_ = &proxy_factory_;
config_->minijail_ = minijail_.get();
}
virtual void TearDown() {
config_->proxy_factory_ = NULL;
config_->minijail_ = NULL;
}
DHCPConfigRefPtr CreateMockMinijailConfig(const string &hostname,
const string &lease_suffix,
bool arp_gateway);
DHCPConfigRefPtr CreateRunningConfig(const string &hostname,
const string &lease_suffix,
bool arp_gateway);
void StopRunningConfigAndExpect(DHCPConfigRefPtr config,
bool lease_file_exists);
protected:
class TestProxyFactory : public ProxyFactory {
public:
explicit TestProxyFactory(DHCPConfigTest *test) : test_(test) {}
virtual DHCPProxyInterface *CreateDHCPProxy(const string &/*service*/) {
return test_->proxy_.release();
}
private:
DHCPConfigTest *test_;
};
static const int kPID;
static const unsigned int kTag;
FilePath lease_file_;
FilePath pid_file_;
ScopedTempDir temp_dir_;
scoped_ptr<MockDHCPProxy> proxy_;
TestProxyFactory proxy_factory_;
MockControl control_;
scoped_ptr<MockMinijail> minijail_;
DHCPConfigRefPtr config_;
};
const int DHCPConfigTest::kPID = 123456;
const unsigned int DHCPConfigTest::kTag = 77;
DHCPConfigRefPtr DHCPConfigTest::CreateMockMinijailConfig(
const string &hostname,
const string &lease_suffix,
bool arp_gateway) {
DHCPConfigRefPtr config(new DHCPConfig(&control_,
dispatcher(),
DHCPProvider::GetInstance(),
kDeviceName,
hostname,
lease_suffix,
arp_gateway,
glib()));
config->minijail_ = minijail_.get();
EXPECT_CALL(*minijail_, RunAndDestroy(_, _, _)).WillOnce(Return(false));
return config;
}
DHCPConfigRefPtr DHCPConfigTest::CreateRunningConfig(const string &hostname,
const string &lease_suffix,
bool arp_gateway) {
DHCPConfigRefPtr config(new DHCPConfig(&control_,
dispatcher(),
DHCPProvider::GetInstance(),
kDeviceName,
hostname,
lease_suffix,
arp_gateway,
glib()));
config->minijail_ = minijail_.get();
EXPECT_CALL(*minijail_, RunAndDestroy(_, _, _))
.WillOnce(DoAll(SetArgumentPointee<2>(kPID), Return(true)));
EXPECT_CALL(*glib(), ChildWatchAdd(kPID, _, _)).WillOnce(Return(kTag));
EXPECT_TRUE(config->Start());
EXPECT_EQ(kPID, config->pid_);
EXPECT_EQ(config.get(), DHCPProvider::GetInstance()->GetConfig(kPID).get());
EXPECT_EQ(kTag, config->child_watch_tag_);
EXPECT_TRUE(temp_dir_.CreateUniqueTempDir());
config->root_ = temp_dir_.path();
FilePath varrun = temp_dir_.path().Append("var/run/dhcpcd");
EXPECT_TRUE(file_util::CreateDirectory(varrun));
pid_file_ = varrun.Append(base::StringPrintf("dhcpcd-%s.pid", kDeviceName));
FilePath varlib = temp_dir_.path().Append("var/lib/dhcpcd");
EXPECT_TRUE(file_util::CreateDirectory(varlib));
lease_file_ =
varlib.Append(base::StringPrintf("dhcpcd-%s.lease", kDeviceName));
EXPECT_EQ(0, file_util::WriteFile(pid_file_, "", 0));
EXPECT_EQ(0, file_util::WriteFile(lease_file_, "", 0));
EXPECT_TRUE(file_util::PathExists(pid_file_));
EXPECT_TRUE(file_util::PathExists(lease_file_));
return config;
}
void DHCPConfigTest::StopRunningConfigAndExpect(DHCPConfigRefPtr config,
bool lease_file_exists) {
ScopedMockLog log;
// We use a non-zero exit status so that we get the log message.
EXPECT_CALL(log, Log(_, _, ::testing::EndsWith("status 10")));
DHCPConfig::ChildWatchCallback(kPID, 10, config.get());
EXPECT_EQ(NULL, DHCPProvider::GetInstance()->GetConfig(kPID).get());
EXPECT_FALSE(file_util::PathExists(pid_file_));
EXPECT_EQ(lease_file_exists, file_util::PathExists(lease_file_));
}
TEST_F(DHCPConfigTest, GetIPv4AddressString) {
EXPECT_EQ("255.255.255.255", config_->GetIPv4AddressString(0xffffffff));
EXPECT_EQ("0.0.0.0", config_->GetIPv4AddressString(0));
EXPECT_EQ("1.2.3.4", config_->GetIPv4AddressString(0x04030201));
}
TEST_F(DHCPConfigTest, InitProxy) {
static const char kService[] = ":1.200";
EXPECT_TRUE(proxy_.get());
EXPECT_FALSE(config_->proxy_.get());
config_->InitProxy(kService);
EXPECT_FALSE(proxy_.get());
EXPECT_TRUE(config_->proxy_.get());
config_->InitProxy(kService);
}
TEST_F(DHCPConfigTest, ParseClasslessStaticRoutes) {
const string kDefaultAddress = "0.0.0.0";
const string kDefaultDestination = kDefaultAddress + "/0";
const string kRouter0 = "10.0.0.254";
const string kAddress1 = "192.168.1.0";
const string kDestination1 = kAddress1 + "/24";
// Last gateway missing, leaving an odd number of parameters.
const string kBrokenClasslessRoutes0 = kDefaultDestination + " " + kRouter0 +
" " + kDestination1;
IPConfig::Properties properties;
EXPECT_FALSE(DHCPConfig::ParseClasslessStaticRoutes(kBrokenClasslessRoutes0,
&properties));
EXPECT_TRUE(properties.routes.empty());
EXPECT_TRUE(properties.gateway.empty());
// Gateway argument for the second route is malformed, but we were able
// to salvage a default gateway.
const string kBrokenRouter1 = "10.0.0";
const string kBrokenClasslessRoutes1 = kBrokenClasslessRoutes0 + " " +
kBrokenRouter1;
EXPECT_FALSE(DHCPConfig::ParseClasslessStaticRoutes(kBrokenClasslessRoutes1,
&properties));
EXPECT_TRUE(properties.routes.empty());
EXPECT_EQ(kRouter0, properties.gateway);
const string kRouter1 = "10.0.0.253";
const string kRouter2 = "10.0.0.252";
const string kClasslessRoutes0 = kDefaultDestination + " " + kRouter2 + " " +
kDestination1 + " " + kRouter1;
EXPECT_TRUE(DHCPConfig::ParseClasslessStaticRoutes(kClasslessRoutes0,
&properties));
// The old default route is preserved.
EXPECT_EQ(kRouter0, properties.gateway);
// The two routes (including the one which would have otherwise been
// classified as a default route) are added to the routing table.
EXPECT_EQ(2, properties.routes.size());
const IPConfig::Route &route0 = properties.routes[0];
EXPECT_EQ(kDefaultAddress, route0.host);
EXPECT_EQ("0.0.0.0", route0.netmask);
EXPECT_EQ(kRouter2, route0.gateway);
const IPConfig::Route &route1 = properties.routes[1];
EXPECT_EQ(kAddress1, route1.host);
EXPECT_EQ("255.255.255.0", route1.netmask);
EXPECT_EQ(kRouter1, route1.gateway);
// A malformed routing table should not affect the current table.
EXPECT_FALSE(DHCPConfig::ParseClasslessStaticRoutes(kBrokenClasslessRoutes1,
&properties));
EXPECT_EQ(2, properties.routes.size());
EXPECT_EQ(kRouter0, properties.gateway);
}
TEST_F(DHCPConfigTest, ParseConfiguration) {
DHCPConfig::Configuration conf;
conf[DHCPConfig::kConfigurationKeyIPAddress].writer().append_uint32(
0x01020304);
conf[DHCPConfig::kConfigurationKeySubnetCIDR].writer().append_byte(
16);
conf[DHCPConfig::kConfigurationKeyBroadcastAddress].writer().append_uint32(
0x10203040);
{
vector<unsigned int> routers;
routers.push_back(0x02040608);
routers.push_back(0x03050709);
DBus::MessageIter writer =
conf[DHCPConfig::kConfigurationKeyRouters].writer();
writer << routers;
}
{
vector<unsigned int> dns;
dns.push_back(0x09070503);
dns.push_back(0x08060402);
DBus::MessageIter writer = conf[DHCPConfig::kConfigurationKeyDNS].writer();
writer << dns;
}
conf[DHCPConfig::kConfigurationKeyDomainName].writer().append_string(
"domain-name");
{
vector<string> search;
search.push_back("foo.com");
search.push_back("bar.com");
DBus::MessageIter writer =
conf[DHCPConfig::kConfigurationKeyDomainSearch].writer();
writer << search;
}
conf[DHCPConfig::kConfigurationKeyMTU].writer().append_uint16(600);
conf["UnknownKey"] = DBus::Variant();
IPConfig::Properties properties;
ASSERT_TRUE(config_->ParseConfiguration(conf, &properties));
EXPECT_EQ("4.3.2.1", properties.address);
EXPECT_EQ(16, properties.subnet_prefix);
EXPECT_EQ("64.48.32.16", properties.broadcast_address);
EXPECT_EQ("8.6.4.2", properties.gateway);
ASSERT_EQ(2, properties.dns_servers.size());
EXPECT_EQ("3.5.7.9", properties.dns_servers[0]);
EXPECT_EQ("2.4.6.8", properties.dns_servers[1]);
EXPECT_EQ("domain-name", properties.domain_name);
ASSERT_EQ(2, properties.domain_search.size());
EXPECT_EQ("foo.com", properties.domain_search[0]);
EXPECT_EQ("bar.com", properties.domain_search[1]);
EXPECT_EQ(600, properties.mtu);
}
TEST_F(DHCPConfigTest, StartFail) {
EXPECT_CALL(*minijail_, RunAndDestroy(_, _, _)).WillOnce(Return(false));
EXPECT_CALL(*glib(), ChildWatchAdd(_, _, _)).Times(0);
EXPECT_FALSE(config_->Start());
EXPECT_EQ(0, config_->pid_);
}
MATCHER_P3(IsDHCPCDArgs, has_hostname, has_arp_gateway, has_lease_suffix, "") {
if (string(arg[0]) != "/sbin/dhcpcd" ||
string(arg[1]) != "-B") {
return false;
}
int end_offset = 2;
if (has_hostname) {
if (string(arg[end_offset]) != "-h" ||
string(arg[end_offset + 1]) != kHostName) {
return false;
}
end_offset += 2;
}
if (has_arp_gateway) {
if (string(arg[end_offset]) != "-R")
return false;
++end_offset;
}
string device_arg = has_lease_suffix ?
string(kDeviceName) + "=" + string(kLeaseFileSuffix) : kDeviceName;
return string(arg[end_offset]) == device_arg && arg[end_offset + 1] == NULL;
}
TEST_F(DHCPConfigTest, StartWithHostname) {
EXPECT_CALL(*minijail_, RunAndDestroy(_, _, _)).WillOnce(Return(false));
EXPECT_FALSE(config_->Start());
}
TEST_F(DHCPConfigTest, StartWithoutHostname) {
DHCPConfigRefPtr config = CreateMockMinijailConfig("",
kLeaseFileSuffix,
kArpGateway);
EXPECT_FALSE(config->Start());
}
TEST_F(DHCPConfigTest, StartWithoutArpGateway) {
DHCPConfigRefPtr config = CreateMockMinijailConfig(kHostName,
kLeaseFileSuffix,
false);
EXPECT_FALSE(config->Start());
}
TEST_F(DHCPConfigTest, StartWithoutLeaseSuffix) {
DHCPConfigRefPtr config = CreateMockMinijailConfig(kHostName,
kDeviceName,
kArpGateway);
EXPECT_FALSE(config->Start());
}
namespace {
class UpdateCallbackTest {
public:
UpdateCallbackTest(const string &message,
const IPConfigRefPtr &ipconfig,
bool success)
: message_(message),
ipconfig_(ipconfig),
success_(success),
called_(false) {}
void Callback(const IPConfigRefPtr &ipconfig, bool success) {
called_ = true;
EXPECT_EQ(ipconfig_.get(), ipconfig.get()) << message_;
EXPECT_EQ(success_, success) << message_;
}
bool called() const { return called_; }
private:
const string message_;
IPConfigRefPtr ipconfig_;
bool success_;
bool called_;
};
void DoNothing() {}
} // namespace {}
TEST_F(DHCPConfigTest, ProcessEventSignalFail) {
DHCPConfig::Configuration conf;
conf[DHCPConfig::kConfigurationKeyIPAddress].writer().append_uint32(
0x01020304);
UpdateCallbackTest callback_test(DHCPConfig::kReasonFail, config_, false);
config_->RegisterUpdateCallback(
Bind(&UpdateCallbackTest::Callback, Unretained(&callback_test)));
config_->lease_acquisition_timeout_callback_.Reset(base::Bind(&DoNothing));
config_->ProcessEventSignal(DHCPConfig::kReasonFail, conf);
EXPECT_TRUE(callback_test.called());
EXPECT_TRUE(config_->properties().address.empty());
EXPECT_TRUE(config_->lease_acquisition_timeout_callback_.IsCancelled());
}
TEST_F(DHCPConfigTest, ProcessEventSignalSuccess) {
static const char * const kReasons[] = {
DHCPConfig::kReasonBound,
DHCPConfig::kReasonRebind,
DHCPConfig::kReasonReboot,
DHCPConfig::kReasonRenew
};
for (size_t r = 0; r < arraysize(kReasons); r++) {
DHCPConfig::Configuration conf;
string message = string(kReasons[r]) + " failed";
conf[DHCPConfig::kConfigurationKeyIPAddress].writer().append_uint32(r);
UpdateCallbackTest callback_test(message, config_, true);
config_->RegisterUpdateCallback(
Bind(&UpdateCallbackTest::Callback, Unretained(&callback_test)));
config_->lease_acquisition_timeout_callback_.Reset(base::Bind(&DoNothing));
config_->ProcessEventSignal(kReasons[r], conf);
EXPECT_TRUE(callback_test.called()) << message;
EXPECT_EQ(base::StringPrintf("%zu.0.0.0", r), config_->properties().address)
<< message;
EXPECT_TRUE(config_->lease_acquisition_timeout_callback_.IsCancelled());
}
}
TEST_F(DHCPConfigTest, ProcessEventSignalUnknown) {
DHCPConfig::Configuration conf;
conf[DHCPConfig::kConfigurationKeyIPAddress].writer().append_uint32(
0x01020304);
static const char kReasonUnknown[] = "UNKNOWN_REASON";
UpdateCallbackTest callback_test(kReasonUnknown, config_, false);
config_->RegisterUpdateCallback(
Bind(&UpdateCallbackTest::Callback, Unretained(&callback_test)));
config_->lease_acquisition_timeout_callback_.Reset(base::Bind(&DoNothing));
config_->ProcessEventSignal(kReasonUnknown, conf);
EXPECT_FALSE(callback_test.called());
EXPECT_TRUE(config_->properties().address.empty());
EXPECT_FALSE(config_->lease_acquisition_timeout_callback_.IsCancelled());
}
TEST_F(DHCPConfigTest, ReleaseIP) {
config_->pid_ = 1 << 18; // Ensure unknown positive PID.
config_->arp_gateway_ = false;
EXPECT_CALL(*proxy_, Release(kDeviceName)).Times(1);
config_->proxy_.reset(proxy_.release());
EXPECT_TRUE(config_->ReleaseIP());
config_->pid_ = 0;
}
TEST_F(DHCPConfigTest, ReleaseIPArpGW) {
config_->pid_ = 1 << 18; // Ensure unknown positive PID.
config_->arp_gateway_ = true;
EXPECT_CALL(*proxy_, Release(kDeviceName)).Times(0);
config_->proxy_.reset(proxy_.release());
EXPECT_TRUE(config_->ReleaseIP());
config_->pid_ = 0;
}
TEST_F(DHCPConfigTest, RenewIP) {
EXPECT_TRUE(config_->lease_acquisition_timeout_callback_.IsCancelled());
config_->pid_ = 456;
EXPECT_FALSE(config_->RenewIP()); // Expect no crash with NULL proxy.
EXPECT_CALL(*proxy_, Rebind(kDeviceName)).Times(1);
config_->proxy_.reset(proxy_.release());
EXPECT_TRUE(config_->RenewIP());
EXPECT_FALSE(config_->lease_acquisition_timeout_callback_.IsCancelled());
config_->pid_ = 0;
}
TEST_F(DHCPConfigTest, RequestIP) {
EXPECT_TRUE(config_->lease_acquisition_timeout_callback_.IsCancelled());
config_->pid_ = 567;
EXPECT_CALL(*proxy_, Rebind(kDeviceName)).Times(1);
config_->proxy_.reset(proxy_.release());
EXPECT_TRUE(config_->RenewIP());
EXPECT_FALSE(config_->lease_acquisition_timeout_callback_.IsCancelled());
config_->pid_ = 0;
}
TEST_F(DHCPConfigTest, RequestIPTimeout) {
UpdateCallbackTest callback_test(DHCPConfig::kReasonFail, config_, false);
config_->RegisterUpdateCallback(
Bind(&UpdateCallbackTest::Callback, Unretained(&callback_test)));
config_->lease_acquisition_timeout_seconds_ = 0;
config_->pid_ = 567;
EXPECT_CALL(*proxy_, Rebind(kDeviceName)).Times(1);
config_->proxy_.reset(proxy_.release());
config_->RenewIP();
config_->dispatcher_->DispatchPendingEvents();
EXPECT_TRUE(callback_test.called());
config_->pid_ = 0;
}
TEST_F(DHCPConfigTest, Restart) {
const int kPID1 = 1 << 17; // Ensure unknown positive PID.
const int kPID2 = 987;
const unsigned int kTag1 = 11;
const unsigned int kTag2 = 22;
config_->pid_ = kPID1;
config_->child_watch_tag_ = kTag1;
DHCPProvider::GetInstance()->BindPID(kPID1, config_);
EXPECT_CALL(*glib(), SourceRemove(kTag1)).WillOnce(Return(true));
EXPECT_CALL(*minijail_, RunAndDestroy(_, _, _)).WillOnce(
DoAll(SetArgumentPointee<2>(kPID2), Return(true)));
EXPECT_CALL(*glib(), ChildWatchAdd(kPID2, _, _)).WillOnce(Return(kTag2));
EXPECT_TRUE(config_->Restart());
EXPECT_EQ(kPID2, config_->pid_);
EXPECT_EQ(config_.get(), DHCPProvider::GetInstance()->GetConfig(kPID2).get());
EXPECT_EQ(kTag2, config_->child_watch_tag_);
DHCPProvider::GetInstance()->UnbindPID(kPID2);
config_->pid_ = 0;
config_->child_watch_tag_ = 0;
}
TEST_F(DHCPConfigTest, RestartNoClient) {
const int kPID = 777;
const unsigned int kTag = 66;
EXPECT_CALL(*glib(), SourceRemove(_)).Times(0);
EXPECT_CALL(*minijail_, RunAndDestroy(_, _, _)).WillOnce(
DoAll(SetArgumentPointee<2>(kPID), Return(true)));
EXPECT_CALL(*glib(), ChildWatchAdd(kPID, _, _)).WillOnce(Return(kTag));
EXPECT_TRUE(config_->Restart());
EXPECT_EQ(kPID, config_->pid_);
EXPECT_EQ(config_.get(), DHCPProvider::GetInstance()->GetConfig(kPID).get());
EXPECT_EQ(kTag, config_->child_watch_tag_);
DHCPProvider::GetInstance()->UnbindPID(kPID);
config_->pid_ = 0;
config_->child_watch_tag_ = 0;
}
TEST_F(DHCPConfigTest, StartSuccessEphemeral) {
DHCPConfigRefPtr config =
CreateRunningConfig(kHostName, kDeviceName, kArpGateway);
StopRunningConfigAndExpect(config, false);
}
TEST_F(DHCPConfigTest, StartSuccessPersistent) {
DHCPConfigRefPtr config =
CreateRunningConfig(kHostName, kLeaseFileSuffix, kArpGateway);
StopRunningConfigAndExpect(config, true);
}
TEST_F(DHCPConfigTest, StartTimeout) {
UpdateCallbackTest callback_test(DHCPConfig::kReasonFail, config_, false);
config_->RegisterUpdateCallback(
Bind(&UpdateCallbackTest::Callback, Unretained(&callback_test)));
config_->lease_acquisition_timeout_seconds_ = 0;
config_->proxy_.reset(proxy_.release());
EXPECT_CALL(*minijail_, RunAndDestroy(_, _, _)).WillOnce(Return(true));
config_->Start();
config_->dispatcher_->DispatchPendingEvents();
EXPECT_TRUE(callback_test.called());
}
TEST_F(DHCPConfigTest, Stop) {
const int kPID = 1 << 17; // Ensure unknown positive PID.
ScopedMockLog log;
EXPECT_CALL(log, Log(_, _, _)).Times(AnyNumber());
EXPECT_CALL(log, Log(_, _, ContainsRegex(
base::StringPrintf("Stopping.+%s", __func__))));
config_->pid_ = kPID;
DHCPProvider::GetInstance()->BindPID(kPID, config_);
config_->Stop(__func__);
EXPECT_TRUE(config_->lease_acquisition_timeout_callback_.IsCancelled());
EXPECT_FALSE(DHCPProvider::GetInstance()->GetConfig(kPID));
EXPECT_FALSE(config_->pid_);
}
TEST_F(DHCPConfigTest, StopDuringRequestIP) {
config_->pid_ = 567;
EXPECT_CALL(*proxy_, Rebind(kDeviceName)).Times(1);
config_->proxy_.reset(proxy_.release());
EXPECT_TRUE(config_->RenewIP());
EXPECT_FALSE(config_->lease_acquisition_timeout_callback_.IsCancelled());
config_->pid_ = 0; // Keep Stop from killing a real process.
config_->Stop(__func__);
EXPECT_TRUE(config_->lease_acquisition_timeout_callback_.IsCancelled());
}
TEST_F(DHCPConfigTest, SetProperty) {
::DBus::Error error;
// Ensure that an attempt to write a R/O property returns InvalidArgs error.
EXPECT_FALSE(DBusAdaptor::SetProperty(config_->mutable_store(),
flimflam::kAddressProperty,
PropertyStoreTest::kStringV,
&error));
EXPECT_EQ(invalid_args(), error.name());
}
} // namespace shill