feat(bazel): mock_names flag support in archive mode (#262)

Hi! In #259 was introduced archive mode for bazel rule, but no support
for mock_names.
This PR added `mock_names` attr to `_gomock_archive` rule.

Author: MrDan4es

bazel/rules/gomock.bzl

@@ -177,15 +177,15 @@ _gomock_source = rule(
 def gomock(name, out, library = None, source_importpath = "", source = None, interfaces = [], package = "", self_package = "", aux_files = {}, mockgen_tool = _MOCKGEN_TOOL, mockgen_args = [], imports = {}, copyright_file = None, mock_names = {}, **kwargs):
     """Calls [mockgen](https://github.com/golang/mock) to generates a Go file containing mocks from the given library.
 
-    If `source` is given, the mocks are generated in source mode; otherwise in reflective mode.
+    If `source` is given, the mocks are generated in source mode; otherwise in archive mode.
 
     Args:
         name: the target name.
         out: the output Go file name.
-        library: the Go library to look into for the interfaces (reflective mode) or source (source mode). If running in source mode, you can specify source_importpath instead of this parameter.
+        library: the Go library to look into for the interfaces (archive mode) or source (source mode). If running in source mode, you can specify source_importpath instead of this parameter.
         source_importpath: the importpath for the source file. Alternative to passing library, which can lead to circular dependencies between mock and library targets. Only valid for source mode.
         source: a Go file in the given `library`. If this is given, `gomock` will call mockgen in source mode to mock all interfaces in the file.
-        interfaces: a list of interfaces in the given `library` to be mocked in reflective mode.
+        interfaces: a list of interfaces in the given `library` to be mocked in archive mode.
         package: the name of the package the generated mocks should be in. If not specified, uses mockgen's default. See [mockgen's -package](https://github.com/golang/mock#flags) for more information.
         self_package: the full package import path for the generated code. The purpose of this flag is to prevent import cycles in the generated code by trying to include its own package. See [mockgen's -self_package](https://github.com/golang/mock#flags) for more information.
         aux_files: a map from source files to their package path. This only needed when `source` is provided. See [mockgen's -aux_files](https://github.com/golang/mock#flags) for more information.
@@ -223,11 +223,17 @@ def gomock(name, out, library = None, source_importpath = "", source = None, int
             self_package = self_package,
             mockgen_tool = mockgen_tool,
             copyright_file = copyright_file,
+            mock_names = mock_names,
             **kwargs
         )
 
 def _gomock_archive_impl(ctx):
     args = ctx.actions.args()
+
+    if len(ctx.attr.mock_names.items()):
+        mock_names = ",".join(["{0}={1}".format(name, pkg) for name, pkg in ctx.attr.mock_names.items()])
+        args.add("-mock_names", mock_names)
+
     args.add("-package", ctx.attr.library[GoInfo].importpath)
     args.add("-archive", ctx.attr.library[GoArchive].data.export_file.path)
     args.add("-destination", ctx.outputs.out)
@@ -282,6 +288,10 @@ _gomock_archive = rule(
         "self_package": attr.string(
             doc = "The full package import path for the generated code.",
         ),
+        "mock_names": attr.string_dict(
+            doc = "Dictionary of interface name to mock name pairs to change the output names of the mock objects. Mock names default to 'Mock' prepended to the name of the interface.",
+            default = {},
+        ),
         "mockgen_tool": attr.label(
             default = Label("@com_github_golang_mock//mockgen"),
             executable = True,

bazel/tests/README.rst

@@ -3,9 +3,9 @@ gomock
 
 Tests that ensure the gomock rules can be called correctly under different input permutations.
 
-reflective
+archive
 ------------------------
-Checks that gomock can be run in "reflective" mode when passed a `GoLibrary` and `interfaces`.
+Checks that gomock can be run in "archive" mode when passed a `GoLibrary` and `interfaces`.
 
 source
 ------------------------

bazel/tests/reflective/BUILD.bazel renamed to bazel/tests/archive/BUILD.bazel

@@ -1,7 +1,6 @@
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
 load("//rules:gomock.bzl", "gomock")
 
-
 go_library(
     name = "client",
     srcs = [
@@ -11,7 +10,7 @@ go_library(
     visibility = ["//visibility:public"],
 )
 
-# Build the mocks using reflective mode (i.e. without passing source)
+# Build the mocks using archive mode (i.e. without passing source)
 gomock(
     name = "mocks",
     out = "client_mock.go",
@@ -21,10 +20,24 @@ gomock(
     visibility = ["//visibility:public"],
 )
 
+# Build the mocks using mock_names renaming.
+gomock(
+    name = "renamed_mocks",
+    out = "client_mock_renamed.go",
+    interfaces = ["Client"],
+    library = ":client",
+    mock_names = {
+        "Client": "MockRenamedClient",
+    },
+    package = "client",
+    visibility = ["//visibility:public"],
+)
+
 go_test(
     name = "client_test",
     srcs = [
         "client_mock.go",
+        "client_mock_renamed.go",
         "client_test.go",
     ],
     embed = [":client"],

bazel/tests/reflective/client.go renamed to bazel/tests/archive/client.go

@@ -1,3 +1,5 @@
 package client
 
 var _ Client = (*MockClient)(nil)
+
+var _ Client = (*MockRenamedClient)(nil)

bazel/tests/reflective/client_test.go renamed to bazel/tests/archive/client_test.go

@@ -1,7 +1,6 @@
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
 load("//rules:gomock.bzl", "gomock")
 
-
 go_library(
     name = "client",
     srcs = [
@@ -21,6 +20,18 @@ gomock(
     visibility = ["//visibility:public"],
 )
 
+gomock(
+    name = "renamed_mocks",
+    out = "renamed_client_mock.go",
+    library = ":client",
+    mock_names = {
+        "Client": "MockRenamedClient",
+    },
+    package = "client",
+    source = "client.go",
+    visibility = ["//visibility:public"],
+)
+
 gomock(
     name = "wrapper_mocks",
     out = "wrapper_mock.go",
@@ -39,6 +50,7 @@ go_test(
     srcs = [
         "client_mock.go",
         "client_test.go",
+        "renamed_client_mock.go",
         "wrapper_mock.go",
     ],
     embed = [":client"],

bazel/tests/source/BUILD.bazel

@@ -1,3 +1,5 @@
 package client
 
 var _ Client = (*MockClient)(nil)
+
+var _ Client = (*MockRenamedClient)(nil)