'\" 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
.\" -----------------------------------------------------------------
.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"
.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
.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\&.
.PP
\fBdepends_exist\fR
.RS 4
-
\fI_info\fR
file CCAN other module without saying, must find\&. It is not score 0\&.
.RE
\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
.PP
\fBinfo_documentation_exists\fR
.RS 4
-
\fI_info\fR
file format is pretty comments\&. Copying someone\&. It is not difficult write documentation!
.RE
.PP
\fBmain_header_exists\fR
.RS 4
-
\fBccanlint\fR
know the module name directory name\&. Expect the same name for header\&.
.RE
.PP
\fBexamples_compile\fR
.RS 4
-
\fBccanlint\fR
very smart! Take
\fIExample:\fR
\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
.PP
\fBtests_pass\fR
.RS 4
-
\fIrun\fR
and
\fIapi\fR
.PP
\fBtests_pass_valgrind\fR
.RS 4
-
\fBvalgrind\fR
the tool of all
\fIrun\fR
.PP
\fBtests_pass_valgrind_noleaks\fR
.RS 4
-
\fBvalgrind\fR
complain if the memory leak test\&.
\fI_info\fR
#include <tools/tools.h>
#include <ccan/foreach/foreach.h>
#include <ccan/str/str.h>
+#include <ccan/tal/str/str.h>
#include <ccan/cast/cast.h>
#include <sys/types.h>
#include <sys/stat.h>
}
static char *find_expect(struct ccan_file *file,
- char **lines, char **input, bool *exact,
+ char **lines, char **input,
+ bool *contains, bool *whitespace, bool *error,
unsigned *line)
{
- char *expect;
- const char *fmt;
+ char *rest, *expect;
+ *error = false;
for (; lines[*line]; (*line)++) {
char *p = lines[*line] + strspn(lines[*line], " \t");
if (!strstarts(p, "//"))
continue;
p += strspn(p, "/ ");
- foreach_ptr(fmt,
- "given '%s', outputs '%s'",
- "given '%s' outputs '%s'",
- "given \"%s\", outputs \"%s\"",
- "given \"%s\" outputs \"%s\"") {
- if (scan_for(file, p, fmt, input, &expect)) {
- *exact = true;
- return expect;
- }
- }
-
- foreach_ptr(fmt,
- "given '%s', output contains '%s'",
- "given '%s' output contains '%s'",
- "given \"%s\", output contains \"%s\"",
- "given \"%s\" output contains \"%s\"") {
- if (scan_for(file, p, fmt, input, &expect)) {
- *exact = false;
- return expect;
- }
- }
- foreach_ptr(fmt, "outputs '%s'", "outputs \"%s\"") {
- if (scan_for(file, p, fmt, &expect)) {
- *input = cast_const(char *, "");
- *exact = true;
- return expect;
+ /* With or without input? */
+ if (strncasecmp(p, "given", strlen("given")) == 0) {
+ /* Must be of form <given "X"> */
+ if (!scan_for(file, p, "given \"%s\" %s", input, &p)) {
+ *error = true;
+ return p;
}
+ } else {
+ *input = NULL;
}
- foreach_ptr(fmt,
- "given '%s', output contains '%s'",
- "given '%s' output contains '%s'",
- "given \"%s\", output contains \"%s\"",
- "given \"%s\" output contains \"%s\"") {
- if (scan_for(file, p, fmt, input, &expect)) {
- *exact = false;
- return expect;
- }
+ if (scan_for(file, p, "outputs \"%s\"", &expect)) {
+ *whitespace = true;
+ *contains = false;
+ return expect;
}
- /* Unquoted versions... we can get this wrong! */
- foreach_ptr(fmt,
- "given %s, outputs '%s'",
- "given '%s', outputs %s",
- "given %s, outputs \"%s\"",
- "given \"%s\", outputs %s",
- "given %s, outputs %s",
- "given %s outputs '%s'",
- "given '%s' outputs %s",
- "given %s outputs \"%s\"",
- "given \"%s\" outputs %s",
- "given %s outputs %s") {
- if (scan_for(file, p, fmt, input, &expect)) {
- *exact = true;
- return expect;
- }
+ if (scan_for(file, p, "output contains \"%s\"", &expect)) {
+ *whitespace = true;
+ *contains = true;
+ return expect;
}
- foreach_ptr(fmt,
- "given %s, output contains '%s'",
- "given '%s', output contains %s",
- "given %s, output contains \"%s\"",
- "given \"%s\", output contains %s",
- "given %s, output contains %s",
- "given %s output contains '%s'",
- "given '%s' output contains %s",
- "given %s output contains \"%s\"",
- "given \"%s\" output contains %s",
- "given %s output contains %s") {
- if (scan_for(file, p, fmt, input, &expect)) {
- *exact = false;
- return expect;
- }
+ /* Whitespace-ignoring versions. */
+ if (scan_for(file, p, "outputs %s", &expect)) {
+ *whitespace = false;
+ *contains = false;
+ return expect;
}
- foreach_ptr(fmt,
- "outputs '%s'",
- "outputs \"%s\"",
- "outputs %s") {
- if (scan_for(file, p, fmt, &expect)) {
- *input = cast_const(char *, "");
- *exact = true;
- return expect;
- }
+ if (scan_for(file, p, "output contains %s", &expect)) {
+ *whitespace = false;
+ *contains = true;
+ return expect;
}
- foreach_ptr(fmt,
- "output contains '%s'",
- "output contains \"%s\"",
- "output contains %s") {
- if (scan_for(file, p, fmt, &expect)) {
- *input = cast_const(char *, "");
- *exact = false;
- return expect;
- }
+ /* Other malformed line? */
+ if (*input || !strncasecmp(p, "output", strlen("output"))) {
+ *error = true;
+ return p;
}
- }
+ }
return NULL;
}
-static char *trim(char *string)
-{
- while (strends(string, "\n"))
- string[strlen(string)-1] = '\0';
- return string;
-}
-
static char *unexpected(struct ccan_file *i, const char *input,
- const char *expect, bool exact)
+ const char *expect, bool contains, bool whitespace)
{
char *output, *cmd;
+ const char *p;
bool ok;
unsigned int default_time = default_timeout_ms;
- cmd = tal_fmt(i, "echo '%s' | %s %s",
- input, i->compiled[COMPILE_NORMAL], input);
+ if (input)
+ cmd = tal_fmt(i, "echo '%s' | %s %s",
+ input, i->compiled[COMPILE_NORMAL], input);
+ else
+ cmd = tal_fmt(i, "%s", i->compiled[COMPILE_NORMAL]);
output = run_with_timeout(i, cmd, &ok, &default_time);
if (!ok)
return tal_fmt(i, "Exited with non-zero status\n");
- if (exact) {
- if (streq(output, expect) || streq(trim(output), expect))
+ /* Substitute \n */
+ while ((p = strstr(expect, "\\n")) != NULL) {
+ expect = tal_fmt(cmd, "%.*s\n%s", (int)(p - expect), expect,
+ p+2);
+ }
+
+ if (!whitespace) {
+ /* Normalize to spaces. */
+ expect = tal_strjoin(cmd,
+ tal_strsplit(cmd, expect, " \n\t",
+ STR_NO_EMPTY),
+ " ", STR_NO_TRAIL);
+ output = tal_strjoin(cmd,
+ tal_strsplit(cmd, output, " \n\t",
+ STR_NO_EMPTY),
+ " ", STR_NO_TRAIL);
+ }
+
+ if (contains) {
+ if (strstr(output, expect))
return NULL;
} else {
- if (strstr(output, expect))
+ if (streq(output, expect))
return NULL;
}
+
return output;
}
list_for_each(list, i, list) {
char **lines, *expect, *input, *output;
unsigned int linenum = 0;
- bool exact;
+ bool contains, whitespace, error;
lines = get_ccan_file_lines(i);
- for (expect = find_expect(i, lines, &input, &exact,
+ for (expect = find_expect(i, lines, &input,
+ &contains, &whitespace, &error,
&linenum);
expect;
linenum++,
expect = find_expect(i, lines, &input,
- &exact, &linenum)) {
+ &contains, &whitespace,
+ &error, &linenum)) {
+ if (error) {
+ score_file_error(score, i, linenum+1,
+ "Unparsable test line '%s'",
+ lines[linenum]);
+ score->pass = false;
+ break;
+ }
+
if (i->compiled[COMPILE_NORMAL] == NULL)
continue;
score->total++;
- output = unexpected(i, input, expect, exact);
+ output = unexpected(i, input, expect,
+ contains, whitespace);
if (!output) {
score->score++;
continue;
score_file_error(score, i, linenum+1,
"output '%s' didn't %s '%s'\n",
output,
- exact ? "match" : "contain",
+ contains ? "contain" : "match",
expect);
score->pass = false;
}
projects / ccan / commitdiff