content/common/page_state_serialization_unittest.cc

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include <math.h>
   6
   7 #include "base/base64.h"
   8 #include "base/file_util.h"
   9 #include "base/path_service.h"
  10 #include "base/pickle.h"
  11 #include "base/strings/string_util.h"
  12 #include "base/strings/stringprintf.h"
  13 #include "base/strings/utf_string_conversions.h"
  14 #include "content/common/page_state_serialization.h"
  15 #include "content/public/common/content_paths.h"
  16 #include "testing/gtest/include/gtest/gtest.h"
  17
  18 namespace content {
  19 namespace {
  20
  21 #if defined(OS_WIN)
  22 inline bool isnan(double num) { return !!_isnan(num); }
  23 #endif
  24
  25 base::NullableString16 NS16(const char* s) {
  26   return s ? base::NullableString16(base::ASCIIToUTF16(s), false) :
  27              base::NullableString16();
  28 }
  29
  30 //-----------------------------------------------------------------------------
  31
  32 template <typename T>
  33 void ExpectEquality(const T& a, const T& b) {
  34   EXPECT_EQ(a, b);
  35 }
  36
  37 template <typename T>
  38 void ExpectEquality(const std::vector<T>& a, const std::vector<T>& b) {
  39   EXPECT_EQ(a.size(), b.size());
  40   for (size_t i = 0; i < std::min(a.size(), b.size()); ++i)
  41     ExpectEquality(a[i], b[i]);
  42 }
  43
  44 template <>
  45 void ExpectEquality(const ExplodedHttpBodyElement& a,
  46                     const ExplodedHttpBodyElement& b) {
  47   EXPECT_EQ(a.type, b.type);
  48   EXPECT_EQ(a.data, b.data);
  49   EXPECT_EQ(a.file_path, b.file_path);
  50   EXPECT_EQ(a.filesystem_url, b.filesystem_url);
  51   EXPECT_EQ(a.file_start, b.file_start);
  52   EXPECT_EQ(a.file_length, b.file_length);
  53   if (!(isnan(a.file_modification_time) && isnan(b.file_modification_time)))
  54     EXPECT_DOUBLE_EQ(a.file_modification_time, b.file_modification_time);
  55   EXPECT_EQ(a.blob_uuid, b.blob_uuid);
  56 }
  57
  58 template <>
  59 void ExpectEquality(const ExplodedHttpBody& a, const ExplodedHttpBody& b) {
  60   EXPECT_EQ(a.http_content_type, b.http_content_type);
  61   EXPECT_EQ(a.identifier, b.identifier);
  62   EXPECT_EQ(a.contains_passwords, b.contains_passwords);
  63   EXPECT_EQ(a.is_null, b.is_null);
  64   ExpectEquality(a.elements, b.elements);
  65 }
  66
  67 template <>
  68 void ExpectEquality(const ExplodedFrameState& a, const ExplodedFrameState& b) {
  69   EXPECT_EQ(a.url_string, b.url_string);
  70   EXPECT_EQ(a.referrer, b.referrer);
  71   EXPECT_EQ(a.referrer_policy, b.referrer_policy);
  72   EXPECT_EQ(a.target, b.target);
  73   EXPECT_EQ(a.state_object, b.state_object);
  74   ExpectEquality(a.document_state, b.document_state);
  75   EXPECT_EQ(a.scroll_offset, b.scroll_offset);
  76   EXPECT_EQ(a.item_sequence_number, b.item_sequence_number);
  77   EXPECT_EQ(a.document_sequence_number, b.document_sequence_number);
  78   EXPECT_EQ(a.page_scale_factor, b.page_scale_factor);
  79   ExpectEquality(a.http_body, b.http_body);
  80   ExpectEquality(a.children, b.children);
  81 }
  82
  83 void ExpectEquality(const ExplodedPageState& a, const ExplodedPageState& b) {
  84   ExpectEquality(a.referenced_files, b.referenced_files);
  85   ExpectEquality(a.top, b.top);
  86 }
  87
  88 //-----------------------------------------------------------------------------
  89
  90 class PageStateSerializationTest : public testing::Test {
  91  public:
  92   void PopulateFrameState(ExplodedFrameState* frame_state) {
  93     // Invent some data for the various fields.
  94     frame_state->url_string = NS16("http://dev.chromium.org/");
  95     frame_state->referrer = NS16("https://www.google.com/search?q=dev.chromium.org");
  96     frame_state->referrer_policy = blink::WebReferrerPolicyAlways;
  97     frame_state->target = NS16("foo");
  98     frame_state->state_object = NS16(NULL);
  99     frame_state->document_state.push_back(NS16("1"));
 100     frame_state->document_state.push_back(NS16("q"));
 101     frame_state->document_state.push_back(NS16("text"));
 102     frame_state->document_state.push_back(NS16("dev.chromium.org"));
 103     frame_state->scroll_offset = gfx::Point(0, 100);
 104     frame_state->item_sequence_number = 1;
 105     frame_state->document_sequence_number = 2;
 106     frame_state->page_scale_factor = 2.0;
 107   }
 108
 109   void PopulateHttpBody(ExplodedHttpBody* http_body,
 110                         std::vector<base::NullableString16>* referenced_files) {
 111     http_body->is_null = false;
 112     http_body->identifier = 12345;
 113     http_body->contains_passwords = false;
 114     http_body->http_content_type = NS16("text/foo");
 115
 116     ExplodedHttpBodyElement e1;
 117     e1.type = blink::WebHTTPBody::Element::TypeData;
 118     e1.data = "foo";
 119     http_body->elements.push_back(e1);
 120
 121     ExplodedHttpBodyElement e2;
 122     e2.type = blink::WebHTTPBody::Element::TypeFile;
 123     e2.file_path = NS16("file.txt");
 124     e2.file_start = 100;
 125     e2.file_length = 1024;
 126     e2.file_modification_time = 9999.0;
 127     http_body->elements.push_back(e2);
 128
 129     referenced_files->push_back(e2.file_path);
 130   }
 131
 132   void PopulateFrameStateForBackwardsCompatTest(
 133       ExplodedFrameState* frame_state,
 134       bool is_child) {
 135     frame_state->url_string = NS16("http://chromium.org/");
 136     frame_state->referrer = NS16("http://google.com/");
 137     frame_state->referrer_policy = blink::WebReferrerPolicyDefault;
 138     if (!is_child)
 139       frame_state->target = NS16("target");
 140     frame_state->scroll_offset = gfx::Point(42, -42);
 141     frame_state->item_sequence_number = 123;
 142     frame_state->document_sequence_number = 456;
 143     frame_state->page_scale_factor = 2.0f;
 144
 145     frame_state->document_state.push_back(
 146         NS16("\n\r?% WebKit serialized form state version 8 \n\r=&"));
 147     frame_state->document_state.push_back(NS16("form key"));
 148     frame_state->document_state.push_back(NS16("1"));
 149     frame_state->document_state.push_back(NS16("foo"));
 150     frame_state->document_state.push_back(NS16("file"));
 151     frame_state->document_state.push_back(NS16("2"));
 152     frame_state->document_state.push_back(NS16("file.txt"));
 153     frame_state->document_state.push_back(NS16("displayName"));
 154
 155     if (!is_child) {
 156       frame_state->http_body.http_content_type = NS16("foo/bar");
 157       frame_state->http_body.identifier = 789;
 158       frame_state->http_body.is_null = false;
 159
 160       ExplodedHttpBodyElement e1;
 161       e1.type = blink::WebHTTPBody::Element::TypeData;
 162       e1.data = "first data block";
 163       frame_state->http_body.elements.push_back(e1);
 164
 165       ExplodedHttpBodyElement e2;
 166       e2.type = blink::WebHTTPBody::Element::TypeFile;
 167       e2.file_path = NS16("file.txt");
 168       frame_state->http_body.elements.push_back(e2);
 169
 170       ExplodedHttpBodyElement e3;
 171       e3.type = blink::WebHTTPBody::Element::TypeData;
 172       e3.data = "data the second";
 173       frame_state->http_body.elements.push_back(e3);
 174
 175       ExplodedFrameState child_state;
 176       PopulateFrameStateForBackwardsCompatTest(&child_state, true);
 177       frame_state->children.push_back(child_state);
 178     }
 179   }
 180
 181   void PopulatePageStateForBackwardsCompatTest(ExplodedPageState* page_state) {
 182     page_state->referenced_files.push_back(NS16("file.txt"));
 183     PopulateFrameStateForBackwardsCompatTest(&page_state->top, false);
 184   }
 185
 186   void TestBackwardsCompat(int version) {
 187     const char* suffix = "";
 188
 189 #if defined(OS_ANDROID)
 190     // Unfortunately, the format of version 11 is different on Android, so we
 191     // need to use a special reference file.
 192     if (version == 11)
 193       suffix = "_android";
 194 #endif
 195
 196     base::FilePath path;
 197     PathService::Get(content::DIR_TEST_DATA, &path);
 198     path = path.AppendASCII("page_state").AppendASCII(
 199         base::StringPrintf("serialized_v%d%s.dat", version, suffix));
 200
 201     std::string file_contents;
 202     if (!base::ReadFileToString(path, &file_contents)) {
 203       ADD_FAILURE() << "File not found: " << path.value();
 204       return;
 205     }
 206
 207     std::string trimmed_contents;
 208     EXPECT_TRUE(base::RemoveChars(file_contents, "\r\n", &trimmed_contents));
 209
 210     std::string encoded;
 211     EXPECT_TRUE(base::Base64Decode(trimmed_contents, &encoded));
 212
 213     ExplodedPageState output;
 214 #if defined(OS_ANDROID)
 215     // Because version 11 of the file format unfortunately bakes in the device
 216     // scale factor on Android, perform this test by assuming a preset device
 217     // scale factor, ignoring the device scale factor of the current device.
 218     const float kPresetDeviceScaleFactor = 2.0f;
 219     EXPECT_TRUE(DecodePageStateWithDeviceScaleFactorForTesting(
 220         encoded,
 221         kPresetDeviceScaleFactor,
 222         &output));
 223 #else
 224     EXPECT_TRUE(DecodePageState(encoded, &output));
 225 #endif
 226
 227     ExplodedPageState expected;
 228     PopulatePageStateForBackwardsCompatTest(&expected);
 229
 230     ExpectEquality(expected, output);
 231   }
 232 };
 233
 234 TEST_F(PageStateSerializationTest, BasicEmpty) {
 235   ExplodedPageState input;
 236
 237   std::string encoded;
 238   EXPECT_TRUE(EncodePageState(input, &encoded));
 239
 240   ExplodedPageState output;
 241   EXPECT_TRUE(DecodePageState(encoded, &output));
 242
 243   ExpectEquality(input, output);
 244 }
 245
 246 TEST_F(PageStateSerializationTest, BasicFrame) {
 247   ExplodedPageState input;
 248   PopulateFrameState(&input.top);
 249
 250   std::string encoded;
 251   EXPECT_TRUE(EncodePageState(input, &encoded));
 252
 253   ExplodedPageState output;
 254   EXPECT_TRUE(DecodePageState(encoded, &output));
 255
 256   ExpectEquality(input, output);
 257 }
 258
 259 TEST_F(PageStateSerializationTest, BasicFramePOST) {
 260   ExplodedPageState input;
 261   PopulateFrameState(&input.top);
 262   PopulateHttpBody(&input.top.http_body, &input.referenced_files);
 263
 264   std::string encoded;
 265   EXPECT_TRUE(EncodePageState(input, &encoded));
 266
 267   ExplodedPageState output;
 268   EXPECT_TRUE(DecodePageState(encoded, &output));
 269
 270   ExpectEquality(input, output);
 271 }
 272
 273 TEST_F(PageStateSerializationTest, BasicFrameSet) {
 274   ExplodedPageState input;
 275   PopulateFrameState(&input.top);
 276
 277   // Add some child frames.
 278   for (int i = 0; i < 4; ++i) {
 279     ExplodedFrameState child_state;
 280     PopulateFrameState(&child_state);
 281     input.top.children.push_back(child_state);
 282   }
 283
 284   std::string encoded;
 285   EXPECT_TRUE(EncodePageState(input, &encoded));
 286
 287   ExplodedPageState output;
 288   EXPECT_TRUE(DecodePageState(encoded, &output));
 289
 290   ExpectEquality(input, output);
 291 }
 292
 293 TEST_F(PageStateSerializationTest, BasicFrameSetPOST) {
 294   ExplodedPageState input;
 295   PopulateFrameState(&input.top);
 296
 297   // Add some child frames.
 298   for (int i = 0; i < 4; ++i) {
 299     ExplodedFrameState child_state;
 300     PopulateFrameState(&child_state);
 301
 302     // Simulate a form POST on a subframe.
 303     if (i == 2)
 304       PopulateHttpBody(&child_state.http_body, &input.referenced_files);
 305
 306     input.top.children.push_back(child_state);
 307   }
 308
 309   std::string encoded;
 310   EncodePageState(input, &encoded);
 311
 312   ExplodedPageState output;
 313   DecodePageState(encoded, &output);
 314
 315   ExpectEquality(input, output);
 316 }
 317
 318 TEST_F(PageStateSerializationTest, BadMessagesTest1) {
 319   Pickle p;
 320   // Version 14
 321   p.WriteInt(14);
 322   // Empty strings.
 323   for (int i = 0; i < 6; ++i)
 324     p.WriteInt(-1);
 325   // Bad real number.
 326   p.WriteInt(-1);
 327
 328   std::string s(static_cast<const char*>(p.data()), p.size());
 329
 330   ExplodedPageState output;
 331   EXPECT_FALSE(DecodePageState(s, &output));
 332 }
 333
 334 TEST_F(PageStateSerializationTest, BadMessagesTest2) {
 335   double d = 0;
 336   Pickle p;
 337   // Version 14
 338   p.WriteInt(14);
 339   // Empty strings.
 340   for (int i = 0; i < 6; ++i)
 341     p.WriteInt(-1);
 342   // More misc fields.
 343   p.WriteData(reinterpret_cast<const char*>(&d), sizeof(d));
 344   p.WriteInt(1);
 345   p.WriteInt(1);
 346   p.WriteInt(0);
 347   p.WriteInt(0);
 348   p.WriteInt(-1);
 349   p.WriteInt(0);
 350   // WebForm
 351   p.WriteInt(1);
 352   p.WriteInt(blink::WebHTTPBody::Element::TypeData);
 353
 354   std::string s(static_cast<const char*>(p.data()), p.size());
 355
 356   ExplodedPageState output;
 357   EXPECT_FALSE(DecodePageState(s, &output));
 358 }
 359
 360 TEST_F(PageStateSerializationTest, DumpExpectedPageStateForBackwardsCompat) {
 361   // Change to #if 1 to enable this code.  Use this code to generate data, based
 362   // on the current serialization format, for the BackwardsCompat_vXX tests.
 363 #if 0
 364   ExplodedPageState state;
 365   PopulatePageStateForBackwardsCompatTest(&state);
 366
 367   std::string encoded;
 368   EXPECT_TRUE(EncodePageState(state, &encoded));
 369
 370   std::string base64;
 371   base::Base64Encode(encoded, &base64);
 372
 373   base::FilePath path;
 374   PathService::Get(base::DIR_TEMP, &path);
 375   path = path.AppendASCII("expected.dat");
 376
 377   FILE* fp = base::OpenFile(path, "wb");
 378   ASSERT_TRUE(fp);
 379
 380   const size_t kRowSize = 76;
 381   for (size_t offset = 0; offset < base64.size(); offset += kRowSize) {
 382     size_t length = std::min(base64.size() - offset, kRowSize);
 383     std::string segment(&base64[offset], length);
 384     segment.push_back('\n');
 385     ASSERT_EQ(1U, fwrite(segment.data(), segment.size(), 1, fp));
 386   }
 387
 388   fclose(fp);
 389 #endif
 390 }
 391
 392 #if !defined(OS_ANDROID)
 393 // TODO(darin): Re-enable for Android once this test accounts for systems with
 394 //              a device scale factor not equal to 2.
 395 TEST_F(PageStateSerializationTest, BackwardsCompat_v11) {
 396   TestBackwardsCompat(11);
 397 }
 398 #endif
 399
 400 TEST_F(PageStateSerializationTest, BackwardsCompat_v12) {
 401   TestBackwardsCompat(12);
 402 }
 403
 404 TEST_F(PageStateSerializationTest, BackwardsCompat_v13) {
 405   TestBackwardsCompat(13);
 406 }
 407
 408 TEST_F(PageStateSerializationTest, BackwardsCompat_v14) {
 409   TestBackwardsCompat(14);
 410 }
 411
 412 TEST_F(PageStateSerializationTest, BackwardsCompat_v15) {
 413   TestBackwardsCompat(15);
 414 }
 415
 416 TEST_F(PageStateSerializationTest, BackwardsCompat_v16) {
 417   TestBackwardsCompat(16);
 418 }
 419
 420 TEST_F(PageStateSerializationTest, BackwardsCompat_v18) {
 421   TestBackwardsCompat(18);
 422 }
 423
 424 }  // namespace
 425 }  // namespace content