gomock_generator. Add --source-path option #930
Conversation
|
Hi @EtienneM . The reason is that the local version of the codebase might not be in the default location. Prior to this change, a codebase such as Scalingo/go-utils would be located $GOPATH/src/github.com/Scalingo/swan-agent gomock_generator REQUIRES the codebase to be located in the default location. The --source-path option allows us to locate the codebase somewhere other than the default location. |
| // SourcePath override the output base path of the mocks | ||
| SourcePath string |
There was a problem hiding this comment.
issue: I'm not sure I understand the choice of words here for the variable name. It mentions Source but it seems to be the location of what this program outputs. What do you think about MocksPath or MocksRootPath?
There was a problem hiding this comment.
I'm not precious about the naming... but it is the location of your codebase. MocksRootPath works. I'll update it.
| mockSigsPath := path.Join(gcfg.SourcePath, mocksCfg.BaseDirectory, gcfg.SignaturesFilename) | ||
| if gcfg.SourcePath != "" { | ||
| mockSigsPath = path.Join(gcfg.SourcePath, gcfg.SignaturesFilename) | ||
| } |
There was a problem hiding this comment.
issue: from what I understand, it shouldn't be needed at this point to still have a condition. mocksPath contains the value we need.
| mockSigsPath := path.Join(gcfg.SourcePath, mocksCfg.BaseDirectory, gcfg.SignaturesFilename) | |
| if gcfg.SourcePath != "" { | |
| mockSigsPath = path.Join(gcfg.SourcePath, gcfg.SignaturesFilename) | |
| } | |
| mockSigsPath := path.Join(mocksPath, gcfg.SignaturesFilename) |
| @@ -67,7 +69,12 @@ func GenerateMocks(ctx context.Context, gcfg GenerationConfiguration, mocksCfg M | |||
| if mocksCfg.BaseDirectory == "" { | |||
| mocksCfg.BaseDirectory = mocksCfg.BasePackage | |||
| } | |||
| err = os.Chdir(path.Join(os.Getenv("GOPATH"), "src", mocksCfg.BaseDirectory)) | |||
|
|
|||
| mocksPath := path.Join(path.Join(os.Getenv("GOPATH"), "src"), mocksCfg.BaseDirectory) | |||
There was a problem hiding this comment.
issue: path.Join receives variadic arguments
| mocksPath := path.Join(path.Join(os.Getenv("GOPATH"), "src"), mocksCfg.BaseDirectory) | |
| mocksPath := path.Join(os.Getenv("GOPATH"), "src", mocksCfg.BaseDirectory) |
| mocksPath := path.Join(path.Join(os.Getenv("GOPATH"), "src"), mocksCfg.BaseDirectory) | ||
| if gcfg.SourcePath != "" { | ||
| mocksPath = gcfg.SourcePath | ||
| } |
There was a problem hiding this comment.
issue: IMO the check with the argument SourcePath should only be done once. The fact that you need to do the check over and over again is a sign that there is a lack of optimization somewhere. Doing this check here, at the beginning of the mocks generation is ok. Doing it multiple times makes me feel like something is wrong. Can you have a look to optimize this?
There was a problem hiding this comment.
I agree, I'll deal with this.
CHANGELOG.mdAdd a --source-path option that allows for the user to specify the location of their codebase.
e.g. gomocks_generator --source-path <path_to_codebase>