1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
|
// Copyright 2017 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/media/router/discovery/dial/device_description_service.h"
#include <memory>
#include <utility>
#include "base/containers/contains.h"
#include "base/memory/raw_ref.h"
#include "base/strings/string_number_conversions.h"
#include "base/strings/stringprintf.h"
#include "base/test/mock_callback.h"
#include "base/test/task_environment.h"
#include "chrome/browser/media/router/discovery/dial/device_description_fetcher.h"
#include "chrome/browser/media/router/discovery/dial/dial_device_data.h"
#include "chrome/browser/media/router/discovery/dial/parsed_dial_device_description.h"
#include "chrome/browser/media/router/discovery/dial/safe_dial_device_description_parser.h"
#include "chrome/browser/media/router/test/provider_test_helpers.h"
#include "content/public/test/browser_task_environment.h"
#include "net/base/ip_address.h"
#include "services/network/test/test_url_loader_factory.h"
#include "testing/gmock/include/gmock/gmock.h"
#include "testing/gtest/include/gtest/gtest.h"
using ::testing::_;
using ::testing::Return;
using ::testing::SaveArg;
namespace media_router {
// Create Test Data
namespace {
DialDeviceData CreateDialDeviceData(int num) {
DialDeviceData device_data(
base::StringPrintf("Device id %d", num),
GURL(base::StringPrintf("http://192.168.1.%d/dd.xml", num)),
base::Time::Now());
device_data.set_label(base::StringPrintf("Device label %d", num));
net::IPAddress address;
CHECK(address.AssignFromIPLiteral(base::StringPrintf("192.168.1.%d", num)));
device_data.set_ip_address(address);
return device_data;
}
DialDeviceDescriptionData CreateDialDeviceDescriptionData(int num) {
return DialDeviceDescriptionData(
"", GURL(base::StringPrintf("http://192.168.1.%d/apps", num)));
}
ParsedDialDeviceDescription CreateParsedDialDeviceDescription(int num) {
ParsedDialDeviceDescription description_data;
description_data.app_url =
GURL(base::StringPrintf("http://192.168.1.%d/apps", num));
description_data.friendly_name = base::StringPrintf("Friendly name %d", num);
description_data.model_name = base::StringPrintf("Model name %d", num);
description_data.unique_id = base::StringPrintf("Unique ID %d", num);
return description_data;
}
} // namespace
class TestDeviceDescriptionService : public DeviceDescriptionService {
public:
TestDeviceDescriptionService(
const DeviceDescriptionParseSuccessCallback& success_cb,
const DeviceDescriptionParseErrorCallback& error_cb)
: DeviceDescriptionService(success_cb, error_cb) {}
MOCK_METHOD2(ParseDeviceDescription,
void(const DialDeviceData&, const DialDeviceDescriptionData&));
std::unique_ptr<DeviceDescriptionFetcher> CreateFetcher(
const DialDeviceData& device_data,
base::OnceCallback<void(const DialDeviceDescriptionData&)> success_cb,
base::OnceCallback<void(const std::string&)> error_cb) override {
return std::make_unique<TestDeviceDescriptionFetcher>(
device_data, std::move(success_cb), std::move(error_cb),
&loader_factory_);
}
private:
network::TestURLLoaderFactory loader_factory_;
};
class DeviceDescriptionServiceTest : public ::testing::Test {
public:
DeviceDescriptionServiceTest()
: device_description_service_(mock_success_cb_.Get(),
mock_error_cb_.Get()),
fetcher_map_(
device_description_service_.device_description_fetcher_map_),
description_cache_(device_description_service_.description_cache_) {}
TestDeviceDescriptionService* device_description_service() {
return &device_description_service_;
}
void AddToCache(const std::string& device_label,
const ParsedDialDeviceDescription& description_data,
bool expired) {
DeviceDescriptionService::CacheEntry cache_entry;
cache_entry.expire_time =
base::Time::Now() + (expired ? -1 : 1) * base::Hours(12);
cache_entry.description_data = description_data;
(*description_cache_)[device_label] = cache_entry;
}
void OnDeviceDescriptionFetchComplete(int num) {}
void TestOnParsedDeviceDescription(
ParsedDialDeviceDescription device_description,
SafeDialDeviceDescriptionParser::ParsingResult parsing_result,
const std::string& error_message) {
GURL app_url("http://192.168.1.1/apps");
auto device_data = CreateDialDeviceData(1);
auto description_data = CreateParsedDialDeviceDescription(1);
if (!error_message.empty()) {
EXPECT_CALL(mock_error_cb_, Run(device_data, error_message));
} else {
EXPECT_CALL(mock_success_cb_, Run(device_data, description_data));
}
device_description_service()->OnParsedDeviceDescription(
device_data, device_description, parsing_result);
}
protected:
base::test::TaskEnvironment environment_;
base::MockCallback<
DeviceDescriptionService::DeviceDescriptionParseSuccessCallback>
mock_success_cb_;
base::MockCallback<
DeviceDescriptionService::DeviceDescriptionParseErrorCallback>
mock_error_cb_;
TestDeviceDescriptionService device_description_service_;
const raw_ref<
std::map<std::string, std::unique_ptr<DeviceDescriptionFetcher>>>
fetcher_map_;
const raw_ref<std::map<std::string, DeviceDescriptionService::CacheEntry>>
description_cache_;
};
TEST_F(DeviceDescriptionServiceTest, TestGetDeviceDescriptionFromCache) {
auto device_data = CreateDialDeviceData(1);
auto description_data = CreateParsedDialDeviceDescription(1);
EXPECT_CALL(mock_success_cb_, Run(device_data, description_data));
AddToCache(device_data.label(), description_data, false /* expired */);
std::vector<DialDeviceData> devices = {device_data};
device_description_service()->GetDeviceDescriptions(devices);
}
TEST_F(DeviceDescriptionServiceTest, TestGetDeviceDescriptionFetchURL) {
DialDeviceData device_data = CreateDialDeviceData(1);
std::vector<DialDeviceData> devices = {device_data};
// Create Fetcher
EXPECT_TRUE(fetcher_map_->empty());
device_description_service()->GetDeviceDescriptions(devices);
EXPECT_EQ(size_t(1), fetcher_map_->size());
// Remove fetcher.
EXPECT_CALL(*device_description_service(), ParseDeviceDescription(_, _));
auto description_response_data = CreateDialDeviceDescriptionData(1);
auto parsed_description_data = CreateParsedDialDeviceDescription(1);
EXPECT_CALL(mock_success_cb_, Run(device_data, parsed_description_data));
device_description_service_.OnDeviceDescriptionFetchComplete(
device_data, description_response_data);
device_description_service_.OnParsedDeviceDescription(
device_data, CreateParsedDialDeviceDescription(1),
SafeDialDeviceDescriptionParser::ParsingResult::kSuccess);
}
TEST_F(DeviceDescriptionServiceTest, TestGetDeviceDescriptionFetchURLError) {
DialDeviceData device_data = CreateDialDeviceData(1);
std::vector<DialDeviceData> devices;
devices.push_back(device_data);
// Create Fetcher
EXPECT_TRUE(fetcher_map_->empty());
device_description_service()->GetDeviceDescriptions(devices);
EXPECT_EQ(size_t(1), fetcher_map_->size());
EXPECT_CALL(mock_error_cb_, Run(device_data, ""));
device_description_service()->OnDeviceDescriptionFetchError(device_data, "");
EXPECT_TRUE(fetcher_map_->empty());
}
TEST_F(DeviceDescriptionServiceTest,
TestGetDeviceDescriptionRemoveOutDatedFetchers) {
DialDeviceData device_data_1 = CreateDialDeviceData(1);
DialDeviceData device_data_2 = CreateDialDeviceData(2);
DialDeviceData device_data_3 = CreateDialDeviceData(3);
std::vector<DialDeviceData> devices;
devices.push_back(device_data_1);
devices.push_back(device_data_2);
// insert fetchers
device_description_service()->GetDeviceDescriptions(devices);
// Keep fetchers non exist in current device list and remove fetchers with
// different description url.
GURL new_url_2 = GURL("http://example.com");
device_data_2.set_device_description_url(new_url_2);
devices.clear();
devices.push_back(device_data_2);
devices.push_back(device_data_3);
device_description_service()->GetDeviceDescriptions(devices);
EXPECT_EQ(size_t(3), fetcher_map_->size());
auto* description_fetcher = (*fetcher_map_)[device_data_2.label()].get();
EXPECT_EQ(new_url_2, description_fetcher->device_description_url());
EXPECT_CALL(mock_error_cb_, Run(_, _)).Times(3);
device_description_service()->OnDeviceDescriptionFetchError(device_data_1,
"");
device_description_service()->OnDeviceDescriptionFetchError(device_data_2,
"");
device_description_service()->OnDeviceDescriptionFetchError(device_data_3,
"");
}
TEST_F(DeviceDescriptionServiceTest, TestCleanUpCacheEntries) {
DialDeviceData device_data_1 = CreateDialDeviceData(1);
DialDeviceData device_data_2 = CreateDialDeviceData(2);
DialDeviceData device_data_3 = CreateDialDeviceData(3);
AddToCache(device_data_1.label(), ParsedDialDeviceDescription(),
true /* expired */);
AddToCache(device_data_2.label(), ParsedDialDeviceDescription(),
true /* expired */);
AddToCache(device_data_3.label(), ParsedDialDeviceDescription(),
false /* expired */);
device_description_service_.CleanUpCacheEntries();
EXPECT_EQ(size_t(1), description_cache_->size());
EXPECT_TRUE(base::Contains(*description_cache_, device_data_3.label()));
AddToCache(device_data_3.label(), ParsedDialDeviceDescription(),
true /* expired*/);
device_description_service_.CleanUpCacheEntries();
EXPECT_TRUE(description_cache_->empty());
}
TEST_F(DeviceDescriptionServiceTest, TestOnParsedDeviceDescription) {
GURL app_url("http://192.168.1.1/apps");
DialDeviceData device_data = CreateDialDeviceData(1);
// XML parsing errors.
std::string error_message = "Failed to parse device description XML";
SafeDialDeviceDescriptionParser::ParsingResult errors[] = {
SafeDialDeviceDescriptionParser::ParsingResult::kInvalidXml,
SafeDialDeviceDescriptionParser::ParsingResult::kFailedToReadUdn,
SafeDialDeviceDescriptionParser::ParsingResult::kFailedToReadFriendlyName,
SafeDialDeviceDescriptionParser::ParsingResult::kFailedToReadModelName,
SafeDialDeviceDescriptionParser::ParsingResult::kFailedToReadDeviceType};
for (auto error : errors) {
TestOnParsedDeviceDescription(ParsedDialDeviceDescription(), error,
error_message);
}
// Empty field
error_message = "Failed to process fetch result";
TestOnParsedDeviceDescription(
ParsedDialDeviceDescription(),
SafeDialDeviceDescriptionParser::ParsingResult::kSuccess, error_message);
// Valid device description and put in cache
auto description = CreateParsedDialDeviceDescription(1);
TestOnParsedDeviceDescription(
description, SafeDialDeviceDescriptionParser::ParsingResult::kSuccess,
"");
EXPECT_EQ(size_t(1), description_cache_->size());
// Valid device description ptr and skip cache.
size_t cache_num = 256;
for (size_t i = 0; i < cache_num; i++) {
AddToCache(base::NumberToString(i), ParsedDialDeviceDescription(),
false /* expired */);
}
EXPECT_EQ(size_t(cache_num + 1), description_cache_->size());
description = CreateParsedDialDeviceDescription(1);
TestOnParsedDeviceDescription(
description, SafeDialDeviceDescriptionParser::ParsingResult::kSuccess,
"");
EXPECT_EQ(size_t(cache_num + 1), description_cache_->size());
}
} // namespace media_router
|