android_frameworks_base/libs/androidfw/tests/TestHelpers.cpp

/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * 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 "TestHelpers.h"

#include <libgen.h>
#include <unistd.h>

#include <memory>
#include <string>

#include "android-base/file.h"
#include "android-base/logging.h"
#include "android-base/strings.h"
#include "ziparchive/zip_archive.h"

namespace android {

static std::string sTestDataPath;

// Extract the directory of the current executable path.
static std::string GetExecutableDir() {
  const std::string path = base::GetExecutablePath();
  std::unique_ptr<char, decltype(&std::free)> mutable_path = {strdup(path.c_str()), std::free};
  std::string executable_dir = dirname(mutable_path.get());
  return executable_dir;
}

void InitializeTest(int* argc, char** argv) {
  // Set the default test data path to be the executable path directory.
  SetTestDataPath(GetExecutableDir());

  for (int i = 1; i < *argc; i++) {
    const std::string arg = argv[i];
    if (base::StartsWith(arg, "--testdata=")) {
      SetTestDataPath(arg.substr(strlen("--testdata=")));
      for (int j = i; j != *argc; j++) {
        argv[j] = argv[j + 1];
      }
      --(*argc);
      --i;
    } else if (arg == "-h" || arg == "--help") {
      std::cerr << "\nAdditional options specific to this test:\n"
                   "  --testdata=[PATH]\n"
                   "      Specify the location of test data used within the tests.\n";
      exit(1);
    }
  }
}

void SetTestDataPath(const std::string& path) { sTestDataPath = path; }

const std::string& GetTestDataPath() {
  CHECK(!sTestDataPath.empty()) << "no test data path set.";
  return sTestDataPath;
}

::testing::AssertionResult ReadFileFromZipToString(const std::string& zip_path,
                                                   const std::string& file,
                                                   std::string* out_contents) {
  out_contents->clear();
  ::ZipArchiveHandle handle;
  int32_t result = OpenArchive(zip_path.c_str(), &handle);
  if (result != 0) {
    return ::testing::AssertionFailure() << "Failed to open zip '" << zip_path
                                         << "': " << ::ErrorCodeString(result);
  }

  ::ZipString name(file.c_str());
  ::ZipEntry entry;
  result = ::FindEntry(handle, name, &entry);
  if (result != 0) {
    ::CloseArchive(handle);
    return ::testing::AssertionFailure() << "Could not find file '" << file << "' in zip '"
                                         << zip_path << "' : " << ::ErrorCodeString(result);
  }

  out_contents->resize(entry.uncompressed_length);
  result = ::ExtractToMemory(
      handle, &entry, const_cast<uint8_t*>(reinterpret_cast<const uint8_t*>(out_contents->data())),
      out_contents->size());
  if (result != 0) {
    ::CloseArchive(handle);
    return ::testing::AssertionFailure() << "Failed to extract file '" << file << "' from zip '"
                                         << zip_path << "': " << ::ErrorCodeString(result);
  }

  ::CloseArchive(handle);
  return ::testing::AssertionSuccess();
}

::testing::AssertionResult IsStringEqual(const ResTable& table, uint32_t resource_id,
                                         const char* expected_str) {
  Res_value val;
  ssize_t block = table.getResource(resource_id, &val, MAY_NOT_BE_BAG);
  if (block < 0) {
    return ::testing::AssertionFailure() << "could not find resource";
  }

  if (val.dataType != Res_value::TYPE_STRING) {
    return ::testing::AssertionFailure() << "resource is not a string";
  }

  const ResStringPool* pool = table.getTableStringBlock(block);
  if (pool == NULL) {
    return ::testing::AssertionFailure() << "table has no string pool for block " << block;
  }

  const String8 actual_str = pool->string8ObjectAt(val.data);
  if (String8(expected_str) != actual_str) {
    return ::testing::AssertionFailure() << actual_str.string();
  }
  return ::testing::AssertionSuccess() << actual_str.string();
}

std::string GetStringFromPool(const ResStringPool* pool, uint32_t idx) {
  String8 str = pool->string8ObjectAt(idx);
  return std::string(str.string(), str.length());
}

}  // namespace android