curl-curl/scripts/mk-unity.pl
Viktor Szakats 6a0cd4feb7
tests: make individual test sources compile cleanly
Tidy up headers and includes to ensure all individual test source
compile cleanly (but not link). To allow running clang-tidy (and
possibly other static analyzers) on them. It also improves readability
and allows to verify them locally, without the bundle logic.

clang-tidy ignores #included C files, so it's blind to bundle C files
the include these tests. The current workaround of embedding has
a couple of downsides:. meaningless filenames and line numbers,
missing issues, messing up self header paths. Thus, running it on
individual sources would be beneficial.

Also:
- de-duplicate includes.
- untangle some includes.
- formatting/indentation fixes.
- merge `getpart.h` into `first.h`.

Ref: https://github.com/curl/curl/pull/17680#issuecomment-2991730158

Closes #17703
2025-06-22 15:58:15 +02:00

103 lines
2.8 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 [--test <tests>] [--include <include-c-sources>] [--srcdir <srcdir>] [--embed]\n";
}
my @src;
my %include;
my $in_include = 0;
my $srcdir = "";
my $in_srcdir = 0;
my $any_test = 0;
my $embed = 0;
foreach my $src (@ARGV) {
if($src eq "--test") {
$in_include = 0;
}
elsif($src eq "--include") {
$in_include = 1;
}
elsif($src eq "--embed") {
$embed = 1;
}
elsif($src eq "--srcdir") {
$in_srcdir = 1;
}
elsif($in_srcdir) {
$srcdir = $src;
$in_srcdir = 0;
}
elsif($in_include) {
$include{$src} = 1;
push @src, $src;
}
else {
push @src, $src;
$any_test = 1;
}
}
print "/* !checksrc! disable COPYRIGHT all */\n\n";
if($any_test) {
print "#include \"first.h\"\n\n";
}
my $tlist = "";
foreach my $src (@src) {
if($src =~ /([a-z0-9_]+)\.c$/) {
my $name = $1;
if($embed) {
my $fn = $src;
if($srcdir ne "" && -e "$srcdir/$fn") {
$fn = $srcdir . "/" . $fn;
}
print "/* Embedding: \"$src\" */\n";
my $content = do { local $/; open my $fh, '<', $fn or die $!; <$fh> };
print $content;
}
else {
print "#include \"$src\"\n";
}
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";
print "\n#include \"first.c\"\n";
}