starboard/loader_app/drain_file_test.cc

// Copyright 2020 The Cobalt Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include "starboard/loader_app/drain_file.h"

#include <string>
#include <vector>

#include "starboard/common/file.h"
#include "starboard/common/log.h"
#include "starboard/common/string.h"
#include "starboard/common/time.h"
#include "starboard/configuration_constants.h"
#include "starboard/directory.h"
#include "starboard/loader_app/drain_file_helper.h"
#include "starboard/system.h"
#include "starboard/types.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace starboard {
namespace loader_app {
namespace {

const char kAppKeyOne[] = "b25lDQo=";
const char kAppKeyTwo[] = "dHdvDQo=";
const char kAppKeyThree[] = "dGhyZWUNCg==";

class DrainFileTest : public ::testing::Test {
 protected:
  void SetUp() override {
    temp_dir_.resize(kSbFileMaxPath);
    ASSERT_TRUE(SbSystemGetPath(kSbSystemPathTempDirectory, temp_dir_.data(),
                                temp_dir_.size()));

    // Use dedicated dir for testing to avoid meddling with other files.
    starboard::strlcat(temp_dir_.data(), kSbFileSepString, kSbFileMaxPath);
    starboard::strlcat(temp_dir_.data(), "df", kSbFileMaxPath);
    ASSERT_TRUE(SbDirectoryCreate(temp_dir_.data()));
  }

  void TearDown() override { DrainFileClearForApp(GetTempDir(), ""); }

  const char* GetTempDir() const { return temp_dir_.data(); }

 private:
  std::vector<char> temp_dir_;
};

// Typical drain file usage.
TEST_F(DrainFileTest, SunnyDay) {
  EXPECT_TRUE(DrainFileTryDrain(GetTempDir(), kAppKeyOne));
  EXPECT_TRUE(DrainFileRankAndCheck(GetTempDir(), kAppKeyOne));
}

// Drain file creation should ignore expired files, even if it has a matching
// app key.
TEST_F(DrainFileTest, SunnyDayIgnoreExpired) {
  ScopedDrainFile stale(
      GetTempDir(), kAppKeyOne,
      PosixTimeToWindowsTime(CurrentPosixTime()) - kDrainFileMaximumAgeUsec);

  EXPECT_FALSE(DrainFileIsAppDraining(GetTempDir(), kAppKeyOne));
  EXPECT_TRUE(DrainFileTryDrain(GetTempDir(), kAppKeyOne));
  EXPECT_TRUE(DrainFileIsAppDraining(GetTempDir(), kAppKeyOne));
}

// Previously created drain file should be reused if it has not expired.
TEST_F(DrainFileTest, SunnyDayTryDrainReusePreviousDrainFile) {
  for (int i = 0; i < 2; ++i)
    EXPECT_TRUE(DrainFileTryDrain(GetTempDir(), kAppKeyOne));
}

// Draining status should return whether or not the file exists and has not yet
// expired.
TEST_F(DrainFileTest, SunnyDayDraining) {
  EXPECT_FALSE(DrainFileIsAppDraining(GetTempDir(), kAppKeyOne));
  EXPECT_TRUE(DrainFileTryDrain(GetTempDir(), kAppKeyOne));
  EXPECT_TRUE(DrainFileIsAppDraining(GetTempDir(), kAppKeyOne));

  DrainFileClearForApp(GetTempDir(), kAppKeyOne);

  EXPECT_FALSE(DrainFileIsAppDraining(GetTempDir(), kAppKeyOne));
}

// Check if another app is draining.
TEST_F(DrainFileTest, SunnyDayAnotherAppDraining) {
  EXPECT_FALSE(DrainFileIsAppDraining(GetTempDir(), kAppKeyOne));
  EXPECT_FALSE(DrainFileIsAppDraining(GetTempDir(), kAppKeyTwo));
  EXPECT_FALSE(DrainFileIsAnotherAppDraining(GetTempDir(), kAppKeyOne));
  EXPECT_FALSE(DrainFileIsAnotherAppDraining(GetTempDir(), kAppKeyTwo));

  EXPECT_TRUE(DrainFileTryDrain(GetTempDir(), kAppKeyOne));
  EXPECT_TRUE(DrainFileIsAppDraining(GetTempDir(), kAppKeyOne));
  EXPECT_TRUE(DrainFileIsAnotherAppDraining(GetTempDir(), kAppKeyTwo));

  DrainFileClearForApp(GetTempDir(), kAppKeyOne);
  EXPECT_FALSE(DrainFileIsAppDraining(GetTempDir(), kAppKeyOne));
  EXPECT_FALSE(DrainFileIsAnotherAppDraining(GetTempDir(), kAppKeyTwo));
}

// Remove an existing drain file.
TEST_F(DrainFileTest, SunnyDayRemove) {
  EXPECT_TRUE(DrainFileTryDrain(GetTempDir(), kAppKeyOne));
  EXPECT_TRUE(DrainFileIsAppDraining(GetTempDir(), kAppKeyOne));
  DrainFileClearForApp(GetTempDir(), kAppKeyOne);
  EXPECT_FALSE(DrainFileIsAppDraining(GetTempDir(), kAppKeyOne));
}

// Clear only expired drain files.
TEST_F(DrainFileTest, SunnyDayClearExpired) {
  EXPECT_TRUE(DrainFileTryDrain(GetTempDir(), kAppKeyOne));

  ScopedDrainFile valid_file(GetTempDir(), kAppKeyTwo,
                             PosixTimeToWindowsTime(CurrentPosixTime()));
  ScopedDrainFile stale_file(
      GetTempDir(), kAppKeyThree,
      PosixTimeToWindowsTime(CurrentPosixTime()) - kDrainFileMaximumAgeUsec);

  EXPECT_TRUE(DrainFileIsAppDraining(GetTempDir(), kAppKeyOne));
  EXPECT_TRUE(DrainFileIsAppDraining(GetTempDir(), kAppKeyTwo));
  EXPECT_TRUE(SbFileExists(stale_file.path().c_str()));

  DrainFileClearExpired(GetTempDir());

  EXPECT_FALSE(SbFileExists(stale_file.path().c_str()));
}

// Clearing drain files for an app.
TEST_F(DrainFileTest, SunnyDayClearForApp) {
  EXPECT_TRUE(DrainFileTryDrain(GetTempDir(), kAppKeyOne));

  ScopedDrainFile valid_file(GetTempDir(), kAppKeyTwo,
                             PosixTimeToWindowsTime(CurrentPosixTime()));
  ScopedDrainFile stale_file(
      GetTempDir(), kAppKeyThree,
      PosixTimeToWindowsTime(CurrentPosixTime()) - kDrainFileMaximumAgeUsec);

  EXPECT_TRUE(DrainFileIsAppDraining(GetTempDir(), kAppKeyOne));
  EXPECT_TRUE(DrainFileIsAppDraining(GetTempDir(), kAppKeyTwo));
  EXPECT_TRUE(SbFileExists(stale_file.path().c_str()));

  // clean all drain files for an app
  DrainFileClearForApp(GetTempDir(), kAppKeyOne);

  EXPECT_FALSE(DrainFileIsAppDraining(GetTempDir(), kAppKeyOne));
  EXPECT_TRUE(DrainFileIsAppDraining(GetTempDir(), kAppKeyTwo));
  EXPECT_TRUE(SbFileExists(stale_file.path().c_str()));
}

// Ranking drain files should first be done by timestamp, with the app key being
// used as a tie breaker.
TEST_F(DrainFileTest, SunnyDayRankCorrectlyRanksFiles) {
  const int64_t timestamp = PosixTimeToWindowsTime(CurrentPosixTime());

  ScopedDrainFile early_and_least(GetTempDir(), "a", timestamp);
  ScopedDrainFile later_and_least(GetTempDir(), "c", timestamp);
  ScopedDrainFile later_and_greatest(GetTempDir(), "b",
                                     timestamp + kDrainFileAgeUnitUsec);

  std::vector<char> result(kSbFileMaxName);

  EXPECT_TRUE(DrainFileRankAndCheck(GetTempDir(), "a"));
  EXPECT_TRUE(SbFileDelete(early_and_least.path().c_str()));

  EXPECT_TRUE(DrainFileRankAndCheck(GetTempDir(), "c"));
  EXPECT_TRUE(SbFileDelete(later_and_least.path().c_str()));

  EXPECT_TRUE(DrainFileRankAndCheck(GetTempDir(), "b"));
  EXPECT_TRUE(SbFileDelete(later_and_greatest.path().c_str()));
}

// Ranking drain files should ignore expired files.
TEST_F(DrainFileTest, SunnyDayRankCorrectlyIgnoresExpired) {
  const int64_t timestamp = PosixTimeToWindowsTime(CurrentPosixTime());

  ScopedDrainFile early_and_expired(GetTempDir(), "a",
                                    timestamp - kDrainFileMaximumAgeUsec);
  ScopedDrainFile later_and_least(GetTempDir(), "c", timestamp);
  ScopedDrainFile later_and_greatest(GetTempDir(), "b",
                                     timestamp + kDrainFileAgeUnitUsec);

  std::vector<char> result(kSbFileMaxName);

  EXPECT_TRUE(DrainFileRankAndCheck(GetTempDir(), "c"));
  EXPECT_TRUE(SbFileDelete(later_and_least.path().c_str()));

  EXPECT_TRUE(DrainFileRankAndCheck(GetTempDir(), "b"));
  EXPECT_TRUE(SbFileDelete(later_and_greatest.path().c_str()));

  // Even though "a" is still there Rank should find nothing since it's expired.
  EXPECT_TRUE(DrainFileRankAndCheck(GetTempDir(), ""));
  EXPECT_TRUE(SbFileDelete(early_and_expired.path().c_str()));
}

// Tests the "racing updaters" scenario.
TEST_F(DrainFileTest, RankAndCheckWithFirstRankedFileFromOtherAppReturnsFalse) {
  const int64_t timestamp = PosixTimeToWindowsTime(CurrentPosixTime());

  ScopedDrainFile earlier(GetTempDir(), "a", timestamp);
  ScopedDrainFile later(GetTempDir(), "b", timestamp + kDrainFileAgeUnitUsec);

  EXPECT_FALSE(DrainFileRankAndCheck(GetTempDir(), "b"));
}

// All files in the directory should be cleared except for drain files with an
// app key matching the provided app key.
TEST_F(DrainFileTest, SunnyDayPrepareDirectory) {
  EXPECT_TRUE(DrainFileTryDrain(GetTempDir(), kAppKeyOne));

  // Create a directory to delete.
  std::string dir(GetTempDir());
  dir.append(kSbFileSepString);
  dir.append("to_delete");

  EXPECT_TRUE(SbDirectoryCreate(dir.c_str()));
  EXPECT_TRUE(SbFileExists(dir.c_str()));

  // Create a file with the app key in the name.
  std::string path(GetTempDir());
  path.append(kSbFileSepString);
  path.append(kAppKeyOne);

  {
    ScopedFile file(path.c_str(), kSbFileOpenAlways | kSbFileWrite, NULL, NULL);
  }

  EXPECT_TRUE(SbFileExists(path.c_str()));

  DrainFilePrepareDirectory(GetTempDir(), kAppKeyOne);

  EXPECT_TRUE(DrainFileRankAndCheck(GetTempDir(), kAppKeyOne));
  EXPECT_FALSE(SbFileExists(dir.c_str()));
  EXPECT_FALSE(SbFileExists(path.c_str()));

  DrainFilePrepareDirectory(GetTempDir(), "nonexistent");

  EXPECT_FALSE(DrainFileRankAndCheck(GetTempDir(), kAppKeyOne));
}

// Creating a new drain file in the same directory as an existing, valid drain
// file should fail.
TEST_F(DrainFileTest, RainyDayDrainFileAlreadyExists) {
  EXPECT_TRUE(DrainFileTryDrain(GetTempDir(), kAppKeyOne));
  EXPECT_FALSE(DrainFileTryDrain(GetTempDir(), kAppKeyTwo));
}

}  // namespace
}  // namespace loader_app
}  // namespace starboard