directory_get_next_test.cc

// Copyright 2015 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 <queue>
#include <set>
#include <string>

#include "starboard/configuration.h"
#include "starboard/configuration_constants.h"
#include "starboard/directory.h"
#include "starboard/file.h"
#include "starboard/nplb/file_helpers.h"
#include "testing/gtest/include/gtest/gtest.h"

namespace starboard {
namespace nplb {
namespace {

typedef std::set<std::string> StringSet;

TEST(SbDirectoryGetNextTest, SunnyDay) {
  const int kNumFiles = 65;
  ScopedRandomFile files[kNumFiles];

  std::string directory_name = files[0].filename();
  directory_name.resize(directory_name.find_last_of(kSbFileSepChar));
  EXPECT_TRUE(SbFileExists(directory_name.c_str()))
      << "Missing directory: " << directory_name;

  SbFileError error = kSbFileErrorMax;
  SbDirectory directory = SbDirectoryOpen(directory_name.c_str(), &error);
  EXPECT_TRUE(SbDirectoryIsValid(directory));
  EXPECT_EQ(kSbFileOk, error);

  // Make sure all the files we created are found exactly once.
  StringSet names;
  for (int i = 0; i < SB_ARRAY_SIZE_INT(files); ++i) {
    names.insert(files[i].filename());
  }

  StringSet names_to_find(names);
  while (true) {
    std::vector<char> entry(kSbFileMaxName, 0);
    if (!SbDirectoryGetNext(directory, entry.data(), entry.size())) {
      break;
    }
    const char* entry_name = entry.data();

    // SbDirectoryEntry just contains the last component of the absolute path to
    // the file, but ScopedRandomFile::filename() returns the full path.
    std::string filename;
    filename += directory_name;
    filename += kSbFileSepChar;
    filename += entry_name;

    StringSet::iterator iterator = names_to_find.find(filename);
    if (iterator != names_to_find.end()) {
      names_to_find.erase(iterator);
    } else {
      // If it isn't in |names_to_find|, make sure it's some external entry and
      // not one of ours. Otherwise, an entry must have shown up twice.
      EXPECT_TRUE(names.find(entry_name) == names.end());
    }
  }

  // Make sure we found all of our names.
  EXPECT_EQ(0, names_to_find.size());

  EXPECT_TRUE(SbDirectoryClose(directory));
}

TEST(SbDirectoryGetNextTest, SunnyDayStaticContent) {
  std::string testdata_dir = GetFileTestsDataDir();
  EXPECT_FALSE(testdata_dir.empty());
  EXPECT_TRUE(SbFileExists(testdata_dir.c_str()))
      << "Missing directory: " << testdata_dir;

  // Make sure all the test directories and files are found exactly once.
  StringSet paths_to_find;
  for (auto path : GetFileTestsDirectoryPaths()) {
    paths_to_find.insert(path);
  }
  for (auto path : GetFileTestsFilePaths()) {
    paths_to_find.insert(path);
  }

  // Breadth-first traversal of our test data.
  std::queue<std::string> directory_queue;
  directory_queue.push(testdata_dir);
  while (!directory_queue.empty()) {
    std::string path = directory_queue.front();
    directory_queue.pop();

    SbFileError error = kSbFileErrorMax;
    SbDirectory directory = SbDirectoryOpen(path.c_str(), &error);
    EXPECT_TRUE(SbDirectoryIsValid(directory)) << "Can't open: " << path;
    EXPECT_EQ(kSbFileOk, error) << "Error opening: " << path;

    // Iterate all entries in this directory.
    while (true) {
      std::vector<char> entry(kSbFileMaxName, 0);
      if (!SbDirectoryGetNext(directory, entry.data(), entry.size())) {
        break;
      }
      std::string entry_name = entry.data();

      // Accept and ignore '.' and '..' directories.
      if (entry_name == "." || entry_name == "..") {
        continue;
      }

      // Absolute path of the entry.
      std::string entry_path = path + kSbFileSepChar + entry_name;

      StringSet::iterator iterator = paths_to_find.find(entry_path);
      if (iterator != paths_to_find.end()) {
        paths_to_find.erase(iterator);
      } else {
        ADD_FAILURE() << "Unexpected entry: " << entry_path;
      }

      // Traverse into the subdirectory.
      SbFileInfo file_info;
      EXPECT_TRUE(SbFileGetPathInfo(entry_path.c_str(), &file_info));
      if (file_info.is_directory) {
        directory_queue.push(entry_path);
      }
    }

    EXPECT_TRUE(SbDirectoryClose(directory));
  }

  // Make sure we found all of test data directories and files.
  EXPECT_EQ(0, paths_to_find.size());
  for (auto it = paths_to_find.begin(); it != paths_to_find.end(); ++it) {
    ADD_FAILURE() << "Missing entry: " << *it;
  }
}

TEST(SbDirectoryGetNextTest, FailureInvalidSbDirectory) {
  std::vector<char> entry(kSbFileMaxName, 0);
  EXPECT_FALSE(
      SbDirectoryGetNext(kSbDirectoryInvalid, entry.data(), entry.size()));
}

TEST(SbDirectoryGetNextTest, FailureNullEntry) {
  // Ensure there's at least one file in the directory.
  ScopedRandomFile file;

  std::string path = GetTempDir();
  EXPECT_FALSE(path.empty());
  EXPECT_TRUE(SbFileExists(path.c_str())) << "Directory is " << path;

  SbFileError error = kSbFileErrorMax;
  SbDirectory directory = SbDirectoryOpen(path.c_str(), &error);
  EXPECT_TRUE(SbDirectoryIsValid(directory));
  EXPECT_EQ(kSbFileOk, error);
  EXPECT_FALSE(SbDirectoryGetNext(directory, NULL, kSbFileMaxName));
  EXPECT_TRUE(SbDirectoryClose(directory));
}

TEST(SbDirectoryGetNextTest, FailureInvalidAndNull) {
  EXPECT_FALSE(SbDirectoryGetNext(kSbDirectoryInvalid, NULL, kSbFileMaxName));
}

TEST(SbDirectoryGetNextTest, FailureOnInsufficientSize) {
  ScopedRandomFile file;
  std::string directory_name = file.filename();
  directory_name.resize(directory_name.find_last_of(kSbFileSepChar));
  EXPECT_TRUE(SbFileExists(directory_name.c_str()))
      << "Directory_name is " << directory_name;

  SbFileError error = kSbFileErrorMax;
  SbDirectory directory = SbDirectoryOpen(directory_name.c_str(), &error);
  EXPECT_TRUE(SbDirectoryIsValid(directory));
  EXPECT_EQ(kSbFileOk, error);

  std::vector<char> entry(kSbFileMaxName);
  for (int i = 0; i < kSbFileMaxName; i++)
    entry[i] = i;
  std::vector<char> entry_copy = entry;
  EXPECT_EQ(SbDirectoryGetNext(directory, entry.data(), 0), false);
  EXPECT_EQ(entry.size(), kSbFileMaxName);
  for (int i = 0; i < kSbFileMaxName; i++)
    EXPECT_EQ(entry[i], entry_copy[i]);

  EXPECT_TRUE(SbDirectoryClose(directory));
}

}  // namespace
}  // namespace nplb
}  // namespace starboard