cfacter 3.11.0.rc.20180314

data/ext/facter/leatherman/dynamic_library/src/posix/dynamic_library.cc

@@ -0,0 +1,91 @@
+#include <leatherman/dynamic_library/dynamic_library.hpp>
+#include <leatherman/logging/logging.hpp>
+#include <dlfcn.h>
+
+using namespace std;
+namespace lth_locale = leatherman::locale;
+
+namespace leatherman { namespace dynamic_library {
+
+    dynamic_library dynamic_library::find_by_pattern(std::string const& pattern)
+    {
+        // POSIX doesn't have this capability
+        return dynamic_library();
+    }
+
+    dynamic_library dynamic_library::find_by_symbol(std::string const& symbol)
+    {
+        dynamic_library library;
+
+        // Load the "null" library; this will cause dlsym to search for the symbol
+        void* handle = dlopen(nullptr, RTLD_GLOBAL | RTLD_LAZY);
+        if (!handle) {
+            return library;
+        }
+
+        // Check to see if a search for the symbol succeeds
+        if (!dlsym(handle, symbol.c_str())) {
+            dlclose(handle);
+            return library;
+        }
+
+        // At least one loaded module will resolve the given symbol
+        // Return this handle to allow the caller to search for other symbols
+        library._handle = handle;
+        library._first_load = false;
+        return library;
+    }
+
+    bool dynamic_library::load(string const& name, bool global)
+    {
+        close();
+
+        auto load_mode = (global ? RTLD_GLOBAL : RTLD_LOCAL) | RTLD_LAZY;
+
+        _handle = dlopen(name.c_str(), load_mode);
+        if (!_handle) {
+            LOG_DEBUG("library {1} not found {2} ({3}).", name.c_str(), strerror(errno), errno);
+            return false;
+        }
+        _first_load = true;
+        _name = name;
+        return true;
+    }
+
+    void dynamic_library::close()
+    {
+        if (_handle) {
+            dlclose(_handle);
+            _handle = nullptr;
+        }
+        _name.clear();
+        _first_load = false;
+    }
+
+    void* dynamic_library::find_symbol(string const& name, bool throw_if_missing, string const& alias) const
+    {
+        if (!_handle) {
+            if (throw_if_missing) {
+                throw missing_import_exception("library is not loaded.");
+            } else {
+                LOG_DEBUG("library {1} is not loaded when attempting to load symbol {2}.", _name.c_str(), name.c_str());
+            }
+            return nullptr;
+        }
+        void* symbol = dlsym(_handle, name.c_str());
+        if (!symbol && !alias.empty()) {
+            LOG_DEBUG("symbol {1} not found in library {2}, trying alias {3}.", name.c_str(), _name.c_str(), alias.c_str());
+            symbol = dlsym(_handle, alias.c_str());
+        }
+        if (!symbol) {
+            if (throw_if_missing) {
+                throw missing_import_exception(lth_locale::format("symbol {1} was not found in {2}.", name, _name));
+            } else {
+                LOG_DEBUG("symbol {1} not found in library {2}.", name.c_str(), _name.c_str());
+            }
+        }
+        return symbol;
+    }
+
+}}  // namespace leatherman::dynamic_library
+

data/ext/facter/leatherman/dynamic_library/src/windows/dynamic_library.cc

@@ -0,0 +1,128 @@
+#include <leatherman/util/scoped_resource.hpp>
+#include <leatherman/util/regex.hpp>
+#include <leatherman/dynamic_library/dynamic_library.hpp>
+#include <leatherman/windows/system_error.hpp>
+#include <leatherman/windows/windows.hpp>
+#include <leatherman/logging/logging.hpp>
+#include <leatherman/locale/locale.hpp>
+#include <boost/nowide/convert.hpp>
+#include <tlhelp32.h>
+
+// Mark string for translation (alias for leatherman::locale::format)
+using leatherman::locale::_;
+
+using namespace std;
+using namespace leatherman::util;
+using namespace leatherman::windows;
+namespace lth_locale = leatherman::locale;
+
+namespace leatherman { namespace dynamic_library {
+
+    dynamic_library dynamic_library::find_by_pattern(std::string const& pattern)
+    {
+        dynamic_library library;
+
+        // Check to see if the library is loaded. Walk the list of loaded modules and match against pattern.
+        // See http://msdn.microsoft.com/en-us/library/windows/desktop/ms686849(v=vs.85).aspx for details on
+        // the Tool Help library.
+        HANDLE hModuleSnap = CreateToolhelp32Snapshot(TH32CS_SNAPMODULE, GetCurrentProcessId());
+        if (hModuleSnap == INVALID_HANDLE_VALUE) {
+            LOG_DEBUG("library matching pattern {1} not found, CreateToolhelp32Snapshot failed: {2}.", pattern.c_str(), windows::system_error());
+            return library;
+        }
+        scoped_resource<HANDLE> hModSnap(hModuleSnap, CloseHandle);
+
+        MODULEENTRY32 me32 = {};
+        me32.dwSize = sizeof(MODULEENTRY32);
+        if (!Module32First(hModSnap, &me32)) {
+            LOG_DEBUG("library matching pattern {1} not found, Module32First failed: {2}.", pattern.c_str(), windows::system_error());
+            return library;
+        }
+
+        boost::regex rx(pattern);
+        do {
+            auto libname = boost::nowide::narrow(me32.szModule);
+            if (re_search(libname, rx)) {
+                // Use GetModuleHandleEx to ensure the reference count is incremented. If the module has been
+                // unloaded since the snapshot was made, this may fail and we should return an empty library.
+                HMODULE hMod;
+                if (GetModuleHandleEx(0, me32.szModule, &hMod)) {
+                    library._handle = hMod;
+                    library._first_load = false;
+                    LOG_DEBUG("library {1} found from pattern {2}", libname, pattern);
+                } else {
+                    LOG_DEBUG("library {1} found from pattern {2}, but unloaded before handle was acquired", libname, pattern);
+                }
+                return library;
+            } else {
+                LOG_TRACE("library %1% didn't match pattern %2%", libname, pattern);
+            }
+        } while (Module32Next(hModSnap, &me32));
+
+        LOG_DEBUG("no loaded libraries found matching pattern {1}", pattern);
+        return library;
+    }
+
+    dynamic_library dynamic_library::find_by_symbol(std::string const& symbol)
+    {
+        // Windows doesn't have this capability.
+        return dynamic_library();
+    }
+
+    bool dynamic_library::load(string const& name, bool global)
+    {
+        close();
+
+        // Check if the module has already been loaded (and increment the ref count).
+        HMODULE hMod;
+        auto wname = boost::nowide::widen(name);
+        if (!GetModuleHandleExW(0, wname.c_str(), &hMod)) {
+            // Load now
+            hMod = LoadLibraryW(wname.c_str());
+            if (!hMod) {
+                LOG_DEBUG("library {1} not found {2}.", name.c_str(), windows::system_error());
+                return false;
+            }
+            _first_load = true;
+        }
+        _handle = hMod;
+        _name = name;
+        return true;
+    }
+
+    void dynamic_library::close()
+    {
+        if (_handle) {
+            FreeLibrary(static_cast<HMODULE>(_handle));
+            _handle = nullptr;
+        }
+        _name.clear();
+        _first_load = false;
+    }
+
+    void* dynamic_library::find_symbol(string const& name, bool throw_if_missing, string const& alias) const
+    {
+        if (!_handle) {
+            if (throw_if_missing) {
+                throw missing_import_exception(_("library is not loaded"));
+            } else {
+                LOG_DEBUG("library {1} is not loaded when attempting to load symbol {2}.", _name.c_str(), name.c_str());
+            }
+            return nullptr;
+        }
+        auto symbol = GetProcAddress(static_cast<HMODULE>(_handle), name.c_str());
+        if (!symbol && !alias.empty()) {
+            LOG_DEBUG("symbol {1} not found in library {2}, trying alias {3}.", name.c_str(), _name.c_str(), alias.c_str());
+            symbol = GetProcAddress(static_cast<HMODULE>(_handle), alias.c_str());
+        }
+        if (!symbol) {
+            if (throw_if_missing) {
+                throw missing_import_exception(_("symbol {1} was not found in {2}.", name, _name));
+            } else {
+                LOG_DEBUG("symbol {1} not found in library {2}.", name.c_str(), _name.c_str());
+            }
+        }
+        return reinterpret_cast<void *>(symbol);
+    }
+
+}}  // namespace leatherman::dynamic_library

data/ext/facter/leatherman/dynamic_library/tests/dynamic_library_tests.cc

@@ -0,0 +1,94 @@
+#include <catch.hpp>
+#include <leatherman/dynamic_library/dynamic_library.hpp>
+#include "fixtures.hpp"
+
+using namespace leatherman::dynamic_library;
+
+std::string const lib_path = TEST_LIB_DIRECTORY + std::string("/libtest.so");
+std::string const lib_path2 = TEST_LIB_DIRECTORY + std::string("/libtest1.so");
+
+TEST_CASE("dynamic_library::load and dynamic_library::close", "[dyn-lib]") {
+    SECTION("should not be loaded by default") {
+        dynamic_library lib;
+        REQUIRE_FALSE(lib.loaded());
+    }
+
+    SECTION("should load library from path, then close it"){
+        dynamic_library lib;
+        REQUIRE(lib.load(lib_path));
+        REQUIRE(lib.loaded());
+        REQUIRE(lib.first_load());
+        lib.close();
+        REQUIRE_FALSE(lib.loaded());
+    }
+
+    SECTION("should fail to load a nonexistent library") {
+        dynamic_library lib;
+        REQUIRE_FALSE(lib.load("no_such_library"));
+    }
+}
+
+TEST_CASE("dynamic_library::find_symbol", "[dyn-lib]"){
+    dynamic_library lib;
+    REQUIRE(lib.load(lib_path));
+
+    SECTION("should fail to find nonexistent symbol") {
+        REQUIRE_FALSE(lib.find_symbol("not_here"));
+        REQUIRE_THROWS(lib.find_symbol("not_here", true));
+    }
+
+    SECTION("should find library function") {
+        REQUIRE(lib.find_symbol("hello"));
+    }
+
+    SECTION("should find aliased symbol"){
+        dynamic_library lib2;
+        REQUIRE(lib2.load(lib_path2));
+        REQUIRE(lib2.find_symbol("not_here", false, "goodbye"));
+    }
+}
+
+TEST_CASE("dynamic_library::dyanmic_library(dynamic_library && other)", "[dyn-lib]") {
+    SECTION("should move library to new variable") {
+        dynamic_library lib;
+        REQUIRE(lib.load(lib_path));
+        REQUIRE(lib.loaded());
+        dynamic_library lib2 = std::move(lib);
+        REQUIRE(lib2.loaded());
+        REQUIRE(lib2.name() == lib_path);
+        REQUIRE_FALSE(lib.loaded());
+    }
+}
+
+#ifdef _WIN32
+TEST_CASE("dynamic_library::find_by_pattern", "[dyn-lib]"){
+    SECTION("should fail to find a missing library"){
+        REQUIRE_FALSE(dynamic_library::find_by_pattern("libtest1").loaded());
+    }
+
+    SECTION("should find a library matching a pattern"){
+        dynamic_library lib;
+        lib.load(lib_path);
+        REQUIRE_FALSE(dynamic_library::find_by_pattern("libtest1").loaded());
+        dynamic_library lib2;
+        lib2.load(lib_path2);
+        REQUIRE(dynamic_library::find_by_pattern("libtest1").loaded());
+    }
+}
+#else
+TEST_CASE("dynamic_library::find_by_symbol", "[dyn-lib]"){
+    SECTION("should fail to find a missing symbol"){
+        REQUIRE_FALSE(dynamic_library::find_by_symbol("no_such_symbol").loaded());
+    }
+
+    SECTION("should find a library with the given symbol"){
+        dynamic_library lib;
+        REQUIRE(lib.load(lib_path));
+        REQUIRE_FALSE(dynamic_library::find_by_symbol("goodbye").loaded());
+        dynamic_library lib2;
+        REQUIRE(lib2.load(lib_path2, true));
+        REQUIRE(lib2.find_symbol("goodbye"));
+        REQUIRE(dynamic_library::find_by_symbol("goodbye").loaded());
+    }
+}
+#endif

data/ext/facter/leatherman/dynamic_library/tests/fixtures.hpp.in

@@ -0,0 +1,3 @@
+#pragma once
+
+#define TEST_LIB_DIRECTORY "@CMAKE_LIBRARY_OUTPUT_DIRECTORY@"

data/ext/facter/leatherman/dynamic_library/tests/test-lib/goodbye.cc

@@ -0,0 +1,5 @@
+#include <iostream>
+
+extern "C" void goodbye(){
+    std::cout << "Goodbye!";
+}

data/ext/facter/leatherman/dynamic_library/tests/test-lib/hello.cc

@@ -0,0 +1,7 @@
+#include <iostream>
+
+void goodbye();
+
+extern "C" void hello(){
+    std::cout << "Hello world!";
+}

data/ext/facter/leatherman/execution/CMakeLists.txt

@@ -0,0 +1,65 @@
+find_package(Boost 1.54 REQUIRED COMPONENTS regex filesystem system)
+
+add_leatherman_deps("${Boost_LIBRARIES}")
+if ("${CMAKE_SYSTEM_NAME}" MATCHES "SunOS")
+    # We use functions provided by this library in the implementation
+    # of the create_detached_process execution option on Solaris to
+    # execute the child processes in their own contracts
+    add_leatherman_deps(contract)
+endif()
+add_leatherman_includes("${Boost_INCLUDE_DIRS}")
+
+leatherman_dependency(util)
+leatherman_dependency(nowide)
+leatherman_dependency(locale)
+leatherman_dependency(logging)
+leatherman_dependency(file_util)
+if (BUILDING_LEATHERMAN)
+    leatherman_logging_namespace("leatherman.execution")
+    leatherman_logging_line_numbers()
+endif()
+
+if(WIN32)
+    leatherman_dependency(windows)
+endif()
+
+add_leatherman_headers(inc/leatherman)
+if(WIN32)
+    add_leatherman_library(src/execution.cc src/windows/execution.cc)
+else()
+    if("${CMAKE_SYSTEM_NAME}" MATCHES "SunOS")
+        # LFS flags are needed to compile the posix/solaris/platform.cc such that it links correctly
+        # against the libcontract library. They're not applied universally as they impact the ability
+        # to use other OS functions. This usage is safe as long as global variables based on these flags
+        # are avoided, according to http://docs.oracle.com/cd/E19455-01/806-0634/6j9vo5alu/index.html
+        EXECUTE_PROCESS( COMMAND getconf LFS_CFLAGS OUTPUT_VARIABLE LFS_CFLAGS OUTPUT_STRIP_TRAILING_WHITESPACE )
+        set(LEATHERMAN_CXX_FLAGS "${LEATHERMAN_CXX_FLAGS} ${LFS_CFLAGS}")
+        add_leatherman_library(src/execution.cc src/posix/execution.cc src/posix/solaris/platform.cc)
+    else()
+        add_leatherman_library(src/execution.cc src/posix/execution.cc src/posix/generic/platform.cc)
+    endif()
+endif()
+
+if(WIN32)
+    set(PLATFORM_TESTS tests/windows/execution.cc)
+else()
+    set(PLATFORM_TESTS tests/posix/execution.cc)
+    if("${CMAKE_SYSTEM_NAME}" MATCHES "SunOS")
+        list(APPEND PLATFORM_TESTS tests/posix/solaris/execution.cc)
+    endif()
+endif()
+
+add_leatherman_test(tests/log_capture.cc ${PLATFORM_TESTS})
+
+if (BUILDING_LEATHERMAN)
+    # Dumb implementation of cat.exe for testing stdin/stdout/stderr handling.
+    include_directories(BEFORE ${LEATHERMAN_NOWIDE_INCLUDE})
+    add_executable(lth_cat tests/lth_cat.cc)
+    target_link_libraries(lth_cat ${LEATHERMAN_NOWIDE_LIBS})
+    set_target_properties(lth_cat PROPERTIES COMPILE_FLAGS "${LEATHERMAN_CXX_FLAGS}")
+
+    configure_file (
+        "${CMAKE_CURRENT_LIST_DIR}/tests/fixtures.hpp.in"
+        "${CMAKE_CURRENT_LIST_DIR}/tests/fixtures.hpp"
+    )
+endif()

data/ext/facter/leatherman/execution/inc/leatherman/execution/execution.hpp

@@ -0,0 +1,488 @@
+/**
+ * @file
+ * Declares functions used for executing commands.
+ */
+#pragma once
+
+#include <leatherman/util/environment.hpp>
+#include <leatherman/util/option_set.hpp>
+#include <boost/optional.hpp>
+#include <boost/filesystem.hpp>
+
+#include <string>
+#include <vector>
+#include <map>
+#include <tuple>
+#include <utility>
+#include <stdexcept>
+#include <functional>
+
+namespace lth_util = leatherman::util;
+
+namespace leatherman { namespace execution {
+
+    /**
+     * The supported execution options.
+     */
+    enum class execution_options
+    {
+        /**
+         * No options.
+         */
+        none = 0,
+        /**
+         * Redirect stderr to stdout.  This will override redirect_stderr_to_null if both are set.
+         */
+        redirect_stderr_to_stdout = (1 << 1),
+        /**
+         * Throw an exception if the child process exits with a nonzero status.
+         */
+        throw_on_nonzero_exit = (1 << 2),
+        /**
+         * Throw an exception if the child process is terminated due to a signal.
+         */
+        throw_on_signal = (1 << 3),
+        /**
+         * Automatically trim output leading and trailing whitespace.
+         */
+        trim_output = (1 << 4),
+        /**
+         * Merge specified environment with the current process environment.
+         */
+        merge_environment = (1 << 5),
+        /**
+         * Redirect stderr to "null".
+         */
+        redirect_stderr_to_null = (1 << 6),
+        /**
+         * Preserve (do not quote) arguments.
+         */
+        preserve_arguments = (1 << 7),
+        /**
+         * Create a new process such that it can outlive its parent. This involves running it
+         * in a separate process group on Windows, and in a separate contract on Solaris.
+         */
+        create_detached_process = (1 << 8),
+        /**
+         * Inherit locale environment variables from the current process. Limited to LC_ALL and
+         * LOCALE, which are specifically overridden to "C" with merge_environment.
+         * Will not override those variables if explicitly passed in an environment map.
+         */
+        inherit_locale = (1 << 9),
+        /**
+         * On windows, converts \r\n newlines to standard \n
+         */
+        convert_newlines = (1 << 10),
+        /**
+         * On POSIX systems, use `fork()` instead of `vfork()` when creating the new process.
+         * Ignored on windows.
+         * The `fork()` is typically slower than `vfork()` because it creates a copy
+         * of the parent's address space for the child process (`vfork()` lets the
+         * child process re-use the parent's address space) but safer from deadlocks
+         * if called from multi threaded processes.
+         */
+        thread_safe = (1 << 11),
+        /**
+         * Allow standard input to be unread, rather than failing if it is ignored.
+         */
+        allow_stdin_unread = (1 << 12),
+        /**
+         * A combination of all throw options.
+         */
+        throw_on_failure = throw_on_nonzero_exit | throw_on_signal,
+    };
+
+    /**
+     * System command shell available for executing shell scripts.
+     * Uses 'cmd' on Windows and 'sh' on *nix systems.
+     */
+    extern const char *const command_shell;
+
+    /**
+     * System command shell arguments to accept a script as an argument.
+     * Uses '/c' on Windows and '-c' on *nix systems.
+     */
+    extern const char *const command_args;
+
+    /**
+     * Base class for execution exceptions.
+     */
+    struct execution_exception : std::runtime_error
+    {
+        /**
+         * Constructs a execution_exception.
+         * @param message The exception message.
+         */
+        explicit execution_exception(std::string const& message);
+    };
+
+    /**
+     * Base class for execution failures.
+     */
+    struct execution_failure_exception : execution_exception
+    {
+        /**
+         * Constructs a execution_failure_exception.
+         * @param message The exception message.
+         * @param output The child process stdout output.
+         * @param error The child process stderr output.
+         */
+        execution_failure_exception(std::string const& message, std::string output, std::string error);
+
+        /**
+         * Gets the child process stdout output.
+         * @return Returns the child process stdout output.
+         */
+        std::string const& output() const;
+
+        /**
+         * Gets the child process stderr output.
+         * @return Returns the child process stderr output.
+         */
+        std::string const& error() const;
+
+     private:
+        std::string _output;
+        std::string _error;
+    };
+
+    /**
+     * Exception that is thrown when a child exits with a non-zero status code.
+     */
+    struct child_exit_exception : execution_failure_exception
+    {
+        /**
+         * Constructs a child_exit_exception.
+         * @param message The exception message.
+         * @param status_code The exit status code of the child process.
+         * @param output The child process stdout output.
+         * @param error The child process stderr output.
+         */
+        child_exit_exception(std::string const& message, int status_code, std::string output, std::string error);
+
+        /**
+         * Gets the child process exit status code.
+         * @return Returns the child process exit status code.
+         */
+        int status_code() const;
+
+     private:
+        int _status_code;
+    };
+
+    /**
+     * Exception that is thrown when a child exists due to a signal.
+     */
+    struct child_signal_exception : execution_failure_exception
+    {
+        /**
+         * Constructs a child_signal_exception.
+         * @param message The exception message.
+         * @param signal The signal code that terminated the child process.
+         * @param output The child process stdout output.
+         * @param error The child process stderr output.
+         */
+        child_signal_exception(std::string const& message, int signal, std::string output, std::string error);
+
+        /**
+         * Gets the signal that terminated the child process.
+         * @return Returns the signal that terminated the child process.
+         */
+        int signal() const;
+
+     private:
+        int _signal;
+    };
+
+    /**
+     * Exception that is thrown when a command times out.
+     */
+    struct timeout_exception : execution_exception
+    {
+        /**
+         * Constructs a timeout_exception.
+         * @param message The exception message.
+         * @param pid The process id of the process that timed out and was killed.
+         */
+        timeout_exception(std::string const& message, size_t pid);
+
+        /**
+         * Gets the process id of the process that timed out and was killed.
+         * @return Returns the process id of the process that timed out and was killed.
+         */
+        size_t pid() const;
+
+     private:
+        size_t _pid;
+    };
+
+    /**
+     * Encapsulates return value from executing a process.
+     */
+    struct result
+    {
+        /**
+         * Constructor.
+         */
+        result(bool s, std::string o, std::string e, int ec, size_t p)
+            : success(s), output(move(o)), error(move(e)), exit_code(ec), pid(p) {}
+        /**
+         * Whether or not the command succeeded, defaults to true.
+         */
+        bool success = true;
+        /**
+         * Output from stdout.
+         */
+        std::string output;
+        /**
+         * Output from stderr (if not redirected).
+         */
+        std::string error;
+        /**
+         * The process exit code, defaults to 0.
+         */
+        int exit_code = 0;
+        /**
+         * The process ID
+         */
+        size_t pid = 0;
+    };
+
+    /**
+     * Searches the given paths for the given executable file.
+     * @param file The file to search for.
+     * @param directories The directories to search.
+     * @return Returns the full path or empty if the file could not be found.
+     */
+    std::string which(std::string const& file, std::vector<std::string> const& directories = lth_util::environment::search_paths());
+
+    /**
+     * Expands the executable in the command to the full path.
+     * @param command The command to expand.
+     * @param directories The directories to search.
+     * @return Returns the expanded command if the executable was found or empty if it was not found..
+     */
+    std::string expand_command(std::string const& command, std::vector<std::string> const& directories = lth_util::environment::search_paths());
+
+    /**
+     * Executes the given program.
+     * @param file The name or path of the program to execute.
+     * @param timeout The timeout, in seconds.  Defaults to no timeout.
+     * @param options The execution options.  Defaults to trimming output, merging the environment, and redirecting stderr to null.
+     * @return Returns a result struct.
+     */
+    result execute(
+        std::string const& file,
+        uint32_t timeout = 0,
+        lth_util::option_set<execution_options> const& options = { execution_options::trim_output, execution_options::merge_environment, execution_options::redirect_stderr_to_null });
+
+    /**
+     * Executes the given program.
+     * @param file The name or path of the program to execute.
+     * @param arguments The arguments to pass to the program. On Windows they will be quoted as needed for spaces.
+     * @param timeout The timeout, in seconds. Defaults to no timeout.
+     * @param options The execution options.  Defaults to trimming output, merging the environment, and redirecting stderr to null.
+     * @return Returns a result struct.
+     */
+    result execute(
+        std::string const& file,
+        std::vector<std::string> const& arguments,
+        uint32_t timeout = 0,
+        lth_util::option_set<execution_options> const& options = { execution_options::trim_output, execution_options::merge_environment, execution_options::redirect_stderr_to_null });
+
+    /**
+     * Executes the given program.
+     * @param file The name or path of the program to execute.
+     * @param arguments The arguments to pass to the program. On Windows they will be quoted as needed for spaces.
+     * @param environment The environment variables to pass to the child process.
+     * @param timeout The timeout, in seconds. Defaults to no timeout.
+     * @param options The execution options.  Defaults to trimming output, merging the environment, and redirecting stderr to null.
+     * @return Returns a result struct.
+     */
+    result execute(
+        std::string const& file,
+        std::vector<std::string> const& arguments,
+        std::map<std::string, std::string> const& environment,
+        uint32_t timeout = 0,
+        lth_util::option_set<execution_options> const& options = { execution_options::trim_output, execution_options::merge_environment, execution_options::redirect_stderr_to_null });
+
+    /**
+     * Executes the given program.
+     * @param file The name or path of the program to execute.
+     * @param arguments The arguments to pass to the program. On Windows they will be quoted as needed for spaces.
+     * @param input A string to place on stdin for the child process before reading output.
+     * @param timeout The timeout, in seconds. Defaults to no timeout.
+     * @param options The execution options.  Defaults to trimming output, merging the environment, and redirecting stderr to null.
+     * @return Returns a result struct.
+     */
+    result execute(
+        std::string const& file,
+        std::vector<std::string> const& arguments,
+        std::string const& input,
+        uint32_t timeout = 0,
+        lth_util::option_set<execution_options> const& options = { execution_options::trim_output, execution_options::merge_environment, execution_options::redirect_stderr_to_null });
+
+    /**
+     * Executes the given program.
+     * @param file The name or path of the program to execute.
+     * @param arguments The arguments to pass to the program. On Windows they will be quoted as needed for spaces.
+     * @param input A string to place on stdin for the child process before reading output.
+     * @param environment The environment variables to pass to the child process.
+     * @param timeout The timeout, in seconds. Defaults to no timeout.
+     * @param options The execution options.  Defaults to trimming output, merging the environment, and redirecting stderr to null.
+     * @return Returns a result struct.
+     */
+    result execute(
+        std::string const& file,
+        std::vector<std::string> const& arguments,
+        std::string const& input,
+        std::map<std::string, std::string> const& environment,
+        uint32_t timeout = 0,
+        lth_util::option_set<execution_options> const& options = { execution_options::trim_output, execution_options::merge_environment, execution_options::redirect_stderr_to_null });
+
+    /**
+     * Executes the given program by calling a specified callback that receives the pid of the program's process.
+     * @param file The name or path of the program to execute.
+     * @param arguments The arguments to pass to the program. On Windows they will be quoted as needed for spaces.
+     * @param input A string to place on stdin for the child process before reading output.
+     * @param environment The environment variables to pass to the child process.
+     * @param pid_callback The callback that is called with the pid of the child process. Defaults to no callback, in which case the pid won't be processed.
+     * @param timeout The timeout, in seconds. Defaults to no timeout.
+     * @param options The execution options.  Defaults to trimming output, merging the environment, and redirecting stderr to null.
+     * @return Returns a result struct.
+     */
+    result execute(
+        std::string const& file,
+        std::vector<std::string> const& arguments,
+        std::string const& input,
+        std::map<std::string, std::string> const& environment,
+        std::function<void(size_t)> pid_callback = nullptr,
+        uint32_t timeout = 0,
+        lth_util::option_set<execution_options> const& options = { execution_options::trim_output, execution_options::merge_environment, execution_options::redirect_stderr_to_null });
+
+    /**
+     * Executes the given program by writing the output of stdout and stderr to specified files. The output
+     * is processed line-by-line, so binary data isn't supported.
+     * @param file The name or path of the program to execute.
+     * @param arguments The arguments to pass to the program. On Windows they will be quoted as needed for spaces.
+     * @param input A string to place on stdin for the child process before reading output.
+     * @param out_file The file where the output on stdout will be written.
+     * @param err_file The file where the output on stderr will be written. Defaults to no file, in which case the output on stderr will be buffered and returned in the result struct.
+     * @param environment The environment variables to pass to the child process.
+     * @param pid_callback The callback that is called with the pid of the child process. Defaults to no callback, in which case the pid will not be processed.
+     * @param timeout The timeout, in seconds. Defaults to no timeout.
+     * @param options The execution options. Defaults to trimming output and merging the environment.
+     * @return Returns a result struct that will not contain the output of the streams for which a file was specified.
+     *
+     * Throws an execution_exception error in case it fails to open a file.
+     */
+    result execute(
+        std::string const& file,
+        std::vector<std::string> const& arguments,
+        std::string const& input,
+        std::string const& out_file,
+        std::string const& err_file = "",
+        std::map<std::string, std::string> const& environment = std::map<std::string, std::string>(),
+        std::function<void(size_t)> pid_callback = nullptr,
+        uint32_t timeout = 0,
+        lth_util::option_set<execution_options> const& options = { execution_options::trim_output, execution_options::merge_environment });
+
+    /**
+     * Executes the given program by writing the output of stdout and stderr to specified files. The output
+     * is processed line-by-line, so binary data isn't supported.
+     * @param file The name or path of the program to execute.
+     * @param arguments The arguments to pass to the program. On Windows they will be quoted as needed for spaces.
+     * @param input A string to place on stdin for the child process before reading output.
+     * @param out_file The file where the output on stdout will be written.
+     * @param err_file The file where the output on stderr will be written.
+     * @param environment The environment variables to pass to the child process.
+     * @param pid_callback The callback that is called with the pid of the child process.
+     * @param timeout The timeout, in seconds.
+     * @param perms The file permissions to apply when creating the out_file and err_file.
+     *              On Windows this only toggles read-only.
+     * @param options The execution options. Defaults to trimming output and merging the environment.
+     * @return Returns a result struct that will not contain the output of the streams for which a file was specified.
+     *
+     * Throws an execution_exception error in case it fails to open a file.
+     */
+    result execute(
+        std::string const& file,
+        std::vector<std::string> const& arguments,
+        std::string const& input,
+        std::string const& out_file,
+        std::string const& err_file,
+        std::map<std::string, std::string> const& environment,
+        std::function<void(size_t)> pid_callback,
+        uint32_t timeout,
+        boost::optional<boost::filesystem::perms> perms,
+        lth_util::option_set<execution_options> const& options = { execution_options::trim_output, execution_options::merge_environment });
+
+    /**
+     * Executes the given program and returns each line of output.
+     * @param file The name or path of the program to execute.
+     * @param stdout_callback The callback that is called with each line of output on stdout.
+     * @param stderr_callback The callback that is called with each line of output on stderr. If nullptr, implies redirect_stderr_to_null unless redirect_stderr_to_stdout is set in options.
+     * @param timeout The timeout, in seconds. Defaults to no timeout.
+     * @param options The execution options.  Defaults to trimming output and merging the environment.
+     * @return Returns true if the execution succeeded or false if it did not.
+     */
+    bool each_line(
+        std::string const& file,
+        std::function<bool(std::string&)> stdout_callback,
+        std::function<bool(std::string&)> stderr_callback = nullptr,
+        uint32_t timeout = 0,
+        lth_util::option_set<execution_options> const& options = { execution_options::trim_output, execution_options::merge_environment });
+
+    /**
+     * Executes the given program and returns each line of output.
+     * @param file The name or path of the program to execute.
+     * @param arguments The arguments to pass to the program. On Windows they will be quoted as needed for spaces.
+     * @param stdout_callback The callback that is called with each line of output on stdout.
+     * @param stderr_callback The callback that is called with each line of output on stderr. If nullptr, implies redirect_stderr_to_null unless redirect_stderr_to_stdout is set in options.
+     * @param timeout The timeout, in seconds. Defaults to no timeout.
+     * @param options The execution options.  Defaults to trimming output and merging the environment.
+     * @return Returns true if the execution succeeded or false if it did not.
+     */
+    bool each_line(
+        std::string const& file,
+        std::vector<std::string> const& arguments,
+        std::function<bool(std::string&)> stdout_callback,
+        std::function<bool(std::string&)> stderr_callback = nullptr,
+        uint32_t timeout = 0,
+        lth_util::option_set<execution_options> const& options = { execution_options::trim_output, execution_options::merge_environment });
+
+    /**
+     * Executes the given program and returns each line of output.
+     * @param file The name or path of the program to execute.
+     * @param arguments The arguments to pass to the program. On Windows they will be quoted as needed for spaces.
+     * @param environment The environment variables to pass to the child process.
+     * @param stdout_callback The callback that is called with each line of output on stdout.
+     * @param stderr_callback The callback that is called with each line of output on stderr. If nullptr, implies redirect_stderr_to_null unless redirect_to_stdout is set in options.
+     * @param timeout The timeout, in seconds. Defaults to no timeout.
+     * @param options The execution options.  Defaults to trimming output and merging the environment.
+     * @return Returns true if the execution succeeded or false if it did not.
+     */
+    bool each_line(
+        std::string const& file,
+        std::vector<std::string> const& arguments,
+        std::map<std::string, std::string> const& environment,
+        std::function<bool(std::string&)> stdout_callback,
+        std::function<bool(std::string&)> stderr_callback = nullptr,
+        uint32_t timeout = 0,
+        lth_util::option_set<execution_options> const& options = { execution_options::trim_output, execution_options::merge_environment });
+
+    /**
+     * Processes stdout and stderror streams of a child process.
+     * @param trim True if output should be trimmed or false if not.
+     * @param stdout_callback The callback to use when a line is read for stdout.
+     * @param stderr_callback The callback to use when a line is read for stderr.
+     * @param read_streams The callback that is called to read stdout and stderr streams.
+     * @return Returns a tuple of stdout and stderr output.  If stdout_callback or stderr_callback is given, it will return empty strings.
+     */
+    std::tuple<std::string, std::string> process_streams(
+            bool trim,
+            std::function<bool(std::string&)> const& stdout_callback,
+            std::function<bool(std::string&)> const& stderr_callback,
+            std::function<void(std::function<bool(std::string const&)>, std::function<bool(std::string const&)>)> const& read_streams);
+
+}}  // namespace leatherman::execution