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
|
/*
* Copyright © 2014 Canonical Ltd.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 or 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Authored By: Alan Griffiths <alan@octopull.co.uk>
*/
#include "mir_test_framework/headless_test.h"
#include "mir/options/option.h"
#include <gtest/gtest.h>
#include <gmock/gmock.h>
#include <cstdlib>
#include <fstream>
#include <system_error>
using namespace testing;
namespace
{
std::string create_temp_dir()
{
char temp_dir[] = "temp_dir_XXXXXX";
if (mkdtemp(temp_dir) == nullptr)
throw std::system_error(errno, std::system_category(), "Failed to create temp dir");
return temp_dir;
}
struct ServerConfigurationOptions : mir_test_framework::HeadlessTest
{
MOCK_METHOD1(command_line_handler, void(std::vector<std::string> const&));
void SetUp() override
{
server.set_command_line_handler([this](int argc, char const* const* argv)
{
std::vector<std::string> args;
for (auto p = argv; p != argv+argc; ++p)
{
args.emplace_back(*p);
}
command_line_handler(args);
});
server.add_configuration_option(test_config_key, "", mir::OptionType::string);
add_to_environment(env_xdg_config_home, fake_xdg_config_home.c_str());
add_to_environment(env_home, fake_home.c_str());
add_to_environment(env_xdg_config_dirs, fake_xdg_config_dirs.c_str());
}
void TearDown() override
{
// In the event of failure leave test files around to aid debugging
if(!HasFailure())
clean_test_files();
}
static constexpr char const* const env_xdg_config_home = "XDG_CONFIG_HOME";
static constexpr char const* const env_home = "HOME";
static constexpr char const* const env_xdg_config_dirs = "XDG_CONFIG_DIRS";
static constexpr char const* const not_found = "not found";
std::string const config_filename{"test.config"};
static constexpr char const* const test_config_key = "config_dir";
void create_config_file_in(std::string const& dir)
{
mkdir(dir.c_str(), 0700);
auto const filename = dir + ('/' + config_filename);
std::ofstream config(filename);
config << test_config_key << '=' << dir << std::endl;
}
void remove_config_file_in(std::string const& dir)
{
remove((dir + ('/' + config_filename)).c_str());
remove(dir.c_str());
}
void clean_test_files()
{
remove_config_file_in(fake_xdg_config_dir0);
remove_config_file_in(fake_xdg_config_dir1);
remove_config_file_in(fake_xdg_config_home);
remove_config_file_in(fake_home_config);
remove(fake_home.c_str());
remove(temp_dir.c_str());
}
std::string const temp_dir = create_temp_dir();
std::string const fake_xdg_config_home = temp_dir + "/fake_xdg_config_home";
std::string const fake_home = temp_dir + "/fake_home";
std::string const fake_home_config = temp_dir + "/fake_home/.config";
std::string const fake_xdg_config_dir0 = temp_dir + "/fake_xdg_config_dir0";
std::string const fake_xdg_config_dir1 = temp_dir + "/fake_xdg_config_dir1";
std::string const fake_xdg_config_dirs =
fake_xdg_config_dir0 + ":" + fake_xdg_config_dir1;
};
}
TEST_F(ServerConfigurationOptions, unknown_command_line_options_are_passed_to_handler)
{
const int argc = 10;
char const* argv[argc] = {
__PRETTY_FUNCTION__,
"--enable-input", "no",
"--hello",
"-f", "test_file",
"world",
"--offscreen",
"--answer", "42"
};
server.set_command_line(argc, argv);
EXPECT_CALL(*this, command_line_handler(
ElementsAre(StrEq("--hello"), StrEq("world"), StrEq("--answer"), StrEq("42"))));
server.apply_settings();
}
TEST_F(ServerConfigurationOptions, are_read_from_xdg_config_home)
{
create_config_file_in(fake_xdg_config_home);
server.set_config_filename(config_filename);
server.apply_settings();
auto const options = server.get_options();
EXPECT_THAT(options->get(test_config_key, not_found), StrEq(fake_xdg_config_home));
}
TEST_F(ServerConfigurationOptions, are_read_from_home_config_file)
{
mkdir(fake_home.c_str(), 0700);
create_config_file_in(fake_home_config);
// $HOME is only used if $XDG_CONFIG_HOME isn't set
add_to_environment(env_xdg_config_home, nullptr);
server.set_config_filename(config_filename);
server.apply_settings();
auto const options = server.get_options();
EXPECT_THAT(options->get(test_config_key, not_found), StrEq(fake_home_config));
}
TEST_F(ServerConfigurationOptions, are_read_from_xdg_config_dir0_config_file)
{
create_config_file_in(fake_xdg_config_dir0);
server.set_config_filename(config_filename);
server.apply_settings();
auto const options = server.get_options();
EXPECT_THAT(options->get(test_config_key, not_found), StrEq(fake_xdg_config_dir0));
}
TEST_F(ServerConfigurationOptions, are_read_from_xdg_config_dir1_config_file)
{
create_config_file_in(fake_xdg_config_dir1);
server.set_config_filename(config_filename);
server.apply_settings();
auto const options = server.get_options();
EXPECT_THAT(options->get(test_config_key, not_found), StrEq(fake_xdg_config_dir1));
}
TEST_F(ServerConfigurationOptions, are_read_from_xdg_config_dir0_before_xdg_config_dir1)
{
create_config_file_in(fake_xdg_config_dir0);
create_config_file_in(fake_xdg_config_dir1);
server.set_config_filename(config_filename);
server.apply_settings();
auto const options = server.get_options();
EXPECT_THAT(options->get(test_config_key, not_found), StrEq(fake_xdg_config_dir0));
}
TEST_F(ServerConfigurationOptions, are_read_from_xdg_config_home_before_xdg_config_dirs)
{
create_config_file_in(fake_xdg_config_home);
create_config_file_in(fake_xdg_config_dir0);
create_config_file_in(fake_xdg_config_dir1);
server.set_config_filename(config_filename);
server.apply_settings();
auto const options = server.get_options();
EXPECT_THAT(options->get(test_config_key, not_found), StrEq(fake_xdg_config_home));
}
|