Move test utilities to testutil/

This moves the following functions meant for use from tests into a testutil subpackage. func DoTestCase(m Markdown, testCase MarkdownTestCase, t TestingT) func DoTestCaseFile(m Markdown, filename string, t TestingT) func DoTestCases(m goldmark.Markdown, cases []MarkdownTestCase, t TestingT) This will help keep the top-level goldmark package clean and limited to core functionality. (Note that tests in the top-level goldmark package that make use of these functions must now use the package name `goldmark_test` so that they're considered separate from the main `goldmark` package, otherwise you'll see an import cycle: goldmark imports testutil imports goldmark.)
yuin · Aug 25, 2019 · 8c55e6f · 8c55e6f
1 parent f98eb98
commit 8c55e6f
Show file tree

Hide file tree

Showing 12 changed files with 50 additions and 28 deletions.
diff --git a/commonmark_test.go b/commonmark_test.go
@@ -1,10 +1,12 @@
-package goldmark
+package goldmark_test
 
 import (
 	"encoding/json"
 	"io/ioutil"
 	"testing"
 
+	. "github.com/yuin/goldmark"
+	"github.com/yuin/goldmark/testutil"
 	"github.com/yuin/goldmark/renderer/html"
 )
 
@@ -26,9 +28,9 @@ func TestSpec(t *testing.T) {
 	if err := json.Unmarshal(bs, &testCases); err != nil {
 		panic(err)
 	}
-	cases := []MarkdownTestCase{}
+	cases := []testutil.MarkdownTestCase{}
 	for _, c := range testCases {
-		cases = append(cases, MarkdownTestCase{
+		cases = append(cases, testutil.MarkdownTestCase{
 			No:       c.Example,
 			Markdown: c.Markdown,
 			Expected: c.HTML,
@@ -38,5 +40,5 @@ func TestSpec(t *testing.T) {
 		html.WithXHTML(),
 		html.WithUnsafe(),
 	))
-	DoTestCases(markdown, cases, t)
+	testutil.DoTestCases(markdown, cases, t)
 }
diff --git a/extension/definition_list_test.go b/extension/definition_list_test.go
@@ -1,9 +1,11 @@
 package extension
 
 import (
+	"testing"
+
 	"github.com/yuin/goldmark"
+	"github.com/yuin/goldmark/testutil"
 	"github.com/yuin/goldmark/renderer/html"
-	"testing"
 )
 
 func TestDefinitionList(t *testing.T) {
@@ -15,5 +17,5 @@ func TestDefinitionList(t *testing.T) {
 			DefinitionList,
 		),
 	)
-	goldmark.DoTestCaseFile(markdown, "_test/definition_list.txt", t)
+	testutil.DoTestCaseFile(markdown, "_test/definition_list.txt", t)
 }
diff --git a/extension/footnote_test.go b/extension/footnote_test.go
@@ -1,9 +1,11 @@
 package extension
 
 import (
+	"testing"
+
 	"github.com/yuin/goldmark"
+	"github.com/yuin/goldmark/testutil"
 	"github.com/yuin/goldmark/renderer/html"
-	"testing"
 )
 
 func TestFootnote(t *testing.T) {
@@ -15,5 +17,5 @@ func TestFootnote(t *testing.T) {
 			Footnote,
 		),
 	)
-	goldmark.DoTestCaseFile(markdown, "_test/footnote.txt", t)
+	testutil.DoTestCaseFile(markdown, "_test/footnote.txt", t)
 }
diff --git a/extension/linkify_test.go b/extension/linkify_test.go
@@ -1,9 +1,11 @@
 package extension
 
 import (
+	"testing"
+
 	"github.com/yuin/goldmark"
+	"github.com/yuin/goldmark/testutil"
 	"github.com/yuin/goldmark/renderer/html"
-	"testing"
 )
 
 func TestLinkify(t *testing.T) {
@@ -15,5 +17,5 @@ func TestLinkify(t *testing.T) {
 			Linkify,
 		),
 	)
-	goldmark.DoTestCaseFile(markdown, "_test/linkify.txt", t)
+	testutil.DoTestCaseFile(markdown, "_test/linkify.txt", t)
 }
diff --git a/extension/strikethrough_test.go b/extension/strikethrough_test.go
@@ -1,9 +1,11 @@
 package extension
 
 import (
+	"testing"
+
 	"github.com/yuin/goldmark"
+	"github.com/yuin/goldmark/testutil"
 	"github.com/yuin/goldmark/renderer/html"
-	"testing"
 )
 
 func TestStrikethrough(t *testing.T) {
@@ -15,5 +17,5 @@ func TestStrikethrough(t *testing.T) {
 			Strikethrough,
 		),
 	)
-	goldmark.DoTestCaseFile(markdown, "_test/strikethrough.txt", t)
+	testutil.DoTestCaseFile(markdown, "_test/strikethrough.txt", t)
 }
diff --git a/extension/table_test.go b/extension/table_test.go
@@ -1,9 +1,11 @@
 package extension
 
 import (
+	"testing"
+
 	"github.com/yuin/goldmark"
+	"github.com/yuin/goldmark/testutil"
 	"github.com/yuin/goldmark/renderer/html"
-	"testing"
 )
 
 func TestTable(t *testing.T) {
@@ -15,5 +17,5 @@ func TestTable(t *testing.T) {
 			Table,
 		),
 	)
-	goldmark.DoTestCaseFile(markdown, "_test/table.txt", t)
+	testutil.DoTestCaseFile(markdown, "_test/table.txt", t)
 }
diff --git a/extension/tasklist_test.go b/extension/tasklist_test.go
@@ -1,9 +1,11 @@
 package extension
 
 import (
+	"testing"
+
 	"github.com/yuin/goldmark"
+	"github.com/yuin/goldmark/testutil"
 	"github.com/yuin/goldmark/renderer/html"
-	"testing"
 )
 
 func TestTaskList(t *testing.T) {
@@ -15,5 +17,5 @@ func TestTaskList(t *testing.T) {
 			TaskList,
 		),
 	)
-	goldmark.DoTestCaseFile(markdown, "_test/tasklist.txt", t)
+	testutil.DoTestCaseFile(markdown, "_test/tasklist.txt", t)
 }
diff --git a/extension/typographer_test.go b/extension/typographer_test.go
@@ -1,9 +1,11 @@
 package extension
 
 import (
+	"testing"
+
 	"github.com/yuin/goldmark"
+	"github.com/yuin/goldmark/testutil"
 	"github.com/yuin/goldmark/renderer/html"
-	"testing"
 )
 
 func TestTypographer(t *testing.T) {
@@ -15,5 +17,5 @@ func TestTypographer(t *testing.T) {
 			Typographer,
 		),
 	)
-	goldmark.DoTestCaseFile(markdown, "_test/typographer.txt", t)
+	testutil.DoTestCaseFile(markdown, "_test/typographer.txt", t)
 }
diff --git a/extra_test.go b/extra_test.go
@@ -1,8 +1,10 @@
-package goldmark
+package goldmark_test
 
 import (
 	"testing"
 
+	. "github.com/yuin/goldmark"
+	"github.com/yuin/goldmark/testutil"
 	"github.com/yuin/goldmark/renderer/html"
 )
 
@@ -11,5 +13,5 @@ func TestDefinitionList(t *testing.T) {
 		html.WithXHTML(),
 		html.WithUnsafe(),
 	))
-	DoTestCaseFile(markdown, "_test/extra.txt", t)
+	testutil.DoTestCaseFile(markdown, "_test/extra.txt", t)
 }
diff --git a/options_test.go b/options_test.go
@@ -1,8 +1,11 @@
-package goldmark
+package goldmark_test
 
 import (
-	"github.com/yuin/goldmark/parser"
 	"testing"
+
+	. "github.com/yuin/goldmark"
+	"github.com/yuin/goldmark/testutil"
+	"github.com/yuin/goldmark/parser"
 )
 
 func TestAttributeAndAutoHeadingID(t *testing.T) {
@@ -12,5 +15,5 @@ func TestAttributeAndAutoHeadingID(t *testing.T) {
 			parser.WithAutoHeadingID(),
 		),
 	)
-	DoTestCaseFile(markdown, "_test/options.txt", t)
+	testutil.DoTestCaseFile(markdown, "_test/options.txt", t)
 }
diff --git a/testutil.go → testutil/testutil.go b/testutil.go → testutil/testutil.go
@@ -1,4 +1,4 @@
-package goldmark
+package testutil
 
 import (
 	"bufio"
@@ -9,6 +9,7 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/yuin/goldmark"
 	"github.com/yuin/goldmark/util"
 )
 
@@ -29,7 +30,7 @@ type MarkdownTestCase struct {
 const attributeSeparator = "//- - - - - - - - -//"
 const caseSeparator = "//= = = = = = = = = = = = = = = = = = = = = = = =//"
 
-func DoTestCaseFile(m Markdown, filename string, t TestingT) {
+func DoTestCaseFile(m goldmark.Markdown, filename string, t TestingT) {
 	fp, err := os.Open(filename)
 	if err != nil {
 		panic(err)
@@ -85,13 +86,13 @@ func DoTestCaseFile(m Markdown, filename string, t TestingT) {
 	DoTestCases(m, cases, t)
 }
 
-func DoTestCases(m Markdown, cases []MarkdownTestCase, t TestingT) {
+func DoTestCases(m goldmark.Markdown, cases []MarkdownTestCase, t TestingT) {
 	for _, testCase := range cases {
 		DoTestCase(m, testCase, t)
 	}
 }
 
-func DoTestCase(m Markdown, testCase MarkdownTestCase, t TestingT) {
+func DoTestCase(m goldmark.Markdown, testCase MarkdownTestCase, t TestingT) {
 	var ok bool
 	var out bytes.Buffer
 	defer func() {

diff --git a/testutil_test.go → testutil/testutil_test.go b/testutil_test.go → testutil/testutil_test.go
@@ -1,4 +1,4 @@
-package goldmark
+package testutil
 
 import "testing"