-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Improve performance when generating spec with external dependen…
…cies (#1108) * Imporve performance when generating spec with external dependencies * Fix code review comments * Add go1.18 test code
- Loading branch information
Showing
19 changed files
with
536 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
package swag | ||
|
||
import ( | ||
"bytes" | ||
"context" | ||
"encoding/json" | ||
"fmt" | ||
"go/build" | ||
"os/exec" | ||
"path/filepath" | ||
) | ||
|
||
func listPackages(ctx context.Context, dir string, env []string, args ...string) (pkgs []*build.Package, finalErr error) { | ||
cmd := exec.CommandContext(ctx, "go", append([]string{"list", "-json", "-e"}, args...)...) | ||
cmd.Env = env | ||
cmd.Dir = dir | ||
|
||
stdout, err := cmd.StdoutPipe() | ||
if err != nil { | ||
return nil, err | ||
} | ||
var stderrBuf bytes.Buffer | ||
cmd.Stderr = &stderrBuf | ||
defer func() { | ||
if stderrBuf.Len() > 0 { | ||
finalErr = fmt.Errorf("%v\n%s", finalErr, stderrBuf.Bytes()) | ||
} | ||
}() | ||
|
||
err = cmd.Start() | ||
if err != nil { | ||
return nil, err | ||
} | ||
dec := json.NewDecoder(stdout) | ||
for dec.More() { | ||
var pkg build.Package | ||
err = dec.Decode(&pkg) | ||
if err != nil { | ||
return nil, err | ||
} | ||
pkgs = append(pkgs, &pkg) | ||
} | ||
err = cmd.Wait() | ||
if err != nil { | ||
return nil, err | ||
} | ||
return pkgs, nil | ||
} | ||
|
||
func (parser *Parser) getAllGoFileInfoFromDepsByList(pkg *build.Package) error { | ||
ignoreInternal := pkg.Goroot && !parser.ParseInternal | ||
if ignoreInternal { // ignored internal | ||
return nil | ||
} | ||
|
||
srcDir := pkg.Dir | ||
var err error | ||
for i := range pkg.GoFiles { | ||
err = parser.parseFile(pkg.ImportPath, filepath.Join(srcDir, pkg.GoFiles[i]), nil) | ||
if err != nil { | ||
return err | ||
} | ||
} | ||
|
||
// parse .go source files that import "C" | ||
for i := range pkg.CgoFiles { | ||
err = parser.parseFile(pkg.ImportPath, filepath.Join(srcDir, pkg.CgoFiles[i]), nil) | ||
if err != nil { | ||
return err | ||
} | ||
} | ||
|
||
return nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
package swag | ||
|
||
import ( | ||
"context" | ||
"errors" | ||
"fmt" | ||
"go/build" | ||
"os" | ||
"path/filepath" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
) | ||
|
||
func TestListPackages(t *testing.T) { | ||
|
||
cases := []struct { | ||
name string | ||
args []string | ||
searchDir string | ||
except error | ||
}{ | ||
{ | ||
name: "errorArgs", | ||
args: []string{"-abc"}, | ||
searchDir: "testdata/golist", | ||
except: fmt.Errorf("exit status 2"), | ||
}, | ||
{ | ||
name: "normal", | ||
args: []string{"-deps"}, | ||
searchDir: "testdata/golist", | ||
except: nil, | ||
}, | ||
{ | ||
name: "list error", | ||
args: []string{"-deps"}, | ||
searchDir: "testdata/golist_not_exist", | ||
except: errors.New("searchDir not exist"), | ||
}, | ||
} | ||
|
||
for _, c := range cases { | ||
t.Run(c.name, func(t *testing.T) { | ||
_, err := listPackages(context.TODO(), c.searchDir, nil, c.args...) | ||
if c.except != nil { | ||
assert.NotNil(t, err) | ||
} else { | ||
assert.Nil(t, err) | ||
} | ||
}) | ||
} | ||
} | ||
|
||
func TestGetAllGoFileInfoFromDepsByList(t *testing.T) { | ||
p := New(ParseUsingGoList(true)) | ||
pwd, err := os.Getwd() | ||
assert.NoError(t, err) | ||
cases := []struct { | ||
name string | ||
buildPackage *build.Package | ||
ignoreInternal bool | ||
except error | ||
}{ | ||
{ | ||
name: "normal", | ||
buildPackage: &build.Package{ | ||
Name: "main", | ||
ImportPath: "github.com/swaggo/swag/testdata/golist", | ||
Dir: "testdata/golist", | ||
GoFiles: []string{"main.go"}, | ||
CgoFiles: []string{"api/api.go"}, | ||
}, | ||
except: nil, | ||
}, | ||
{ | ||
name: "ignore internal", | ||
buildPackage: &build.Package{ | ||
Goroot: true, | ||
}, | ||
ignoreInternal: true, | ||
except: nil, | ||
}, | ||
{ | ||
name: "gofiles error", | ||
buildPackage: &build.Package{ | ||
Dir: "testdata/golist_not_exist", | ||
GoFiles: []string{"main.go"}, | ||
}, | ||
except: errors.New("file not exist"), | ||
}, | ||
{ | ||
name: "cgofiles error", | ||
buildPackage: &build.Package{ | ||
Dir: "testdata/golist_not_exist", | ||
CgoFiles: []string{"main.go"}, | ||
}, | ||
except: errors.New("file not exist"), | ||
}, | ||
} | ||
|
||
for _, c := range cases { | ||
t.Run(c.name, func(t *testing.T) { | ||
if c.ignoreInternal { | ||
p.ParseInternal = false | ||
} | ||
c.buildPackage.Dir = filepath.Join(pwd, c.buildPackage.Dir) | ||
err := p.getAllGoFileInfoFromDepsByList(c.buildPackage) | ||
if c.except != nil { | ||
assert.NotNil(t, err) | ||
} else { | ||
assert.Nil(t, err) | ||
} | ||
}) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.