/*
- * Copyright 2015 Facebook, Inc.
+ * Copyright 2017 Facebook, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <folly/Subprocess.h>
-#include <unistd.h>
#include <sys/types.h>
-#include <dirent.h>
#include <boost/container/flat_set.hpp>
#include <glog/logging.h>
-#include <gtest/gtest.h>
#include <folly/Exception.h>
-#include <folly/Format.h>
#include <folly/FileUtil.h>
+#include <folly/Format.h>
#include <folly/String.h>
+#include <folly/experimental/TestUtil.h>
+#include <folly/experimental/io/FsUtil.h>
#include <folly/gen/Base.h>
#include <folly/gen/File.h>
#include <folly/gen/String.h>
-#include <folly/experimental/TestUtil.h>
-#include <folly/experimental/io/FsUtil.h>
+#include <folly/portability/GTest.h>
+#include <folly/portability/Unistd.h>
+
+FOLLY_GCC_DISABLE_WARNING("-Wdeprecated-declarations")
using namespace folly;
proc.waitChecked();
}
+TEST(SimpleSubprocessTest, CloneFlagsWithVfork) {
+ Subprocess proc(
+ std::vector<std::string>{"/bin/true"},
+ Subprocess::Options().useCloneWithFlags(SIGCHLD | CLONE_VFORK));
+ EXPECT_EQ(0, proc.wait().exitStatus());
+}
+
+TEST(SimpleSubprocessTest, CloneFlagsWithFork) {
+ Subprocess proc(
+ std::vector<std::string>{"/bin/true"},
+ Subprocess::Options().useCloneWithFlags(SIGCHLD));
+ EXPECT_EQ(0, proc.wait().exitStatus());
+}
+
+TEST(SimpleSubprocessTest, CloneFlagsSubprocessCtorExitsAfterExec) {
+ Subprocess proc(
+ std::vector<std::string>{"/bin/sleep", "3600"},
+ Subprocess::Options().useCloneWithFlags(SIGCHLD));
+ checkUnixError(::kill(proc.pid(), SIGKILL), "kill");
+ auto retCode = proc.wait();
+ EXPECT_TRUE(retCode.killed());
+}
+
TEST(SimpleSubprocessTest, ExitsWithError) {
Subprocess proc(std::vector<std::string>{ "/bin/false" });
EXPECT_EQ(1, proc.wait().exitStatus());
// Now old_proc is destroyed, but we don't crash.
}
+TEST(SimpleSubprocessTest, DefaultConstructor) {
+ Subprocess proc;
+ EXPECT_TRUE(proc.returnCode().notStarted());
+
+ {
+ auto p1 = Subprocess(std::vector<std::string>{"/bin/true"});
+ proc = std::move(p1);
+ }
+
+ EXPECT_TRUE(proc.returnCode().running());
+ EXPECT_EQ(0, proc.wait().exitStatus());
+}
+
#define EXPECT_SPAWN_ERROR(err, errMsg, cmd, ...) \
do { \
try { \
});
// Normal execution with pipes
checkFdLeak([] {
- Subprocess proc("echo foo; echo bar >&2",
- Subprocess::pipeStdout() | Subprocess::pipeStderr());
+ Subprocess proc(
+ "echo foo; echo bar >&2",
+ Subprocess::Options().pipeStdout().pipeStderr());
auto p = proc.communicate();
EXPECT_EQ("foo\n", p.first);
EXPECT_EQ("bar\n", p.second);
// Test where the exec call fails() with pipes
checkFdLeak([] {
try {
- Subprocess proc(std::vector<std::string>({"/no/such/file"}),
- Subprocess::pipeStdout().stderr(Subprocess::PIPE));
+ Subprocess proc(
+ std::vector<std::string>({"/no/such/file"}),
+ Subprocess::Options().pipeStdout().stderrFd(Subprocess::PIPE));
ADD_FAILURE() << "expected an error when running /no/such/file";
} catch (const SubprocessSpawnError& ex) {
EXPECT_EQ(ENOENT, ex.errnoValue());
}
TEST(PopenSubprocessTest, PopenRead) {
- Subprocess proc("ls /", Subprocess::pipeStdout());
+ Subprocess proc("ls /", Subprocess::Options().pipeStdout());
int found = 0;
- gen::byLine(File(proc.stdout())) |
+ gen::byLine(File(proc.stdoutFd())) |
[&] (StringPiece line) {
if (line == "etc" || line == "bin" || line == "usr") {
++found;
proc.waitChecked();
}
+// DANGER: This class runs after fork in a child processes. Be fast, the
+// parent thread is waiting, but remember that other parent threads are
+// running and may mutate your state. Avoid mutating any data belonging to
+// the parent. Avoid interacting with non-POD data that originated in the
+// parent. Avoid any libraries that may internally reference non-POD data.
+// Especially beware parent mutexes -- for example, glog's LOG() uses one.
+struct WriteFileAfterFork
+ : public Subprocess::DangerousPostForkPreExecCallback {
+ explicit WriteFileAfterFork(std::string filename)
+ : filename_(std::move(filename)) {}
+ virtual ~WriteFileAfterFork() {}
+ int operator()() override {
+ return writeFile(std::string("ok"), filename_.c_str()) ? 0 : errno;
+ }
+ const std::string filename_;
+};
+
+TEST(AfterForkCallbackSubprocessTest, TestAfterForkCallbackSuccess) {
+ test::ChangeToTempDir td;
+ // Trigger a file write from the child.
+ WriteFileAfterFork write_cob("good_file");
+ Subprocess proc(
+ std::vector<std::string>{"/bin/echo"},
+ Subprocess::Options().dangerousPostForkPreExecCallback(&write_cob)
+ );
+ // The file gets written immediately.
+ std::string s;
+ EXPECT_TRUE(readFile(write_cob.filename_.c_str(), s));
+ EXPECT_EQ("ok", s);
+ proc.waitChecked();
+}
+
+TEST(AfterForkCallbackSubprocessTest, TestAfterForkCallbackError) {
+ test::ChangeToTempDir td;
+ // The child will try to write to a file, whose directory does not exist.
+ WriteFileAfterFork write_cob("bad/file");
+ EXPECT_THROW(
+ Subprocess proc(
+ std::vector<std::string>{"/bin/echo"},
+ Subprocess::Options().dangerousPostForkPreExecCallback(&write_cob)
+ ),
+ SubprocessSpawnError
+ );
+ EXPECT_FALSE(fs::exists(write_cob.filename_));
+}
+
TEST(CommunicateSubprocessTest, SimpleRead) {
- Subprocess proc(std::vector<std::string>{ "/bin/echo", "-n", "foo", "bar"},
- Subprocess::pipeStdout());
+ Subprocess proc(
+ std::vector<std::string>{"/bin/echo", "-n", "foo", "bar"},
+ Subprocess::Options().pipeStdout());
auto p = proc.communicate();
EXPECT_EQ("foo bar", p.first);
proc.waitChecked();
data.append(line);
}
- Subprocess proc("wc -l", Subprocess::pipeStdin() | Subprocess::pipeStdout());
+ Subprocess proc("wc -l", Subprocess::Options().pipeStdin().pipeStdout());
auto p = proc.communicate(data);
EXPECT_EQ(folly::format("{}\n", numLines).str(), p.first);
proc.waitChecked();
const int bytes = 10 << 20;
std::string line(bytes, 'x');
- Subprocess proc("tr a-z A-Z",
- Subprocess::pipeStdin() | Subprocess::pipeStdout());
+ Subprocess proc("tr a-z A-Z", Subprocess::Options().pipeStdin().pipeStdout());
auto p = proc.communicate(line);
EXPECT_EQ(bytes, p.first.size());
EXPECT_EQ(std::string::npos, p.first.find_first_not_of('X'));
"-e", "s/a test/a successful test/",
"-e", "/^another line/w/dev/stderr",
});
- auto options = Subprocess::pipeStdin().pipeStdout().pipeStderr().usePath();
+ auto options =
+ Subprocess::Options().pipeStdin().pipeStdout().pipeStderr().usePath();
Subprocess proc(cmd, options);
auto out = proc.communicateIOBuf(std::move(input));
proc.waitChecked();
namespace {
bool readToString(int fd, std::string& buf, size_t maxSize) {
- size_t bytesRead = 0;
-
buf.resize(maxSize);
char* dest = &buf.front();
size_t remaining = maxSize;
int wcount = 0;
int rcount = 0;
- auto options = Subprocess::pipeStdin().pipeStdout().pipeStderr().usePath();
+ auto options =
+ Subprocess::Options().pipeStdin().pipeStdout().pipeStderr().usePath();
std::vector<std::string> cmd {
"sed",
"-u",
std::vector<Subprocess::ChildPipe> pipes;
{
Subprocess proc(
- "echo $'oh\\nmy\\ncat' | wc -l &", Subprocess::pipeStdout()
- );
+ "echo $'oh\\nmy\\ncat' | wc -l &", Subprocess::Options().pipeStdout());
pipes = proc.takeOwnershipOfPipes();
proc.waitChecked();
}