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 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
|
extern crate cbindgen;
use cbindgen::*;
use std::collections::HashSet;
use std::fs::File;
use std::io::Read;
use std::path::Path;
use std::process::Command;
use std::{env, fs, str};
use pretty_assertions::assert_eq;
// Set automatically by cargo for integration tests
static CBINDGEN_PATH: &str = env!("CARGO_BIN_EXE_cbindgen");
fn style_str(style: Style) -> &'static str {
match style {
Style::Both => "both",
Style::Tag => "tag",
Style::Type => "type",
}
}
fn run_cbindgen(
path: &Path,
output: Option<&Path>,
language: Language,
cpp_compat: bool,
style: Option<Style>,
generate_depfile: bool,
package_version: bool,
) -> (Vec<u8>, Option<String>) {
assert!(
!(output.is_none() && generate_depfile),
"generating a depfile requires outputting to a path"
);
let program = Path::new(CBINDGEN_PATH);
let mut command = Command::new(program);
if let Some(output) = output {
command.arg("--output").arg(output);
}
let cbindgen_depfile = if generate_depfile {
let depfile = tempfile::NamedTempFile::new().unwrap();
command.arg("--depfile").arg(depfile.path());
Some(depfile)
} else {
None
};
match language {
Language::Cxx => {}
Language::C => {
command.arg("--lang").arg("c");
if cpp_compat {
command.arg("--cpp-compat");
}
}
Language::Cython => {
command.arg("--lang").arg("cython");
}
}
if package_version {
command.arg("--package-version");
}
if let Some(style) = style {
command.arg("--style").arg(style_str(style));
}
let config = path.with_extension("toml");
if config.exists() {
command.arg("--config").arg(config);
}
command.arg(path);
println!("Running: {:?}", command);
let cbindgen_output = command.output().expect("failed to execute process");
assert!(
cbindgen_output.status.success(),
"cbindgen failed: {:?} with error: {}",
output,
str::from_utf8(&cbindgen_output.stderr).unwrap_or_default()
);
let bindings = if let Some(output_path) = output {
let mut bindings = Vec::new();
// Ignore errors here, we have assertions on the expected output later.
let _ = File::open(output_path).map(|mut file| {
let _ = file.read_to_end(&mut bindings);
});
bindings
} else {
cbindgen_output.stdout
};
let depfile_contents = if let Some(mut depfile) = cbindgen_depfile {
let mut raw = Vec::new();
depfile.read_to_end(&mut raw).unwrap();
Some(
str::from_utf8(raw.as_slice())
.expect("Invalid encoding encountered in depfile")
.into(),
)
} else {
None
};
(bindings, depfile_contents)
}
fn compile(
cbindgen_output: &Path,
tests_path: &Path,
tmp_dir: &Path,
language: Language,
style: Option<Style>,
skip_warning_as_error: bool,
) {
let cc = match language {
Language::Cxx => env::var("CXX").unwrap_or_else(|_| "g++".to_owned()),
Language::C => env::var("CC").unwrap_or_else(|_| "gcc".to_owned()),
Language::Cython => env::var("CYTHON").unwrap_or_else(|_| "cython3".to_owned()),
};
let file_name = cbindgen_output
.file_name()
.expect("cbindgen output should be a file");
let mut object = tmp_dir.join(file_name);
object.set_extension("o");
let mut command = Command::new(cc);
match language {
Language::Cxx | Language::C => {
command.arg("-D").arg("DEFINED");
command.arg("-I").arg(tests_path);
command.arg("-Wall");
if !skip_warning_as_error {
command.arg("-Werror");
}
// `swift_name` is not recognzied by gcc.
command.arg("-Wno-attributes");
// clang warns about unused const variables.
command.arg("-Wno-unused-const-variable");
// clang also warns about returning non-instantiated templates (they could
// be specialized, but they're not so it's fine).
command.arg("-Wno-return-type-c-linkage");
// deprecated warnings should not be errors as it's intended
command.arg("-Wno-deprecated-declarations");
if let Language::Cxx = language {
// enum class is a c++11 extension which makes g++ on macos 10.14 error out
// inline variables are are a c++17 extension
command.arg("-std=c++17");
// Prevents warnings when compiling .c files as c++.
command.arg("-x").arg("c++");
if let Ok(extra_flags) = env::var("CXXFLAGS") {
command.args(extra_flags.split_whitespace());
}
} else if let Ok(extra_flags) = env::var("CFLAGS") {
command.args(extra_flags.split_whitespace());
}
if let Some(style) = style {
command.arg("-D");
command.arg(format!(
"CBINDGEN_STYLE_{}",
style_str(style).to_uppercase()
));
}
command.arg("-o").arg(&object);
command.arg("-c").arg(cbindgen_output);
}
Language::Cython => {
command.arg("-Wextra");
if !skip_warning_as_error {
// Our tests contain code that is deprecated in Cython 3.0.
// Allowing warnings buys a little time.
// command.arg("-Werror");
}
command.arg("-3");
command.arg("-o").arg(&object);
command.arg(cbindgen_output);
}
}
println!("Running: {:?}", command);
let out = command.output().expect("failed to compile");
assert!(out.status.success(), "Output failed to compile: {:?}", out);
if object.exists() {
fs::remove_file(object).unwrap();
}
}
const SKIP_WARNING_AS_ERROR_SUFFIX: &str = ".skip_warning_as_error";
#[allow(clippy::too_many_arguments)]
fn run_compile_test(
name: &'static str,
path: &Path,
tmp_dir: &Path,
language: Language,
cpp_compat: bool,
style: Option<Style>,
cbindgen_outputs: &mut HashSet<Vec<u8>>,
package_version: bool,
) {
let crate_dir = env::var("CARGO_MANIFEST_DIR").unwrap();
let tests_path = Path::new(&crate_dir).join("tests");
let mut generated_file = tests_path.join("expectations");
if let Some(cargo_target_tmpdir) = option_env!("CARGO_TARGET_TMPDIR") {
generated_file = Path::new(cargo_target_tmpdir).join("expectations");
}
fs::create_dir_all(&generated_file).unwrap();
let style_ext = style
// Cython is sensitive to dots, so we can't include any dots.
.map(|style| match style {
Style::Both => "_both",
Style::Tag => "_tag",
Style::Type => "",
})
.unwrap_or_default();
let lang_ext = match language {
Language::Cxx => ".cpp",
Language::C if cpp_compat => ".compat.c",
Language::C => ".c",
// cbindgen is supposed to generate declaration files (`.pxd`), but `cython` compiler
// is extension-sensitive and won't work on them, so we use implementation files (`.pyx`)
// in the test suite.
Language::Cython => ".pyx",
};
let skip_warning_as_error = name.rfind(SKIP_WARNING_AS_ERROR_SUFFIX).is_some();
let source_file =
format!("{}{}{}", name, style_ext, lang_ext).replace(SKIP_WARNING_AS_ERROR_SUFFIX, "");
generated_file.push(source_file);
let (output_file, generate_depfile) = if env::var_os("CBINDGEN_TEST_VERIFY").is_some() {
(None, false)
} else {
(
Some(generated_file.as_path()),
// --depfile does not work in combination with expanding yet, so we blacklist expanding tests.
!(name.contains("expand") || name.contains("bitfield")),
)
};
let (cbindgen_output, depfile_contents) = run_cbindgen(
path,
output_file,
language,
cpp_compat,
style,
generate_depfile,
package_version,
);
if generate_depfile {
let depfile = depfile_contents.expect("No depfile generated");
assert!(!depfile.is_empty());
let mut rules = depfile.split(':');
let target = rules.next().expect("No target found");
assert_eq!(target, generated_file.as_os_str().to_str().unwrap());
let sources = rules.next().unwrap();
// All the tests here only have one sourcefile.
assert!(
sources.contains(path.to_str().unwrap()),
"Path: {:?}, Depfile contents: {}",
path,
depfile
);
assert_eq!(rules.count(), 0, "More than 1 rule in the depfile");
}
if cbindgen_outputs.contains(&cbindgen_output) {
// We already generated an identical file previously.
if env::var_os("CBINDGEN_TEST_VERIFY").is_some() {
assert!(!generated_file.exists());
} else if generated_file.exists() {
fs::remove_file(&generated_file).unwrap();
}
} else {
if env::var_os("CBINDGEN_TEST_VERIFY").is_some() {
use std::str::from_utf8;
let prev_cbindgen_output = fs::read(&generated_file).unwrap();
let cbindgen_output = from_utf8(&cbindgen_output).unwrap();
let prev_cbindgen_output = from_utf8(&prev_cbindgen_output).unwrap();
assert_eq!(prev_cbindgen_output, cbindgen_output);
} else {
fs::write(&generated_file, &cbindgen_output).unwrap();
}
cbindgen_outputs.insert(cbindgen_output);
if env::var_os("CBINDGEN_TEST_NO_COMPILE").is_some() {
return;
}
compile(
&generated_file,
&tests_path,
tmp_dir,
language,
style,
skip_warning_as_error,
);
if language == Language::C && cpp_compat {
compile(
&generated_file,
&tests_path,
tmp_dir,
Language::Cxx,
style,
skip_warning_as_error,
);
}
}
}
fn test_file(name: &'static str, filename: &'static str) {
let test = Path::new(filename);
let tmp_dir = tempfile::Builder::new()
.prefix("cbindgen-test-output")
.tempdir()
.expect("Creating tmp dir failed");
let tmp_dir = tmp_dir.path();
// Run tests in deduplication priority order. C++ compatibility tests are run first,
// otherwise we would lose the C++ compiler run if they were deduplicated.
let mut cbindgen_outputs = HashSet::new();
for cpp_compat in &[true, false] {
for style in &[Style::Type, Style::Tag, Style::Both] {
run_compile_test(
name,
test,
tmp_dir,
Language::C,
*cpp_compat,
Some(*style),
&mut cbindgen_outputs,
false,
);
}
}
run_compile_test(
name,
test,
tmp_dir,
Language::Cxx,
/* cpp_compat = */ false,
None,
&mut HashSet::new(),
false,
);
// `Style::Both` should be identical to `Style::Tag` for Cython.
let mut cbindgen_outputs = HashSet::new();
for style in &[Style::Type, Style::Tag] {
run_compile_test(
name,
test,
tmp_dir,
Language::Cython,
/* cpp_compat = */ false,
Some(*style),
&mut cbindgen_outputs,
false,
);
}
}
macro_rules! test_file {
($test_function_name:ident, $name:expr, $file:tt) => {
#[test]
fn $test_function_name() {
test_file($name, $file);
}
};
}
// This file is generated by build.rs
include!(concat!(env!("OUT_DIR"), "/tests.rs"));
|