Merge pull request #31 from fjl/test-comments

add test description and speconly flag as comments

ethclient.go

@@ -7,6 +7,7 @@ import (
 	"io"
 	"net/http"
 	"os"
+	"strings"
 
 	"github.com/ethereum/go-ethereum/rpc"
 )
@@ -49,6 +50,14 @@ func (l *ethclientHandler) RotateLog(filename string) error {
 	return nil
 }
 
+// WriteComment adds the given text as a comment to the current log file.
+func (l *ethclientHandler) WriteComment(text string) error {
+	text = strings.TrimSpace(text)
+	text = "// " + strings.Replace(text, "\n", "\n// ", -1) + "\n"
+	_, err := io.WriteString(l.logFile, text)
+	return err
+}
+
 func (l *ethclientHandler) Close() {
 	if l.logFile != nil {
 		l.logFile.Close()

generate.go

@@ -68,6 +68,15 @@ func runGenerator(ctx context.Context) error {
 
 			// Write the exchange for each test in a separte file.
 			handler.RotateLog(filename)
+			if test.About != "" {
+				handler.WriteComment(test.About)
+			}
+			if test.SpecOnly {
+				if test.About != "" {
+					handler.WriteComment("")
+				}
+				handler.WriteComment("speconly: client response is only checked for schema validity.")
+			}
 
 			// Fail test fill if request exceeds timeout.
 			ctx, cancel := context.WithTimeout(ctx, 3*time.Second)