Merge pull request 99designs#780 from zdebra/master

fixed generating a description to golang comments for enum type
cgxxv · Jul 8, 2019 · 9019ee3 · 9019ee3
2 parents 1c5824d + 3d7a113
commit 9019ee3
Show file tree

Hide file tree

Showing 4 changed files with 95 additions and 1 deletion.
diff --git a/plugin/modelgen/models.gotpl b/plugin/modelgen/models.gotpl
@@ -36,7 +36,7 @@
 {{- end}}
 
 {{ range $enum := .Enums }}
-	{{ with .Description|go }} {{.|prefixLines "// "}} {{end}}
+	{{ with .Description }} {{.|prefixLines "// "}} {{end}}
 	type {{.Name|go }} string
 	const (
 	{{- range $value := .Values}}

diff --git a/plugin/modelgen/models_test.go b/plugin/modelgen/models_test.go
@@ -1,7 +1,10 @@
 package modelgen
 
 import (
+	"go/parser"
+	"go/token"
 	"io/ioutil"
+	"strings"
 	"testing"
 
 	"github.com/99designs/gqlgen/codegen/config"
@@ -19,10 +22,24 @@ func TestModelGeneration(t *testing.T) {
 	require.True(t, cfg.Models.UserDefined("MissingEnum"))
 	require.True(t, cfg.Models.UserDefined("MissingUnion"))
 	require.True(t, cfg.Models.UserDefined("MissingInterface"))
+	require.True(t, cfg.Models.UserDefined("TypeWithDescription"))
+	require.True(t, cfg.Models.UserDefined("EnumWithDescription"))
+	require.True(t, cfg.Models.UserDefined("InterfaceWithDescription"))
+	require.True(t, cfg.Models.UserDefined("UnionWithDescription"))
 
 	t.Run("no pointer pointers", func(t *testing.T) {
 		generated, err := ioutil.ReadFile("./out/generated.go")
 		require.NoError(t, err)
 		require.NotContains(t, string(generated), "**")
 	})
+
+	t.Run("description is generated", func(t *testing.T) {
+		node, err := parser.ParseFile(token.NewFileSet(), "./out/generated.go", nil, parser.ParseComments)
+		require.NoError(t, err)
+		for _, commentGroup := range node.Comments {
+			text := commentGroup.Text()
+			words := strings.Split(text, " ")
+			require.True(t, len(words) > 1, "expected description %q to have more than one word", text)
+		}
+	})
 }
diff --git a/plugin/modelgen/out/generated.go b/plugin/modelgen/out/generated.go
diff --git a/plugin/modelgen/testdata/schema.graphql b/plugin/modelgen/testdata/schema.graphql
@@ -65,3 +65,21 @@ interface ExistingInterface {
 
 union ExistingUnion = MissingTypeNotNull | MissingTypeNullable  | ExistingType
 
+"TypeWithDescription is a type with a description"
+type TypeWithDescription {
+    name: String
+}
+
+"EnumWithDescription is an enum with a description"
+enum EnumWithDescription {
+    CAT
+    DOG
+}
+
+"InterfaceWithDescription is an interface with a description"
+interface InterfaceWithDescription {
+    name: String
+}
+
+"UnionWithDescription is an union with a description"
+union UnionWithDescription = TypeWithDescription | ExistingType