test(cmd): add check mode tests for embed (#110)

cmd/gomarkdoc/command_test.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"fmt"
 	"io"
+	"log"
 	"os"
 	"path/filepath"
 	"strings"
@@ -292,6 +293,49 @@ func TestCommand_embed(t *testing.T) {
 	verify(t, "./embed", "github")
 }
 
+func TestCommand_embed_check(t *testing.T) {
+	is := is.New(t)
+
+	err := os.Chdir(filepath.Join(wd, "../../testData"))
+	is.NoErr(err)
+
+	os.Args = []string{
+		"gomarkdoc", "./embed",
+		"--embed",
+		"--check",
+		"-o", "{{.Dir}}/README-github-invalid.md",
+		"--repository.url", "https://github.com/princjef/gomarkdoc",
+		"--repository.default-branch", "master",
+		"--repository.path", "/testData/",
+	}
+	cleanup(t, "embed")
+
+	log.SetFlags(0)
+
+	cmd := buildCommand()
+
+	err = cmd.Execute()
+	is.True(err != nil) // Should fail
+
+	os.Args = []string{
+		"gomarkdoc", "./embed",
+		"--embed",
+		"--check",
+		"-o", "{{.Dir}}/README-github.md",
+		"--repository.url", "https://github.com/princjef/gomarkdoc",
+		"--repository.default-branch", "master",
+		"--repository.path", "/testData/",
+	}
+	cleanup(t, "embed")
+
+	log.SetFlags(0)
+
+	cmd = buildCommand()
+
+	err = cmd.Execute()
+	is.NoErr(err) // Should pass
+}
+
 func TestCompare(t *testing.T) {
 	tests := []struct {
 		b1, b2 []byte

testData/embed/README-github-invalid.md

@@ -0,0 +1,100 @@
+This is content before the embed
+
+<!-- gomarkdoc:embed:start -->
+
+<!-- Code generated by gomarkdoc. DO NOT EDIT -->
+
+# embed
+
+```go
+import "github.com/princjef/gomarkdoc/testData/embed"
+```
+
+Package embed tests out embedding of documentation in an existing readme. This is an extra comment that is invalid.
+
+## Index
+
+- [func EmbeddedFunc\(param int\) int](<#EmbeddedFunc>)
+
+
+<a name="EmbeddedFunc"></a>
+## func [EmbeddedFunc](<https://github.com/princjef/gomarkdoc/blob/master/testData/embed/embed.go#L6>)
+
+```go
+func EmbeddedFunc(param int) int
+```
+
+EmbeddedFunc is present in embedded content.
+
+Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
+
+
+<!-- gomarkdoc:embed:end -->
+
+This is content after the embed
+
+<!-- gomarkdoc:embed:start -->
+
+<!-- Code generated by gomarkdoc. DO NOT EDIT -->
+
+# embed
+
+```go
+import "github.com/princjef/gomarkdoc/testData/embed"
+```
+
+Package embed tests out embedding of documentation in an existing readme.
+
+## Index
+
+- [func EmbeddedFunc\(param int\) int](<#EmbeddedFunc>)
+
+
+<a name="EmbeddedFunc"></a>
+## func [EmbeddedFunc](<https://github.com/princjef/gomarkdoc/blob/master/testData/embed/embed.go#L6>)
+
+```go
+func EmbeddedFunc(param int) int
+```
+
+EmbeddedFunc is present in embedded content.
+
+Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
+
+
+<!-- gomarkdoc:embed:end -->
+
+This is content after the second embed
+
+<!-- gomarkdoc:embed:start -->
+
+<!-- Code generated by gomarkdoc. DO NOT EDIT -->
+
+# embed
+
+```go
+import "github.com/princjef/gomarkdoc/testData/embed"
+```
+
+Package embed tests out embedding of documentation in an existing readme.
+
+## Index
+
+- [func EmbeddedFunc\(param int\) int](<#EmbeddedFunc>)
+
+
+<a name="EmbeddedFunc"></a>
+## func [EmbeddedFunc](<https://github.com/princjef/gomarkdoc/blob/master/testData/embed/embed.go#L6>)
+
+```go
+func EmbeddedFunc(param int) int
+```
+
+EmbeddedFunc is present in embedded content.
+
+Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
+
+
+<!-- gomarkdoc:embed:end -->
+
+This is content after the third embed