Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: define imported package's local name by using flags #41

Merged
merged 16 commits into from
Aug 7, 2023
Merged

fix: define imported package's local name by using flags #41

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
891fb47
style: change import flags location
Jul 9, 2023
b1942a0
fix: fixing for define imported package's local name with flag problem
Jul 9, 2023
edfd5fb
test: adding test for defining imported package's local name with flag
Jul 9, 2023
3fa9ecd
Merge branch 'main' into main
ErfanMomeniii Jul 12, 2023
e14f5b1
style: change import flags location
ErfanMomeniii Jul 9, 2023
2cf432d
fix: fixing for define imported package's local name with flag problem
ErfanMomeniii Jul 9, 2023
d9bb889
test: adding test for defining imported package's local name with flag
ErfanMomeniii Jul 9, 2023
fe571d5
support embedded generic interfaces (#13)
tra4less Jul 11, 2023
4c28988
Add -write_source_comment flag to toggle whether to emit source file/…
utgwkk Jul 11, 2023
85bc09b
fix: sync with last change
Jul 13, 2023
4d17cbf
fix: sync with last change
ErfanMomeniii Jul 13, 2023
6c2abe5
Merge branch 'main' of https://github.com/ErfanMomeniii/mock
Jul 13, 2023
15ee942
fix: define imported package's local name by using flags
ErfanMomeniii Jul 15, 2023
f7c4941
test: update
ErfanMomeniii Aug 2, 2023
89cfe47
test: update
ErfanMomeniii Aug 2, 2023
3c30488
Update mockgen/mockgen.go
sywhang Aug 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions mockgen/internal/tests/defined_import_local_name/input.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
package defined_import_local_name

import (
"bytes"
"context"
)

//go:generate mockgen -package defined_import_local_name -destination mock.go -source input.go -imports b_mock=bytes,c_mock=context

type WithDotImports interface {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we add an additional package to test for stdlib and external imports?

Suggestion: Update the method names to reflect which scenario being tested.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is DotImports referring to? In the spec I see three cases

Import declaration          Local name of Sin

import   "lib/math"         math.Sin
import m "lib/math"         m.Sin
import . "lib/math"         Sin

As a reviewer, the DotImport name makes me think this is that last case in the list, but this test seems to be testing named imports (case 2).

Method1() bytes.Buffer
Method2() context.Context
}
64 changes: 64 additions & 0 deletions mockgen/internal/tests/defined_import_local_name/mock.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 19 additions & 1 deletion mockgen/mockgen.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ var (
writeSourceComment = flag.Bool("write_source_comment", true, "Writes original file (source mode) or interface names (reflect mode) comment if true.")
copyrightFile = flag.String("copyright_file", "", "Copyright file used to add copyright header")
typed = flag.Bool("typed", false, "Generate Type-safe 'Return', 'Do', 'DoAndReturn' function")
imports = flag.String("imports", "", "(source mode) Comma-separated name=path pairs of explicit imports to use.")
auxFiles = flag.String("aux_files", "", "(source mode) Comma-separated pkg=path pairs of auxiliary Go source files.")

debugParser = flag.Bool("debug_parser", false, "Print out parser results only.")
showVersion = flag.Bool("version", false, "Print version.")
Expand Down Expand Up @@ -319,6 +321,17 @@ func (g *generator) Generate(pkg *model.Package, outputPkgName string, outputPac

packagesName := createPackageMap(sortedPaths)

definedImports := make(map[string]string, len(im))
if *imports != "" {
for _, kv := range strings.Split(*imports, ",") {
eq := strings.Index(kv, "=")
k, v := kv[:eq], kv[eq+1:]
if k != "." {
sywhang marked this conversation as resolved.
Show resolved Hide resolved
definedImports[v] = k
}
}
}

g.packageMap = make(map[string]string, len(im))
localNames := make(map[string]bool, len(im))
for _, pth := range sortedPaths {
Expand All @@ -330,9 +343,14 @@ func (g *generator) Generate(pkg *model.Package, outputPkgName string, outputPac
// Local names for an imported package can usually be the basename of the import path.
// A couple of situations don't permit that, such as duplicate local names
// (e.g. importing "html/template" and "text/template"), or where the basename is
// a keyword (e.g. "foo/case").
// a keyword (e.g. "foo/case") or when defining a name for that by using the -imports flag.
// try base0, base1, ...
pkgName := base

if _, ok := definedImports[base]; ok {
pkgName = definedImports[base]
}

i := 0
for localNames[pkgName] || token.Lookup(pkgName).IsKeyword() {
pkgName = base + strconv.Itoa(i)
Expand Down
6 changes: 0 additions & 6 deletions mockgen/parse.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ package main

import (
"errors"
"flag"
"fmt"
"go/ast"
"go/build"
Expand All @@ -36,11 +35,6 @@ import (
"go.uber.org/mock/mockgen/model"
)

var (
imports = flag.String("imports", "", "(source mode) Comma-separated name=path pairs of explicit imports to use.")
auxFiles = flag.String("aux_files", "", "(source mode) Comma-separated pkg=path pairs of auxiliary Go source files.")
)

// sourceMode generates mocks via source file.
func sourceMode(source string) (*model.Package, error) {
srcDir, err := filepath.Abs(filepath.Dir(source))
Expand Down