//===- unittest/Support/ProgramTest.cpp -----------------------------------===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#include "llvm/Support/ConvertUTF.h"
#include "llvm/Support/CommandLine.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/Path.h"
#include "llvm/Support/Program.h"
#include "gtest/gtest.h"
#include <stdlib.h>
#if defined(__APPLE__)
# include <crt_externs.h>
#elif !defined(_MSC_VER)
// Forward declare environ in case it's not provided by stdlib.h.
extern char **environ;
#endif
#if defined(LLVM_ON_UNIX)
#include <unistd.h>
void sleep_for(unsigned int seconds) {
sleep(seconds);
}
#elif defined(LLVM_ON_WIN32)
#include <windows.h>
void sleep_for(unsigned int seconds) {
Sleep(seconds * 1000);
}
#else
#error sleep_for is not implemented on your platform.
#endif
#define ASSERT_NO_ERROR(x) \
if (std::error_code ASSERT_NO_ERROR_ec = x) { \
SmallString<128> MessageStorage; \
raw_svector_ostream Message(MessageStorage); \
Message << #x ": did not return errc::success.\n" \
<< "error number: " << ASSERT_NO_ERROR_ec.value() << "\n" \
<< "error message: " << ASSERT_NO_ERROR_ec.message() << "\n"; \
GTEST_FATAL_FAILURE_(MessageStorage.c_str()); \
} else { \
}
// From TestMain.cpp.
extern const char *TestMainArgv0;
namespace {
using namespace llvm;
using namespace sys;
static cl::opt<std::string>
ProgramTestStringArg1("program-test-string-arg1");
static cl::opt<std::string>
ProgramTestStringArg2("program-test-string-arg2");
class ProgramEnvTest : public testing::Test {
std::vector<const char *> EnvTable;
std::vector<std::string> EnvStorage;
protected:
void SetUp() override {
auto EnvP = [] {
#if defined(LLVM_ON_WIN32)
_wgetenv(L"TMP"); // Populate _wenviron, initially is null
return _wenviron;
#elif defined(__APPLE__)
return *_NSGetEnviron();
#else
return environ;
#endif
}();
ASSERT_TRUE(EnvP);
auto prepareEnvVar = [this](decltype(*EnvP) Var) {
#if defined(LLVM_ON_WIN32)
// On Windows convert UTF16 encoded variable to UTF8
auto Len = wcslen(Var);
ArrayRef<char> Ref{reinterpret_cast<char const *>(Var),
Len * sizeof(*Var)};
EnvStorage.emplace_back();
auto convStatus = convertUTF16ToUTF8String(Ref, EnvStorage.back());
EXPECT_TRUE(convStatus);
return EnvStorage.back().c_str();
#else
return Var;
#endif
};
while (*EnvP != nullptr) {
EnvTable.emplace_back(prepareEnvVar(*EnvP));
++EnvP;
}
}
void TearDown() override {
EnvTable.clear();
EnvStorage.clear();
}
void addEnvVar(const char *Var) {
ASSERT_TRUE(EnvTable.empty() || EnvTable.back()) << "Env table sealed";
EnvTable.emplace_back(Var);
}
const char **getEnviron() {
if (EnvTable.back() != nullptr)
EnvTable.emplace_back(nullptr); // Seal table.
return &EnvTable[0];
}
};
#ifdef LLVM_ON_WIN32
TEST_F(ProgramEnvTest, CreateProcessLongPath) {
if (getenv("LLVM_PROGRAM_TEST_LONG_PATH"))
exit(0);
// getMainExecutable returns an absolute path; prepend the long-path prefix.
std::string MyAbsExe =
sys::fs::getMainExecutable(TestMainArgv0, &ProgramTestStringArg1);
std::string MyExe;
if (!StringRef(MyAbsExe).startswith("\\\\?\\"))
MyExe.append("\\\\?\\");
MyExe.append(MyAbsExe);
const char *ArgV[] = {
MyExe.c_str(),
"--gtest_filter=ProgramEnvTest.CreateProcessLongPath",
nullptr
};
// Add LLVM_PROGRAM_TEST_LONG_PATH to the environment of the child.
addEnvVar("LLVM_PROGRAM_TEST_LONG_PATH=1");
// Redirect stdout to a long path.
SmallString<128> TestDirectory;
ASSERT_NO_ERROR(
fs::createUniqueDirectory("program-redirect-test", TestDirectory));
SmallString<256> LongPath(TestDirectory);
LongPath.push_back('\\');
// MAX_PATH = 260
LongPath.append(260 - TestDirectory.size(), 'a');
StringRef LongPathRef(LongPath);
std::string Error;
bool ExecutionFailed;
const StringRef *Redirects[] = { nullptr, &LongPathRef, nullptr };
int RC = ExecuteAndWait(MyExe, ArgV, getEnviron(), Redirects,
/*secondsToWait=*/ 10, /*memoryLimit=*/ 0, &Error,
&ExecutionFailed);
EXPECT_FALSE(ExecutionFailed) << Error;
EXPECT_EQ(0, RC);
// Remove the long stdout.
ASSERT_NO_ERROR(fs::remove(Twine(LongPath)));
ASSERT_NO_ERROR(fs::remove(Twine(TestDirectory)));
}
#endif
TEST_F(ProgramEnvTest, CreateProcessTrailingSlash) {
if (getenv("LLVM_PROGRAM_TEST_CHILD")) {
if (ProgramTestStringArg1 == "has\\\\ trailing\\" &&
ProgramTestStringArg2 == "has\\\\ trailing\\") {
exit(0); // Success! The arguments were passed and parsed.
}
exit(1);
}
std::string my_exe =
sys::fs::getMainExecutable(TestMainArgv0, &ProgramTestStringArg1);
const char *argv[] = {
my_exe.c_str(),
"--gtest_filter=ProgramEnvTest.CreateProcessTrailingSlash",
"-program-test-string-arg1", "has\\\\ trailing\\",
"-program-test-string-arg2", "has\\\\ trailing\\",
nullptr
};
// Add LLVM_PROGRAM_TEST_CHILD to the environment of the child.
addEnvVar("LLVM_PROGRAM_TEST_CHILD=1");
std::string error;
bool ExecutionFailed;
// Redirect stdout and stdin to NUL, but let stderr through.
#ifdef LLVM_ON_WIN32
StringRef nul("NUL");
#else
StringRef nul("/dev/null");
#endif
const StringRef *redirects[] = { &nul, &nul, nullptr };
int rc = ExecuteAndWait(my_exe, argv, getEnviron(), redirects,
/*secondsToWait=*/ 10, /*memoryLimit=*/ 0, &error,
&ExecutionFailed);
EXPECT_FALSE(ExecutionFailed) << error;
EXPECT_EQ(0, rc);
}
TEST_F(ProgramEnvTest, TestExecuteNoWait) {
using namespace llvm::sys;
if (getenv("LLVM_PROGRAM_TEST_EXECUTE_NO_WAIT")) {
sleep_for(/*seconds*/ 1);
exit(0);
}
std::string Executable =
sys::fs::getMainExecutable(TestMainArgv0, &ProgramTestStringArg1);
const char *argv[] = {
Executable.c_str(),
"--gtest_filter=ProgramEnvTest.TestExecuteNoWait",
nullptr
};
// Add LLVM_PROGRAM_TEST_EXECUTE_NO_WAIT to the environment of the child.
addEnvVar("LLVM_PROGRAM_TEST_EXECUTE_NO_WAIT=1");
std::string Error;
bool ExecutionFailed;
ProcessInfo PI1 = ExecuteNoWait(Executable, argv, getEnviron(), nullptr, 0,
&Error, &ExecutionFailed);
ASSERT_FALSE(ExecutionFailed) << Error;
ASSERT_NE(PI1.Pid, ProcessInfo::InvalidPid) << "Invalid process id";
unsigned LoopCount = 0;
// Test that Wait() with WaitUntilTerminates=true works. In this case,
// LoopCount should only be incremented once.
while (true) {
++LoopCount;
ProcessInfo WaitResult = llvm::sys::Wait(PI1, 0, true, &Error);
ASSERT_TRUE(Error.empty());
if (WaitResult.Pid == PI1.Pid)
break;
}
EXPECT_EQ(LoopCount, 1u) << "LoopCount should be 1";
ProcessInfo PI2 = ExecuteNoWait(Executable, argv, getEnviron(), nullptr, 0,
&Error, &ExecutionFailed);
ASSERT_FALSE(ExecutionFailed) << Error;
ASSERT_NE(PI2.Pid, ProcessInfo::InvalidPid) << "Invalid process id";
// Test that Wait() with SecondsToWait=0 performs a non-blocking wait. In this
// cse, LoopCount should be greater than 1 (more than one increment occurs).
while (true) {
++LoopCount;
ProcessInfo WaitResult = llvm::sys::Wait(PI2, 0, false, &Error);
ASSERT_TRUE(Error.empty());
if (WaitResult.Pid == PI2.Pid)
break;
}
ASSERT_GT(LoopCount, 1u) << "LoopCount should be >1";
}
TEST_F(ProgramEnvTest, TestExecuteAndWaitTimeout) {
using namespace llvm::sys;
if (getenv("LLVM_PROGRAM_TEST_TIMEOUT")) {
sleep_for(/*seconds*/ 10);
exit(0);
}
std::string Executable =
sys::fs::getMainExecutable(TestMainArgv0, &ProgramTestStringArg1);
const char *argv[] = {
Executable.c_str(),
"--gtest_filter=ProgramEnvTest.TestExecuteAndWaitTimeout",
nullptr
};
// Add LLVM_PROGRAM_TEST_TIMEOUT to the environment of the child.
addEnvVar("LLVM_PROGRAM_TEST_TIMEOUT=1");
std::string Error;
bool ExecutionFailed;
int RetCode =
ExecuteAndWait(Executable, argv, getEnviron(), nullptr, /*secondsToWait=*/1, 0,
&Error, &ExecutionFailed);
ASSERT_EQ(-2, RetCode);
}
TEST(ProgramTest, TestExecuteNegative) {
std::string Executable = "i_dont_exist";
const char *argv[] = { Executable.c_str(), nullptr };
{
std::string Error;
bool ExecutionFailed;
int RetCode = ExecuteAndWait(Executable, argv, nullptr, nullptr, 0, 0,
&Error, &ExecutionFailed);
ASSERT_TRUE(RetCode < 0) << "On error ExecuteAndWait should return 0 or "
"positive value indicating the result code";
ASSERT_TRUE(ExecutionFailed);
ASSERT_FALSE(Error.empty());
}
{
std::string Error;
bool ExecutionFailed;
ProcessInfo PI = ExecuteNoWait(Executable, argv, nullptr, nullptr, 0,
&Error, &ExecutionFailed);
ASSERT_EQ(PI.Pid, ProcessInfo::InvalidPid)
<< "On error ExecuteNoWait should return an invalid ProcessInfo";
ASSERT_TRUE(ExecutionFailed);
ASSERT_FALSE(Error.empty());
}
}
#ifdef LLVM_ON_WIN32
const char utf16le_text[] =
"\x6c\x00\x69\x00\x6e\x00\x67\x00\xfc\x00\x69\x00\xe7\x00\x61\x00";
const char utf16be_text[] =
"\x00\x6c\x00\x69\x00\x6e\x00\x67\x00\xfc\x00\x69\x00\xe7\x00\x61";
#endif
const char utf8_text[] = "\x6c\x69\x6e\x67\xc3\xbc\x69\xc3\xa7\x61";
TEST(ProgramTest, TestWriteWithSystemEncoding) {
SmallString<128> TestDirectory;
ASSERT_NO_ERROR(fs::createUniqueDirectory("program-test", TestDirectory));
errs() << "Test Directory: " << TestDirectory << '\n';
errs().flush();
SmallString<128> file_pathname(TestDirectory);
path::append(file_pathname, "international-file.txt");
// Only on Windows we should encode in UTF16. For other systems, use UTF8
ASSERT_NO_ERROR(sys::writeFileWithEncoding(file_pathname.c_str(), utf8_text,
sys::WEM_UTF16));
int fd = 0;
ASSERT_NO_ERROR(fs::openFileForRead(file_pathname.c_str(), fd));
#if defined(LLVM_ON_WIN32)
char buf[18];
ASSERT_EQ(::read(fd, buf, 18), 18);
if (strncmp(buf, "\xfe\xff", 2) == 0) { // UTF16-BE
ASSERT_EQ(strncmp(&buf[2], utf16be_text, 16), 0);
} else if (strncmp(buf, "\xff\xfe", 2) == 0) { // UTF16-LE
ASSERT_EQ(strncmp(&buf[2], utf16le_text, 16), 0);
} else {
FAIL() << "Invalid BOM in UTF-16 file";
}
#else
char buf[10];
ASSERT_EQ(::read(fd, buf, 10), 10);
ASSERT_EQ(strncmp(buf, utf8_text, 10), 0);
#endif
::close(fd);
ASSERT_NO_ERROR(fs::remove(file_pathname.str()));
ASSERT_NO_ERROR(fs::remove(TestDirectory.str()));
}
} // end anonymous namespace