a171485c4f
If the first function in a file does not have a doc comment, do not run off the beginning of the file. Fixes #102. Also: - Add t/tree/issue102.c that exhibits this bug. - in find-file-doc-comments.pl and script.sh, exit with a nonzero code if this should recur.
79 lines
2.5 KiB
Perl
79 lines
2.5 KiB
Perl
#!/usr/bin/env perl
|
|
# 300-doc-comments.t: Test elixir doc-comment extraction against the files in tree/ .
|
|
#
|
|
# Copyright (c) 2020 Christopher White.
|
|
# Copyright (c) 2020 D3 Engineering, LLC.
|
|
# By Christopher White, <cwhite@d3engineering.com>.
|
|
#
|
|
# Elixir is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU Affero General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Elixir 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 Affero General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Affero General Public License
|
|
# along with Elixir. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
#
|
|
# This file uses core Perl modules only.
|
|
|
|
use autodie; # note: still need to check system() calls manually
|
|
|
|
use FindBin '$Bin';
|
|
use lib $Bin;
|
|
|
|
use Test::More;
|
|
|
|
use TestEnvironment;
|
|
use TestHelpers;
|
|
|
|
# ===========================================================================
|
|
# Main
|
|
|
|
# Set up
|
|
my $tenv = TestEnvironment->new;
|
|
$tenv->build_repo(sibling_abs_path('tree'))->build_db->update_env;
|
|
|
|
ok_or_die( -d $tenv->lxr_data_dir, 'database dir exists',
|
|
"Database dir @{[$tenv->lxr_data_dir]} not present");
|
|
|
|
# Spot-check some identifiers
|
|
|
|
run_produces_ok('doc-comment query (nonexistent)',
|
|
[$tenv->query_py, qw(v5.4 ident SOME_NONEXISTENT_IDENTIFIER_XYZZY_PLUGH)],
|
|
[
|
|
qr{^Documented in:},
|
|
{doc => { not => qr{/} }}, # No file paths in the doc section
|
|
],
|
|
MUST_SUCCEED);
|
|
|
|
run_produces_ok('doc-comment query (existent but not documented)',
|
|
[$tenv->query_py, qw(v5.4 ident gsb_buffer)], # in drivers/i2c/i2c-core-acpi.c
|
|
[
|
|
qr{^Documented in:},
|
|
{doc => { not => qr{/} }}
|
|
],
|
|
MUST_SUCCEED);
|
|
|
|
run_produces_ok('ident query (existent, function, documented in C file)',
|
|
[$tenv->query_py, qw(v5.4 ident i2c_acpi_get_i2c_resource)],
|
|
[
|
|
qr{^Documented in:},
|
|
{doc => qr{drivers/i2c/i2c-core-acpi\.c.+\b45\b}},
|
|
],
|
|
MUST_SUCCEED);
|
|
|
|
run_produces_ok('ident query (existent, function, documented in C file, #102)',
|
|
[$tenv->query_py, qw(v5.4 ident documented_function_XYZZY)],
|
|
[
|
|
qr{^Documented in:},
|
|
{doc => qr{issue102\.c.+\b6\b}},
|
|
],
|
|
MUST_SUCCEED);
|
|
|
|
done_testing;
|