From f3f5d82e2854991cd12ad5dcf022e8abbcea7038 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Tue, 12 May 2020 13:29:53 +0200 Subject: docs/options-in-versions: which version added each cmdline option Added test 971 to verify that the list is in sync with the files in cmdline-opts. The check also verifies that .d-files that uses Added: specify the same version number as the options-in-versions file does. Closes #5381 --- tests/Makefile.am | 2 +- tests/data/Makefile.inc | 2 +- tests/data/test971 | 25 ++++++++++ tests/options-scan.pl | 120 ++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 147 insertions(+), 2 deletions(-) create mode 100644 tests/data/test971 create mode 100644 tests/options-scan.pl (limited to 'tests') diff --git a/tests/Makefile.am b/tests/Makefile.am index cea09d146..9773b86db 100644 --- a/tests/Makefile.am +++ b/tests/Makefile.am @@ -33,7 +33,7 @@ EXTRA_DIST = ftpserver.pl httpserver.pl secureserver.pl runtests.pl \ negtelnetserver.py smbserver.py curl_test_data.py \ objnames-test08.sh objnames-test10.sh objnames.inc \ disable-scan.pl manpage-syntax.pl error-codes.pl badsymbols.pl \ - azure.pm appveyor.pm version-scan.pl + azure.pm appveyor.pm version-scan.pl options-scan.pl DISTCLEANFILES = configurehelp.pm diff --git a/tests/data/Makefile.inc b/tests/data/Makefile.inc index 07ab2a974..c83e7181a 100644 --- a/tests/data/Makefile.inc +++ b/tests/data/Makefile.inc @@ -113,7 +113,7 @@ test927 test928 test929 test930 test931 test932 test933 test934 test935 \ test936 test937 test938 test939 test940 test941 test942 test943 test944 \ test945 test946 test947 test948 test949 test950 test951 test952 test953 \ test954 test955 test956 test957 test958 test959 test960 test961 test962 \ -test963 test964 test965 test966 test967 test968 test969 test970 \ +test963 test964 test965 test966 test967 test968 test969 test970 test971 \ \ test1000 test1001 test1002 test1003 test1004 test1005 test1006 test1007 \ test1008 test1009 test1010 test1011 test1012 test1013 test1014 test1015 \ diff --git a/tests/data/test971 b/tests/data/test971 new file mode 100644 index 000000000..de134e8e6 --- /dev/null +++ b/tests/data/test971 @@ -0,0 +1,25 @@ + + + +source analysis +options-in-versions + + + +# +# Client-side + + +none + + + +Verify that options-in-versions and docs/cmdline-opts are in sync + + + +%SRCDIR/options-scan.pl %SRCDIR/../docs/options-in-versions %SRCDIR/../docs/cmdline-opts + + + + diff --git a/tests/options-scan.pl b/tests/options-scan.pl new file mode 100644 index 000000000..d79969a29 --- /dev/null +++ b/tests/options-scan.pl @@ -0,0 +1,120 @@ +#!/usr/bin/env perl +#*************************************************************************** +# _ _ ____ _ +# Project ___| | | | _ \| | +# / __| | | | |_) | | +# | (__| |_| | _ <| |___ +# \___|\___/|_| \_\_____| +# +# Copyright (C) 2010 - 2020, Daniel Stenberg, , et al. +# +# 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.haxx.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. +# +########################################################################### +# +# +# - Get all options mentioned in the $cmddir. +# - Make sure they're all mentioned inthe $opts document +# - Make usre that the version in $opts matches the version in the file in +# $cmddir +# + +my $opts = $ARGV[0]; +my $cmddir = $ARGV[1]; + +sub cmdfiles { + my ($dir)=@_; + + opendir(my $dh, $dir) || die "Can't opendir $dir: $!"; + my @opts = grep { /\.d$/ && -f "$dir/$_" } readdir($dh); + closedir $dh; + + for(@opts) { + $_ =~ s/\.d$//; + $file{$_}=1; + } + return @opts; +} + +sub mentions { + my ($f) = @_; + my @options; + open(F, "<$f"); + while() { + chomp; + if(/(.*) +([0-9.]+)/) { + my ($flag, $version)=($1, $2); + + # store the name without the leading dashes + $flag =~ s/^--//; + + # cut out short option (if present) + $flag =~ s/ \(-.\)//; + + # store the name without trailing space + $flag =~ s/ +$//; + + push @options, $flag; + + # options-in-versions says... + $oiv{$flag} = $version; + } + } + return @options; +} + +sub versioncheck { + my ($f, $v)=@_; + open(F, "<$cmddir/$f.d"); + while() { + chomp; + if(/^Added: ([0-9.]+)/) { + if($1 ne $v) { + print STDERR "$f lists $v in doc but $1 in file\n"; + $error++; + } + last; + } + } + close(F); +} + +# get all the files +my @cmdopts = cmdfiles($cmddir); + +# get all the options mentioned in $o +my @veropts = mentions($opts); + +# check if all files are in the doc +for my $c (sort @cmdopts) { + if($oiv{$c}) { + # present, but at same version? + versioncheck($c, $oiv{$c}); + } + else { + print STDERR "$c is in the directory but not in file!\n"; + $error++; + } +} + +# check if the all options in the doc have files +for my $v (sort @veropts) { + if($file{$v}) { + # present + } + else { + print STDERR "$v is in the doc but NOT as a file!\n"; + $error++; + } +} + +exit $error; -- cgit v1.2.3