1 /*
2 * Copyright (c) Facebook, Inc. and its affiliates.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 #include <folly/experimental/NestedCommandLineApp.h>
18
19 #include <folly/Subprocess.h>
20 #include <folly/experimental/io/FsUtil.h>
21 #include <folly/portability/GTest.h>
22
23 #include <glog/logging.h>
24
25 namespace folly {
26 namespace test {
27
28 namespace {
29
getHelperPath()30 std::string getHelperPath() {
31 const auto basename = "nested_command_line_app_test_helper";
32 auto path = fs::executable_path();
33 path.remove_filename() /= basename;
34 if (!fs::exists(path)) {
35 path = path.parent_path().parent_path() / basename / basename;
36 }
37 return path.string();
38 }
39
callHelper(std::initializer_list<std::string> args,int expectedExitCode=0,int stdoutFd=-1)40 std::string callHelper(
41 std::initializer_list<std::string> args,
42 int expectedExitCode = 0,
43 int stdoutFd = -1) {
44 static std::string helperPath = getHelperPath();
45
46 std::vector<std::string> allArgs;
47 allArgs.reserve(args.size() + 1);
48 allArgs.push_back(helperPath);
49 allArgs.insert(allArgs.end(), args.begin(), args.end());
50
51 Subprocess::Options options;
52 if (stdoutFd != -1) {
53 options.stdoutFd(stdoutFd);
54 } else {
55 options.pipeStdout();
56 }
57 options.pipeStderr();
58
59 Subprocess proc(allArgs, options);
60 auto p = proc.communicate();
61 EXPECT_EQ(expectedExitCode, proc.wait().exitStatus());
62
63 return p.first;
64 }
65
66 } // namespace
67
TEST(ProgramOptionsTest,Errors)68 TEST(ProgramOptionsTest, Errors) {
69 callHelper({}, 1);
70 callHelper({"--wtf", "foo"}, 1);
71 callHelper({"qux"}, 1);
72 callHelper({"--global-foo", "x", "foo"}, 1);
73 }
74
TEST(ProgramOptionsTest,Help)75 TEST(ProgramOptionsTest, Help) {
76 // Not actually checking help output, just verifying that help doesn't fail
77 callHelper({"--version"});
78 callHelper({"-h"});
79 callHelper({"-h", "foo"});
80 callHelper({"-h", "bar"});
81 callHelper({"-h", "--", "bar"});
82 callHelper({"--help"});
83 callHelper({"--help", "foo"});
84 callHelper({"--help", "bar"});
85 callHelper({"--help", "--", "bar"});
86 callHelper({"help"});
87 callHelper({"help", "foo"});
88 callHelper({"help", "bar"});
89
90 // wrong command name
91 callHelper({"-h", "qux"}, 1);
92 callHelper({"--help", "qux"}, 1);
93 callHelper({"help", "qux"}, 1);
94
95 // anything after -- is parsed as arguments
96 callHelper({"--", "help", "bar"}, 1);
97 }
98
TEST(ProgramOptionsTest,DevFull)99 TEST(ProgramOptionsTest, DevFull) {
100 folly::File full("/dev/full", O_RDWR);
101 callHelper({"-h"}, 1, full.fd());
102 callHelper({"--help"}, 1, full.fd());
103 }
104
TEST(ProgramOptionsTest,CutArguments)105 TEST(ProgramOptionsTest, CutArguments) {
106 // anything after -- is parsed as arguments
107 EXPECT_EQ(
108 "running foo\n"
109 "foo global-foo 43\n"
110 "foo local-foo 42\n"
111 "foo conflict-global 42\n"
112 "foo conflict 42\n"
113 "foo arg b\n"
114 "foo arg --local-foo\n"
115 "foo arg 44\n"
116 "foo arg a\n",
117 callHelper(
118 {"foo", "--global-foo", "43", "--", "b", "--local-foo", "44", "a"}));
119 }
120
TEST(ProgramOptionsTest,Success)121 TEST(ProgramOptionsTest, Success) {
122 EXPECT_EQ(
123 "running foo\n"
124 "foo global-foo 42\n"
125 "foo local-foo 42\n"
126 "foo conflict-global 42\n"
127 "foo conflict 42\n",
128 callHelper({"foo"}));
129
130 EXPECT_EQ(
131 "running foo\n"
132 "foo global-foo 43\n"
133 "foo local-foo 44\n"
134 "foo conflict-global 42\n"
135 "foo conflict 42\n"
136 "foo arg a\n"
137 "foo arg b\n",
138 callHelper({"--global-foo", "43", "foo", "--local-foo", "44", "a", "b"}));
139
140 // Check that global flags can still be given after the command
141 EXPECT_EQ(
142 "running foo\n"
143 "foo global-foo 43\n"
144 "foo local-foo 44\n"
145 "foo conflict-global 42\n"
146 "foo conflict 42\n"
147 "foo arg a\n"
148 "foo arg b\n",
149 callHelper({"foo", "--global-foo", "43", "--local-foo", "44", "a", "b"}));
150 }
151
TEST(ProgramOptionsTest,Aliases)152 TEST(ProgramOptionsTest, Aliases) {
153 EXPECT_EQ(
154 "running foo\n"
155 "foo global-foo 43\n"
156 "foo local-foo 44\n"
157 "foo conflict-global 42\n"
158 "foo conflict 42\n"
159 "foo arg a\n"
160 "foo arg b\n",
161 callHelper({"--global-foo", "43", "bar", "--local-foo", "44", "a", "b"}));
162 }
163
TEST(ProgramOptionsTest,BuiltinCommand)164 TEST(ProgramOptionsTest, BuiltinCommand) {
165 NestedCommandLineApp app;
166 ASSERT_TRUE(app.isBuiltinCommand(NestedCommandLineApp::kHelpCommand.str()));
167 ASSERT_TRUE(
168 app.isBuiltinCommand(NestedCommandLineApp::kVersionCommand.str()));
169 ASSERT_FALSE(app.isBuiltinCommand(
170 NestedCommandLineApp::kHelpCommand.str() + "nonsense"));
171 }
172
TEST(ProgramOptionsTest,ConflictingFlags)173 TEST(ProgramOptionsTest, ConflictingFlags) {
174 EXPECT_EQ(
175 "running foo\n"
176 "foo global-foo 42\n"
177 "foo local-foo 42\n"
178 "foo conflict-global 43\n"
179 "foo conflict 42\n",
180 callHelper({"--conflict-global", "43", "foo"}));
181
182 EXPECT_EQ(
183 "running foo\n"
184 "foo global-foo 42\n"
185 "foo local-foo 42\n"
186 "foo conflict-global 43\n"
187 "foo conflict 42\n",
188 callHelper({"foo", "--conflict-global", "43"}));
189
190 EXPECT_EQ(
191 "running foo\n"
192 "foo global-foo 42\n"
193 "foo local-foo 42\n"
194 "foo conflict-global 42\n"
195 "foo conflict 43\n",
196 callHelper({"foo", "--conflict", "43"}));
197
198 callHelper({"--conflict", "43", "foo"}, 1);
199 }
200
201 } // namespace test
202 } // namespace folly
203