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
221
222
223
224
225
226
227
228
229
230
231
|
// Copyright 2016 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include "src/main/cpp/startup_options.h"
#include <stdlib.h>
#include "src/main/cpp/blaze_util_platform.h"
#include "src/main/cpp/workspace_layout.h"
#include "gtest/gtest.h"
namespace blaze {
class StartupOptionsTest : public ::testing::Test {
protected:
StartupOptionsTest() : workspace_layout_(new WorkspaceLayout()) {}
~StartupOptionsTest() = default;
void SetUp() override {
// This knowingly ignores the possibility of these environment variables
// being unset because we expect our test runner to set them in all cases.
// Otherwise, we'll crash here, but this keeps our code simpler.
old_home_ = GetHomeDir();
old_test_tmpdir_ = GetEnv("TEST_TMPDIR");
ReinitStartupOptions();
}
void TearDown() override {
SetEnv("HOME", old_home_);
SetEnv("TEST_TMPDIR", old_test_tmpdir_);
}
// Recreates startup_options_ after changes to the environment.
void ReinitStartupOptions() {
startup_options_.reset(new StartupOptions(workspace_layout_.get()));
}
void SuccessfulIsNullaryTest(const std::string& flag_name) const {
EXPECT_TRUE(startup_options_->IsNullary("--" + flag_name));
EXPECT_TRUE(startup_options_->IsNullary("--no" + flag_name));
EXPECT_FALSE(startup_options_->IsNullary("--" + flag_name + "__invalid"));
EXPECT_DEATH(startup_options_->IsNullary("--" + flag_name + "=foo"),
("In argument '--" + flag_name + "=foo': option "
"'--" + flag_name + "' does not take a value").c_str());
EXPECT_DEATH(startup_options_->IsNullary("--no" + flag_name + "=foo"),
("In argument '--no" + flag_name + "=foo': option "
"'--no" + flag_name + "' does not take a value").c_str());
EXPECT_FALSE(startup_options_->IsUnary("--" + flag_name));
EXPECT_FALSE(startup_options_->IsUnary("--no" + flag_name));
}
void SuccessfulIsUnaryTest(const std::string& flag_name) const {
EXPECT_TRUE(startup_options_->IsUnary("--" + flag_name));
EXPECT_TRUE(startup_options_->IsUnary("--" + flag_name + "="));
EXPECT_TRUE(startup_options_->IsUnary("--" + flag_name + "=foo"));
EXPECT_FALSE(startup_options_->IsUnary("--" + flag_name + "__invalid"));
EXPECT_FALSE(startup_options_->IsNullary("--" + flag_name));
EXPECT_FALSE(startup_options_->IsNullary("--no" + flag_name));
}
private:
std::unique_ptr<WorkspaceLayout> workspace_layout_;
protected:
std::unique_ptr<StartupOptions> startup_options_;
private:
std::string old_home_;
std::string old_test_tmpdir_;
};
TEST_F(StartupOptionsTest, ProductName) {
ASSERT_EQ("Bazel", startup_options_->product_name);
}
TEST_F(StartupOptionsTest, JavaLoggingOptions) {
ASSERT_EQ("com.google.devtools.build.lib.util.SingleLineFormatter",
startup_options_->java_logging_formatter);
}
// TODO(bazel-team): remove the ifdef guard once the implementation of
// GetOutputRoot is stable among the different platforms.
#ifdef __linux
TEST_F(StartupOptionsTest, OutputRootPreferTestTmpdirIfSet) {
SetEnv("HOME", "/nonexistent/home");
SetEnv("TEST_TMPDIR", "/nonexistent/tmpdir");
ReinitStartupOptions();
ASSERT_EQ("/nonexistent/tmpdir", startup_options_->output_root);
}
TEST_F(StartupOptionsTest, OutputRootUseHomeDirectory) {
SetEnv("HOME", "/nonexistent/home");
UnsetEnv("TEST_TMPDIR");
ReinitStartupOptions();
ASSERT_EQ("/nonexistent/home/.cache/bazel", startup_options_->output_root);
}
#endif // __linux
TEST_F(StartupOptionsTest, EmptyFlagsAreInvalidTest) {
EXPECT_FALSE(startup_options_->IsNullary(""));
EXPECT_FALSE(startup_options_->IsNullary("--"));
EXPECT_FALSE(startup_options_->IsUnary(""));
EXPECT_FALSE(startup_options_->IsUnary("--"));
}
TEST_F(StartupOptionsTest, ValidStartupFlagsTest) {
// IMPORTANT: Before modifying this test, please contact a Bazel core team
// member that knows the Google-internal procedure for adding/deprecating
// startup flags.
SuccessfulIsNullaryTest("allow_configurable_attributes");
SuccessfulIsNullaryTest("batch");
SuccessfulIsNullaryTest("batch_cpu_scheduling");
SuccessfulIsNullaryTest("block_for_lock");
SuccessfulIsNullaryTest("client_debug");
SuccessfulIsNullaryTest("deep_execroot");
SuccessfulIsNullaryTest("experimental_oom_more_eagerly");
SuccessfulIsNullaryTest("fatal_event_bus_exceptions");
SuccessfulIsNullaryTest("host_jvm_debug");
SuccessfulIsNullaryTest("master_bazelrc");
SuccessfulIsNullaryTest("master_blazerc");
SuccessfulIsNullaryTest("watchfs");
SuccessfulIsNullaryTest("write_command_log");
SuccessfulIsUnaryTest("bazelrc");
SuccessfulIsUnaryTest("blazerc");
SuccessfulIsUnaryTest("command_port");
SuccessfulIsUnaryTest("connect_timeout_secs");
SuccessfulIsUnaryTest("experimental_oom_more_eagerly_threshold");
SuccessfulIsUnaryTest("host_javabase");
SuccessfulIsUnaryTest("host_jvm_args");
SuccessfulIsUnaryTest("host_jvm_profile");
SuccessfulIsUnaryTest("invocation_policy");
SuccessfulIsUnaryTest("io_nice_level");
SuccessfulIsUnaryTest("install_base");
SuccessfulIsUnaryTest("max_idle_secs");
SuccessfulIsUnaryTest("output_base");
SuccessfulIsUnaryTest("output_user_root");
}
TEST_F(StartupOptionsTest, ProcessSpaceSeparatedArgsTest) {
std::string error;
const std::vector<RcStartupFlag> flags{
RcStartupFlag("somewhere", "--max_idle_secs"),
RcStartupFlag("somewhere", "42")};
const blaze_exit_code::ExitCode ec =
startup_options_->ProcessArgs(flags, &error);
ASSERT_EQ(blaze_exit_code::SUCCESS, ec)
<< "ProcessArgs failed with error " << error;
EXPECT_EQ(42, startup_options_->max_idle_secs);
EXPECT_EQ("somewhere", startup_options_->original_startup_options_[0].source);
EXPECT_EQ("--max_idle_secs=42",
startup_options_->original_startup_options_[0].value);
}
TEST_F(StartupOptionsTest, ProcessEqualsSeparatedArgsTest) {
std::string error;
const std::vector<RcStartupFlag> flags{
RcStartupFlag("somewhere", "--max_idle_secs=36")};
const blaze_exit_code::ExitCode ec =
startup_options_->ProcessArgs(flags, &error);
ASSERT_EQ(ec, blaze_exit_code::SUCCESS)
<< "ProcessArgs failed with error " << error;
EXPECT_EQ(36, startup_options_->max_idle_secs);
EXPECT_EQ("somewhere", startup_options_->original_startup_options_[0].source);
EXPECT_EQ("--max_idle_secs=36",
startup_options_->original_startup_options_[0].value);
}
TEST_F(StartupOptionsTest, ProcessIncorrectArgValueTest) {
std::string error;
const std::vector<RcStartupFlag> flags{
RcStartupFlag("somewhere", "--max_idle_secs=notANumber")};
const blaze_exit_code::ExitCode ec =
startup_options_->ProcessArgs(flags, &error);
ASSERT_EQ(blaze_exit_code::BAD_ARGV, ec)
<< "ProcessArgs failed with the wrong error " << error;
// Even for a failing args processing step, expect the original value
// to be stored.
EXPECT_EQ("somewhere", startup_options_->original_startup_options_[0].source);
EXPECT_EQ("--max_idle_secs=notANumber",
startup_options_->original_startup_options_[0].value);
}
TEST_F(StartupOptionsTest, ProcessArgsWithMultipleArgstest) {
const std::vector<RcStartupFlag> flags{
RcStartupFlag("somewhere", "--max_idle_secs=36"),
RcStartupFlag("somewhereElse", "--nowrite_command_log")};
std::string error;
const blaze_exit_code::ExitCode ec =
startup_options_->ProcessArgs(flags, &error);
ASSERT_EQ(ec, blaze_exit_code::SUCCESS)
<< "ProcessArgs failed with error " << error;
EXPECT_EQ(36, startup_options_->max_idle_secs);
EXPECT_FALSE(startup_options_->write_command_log);
EXPECT_EQ("somewhere", startup_options_->original_startup_options_[0].source);
EXPECT_EQ("--max_idle_secs=36",
startup_options_->original_startup_options_[0].value);
EXPECT_EQ("somewhereElse",
startup_options_->original_startup_options_[1].source);
EXPECT_EQ("--nowrite_command_log",
startup_options_->original_startup_options_[1].value);
}
} // namespace blaze
|
