refactor: enhance error handle (#206)

* refactor: enhance error handle

* add missing return

* use pkg error lib instead of standard error

* fix test

gen/gen.go

@@ -2,6 +2,9 @@ package gen
 
 import (
  "encoding/json"
+
+ "github.com/pkg/errors"
+
  "log"
  "os"
  "path"
@@ -29,33 +32,49 @@ func (g *Gen) Build(searchDir, mainAPIFile, swaggerConfDir, propNamingStrategy s
  p.ParseAPI(searchDir, mainAPIFile)
  swagger := p.GetSwagger()
 
- b, _ := json.MarshalIndent(swagger, "", " ")
+ b, err := json.MarshalIndent(swagger, "", " ")
+ if err != nil {
+ return err
+ }
 
  os.MkdirAll(path.Join(searchDir, "docs"), os.ModePerm)
- docs, _ := os.Create(path.Join(searchDir, "docs", "docs.go"))
+ docs, err := os.Create(path.Join(searchDir, "docs", "docs.go"))
+ if err != nil {
+ return err
+ }
  defer docs.Close()
 
  os.Mkdir(swaggerConfDir, os.ModePerm)
- swaggerJSON, _ := os.Create(path.Join(swaggerConfDir, "swagger.json"))
+ swaggerJSON, err := os.Create(path.Join(swaggerConfDir, "swagger.json"))
+ if err != nil {
+ return err
+ }
+
  defer swaggerJSON.Close()
  swaggerJSON.Write(b)
 
- swaggerYAML, _ := os.Create(path.Join(swaggerConfDir, "swagger.yaml"))
+ swaggerYAML, err := os.Create(path.Join(swaggerConfDir, "swagger.yaml"))
+ if err != nil {
+ return err
+ }
+
  defer swaggerYAML.Close()
  y, err := yaml.JSONToYAML(b)
  if err != nil {
- //TODO: using return error instead of panic
- log.Fatalf("can't swagger json covert to yaml err: %s", err)
+ return errors.Wrap(err, "cannot covert json to yaml")
  }
+
  swaggerYAML.Write(y)
 
- packageTemplate.Execute(docs, struct {
+ if err := packageTemplate.Execute(docs, struct {
  Timestamp time.Time
  Doc string
  }{
  Timestamp: time.Now(),
  Doc: "`" + string(b) + "`",
- })
+ }); err != nil {
+ return err
+ }
 
  log.Printf("create docs.go at %+v", docs.Name())
  return nil

parser.go

@@ -1,6 +1,8 @@
 package swag
 
 import (
+ "github.com/pkg/errors"
+
  "fmt"
  "go/ast"
  goparser "go/parser"
@@ -76,9 +78,11 @@ func New() *Parser {
 }
 
 // ParseAPI parses general api info for gived searchDir and mainAPIFile
-func (parser *Parser) ParseAPI(searchDir string, mainAPIFile string) {
+func (parser *Parser) ParseAPI(searchDir string, mainAPIFile string) error {
  log.Println("Generate general API Info")
- parser.getAllGoFileInfo(searchDir)
+ if err := parser.getAllGoFileInfo(searchDir); err != nil {
+ return err
+ }
  parser.ParseGeneralAPIInfo(path.Join(searchDir, mainAPIFile))
 
  for _, astFile := range parser.files {
@@ -90,15 +94,16 @@ func (parser *Parser) ParseAPI(searchDir string, mainAPIFile string) {
  }
 
  parser.ParseDefinitions()
+
+ return nil
 }
 
 // ParseGeneralAPIInfo parses general api info for gived mainAPIFile path
-func (parser *Parser) ParseGeneralAPIInfo(mainAPIFile string) {
+func (parser *Parser) ParseGeneralAPIInfo(mainAPIFile string) error {
  fileSet := token.NewFileSet()
  fileTree, err := goparser.ParseFile(fileSet, mainAPIFile, nil, goparser.ParseComments)
-
  if err != nil {
- log.Panicf("ParseGeneralApiInfo occur error:%+v", err)
+ return errors.Wrap(err, "cannot parse soure files")
  }
 
  parser.swagger.Swagger = "2.0"
@@ -257,6 +262,8 @@ func (parser *Parser) ParseGeneralAPIInfo(mainAPIFile string) {
  if len(securityMap) > 0 {
  parser.swagger.SecurityDefinitions = securityMap
  }
+
+ return nil
 }
 
 func getScopeScheme(scope string) string {
@@ -728,8 +735,8 @@ func defineTypeOfExample(schemaType string, exampleValue string) interface{} {
 }
 
 // GetAllGoFileInfo gets all Go source files information for given searchDir.
-func (parser *Parser) getAllGoFileInfo(searchDir string) {
- filepath.Walk(searchDir, parser.visit)
+func (parser *Parser) getAllGoFileInfo(searchDir string) error {
+ return filepath.Walk(searchDir, parser.visit)
 }
 
 func (parser *Parser) visit(path string, f os.FileInfo, err error) error {

parser_test.go

@@ -97,9 +97,7 @@ func TestParser_ParseGeneralApiInfoFailed(t *testing.T) {
  gopath := os.Getenv("GOPATH")
  assert.NotNil(t, gopath)
  p := New()
- assert.Panics(t, func() {
- p.ParseGeneralAPIInfo("testdata/noexist.go")
- })
+ assert.Error(t, p.ParseGeneralAPIInfo("testdata/noexist.go"))
 }
 
 func TestGetAllGoFileInfo(t *testing.T) {