sanposhiho / gomockhandler Goto Github PK

from #59

Let's move source_checksum and checksum from gomockhandler.json to new 'mocks status file'.

with this

• we can make configuration file more readable
• we can allow user to edit configuration file directly

Let's eliminate the need to install mockgen.

We currently require users to install it. But, unexpected behaviors may occur due to differences in mockgen behavior depending on which mockgen the user has installed.
Ideally, we should generate mocks without using user-installed mockgen and we can achieve that if we can import mockgen.

But currently, almost all logic of mockgen cannot be imported, because it is placed in main package.
So, I propose to fork golang/mock, add changes to make it importable, and use the fork to import mockgen.

And, I raised the issue for golang/mock.
golang/mock#609

It would be nice to be able to filter in more detail using regular expressions, etc.

to detect deletion of the original interface.

In Source mode, skip generation if the source file is not changed.

-f flag will not skip the generation of mocks.

how to check in github action

Now, when not uptodate, it only print.

Now, we support source mode only.

SSIA.

Target version: v1.0

We cannot call mockgen directly because it is private entry point.
https://github.com/golang/mock/blob/master/mockgen/mockgen.go#L68

But, I think we can make it with gitsubmodule, maybe, maybe... Let's try it.

Let GOMAXPROCS be the upper limit of concurrency.

In order to add new mock to be generated easily, we want to convert mockgen command to gomockhandler config format.

Currently, do only manual test on playground.
We don't have any tests now...

Currently, if no option is specified, the default argument is written in config.
Unnecessary information in config file will increase and make it difficult to read.

Automatic mock updates in user's devices.

To make it easier to read json.
(In the future, it will not be necessary for users to look at the json directly.)

Now, we support configuration gomockhandler.json.

And to add new mock on config, users have to execute cmd like this, and config for new mock will be added on gomockhandler.json.
gomockhandler -config=/path/to/gomockhandler.json -source=foo.go -destination=./mock/ [other mockgen options]

But, PR reviewers cannot see what command will be registered, and it makes PR review a little hard.

So, I want to add new optional configuration file or add information on config file to resolve this.

Currently, if you want to delete the mock, you have to modify the config manually...

Version

• go.uber.org/mock/[email protected]
• github.com/sanposhiho/[email protected]

Actual behavior

Despite the mock being up to date, the gomockhandler -config=./gomockhandler.json check command reports a different checksum value, leading to the determination that it is not the latest version.

[ERROR] mock is not up to date. destination: usecases/mock/xxx.go

Expected behavior

gomockhandler -config=./gomockhandler.json check command works correctly.

Why this issue occurred

uber-go/mock@2c718f2 was merged and is affecting gomockhandler, causing the check command to not work correctly.

Detail

The checksum values differ because the file paths for the destination specified in the comments within code A and code B are different.

code A : generated code by go.uber.org/mock/mockgen

// Code generated by MockGen. DO NOT EDIT.
// Source: github.com/org/repo/api/usecases (interfaces: xxx)
//
// Generated by this command:
//
//      mockgen -destination=usecases/mock/xxx.go -package=usecases_mock github.com/org/repo/api/usecases xxx
//

code B : tmp file code to calculate checksum in this line

// Code generated by MockGen. DO NOT EDIT.
// Source: github.com/org/repo/api/usecases (interfaces: xxx)
//
// Generated by this command:
//
//      mockgen -destination=usecases/mock/tmp_xxx.go -package=usecases_mock github.com/org/repo/api/usecases xxx
//

Currently if we do gomockhandler mockgen order of content randomly changed, although there is no changes.
For Example:

// before
{
	"mocks": {
		"a_mock.go": {
			"checksum": "xxxxxxxxxxx",
			"source_checksum": "aaaaaaaaaaaaa",
			"mode": "SOURCE_MODE",
			"source_mode_runner": {
				"source": "a.go",
				"destination": "a_mock.go",
				"package": "main"
			}
		},
		"b_mock.go": {
			"checksum": "yyyyyyyyyyyy",
			"source_checksum": "bbbbbbbbbbb",
			"mode": "SOURCE_MODE",
			"source_mode_runner": {
				"source": "b.go",
				"destination": "b_mock.go",
				"package": "main"
			}
		}
}
// after
{
	"mocks": {
		"b_mock.go": {
			"checksum": "yyyyyyyyyyyy",
			"source_checksum": "bbbbbbbbbbb",
			"mode": "SOURCE_MODE",
			"source_mode_runner": {
				"source": "b.go",
				"destination": "b_mock.go",
				"package": "main"
			}
		},
		"a_mock.go": {
			"checksum": "xxxxxxxxxxx",
			"source_checksum": "aaaaaaaaaaaaa",
			"mode": "SOURCE_MODE",
			"source_mode_runner": {
				"source": "a.go",
				"destination": "a_mock.go",
				"package": "main"
			}
		}
}

This behavior becomes some noise when we manage config file by git.
I recommend those contents to be dictionary order to avoid this problem.

I think the part below leads this phenomenon.

Thank you.

like

You SHOULD delete the mock with following command.
rm /path/to/deleted-mockfile

To better performance.

Being able to specify paths ignored by gomockhandler could be useful.

For example, one of my projects has a vendor folder where code from an external repository is being stored. In that folder, there are mock files. Those are not managed by gomockhandler and therefore, gomockhandler check complains about it. Given that those files come from outside of my project, I don't think having gomockhandler managing them would be a good idea.

Only mocks under specified path will be targeted for commands check and mockgen.

find mocks un-managed by gomockhandler.
IMO, this feature should be implemented in gomockhandler check to keep gomockhandler simple.

• mockshow command to check the definition of mock from the CLI?
• make another file?
• make config more readable?

manage all mocks in one config file.

absolute path only now

To generate mocks more fastly on source mode.