Merge pull request #2046 from wilzbach/improve-doc-tester

Improve dspec_tester.d

Author: wilzbach

dspec_tester.d

@@ -24,21 +24,82 @@ struct Config {
     string dmdBinPath = "dmd";
     bool printLineNumbers; // whether line numbers should be shown on errors
 }
-Config config;
+shared Config config;
+
+// a range until the next ')', nested () are ignored
+auto untilClosingParentheses(R)(R rs)
+{
+    struct State
+    {
+        uint rightParensCount = 1;
+        bool inCodeBlock;
+        uint dashCount;
+    }
+    return rs.cumulativeFold!((state, r){
+        if (r == '-')
+        {
+            state.dashCount++;
+        }
+        else
+        {
+            if (state.dashCount >= 3)
+                state.inCodeBlock = !state.inCodeBlock;
+            state.dashCount = 0;
+        }
+        switch(r)
+        {
+            case '-':
+                break;
+            case '(':
+                if (!state.inCodeBlock)
+                    state.rightParensCount++;
+                break;
+            case ')':
+                if (!state.inCodeBlock)
+                    state.rightParensCount--;
+                break;
+            default:
+        }
+        return state;
+    })(State()).zip(rs).until!(e => e[0].rightParensCount == 0).map!(e => e[1]);
+}
+
+unittest
+{
+    import std.algorithm.comparison : equal;
+    assert("aa $(foo $(bar)foobar)".untilClosingParentheses.equal("aa $(foo $(bar)foobar)"));
+}
+
+auto findDdocMacro(R)(R text, string ddocKey)
+{
+    return text.splitter(ddocKey).map!untilClosingParentheses.dropOne;
+}
+
+auto ddocMacroToCode(R)(R text)
+{
+    import std.ascii : newline;
+    import std.conv : to;
+    return text.find("---")
+               .findSplitAfter(newline)[1]
+               .findSplitBefore("---")[0]
+               .to!string;
+}
 
 int main(string[] args)
 {
-    import std.conv, std.file, std.getopt, std.path;
+    import std.file, std.getopt, std.path;
     import std.parallelism : parallel;
     import std.process : environment;
+    import std.typecons : Tuple;
 
     auto specDir = __FILE_FULL_PATH__.dirName.buildPath("spec");
-    config.dmdBinPath = environment.get("DMD", "dmd");
     bool hasFailed;
 
+    config.dmdBinPath = environment.get("DMD", "dmd");
     auto helpInformation = getopt(
         args,
-        "l|lines", "Show the line numbers on errors", &config.printLineNumbers,
+        "l|lines", "Show the line numbers on errors", cast(bool*) &config.printLineNumbers,
+        "compiler", "D compiler to use", cast(string*) &config.dmdBinPath,
     );
 
     if (helpInformation.helpWanted)
@@ -50,23 +111,22 @@ int main(string[] args)
     }
 
     // Find all examples in the specification
-    auto r = regex(`SPEC_RUNNABLE_EXAMPLE\n\s*---+\n[^-]*---+\n\s*\)`, "s");
+    alias findExamples = (file, ddocKey) => file
+            .readText
+            .findDdocMacro(ddocKey)
+            .map!ddocMacroToCode;
+
+    alias SpecType = Tuple!(string, "key", CompileConfig.TestMode, "mode");
+    auto specTypes = [
+        SpecType("$(SPEC_RUNNABLE_EXAMPLE_COMPILE", CompileConfig.TestMode.compile),
+        SpecType("$(SPEC_RUNNABLE_EXAMPLE_RUN", CompileConfig.TestMode.run),
+        SpecType("$(SPEC_RUNNABLE_EXAMPLE_FAIL", CompileConfig.TestMode.fail),
+    ];
     foreach (file; specDir.dirEntries("*.dd", SpanMode.depth).parallel(1))
     {
-        import std.ascii : newline;
-        import std.uni : isWhite;
-        auto allTests =
-            file
-            .readText
-            .matchAll(r)
-            .map!(a => a[0])
-            .map!(a => a
-                    .find("---")
-                    .findSplitAfter(newline)[1]
-                    .findSplitBefore("---")[0]
-                    .to!string)
-            .map!compileAndCheck;
-
+        auto allTests = specTypes.map!(c => findExamples(file, c.key)
+                                            .map!(e => compileAndCheck(e, CompileConfig(c.mode))))
+                                 .joiner;
         if (!allTests.empty)
         {
             writefln("%s: %d examples found", file.baseName, allTests.walkLength);
@@ -77,6 +137,15 @@ int main(string[] args)
     return hasFailed;
 }
 
+struct CompileConfig
+{
+    enum TestMode { run, compile, fail }
+    TestMode mode;
+    string[] args;
+    string expectedStdout;
+    string expectedStderr;
+}
+
 /**
 Executes source code with a D compiler (compile-only)
 
@@ -85,13 +154,29 @@ Params:
 
 Returns: the exit code of the compiler invocation.
 */
-auto compileAndCheck(R)(R buffer)
+auto compileAndCheck(R)(R buffer, CompileConfig config)
 {
     import std.process;
     import std.uni : isWhite;
 
-    auto pipes = pipeProcess([config.dmdBinPath, "-c", "-o-", "-"],
-            Redirect.stdin | Redirect.stdout | Redirect.stderr);
+    string[] args = [.config.dmdBinPath];
+    args ~= config.args;
+    with (CompileConfig.TestMode)
+    final switch (config.mode)
+    {
+        case run:
+            args ~= ["-run"];
+            break;
+        case compile:
+            args ~= ["-c", "-o-"];
+            break;
+        case fail:
+            args ~= ["-c", "-o-"];
+            break;
+    }
+    args ~= "-";
+
+    auto pipes = pipeProcess(args, Redirect.all);
 
     static mainRegex = regex(`(void|int)\s+main`);
     const hasMain = !buffer.matchFirst(mainRegex).empty;
@@ -107,15 +192,27 @@ auto compileAndCheck(R)(R buffer)
     pipes.stdin.write(buffer);
     pipes.stdin.close;
     auto ret = wait(pipes.pid);
-    if (ret != 0)
+    if (config.mode == CompileConfig.TestMode.fail)
+    {
+        if (ret == 0)
+        {
+            stderr.writefln("Compilation should have failed for:\n%s", buffer);
+            ret = 1;
+        }
+        else
+        {
+            ret = 0;
+        }
+    }
+    else if (ret != 0)
     {
-        stderr.writeln("--- ");
+        stderr.writeln("---");
         int lineNumber = 1;
         buffer
             .splitter("\n")
             .each!((a) {
                 const indent = hasMain ? "    " : "";
-                if (config.printLineNumbers)
+                if (.config.printLineNumbers)
                     stderr.writefln("%3d: %s%s", lineNumber++, indent, a);
                 else
                     stderr.writefln("%s%s", indent, a);
@@ -124,5 +221,23 @@ auto compileAndCheck(R)(R buffer)
         stderr.writeln("---");
         pipes.stderr.byLine.each!(e => stderr.writeln(e));
     }
+    // check stdout or stderr
+    static foreach (stream; ["stdout", "stderr"])
+    {{
+        import std.ascii : toUpper;
+        import std.conv : to;
+        mixin("auto expected = config.expected" ~ stream.front.toUpper.to!string ~ stream.dropOne~ ";");
+        if (expected)
+        {
+            mixin("auto stream = pipes." ~ stream ~ ";");
+            auto obs = appender!string;
+            stream.byChunk(4096).each!(c => obs.put(c));
+            scope(failure) {
+                stderr.writefln("Expected: %s", expected);
+                stderr.writefln("Observed: %s", obs.data);
+            }
+            assert(obs.data == expected);
+        }
+    }}
     return ret;
 }

ebook.ddoc

@@ -58,6 +58,9 @@ RUNNABLE_EXAMPLE=$0
 RUNNABLE_EXAMPLE_STDIN=
 RUNNABLE_EXAMPLE_ARGS=
 SPEC_RUNNABLE_EXAMPLE=$0
+SPEC_RUNNABLE_EXAMPLE_COMPILE=$0
+SPEC_RUNNABLE_EXAMPLE_RUN=$0
+SPEC_RUNNABLE_EXAMPLE_FAIL=$0
 SPEC_SUBNAV_NEXT=
 SPEC_SUBNAV_PREV_NEXT=
 SPEC_SUBNAV_PREV=

latex.ddoc

@@ -263,6 +263,9 @@ SHY=\-
 SINGLEQUOTE=`$0'
 SMALL=\small{$0}
 SPEC_RUNNABLE_EXAMPLE=$0
+SPEC_RUNNABLE_EXAMPLE_COMPILE=$0
+SPEC_RUNNABLE_EXAMPLE_RUN=$0
+SPEC_RUNNABLE_EXAMPLE_FAIL=$0
 SPEC_S=$(LAYOUT , $1, $(ARGS $+))
 SPEC_SUBNAV_NEXT=
 SPEC_SUBNAV_PREV=

posix.mak

@@ -145,6 +145,7 @@ include $(DMD_DIR)/src/osmodel.mak
 
 # External binaries
 DMD=$(DMD_DIR)/generated/$(OS)/release/$(MODEL)/dmd
+PHOBOS_LIB=$(PHOBOS_DIR)/generated/$(OS)/release/$(MODEL)/dmd/libphobos2.a
 
 # External directories
 DOC_OUTPUT_DIR:=$(PWD)/web
@@ -686,6 +687,9 @@ $W/phobos-prerelease/index.verbatim : verbatim.ddoc \
 	mv $W/phobos-prerelease-verbatim/* $(dir $@)
 	rm -r $W/phobos-prerelease-verbatim
 
+$(PHOBOS_LIB): $(DMD)
+	${MAKE} --directory=${PHOBOS_DIR} -f posix.mak lib
+
 ################################################################################
 # phobos and druntime, latest released build and current build (DDOX version)
 ################################################################################
@@ -861,10 +865,9 @@ $(PHOBOS_LATEST_FILES_GENERATED): $(PHOBOS_LATEST_DIR_GENERATED)/%: $(PHOBOS_LAT
 # Style tests
 ################################################################################
 
-test_dspec: dspec_tester.d $(STABLE_DMD)
-	# Temporarily allows failures, see https://github.com/dlang/dlang.org/pull/2006
+test_dspec: dspec_tester.d $(DMD) $(PHOBOS_LIB)
 	@echo "Test the D Language specification"
-	-DMD=$(DMD_LATEST) $(STABLE_RDMD) $<
+	$(DMD) -run $< --compiler=$(DMD)
 
 test: $(ASSERT_WRITELN_BIN)_test test_dspec test/next_version.sh all
 	@echo "Searching for trailing whitespace"