File: posix_specific.cpp

package info (click to toggle)
boost1.90 1.90.0-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 593,120 kB
  • sloc: cpp: 4,190,908; xml: 196,648; python: 34,618; ansic: 23,145; asm: 5,468; sh: 3,774; makefile: 1,161; perl: 1,020; sql: 728; ruby: 676; yacc: 478; java: 77; lisp: 24; csh: 6
file content (220 lines) | stat: -rw-r--r-- 6,890 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
// Copyright (c) 2006, 2007 Julio M. Merino Vidal
// Copyright (c) 2008 Ilya Sokolov, Boris Schaeling
// Copyright (c) 2009 Boris Schaeling
// Copyright (c) 2010 Felipe Tanus, Boris Schaeling
// Copyright (c) 2011, 2012 Jeff Flinn, Boris Schaeling
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

#define BOOST_TEST_MAIN
#define BOOST_TEST_IGNORE_SIGCHLD
#include <boost/test/included/unit_test.hpp>

#include <boost/process/v1/child.hpp>
#include <boost/process/v1/environment.hpp>
#include <boost/process/v1/filesystem.hpp>
#include <boost/process/v1/io.hpp>
#include <boost/process/v1/pipe.hpp>
#include <boost/process/v1/posix.hpp>
#include <boost/process/v1/spawn.hpp>
#include <boost/process/v1/system.hpp>

#if !defined(BOOST_PROCESS_USE_STD_FS)
#include <boost/filesystem/directory.hpp>
#endif


#include <system_error>


#include <string>
#include <sys/wait.h>
#include <errno.h>

namespace fs = boost::process::v1::filesystem;
namespace bp = boost::process::v1;

BOOST_AUTO_TEST_CASE(bind_fd, *boost::unit_test::timeout(2))
{
    using boost::unit_test::framework::master_test_suite;

    bp::pipe p;

    std::error_code ec;
    bp::child c(
        master_test_suite().argv[1],
        "test", "--posix-echo-one", "3", "hello",
        bp::posix::fd.bind(3, p.native_sink()),
        ec
    );
    BOOST_CHECK(!ec);


    bp::ipstream is(std::move(p));

    std::string s;
    is >> s;
    BOOST_CHECK_EQUAL(s, "hello");
}

BOOST_AUTO_TEST_CASE(bind_fds, *boost::unit_test::timeout(2))
{
    using boost::unit_test::framework::master_test_suite;

    bp::pipe p1;
    bp::pipe p2;

    std::error_code ec;
    bp::child c(
        master_test_suite().argv[1],
        "test","--posix-echo-two","3","hello","99","bye",
        bp::posix::fd.bind(3,  p1.native_sink()),
        bp::posix::fd.bind(99, p2.native_sink()),
        ec
    );
    BOOST_CHECK(!ec);

    bp::ipstream is1(std::move(p1));
    bp::ipstream is2(std::move(p2));

    std::string s1;
    is1 >> s1;
    BOOST_CHECK_EQUAL(s1, "hello");

    std::string s2;
    is2 >> s2;
    BOOST_CHECK_EQUAL(s2, "bye");
}

BOOST_AUTO_TEST_CASE(execve_set_on_error, *boost::unit_test::timeout(2))
{
    std::error_code ec;
    bp::spawn(
        "doesnt-exist",
        ec
    );
    BOOST_CHECK(ec);
    BOOST_CHECK_EQUAL(ec.value(), ENOENT);
}

BOOST_AUTO_TEST_CASE(execve_throw_on_error, *boost::unit_test::timeout(2))
{
    try
    {
        bp::spawn("doesnt-exist");
        BOOST_CHECK(false);
    }
    catch (bp::process_error &e)
    {
        BOOST_CHECK(e.code());
        BOOST_CHECK_EQUAL(e.code().value(), ENOENT);
    }
}

BOOST_AUTO_TEST_CASE(leak_test, *boost::unit_test::timeout(5))
{
    using boost::unit_test::framework::master_test_suite;

    std::error_code ec;

    const auto pid = boost::this_process::get_id();
    const auto  fd_path = fs::path("/proc") / std::to_string(pid) / "fd";

    auto get_fds = [&]{
        std::vector<int> fds;
        for (auto && fd : fs::directory_iterator(fd_path))
            fds.push_back(std::stoi(fd.path().filename().string()));
        return fds;
    };

    std::vector<int> fd_list = get_fds();
    if (fd_list.empty()) //then there's no /proc in the current linux distribution.
        return;


    BOOST_CHECK(std::find(fd_list.begin(), fd_list.end(), STDOUT_FILENO) != fd_list.end());
    BOOST_CHECK(std::find(fd_list.begin(), fd_list.end(),  STDIN_FILENO) != fd_list.end());
    BOOST_CHECK(std::find(fd_list.begin(), fd_list.end(), STDERR_FILENO) != fd_list.end());

    bp::pipe p; //should add two descriptors.

    auto fd_list_new = get_fds();

    BOOST_CHECK_EQUAL(fd_list_new.size(), fd_list.size() + 2);
    fd_list.push_back(p.native_source());
    fd_list.push_back(p.native_sink());


    BOOST_CHECK_EQUAL(
            bp::system(
                    master_test_suite().argv[1],
                    "test", "--exit-code", "123",  ec), 123);

    fd_list_new = get_fds();
    BOOST_CHECK_EQUAL(fd_list.size(), fd_list_new.size());


    const int native_source = p.native_source();
    BOOST_CHECK_EQUAL(
            bp::system(
                    master_test_suite().argv[1],
                    bp::std_in < p,
                    "test", "--exit-code", "123",  ec), 123);

    BOOST_CHECK(!ec);

   ////now, p.source should be closed, so we remove it from fd_list

   const auto itr = std::find(fd_list.begin(), fd_list.end(), native_source);
   if (itr != fd_list.end())
       fd_list.erase(itr);

    fd_list_new = get_fds();

    BOOST_CHECK_EQUAL(fd_list.size(), fd_list_new.size());

}

BOOST_AUTO_TEST_CASE(pipe_fd_is_not_leaked, *boost::unit_test::timeout(5))
{
    const std::string partner = boost::unit_test::framework::master_test_suite().argv[1];

    #define test(parent_closes_source, fd_to_check, expected_exitcode, call_args...) \
        do { \
            boost::asio::io_context ioctx; \
            bp::async_pipe pipe(ioctx); \
            BOOST_CHECK_NE(pipe.native_source(), -1); \
            BOOST_CHECK_NE(pipe.native_sink(), -1); \
            BOOST_CHECK_EQUAL(bp::system(partner, "--has-handle", std::to_string(fd_to_check), call_args), expected_exitcode); \
            if (parent_closes_source) { \
                BOOST_CHECK_EQUAL(pipe.native_source(), -1); \
                BOOST_CHECK_NE(pipe.native_sink(), -1); \
            } else { \
                BOOST_CHECK_NE(pipe.native_source(), -1); \
                BOOST_CHECK_EQUAL(pipe.native_sink(), -1); \
            } \
        } while (0)

    // Both parent and child processes must close the end of the pipe which they don't use,
    // and pipe_in/pipe_out must close the original source/sink fd after redirecting in the child process,
    // so that they don't keep the pipe open unnecessarily.
    test(true, STDIN_FILENO        , EXIT_SUCCESS, bp::std_in < pipe);
    test(true, pipe.native_source(), EXIT_FAILURE, bp::std_in < pipe);
    test(true, pipe.native_sink()  , EXIT_FAILURE, bp::std_in < pipe);

    test(false, STDOUT_FILENO       , EXIT_SUCCESS, bp::std_out > pipe);
    test(false, pipe.native_source(), EXIT_FAILURE, bp::std_out > pipe);
    test(false, pipe.native_sink()  , EXIT_FAILURE, bp::std_out > pipe);

    test(false, STDERR_FILENO       , EXIT_SUCCESS, bp::std_err > pipe);
    test(false, pipe.native_source(), EXIT_FAILURE, bp::std_err > pipe);
    test(false, pipe.native_sink()  , EXIT_FAILURE, bp::std_err > pipe);

    test(false, STDOUT_FILENO       , EXIT_SUCCESS, (bp::std_out & bp::std_err) > pipe);
    test(false, STDERR_FILENO       , EXIT_SUCCESS, (bp::std_out & bp::std_err) > pipe);
    test(false, pipe.native_source(), EXIT_FAILURE, (bp::std_out & bp::std_err) > pipe);
    test(false, pipe.native_sink()  , EXIT_FAILURE, (bp::std_out & bp::std_err) > pipe);

    #undef test
}