ccanlint: enhance and streamline "output" testing lines.
PATCH 1/1 ccanlint: enhance and streamline "output" testing lines.
1) Require "" around input
2) Make them optional around output: if not there, loose match whitespace
3) Handle \n in output.
4) Document that "Given xxx" is optional.
--- ccan/array_size/_info | 2 +- ccan/autodata/_info | 4 +- ccan/cast/_info | 2 +- ccan/crc/_info | 2 +- ccan/io/_info | 2 +- ccan/jmap/_info | 6 +- ccan/objset/_info | 6 +- ccan/rfc822/_info | 8 +- ccan/siphash/_info | 2 +- ccan/siphash/siphash.h | 2 +- ccan/strmap/_info | 6 +- ccan/strset/_info | 4 +- ccan/take/_info | 2 +- ccan/tal/link/_info | 4 +- ccan/tal/str/str.h | 6 +- ccan/tcon/_info | 4 +- doc/ccanlint.1 | 34 +++---- doc/ccanlint.1.txt | 12 ++- tools/ccanlint/tests/examples_run.c | 182 +++++++++++++++--------------------- 19 files changed, 125 insertions(+), 165 deletions(-)
ccan/array_size/_info +1 -1
@@ -12,7 +12,7 @@ * macro or constant. * * Example: - * // Outputs "Initialized 32 values" + * // Outputs "Initialized 32 values\n" * #include <ccan/array_size/array_size.h> * #include <stdlib.h> * #include <stdio.h>
ccan/autodata/_info +2 -2
@@ -92,8 +92,8 @@ * printf("verbose mode on\n"); * return 0; * } - * // Given -v outputs 'verbose mode on' - * // Given -v -C / outputs 'chdir to /. verbose mode on' + * // Given "-v" outputs "verbose mode on\n" + * // Given "-v -C /" outputs "chdir to /. verbose mode on\n" */ int main(int argc, char *argv[]) {
ccan/cast/_info +1 -1
@@ -20,7 +20,7 @@ * License: LGPL (v2.1 or any later version) * * Example: - * // Given "test" contains "3 t's in 'test string' + * // Given "test" output contains "3 t's in 'test string'" * #include <ccan/cast/cast.h> * #include <stdint.h> * #include <stdio.h>
ccan/crc/_info +1 -1
@@ -16,7 +16,7 @@ * #include <stdio.h> * #include <stdlib.h> * - * // Given IHATEMATH outputs 0x98a3b8df + * // Given "IHATEMATH" outputs 0x98a3b8df * int main(int argc, char *argv[]) * { * if (argc != 2) {
ccan/io/_info +1 -1
@@ -11,7 +11,7 @@ * plans. * * Example: - * // Given tr A-Z a-z outputs tr a-z a-z + * // Given "tr A-Z a-z" outputs tr a-z a-z * #include <ccan/io/io.h> * #include <ccan/err/err.h> * #include <assert.h>
ccan/jmap/_info +3 -3
@@ -80,9 +80,9 @@ * jmap_free(arg); * return 0; * } - * // Given "--help" output contains "Arg 1 ('--help') is a long opt of 4 chars" - * // Given "-h" output contains "Arg 1 ('-h') is a short opt of 1 chars" - * // Given "foo" output contains "Arg 1 ('foo') is a normal arg of 3 chars" + * // Given "--help" output contains "Arg 1 ('--help') is a long opt of 4 chars\n" + * // Given "-h" output contains "Arg 1 ('-h') is a short opt of 1 chars\n" + * // Given "foo" output contains "Arg 1 ('foo') is a normal arg of 3 chars\n" * * License: LGPL (v2.1 or any later version) * Author: Rusty Russell <[email protected]>
ccan/objset/_info +3 -3
@@ -41,9 +41,9 @@ * } * return 0; * } - * // Given 'a b c' outputs No arguments start with -. - * // Given 'a -b c' outputs 2, - * // Given 'a -b -c d' outputs 2,3, + * // Given "a b c" outputs No arguments start with -. + * // Given "a -b c" outputs 2, + * // Given "a -b -c d" outputs 2,3, */ int main(int argc, char *argv[]) {
ccan/rfc822/_info +4 -4
@@ -25,9 +25,9 @@ * it too). * * Example: - * // Given '' outputs 'body' - * // Given 'From' outputs ' <[email protected]>' - * // Given 'To' outputs ' <[email protected]>' + * // Outputs "body\n" + * // Given "From" outputs <[email protected]> + * // Given "To" outputs <[email protected]> * char buf[] = "From: <[email protected]>\n" * "To: <[email protected]>\n\n" * "body\n";
@@ -35,7 +35,7 @@ * struct bytestring out; * * msg = rfc822_start(NULL, buf, sizeof(buf)); - * if (!argv[1] || !argv[1][0]) + * if (!argv[1]) * out = rfc822_body(msg); * else { * struct rfc822_header *hdr;
ccan/siphash/_info +1 -1
@@ -23,7 +23,7 @@ * Returns one 64-bit word as the hash function result. * * Example: - * // Outputs "cf2794e0277187b7" + * // Outputs cf2794e0277187b7 * #include <stdio.h> * #include <ccan/siphash/siphash.h> *
ccan/siphash/siphash.h +1 -1
@@ -28,7 +28,7 @@* Returns one 64-bit word as the hash function result. * * Example: -* // Outputs "cf2794e0277187b7" +* // Outputs cf2794e0277187b7 * #include <stdio.h> * #include <ccan/siphash/siphash.h> *
ccan/strmap/_info +3 -3
@@ -40,9 +40,9 @@ * printf("\n"); * return 0; * } - * // Given 'foo' outputs 'foo at 1. ' - * // Given 'foo bar' outputs 'bar at 2. foo at 1. ' - * // Given 'foo foo bar zebra' outputs 'bar at 3. foo at 1. zebra at 4. ' + * // Given "foo" outputs "foo at 1. \n" + * // Given "foo bar" outputs "bar at 2. foo at 1. \n" + * // Given "foo foo bar zebra" outputs "bar at 3. foo at 1. zebra at 4. \n" */ int main(int argc, char *argv[]) {
ccan/strset/_info +2 -2
@@ -45,8 +45,8 @@ * printf("\n"); * return 0; * } - * // Given "foo bar" outputs "bar foo " - * // Given "foo foo bar" outputs "bar foo " + * // Given "foo bar" outputs "bar foo \n" + * // Given "foo foo bar" outputs "bar foo \n" * * License: CC0 (but some dependencies are LGPL!) * Author: Rusty Russell <[email protected]>
ccan/take/_info +1 -1
@@ -13,7 +13,7 @@ * License: CC0 (Public domain) * * Example: - * // Given foo/bar.c outputs basename is bar.c + * // Given "foo/bar.c" outputs basename is bar.c * #include <ccan/take/take.h> * #include <string.h> *
ccan/tal/link/_info +2 -2
@@ -14,8 +14,8 @@ * // Silly program which keeps a cache of uppercased strings. * // The cache wants to keep strings around even after they may have * // been "freed" by the caller. - * // Given 'hello' outputs '1 cache hits HELLO ' - * // Given 'hello hello there' outputs '4 cache hits HELLO HELLO THERE ' + * // Given "hello" outputs "1 cache hits HELLO \n" + * // Given "hello hello there" outputs "4 cache hits HELLO HELLO THERE \n" * #include <stdio.h> * #include <err.h> * #include <string.h>
ccan/tal/str/str.h +3 -3
@@ -164,9 +164,9 @@ char *tal_strjoin(const void *ctx, char *strings[], const char *delim,* regcomp(3), regex(3). * * Example: -* // Given 'My name is Rusty' outputs 'Hello Rusty!' -* // Given 'my first name is Rusty Russell' outputs 'Hello Rusty Russell!' -* // Given 'My name isnt Rusty Russell' outputs 'Hello there!' +* // Given "My name is Rusty" outputs "Hello Rusty!\n" +* // Given "my first name is Rusty Russell" outputs "Hello Rusty Russell!\n" +* // Given "My name isnt Rusty Russell" outputs "Hello there!\n" * int main(int argc, char *argv[]) * { * char *person, *input;
ccan/tcon/_info +2 -2
@@ -54,8 +54,8 @@ * container_get(&sc), *container_get(&ic) - 1); * return 0; * } - * // Given "foo" outputs "Last arg is foo of 1 arguments" - * // Given "foo bar" outputs "Last arg is bar of 2 arguments" + * // Given "foo" outputs "Last arg is foo of 1 arguments\n" + * // Given "foo bar" outputs "Last arg is bar of 2 arguments\n" * * License: CC0 (Public domain) *
doc/ccanlint.1 +12 -22
@@ -1,13 +1,13 @@ '\" t .\" Title: ccanlint .\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 12/05/2011 +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 09/28/2015 .\" Manual: \ \& .\" Source: \ \& .\" Language: English .\" -.TH "CCANLINT" "1" "12/05/2011" "\ \&" "\ \&" +.TH "CCANLINT" "1" "09/28/2015" "\ \&" "\ \&" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" -----------------------------------------------------------------
@@ -36,7 +36,7 @@ ccanlint \- Make CCAN code modules, and the brightness up\&. .sp No encoder? No need to \fBccanlint\fR\&. You programmer? Excited to \fBccanlint\fR! .sp -CCAN module is small code of the song\&. \fBccanlint\fR full CCAN testing tool\&. Each test spray bit of wisdom\&. Also score\&. Good score good\&. Bad bad score\&. +CCAN module is small code of the song\&. \fBccanlint\fR full CCAN testing tool\&. Each test spray bit of wisdom\&. Also score\&. Good score good\&. Bad score bad\&. .sp \fBccanlint\fR expect the source code in this directory, or command line can be more than one\&. Exit 0 happy if all modules all tests happy\&. .SH "OPTIONS"
@@ -73,14 +73,12 @@ Graphviz, then die happy\&. .PP \fB\-k, \-\-keep\fR .RS 4 - \fBccanlint\fR normally make mess temporary directory, but now it later in forensic\&. .RE .PP \fB\-s, \-\-summary\fR .RS 4 - \fBccanlint\fR just realized there is no message unless you die horrible\&. .RE
@@ -107,7 +105,6 @@ Do not run all tests\&. Run this test, and the proof you need\&. Used many times .PP \fB\-\-compiler\fR=\fICOMPILER\fR .RS 4 - \fBccanlint\fR read config\&.h about finding \fICCAN_COMPILER\fR\&. Otherwise use the default when it was built\&. The change, to use this compiler\&.
@@ -148,7 +145,6 @@ question may help to write one\&. .PP \fBdepends_exist\fR .RS 4 - \fI_info\fR file CCAN other module without saying, must find\&. It is not score 0\&. .RE
@@ -197,8 +193,7 @@ unhappy\&. \fBhash_if\fR .RS 4 Module wants -\fBccanlint\fR -\fIconfig\&.h\fR +\fBccanlint\fR\fIconfig\&.h\fR "#define HAVE_FEATURE" for all feature\&. Function test "#if HAVE_FEATURE" no "#ifdef HAVE_FEATURE" because user might not know about the role at all\&. Intelligent GCC flag \fI\-Wundef\fR say HAVE_FEATURE not 0, not 1! but only if the use of
@@ -207,7 +202,6 @@ say HAVE_FEATURE not 0, not 1! but only if the use of .PP \fBinfo_documentation_exists\fR .RS 4 - \fI_info\fR file format is pretty comments\&. Copying someone\&. It is not difficult write documentation! .RE
@@ -250,7 +244,6 @@ Hostile to BSD license module, but requires another module of the GPL\&. Perhaps .PP \fBmain_header_exists\fR .RS 4 - \fBccanlint\fR know the module name directory name\&. Expect the same name for header\&. .RE
@@ -283,7 +276,6 @@ Linux kernel programmers more, solve the problem for the space of the final ban .PP \fBexamples_compile\fR .RS 4 - \fBccanlint\fR very smart! Take \fIExample:\fR
@@ -302,15 +294,16 @@ says wow! \fBexamples_run\fR .RS 4 If the example program that comments like -\fI// given foo outputs bar\fR -\fBccanlint\fR -will run the food program +\fI// Given "foo" outputs "bar"\fR\fBccanlint\fR +will run the program with \fIfoo\fR in the command line and standard input\&. Happy if \fIbar\fR -are out\&. You can do \*(Aq or " about the production or determined\&. You can also -\fIoutput contains\fR -more relaxed controls\&. +are out\&. If quotes around +\fIbar\fR +exact match needed; without quotes whitespace matches any other space and trailing ignored\&. \en is also supported for matching\&. You can also +\fI"output contains"\fR +to pass if the output contains the string\&. .RE .PP \fBmodule_links\fR
@@ -364,7 +357,6 @@ Other files .PP \fBtests_pass\fR .RS 4 - \fIrun\fR and \fIapi\fR
@@ -373,7 +365,6 @@ test happy departure\&. If not happy, offer debugger\&. .PP \fBtests_pass_valgrind\fR .RS 4 - \fBvalgrind\fR the tool of all \fIrun\fR
@@ -390,7 +381,6 @@ section, make "tests_pass_valgrind test/TESTNAME:FAIL"\&. If required valgrind a .PP \fBtests_pass_valgrind_noleaks\fR .RS 4 - \fBvalgrind\fR complain if the memory leak test\&. \fI_info\fR
doc/ccanlint.1.txt +7 -5
@@ -175,11 +175,13 @@ test, but happy: bad example *ccanlint* says wow! *examples_run*:: - If the example program that comments like '// given foo outputs bar' - *ccanlint* will run the food program 'foo' in the command line and - standard input. Happy if 'bar' are out. You can do ' or " about - the production or determined. You can also 'output contains' more - relaxed controls. + If the example program that comments like '// [Given "foo"] outputs + "bar"' then *ccanlint* will run the program with 'foo' in the + command line and standard input. Happy if 'bar' are out and exit 0. + If quotes around 'bar' exact match needed; without quotes whitespace matches + any other space and trailing ignored. \n is also supported for + matching. You can also '"output contains"' to pass if the output + contains the string. *module_links*:: CCAN link to the program module simply no error.
tools/ccanlint/tests/examples_run.c +75 -107
255 lines not on this page · raw message
Signature · 6 lines
2.1.4 _______________________________________________ ccan mailing list [email protected] https://lists.ozlabs.org/listinfo/ccan
Quoted 4 lines · Paul 'Rusty' Russell
1) Require "" around input
2) Make them optional around output: if not there, loose match whitespace
3) Handle \n in output.
4) Document that "Given xxx" is optional.
Patch looks fine to me.
Quoted 2 lines
Signed-off-by Rusty Russell <[email protected]>
Signature · 4 lines
David Gibson | I'll have my music baroque, and my code david AT gibson.dropbear.id.au | minimalist, thank you. NOT _the_ _other_ | _way_ _around_! http://www.ozlabs.org/~dgibson
_______________________________________________
ccan mailing list
[email protected]
https://lists.ozlabs.org/listinfo/ccan
Quoted 7 lines · David Gibson
Quoted 4 lines · Paul 'Rusty' Russell
1) Require "" around input
2) Make them optional around output: if not there, loose match whitespace
3) Handle \n in output.
4) Document that "Given xxx" is optional.Patch looks fine to me.
I take that back. With a bit more playing, noticed that if you *don't* put" around the input, it will silently skip the example expected output test.
Signature · 4 lines
David Gibson | I'll have my music baroque, and my code david AT gibson.dropbear.id.au | minimalist, thank you. NOT _the_ _other_ | _way_ _around_! http://www.ozlabs.org/~dgibson
_______________________________________________
ccan mailing list
[email protected]
https://lists.ozlabs.org/listinfo/ccan
Quoted 7 lines · David Gibson
Quoted 6 lines · David Gibson
Quoted 4 lines · Paul 'Rusty' Russell
1) Require "" around input
2) Make them optional around output: if not there, loose match whitespace
3) Handle \n in output.
4) Document that "Given xxx" is optional.
Quoted 5 lines
Quoted 1 line
Patch looks fine to me.
I take that back. With a bit more playing, noticed that if you *don't* put" around the input, it will silently skip the example expected output test.
It should detect some malformed uses. Let's beef it up, so it errors on any comment not otherwise recognized which starts with "// given" or "// outputs". (It already caught the "given" case).
tools/ccanlint/tests/examples_run.c +2 -2
@@ -125,8 +125,8 @@ static char *find_expect(struct ccan_file *file,return expect; } -/* "Given" without "output"? */ -if (*input) { +/* Other malformed line? */ +if (!strncasecmp (p,"given" ) || !strncasecmp (p,"outputs" )) { *error = true;return p; }
Cheers,
Rusty.
_______________________________________________
ccan mailing list
[email protected]
https://lists.ozlabs.org/listinfo/ccan