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
|
// Copyright (C) 2020-2022 Joel Rosdahl and other contributors
//
// See doc/AUTHORS.adoc for a complete list of contributors.
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation; either version 3 of the License, or (at your option)
// any later version.
//
// 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, write to the Free Software Foundation, Inc., 51
// Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#include "../src/Context.hpp"
#include "../src/ccache.hpp"
#include "../src/fmtmacros.hpp"
#include "TestUtil.hpp"
#include <core/wincompat.hpp>
#include <util/file.hpp>
#include "third_party/doctest.h"
#include <optional>
#ifdef HAVE_UNISTD_H
# include <unistd.h>
#endif
using TestUtil::TestContext;
TEST_SUITE_BEGIN("ccache");
// Wraps find_compiler in a test friendly interface.
static std::string
helper(const char* args,
const char* config_compiler,
const char* find_executable_return_string = nullptr)
{
const auto find_executable_stub =
[&find_executable_return_string](const auto&, const auto& s, const auto&) {
return find_executable_return_string ? find_executable_return_string
: "resolved_" + s;
};
Context ctx;
ctx.config.set_compiler(config_compiler);
ctx.orig_args = Args::from_string(args);
find_compiler(ctx, find_executable_stub);
return ctx.orig_args.to_string();
}
TEST_CASE("find_compiler")
{
SUBCASE("no config")
{
// In case the first parameter is gcc it must be a link to ccache, so
// find_compiler should call find_executable to locate the next best "gcc"
// and return that value.
CHECK(helper("gcc", "") == "resolved_gcc");
CHECK(helper("relative/gcc", "") == "resolved_gcc");
CHECK(helper("/absolute/gcc", "") == "resolved_gcc");
// In case the first parameter is ccache, resolve the second parameter to
// the real compiler unless it's a relative or absolute path.
CHECK(helper("ccache gcc", "") == "resolved_gcc");
CHECK(helper("ccache rel/gcc", "") == "rel/gcc");
CHECK(helper("ccache /abs/gcc", "") == "/abs/gcc");
CHECK(helper("rel/ccache gcc", "") == "resolved_gcc");
CHECK(helper("rel/ccache rel/gcc", "") == "rel/gcc");
CHECK(helper("rel/ccache /abs/gcc", "") == "/abs/gcc");
CHECK(helper("/abs/ccache gcc", "") == "resolved_gcc");
CHECK(helper("/abs/ccache rel/gcc", "") == "rel/gcc");
CHECK(helper("/abs/ccache /abs/gcc", "") == "/abs/gcc");
// If gcc points back to ccache throw, unless either ccache or gcc is a
// relative or absolute path.
CHECK_THROWS(helper("ccache gcc", "", "ccache"));
CHECK(helper("ccache rel/gcc", "", "ccache") == "rel/gcc");
CHECK(helper("ccache /abs/gcc", "", "ccache") == "/abs/gcc");
CHECK_THROWS(helper("rel/ccache gcc", "", "ccache"));
CHECK(helper("rel/ccache rel/gcc", "", "ccache") == "rel/gcc");
CHECK(helper("rel/ccache /a/gcc", "", "ccache") == "/a/gcc");
CHECK_THROWS(helper("/abs/ccache gcc", "", "ccache"));
CHECK(helper("/abs/ccache rel/gcc", "", "ccache") == "rel/gcc");
CHECK(helper("/abs/ccache /a/gcc", "", "ccache") == "/a/gcc");
// If compiler is not found then throw, unless the compiler has a relative
// or absolute path.
CHECK_THROWS(helper("ccache gcc", "", ""));
CHECK(helper("ccache rel/gcc", "", "") == "rel/gcc");
CHECK(helper("ccache /abs/gcc", "", "") == "/abs/gcc");
CHECK_THROWS(helper("rel/ccache gcc", "", ""));
CHECK(helper("rel/ccache rel/gcc", "", "") == "rel/gcc");
CHECK(helper("rel/ccache /abs/gcc", "", "") == "/abs/gcc");
CHECK_THROWS(helper("/abs/ccache gcc", "", ""));
CHECK(helper("/abs/ccache rel/gcc", "", "") == "rel/gcc");
CHECK(helper("/abs/ccache /abs/gcc", "", "") == "/abs/gcc");
}
SUBCASE("double ccache")
{
// E.g. due to some suboptimal setup, scripts etc. Source:
// https://github.com/ccache/ccache/issues/686
CHECK(helper("ccache gcc", "") == "resolved_gcc");
CHECK(helper("ccache ccache gcc", "") == "resolved_gcc");
CHECK(helper("ccache ccache-1.2.3 ccache gcc", "") == "resolved_gcc");
}
SUBCASE("config")
{
// In case the first parameter is gcc it must be a link to ccache so use
// config value instead. Don't resolve config if it's a relative or absolute
// path.
CHECK(helper("gcc", "config") == "resolved_config");
CHECK(helper("gcc", "rel/config") == "rel/config");
CHECK(helper("gcc", "/abs/config") == "/abs/config");
CHECK(helper("rel/gcc", "config") == "resolved_config");
CHECK(helper("rel/gcc", "rel/config") == "rel/config");
CHECK(helper("rel/gcc", "/abs/config") == "/abs/config");
CHECK(helper("/abs/gcc", "config") == "resolved_config");
CHECK(helper("/abs/gcc", "rel/config") == "rel/config");
CHECK(helper("/abs/gcc", "/abs/config") == "/abs/config");
// In case the first parameter is ccache, use the configuration value. Don't
// resolve configuration value if it's a relative or absolute path.
CHECK(helper("ccache gcc", "config") == "resolved_config");
CHECK(helper("ccache gcc", "rel/config") == "rel/config");
CHECK(helper("ccache gcc", "/abs/config") == "/abs/config");
CHECK(helper("ccache rel/gcc", "config") == "resolved_config");
CHECK(helper("ccache /abs/gcc", "config") == "resolved_config");
// Same as above with relative path to ccache.
CHECK(helper("r/ccache gcc", "conf") == "resolved_conf");
CHECK(helper("r/ccache gcc", "rel/conf") == "rel/conf");
CHECK(helper("r/ccache gcc", "/abs/conf") == "/abs/conf");
CHECK(helper("r/ccache rel/gcc", "conf") == "resolved_conf");
CHECK(helper("r/ccache /abs/gcc", "conf") == "resolved_conf");
// Same as above with absolute path to ccache.
CHECK(helper("/a/ccache gcc", "conf") == "resolved_conf");
CHECK(helper("/a/ccache gcc", "rel/conf") == "rel/conf");
CHECK(helper("/a/ccache gcc", "/a/conf") == "/a/conf");
CHECK(helper("/a/ccache rel/gcc", "conf") == "resolved_conf");
CHECK(helper("/a/ccache /abs/gcc", "conf") == "resolved_conf");
}
}
TEST_CASE("guess_compiler")
{
TestContext test_context;
SUBCASE("Compiler not in file system")
{
CHECK(guess_compiler("/test/prefix/clang") == CompilerType::clang);
CHECK(guess_compiler("/test/prefix/clang-3.8") == CompilerType::clang);
CHECK(guess_compiler("/test/prefix/clang++") == CompilerType::clang);
CHECK(guess_compiler("/test/prefix/clang++-10") == CompilerType::clang);
CHECK(guess_compiler("/test/prefix/gcc") == CompilerType::gcc);
CHECK(guess_compiler("/test/prefix/gcc-4.8") == CompilerType::gcc);
CHECK(guess_compiler("/test/prefix/g++") == CompilerType::gcc);
CHECK(guess_compiler("/test/prefix/g++-9") == CompilerType::gcc);
CHECK(guess_compiler("/test/prefix/x86_64-w64-mingw32-gcc-posix")
== CompilerType::gcc);
CHECK(guess_compiler("/test/prefix/nvcc") == CompilerType::nvcc);
CHECK(guess_compiler("/test/prefix/nvcc-10.1.243") == CompilerType::nvcc);
CHECK(guess_compiler("/test/prefix/x") == CompilerType::other);
CHECK(guess_compiler("/test/prefix/cc") == CompilerType::other);
CHECK(guess_compiler("/test/prefix/c++") == CompilerType::other);
}
#ifndef _WIN32
SUBCASE("Follow symlink to actual compiler")
{
const auto cwd = Util::get_actual_cwd();
util::write_file(FMT("{}/gcc", cwd), "");
CHECK(symlink("gcc", FMT("{}/intermediate", cwd).c_str()) == 0);
const auto cc = FMT("{}/cc", cwd);
CHECK(symlink("intermediate", cc.c_str()) == 0);
CHECK(guess_compiler(cc) == CompilerType::gcc);
}
#endif
}
TEST_SUITE_END();
|
