chrome/browser/process_singleton_posix_unittest.cc

   1 // Copyright 2014 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 "chrome/browser/process_singleton.h"
   6
   7 #include <fcntl.h>
   8 #include <signal.h>
   9 #include <sys/types.h>
  10 #include <sys/un.h>
  11 #include <sys/wait.h>
  12 #include <unistd.h>
  13
  14 #include <string>
  15 #include <vector>
  16
  17 #include "base/bind.h"
  18 #include "base/command_line.h"
  19 #include "base/files/file_path.h"
  20 #include "base/files/file_util.h"
  21 #include "base/files/scoped_temp_dir.h"
  22 #include "base/message_loop/message_loop.h"
  23 #include "base/posix/eintr_wrapper.h"
  24 #include "base/strings/stringprintf.h"
  25 #include "base/synchronization/waitable_event.h"
  26 #include "base/test/test_timeouts.h"
  27 #include "base/test/thread_test_helper.h"
  28 #include "base/threading/thread.h"
  29 #include "chrome/common/chrome_constants.h"
  30 #include "content/public/test/test_browser_thread.h"
  31 #include "net/base/net_util.h"
  32 #include "testing/gtest/include/gtest/gtest.h"
  33
  34 using content::BrowserThread;
  35
  36 namespace {
  37
  38 class ProcessSingletonPosixTest : public testing::Test {
  39  public:
  40   // A ProcessSingleton exposing some protected methods for testing.
  41   class TestableProcessSingleton : public ProcessSingleton {
  42    public:
  43     explicit TestableProcessSingleton(const base::FilePath& user_data_dir)
  44         : ProcessSingleton(
  45             user_data_dir,
  46             base::Bind(&TestableProcessSingleton::NotificationCallback,
  47                        base::Unretained(this))) {}
  48
  49     std::vector<base::CommandLine::StringVector> callback_command_lines_;
  50
  51     using ProcessSingleton::NotifyOtherProcessWithTimeout;
  52     using ProcessSingleton::NotifyOtherProcessWithTimeoutOrCreate;
  53     using ProcessSingleton::OverrideCurrentPidForTesting;
  54     using ProcessSingleton::OverrideKillCallbackForTesting;
  55
  56    private:
  57     bool NotificationCallback(const base::CommandLine& command_line,
  58                               const base::FilePath& current_directory) {
  59       callback_command_lines_.push_back(command_line.argv());
  60       return true;
  61     }
  62   };
  63
  64   ProcessSingletonPosixTest()
  65       : kill_callbacks_(0),
  66         io_thread_(BrowserThread::IO),
  67         wait_event_(true, false),
  68         signal_event_(true, false),
  69         process_singleton_on_thread_(NULL) {
  70     io_thread_.StartIOThread();
  71   }
  72
  73   void SetUp() override {
  74     testing::Test::SetUp();
  75
  76     ProcessSingleton::DisablePromptForTesting();
  77     // Put the lock in a temporary directory.  Doesn't need to be a
  78     // full profile to test this code.
  79     ASSERT_TRUE(temp_dir_.CreateUniqueTempDir());
  80     // Use a long directory name to ensure that the socket isn't opened through
  81     // the symlink.
  82     user_data_path_ = temp_dir_.path().Append(
  83         std::string(sizeof(sockaddr_un::sun_path), 'a'));
  84     ASSERT_TRUE(CreateDirectory(user_data_path_));
  85
  86     lock_path_ = user_data_path_.Append(chrome::kSingletonLockFilename);
  87     socket_path_ = user_data_path_.Append(chrome::kSingletonSocketFilename);
  88     cookie_path_ = user_data_path_.Append(chrome::kSingletonCookieFilename);
  89   }
  90
  91   void TearDown() override {
  92     scoped_refptr<base::ThreadTestHelper> io_helper(new base::ThreadTestHelper(
  93         BrowserThread::GetMessageLoopProxyForThread(BrowserThread::IO).get()));
  94     ASSERT_TRUE(io_helper->Run());
  95
  96     // Destruct the ProcessSingleton object before the IO thread so that its
  97     // internals are destructed properly.
  98     if (process_singleton_on_thread_) {
  99       worker_thread_->message_loop()->PostTask(
 100           FROM_HERE,
 101           base::Bind(&ProcessSingletonPosixTest::DestructProcessSingleton,
 102                      base::Unretained(this)));
 103
 104       scoped_refptr<base::ThreadTestHelper> helper(new base::ThreadTestHelper(
 105           worker_thread_->message_loop_proxy().get()));
 106       ASSERT_TRUE(helper->Run());
 107     }
 108
 109     io_thread_.Stop();
 110     testing::Test::TearDown();
 111   }
 112
 113   void CreateProcessSingletonOnThread() {
 114     ASSERT_EQ(NULL, worker_thread_.get());
 115     worker_thread_.reset(new base::Thread("BlockingThread"));
 116     worker_thread_->Start();
 117
 118     worker_thread_->message_loop()->PostTask(
 119        FROM_HERE,
 120        base::Bind(&ProcessSingletonPosixTest::
 121                       CreateProcessSingletonInternal,
 122                   base::Unretained(this)));
 123
 124     scoped_refptr<base::ThreadTestHelper> helper(
 125         new base::ThreadTestHelper(worker_thread_->message_loop_proxy().get()));
 126     ASSERT_TRUE(helper->Run());
 127   }
 128
 129   TestableProcessSingleton* CreateProcessSingleton() {
 130     return new TestableProcessSingleton(user_data_path_);
 131   }
 132
 133   void VerifyFiles() {
 134     struct stat statbuf;
 135     ASSERT_EQ(0, lstat(lock_path_.value().c_str(), &statbuf));
 136     ASSERT_TRUE(S_ISLNK(statbuf.st_mode));
 137     char buf[PATH_MAX];
 138     ssize_t len = readlink(lock_path_.value().c_str(), buf, PATH_MAX);
 139     ASSERT_GT(len, 0);
 140
 141     ASSERT_EQ(0, lstat(socket_path_.value().c_str(), &statbuf));
 142     ASSERT_TRUE(S_ISLNK(statbuf.st_mode));
 143
 144     len = readlink(socket_path_.value().c_str(), buf, PATH_MAX);
 145     ASSERT_GT(len, 0);
 146     base::FilePath socket_target_path = base::FilePath(std::string(buf, len));
 147
 148     ASSERT_EQ(0, lstat(socket_target_path.value().c_str(), &statbuf));
 149     ASSERT_TRUE(S_ISSOCK(statbuf.st_mode));
 150
 151     len = readlink(cookie_path_.value().c_str(), buf, PATH_MAX);
 152     ASSERT_GT(len, 0);
 153     std::string cookie(buf, len);
 154
 155     base::FilePath remote_cookie_path = socket_target_path.DirName().
 156         Append(chrome::kSingletonCookieFilename);
 157     len = readlink(remote_cookie_path.value().c_str(), buf, PATH_MAX);
 158     ASSERT_GT(len, 0);
 159     EXPECT_EQ(cookie, std::string(buf, len));
 160   }
 161
 162   ProcessSingleton::NotifyResult NotifyOtherProcess(bool override_kill) {
 163     scoped_ptr<TestableProcessSingleton> process_singleton(
 164         CreateProcessSingleton());
 165     base::CommandLine command_line(
 166         base::CommandLine::ForCurrentProcess()->GetProgram());
 167     command_line.AppendArg("about:blank");
 168     if (override_kill) {
 169       process_singleton->OverrideCurrentPidForTesting(
 170           base::GetCurrentProcId() + 1);
 171       process_singleton->OverrideKillCallbackForTesting(
 172           base::Bind(&ProcessSingletonPosixTest::KillCallback,
 173                      base::Unretained(this)));
 174     }
 175
 176     return process_singleton->NotifyOtherProcessWithTimeout(
 177         command_line, kRetryAttempts, timeout(), true);
 178   }
 179
 180   // A helper method to call ProcessSingleton::NotifyOtherProcessOrCreate().
 181   ProcessSingleton::NotifyResult NotifyOtherProcessOrCreate(
 182       const std::string& url) {
 183     scoped_ptr<TestableProcessSingleton> process_singleton(
 184         CreateProcessSingleton());
 185     base::CommandLine command_line(
 186         base::CommandLine::ForCurrentProcess()->GetProgram());
 187     command_line.AppendArg(url);
 188     return process_singleton->NotifyOtherProcessWithTimeoutOrCreate(
 189         command_line, kRetryAttempts, timeout());
 190   }
 191
 192   void CheckNotified() {
 193     ASSERT_TRUE(process_singleton_on_thread_ != NULL);
 194     ASSERT_EQ(1u, process_singleton_on_thread_->callback_command_lines_.size());
 195     bool found = false;
 196     for (size_t i = 0;
 197          i < process_singleton_on_thread_->callback_command_lines_[0].size();
 198          ++i) {
 199       if (process_singleton_on_thread_->callback_command_lines_[0][i] ==
 200           "about:blank") {
 201         found = true;
 202         break;
 203       }
 204     }
 205     ASSERT_TRUE(found);
 206     ASSERT_EQ(0, kill_callbacks_);
 207   }
 208
 209   void BlockWorkerThread() {
 210     worker_thread_->message_loop()->PostTask(
 211         FROM_HERE,
 212         base::Bind(&ProcessSingletonPosixTest::BlockThread,
 213                    base::Unretained(this)));
 214   }
 215
 216   void UnblockWorkerThread() {
 217     wait_event_.Signal();  // Unblock the worker thread for shutdown.
 218     signal_event_.Wait();  // Ensure thread unblocks before continuing.
 219   }
 220
 221   void BlockThread() {
 222     wait_event_.Wait();
 223     signal_event_.Signal();
 224   }
 225
 226   base::FilePath user_data_path_;
 227   base::FilePath lock_path_;
 228   base::FilePath socket_path_;
 229   base::FilePath cookie_path_;
 230   int kill_callbacks_;
 231
 232  private:
 233   static const int kRetryAttempts = 2;
 234
 235   base::TimeDelta timeout() const {
 236     return TestTimeouts::tiny_timeout() * kRetryAttempts;
 237   }
 238
 239   void CreateProcessSingletonInternal() {
 240     ASSERT_TRUE(!process_singleton_on_thread_);
 241     process_singleton_on_thread_ = CreateProcessSingleton();
 242     ASSERT_EQ(ProcessSingleton::PROCESS_NONE,
 243               process_singleton_on_thread_->NotifyOtherProcessOrCreate());
 244   }
 245
 246   void DestructProcessSingleton() {
 247     ASSERT_TRUE(process_singleton_on_thread_);
 248     delete process_singleton_on_thread_;
 249   }
 250
 251   void KillCallback(int pid) {
 252     kill_callbacks_++;
 253   }
 254
 255   content::TestBrowserThread io_thread_;
 256   base::ScopedTempDir temp_dir_;
 257   base::WaitableEvent wait_event_;
 258   base::WaitableEvent signal_event_;
 259
 260   scoped_ptr<base::Thread> worker_thread_;
 261   TestableProcessSingleton* process_singleton_on_thread_;
 262 };
 263
 264 }  // namespace
 265
 266 // Test if the socket file and symbol link created by ProcessSingletonPosix
 267 // are valid.
 268 // If this test flakes, use http://crbug.com/74554.
 269 TEST_F(ProcessSingletonPosixTest, CheckSocketFile) {
 270   CreateProcessSingletonOnThread();
 271   VerifyFiles();
 272 }
 273
 274 // TODO(james.su@gmail.com): port following tests to Windows.
 275 // Test success case of NotifyOtherProcess().
 276 TEST_F(ProcessSingletonPosixTest, NotifyOtherProcessSuccess) {
 277   CreateProcessSingletonOnThread();
 278   EXPECT_EQ(ProcessSingleton::PROCESS_NOTIFIED, NotifyOtherProcess(true));
 279   CheckNotified();
 280 }
 281
 282 // Test failure case of NotifyOtherProcess().
 283 TEST_F(ProcessSingletonPosixTest, NotifyOtherProcessFailure) {
 284   CreateProcessSingletonOnThread();
 285
 286   BlockWorkerThread();
 287   EXPECT_EQ(ProcessSingleton::PROCESS_NONE, NotifyOtherProcess(true));
 288   ASSERT_EQ(1, kill_callbacks_);
 289   UnblockWorkerThread();
 290 }
 291
 292 // Test that we don't kill ourselves by accident if a lockfile with the same pid
 293 // happens to exist.
 294 TEST_F(ProcessSingletonPosixTest, NotifyOtherProcessNoSuicide) {
 295   CreateProcessSingletonOnThread();
 296   // Replace lockfile with one containing our own pid.
 297   EXPECT_EQ(0, unlink(lock_path_.value().c_str()));
 298   std::string symlink_content = base::StringPrintf(
 299       "%s%c%u",
 300       net::GetHostName().c_str(),
 301       '-',
 302       base::GetCurrentProcId());
 303   EXPECT_EQ(0, symlink(symlink_content.c_str(), lock_path_.value().c_str()));
 304
 305   // Remove socket so that we will not be able to notify the existing browser.
 306   EXPECT_EQ(0, unlink(socket_path_.value().c_str()));
 307
 308   EXPECT_EQ(ProcessSingleton::PROCESS_NONE, NotifyOtherProcess(false));
 309   // If we've gotten to this point without killing ourself, the test succeeded.
 310 }
 311
 312 // Test that we can still notify a process on the same host even after the
 313 // hostname changed.
 314 TEST_F(ProcessSingletonPosixTest, NotifyOtherProcessHostChanged) {
 315   CreateProcessSingletonOnThread();
 316   EXPECT_EQ(0, unlink(lock_path_.value().c_str()));
 317   EXPECT_EQ(0, symlink("FAKEFOOHOST-1234", lock_path_.value().c_str()));
 318
 319   EXPECT_EQ(ProcessSingleton::PROCESS_NOTIFIED, NotifyOtherProcess(false));
 320   CheckNotified();
 321 }
 322
 323 // Test that we fail when lock says process is on another host and we can't
 324 // notify it over the socket.
 325 TEST_F(ProcessSingletonPosixTest, NotifyOtherProcessDifferingHost) {
 326   CreateProcessSingletonOnThread();
 327
 328   BlockWorkerThread();
 329
 330   EXPECT_EQ(0, unlink(lock_path_.value().c_str()));
 331   EXPECT_EQ(0, symlink("FAKEFOOHOST-1234", lock_path_.value().c_str()));
 332
 333   EXPECT_EQ(ProcessSingleton::PROFILE_IN_USE, NotifyOtherProcess(false));
 334
 335   ASSERT_EQ(0, unlink(lock_path_.value().c_str()));
 336
 337   UnblockWorkerThread();
 338 }
 339
 340 // Test that we fail when lock says process is on another host and we can't
 341 // notify it over the socket.
 342 TEST_F(ProcessSingletonPosixTest, NotifyOtherProcessOrCreate_DifferingHost) {
 343   CreateProcessSingletonOnThread();
 344
 345   BlockWorkerThread();
 346
 347   EXPECT_EQ(0, unlink(lock_path_.value().c_str()));
 348   EXPECT_EQ(0, symlink("FAKEFOOHOST-1234", lock_path_.value().c_str()));
 349
 350   std::string url("about:blank");
 351   EXPECT_EQ(ProcessSingleton::PROFILE_IN_USE, NotifyOtherProcessOrCreate(url));
 352
 353   ASSERT_EQ(0, unlink(lock_path_.value().c_str()));
 354
 355   UnblockWorkerThread();
 356 }
 357
 358 // Test that Create fails when another browser is using the profile directory.
 359 TEST_F(ProcessSingletonPosixTest, CreateFailsWithExistingBrowser) {
 360   CreateProcessSingletonOnThread();
 361
 362   scoped_ptr<TestableProcessSingleton> process_singleton(
 363       CreateProcessSingleton());
 364   process_singleton->OverrideCurrentPidForTesting(base::GetCurrentProcId() + 1);
 365   EXPECT_FALSE(process_singleton->Create());
 366 }
 367
 368 // Test that Create fails when another browser is using the profile directory
 369 // but with the old socket location.
 370 TEST_F(ProcessSingletonPosixTest, CreateChecksCompatibilitySocket) {
 371   CreateProcessSingletonOnThread();
 372   scoped_ptr<TestableProcessSingleton> process_singleton(
 373       CreateProcessSingleton());
 374   process_singleton->OverrideCurrentPidForTesting(base::GetCurrentProcId() + 1);
 375
 376   // Do some surgery so as to look like the old configuration.
 377   char buf[PATH_MAX];
 378   ssize_t len = readlink(socket_path_.value().c_str(), buf, sizeof(buf));
 379   ASSERT_GT(len, 0);
 380   base::FilePath socket_target_path = base::FilePath(std::string(buf, len));
 381   ASSERT_EQ(0, unlink(socket_path_.value().c_str()));
 382   ASSERT_EQ(0, rename(socket_target_path.value().c_str(),
 383                       socket_path_.value().c_str()));
 384   ASSERT_EQ(0, unlink(cookie_path_.value().c_str()));
 385
 386   EXPECT_FALSE(process_singleton->Create());
 387 }
 388
 389 // Test that we fail when lock says process is on another host and we can't
 390 // notify it over the socket before of a bad cookie.
 391 TEST_F(ProcessSingletonPosixTest, NotifyOtherProcessOrCreate_BadCookie) {
 392   CreateProcessSingletonOnThread();
 393   // Change the cookie.
 394   EXPECT_EQ(0, unlink(cookie_path_.value().c_str()));
 395   EXPECT_EQ(0, symlink("INCORRECTCOOKIE", cookie_path_.value().c_str()));
 396
 397   // Also change the hostname, so the remote does not retry.
 398   EXPECT_EQ(0, unlink(lock_path_.value().c_str()));
 399   EXPECT_EQ(0, symlink("FAKEFOOHOST-1234", lock_path_.value().c_str()));
 400
 401   std::string url("about:blank");
 402   EXPECT_EQ(ProcessSingleton::PROFILE_IN_USE, NotifyOtherProcessOrCreate(url));
 403 }
 404
 405 #if defined(OS_MACOSX)
 406 // Test that if there is an existing lock file, and we could not flock()
 407 // it, then exit.
 408 TEST_F(ProcessSingletonPosixTest, CreateRespectsOldMacLock) {
 409   scoped_ptr<TestableProcessSingleton> process_singleton(
 410       CreateProcessSingleton());
 411   base::ScopedFD lock_fd(HANDLE_EINTR(
 412       open(lock_path_.value().c_str(), O_RDWR | O_CREAT | O_EXLOCK, 0644)));
 413   ASSERT_TRUE(lock_fd.is_valid());
 414   EXPECT_FALSE(process_singleton->Create());
 415   base::File::Info info;
 416   EXPECT_TRUE(base::GetFileInfo(lock_path_, &info));
 417   EXPECT_FALSE(info.is_directory);
 418   EXPECT_FALSE(info.is_symbolic_link);
 419 }
 420
 421 // Test that if there is an existing lock file, and it's not locked, we replace
 422 // it.
 423 TEST_F(ProcessSingletonPosixTest, CreateReplacesOldMacLock) {
 424   scoped_ptr<TestableProcessSingleton> process_singleton(
 425       CreateProcessSingleton());
 426   EXPECT_EQ(0, base::WriteFile(lock_path_, "", 0));
 427   EXPECT_TRUE(process_singleton->Create());
 428   VerifyFiles();
 429 }
 430 #endif  // defined(OS_MACOSX)