mirror of
https://github.com/curl/curl.git
synced 2026-04-12 00:11:42 +08:00
39542f0993
Tests are build in "unity"-style, by including sources into an umbrella C files (similar to how CMake unity works). This does not play well with clang-tidy, which seems to unconditionally ignore C sources included like this. To fix it, curl's CMake implements a manual clang-tidy support for tests, which compiles sources one-by-one, while also making sure sources compile cleanly standalone (e.g. all sources need to include `first.h`). The manual clang-tidy implementation is fragile, and performance, in particular when targeting Windows, is abysmal. This patch introduces an alternate solution, enabled by the `_CURL_TESTS_CONCAT=ON` option. In this mode, umbrella sources include the actual sources instead of `#including` them. Allowing to use CMake's built-in clang-tidy support to compile them, with clang-tidy actually checking the sources. Making the manual clang-tidy support unnecessary. In the Windows CI job it results in a 4x performance improvement (4m -> 1m), making it practical to run clang-tidy on tests on Windows, in CI. The main downside is that clang-tidy doesn't understand the `#line` directive. Meaning issues found show the wrong filename and line number next to them. It's not impossible to locate errors this way, but also not convenient. Minor/potential downside is that the concatenated source needs to be reassembled each time an original source is updated. This may result in more copying on the disk when used in local development. The largest source is 1.4MB, so probably not a show-stopper on most machines. Another is the complexity of maintaining two methods in parallel, which may be necessary till clang-tidy understands `#line`: https://github.com/llvm/llvm-project/issues/62405 This solution may in theory also enable adding clang-tidy support for tests in autotools, though I haven't tried. Targeted for curl CI for now, and used in a GHA/windows job. 100% experimental, not recommended outside these. Closes #20667
116 lines
3.1 KiB
Perl
Executable File
116 lines
3.1 KiB
Perl
Executable File
#!/usr/bin/env perl
|
|
#***************************************************************************
|
|
# _ _ ____ _
|
|
# Project ___| | | | _ \| |
|
|
# / __| | | | |_) | |
|
|
# | (__| |_| | _ <| |___
|
|
# \___|\___/|_| \_\_____|
|
|
#
|
|
# Copyright (C) Viktor Szakats
|
|
#
|
|
# This software is licensed as described in the file COPYING, which
|
|
# you should have received as part of this distribution. The terms
|
|
# are also available at https://curl.se/docs/copyright.html.
|
|
#
|
|
# You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
# copies of the Software, and permit persons to whom the Software is
|
|
# furnished to do so, under the terms of the COPYING file.
|
|
#
|
|
# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
# KIND, either express or implied.
|
|
#
|
|
# SPDX-License-Identifier: curl
|
|
#
|
|
###########################################################################
|
|
|
|
# Helper script for "unity"-like support in autotools and to bundle up tests
|
|
# for both autotools and cmake. It generates the umbrella C source that
|
|
# includes the individual source files and tests.
|
|
|
|
use strict;
|
|
use warnings;
|
|
|
|
if(!@ARGV) {
|
|
die "Usage: $0 [--concat [-I<incdir>]] [--test <tests>] [--include <include-c-sources>]\n";
|
|
}
|
|
|
|
my @src;
|
|
my %include;
|
|
my $in_include = 0;
|
|
my $any_test = 0;
|
|
my $concat = 0;
|
|
my @incpath;
|
|
foreach my $src (@ARGV) {
|
|
if($src eq "--concat") {
|
|
$concat = 1;
|
|
}
|
|
elsif($src =~ "^-I") {
|
|
push @incpath, substr($src, 2);
|
|
}
|
|
elsif($src eq "--test") {
|
|
$in_include = 0;
|
|
}
|
|
elsif($src eq "--include") {
|
|
$in_include = 1;
|
|
}
|
|
elsif($in_include) {
|
|
$include{$src} = 1;
|
|
push @src, $src;
|
|
}
|
|
else {
|
|
push @src, $src;
|
|
$any_test = 1;
|
|
}
|
|
}
|
|
|
|
sub include($@) {
|
|
my $filename = shift;
|
|
if($concat) {
|
|
if(! -f $filename) {
|
|
foreach my $path (@incpath) {
|
|
my $fullfn = $path . "/" . $filename;
|
|
if(-f $fullfn) {
|
|
$filename = $fullfn;
|
|
last;
|
|
}
|
|
}
|
|
}
|
|
open(my $fh, '<', $filename) or die "Cannot open '$filename': $!";
|
|
my $content = do { local $/; <$fh> };
|
|
close $fh;
|
|
print "#line 1 \"$filename\"\n$content\n";
|
|
}
|
|
else {
|
|
print "#include \"$filename\"\n";
|
|
}
|
|
}
|
|
|
|
print "/* !checksrc! disable COPYRIGHT all */\n\n";
|
|
if($any_test) {
|
|
if($concat) {
|
|
print "/* NOLINTBEGIN(readability-duplicate-include) */\n\n";
|
|
}
|
|
include("first.h");
|
|
print "\n";
|
|
}
|
|
|
|
my $tlist = "";
|
|
|
|
foreach my $src (@src) {
|
|
if($src =~ /([a-z0-9_]+)\.c$/) {
|
|
my $name = $1;
|
|
include($src);
|
|
if(not exists $include{$src}) { # register test entry function
|
|
$tlist .= " {\"$name\", test_$name},\n";
|
|
}
|
|
}
|
|
}
|
|
|
|
if($any_test) {
|
|
print "\nconst struct entry_s s_entries[] = {\n$tlist {NULL, NULL}\n};\n\n";
|
|
include("first.c");
|
|
if($concat) {
|
|
print "/* NOLINTEND(readability-duplicate-include) */\n";
|
|
}
|
|
}
|