From db235e4ea9a1aa659d257c8d60dafa6a47846f7f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Mo=C5=84ko?= Date: Wed, 4 Jan 2023 16:30:37 +0100 Subject: [PATCH 1/3] Add Echo router extractor and method parser --- README.md | 3 ++ doc/parse/extract.go | 2 +- doc/parse/package.go | 6 ++++ go.mod | 1 + go.sum | 75 ++++++++++++++++++++++++++++++++++++++++++++ vars/echorouter.go | 26 +++++++++++++++ 6 files changed, 112 insertions(+), 1 deletion(-) create mode 100644 vars/echorouter.go diff --git a/README.md b/README.md index 5727a35..c42ae8a 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,9 @@ Generate documentation for your REST/HTTP API from your Go unit tests - a simple addition to Go's testing package. +This fork adds `MakeEchoRouterExtractor` to extract query params from labstack.Echo server +and includes method handlers in documentation. + ### Diving right in.. Given a handler func: diff --git a/doc/parse/extract.go b/doc/parse/extract.go index 9a738a1..59cea84 100644 --- a/doc/parse/extract.go +++ b/doc/parse/extract.go @@ -48,6 +48,6 @@ func IsFuncInPkg(longFnName string) bool { // longFnName of the form: // github.com/adams-sarah/test2doc/example.GetWidget func getShortFnName(longFnName string) string { - splitName := strings.Split(longFnName, ".") + splitName := strings.Split(strings.Replace(longFnName, ").", ")", -1), ".") return splitName[len(splitName)-1] } diff --git a/doc/parse/package.go b/doc/parse/package.go index 5fb4f54..156d549 100644 --- a/doc/parse/package.go +++ b/doc/parse/package.go @@ -33,6 +33,12 @@ func NewPackageDoc(dir string) (*doc.Package, error) { func setDocFuncsMap(pkgDoc *doc.Package) { funcsMap = make(map[string]*doc.Func, len(pkgDoc.Funcs)) + for _, tp := range pkgDoc.Types { + for _, fn := range tp.Methods { + fn.Doc = strings.Replace(fn.Doc, "\t", " ", -1) + funcsMap["("+fn.Recv+")"+fn.Name] = fn + } + } for _, fn := range pkgDoc.Funcs { // replace any \t character in comment with spaces // because apiary parser cannot handle tabs diff --git a/go.mod b/go.mod index 9e8e05f..22ae4e8 100644 --- a/go.mod +++ b/go.mod @@ -5,4 +5,5 @@ go 1.16 require ( github.com/gorilla/mux v1.8.0 github.com/julienschmidt/httprouter v1.3.0 + github.com/labstack/echo/v4 v4.10.0 ) diff --git a/go.sum b/go.sum index 0488809..ab5e82e 100644 --- a/go.sum +++ b/go.sum @@ -1,4 +1,79 @@ +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/golang-jwt/jwt v3.2.2+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzqecmYZeUEB8OUGHkxJ+I= github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI= github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So= github.com/julienschmidt/httprouter v1.3.0 h1:U0609e9tgbseu3rBINet9P48AI/D3oJs4dN7jwJOQ1U= github.com/julienschmidt/httprouter v1.3.0/go.mod h1:JR6WtHb+2LUe8TCKY3cZOxFyyO8IZAc4RVcycCCAKdM= +github.com/labstack/echo/v4 v4.10.0 h1:5CiyngihEO4HXsz3vVsJn7f8xAlWwRr3aY6Ih280ZKA= +github.com/labstack/echo/v4 v4.10.0/go.mod h1:S/T/5fy/GigaXnHTkh0ZGe4LpkkQysvRjFMSUTkDRNQ= +github.com/labstack/gommon v0.4.0 h1:y7cvthEAEbU0yHOf4axH8ZG2NH8knB9iNSoTO8dyIk8= +github.com/labstack/gommon v0.4.0/go.mod h1:uW6kP17uPlLJsD3ijUYn3/M5bAxtlZhMI6m3MFxTMTM= +github.com/mattn/go-colorable v0.1.11/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4= +github.com/mattn/go-colorable v0.1.13 h1:fFA4WZxdEF4tXPZVKMLwD8oUnCTTo08duU7wxecdEvA= +github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovkB8vQcUbaXHg= +github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= +github.com/mattn/go-isatty v0.0.16 h1:bq3VjFmv/sOjHtdEhmkEV4x1AJtvUvOJ2PFAZ5+peKQ= +github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk= +github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/valyala/bytebufferpool v1.0.0 h1:GqA5TC/0021Y/b9FG4Oi9Mr3q7XYx6KllzawFIhcdPw= +github.com/valyala/bytebufferpool v1.0.0/go.mod h1:6bBcMArwyJ5K/AmCkWv1jt77kVWyCJ6HpOuEn7z0Csc= +github.com/valyala/fasttemplate v1.2.1/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ= +github.com/valyala/fasttemplate v1.2.2 h1:lxLXG0uE3Qnshl9QyaK6XJxMXlQZELvChBOCmQD0Loo= +github.com/valyala/fasttemplate v1.2.2/go.mod h1:KHLXt3tVN2HBp8eijSv/kGJopbvo7S+qRAEEKiv+SiQ= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.2.0 h1:BRXPfhNivWL5Yq0BGQ39a2sW6t44aODpfxkWjYdzewE= +golang.org/x/crypto v0.2.0/go.mod h1:hebNnKkNXi2UzZN1eVRvBB7co0a+JxK6XbPiWVs/3J4= +golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.2.0/go.mod h1:KqCZLdyyvdV855qA2rE3GC2aiw5xGR5TEjj8smXukLY= +golang.org/x/net v0.4.0 h1:Q5QPcMlvfxFTAPV0+07Xz/MpK9NTXu2VDUuy0FeMfaU= +golang.org/x/net v0.4.0/go.mod h1:MBQ8lrhLObU/6UmLb4fmbmk5OcyYmqtbGd/9yIeKjEE= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20211103235746-7861aae1554b/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.3.0 h1:w8ZOecv6NaNa/zC8944JTU3vz4u6Lagfk4RPQxv92NQ= +golang.org/x/sys v0.3.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc= +golang.org/x/term v0.3.0/go.mod h1:q750SLmJuPmVoN1blW3UFBPREJfb1KmY3vwxfr+nFDA= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/text v0.5.0 h1:OLmvp0KP+FVG99Ct/qFiL/Fhk4zp4QQnZ7b2U+5piUM= +golang.org/x/text v0.5.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/time v0.2.0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/vars/echorouter.go b/vars/echorouter.go new file mode 100644 index 0000000..2ad240b --- /dev/null +++ b/vars/echorouter.go @@ -0,0 +1,26 @@ +package vars + +import ( + "github.com/labstack/echo/v4" + "github.com/s-mang/test2doc/doc/parse" + "net/http" +) + +// MakeEchoRouterExtractor is a URLVarExtractor for Echo server +func MakeEchoRouterExtractor(e *echo.Echo) parse.URLVarExtractor { + router := e.Router() + return func(req *http.Request) map[string]string { + out := make(map[string]string) + c := e.AcquireContext() + router.Find(req.Method, req.URL.Path, c) + params := c.QueryParams() + c.Reset(nil, nil) + e.ReleaseContext(c) + + for k, v := range params { + out[k] = v[0] + } + + return out + } +} From 6a7a04948594ef423a7c7f8f63e10f3c3c2fb698 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Mo=C5=84ko?= Date: Tue, 10 Jan 2023 12:09:10 +0100 Subject: [PATCH 2/3] Update Echo router extractor --- vars/echorouter.go | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/vars/echorouter.go b/vars/echorouter.go index 2ad240b..147d11b 100644 --- a/vars/echorouter.go +++ b/vars/echorouter.go @@ -4,19 +4,35 @@ import ( "github.com/labstack/echo/v4" "github.com/s-mang/test2doc/doc/parse" "net/http" + "sync" ) // MakeEchoRouterExtractor is a URLVarExtractor for Echo server func MakeEchoRouterExtractor(e *echo.Echo) parse.URLVarExtractor { router := e.Router() + mu := sync.Mutex{} + return func(req *http.Request) map[string]string { - out := make(map[string]string) + mu.Lock() + defer mu.Unlock() + if req == nil { + panic("missing request") + } + c := e.AcquireContext() + if c == nil { + panic("cannot AcquireContext") + } + router.Find(req.Method, req.URL.Path, c) + if c.Request() == nil { + c.SetRequest(req) + } params := c.QueryParams() c.Reset(nil, nil) e.ReleaseContext(c) + out := make(map[string]string) for k, v := range params { out[k] = v[0] } From 4a2702f7f9e6b53f8b436d347134cd567d9d2776 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Piotr=20Mo=C5=84ko?= Date: Tue, 14 Mar 2023 08:08:35 +0100 Subject: [PATCH 3/3] Add ResourceGroup description to output --- doc/doc.go | 15 +++++++++++++-- doc/group.go | 1 + doc/parse/extract.go | 7 +++++-- doc/resource.go | 4 +++- test/responsewriter.go | 1 + 5 files changed, 23 insertions(+), 5 deletions(-) diff --git a/doc/doc.go b/doc/doc.go index b0dcb46..18becdf 100644 --- a/doc/doc.go +++ b/doc/doc.go @@ -51,7 +51,8 @@ func NewDoc(pkgDir string) (doc *Doc, err error) { doc = &Doc{ Group: ResourceGroup{ - Title: strings.Title(pkgDoc.Name), + Title: strings.Title(pkgDoc.Name), + Description: pkgDocApib(pkgDoc.Doc), }, file: fi, } @@ -59,6 +60,15 @@ func NewDoc(pkgDir string) (doc *Doc, err error) { return } +// pkgDocApib removes all lines preceding `// apidoc:` marker, allowing for separation of apidoc from package doc. +func pkgDocApib(s string) string { + parts := strings.Split(s, "apidoc:\n") + if len(parts) != 2 { + return s + } + return parts[1] +} + type byResp []*Request func (rs byResp) Len() int { @@ -82,7 +92,8 @@ func (rs byResp) Less(i, j int) bool { } // TODO: add Resource to appropriate ResourceGroup, -// not just to ResourceGroups[0] +// +// not just to ResourceGroups[0] func (d *Doc) AddResource(resource *Resource) { // sort requests by response status code and body len for method, _ := range resource.Actions { diff --git a/doc/group.go b/doc/group.go index d71f30c..33bc7c3 100644 --- a/doc/group.go +++ b/doc/group.go @@ -6,6 +6,7 @@ var ( resourceGroupTmpl *template.Template resourceGroupFmt = ` # Group {{.Title}} +{{.Description}} {{range .Resources}} {{.Render}}{{end}}` ) diff --git a/doc/parse/extract.go b/doc/parse/extract.go index 59cea84..298af83 100644 --- a/doc/parse/extract.go +++ b/doc/parse/extract.go @@ -3,6 +3,7 @@ package parse import ( "regexp" "strings" + "unicode" ) const camelCase = "[A-Z]?[^A-Z]*" @@ -30,8 +31,10 @@ func GetDescription(longFnName string) (desc string) { shortFnName := getShortFnName(longFnName) doc := funcsMap[shortFnName] - if doc != nil { - desc = strings.TrimPrefix(doc.Doc, shortFnName+" ") + if doc != nil && len(doc.Doc) > 0 { + runes := []rune(strings.TrimPrefix(doc.Doc, doc.Name+" ")) + runes[0] = unicode.ToUpper(runes[0]) + desc = string(runes) } return diff --git a/doc/resource.go b/doc/resource.go index e67133f..085936f 100644 --- a/doc/resource.go +++ b/doc/resource.go @@ -5,7 +5,9 @@ import "text/template" var ( resourceTmpl *template.Template resourceFmt = `## {{.URL.ParameterizedPath}} -{{.Description}}{{if .URL.Parameters}} +{{.Description}} + +{{if .URL.Parameters}} + Parameters {{range .URL.Parameters}}{{.Render}} {{end}}{{end}}{{range .Actions}} diff --git a/test/responsewriter.go b/test/responsewriter.go index a5fe338..4b6ec2d 100644 --- a/test/responsewriter.go +++ b/test/responsewriter.go @@ -35,6 +35,7 @@ func (rw *ResponseWriter) Write(b []byte) (int, error) { } func (rw *ResponseWriter) WriteHeader(c int) { + rw.setHandlerInfo() rw.W.WriteHeader(c) }