summaryrefslogtreecommitdiffstats
path: root/content/test/layout_browsertest.cc
blob: 469a45a53e3a467e09201ade55b9916d92998476 (plain)
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
// Copyright (c) 2012 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 "content/test/layout_browsertest.h"

#include "base/file_path.h"
#include "base/file_util.h"
#include "base/path_service.h"
#include "base/rand_util.h"
#include "base/scoped_temp_dir.h"
#include "base/stringprintf.h"
#include "base/string_util.h"
#include "base/utf_string_conversions.h"
#include "chrome/browser/ui/browser.h"
#include "chrome/test/base/in_process_browser_test.h"
#include "chrome/test/base/layout_test_http_server.h"
#include "chrome/test/base/ui_test_utils.h"
#include "content/browser/web_contents/web_contents_impl.h"
#include "content/public/common/content_paths.h"
#include "net/base/net_util.h"

#if defined(OS_WIN)
static const char kPlatformName[] = "chromium-win";
#elif defined(OS_MACOSX)
static const char kPlatformName[] = "chromium-mac";
#elif defined(OS_LINUX)
static const char kPlatformName[] = "chromium-linux";
#elif defined(OS_OPENBSD)
static const char kPlatformName[] = "chromium-openbsd";
#else
#error No known OS defined
#endif

namespace {

size_t FindInsertPosition(const std::string& html) {
  size_t tag_start = html.find("<html");
  if (tag_start == std::string::npos)
    return 0;
  size_t tag_end = html.find(">", tag_start);
  if (tag_end == std::string::npos)
    return 0;
  return tag_end + 1;
}

bool ReadExpectedResult(const FilePath& result_dir_path,
                        const std::string test_case_file_name,
                        std::string* expected_result_value) {
  FilePath expected_result_path(result_dir_path);
  expected_result_path = expected_result_path.AppendASCII(test_case_file_name);
  expected_result_path = expected_result_path.InsertBeforeExtension(
      FILE_PATH_LITERAL("-expected"));
  expected_result_path =
      expected_result_path.ReplaceExtension(FILE_PATH_LITERAL("txt"));
  return file_util::ReadFileToString(
      expected_result_path, expected_result_value);
}

void ScrapeResultFromBrowser(Browser* browser, std::string* actual_text) {
  DOMElementProxyRef doc = ui_test_utils::GetActiveDOMDocument(browser);
  DOMElementProxyRef body =
      doc->FindElement(DOMElementProxy::By::XPath("//body"));
  ASSERT_TRUE(body.get());
  ASSERT_TRUE(body->GetInnerText(actual_text));
}

static const std::string preamble =
      "\n<script>\n"
      "function LayoutTestController() {\n"
      "  this.wait_until_done_ = false;\n"
      "  this.dumpAsText = function () {};\n"
      "  this.waitUntilDone = function () {\n"
      "    this.wait_until_done_ = true;\n"
      "  }\n"
      "  this.notifyDone = function () {\n"
      "    document.title = 'done';\n"
      "  }\n"
      "  this.overridePreference = function () {}\n"
      "  this.OnEvent = function () {\n"
      "    if (!layoutTestController.wait_until_done_)\n"
      "      layoutTestController.notifyDone();\n"
      "  }\n"
      "  this.workerThreadCount = 0; \n"
      "}\n"
      "window.layoutTestController = new LayoutTestController();\n"
      "window.addEventListener('load', layoutTestController.OnEvent, false);\n"
      "</script>";

}

InProcessBrowserLayoutTest::InProcessBrowserLayoutTest(
    const FilePath& test_parent_dir, const FilePath& test_case_dir)
    : test_parent_dir_(test_parent_dir), test_case_dir_(test_case_dir),
      port_(-2) {
  EnableDOMAutomation();
}

InProcessBrowserLayoutTest::InProcessBrowserLayoutTest(
    const FilePath& test_parent_dir, const FilePath& test_case_dir, int port)
    : test_parent_dir_(test_parent_dir), test_case_dir_(test_case_dir),
      port_(port) {
  EnableDOMAutomation();
}

InProcessBrowserLayoutTest::~InProcessBrowserLayoutTest() {
  if (test_http_server_.get())
    CHECK(test_http_server_->Stop());
}

void InProcessBrowserLayoutTest::SetUpInProcessBrowserTestFixture() {
  ASSERT_TRUE(scoped_temp_dir_.CreateUniqueTempDir());
  FilePath src_dir;
  ASSERT_TRUE(PathService::Get(content::DIR_LAYOUT_TESTS, &src_dir));
  our_original_layout_test_dir_ =
      src_dir.Append(test_parent_dir_).Append(test_case_dir_);
  ASSERT_TRUE(file_util::DirectoryExists(our_original_layout_test_dir_));
  our_layout_test_temp_dir_ = scoped_temp_dir_.path()
      .AppendASCII("LayoutTests").Append(test_parent_dir_);
  ASSERT_TRUE(file_util::CreateDirectory(
      our_layout_test_temp_dir_.Append(test_case_dir_)));
  file_util::CopyDirectory(
      our_original_layout_test_dir_.AppendASCII("resources"),
      our_layout_test_temp_dir_.Append(test_case_dir_).AppendASCII("resources"),
      true /*recursive*/);

  // Gets the file path to rebased expected result directory for the current
  // platform.
  //   $LayoutTestRoot/platform/chromium_***/...
  rebase_result_dir_ = src_dir.AppendASCII("platform");
  rebase_result_dir_ = rebase_result_dir_.AppendASCII(kPlatformName);
  rebase_result_dir_ = rebase_result_dir_.Append(test_parent_dir_);
  rebase_result_dir_ = rebase_result_dir_.Append(test_case_dir_);

  // Generic chromium expected results. Not OS-specific. For example,
  // v8-specific differences go here.
  // chrome/test/data/layout_tests/LayoutTests/platform/chromium/...
  rebase_result_chromium_dir_ = src_dir.AppendASCII("platform").
                                        AppendASCII("chromium").
                                        Append(test_parent_dir_).
                                        Append(test_case_dir_);

  // Gets the file path to rebased expected result directory under the
  // win32 platform. This is used by other non-win32 platform to use the same
  // rebased expected results.
#if !defined(OS_WIN)
  rebase_result_win_dir_ = src_dir.AppendASCII("platform").
                                   AppendASCII("chromium-win").
                                   Append(test_parent_dir_).
                                   Append(test_case_dir_);
#endif

  if (port_ != -2) {
    // Layout tests expect that the server points at the
    // LayoutTests\http\tests directory.
    if (port_ == -1)
      port_ = base::RandInt(1024, 65535);
    test_http_server_.reset(new LayoutTestHttpServer(
        our_layout_test_temp_dir_, port_));
    ASSERT_TRUE(test_http_server_->Start());
  }
}

void InProcessBrowserLayoutTest::RunLayoutTest(
    const std::string& test_case_file_name) {
  FilePath file_path;
  WriteModifiedFile(test_case_file_name, &file_path);
  GURL url = net::FilePathToFileURL(file_path);
  RunLayoutTestInternal(test_case_file_name, url);
}

void InProcessBrowserLayoutTest::RunHttpLayoutTest(
    const std::string& test_case_file_name) {
  DCHECK(test_http_server_.get());
  FilePath file_path;
  WriteModifiedFile(test_case_file_name, &file_path);

  GURL url(StringPrintf(
      "http://127.0.0.1:%d/%s/%s", port_, test_case_dir_.MaybeAsASCII().c_str(),
      test_case_file_name.c_str()));
  RunLayoutTestInternal(test_case_file_name, url);
}

void InProcessBrowserLayoutTest::RunLayoutTestInternal(
    const std::string& test_case_file_name, const GURL& url) {
  LOG(INFO) << "Navigating to URL " << url << " and blocking.";
  const string16 expected_title = ASCIIToUTF16("done");
  ui_test_utils::TitleWatcher title_watcher(
      browser()->GetSelectedWebContents(), expected_title);
  ui_test_utils::NavigateToURL(browser(), url);
  LOG(INFO) << "Navigation completed, now waiting for title.";
  string16 final_title = title_watcher.WaitAndGetTitle();
  EXPECT_EQ(expected_title, final_title);

  std::string actual_text;
  ScrapeResultFromBrowser(browser(), &actual_text);
  ReplaceSubstringsAfterOffset(&actual_text, 0, "\r", "");
  TrimString(actual_text, "\n", &actual_text);

  std::string expected_text;
  // Reads the expected result. First try to read from rebase directory.
  // If failed, read from original directory.
  if (!ReadExpectedResult(rebase_result_dir_,
                          test_case_file_name,
                          &expected_text) &&
      !ReadExpectedResult(rebase_result_chromium_dir_,
                          test_case_file_name,
                          &expected_text)) {
    if (rebase_result_win_dir_.empty() ||
        !ReadExpectedResult(rebase_result_win_dir_,
                            test_case_file_name,
                            &expected_text))
      ReadExpectedResult(our_original_layout_test_dir_,
                         test_case_file_name,
                         &expected_text);
  }
  ASSERT_TRUE(!expected_text.empty());
  ReplaceSubstringsAfterOffset(&expected_text, 0, "\r", "");
  TrimString(expected_text, "\n", &expected_text);

  EXPECT_EQ(expected_text, actual_text);
}

void InProcessBrowserLayoutTest::AddResourceForLayoutTest(
    const FilePath& parent_dir,
    const FilePath& resource_name) {
  FilePath source;
  ASSERT_TRUE(PathService::Get(content::DIR_LAYOUT_TESTS, &source));
  source = source.Append(parent_dir);
  source = source.Append(resource_name);

  ASSERT_TRUE(file_util::PathExists(source));

  FilePath dest_parent_dir = scoped_temp_dir_.path().
      AppendASCII("LayoutTests").Append(parent_dir);
  ASSERT_TRUE(file_util::CreateDirectory(dest_parent_dir));
  FilePath dest = dest_parent_dir.Append(resource_name);

  if (file_util::DirectoryExists(source)) {
    ASSERT_TRUE(file_util::CreateDirectory(dest.DirName()));
    ASSERT_TRUE(file_util::CopyDirectory(source, dest, true));
  } else {
    ASSERT_TRUE(file_util::CopyFile(source, dest));
  }
}

void InProcessBrowserLayoutTest::WriteModifiedFile(
    const std::string& test_case_file_name, FilePath* test_path) {
  FilePath path_to_single_test =
      our_original_layout_test_dir_.AppendASCII(test_case_file_name);
  std::string test_html;
  ASSERT_TRUE(file_util::ReadFileToString(path_to_single_test, &test_html));

  size_t insertion_position = FindInsertPosition(test_html);
  test_html.insert(insertion_position, preamble);
  *test_path = our_layout_test_temp_dir_.Append(test_case_dir_);
  *test_path = test_path->AppendASCII(test_case_file_name);
  ASSERT_TRUE(file_util::WriteFile(*test_path,
                                   &test_html.at(0),
                                   static_cast<int>(test_html.size())));
}