GTTF: Make ui_tests more reliable by using a temporary profile directory

chrome/test/ui/ui_test.cc

 // Copyright (c) 2010 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 "chrome/test/ui/ui_test.h"
 
 #if defined(OS_POSIX)
 #include <signal.h>
 #include <sys/types.h>
 #endif
 
 #include <set>
 #include <vector>
 
 #include "app/sql/connection.h"
 #include "base/base_switches.h"
 #include "base/command_line.h"
 #include "base/file_path.h"
 #include "base/file_util.h"
 #include "base/path_service.h"
 #include "base/platform_thread.h"
 #include "base/process_util.h"
 #include "base/scoped_ptr.h"
+#include "base/scoped_temp_dir.h"
 #include "base/string_util.h"
 #include "base/test/test_file_util.h"
 #include "base/time.h"
 #include "chrome/app/chrome_dll_resource.h"
 #include "chrome/browser/net/url_fixer_upper.h"
 #include "chrome/common/chrome_constants.h"
 #include "chrome/common/chrome_paths.h"
 #include "chrome/common/chrome_switches.h"
 #include "chrome/common/debug_flags.h"
 #include "chrome/common/logging_chrome.h"
@@ skipping 84 matching lines @@
       clear_profile_(true),
       include_testing_id_(true),
       enable_file_cookies_(true),
       profile_type_(UITestBase::DEFAULT_THEME),
       shutdown_type_(UITestBase::WINDOW_CLOSE),
       test_start_time_(Time::NowFromSystemTime()),
       command_execution_timeout_ms_(kCommandExecutionTimeout),
       action_timeout_ms_(kWaitForActionMsec),
       action_max_timeout_ms_(kWaitForActionMaxMsec),
       sleep_timeout_ms_(kWaitForActionMsec),
-      terminate_timeout_ms_(kWaitForTerminateMsec) {
+      terminate_timeout_ms_(kWaitForTerminateMsec),
+      temp_profile_dir_(new ScopedTempDir()) {
   PathService::Get(chrome::DIR_APP, &browser_directory_);
   PathService::Get(chrome::DIR_TEST_DATA, &test_data_directory_);
 }
 
 UITestBase::UITestBase(MessageLoop::Type msg_loop_type)
     : launch_arguments_(CommandLine::ARGUMENTS_ONLY),
       expected_errors_(0),
       expected_crashes_(0),
       homepage_(L"about:blank"),
       wait_for_initial_loads_(true),
@@ skipping 213 matching lines @@
 
 void UITestBase::StopHttpServer() {
   scoped_ptr<CommandLine> cmd_line(CreateHttpServerCommandLine());
   ASSERT_TRUE(cmd_line.get());
   cmd_line->AppendSwitchWithValue("server", "stop");
   RunCommand(*cmd_line.get());
 }
 
 void UITestBase::LaunchBrowser(const CommandLine& arguments,
                                bool clear_profile) {
-#if defined(OS_POSIX)
-  const char* alternative_userdir = getenv("CHROME_UI_TESTS_USER_DATA_DIR");
-#else
-  const FilePath::StringType::value_type* const alternative_userdir = NULL;
-#endif
+  if (clear_profile || !temp_profile_dir_->IsValid()) {
+    temp_profile_dir_.reset(new ScopedTempDir());
+    ASSERT_TRUE(temp_profile_dir_->CreateUniqueTempDir());
 
-  if (alternative_userdir) {
-    user_data_dir_ = FilePath(alternative_userdir);
-  } else {
-    PathService::Get(chrome::DIR_USER_DATA, &user_data_dir_);
+    // Update the information about user data directory location on the ui_test
+    // side. Using PathService seems to be the most reliable, consistent way
+    // to do that.
+    ASSERT_TRUE(PathService::Override(chrome::DIR_USER_DATA, user_data_dir()));
   }
 
-  // Clear user data directory to make sure test environment is consistent
-  // We balk on really short (absolute) user_data_dir directory names, because
-  // we're worried that they'd accidentally be root or something.
-  ASSERT_LT(10, static_cast<int>(user_data_dir_.value().size())) <<
-                "The user data directory name passed into this test was too "
-                "short to delete safely.  Please check the user-data-dir "
-                "argument and try again.";
-  if (clear_profile)
-    ASSERT_TRUE(file_util::DieFileDie(user_data_dir_, true));
-
   if (!template_user_data_.empty()) {
     // Recursively copy the template directory to the user_data_dir.
     ASSERT_TRUE(file_util::CopyRecursiveDirNoCache(
         template_user_data_,
-        user_data_dir_));
+        user_data_dir()));
     // If we're using the complex theme data, we need to write the
     // user_data_dir_ to our preferences file.
     if (profile_type_ == UITestBase::COMPLEX_THEME) {
-      RewritePreferencesFile(user_data_dir_);
+      RewritePreferencesFile(user_data_dir());
     }
 
     // Update the history file to include recent dates.
     UpdateHistoryDates();
   }
 
   ASSERT_TRUE(LaunchBrowserHelper(arguments, false, &process_));
   process_id_ = base::GetProcId(process_);
 }
 
@@ skipping 614 matching lines @@
   // Rewrite prefs file.
   std::vector<string16> subst;
   subst.push_back(WideToUTF16(user_data_dir_w));
   const std::string prefs_string =
       UTF16ToASCII(ReplaceStringPlaceholders(format_string, subst, NULL));
   EXPECT_TRUE(file_util::WriteFile(pref_path, prefs_string.c_str(),
                                    prefs_string.size()));
   file_util::EvictFileFromSystemCache(pref_path);
 }
 
+FilePath UITestBase::user_data_dir() const {
+  EXPECT_TRUE(temp_profile_dir_->IsValid());
+  return temp_profile_dir_->path();
+}
+
 // static
 FilePath UITestBase::ComputeTypicalUserDataSource(ProfileType profile_type) {
   FilePath source_history_file;
   EXPECT_TRUE(PathService::Get(chrome::DIR_TEST_DATA,
                                &source_history_file));
   source_history_file = source_history_file.AppendASCII("profiles");
   switch (profile_type) {
     case UITestBase::DEFAULT_THEME:
       source_history_file = source_history_file.AppendASCII("typical_history");
       break;
@@ skipping 82 matching lines @@
   command_line.AppendSwitch(switches::kNoFirstRun);
 
   // No default browser check, it would create an info-bar (if we are not the
   // default browser) that could conflicts with some tests expectations.
   command_line.AppendSwitch(switches::kNoDefaultBrowserCheck);
 
   // This is a UI test.
   command_line.AppendSwitchWithValue(switches::kTestType,
                                      ASCIIToWide(kUITestType));
 
+  // Tell the browser to use a temporary directory just for this test.
+  command_line.AppendSwitchWithValue(switches::kUserDataDir,
+                                     user_data_dir().ToWStringHack());
+
   // We need cookies on file:// for things like the page cycler.
   if (enable_file_cookies_)
     command_line.AppendSwitch(switches::kEnableFileCookies);
 
   if (dom_automation_enabled_)
     command_line.AppendSwitch(switches::kDomAutomationController);
 
   if (include_testing_id_) {
     command_line.AppendSwitchWithValue(switches::kTestingChannelID,
                                        ASCIIToWide(server_->channel_id()));
@@ skipping 16 matching lines @@
   if (silent_dump_on_dcheck_)
     command_line.AppendSwitch(switches::kSilentDumpOnDCHECK);
   if (disable_breakpad_)
     command_line.AppendSwitch(switches::kDisableBreakpad);
   if (!homepage_.empty())
     command_line.AppendSwitchWithValue(switches::kHomePage,
                                        homepage_);
   // Don't try to fetch web resources during UI testing.
   command_line.AppendSwitch(switches::kDisableWebResources);
 
-  if (!user_data_dir_.empty())
-    command_line.AppendSwitchWithValue(switches::kUserDataDir,
-                                       user_data_dir_.ToWStringHack());
   if (!js_flags_.empty())
     command_line.AppendSwitchWithValue(switches::kJavaScriptFlags,
                                        js_flags_);
   if (!log_level_.empty())
     command_line.AppendSwitchWithValue(switches::kLoggingLevel, log_level_);
 
   command_line.AppendSwitch(switches::kMetricsRecordingOnly);
 
   if (!CommandLine::ForCurrentProcess()->HasSwitch(kEnableErrorDialogs))
     command_line.AppendSwitch(switches::kEnableLogging);
@@ skipping 46 matching lines @@
 #endif
 
   return started;
 }
 
 void UITestBase::UpdateHistoryDates() {
   // Migrate the times in the segment_usage table to yesterday so we get
   // actual thumbnails on the NTP.
   sql::Connection db;
   FilePath history =
-      user_data_dir_.AppendASCII("Default").AppendASCII("History");
+      user_data_dir().AppendASCII("Default").AppendASCII("History");
   // Not all test profiles have a history file.
   if (!file_util::PathExists(history))
     return;
 
   ASSERT_TRUE(db.Open(history));
   Time yesterday = Time::Now() - TimeDelta::FromDays(1);
   std::string yesterday_str = Int64ToString(yesterday.ToInternalValue());
   std::string query = StringPrintf(
       "UPDATE segment_usage "
       "SET time_slot = %s "
@@ skipping 281 matching lines @@
     set_ui_test_name(ASCIIToWide(test_name));
   }
   UITestBase::SetUp();
   PlatformTest::SetUp();
 }
 
 void UITest::TearDown() {
   UITestBase::TearDown();
   PlatformTest::TearDown();
 }