Repository: golang/mock Branch: main Commit: 674a1c4a938e Files: 135 Total size: 312.4 KB Directory structure: gitextract_uystbc9u/ ├── .github/ │ ├── CODEOWNERS │ ├── ISSUE_TEMPLATE/ │ │ ├── bug_report.md │ │ ├── config.yml │ │ └── feature_request.md │ └── workflows/ │ └── test.yaml ├── .gitignore ├── .goreleaser.yml ├── AUTHORS ├── CONTRIBUTING.md ├── CONTRIBUTORS ├── LICENSE ├── README.md ├── ci/ │ ├── check_panic_handling.sh │ └── test.sh ├── go.mod ├── go.sum ├── gomock/ │ ├── call.go │ ├── call_test.go │ ├── callset.go │ ├── callset_test.go │ ├── controller.go │ ├── controller_test.go │ ├── doc.go │ ├── example_test.go │ ├── internal/ │ │ └── mock_gomock/ │ │ └── mock_matcher.go │ ├── matchers.go │ ├── matchers_test.go │ └── mock_test.go ├── mockgen/ │ ├── generic_go118.go │ ├── generic_notgo118.go │ ├── internal/ │ │ └── tests/ │ │ ├── aux_imports_embedded_interface/ │ │ │ ├── README.md │ │ │ ├── bugreport.go │ │ │ ├── bugreport_mock.go │ │ │ ├── bugreport_test.go │ │ │ └── faux/ │ │ │ └── faux.go │ │ ├── const_array_length/ │ │ │ ├── input.go │ │ │ └── mock.go │ │ ├── copyright_file/ │ │ │ ├── input.go │ │ │ ├── mock.go │ │ │ └── mock_copyright_header │ │ ├── custom_package_name/ │ │ │ ├── README.md │ │ │ ├── client/ │ │ │ │ └── v1/ │ │ │ │ └── client.go │ │ │ ├── greeter/ │ │ │ │ ├── greeter.go │ │ │ │ ├── greeter_mock_test.go │ │ │ │ └── greeter_test.go │ │ │ └── validator/ │ │ │ └── validate.go │ │ ├── dot_imports/ │ │ │ ├── input.go │ │ │ └── mock.go │ │ ├── empty_interface/ │ │ │ ├── input.go │ │ │ └── mock.go │ │ ├── extra_import/ │ │ │ ├── import.go │ │ │ └── mock.go │ │ ├── generated_identifier_conflict/ │ │ │ ├── README.md │ │ │ ├── bugreport.go │ │ │ ├── bugreport_mock.go │ │ │ └── bugreport_test.go │ │ ├── generics/ │ │ │ ├── external.go │ │ │ ├── generics.go │ │ │ ├── go.mod │ │ │ ├── go.sum │ │ │ ├── other/ │ │ │ │ └── other.go │ │ │ └── source/ │ │ │ ├── mock_external_test.go │ │ │ └── mock_generics_test.go │ │ ├── import_embedded_interface/ │ │ │ ├── bugreport.go │ │ │ ├── bugreport_mock.go │ │ │ ├── bugreport_test.go │ │ │ ├── ersatz/ │ │ │ │ └── ersatz.go │ │ │ ├── faux/ │ │ │ │ ├── conflict.go │ │ │ │ └── faux.go │ │ │ ├── foo.go │ │ │ ├── net.go │ │ │ ├── net_mock.go │ │ │ ├── net_test.go │ │ │ └── other/ │ │ │ ├── ersatz/ │ │ │ │ └── ersatz.go │ │ │ └── log/ │ │ │ └── log.go │ │ ├── import_source/ │ │ │ ├── README.md │ │ │ ├── definition/ │ │ │ │ ├── source.go │ │ │ │ └── source_mock.go │ │ │ └── source_mock.go │ │ ├── internal_pkg/ │ │ │ ├── generate.go │ │ │ └── subdir/ │ │ │ └── internal/ │ │ │ └── pkg/ │ │ │ ├── input.go │ │ │ ├── reflect_output/ │ │ │ │ └── mock.go │ │ │ └── source_output/ │ │ │ └── mock.go │ │ ├── missing_import/ │ │ │ ├── output/ │ │ │ │ └── source_mock.go │ │ │ └── source/ │ │ │ └── source.go │ │ ├── mock_in_test_package/ │ │ │ ├── README.md │ │ │ ├── mock_test.go │ │ │ └── user.go │ │ ├── overlapping_methods/ │ │ │ ├── interfaces.go │ │ │ ├── mock.go │ │ │ ├── overlap.go │ │ │ └── overlap_test.go │ │ ├── panicing_test/ │ │ │ ├── mock_test.go │ │ │ ├── panic.go │ │ │ └── panic_test.go │ │ ├── parenthesized_parameter_type/ │ │ │ ├── README.md │ │ │ ├── input.go │ │ │ └── mock.go │ │ ├── performance/ │ │ │ └── big_interface/ │ │ │ └── big_interface.go │ │ ├── self_package/ │ │ │ ├── mock.go │ │ │ └── types.go │ │ ├── test_package/ │ │ │ ├── foo.go │ │ │ ├── mock_test.go │ │ │ └── user_test.go │ │ ├── unexported_method/ │ │ │ ├── README.md │ │ │ ├── bugreport.go │ │ │ ├── bugreport_mock.go │ │ │ └── bugreport_test.go │ │ ├── vendor_dep/ │ │ │ ├── README.md │ │ │ ├── doc.go │ │ │ ├── mock.go │ │ │ ├── source_mock_package/ │ │ │ │ └── mock.go │ │ │ └── vendor_dep.go │ │ └── vendor_pkg/ │ │ ├── README.md │ │ ├── doc.go │ │ └── mock.go │ ├── mockgen.go │ ├── mockgen_test.go │ ├── model/ │ │ ├── model.go │ │ └── model_test.go │ ├── parse.go │ ├── parse_test.go │ ├── reflect.go │ └── version.go └── sample/ ├── README.md ├── concurrent/ │ ├── concurrent.go │ ├── concurrent_test.go │ └── mock/ │ └── concurrent_mock.go ├── imp1/ │ └── imp1.go ├── imp2/ │ └── imp2.go ├── imp3/ │ └── imp3.go ├── imp4/ │ └── imp4.go ├── mock_user_test.go ├── user.go └── user_test.go ================================================ FILE CONTENTS ================================================ ================================================ FILE: .github/CODEOWNERS ================================================ * @codyoss ================================================ FILE: .github/ISSUE_TEMPLATE/bug_report.md ================================================ --- name: Bug report about: Report a bug in gomock title: '' labels: '' assignees: '' --- **Actual behavior** A clear and concise description of what the bug is. **Expected behavior** A clear and concise description of what you expected to happen. **To Reproduce** Steps to reproduce the behavior 1. ... 2. ... **Additional Information** - gomock mode (reflect or source): - gomock version or git ref: - golang version: **Triage Notes for the Maintainers** ================================================ FILE: .github/ISSUE_TEMPLATE/config.yml ================================================ blank_issues_enabled: true #contact_links: # - name: GitHub Community Forum # url: https://github.community/ # about: Please ask and answer questions here. # - name: GitHub Security Bug Bounty # url: https://bounty.github.com/ # about: Please report security vulnerabilities here. ================================================ FILE: .github/ISSUE_TEMPLATE/feature_request.md ================================================ --- name: Feature request about: Propose a new feature for gomock title: '' labels: 'type: feature request' assignees: '' --- *Requested feature* A clear description of the desired feature and an example of how it would be used. *Why the feature is needed* A clear description of how this feature is not served by existing functionality in gomock. *(Optional) Proposed solution* A clear description of a proposed method for adding this feature to gomock. ================================================ FILE: .github/workflows/test.yaml ================================================ name: Run tests on: push: branches: [main] pull_request: branches: [main] env: GO111MODULE: on jobs: test: strategy: matrix: go-version: [1.15.x, 1.18.x] os: [ubuntu-latest] runs-on: ${{ matrix.os }} steps: - name: Install Go uses: actions/setup-go@v2 with: go-version: ${{ matrix.go-version }} - name: Checkout code uses: actions/checkout@v2 - name: Vet and build run: | go vet ./... go build ./... - name: Install mockgen run: | go install github.com/golang/mock/mockgen - name: Run test script run: | ./ci/test.sh ./ci/check_panic_handling.sh - name: Run Go tests all if: ${{ startsWith(matrix.go-version, '1.18') }} run: | for i in $(find $PWD -name go.mod); do pushd $(dirname $i) go test ./... popd done - name: Run Go tests some if: ${{ startsWith(matrix.go-version, '1.18') == false }} run: | go test ./... ================================================ FILE: .gitignore ================================================ # Object files and binaries from go. *.[568] # Library files. *.a # Any file prefixed by an underscore. */_* # System .*.swp .DS_Store # The mockgen binary. mockgen/mockgen # Editors .vscode .idea # vendor directory used for IDEs /vendor ================================================ FILE: .goreleaser.yml ================================================ # Release automation via GoReleaser (goreleaser.com) # Requires a valid GITHUB_TOKEN envar prior to running `goreleaser` # See https://goreleaser.com/environment/ for more info --- release: github: owner: golang name: mock builds: - binary: mockgen goos: - darwin - windows - linux goarch: - amd64 - arm64 - 386 env: - CGO_ENABLED=0 - GO111MODULE=on - GOPROXY=https://proxy.golang.org - GOSUMDB=sum.golang.org main: ./mockgen/ archives: - format: tar.gz wrap_in_directory: true files: - LICENSE - README.md checksum: snapshot: name_template: "snap-{{ .Commit }}" changelog: sort: asc filters: exclude: - '^docs:' - '^test:' - 'README' ================================================ FILE: AUTHORS ================================================ # This is the official list of GoMock authors for copyright purposes. # This file is distinct from the CONTRIBUTORS files. # See the latter for an explanation. # Names should be added to this file as # Name or Organization # The email address is not required for organizations. # Please keep the list sorted. Alex Reece Google Inc. ================================================ FILE: CONTRIBUTING.md ================================================ # Contributing First off, thank you for taking an interest to contribute to this project! ## Opening issues When opening a [new issue](https://github.com/golang/mock/issues/new/choose) please: 1. Make sure there are not other open/closed issues asking/reporting/requesting the same thing. 1. Choose one of our provided templates and fill out as much information as possible. ## Opening a Pull Requests We gladly accept contributions from the community. Before opening a pull request please make sure to create an issue for discussion first. This helps us decide what action should be taken in regards to the issue. ================================================ FILE: CONTRIBUTORS ================================================ # This is the official list of people who can contribute (and typically # have contributed) code to the gomock repository. # The AUTHORS file lists the copyright holders; this file # lists people. For example, Google employees are listed here # but not in AUTHORS, because Google holds the copyright. # # The submission process automatically checks to make sure # that people submitting code are listed in this file (by email address). # # Names should be added to this file only after verifying that # the individual or the individual's organization has agreed to # the appropriate Contributor License Agreement, found here: # # http://code.google.com/legal/individual-cla-v1.0.html # http://code.google.com/legal/corporate-cla-v1.0.html # # The agreement for individuals can be filled out on the web. # # When adding J Random Contributor's name to this file, # either J's name or J's organization's name should be # added to the AUTHORS file, depending on whether the # individual or corporate CLA was used. # Names should be added to this file like so: # Name # # An entry with two email addresses specifies that the # first address should be used in the submit logs and # that the second address should be recognized as the # same person when interacting with Rietveld. # Please keep the list sorted. Aaron Jacobs Alex Reece David Symonds Ryan Barrett ================================================ FILE: LICENSE ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ================================================ FILE: README.md ================================================ # gomock **Update, June 2023**: _This repo and tool are no longer maintained. Please see [go.uber.org/mock](https://github.com/uber/mock) for a maintained fork instead._ [![Build Status][ci-badge]][ci-runs] [![Go Reference][reference-badge]][reference] gomock is a mocking framework for the [Go programming language][golang]. It integrates well with Go's built-in `testing` package, but can be used in other contexts too. ## Installation Once you have [installed Go][golang-install], install the `mockgen` tool. **Note**: If you have not done so already be sure to add `$GOPATH/bin` to your `PATH`. To get the latest released version use: ### Go version < 1.16 ```bash GO111MODULE=on go get github.com/golang/mock/mockgen@v1.6.0 ``` ### Go 1.16+ ```bash go install github.com/golang/mock/mockgen@v1.6.0 ``` If you use `mockgen` in your CI pipeline, it may be more appropriate to fixate on a specific mockgen version. You should try to keep the library in sync with the version of mockgen used to generate your mocks. ## Running mockgen `mockgen` has two modes of operation: source and reflect. ### Source mode Source mode generates mock interfaces from a source file. It is enabled by using the -source flag. Other flags that may be useful in this mode are -imports and -aux_files. Example: ```bash mockgen -source=foo.go [other options] ``` ### Reflect mode Reflect mode generates mock interfaces by building a program that uses reflection to understand interfaces. It is enabled by passing two non-flag arguments: an import path, and a comma-separated list of symbols. You can use "." to refer to the current path's package. Example: ```bash mockgen database/sql/driver Conn,Driver # Convenient for `go:generate`. mockgen . Conn,Driver ``` ### Flags The `mockgen` command is used to generate source code for a mock class given a Go source file containing interfaces to be mocked. It supports the following flags: - `-source`: A file containing interfaces to be mocked. - `-destination`: A file to which to write the resulting source code. If you don't set this, the code is printed to standard output. - `-package`: The package to use for the resulting mock class source code. If you don't set this, the package name is `mock_` concatenated with the package of the input file. - `-imports`: A list of explicit imports that should be used in the resulting source code, specified as a comma-separated list of elements of the form `foo=bar/baz`, where `bar/baz` is the package being imported and `foo` is the identifier to use for the package in the generated source code. - `-aux_files`: A list of additional files that should be consulted to resolve e.g. embedded interfaces defined in a different file. This is specified as a comma-separated list of elements of the form `foo=bar/baz.go`, where `bar/baz.go` is the source file and `foo` is the package name of that file used by the -source file. - `-build_flags`: (reflect mode only) Flags passed verbatim to `go build`. - `-mock_names`: A list of custom names for generated mocks. This is specified as a comma-separated list of elements of the form `Repository=MockSensorRepository,Endpoint=MockSensorEndpoint`, where `Repository` is the interface name and `MockSensorRepository` is the desired mock name (mock factory method and mock recorder will be named after the mock). If one of the interfaces has no custom name specified, then default naming convention will be used. - `-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. This can happen if the mock's package is set to one of its inputs (usually the main one) and the output is stdio so mockgen cannot detect the final output package. Setting this flag will then tell mockgen which import to exclude. - `-copyright_file`: Copyright file used to add copyright header to the resulting source code. - `-debug_parser`: Print out parser results only. - `-exec_only`: (reflect mode) If set, execute this reflection program. - `-prog_only`: (reflect mode) Only generate the reflection program; write it to stdout and exit. - `-write_package_comment`: Writes package documentation comment (godoc) if true. (default true) For an example of the use of `mockgen`, see the `sample/` directory. In simple cases, you will need only the `-source` flag. ## Building Mocks ```go type Foo interface { Bar(x int) int } func SUT(f Foo) { // ... } ``` ```go func TestFoo(t *testing.T) { ctrl := gomock.NewController(t) // Assert that Bar() is invoked. defer ctrl.Finish() m := NewMockFoo(ctrl) // Asserts that the first and only call to Bar() is passed 99. // Anything else will fail. m. EXPECT(). Bar(gomock.Eq(99)). Return(101) SUT(m) } ``` If you are using a Go version of 1.14+, a mockgen version of 1.5.0+, and are passing a *testing.T into `gomock.NewController(t)` you no longer need to call `ctrl.Finish()` explicitly. It will be called for you automatically from a self registered [Cleanup](https://pkg.go.dev/testing?tab=doc#T.Cleanup) function. ## Building Stubs ```go type Foo interface { Bar(x int) int } func SUT(f Foo) { // ... } ``` ```go func TestFoo(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() m := NewMockFoo(ctrl) // Does not make any assertions. Executes the anonymous functions and returns // its result when Bar is invoked with 99. m. EXPECT(). Bar(gomock.Eq(99)). DoAndReturn(func(_ int) int { time.Sleep(1*time.Second) return 101 }). AnyTimes() // Does not make any assertions. Returns 103 when Bar is invoked with 101. m. EXPECT(). Bar(gomock.Eq(101)). Return(103). AnyTimes() SUT(m) } ``` ## Modifying Failure Messages When a matcher reports a failure, it prints the received (`Got`) vs the expected (`Want`) value. ```shell Got: [3] Want: is equal to 2 Expected call at user_test.go:33 doesn't match the argument at index 1. Got: [0 1 1 2 3] Want: is equal to 1 ``` ### Modifying `Want` The `Want` value comes from the matcher's `String()` method. If the matcher's default output doesn't meet your needs, then it can be modified as follows: ```go gomock.WantFormatter( gomock.StringerFunc(func() string { return "is equal to fifteen" }), gomock.Eq(15), ) ``` This modifies the `gomock.Eq(15)` matcher's output for `Want:` from `is equal to 15` to `is equal to fifteen`. ### Modifying `Got` The `Got` value comes from the object's `String()` method if it is available. In some cases the output of an object is difficult to read (e.g., `[]byte`) and it would be helpful for the test to print it differently. The following modifies how the `Got` value is formatted: ```go gomock.GotFormatterAdapter( gomock.GotFormatterFunc(func(i interface{}) string { // Leading 0s return fmt.Sprintf("%02d", i) }), gomock.Eq(15), ) ``` If the received value is `3`, then it will be printed as `03`. [golang]: http://golang.org/ [golang-install]: http://golang.org/doc/install.html#releases [gomock-reference]: https://pkg.go.dev/github.com/golang/mock/gomock [ci-badge]: https://github.com/golang/mock/actions/workflows/test.yaml/badge.svg [ci-runs]: https://github.com/golang/mock/actions [reference-badge]: https://pkg.go.dev/badge/github.com/golang/mock.svg [reference]: https://pkg.go.dev/github.com/golang/mock ## Debugging Errors ### reflect vendoring error ```text cannot find package "." ... github.com/golang/mock/mockgen/model ``` If you come across this error while using reflect mode and vendoring dependencies there are three workarounds you can choose from: 1. Use source mode. 2. Include an empty import `import _ "github.com/golang/mock/mockgen/model"`. 3. Add `--build_flags=--mod=mod` to your mockgen command. This error is due to changes in default behavior of the `go` command in more recent versions. More details can be found in [#494](https://github.com/golang/mock/issues/494). ================================================ FILE: ci/check_panic_handling.sh ================================================ #!/bin/bash # Copyright 2010 Google LLC. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # This script is used to ensure that panics are properly reported in tests. set -eux pushd mockgen/internal/tests/panicing_test go test -v -tags=panictest -run TestDanger_Panics_Explicit | grep "Danger, Will Robinson!" go test -v -tags=panictest -run TestDanger_Panics_Implicit | grep "Danger, Will Robinson!" popd ================================================ FILE: ci/test.sh ================================================ #!/bin/bash # This script is used to ensure that the go.mod file is up to date. set -euo pipefail if [[ $(go version) != *"go1.18"* ]]; then exit 0 fi for i in $(find $PWD -name go.mod); do pushd $(dirname $i) go mod tidy popd done if [ ! -z "$(git status --porcelain)" ]; then git status git diff echo echo "The go.mod is not up to date." exit 1 fi BASE_DIR="$PWD" TEMP_DIR=$(mktemp -d) function cleanup() { rm -rf "${TEMP_DIR}" } trap cleanup EXIT cp -r . "${TEMP_DIR}/" cd $TEMP_DIR for i in $(find $PWD -name go.mod); do pushd $(dirname $i) go generate ./... popd done if ! diff -r . "${BASE_DIR}"; then echo echo "The generated files aren't up to date." echo "Update them with the 'go generate ./...' command." exit 1 fi ================================================ FILE: go.mod ================================================ module github.com/golang/mock require ( golang.org/x/mod v0.5.1 golang.org/x/tools v0.1.8 ) go 1.15 ================================================ FILE: go.sum ================================================ github.com/yuin/goldmark v1.4.1 h1:/vn0k+RBvwlxEmP5E7SZMqNxPhfMVFEJiykr15/0XKM= github.com/yuin/goldmark v1.4.1/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/mod v0.5.1 h1:OJxoQ/rynoF0dcCdI7cLPktw/hR2cueqYfjm43oqK38= golang.org/x/mod v0.5.1/go.mod h1:5OXOZSfqPIIbmVBIIKWRFfZjPR0E5r58TLhUjH0a2Ro= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20211019181941-9d821ace8654 h1:id054HUawV2/6IGm2IV8KZQjqtwAOo2CYlOToYqa0d0= golang.org/x/sys v0.0.0-20211019181941-9d821ace8654/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.1.8 h1:P1HhGGuLW4aAclzjtmJdf0mJOjVUZUzOTqkAkWL+l6w= golang.org/x/tools v0.1.8/go.mod h1:nABZi5QlRsZVlzPpHl034qft6wpY4eDcsTt5AaioBiU= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE= golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= ================================================ FILE: gomock/call.go ================================================ // Copyright 2010 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package gomock import ( "fmt" "reflect" "strconv" "strings" ) // Call represents an expected call to a mock. type Call struct { t TestHelper // for triggering test failures on invalid call setup receiver interface{} // the receiver of the method call method string // the name of the method methodType reflect.Type // the type of the method args []Matcher // the args origin string // file and line number of call setup preReqs []*Call // prerequisite calls // Expectations minCalls, maxCalls int numCalls int // actual number made // actions are called when this Call is called. Each action gets the args and // can set the return values by returning a non-nil slice. Actions run in the // order they are created. actions []func([]interface{}) []interface{} } // newCall creates a *Call. It requires the method type in order to support // unexported methods. func newCall(t TestHelper, receiver interface{}, method string, methodType reflect.Type, args ...interface{}) *Call { t.Helper() // TODO: check arity, types. mArgs := make([]Matcher, len(args)) for i, arg := range args { if m, ok := arg.(Matcher); ok { mArgs[i] = m } else if arg == nil { // Handle nil specially so that passing a nil interface value // will match the typed nils of concrete args. mArgs[i] = Nil() } else { mArgs[i] = Eq(arg) } } // callerInfo's skip should be updated if the number of calls between the user's test // and this line changes, i.e. this code is wrapped in another anonymous function. // 0 is us, 1 is RecordCallWithMethodType(), 2 is the generated recorder, and 3 is the user's test. origin := callerInfo(3) actions := []func([]interface{}) []interface{}{func([]interface{}) []interface{} { // Synthesize the zero value for each of the return args' types. rets := make([]interface{}, methodType.NumOut()) for i := 0; i < methodType.NumOut(); i++ { rets[i] = reflect.Zero(methodType.Out(i)).Interface() } return rets }} return &Call{t: t, receiver: receiver, method: method, methodType: methodType, args: mArgs, origin: origin, minCalls: 1, maxCalls: 1, actions: actions} } // AnyTimes allows the expectation to be called 0 or more times func (c *Call) AnyTimes() *Call { c.minCalls, c.maxCalls = 0, 1e8 // close enough to infinity return c } // MinTimes requires the call to occur at least n times. If AnyTimes or MaxTimes have not been called or if MaxTimes // was previously called with 1, MinTimes also sets the maximum number of calls to infinity. func (c *Call) MinTimes(n int) *Call { c.minCalls = n if c.maxCalls == 1 { c.maxCalls = 1e8 } return c } // MaxTimes limits the number of calls to n times. If AnyTimes or MinTimes have not been called or if MinTimes was // previously called with 1, MaxTimes also sets the minimum number of calls to 0. func (c *Call) MaxTimes(n int) *Call { c.maxCalls = n if c.minCalls == 1 { c.minCalls = 0 } return c } // DoAndReturn declares the action to run when the call is matched. // The return values from this function are returned by the mocked function. // It takes an interface{} argument to support n-arity functions. // The anonymous function must match the function signature mocked method. func (c *Call) DoAndReturn(f interface{}) *Call { // TODO: Check arity and types here, rather than dying badly elsewhere. v := reflect.ValueOf(f) c.addAction(func(args []interface{}) []interface{} { c.t.Helper() ft := v.Type() if c.methodType.NumIn() != ft.NumIn() { if ft.IsVariadic() { c.t.Fatalf("wrong number of arguments in DoAndReturn func for %T.%v The function signature must match the mocked method, a variadic function cannot be used.", c.receiver, c.method) } else { c.t.Fatalf("wrong number of arguments in DoAndReturn func for %T.%v: got %d, want %d [%s]", c.receiver, c.method, ft.NumIn(), c.methodType.NumIn(), c.origin) } return nil } vArgs := make([]reflect.Value, len(args)) for i := 0; i < len(args); i++ { if args[i] != nil { vArgs[i] = reflect.ValueOf(args[i]) } else { // Use the zero value for the arg. vArgs[i] = reflect.Zero(ft.In(i)) } } vRets := v.Call(vArgs) rets := make([]interface{}, len(vRets)) for i, ret := range vRets { rets[i] = ret.Interface() } return rets }) return c } // Do declares the action to run when the call is matched. The function's // return values are ignored to retain backward compatibility. To use the // return values call DoAndReturn. // It takes an interface{} argument to support n-arity functions. // The anonymous function must match the function signature mocked method. func (c *Call) Do(f interface{}) *Call { // TODO: Check arity and types here, rather than dying badly elsewhere. v := reflect.ValueOf(f) c.addAction(func(args []interface{}) []interface{} { c.t.Helper() ft := v.Type() if c.methodType.NumIn() != ft.NumIn() { if ft.IsVariadic() { c.t.Fatalf("wrong number of arguments in Do func for %T.%v The function signature must match the mocked method, a variadic function cannot be used.", c.receiver, c.method) } else { c.t.Fatalf("wrong number of arguments in Do func for %T.%v: got %d, want %d [%s]", c.receiver, c.method, ft.NumIn(), c.methodType.NumIn(), c.origin) } return nil } vArgs := make([]reflect.Value, len(args)) for i := 0; i < len(args); i++ { if args[i] != nil { vArgs[i] = reflect.ValueOf(args[i]) } else { // Use the zero value for the arg. vArgs[i] = reflect.Zero(ft.In(i)) } } v.Call(vArgs) return nil }) return c } // Return declares the values to be returned by the mocked function call. func (c *Call) Return(rets ...interface{}) *Call { c.t.Helper() mt := c.methodType if len(rets) != mt.NumOut() { c.t.Fatalf("wrong number of arguments to Return for %T.%v: got %d, want %d [%s]", c.receiver, c.method, len(rets), mt.NumOut(), c.origin) } for i, ret := range rets { if got, want := reflect.TypeOf(ret), mt.Out(i); got == want { // Identical types; nothing to do. } else if got == nil { // Nil needs special handling. switch want.Kind() { case reflect.Chan, reflect.Func, reflect.Interface, reflect.Map, reflect.Ptr, reflect.Slice: // ok default: c.t.Fatalf("argument %d to Return for %T.%v is nil, but %v is not nillable [%s]", i, c.receiver, c.method, want, c.origin) } } else if got.AssignableTo(want) { // Assignable type relation. Make the assignment now so that the generated code // can return the values with a type assertion. v := reflect.New(want).Elem() v.Set(reflect.ValueOf(ret)) rets[i] = v.Interface() } else { c.t.Fatalf("wrong type of argument %d to Return for %T.%v: %v is not assignable to %v [%s]", i, c.receiver, c.method, got, want, c.origin) } } c.addAction(func([]interface{}) []interface{} { return rets }) return c } // Times declares the exact number of times a function call is expected to be executed. func (c *Call) Times(n int) *Call { c.minCalls, c.maxCalls = n, n return c } // SetArg declares an action that will set the nth argument's value, // indirected through a pointer. Or, in the case of a slice and map, SetArg // will copy value's elements/key-value pairs into the nth argument. func (c *Call) SetArg(n int, value interface{}) *Call { c.t.Helper() mt := c.methodType // TODO: This will break on variadic methods. // We will need to check those at invocation time. if n < 0 || n >= mt.NumIn() { c.t.Fatalf("SetArg(%d, ...) called for a method with %d args [%s]", n, mt.NumIn(), c.origin) } // Permit setting argument through an interface. // In the interface case, we don't (nay, can't) check the type here. at := mt.In(n) switch at.Kind() { case reflect.Ptr: dt := at.Elem() if vt := reflect.TypeOf(value); !vt.AssignableTo(dt) { c.t.Fatalf("SetArg(%d, ...) argument is a %v, not assignable to %v [%s]", n, vt, dt, c.origin) } case reflect.Interface: // nothing to do case reflect.Slice: // nothing to do case reflect.Map: // nothing to do default: c.t.Fatalf("SetArg(%d, ...) referring to argument of non-pointer non-interface non-slice non-map type %v [%s]", n, at, c.origin) } c.addAction(func(args []interface{}) []interface{} { v := reflect.ValueOf(value) switch reflect.TypeOf(args[n]).Kind() { case reflect.Slice: setSlice(args[n], v) case reflect.Map: setMap(args[n], v) default: reflect.ValueOf(args[n]).Elem().Set(v) } return nil }) return c } // isPreReq returns true if other is a direct or indirect prerequisite to c. func (c *Call) isPreReq(other *Call) bool { for _, preReq := range c.preReqs { if other == preReq || preReq.isPreReq(other) { return true } } return false } // After declares that the call may only match after preReq has been exhausted. func (c *Call) After(preReq *Call) *Call { c.t.Helper() if c == preReq { c.t.Fatalf("A call isn't allowed to be its own prerequisite") } if preReq.isPreReq(c) { c.t.Fatalf("Loop in call order: %v is a prerequisite to %v (possibly indirectly).", c, preReq) } c.preReqs = append(c.preReqs, preReq) return c } // Returns true if the minimum number of calls have been made. func (c *Call) satisfied() bool { return c.numCalls >= c.minCalls } // Returns true if the maximum number of calls have been made. func (c *Call) exhausted() bool { return c.numCalls >= c.maxCalls } func (c *Call) String() string { args := make([]string, len(c.args)) for i, arg := range c.args { args[i] = arg.String() } arguments := strings.Join(args, ", ") return fmt.Sprintf("%T.%v(%s) %s", c.receiver, c.method, arguments, c.origin) } // Tests if the given call matches the expected call. // If yes, returns nil. If no, returns error with message explaining why it does not match. func (c *Call) matches(args []interface{}) error { if !c.methodType.IsVariadic() { if len(args) != len(c.args) { return fmt.Errorf("expected call at %s has the wrong number of arguments. Got: %d, want: %d", c.origin, len(args), len(c.args)) } for i, m := range c.args { if !m.Matches(args[i]) { return fmt.Errorf( "expected call at %s doesn't match the argument at index %d.\nGot: %v\nWant: %v", c.origin, i, formatGottenArg(m, args[i]), m, ) } } } else { if len(c.args) < c.methodType.NumIn()-1 { return fmt.Errorf("expected call at %s has the wrong number of matchers. Got: %d, want: %d", c.origin, len(c.args), c.methodType.NumIn()-1) } if len(c.args) != c.methodType.NumIn() && len(args) != len(c.args) { return fmt.Errorf("expected call at %s has the wrong number of arguments. Got: %d, want: %d", c.origin, len(args), len(c.args)) } if len(args) < len(c.args)-1 { return fmt.Errorf("expected call at %s has the wrong number of arguments. Got: %d, want: greater than or equal to %d", c.origin, len(args), len(c.args)-1) } for i, m := range c.args { if i < c.methodType.NumIn()-1 { // Non-variadic args if !m.Matches(args[i]) { return fmt.Errorf("expected call at %s doesn't match the argument at index %s.\nGot: %v\nWant: %v", c.origin, strconv.Itoa(i), formatGottenArg(m, args[i]), m) } continue } // The last arg has a possibility of a variadic argument, so let it branch // sample: Foo(a int, b int, c ...int) if i < len(c.args) && i < len(args) { if m.Matches(args[i]) { // Got Foo(a, b, c) want Foo(matcherA, matcherB, gomock.Any()) // Got Foo(a, b, c) want Foo(matcherA, matcherB, someSliceMatcher) // Got Foo(a, b, c) want Foo(matcherA, matcherB, matcherC) // Got Foo(a, b) want Foo(matcherA, matcherB) // Got Foo(a, b, c, d) want Foo(matcherA, matcherB, matcherC, matcherD) continue } } // The number of actual args don't match the number of matchers, // or the last matcher is a slice and the last arg is not. // If this function still matches it is because the last matcher // matches all the remaining arguments or the lack of any. // Convert the remaining arguments, if any, into a slice of the // expected type. vArgsType := c.methodType.In(c.methodType.NumIn() - 1) vArgs := reflect.MakeSlice(vArgsType, 0, len(args)-i) for _, arg := range args[i:] { vArgs = reflect.Append(vArgs, reflect.ValueOf(arg)) } if m.Matches(vArgs.Interface()) { // Got Foo(a, b, c, d, e) want Foo(matcherA, matcherB, gomock.Any()) // Got Foo(a, b, c, d, e) want Foo(matcherA, matcherB, someSliceMatcher) // Got Foo(a, b) want Foo(matcherA, matcherB, gomock.Any()) // Got Foo(a, b) want Foo(matcherA, matcherB, someEmptySliceMatcher) break } // Wrong number of matchers or not match. Fail. // Got Foo(a, b) want Foo(matcherA, matcherB, matcherC, matcherD) // Got Foo(a, b, c) want Foo(matcherA, matcherB, matcherC, matcherD) // Got Foo(a, b, c, d) want Foo(matcherA, matcherB, matcherC, matcherD, matcherE) // Got Foo(a, b, c, d, e) want Foo(matcherA, matcherB, matcherC, matcherD) // Got Foo(a, b, c) want Foo(matcherA, matcherB) return fmt.Errorf("expected call at %s doesn't match the argument at index %s.\nGot: %v\nWant: %v", c.origin, strconv.Itoa(i), formatGottenArg(m, args[i:]), c.args[i]) } } // Check that all prerequisite calls have been satisfied. for _, preReqCall := range c.preReqs { if !preReqCall.satisfied() { return fmt.Errorf("expected call at %s doesn't have a prerequisite call satisfied:\n%v\nshould be called before:\n%v", c.origin, preReqCall, c) } } // Check that the call is not exhausted. if c.exhausted() { return fmt.Errorf("expected call at %s has already been called the max number of times", c.origin) } return nil } // dropPrereqs tells the expected Call to not re-check prerequisite calls any // longer, and to return its current set. func (c *Call) dropPrereqs() (preReqs []*Call) { preReqs = c.preReqs c.preReqs = nil return } func (c *Call) call() []func([]interface{}) []interface{} { c.numCalls++ return c.actions } // InOrder declares that the given calls should occur in order. func InOrder(calls ...*Call) { for i := 1; i < len(calls); i++ { calls[i].After(calls[i-1]) } } func setSlice(arg interface{}, v reflect.Value) { va := reflect.ValueOf(arg) for i := 0; i < v.Len(); i++ { va.Index(i).Set(v.Index(i)) } } func setMap(arg interface{}, v reflect.Value) { va := reflect.ValueOf(arg) for _, e := range va.MapKeys() { va.SetMapIndex(e, reflect.Value{}) } for _, e := range v.MapKeys() { va.SetMapIndex(e, v.MapIndex(e)) } } func (c *Call) addAction(action func([]interface{}) []interface{}) { c.actions = append(c.actions, action) } func formatGottenArg(m Matcher, arg interface{}) string { got := fmt.Sprintf("%v (%T)", arg, arg) if gs, ok := m.(GotFormatter); ok { got = gs.Got(arg) } return got } ================================================ FILE: gomock/call_test.go ================================================ // Copyright 2020 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package gomock import ( "fmt" "reflect" "testing" ) type foo struct{} func (f foo) String() string { return "meow" } type a struct { name string } func (testObj a) Name() string { return testObj.name } type b struct { foo string } func (testObj b) Foo() string { return testObj.foo } type mockTestReporter struct { errorCalls int fatalCalls int } func (o *mockTestReporter) Errorf(format string, args ...interface{}) { o.errorCalls++ } func (o *mockTestReporter) Fatalf(format string, args ...interface{}) { o.fatalCalls++ } func (o *mockTestReporter) Helper() {} func TestCall_After(t *testing.T) { t.Run("SelfPrereqCallsFatalf", func(t *testing.T) { tr1 := &mockTestReporter{} c := &Call{t: tr1} c.After(c) if tr1.fatalCalls != 1 { t.Errorf("number of fatal calls == %v, want 1", tr1.fatalCalls) } }) t.Run("LoopInCallOrderCallsFatalf", func(t *testing.T) { tr1 := &mockTestReporter{} tr2 := &mockTestReporter{} c1 := &Call{t: tr1} c2 := &Call{t: tr2} c1.After(c2) c2.After(c1) if tr1.errorCalls != 0 || tr1.fatalCalls != 0 { t.Error("unexpected errors") } if tr2.fatalCalls != 1 { t.Errorf("number of fatal calls == %v, want 1", tr2.fatalCalls) } }) } func prepareDoCall(doFunc, callFunc interface{}) *Call { tr := &mockTestReporter{} c := &Call{ t: tr, methodType: reflect.TypeOf(callFunc), } c.Do(doFunc) return c } func prepareDoAndReturnCall(doFunc, callFunc interface{}) *Call { tr := &mockTestReporter{} c := &Call{ t: tr, methodType: reflect.TypeOf(callFunc), } c.DoAndReturn(doFunc) return c } type testCase struct { description string doFunc interface{} callFunc interface{} args []interface{} expectPanic bool } var testCases []testCase = []testCase{ { description: "argument to Do is not a function", doFunc: "meow", callFunc: func(x int, y int) {}, args: []interface{}{0, 1}, expectPanic: true, }, { description: "argument to Do is not a function", doFunc: "meow", callFunc: func(x int, y int) bool { return true }, args: []interface{}{0, 1}, expectPanic: true, }, { description: "number of args for Do func don't match Call func", doFunc: func(x int) {}, callFunc: func(x int, y int) {}, args: []interface{}{0, 1}, expectPanic: false, }, { description: "number of args for Do func don't match Call func", doFunc: func(x int) bool { return true }, callFunc: func(x int, y int) bool { return true }, args: []interface{}{0, 1}, expectPanic: false, }, { description: "arg type for Do func incompatible with Call func", doFunc: func(x int) {}, callFunc: func(x string) {}, args: []interface{}{"meow"}, expectPanic: true, }, { description: "arg type for Do func incompatible with Call func", doFunc: func(x int) bool { return true }, callFunc: func(x string) bool { return true }, args: []interface{}{"meow"}, expectPanic: true, }, { description: "Do func(int) Call func(int)", doFunc: func(x int) {}, callFunc: func(x int) {}, args: []interface{}{0}, }, { description: "Do func(int) Call func(interface{})", doFunc: func(x int) {}, callFunc: func(x interface{}) {}, args: []interface{}{0}, }, { description: "Do func(int) bool Call func(int) bool", doFunc: func(x int) bool { return true }, callFunc: func(x int) bool { return true }, args: []interface{}{0}, }, { description: "Do func(int) bool Call func(interface{}) bool", doFunc: func(x int) bool { return true }, callFunc: func(x interface{}) bool { return true }, args: []interface{}{0}, }, { description: "Do func(string) Call func([]byte)", doFunc: func(x string) {}, callFunc: func(x []byte) {}, args: []interface{}{[]byte("meow")}, expectPanic: true, }, { description: "Do func(string) bool Call func([]byte) bool", doFunc: func(x string) bool { return true }, callFunc: func(x []byte) bool { return true }, args: []interface{}{[]byte("meow")}, expectPanic: true, }, { description: "Do func(map[int]string) Call func(map[interface{}]int)", doFunc: func(x map[int]string) {}, callFunc: func(x map[interface{}]int) {}, args: []interface{}{map[interface{}]int{"meow": 0}}, expectPanic: true, }, { description: "Do func(map[int]string) Call func(map[interface{}]interface{})", doFunc: func(x map[int]string) {}, callFunc: func(x map[interface{}]interface{}) {}, args: []interface{}{map[interface{}]interface{}{"meow": "meow"}}, expectPanic: true, }, { description: "Do func(map[int]string) bool Call func(map[interface{}]int) bool", doFunc: func(x map[int]string) bool { return true }, callFunc: func(x map[interface{}]int) bool { return true }, args: []interface{}{map[interface{}]int{"meow": 0}}, expectPanic: true, }, { description: "Do func(map[int]string) bool Call func(map[interface{}]interface{}) bool", doFunc: func(x map[int]string) bool { return true }, callFunc: func(x map[interface{}]interface{}) bool { return true }, args: []interface{}{map[interface{}]interface{}{"meow": "meow"}}, expectPanic: true, }, { description: "Do func([]string) Call func([]interface{})", doFunc: func(x []string) {}, callFunc: func(x []interface{}) {}, args: []interface{}{[]interface{}{0}}, expectPanic: true, }, { description: "Do func([]string) Call func([]int)", doFunc: func(x []string) {}, callFunc: func(x []int) {}, args: []interface{}{[]int{0, 1}}, expectPanic: true, }, { description: "Do func([]int) Call func([]int)", doFunc: func(x []int) {}, callFunc: func(x []int) {}, args: []interface{}{[]int{0, 1}}, }, { description: "Do func([]int) Call func([]interface{})", doFunc: func(x []int) {}, callFunc: func(x []interface{}) {}, args: []interface{}{[]interface{}{0}}, expectPanic: true, }, { description: "Do func([]int) Call func(...interface{})", doFunc: func(x []int) {}, callFunc: func(x ...interface{}) {}, args: []interface{}{0, 1}, expectPanic: true, }, { description: "Do func([]int) Call func(...int)", doFunc: func(x []int) {}, callFunc: func(x ...int) {}, args: []interface{}{0, 1}, expectPanic: true, }, { description: "Do func([]string) bool Call func([]interface{}) bool", doFunc: func(x []string) bool { return true }, callFunc: func(x []interface{}) bool { return true }, args: []interface{}{[]interface{}{0}}, expectPanic: true, }, { description: "Do func([]string) bool Call func([]int) bool", doFunc: func(x []string) bool { return true }, callFunc: func(x []int) bool { return true }, args: []interface{}{[]int{0, 1}}, expectPanic: true, }, { description: "Do func([]int) bool Call func([]int) bool", doFunc: func(x []int) bool { return true }, callFunc: func(x []int) bool { return true }, args: []interface{}{[]int{0, 1}}, }, { description: "Do func([]int) bool Call func([]interface{}) bool", doFunc: func(x []int) bool { return true }, callFunc: func(x []interface{}) bool { return true }, args: []interface{}{[]interface{}{0}}, expectPanic: true, }, { description: "Do func([]int) bool Call func(...interface{}) bool", doFunc: func(x []int) bool { return true }, callFunc: func(x ...interface{}) bool { return true }, args: []interface{}{0, 1}, expectPanic: true, }, { description: "Do func([]int) bool Call func(...int) bool", doFunc: func(x []int) bool { return true }, callFunc: func(x ...int) bool { return true }, args: []interface{}{0, 1}, expectPanic: true, }, { description: "Do func(...int) Call func([]int)", doFunc: func(x ...int) {}, callFunc: func(x []int) {}, args: []interface{}{[]int{0, 1}}, expectPanic: true, }, { description: "Do func(...int) Call func([]interface{})", doFunc: func(x ...int) {}, callFunc: func(x []interface{}) {}, args: []interface{}{[]interface{}{0, 1}}, expectPanic: true, }, { description: "Do func(...int) Call func(...interface{})", doFunc: func(x ...int) {}, callFunc: func(x ...interface{}) {}, args: []interface{}{0, 1}, }, { description: "Do func(...int) bool Call func(...int) bool", doFunc: func(x ...int) bool { return true }, callFunc: func(x ...int) bool { return true }, args: []interface{}{0, 1}, }, { description: "Do func(...int) bool Call func([]int) bool", doFunc: func(x ...int) bool { return true }, callFunc: func(x []int) bool { return true }, args: []interface{}{[]int{0, 1}}, expectPanic: true, }, { description: "Do func(...int) bool Call func([]interface{}) bool", doFunc: func(x ...int) bool { return true }, callFunc: func(x []interface{}) bool { return true }, args: []interface{}{[]interface{}{0, 1}}, expectPanic: true, }, { description: "Do func(...int) bool Call func(...interface{}) bool", doFunc: func(x ...int) bool { return true }, callFunc: func(x ...interface{}) bool { return true }, args: []interface{}{0, 1}, }, { description: "Do func(...int) Call func(...int)", doFunc: func(x ...int) {}, callFunc: func(x ...int) {}, args: []interface{}{0, 1}, }, { description: "Do func(foo); foo implements interface X Call func(interface X)", doFunc: func(x foo) {}, callFunc: func(x fmt.Stringer) {}, args: []interface{}{foo{}}, }, { description: "Do func(b); b does not implement interface X Call func(interface X)", doFunc: func(x b) {}, callFunc: func(x fmt.Stringer) {}, args: []interface{}{foo{}}, expectPanic: true, }, { description: "Do func(b) Call func(a); a and b are not aliases", doFunc: func(x b) {}, callFunc: func(x a) {}, args: []interface{}{a{}}, expectPanic: true, }, { description: "Do func(foo) bool; foo implements interface X Call func(interface X) bool", doFunc: func(x foo) bool { return true }, callFunc: func(x fmt.Stringer) bool { return true }, args: []interface{}{foo{}}, }, { description: "Do func(b) bool; b does not implement interface X Call func(interface X) bool", doFunc: func(x b) bool { return true }, callFunc: func(x fmt.Stringer) bool { return true }, args: []interface{}{foo{}}, expectPanic: true, }, { description: "Do func(b) bool Call func(a) bool; a and b are not aliases", doFunc: func(x b) bool { return true }, callFunc: func(x a) bool { return true }, args: []interface{}{a{}}, expectPanic: true, }, { description: "Do func(bool) b Call func(bool) a; a and b are not aliases", doFunc: func(x bool) b { return b{} }, callFunc: func(x bool) a { return a{} }, args: []interface{}{true}, }, } func TestCall_Do(t *testing.T) { for _, tc := range testCases { t.Run(tc.description, func(t *testing.T) { c := prepareDoCall(tc.doFunc, tc.callFunc) if len(c.actions) != 1 { t.Errorf("expected %d actions but got %d", 1, len(c.actions)) } action := c.actions[0] if tc.expectPanic { defer func() { if r := recover(); r == nil { t.Error("expected Do to panic") } }() } action(tc.args) }) } } func TestCall_Do_NumArgValidation(t *testing.T) { tests := []struct { name string methodType reflect.Type doFn interface{} args []interface{} wantErr bool }{ { name: "too few", methodType: reflect.TypeOf(func(one, two string) {}), doFn: func(one string) {}, args: []interface{}{"too", "few"}, wantErr: true, }, { name: "too many", methodType: reflect.TypeOf(func(one, two string) {}), doFn: func(one, two, three string) {}, args: []interface{}{"too", "few"}, wantErr: true, }, { name: "just right", methodType: reflect.TypeOf(func(one, two string) {}), doFn: func(one string, two string) {}, args: []interface{}{"just", "right"}, wantErr: false, }, { name: "variadic", methodType: reflect.TypeOf(func(one, two string) {}), doFn: func(args ...interface{}) {}, args: []interface{}{"just", "right"}, wantErr: true, }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { tr := &mockTestReporter{} call := &Call{ t: tr, methodType: tt.methodType, } call.Do(tt.doFn) call.actions[0](tt.args) if tt.wantErr && tr.fatalCalls != 1 { t.Fatalf("expected call to fail") } if !tt.wantErr && tr.fatalCalls != 0 { t.Fatalf("expected call to pass") } }) } } func TestCall_DoAndReturn_NumArgValidation(t *testing.T) { tests := []struct { name string methodType reflect.Type doFn interface{} args []interface{} wantErr bool }{ { name: "too few", methodType: reflect.TypeOf(func(one, two string) string { return "" }), doFn: func(one string) {}, args: []interface{}{"too", "few"}, wantErr: true, }, { name: "too many", methodType: reflect.TypeOf(func(one, two string) string { return "" }), doFn: func(one, two, three string) string { return "" }, args: []interface{}{"too", "few"}, wantErr: true, }, { name: "just right", methodType: reflect.TypeOf(func(one, two string) string { return "" }), doFn: func(one string, two string) string { return "" }, args: []interface{}{"just", "right"}, wantErr: false, }, { name: "variadic", methodType: reflect.TypeOf(func(one, two string) {}), doFn: func(args ...interface{}) string { return "" }, args: []interface{}{"just", "right"}, wantErr: true, }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { tr := &mockTestReporter{} call := &Call{ t: tr, methodType: tt.methodType, } call.DoAndReturn(tt.doFn) call.actions[0](tt.args) if tt.wantErr && tr.fatalCalls != 1 { t.Fatalf("expected call to fail") } if !tt.wantErr && tr.fatalCalls != 0 { t.Fatalf("expected call to pass") } }) } } func TestCall_DoAndReturn(t *testing.T) { for _, tc := range testCases { t.Run(tc.description, func(t *testing.T) { c := prepareDoAndReturnCall(tc.doFunc, tc.callFunc) if len(c.actions) != 1 { t.Errorf("expected %d actions but got %d", 1, len(c.actions)) } action := c.actions[0] if tc.expectPanic { defer func() { if r := recover(); r == nil { t.Error("expected DoAndReturn to panic") } }() } action(tc.args) }) } } ================================================ FILE: gomock/callset.go ================================================ // Copyright 2011 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package gomock import ( "bytes" "errors" "fmt" ) // callSet represents a set of expected calls, indexed by receiver and method // name. type callSet struct { // Calls that are still expected. expected map[callSetKey][]*Call // Calls that have been exhausted. exhausted map[callSetKey][]*Call } // callSetKey is the key in the maps in callSet type callSetKey struct { receiver interface{} fname string } func newCallSet() *callSet { return &callSet{make(map[callSetKey][]*Call), make(map[callSetKey][]*Call)} } // Add adds a new expected call. func (cs callSet) Add(call *Call) { key := callSetKey{call.receiver, call.method} m := cs.expected if call.exhausted() { m = cs.exhausted } m[key] = append(m[key], call) } // Remove removes an expected call. func (cs callSet) Remove(call *Call) { key := callSetKey{call.receiver, call.method} calls := cs.expected[key] for i, c := range calls { if c == call { // maintain order for remaining calls cs.expected[key] = append(calls[:i], calls[i+1:]...) cs.exhausted[key] = append(cs.exhausted[key], call) break } } } // FindMatch searches for a matching call. Returns error with explanation message if no call matched. func (cs callSet) FindMatch(receiver interface{}, method string, args []interface{}) (*Call, error) { key := callSetKey{receiver, method} // Search through the expected calls. expected := cs.expected[key] var callsErrors bytes.Buffer for _, call := range expected { err := call.matches(args) if err != nil { _, _ = fmt.Fprintf(&callsErrors, "\n%v", err) } else { return call, nil } } // If we haven't found a match then search through the exhausted calls so we // get useful error messages. exhausted := cs.exhausted[key] for _, call := range exhausted { if err := call.matches(args); err != nil { _, _ = fmt.Fprintf(&callsErrors, "\n%v", err) continue } _, _ = fmt.Fprintf( &callsErrors, "all expected calls for method %q have been exhausted", method, ) } if len(expected)+len(exhausted) == 0 { _, _ = fmt.Fprintf(&callsErrors, "there are no expected calls of the method %q for that receiver", method) } return nil, errors.New(callsErrors.String()) } // Failures returns the calls that are not satisfied. func (cs callSet) Failures() []*Call { failures := make([]*Call, 0, len(cs.expected)) for _, calls := range cs.expected { for _, call := range calls { if !call.satisfied() { failures = append(failures, call) } } } return failures } ================================================ FILE: gomock/callset_test.go ================================================ // Copyright 2011 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package gomock import ( "reflect" "testing" ) type receiverType struct{} func (receiverType) Func() {} func TestCallSetAdd(t *testing.T) { method := "TestMethod" var receiver interface{} = "TestReceiver" cs := newCallSet() numCalls := 10 for i := 0; i < numCalls; i++ { cs.Add(newCall(t, receiver, method, reflect.TypeOf(receiverType{}.Func))) } call, err := cs.FindMatch(receiver, method, []interface{}{}) if err != nil { t.Fatalf("FindMatch: %v", err) } if call == nil { t.Fatalf("FindMatch: Got nil, want non-nil *Call") } } func TestCallSetRemove(t *testing.T) { method := "TestMethod" var receiver interface{} = "TestReceiver" cs := newCallSet() ourCalls := []*Call{} numCalls := 10 for i := 0; i < numCalls; i++ { // NOTE: abuse the `numCalls` value to convey initial ordering of mocked calls generatedCall := &Call{receiver: receiver, method: method, numCalls: i} cs.Add(generatedCall) ourCalls = append(ourCalls, generatedCall) } // validateOrder validates that the calls in the array are ordered as they were added validateOrder := func(calls []*Call) { // lastNum tracks the last `numCalls` (call order) value seen lastNum := -1 for _, c := range calls { if lastNum >= c.numCalls { t.Errorf("found call %d after call %d", c.numCalls, lastNum) } lastNum = c.numCalls } } for _, c := range ourCalls { validateOrder(cs.expected[callSetKey{receiver, method}]) cs.Remove(c) } } func TestCallSetFindMatch(t *testing.T) { t.Run("call is exhausted", func(t *testing.T) { cs := callSet{} var receiver interface{} = "TestReceiver" method := "TestMethod" args := []interface{}{} c1 := newCall(t, receiver, method, reflect.TypeOf(receiverType{}.Func)) cs.exhausted = map[callSetKey][]*Call{ {receiver: receiver, fname: method}: {c1}, } _, err := cs.FindMatch(receiver, method, args) if err == nil { t.Fatal("expected error, but was nil") } if err.Error() == "" { t.Fatal("expected error to have message, but was empty") } }) } ================================================ FILE: gomock/controller.go ================================================ // Copyright 2010 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package gomock import ( "context" "fmt" "reflect" "runtime" "sync" ) // A TestReporter is something that can be used to report test failures. It // is satisfied by the standard library's *testing.T. type TestReporter interface { Errorf(format string, args ...interface{}) Fatalf(format string, args ...interface{}) } // TestHelper is a TestReporter that has the Helper method. It is satisfied // by the standard library's *testing.T. type TestHelper interface { TestReporter Helper() } // cleanuper is used to check if TestHelper also has the `Cleanup` method. A // common pattern is to pass in a `*testing.T` to // `NewController(t TestReporter)`. In Go 1.14+, `*testing.T` has a cleanup // method. This can be utilized to call `Finish()` so the caller of this library // does not have to. type cleanuper interface { Cleanup(func()) } // A Controller represents the top-level control of a mock ecosystem. It // defines the scope and lifetime of mock objects, as well as their // expectations. It is safe to call Controller's methods from multiple // goroutines. Each test should create a new Controller and invoke Finish via // defer. // // func TestFoo(t *testing.T) { // ctrl := gomock.NewController(t) // defer ctrl.Finish() // // .. // } // // func TestBar(t *testing.T) { // t.Run("Sub-Test-1", st) { // ctrl := gomock.NewController(st) // defer ctrl.Finish() // // .. // }) // t.Run("Sub-Test-2", st) { // ctrl := gomock.NewController(st) // defer ctrl.Finish() // // .. // }) // }) type Controller struct { // T should only be called within a generated mock. It is not intended to // be used in user code and may be changed in future versions. T is the // TestReporter passed in when creating the Controller via NewController. // If the TestReporter does not implement a TestHelper it will be wrapped // with a nopTestHelper. T TestHelper mu sync.Mutex expectedCalls *callSet finished bool } // NewController returns a new Controller. It is the preferred way to create a // Controller. // // New in go1.14+, if you are passing a *testing.T into this function you no // longer need to call ctrl.Finish() in your test methods. func NewController(t TestReporter) *Controller { h, ok := t.(TestHelper) if !ok { h = &nopTestHelper{t} } ctrl := &Controller{ T: h, expectedCalls: newCallSet(), } if c, ok := isCleanuper(ctrl.T); ok { c.Cleanup(func() { ctrl.T.Helper() ctrl.finish(true, nil) }) } return ctrl } type cancelReporter struct { t TestHelper cancel func() } func (r *cancelReporter) Errorf(format string, args ...interface{}) { r.t.Errorf(format, args...) } func (r *cancelReporter) Fatalf(format string, args ...interface{}) { defer r.cancel() r.t.Fatalf(format, args...) } func (r *cancelReporter) Helper() { r.t.Helper() } // WithContext returns a new Controller and a Context, which is cancelled on any // fatal failure. func WithContext(ctx context.Context, t TestReporter) (*Controller, context.Context) { h, ok := t.(TestHelper) if !ok { h = &nopTestHelper{t: t} } ctx, cancel := context.WithCancel(ctx) return NewController(&cancelReporter{t: h, cancel: cancel}), ctx } type nopTestHelper struct { t TestReporter } func (h *nopTestHelper) Errorf(format string, args ...interface{}) { h.t.Errorf(format, args...) } func (h *nopTestHelper) Fatalf(format string, args ...interface{}) { h.t.Fatalf(format, args...) } func (h nopTestHelper) Helper() {} // RecordCall is called by a mock. It should not be called by user code. func (ctrl *Controller) RecordCall(receiver interface{}, method string, args ...interface{}) *Call { ctrl.T.Helper() recv := reflect.ValueOf(receiver) for i := 0; i < recv.Type().NumMethod(); i++ { if recv.Type().Method(i).Name == method { return ctrl.RecordCallWithMethodType(receiver, method, recv.Method(i).Type(), args...) } } ctrl.T.Fatalf("gomock: failed finding method %s on %T", method, receiver) panic("unreachable") } // RecordCallWithMethodType is called by a mock. It should not be called by user code. func (ctrl *Controller) RecordCallWithMethodType(receiver interface{}, method string, methodType reflect.Type, args ...interface{}) *Call { ctrl.T.Helper() call := newCall(ctrl.T, receiver, method, methodType, args...) ctrl.mu.Lock() defer ctrl.mu.Unlock() ctrl.expectedCalls.Add(call) return call } // Call is called by a mock. It should not be called by user code. func (ctrl *Controller) Call(receiver interface{}, method string, args ...interface{}) []interface{} { ctrl.T.Helper() // Nest this code so we can use defer to make sure the lock is released. actions := func() []func([]interface{}) []interface{} { ctrl.T.Helper() ctrl.mu.Lock() defer ctrl.mu.Unlock() expected, err := ctrl.expectedCalls.FindMatch(receiver, method, args) if err != nil { // callerInfo's skip should be updated if the number of calls between the user's test // and this line changes, i.e. this code is wrapped in another anonymous function. // 0 is us, 1 is controller.Call(), 2 is the generated mock, and 3 is the user's test. origin := callerInfo(3) ctrl.T.Fatalf("Unexpected call to %T.%v(%v) at %s because: %s", receiver, method, args, origin, err) } // Two things happen here: // * the matching call no longer needs to check prerequite calls, // * and the prerequite calls are no longer expected, so remove them. preReqCalls := expected.dropPrereqs() for _, preReqCall := range preReqCalls { ctrl.expectedCalls.Remove(preReqCall) } actions := expected.call() if expected.exhausted() { ctrl.expectedCalls.Remove(expected) } return actions }() var rets []interface{} for _, action := range actions { if r := action(args); r != nil { rets = r } } return rets } // Finish checks to see if all the methods that were expected to be called // were called. It should be invoked for each Controller. It is not idempotent // and therefore can only be invoked once. // // New in go1.14+, if you are passing a *testing.T into NewController function you no // longer need to call ctrl.Finish() in your test methods. func (ctrl *Controller) Finish() { // If we're currently panicking, probably because this is a deferred call. // This must be recovered in the deferred function. err := recover() ctrl.finish(false, err) } func (ctrl *Controller) finish(cleanup bool, panicErr interface{}) { ctrl.T.Helper() ctrl.mu.Lock() defer ctrl.mu.Unlock() if ctrl.finished { if _, ok := isCleanuper(ctrl.T); !ok { ctrl.T.Fatalf("Controller.Finish was called more than once. It has to be called exactly once.") } return } ctrl.finished = true // Short-circuit, pass through the panic. if panicErr != nil { panic(panicErr) } // Check that all remaining expected calls are satisfied. failures := ctrl.expectedCalls.Failures() for _, call := range failures { ctrl.T.Errorf("missing call(s) to %v", call) } if len(failures) != 0 { if !cleanup { ctrl.T.Fatalf("aborting test due to missing call(s)") return } ctrl.T.Errorf("aborting test due to missing call(s)") } } // callerInfo returns the file:line of the call site. skip is the number // of stack frames to skip when reporting. 0 is callerInfo's call site. func callerInfo(skip int) string { if _, file, line, ok := runtime.Caller(skip + 1); ok { return fmt.Sprintf("%s:%d", file, line) } return "unknown file" } // isCleanuper checks it if t's base TestReporter has a Cleanup method. func isCleanuper(t TestReporter) (cleanuper, bool) { tr := unwrapTestReporter(t) c, ok := tr.(cleanuper) return c, ok } // unwrapTestReporter unwraps TestReporter to the base implementation. func unwrapTestReporter(t TestReporter) TestReporter { tr := t switch nt := t.(type) { case *cancelReporter: tr = nt.t if h, check := tr.(*nopTestHelper); check { tr = h.t } case *nopTestHelper: tr = nt.t default: // not wrapped } return tr } ================================================ FILE: gomock/controller_test.go ================================================ // Copyright 2011 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package gomock_test import ( "fmt" "reflect" "testing" "strings" "github.com/golang/mock/gomock" ) type ErrorReporter struct { t *testing.T log []string failed bool fatalToken struct{} } func NewErrorReporter(t *testing.T) *ErrorReporter { return &ErrorReporter{t: t} } func (e *ErrorReporter) reportLog() { for _, entry := range e.log { e.t.Log(entry) } } func (e *ErrorReporter) assertPass(msg string) { if e.failed { e.t.Errorf("Expected pass, but got failure(s): %s", msg) e.reportLog() } } func (e *ErrorReporter) assertFail(msg string) { if !e.failed { e.t.Errorf("Expected failure, but got pass: %s", msg) } } // Use to check that code triggers a fatal test failure. func (e *ErrorReporter) assertFatal(fn func(), expectedErrMsgs ...string) { defer func() { err := recover() if err == nil { var actual string if e.failed { actual = "non-fatal failure" } else { actual = "pass" } e.t.Error("Expected fatal failure, but got a", actual) } else if token, ok := err.(*struct{}); ok && token == &e.fatalToken { // This is okay - the panic is from Fatalf(). if expectedErrMsgs != nil { // assert that the actual error message // contains expectedErrMsgs // check the last actualErrMsg, because the previous messages come from previous errors actualErrMsg := e.log[len(e.log)-1] for _, expectedErrMsg := range expectedErrMsgs { if !strings.Contains(actualErrMsg, expectedErrMsg) { e.t.Errorf("Error message:\ngot: %q\nwant to contain: %q\n", actualErrMsg, expectedErrMsg) } } } return } else { // Some other panic. panic(err) } }() fn() } // recoverUnexpectedFatal can be used as a deferred call in test cases to // recover from and display a call to ErrorReporter.Fatalf(). func (e *ErrorReporter) recoverUnexpectedFatal() { err := recover() if err == nil { // No panic. } else if token, ok := err.(*struct{}); ok && token == &e.fatalToken { // Unexpected fatal error happened. e.t.Error("Got unexpected fatal error(s). All errors up to this point:") e.reportLog() return } else { // Some other panic. panic(err) } } func (e *ErrorReporter) Log(args ...interface{}) { e.log = append(e.log, fmt.Sprint(args...)) } func (e *ErrorReporter) Logf(format string, args ...interface{}) { e.log = append(e.log, fmt.Sprintf(format, args...)) } func (e *ErrorReporter) Errorf(format string, args ...interface{}) { e.Logf(format, args...) e.failed = true } func (e *ErrorReporter) Fatalf(format string, args ...interface{}) { e.Logf(format, args...) e.failed = true panic(&e.fatalToken) } type HelperReporter struct { gomock.TestReporter helper int } func (h *HelperReporter) Helper() { h.helper++ } // A type purely for use as a receiver in testing the Controller. type Subject struct{} func (s *Subject) FooMethod(arg string) int { return 0 } func (s *Subject) BarMethod(arg string) int { return 0 } func (s *Subject) VariadicMethod(arg int, vararg ...string) {} // A type purely for ActOnTestStructMethod type TestStruct struct { Number int Message string } func (s *Subject) ActOnTestStructMethod(arg TestStruct, arg1 int) int { return 0 } func (s *Subject) SetArgMethod(sliceArg []byte, ptrArg *int, mapArg map[interface{}]interface{}) {} func (s *Subject) SetArgMethodInterface(sliceArg, ptrArg, mapArg interface{}) {} func assertEqual(t *testing.T, expected interface{}, actual interface{}) { if !reflect.DeepEqual(expected, actual) { t.Errorf("Expected %+v, but got %+v", expected, actual) } } func createFixtures(t *testing.T) (reporter *ErrorReporter, ctrl *gomock.Controller) { // reporter acts as a testing.T-like object that we pass to the // Controller. We use it to test that the mock considered tests // successful or failed. reporter = NewErrorReporter(t) ctrl = gomock.NewController(reporter) return } func TestNoCalls(t *testing.T) { reporter, ctrl := createFixtures(t) ctrl.Finish() reporter.assertPass("No calls expected or made.") } func TestNoRecordedCallsForAReceiver(t *testing.T) { reporter, ctrl := createFixtures(t) subject := new(Subject) reporter.assertFatal(func() { ctrl.Call(subject, "NotRecordedMethod", "argument") }, "Unexpected call to", "there are no expected calls of the method \"NotRecordedMethod\" for that receiver") ctrl.Finish() } func TestNoRecordedMatchingMethodNameForAReceiver(t *testing.T) { reporter, ctrl := createFixtures(t) subject := new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument") reporter.assertFatal(func() { ctrl.Call(subject, "NotRecordedMethod", "argument") }, "Unexpected call to", "there are no expected calls of the method \"NotRecordedMethod\" for that receiver") reporter.assertFatal(func() { // The expected call wasn't made. ctrl.Finish() }) } // This tests that a call with an arguments of some primitive type matches a recorded call. func TestExpectedMethodCall(t *testing.T) { reporter, ctrl := createFixtures(t) subject := new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument") ctrl.Call(subject, "FooMethod", "argument") ctrl.Finish() reporter.assertPass("Expected method call made.") } func TestUnexpectedMethodCall(t *testing.T) { reporter, ctrl := createFixtures(t) subject := new(Subject) reporter.assertFatal(func() { ctrl.Call(subject, "FooMethod", "argument") }) ctrl.Finish() } func TestRepeatedCall(t *testing.T) { reporter, ctrl := createFixtures(t) subject := new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument").Times(3) ctrl.Call(subject, "FooMethod", "argument") ctrl.Call(subject, "FooMethod", "argument") ctrl.Call(subject, "FooMethod", "argument") reporter.assertPass("After expected repeated method calls.") reporter.assertFatal(func() { ctrl.Call(subject, "FooMethod", "argument") }) ctrl.Finish() reporter.assertFail("After calling one too many times.") } func TestUnexpectedArgCount(t *testing.T) { reporter, ctrl := createFixtures(t) defer reporter.recoverUnexpectedFatal() subject := new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument") reporter.assertFatal(func() { // This call is made with the wrong number of arguments... ctrl.Call(subject, "FooMethod", "argument", "extra_argument") }, "Unexpected call to", "wrong number of arguments", "Got: 2, want: 1") reporter.assertFatal(func() { // ... so is this. ctrl.Call(subject, "FooMethod") }, "Unexpected call to", "wrong number of arguments", "Got: 0, want: 1") reporter.assertFatal(func() { // The expected call wasn't made. ctrl.Finish() }) } // This tests that a call with complex arguments (a struct and some primitive type) matches a recorded call. func TestExpectedMethodCall_CustomStruct(t *testing.T) { reporter, ctrl := createFixtures(t) subject := new(Subject) expectedArg0 := TestStruct{Number: 123, Message: "hello"} ctrl.RecordCall(subject, "ActOnTestStructMethod", expectedArg0, 15) ctrl.Call(subject, "ActOnTestStructMethod", expectedArg0, 15) reporter.assertPass("Expected method call made.") } func TestUnexpectedArgValue_FirstArg(t *testing.T) { reporter, ctrl := createFixtures(t) defer reporter.recoverUnexpectedFatal() subject := new(Subject) expectedArg0 := TestStruct{Number: 123, Message: "hello %s"} ctrl.RecordCall(subject, "ActOnTestStructMethod", expectedArg0, 15) reporter.assertFatal(func() { // the method argument (of TestStruct type) has 1 unexpected value (for the Message field) ctrl.Call(subject, "ActOnTestStructMethod", TestStruct{Number: 123, Message: "no message"}, 15) }, "Unexpected call to", "doesn't match the argument at index 0", "Got: {123 no message} (gomock_test.TestStruct)\nWant: is equal to {123 hello %s} (gomock_test.TestStruct)") reporter.assertFatal(func() { // the method argument (of TestStruct type) has 2 unexpected values (for both fields) ctrl.Call(subject, "ActOnTestStructMethod", TestStruct{Number: 11, Message: "no message"}, 15) }, "Unexpected call to", "doesn't match the argument at index 0", "Got: {11 no message} (gomock_test.TestStruct)\nWant: is equal to {123 hello %s} (gomock_test.TestStruct)") reporter.assertFatal(func() { // The expected call wasn't made. ctrl.Finish() }) } func TestUnexpectedArgValue_SecondArg(t *testing.T) { reporter, ctrl := createFixtures(t) defer reporter.recoverUnexpectedFatal() subject := new(Subject) expectedArg0 := TestStruct{Number: 123, Message: "hello"} ctrl.RecordCall(subject, "ActOnTestStructMethod", expectedArg0, 15) reporter.assertFatal(func() { ctrl.Call(subject, "ActOnTestStructMethod", TestStruct{Number: 123, Message: "hello"}, 3) }, "Unexpected call to", "doesn't match the argument at index 1", "Got: 3 (int)\nWant: is equal to 15 (int)") reporter.assertFatal(func() { // The expected call wasn't made. ctrl.Finish() }) } func TestUnexpectedArgValue_WantFormatter(t *testing.T) { reporter, ctrl := createFixtures(t) defer reporter.recoverUnexpectedFatal() subject := new(Subject) expectedArg0 := TestStruct{Number: 123, Message: "hello"} ctrl.RecordCall( subject, "ActOnTestStructMethod", expectedArg0, gomock.WantFormatter( gomock.StringerFunc(func() string { return "is equal to fifteen" }), gomock.Eq(15), ), ) reporter.assertFatal(func() { ctrl.Call(subject, "ActOnTestStructMethod", TestStruct{Number: 123, Message: "hello"}, 3) }, "Unexpected call to", "doesn't match the argument at index 1", "Got: 3 (int)\nWant: is equal to fifteen") reporter.assertFatal(func() { // The expected call wasn't made. ctrl.Finish() }) } func TestUnexpectedArgValue_GotFormatter(t *testing.T) { reporter, ctrl := createFixtures(t) defer reporter.recoverUnexpectedFatal() subject := new(Subject) expectedArg0 := TestStruct{Number: 123, Message: "hello"} ctrl.RecordCall( subject, "ActOnTestStructMethod", expectedArg0, gomock.GotFormatterAdapter( gomock.GotFormatterFunc(func(i interface{}) string { // Leading 0s return fmt.Sprintf("%02d", i) }), gomock.Eq(15), ), ) reporter.assertFatal(func() { ctrl.Call(subject, "ActOnTestStructMethod", TestStruct{Number: 123, Message: "hello"}, 3) }, "Unexpected call to", "doesn't match the argument at index 1", "Got: 03\nWant: is equal to 15") reporter.assertFatal(func() { // The expected call wasn't made. ctrl.Finish() }) } func TestAnyTimes(t *testing.T) { reporter, ctrl := createFixtures(t) subject := new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument").AnyTimes() for i := 0; i < 100; i++ { ctrl.Call(subject, "FooMethod", "argument") } reporter.assertPass("After 100 method calls.") ctrl.Finish() } func TestMinTimes1(t *testing.T) { // It fails if there are no calls reporter, ctrl := createFixtures(t) subject := new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument").MinTimes(1) reporter.assertFatal(func() { ctrl.Finish() }) // It succeeds if there is one call _, ctrl = createFixtures(t) subject = new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument").MinTimes(1) ctrl.Call(subject, "FooMethod", "argument") ctrl.Finish() // It succeeds if there are many calls _, ctrl = createFixtures(t) subject = new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument").MinTimes(1) for i := 0; i < 100; i++ { ctrl.Call(subject, "FooMethod", "argument") } ctrl.Finish() } func TestMaxTimes1(t *testing.T) { // It succeeds if there are no calls _, ctrl := createFixtures(t) subject := new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument").MaxTimes(1) ctrl.Finish() // It succeeds if there is one call _, ctrl = createFixtures(t) subject = new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument").MaxTimes(1) ctrl.Call(subject, "FooMethod", "argument") ctrl.Finish() // It fails if there are more reporter, ctrl := createFixtures(t) subject = new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument").MaxTimes(1) ctrl.Call(subject, "FooMethod", "argument") reporter.assertFatal(func() { ctrl.Call(subject, "FooMethod", "argument") }) ctrl.Finish() } func TestMinMaxTimes(t *testing.T) { // It fails if there are less calls than specified reporter, ctrl := createFixtures(t) subject := new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument").MinTimes(2).MaxTimes(2) ctrl.Call(subject, "FooMethod", "argument") reporter.assertFatal(func() { ctrl.Finish() }) // It fails if there are more calls than specified reporter, ctrl = createFixtures(t) subject = new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument").MinTimes(2).MaxTimes(2) ctrl.Call(subject, "FooMethod", "argument") ctrl.Call(subject, "FooMethod", "argument") reporter.assertFatal(func() { ctrl.Call(subject, "FooMethod", "argument") }) // It succeeds if there is just the right number of calls _, ctrl = createFixtures(t) subject = new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument").MaxTimes(2).MinTimes(2) ctrl.Call(subject, "FooMethod", "argument") ctrl.Call(subject, "FooMethod", "argument") ctrl.Finish() // If MaxTimes is called after MinTimes is called with 1, MaxTimes takes precedence. reporter, ctrl = createFixtures(t) subject = new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument").MinTimes(1).MaxTimes(2) ctrl.Call(subject, "FooMethod", "argument") ctrl.Call(subject, "FooMethod", "argument") reporter.assertFatal(func() { ctrl.Call(subject, "FooMethod", "argument") }) // If MinTimes is called after MaxTimes is called with 1, MinTimes takes precedence. _, ctrl = createFixtures(t) subject = new(Subject) ctrl.RecordCall(subject, "FooMethod", "argument").MaxTimes(1).MinTimes(2) for i := 0; i < 100; i++ { ctrl.Call(subject, "FooMethod", "argument") } ctrl.Finish() } func TestDo(t *testing.T) { _, ctrl := createFixtures(t) subject := new(Subject) doCalled := false var argument string wantArg := "argument" ctrl.RecordCall(subject, "FooMethod", wantArg).Do( func(arg string) { doCalled = true argument = arg }) if doCalled { t.Error("Do() callback called too early.") } ctrl.Call(subject, "FooMethod", wantArg) if !doCalled { t.Error("Do() callback not called.") } if wantArg != argument { t.Error("Do callback received wrong argument.") } ctrl.Finish() } func TestDoAndReturn(t *testing.T) { _, ctrl := createFixtures(t) subject := new(Subject) doCalled := false var argument string wantArg := "argument" ctrl.RecordCall(subject, "FooMethod", wantArg).DoAndReturn( func(arg string) int { doCalled = true argument = arg return 5 }) if doCalled { t.Error("Do() callback called too early.") } rets := ctrl.Call(subject, "FooMethod", wantArg) if !doCalled { t.Error("Do() callback not called.") } if wantArg != argument { t.Error("Do callback received wrong argument.") } if len(rets) != 1 { t.Fatalf("Return values from Call: got %d, want 1", len(rets)) } if ret, ok := rets[0].(int); !ok { t.Fatalf("Return value is not an int") } else if ret != 5 { t.Errorf("DoAndReturn return value: got %d, want 5", ret) } ctrl.Finish() } func TestSetArgSlice(t *testing.T) { _, ctrl := createFixtures(t) subject := new(Subject) var in = []byte{4, 5, 6} var set = []byte{1, 2, 3} ctrl.RecordCall(subject, "SetArgMethod", in, nil, nil).SetArg(0, set) ctrl.Call(subject, "SetArgMethod", in, nil, nil) if !reflect.DeepEqual(in, set) { t.Error("Expected SetArg() to modify input slice argument") } ctrl.RecordCall(subject, "SetArgMethodInterface", in, nil, nil).SetArg(0, set) ctrl.Call(subject, "SetArgMethodInterface", in, nil, nil) if !reflect.DeepEqual(in, set) { t.Error("Expected SetArg() to modify input slice argument as interface{}") } ctrl.Finish() } func TestSetArgMap(t *testing.T) { _, ctrl := createFixtures(t) subject := new(Subject) var in = map[interface{}]interface{}{"int": 1, "string": "random string", 1: "1", 0: 0} var set = map[interface{}]interface{}{"int": 2, 1: "2", 2: 100} ctrl.RecordCall(subject, "SetArgMethod", nil, nil, in).SetArg(2, set) ctrl.Call(subject, "SetArgMethod", nil, nil, in) if !reflect.DeepEqual(in, set) { t.Error("Expected SetArg() to modify input map argument") } ctrl.RecordCall(subject, "SetArgMethodInterface", nil, nil, in).SetArg(2, set) ctrl.Call(subject, "SetArgMethodInterface", nil, nil, in) if !reflect.DeepEqual(in, set) { t.Error("Expected SetArg() to modify input map argument as interface{}") } ctrl.Finish() } func TestSetArgPtr(t *testing.T) { _, ctrl := createFixtures(t) subject := new(Subject) var in int = 43 const set = 42 ctrl.RecordCall(subject, "SetArgMethod", nil, &in, nil).SetArg(1, set) ctrl.Call(subject, "SetArgMethod", nil, &in, nil) if in != set { t.Error("Expected SetArg() to modify value pointed to by argument") } ctrl.RecordCall(subject, "SetArgMethodInterface", nil, &in, nil).SetArg(1, set) ctrl.Call(subject, "SetArgMethodInterface", nil, &in, nil) if in != set { t.Error("Expected SetArg() to modify value pointed to by argument as interface{}") } ctrl.Finish() } func TestReturn(t *testing.T) { _, ctrl := createFixtures(t) subject := new(Subject) // Unspecified return should produce "zero" result. ctrl.RecordCall(subject, "FooMethod", "zero") ctrl.RecordCall(subject, "FooMethod", "five").Return(5) assertEqual( t, []interface{}{0}, ctrl.Call(subject, "FooMethod", "zero")) assertEqual( t, []interface{}{5}, ctrl.Call(subject, "FooMethod", "five")) ctrl.Finish() } func TestUnorderedCalls(t *testing.T) { reporter, ctrl := createFixtures(t) defer reporter.recoverUnexpectedFatal() subjectTwo := new(Subject) subjectOne := new(Subject) ctrl.RecordCall(subjectOne, "FooMethod", "1") ctrl.RecordCall(subjectOne, "BarMethod", "2") ctrl.RecordCall(subjectTwo, "FooMethod", "3") ctrl.RecordCall(subjectTwo, "BarMethod", "4") // Make the calls in a different order, which should be fine. ctrl.Call(subjectOne, "BarMethod", "2") ctrl.Call(subjectTwo, "FooMethod", "3") ctrl.Call(subjectTwo, "BarMethod", "4") ctrl.Call(subjectOne, "FooMethod", "1") reporter.assertPass("After making all calls in different order") ctrl.Finish() reporter.assertPass("After finish") } func commonTestOrderedCalls(t *testing.T) (reporter *ErrorReporter, ctrl *gomock.Controller, subjectOne, subjectTwo *Subject) { reporter, ctrl = createFixtures(t) subjectOne = new(Subject) subjectTwo = new(Subject) gomock.InOrder( ctrl.RecordCall(subjectOne, "FooMethod", "1").AnyTimes(), ctrl.RecordCall(subjectTwo, "FooMethod", "2"), ctrl.RecordCall(subjectTwo, "BarMethod", "3"), ) return } func TestOrderedCallsCorrect(t *testing.T) { reporter, ctrl, subjectOne, subjectTwo := commonTestOrderedCalls(t) ctrl.Call(subjectOne, "FooMethod", "1") ctrl.Call(subjectTwo, "FooMethod", "2") ctrl.Call(subjectTwo, "BarMethod", "3") ctrl.Finish() reporter.assertPass("After finish") } func TestPanicOverridesExpectationChecks(t *testing.T) { ctrl := gomock.NewController(t) reporter := NewErrorReporter(t) reporter.assertFatal(func() { ctrl.RecordCall(new(Subject), "FooMethod", "1") defer ctrl.Finish() reporter.Fatalf("Intentional panic") }) } func TestSetArgWithBadType(t *testing.T) { rep, ctrl := createFixtures(t) defer ctrl.Finish() s := new(Subject) // This should catch a type error: rep.assertFatal(func() { ctrl.RecordCall(s, "FooMethod", "1").SetArg(0, "blah") }) ctrl.Call(s, "FooMethod", "1") } func TestTimes0(t *testing.T) { rep, ctrl := createFixtures(t) defer ctrl.Finish() s := new(Subject) ctrl.RecordCall(s, "FooMethod", "arg").Times(0) rep.assertFatal(func() { ctrl.Call(s, "FooMethod", "arg") }) } func TestVariadicMatching(t *testing.T) { rep, ctrl := createFixtures(t) defer rep.recoverUnexpectedFatal() s := new(Subject) ctrl.RecordCall(s, "VariadicMethod", 0, "1", "2") ctrl.Call(s, "VariadicMethod", 0, "1", "2") ctrl.Finish() rep.assertPass("variadic matching works") } func TestVariadicNoMatch(t *testing.T) { rep, ctrl := createFixtures(t) defer rep.recoverUnexpectedFatal() s := new(Subject) ctrl.RecordCall(s, "VariadicMethod", 0) rep.assertFatal(func() { ctrl.Call(s, "VariadicMethod", 1) }, "expected call at", "doesn't match the argument at index 0", "Got: 1 (int)\nWant: is equal to 0 (int)") ctrl.Call(s, "VariadicMethod", 0) ctrl.Finish() } func TestVariadicMatchingWithSlice(t *testing.T) { testCases := [][]string{ {"1"}, {"1", "2"}, } for _, tc := range testCases { t.Run(fmt.Sprintf("%d arguments", len(tc)), func(t *testing.T) { rep, ctrl := createFixtures(t) defer rep.recoverUnexpectedFatal() s := new(Subject) ctrl.RecordCall(s, "VariadicMethod", 1, tc) args := make([]interface{}, len(tc)+1) args[0] = 1 for i, arg := range tc { args[i+1] = arg } ctrl.Call(s, "VariadicMethod", args...) ctrl.Finish() rep.assertPass("slices can be used as matchers for variadic arguments") }) } } func TestVariadicArgumentsGotFormatter(t *testing.T) { rep, ctrl := createFixtures(t) defer rep.recoverUnexpectedFatal() s := new(Subject) ctrl.RecordCall( s, "VariadicMethod", gomock.GotFormatterAdapter( gomock.GotFormatterFunc(func(i interface{}) string { return fmt.Sprintf("test{%v}", i) }), gomock.Eq(0), ), ) rep.assertFatal(func() { ctrl.Call(s, "VariadicMethod", 1) }, "expected call to", "doesn't match the argument at index 0", "Got: test{1}\nWant: is equal to 0") ctrl.Call(s, "VariadicMethod", 0) ctrl.Finish() } func TestVariadicArgumentsGotFormatterTooManyArgsFailure(t *testing.T) { rep, ctrl := createFixtures(t) defer rep.recoverUnexpectedFatal() s := new(Subject) ctrl.RecordCall( s, "VariadicMethod", 0, gomock.GotFormatterAdapter( gomock.GotFormatterFunc(func(i interface{}) string { return fmt.Sprintf("test{%v}", i) }), gomock.Eq("1"), ), ) rep.assertFatal(func() { ctrl.Call(s, "VariadicMethod", 0, "2", "3") }, "expected call to", "doesn't match the argument at index 1", "Got: test{[2 3]}\nWant: is equal to 1") ctrl.Call(s, "VariadicMethod", 0, "1") ctrl.Finish() } func TestNoHelper(t *testing.T) { ctrlNoHelper := gomock.NewController(NewErrorReporter(t)) // doesn't panic ctrlNoHelper.T.Helper() } func TestWithHelper(t *testing.T) { withHelper := &HelperReporter{TestReporter: NewErrorReporter(t)} ctrlWithHelper := gomock.NewController(withHelper) ctrlWithHelper.T.Helper() if withHelper.helper == 0 { t.Fatal("expected Helper to be invoked") } } func (e *ErrorReporter) Cleanup(f func()) { e.t.Helper() e.t.Cleanup(f) } func TestMultipleDefers(t *testing.T) { reporter := NewErrorReporter(t) reporter.Cleanup(func() { reporter.assertPass("No errors for multiple calls to Finish") }) ctrl := gomock.NewController(reporter) ctrl.Finish() } // Equivalent to the TestNoRecordedCallsForAReceiver, but without explicitly // calling Finish. func TestDeferNotNeededFail(t *testing.T) { reporter := NewErrorReporter(t) subject := new(Subject) var ctrl *gomock.Controller reporter.Cleanup(func() { reporter.assertFatal(func() { ctrl.Call(subject, "NotRecordedMethod", "argument") }, "Unexpected call to", "there are no expected calls of the method \"NotRecordedMethod\" for that receiver") }) ctrl = gomock.NewController(reporter) } func TestDeferNotNeededPass(t *testing.T) { reporter := NewErrorReporter(t) subject := new(Subject) var ctrl *gomock.Controller reporter.Cleanup(func() { reporter.assertPass("Expected method call made.") }) ctrl = gomock.NewController(reporter) ctrl.RecordCall(subject, "FooMethod", "argument") ctrl.Call(subject, "FooMethod", "argument") } func TestOrderedCallsInCorrect(t *testing.T) { reporter := NewErrorReporter(t) subjectOne := new(Subject) subjectTwo := new(Subject) var ctrl *gomock.Controller reporter.Cleanup(func() { reporter.assertFatal(func() { gomock.InOrder( ctrl.RecordCall(subjectOne, "FooMethod", "1").AnyTimes(), ctrl.RecordCall(subjectTwo, "FooMethod", "2"), ctrl.RecordCall(subjectTwo, "BarMethod", "3"), ) ctrl.Call(subjectOne, "FooMethod", "1") // FooMethod(2) should be called before BarMethod(3) ctrl.Call(subjectTwo, "BarMethod", "3") }, "Unexpected call to", "Subject.BarMethod([3])", "doesn't have a prerequisite call satisfied") }) ctrl = gomock.NewController(reporter) } // Test that calls that are prerequisites to other calls but have maxCalls > // minCalls are removed from the expected call set. func TestOrderedCallsWithPreReqMaxUnbounded(t *testing.T) { reporter := NewErrorReporter(t) subjectOne := new(Subject) subjectTwo := new(Subject) var ctrl *gomock.Controller reporter.Cleanup(func() { reporter.assertFatal(func() { // Initially we should be able to call FooMethod("1") as many times as we // want. ctrl.Call(subjectOne, "FooMethod", "1") ctrl.Call(subjectOne, "FooMethod", "1") // But calling something that has it as a prerequite should remove it from // the expected call set. This allows tests to ensure that FooMethod("1") is // *not* called after FooMethod("2"). ctrl.Call(subjectTwo, "FooMethod", "2") ctrl.Call(subjectOne, "FooMethod", "1") }) }) ctrl = gomock.NewController(reporter) } func TestCallAfterLoopPanic(t *testing.T) { reporter := NewErrorReporter(t) subject := new(Subject) var ctrl *gomock.Controller reporter.Cleanup(func() { firstCall := ctrl.RecordCall(subject, "FooMethod", "1") secondCall := ctrl.RecordCall(subject, "FooMethod", "2") thirdCall := ctrl.RecordCall(subject, "FooMethod", "3") gomock.InOrder(firstCall, secondCall, thirdCall) defer func() { err := recover() if err == nil { t.Error("Call.After creation of dependency loop did not panic.") } }() // This should panic due to dependency loop. firstCall.After(thirdCall) }) ctrl = gomock.NewController(reporter) } ================================================ FILE: gomock/doc.go ================================================ // Copyright 2022 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // Package gomock is a mock framework for Go. // // Standard usage: // (1) Define an interface that you wish to mock. // type MyInterface interface { // SomeMethod(x int64, y string) // } // (2) Use mockgen to generate a mock from the interface. // (3) Use the mock in a test: // func TestMyThing(t *testing.T) { // mockCtrl := gomock.NewController(t)// // mockObj := something.NewMockMyInterface(mockCtrl) // mockObj.EXPECT().SomeMethod(4, "blah") // // pass mockObj to a real object and play with it. // } // // By default, expected calls are not enforced to run in any particular order. // Call order dependency can be enforced by use of InOrder and/or Call.After. // Call.After can create more varied call order dependencies, but InOrder is // often more convenient. // // The following examples create equivalent call order dependencies. // // Example of using Call.After to chain expected call order: // // firstCall := mockObj.EXPECT().SomeMethod(1, "first") // secondCall := mockObj.EXPECT().SomeMethod(2, "second").After(firstCall) // mockObj.EXPECT().SomeMethod(3, "third").After(secondCall) // // Example of using InOrder to declare expected call order: // // gomock.InOrder( // mockObj.EXPECT().SomeMethod(1, "first"), // mockObj.EXPECT().SomeMethod(2, "second"), // mockObj.EXPECT().SomeMethod(3, "third"), // ) // // The standard TestReporter most users will pass to `NewController` is a // `*testing.T` from the context of the test. Note that this will use the // standard `t.Error` and `t.Fatal` methods to report what happened in the test. // In some cases this can leave your testing package in a weird state if global // state is used since `t.Fatal` is like calling panic in the middle of a // function. In these cases it is recommended that you pass in your own // `TestReporter`. package gomock ================================================ FILE: gomock/example_test.go ================================================ package gomock_test //go:generate mockgen -destination mock_test.go -package gomock_test -source example_test.go import ( "fmt" "testing" "time" "github.com/golang/mock/gomock" ) type Foo interface { Bar(string) string } func ExampleCall_DoAndReturn_latency() { t := &testing.T{} // provided by test ctrl := gomock.NewController(t) mockIndex := NewMockFoo(ctrl) mockIndex.EXPECT().Bar(gomock.Any()).DoAndReturn( func(arg string) string { time.Sleep(1 * time.Millisecond) return "I'm sleepy" }, ) r := mockIndex.Bar("foo") fmt.Println(r) // Output: I'm sleepy } func ExampleCall_DoAndReturn_captureArguments() { t := &testing.T{} // provided by test ctrl := gomock.NewController(t) mockIndex := NewMockFoo(ctrl) var s string mockIndex.EXPECT().Bar(gomock.AssignableToTypeOf(s)).DoAndReturn( func(arg string) interface{} { s = arg return "I'm sleepy" }, ) r := mockIndex.Bar("foo") fmt.Printf("%s %s", r, s) // Output: I'm sleepy foo } ================================================ FILE: gomock/internal/mock_gomock/mock_matcher.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: github.com/golang/mock/gomock (interfaces: Matcher) // Package mock_gomock is a generated GoMock package. package mock_gomock import ( reflect "reflect" gomock "github.com/golang/mock/gomock" ) // MockMatcher is a mock of Matcher interface. type MockMatcher struct { ctrl *gomock.Controller recorder *MockMatcherMockRecorder } // MockMatcherMockRecorder is the mock recorder for MockMatcher. type MockMatcherMockRecorder struct { mock *MockMatcher } // NewMockMatcher creates a new mock instance. func NewMockMatcher(ctrl *gomock.Controller) *MockMatcher { mock := &MockMatcher{ctrl: ctrl} mock.recorder = &MockMatcherMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockMatcher) EXPECT() *MockMatcherMockRecorder { return m.recorder } // Matches mocks base method. func (m *MockMatcher) Matches(arg0 interface{}) bool { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Matches", arg0) ret0, _ := ret[0].(bool) return ret0 } // Matches indicates an expected call of Matches. func (mr *MockMatcherMockRecorder) Matches(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Matches", reflect.TypeOf((*MockMatcher)(nil).Matches), arg0) } // String mocks base method. func (m *MockMatcher) String() string { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "String") ret0, _ := ret[0].(string) return ret0 } // String indicates an expected call of String. func (mr *MockMatcherMockRecorder) String() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "String", reflect.TypeOf((*MockMatcher)(nil).String)) } ================================================ FILE: gomock/matchers.go ================================================ // Copyright 2010 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package gomock import ( "fmt" "reflect" "strings" ) // A Matcher is a representation of a class of values. // It is used to represent the valid or expected arguments to a mocked method. type Matcher interface { // Matches returns whether x is a match. Matches(x interface{}) bool // String describes what the matcher matches. String() string } // WantFormatter modifies the given Matcher's String() method to the given // Stringer. This allows for control on how the "Want" is formatted when // printing . func WantFormatter(s fmt.Stringer, m Matcher) Matcher { type matcher interface { Matches(x interface{}) bool } return struct { matcher fmt.Stringer }{ matcher: m, Stringer: s, } } // StringerFunc type is an adapter to allow the use of ordinary functions as // a Stringer. If f is a function with the appropriate signature, // StringerFunc(f) is a Stringer that calls f. type StringerFunc func() string // String implements fmt.Stringer. func (f StringerFunc) String() string { return f() } // GotFormatter is used to better print failure messages. If a matcher // implements GotFormatter, it will use the result from Got when printing // the failure message. type GotFormatter interface { // Got is invoked with the received value. The result is used when // printing the failure message. Got(got interface{}) string } // GotFormatterFunc type is an adapter to allow the use of ordinary // functions as a GotFormatter. If f is a function with the appropriate // signature, GotFormatterFunc(f) is a GotFormatter that calls f. type GotFormatterFunc func(got interface{}) string // Got implements GotFormatter. func (f GotFormatterFunc) Got(got interface{}) string { return f(got) } // GotFormatterAdapter attaches a GotFormatter to a Matcher. func GotFormatterAdapter(s GotFormatter, m Matcher) Matcher { return struct { GotFormatter Matcher }{ GotFormatter: s, Matcher: m, } } type anyMatcher struct{} func (anyMatcher) Matches(interface{}) bool { return true } func (anyMatcher) String() string { return "is anything" } type eqMatcher struct { x interface{} } func (e eqMatcher) Matches(x interface{}) bool { // In case, some value is nil if e.x == nil || x == nil { return reflect.DeepEqual(e.x, x) } // Check if types assignable and convert them to common type x1Val := reflect.ValueOf(e.x) x2Val := reflect.ValueOf(x) if x1Val.Type().AssignableTo(x2Val.Type()) { x1ValConverted := x1Val.Convert(x2Val.Type()) return reflect.DeepEqual(x1ValConverted.Interface(), x2Val.Interface()) } return false } func (e eqMatcher) String() string { return fmt.Sprintf("is equal to %v (%T)", e.x, e.x) } type nilMatcher struct{} func (nilMatcher) Matches(x interface{}) bool { if x == nil { return true } v := reflect.ValueOf(x) switch v.Kind() { case reflect.Chan, reflect.Func, reflect.Interface, reflect.Map, reflect.Ptr, reflect.Slice: return v.IsNil() } return false } func (nilMatcher) String() string { return "is nil" } type notMatcher struct { m Matcher } func (n notMatcher) Matches(x interface{}) bool { return !n.m.Matches(x) } func (n notMatcher) String() string { return "not(" + n.m.String() + ")" } type assignableToTypeOfMatcher struct { targetType reflect.Type } func (m assignableToTypeOfMatcher) Matches(x interface{}) bool { return reflect.TypeOf(x).AssignableTo(m.targetType) } func (m assignableToTypeOfMatcher) String() string { return "is assignable to " + m.targetType.Name() } type allMatcher struct { matchers []Matcher } func (am allMatcher) Matches(x interface{}) bool { for _, m := range am.matchers { if !m.Matches(x) { return false } } return true } func (am allMatcher) String() string { ss := make([]string, 0, len(am.matchers)) for _, matcher := range am.matchers { ss = append(ss, matcher.String()) } return strings.Join(ss, "; ") } type lenMatcher struct { i int } func (m lenMatcher) Matches(x interface{}) bool { v := reflect.ValueOf(x) switch v.Kind() { case reflect.Array, reflect.Chan, reflect.Map, reflect.Slice, reflect.String: return v.Len() == m.i default: return false } } func (m lenMatcher) String() string { return fmt.Sprintf("has length %d", m.i) } type inAnyOrderMatcher struct { x interface{} } func (m inAnyOrderMatcher) Matches(x interface{}) bool { given, ok := m.prepareValue(x) if !ok { return false } wanted, ok := m.prepareValue(m.x) if !ok { return false } if given.Len() != wanted.Len() { return false } usedFromGiven := make([]bool, given.Len()) foundFromWanted := make([]bool, wanted.Len()) for i := 0; i < wanted.Len(); i++ { wantedMatcher := Eq(wanted.Index(i).Interface()) for j := 0; j < given.Len(); j++ { if usedFromGiven[j] { continue } if wantedMatcher.Matches(given.Index(j).Interface()) { foundFromWanted[i] = true usedFromGiven[j] = true break } } } missingFromWanted := 0 for _, found := range foundFromWanted { if !found { missingFromWanted++ } } extraInGiven := 0 for _, used := range usedFromGiven { if !used { extraInGiven++ } } return extraInGiven == 0 && missingFromWanted == 0 } func (m inAnyOrderMatcher) prepareValue(x interface{}) (reflect.Value, bool) { xValue := reflect.ValueOf(x) switch xValue.Kind() { case reflect.Slice, reflect.Array: return xValue, true default: return reflect.Value{}, false } } func (m inAnyOrderMatcher) String() string { return fmt.Sprintf("has the same elements as %v", m.x) } // Constructors // All returns a composite Matcher that returns true if and only all of the // matchers return true. func All(ms ...Matcher) Matcher { return allMatcher{ms} } // Any returns a matcher that always matches. func Any() Matcher { return anyMatcher{} } // Eq returns a matcher that matches on equality. // // Example usage: // Eq(5).Matches(5) // returns true // Eq(5).Matches(4) // returns false func Eq(x interface{}) Matcher { return eqMatcher{x} } // Len returns a matcher that matches on length. This matcher returns false if // is compared to a type that is not an array, chan, map, slice, or string. func Len(i int) Matcher { return lenMatcher{i} } // Nil returns a matcher that matches if the received value is nil. // // Example usage: // var x *bytes.Buffer // Nil().Matches(x) // returns true // x = &bytes.Buffer{} // Nil().Matches(x) // returns false func Nil() Matcher { return nilMatcher{} } // Not reverses the results of its given child matcher. // // Example usage: // Not(Eq(5)).Matches(4) // returns true // Not(Eq(5)).Matches(5) // returns false func Not(x interface{}) Matcher { if m, ok := x.(Matcher); ok { return notMatcher{m} } return notMatcher{Eq(x)} } // AssignableToTypeOf is a Matcher that matches if the parameter to the mock // function is assignable to the type of the parameter to this function. // // Example usage: // var s fmt.Stringer = &bytes.Buffer{} // AssignableToTypeOf(s).Matches(time.Second) // returns true // AssignableToTypeOf(s).Matches(99) // returns false // // var ctx = reflect.TypeOf((*context.Context)(nil)).Elem() // AssignableToTypeOf(ctx).Matches(context.Background()) // returns true func AssignableToTypeOf(x interface{}) Matcher { if xt, ok := x.(reflect.Type); ok { return assignableToTypeOfMatcher{xt} } return assignableToTypeOfMatcher{reflect.TypeOf(x)} } // InAnyOrder is a Matcher that returns true for collections of the same elements ignoring the order. // // Example usage: // InAnyOrder([]int{1, 2, 3}).Matches([]int{1, 3, 2}) // returns true // InAnyOrder([]int{1, 2, 3}).Matches([]int{1, 2}) // returns false func InAnyOrder(x interface{}) Matcher { return inAnyOrderMatcher{x} } ================================================ FILE: gomock/matchers_test.go ================================================ // Copyright 2010 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package gomock_test //go:generate mockgen -destination internal/mock_gomock/mock_matcher.go github.com/golang/mock/gomock Matcher import ( "context" "errors" "reflect" "testing" "github.com/golang/mock/gomock" "github.com/golang/mock/gomock/internal/mock_gomock" ) type A []string func TestMatchers(t *testing.T) { type e interface{} tests := []struct { name string matcher gomock.Matcher yes, no []e }{ {"test Any", gomock.Any(), []e{3, nil, "foo"}, nil}, {"test All", gomock.Eq(4), []e{4}, []e{3, "blah", nil, int64(4)}}, {"test Nil", gomock.Nil(), []e{nil, (error)(nil), (chan bool)(nil), (*int)(nil)}, []e{"", 0, make(chan bool), errors.New("err"), new(int)}}, {"test Not", gomock.Not(gomock.Eq(4)), []e{3, "blah", nil, int64(4)}, []e{4}}, {"test All", gomock.All(gomock.Any(), gomock.Eq(4)), []e{4}, []e{3, "blah", nil, int64(4)}}, {"test Len", gomock.Len(2), []e{[]int{1, 2}, "ab", map[string]int{"a": 0, "b": 1}, [2]string{"a", "b"}}, []e{[]int{1}, "a", 42, 42.0, false, [1]string{"a"}}, }, {"test assignable types", gomock.Eq(A{"a", "b"}), []e{[]string{"a", "b"}, A{"a", "b"}}, []e{[]string{"a"}, A{"b"}}, }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { for _, x := range tt.yes { if !tt.matcher.Matches(x) { t.Errorf(`"%v %s": got false, want true.`, x, tt.matcher) } } for _, x := range tt.no { if tt.matcher.Matches(x) { t.Errorf(`"%v %s": got true, want false.`, x, tt.matcher) } } }) } } // A more thorough test of notMatcher func TestNotMatcher(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() mockMatcher := mock_gomock.NewMockMatcher(ctrl) notMatcher := gomock.Not(mockMatcher) mockMatcher.EXPECT().Matches(4).Return(true) if match := notMatcher.Matches(4); match { t.Errorf("notMatcher should not match 4") } mockMatcher.EXPECT().Matches(5).Return(false) if match := notMatcher.Matches(5); !match { t.Errorf("notMatcher should match 5") } } type Dog struct { Breed, Name string } type ctxKey struct{} // A thorough test of assignableToTypeOfMatcher func TestAssignableToTypeOfMatcher(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() aStr := "def" anotherStr := "ghi" if match := gomock.AssignableToTypeOf("abc").Matches(4); match { t.Errorf(`AssignableToTypeOf("abc") should not match 4`) } if match := gomock.AssignableToTypeOf("abc").Matches(&aStr); match { t.Errorf(`AssignableToTypeOf("abc") should not match &aStr (*string)`) } if match := gomock.AssignableToTypeOf("abc").Matches("def"); !match { t.Errorf(`AssignableToTypeOf("abc") should match "def"`) } if match := gomock.AssignableToTypeOf(&aStr).Matches("abc"); match { t.Errorf(`AssignableToTypeOf(&aStr) should not match "abc"`) } if match := gomock.AssignableToTypeOf(&aStr).Matches(&anotherStr); !match { t.Errorf(`AssignableToTypeOf(&aStr) should match &anotherStr`) } if match := gomock.AssignableToTypeOf(0).Matches(4); !match { t.Errorf(`AssignableToTypeOf(0) should match 4`) } if match := gomock.AssignableToTypeOf(0).Matches("def"); match { t.Errorf(`AssignableToTypeOf(0) should not match "def"`) } if match := gomock.AssignableToTypeOf(Dog{}).Matches(&Dog{}); match { t.Errorf(`AssignableToTypeOf(Dog{}) should not match &Dog{}`) } if match := gomock.AssignableToTypeOf(Dog{}).Matches(Dog{Breed: "pug", Name: "Fido"}); !match { t.Errorf(`AssignableToTypeOf(Dog{}) should match Dog{Breed: "pug", Name: "Fido"}`) } if match := gomock.AssignableToTypeOf(&Dog{}).Matches(Dog{}); match { t.Errorf(`AssignableToTypeOf(&Dog{}) should not match Dog{}`) } if match := gomock.AssignableToTypeOf(&Dog{}).Matches(&Dog{Breed: "pug", Name: "Fido"}); !match { t.Errorf(`AssignableToTypeOf(&Dog{}) should match &Dog{Breed: "pug", Name: "Fido"}`) } ctxInterface := reflect.TypeOf((*context.Context)(nil)).Elem() if match := gomock.AssignableToTypeOf(ctxInterface).Matches(context.Background()); !match { t.Errorf(`AssignableToTypeOf(context.Context) should not match context.Background()`) } ctxWithValue := context.WithValue(context.Background(), ctxKey{}, "val") if match := gomock.AssignableToTypeOf(ctxInterface).Matches(ctxWithValue); !match { t.Errorf(`AssignableToTypeOf(context.Context) should not match ctxWithValue`) } } func TestInAnyOrder(t *testing.T) { tests := []struct { name string wanted interface{} given interface{} wantMatch bool }{ { name: "match for equal slices", wanted: []int{1, 2, 3}, given: []int{1, 2, 3}, wantMatch: true, }, { name: "match for slices with same elements of different order", wanted: []int{1, 2, 3}, given: []int{1, 3, 2}, wantMatch: true, }, { name: "not match for slices with different elements", wanted: []int{1, 2, 3}, given: []int{1, 2, 4}, wantMatch: false, }, { name: "not match for slices with missing elements", wanted: []int{1, 2, 3}, given: []int{1, 2}, wantMatch: false, }, { name: "not match for slices with extra elements", wanted: []int{1, 2, 3}, given: []int{1, 2, 3, 4}, wantMatch: false, }, { name: "match for empty slices", wanted: []int{}, given: []int{}, wantMatch: true, }, { name: "not match for equal slices of different types", wanted: []float64{1, 2, 3}, given: []int{1, 2, 3}, wantMatch: false, }, { name: "match for equal arrays", wanted: [3]int{1, 2, 3}, given: [3]int{1, 2, 3}, wantMatch: true, }, { name: "match for equal arrays of different order", wanted: [3]int{1, 2, 3}, given: [3]int{1, 3, 2}, wantMatch: true, }, { name: "not match for arrays of different elements", wanted: [3]int{1, 2, 3}, given: [3]int{1, 2, 4}, wantMatch: false, }, { name: "not match for arrays with extra elements", wanted: [3]int{1, 2, 3}, given: [4]int{1, 2, 3, 4}, wantMatch: false, }, { name: "not match for arrays with missing elements", wanted: [3]int{1, 2, 3}, given: [2]int{1, 2}, wantMatch: false, }, { name: "not match for equal strings", // matcher shouldn't treat strings as collections wanted: "123", given: "123", wantMatch: false, }, { name: "not match if x type is not iterable", wanted: 123, given: []int{123}, wantMatch: false, }, { name: "not match if in type is not iterable", wanted: []int{123}, given: 123, wantMatch: false, }, { name: "not match if both are not iterable", wanted: 123, given: 123, wantMatch: false, }, { name: "match for equal slices with unhashable elements", wanted: [][]int{{1}, {1, 2}, {1, 2, 3}}, given: [][]int{{1}, {1, 2}, {1, 2, 3}}, wantMatch: true, }, { name: "match for equal slices with unhashable elements of different order", wanted: [][]int{{1}, {1, 2, 3}, {1, 2}}, given: [][]int{{1}, {1, 2}, {1, 2, 3}}, wantMatch: true, }, { name: "not match for different slices with unhashable elements", wanted: [][]int{{1}, {1, 2, 3}, {1, 2}}, given: [][]int{{1}, {1, 2, 4}, {1, 3}}, wantMatch: false, }, { name: "not match for unhashable missing elements", wanted: [][]int{{1}, {1, 2}, {1, 2, 3}}, given: [][]int{{1}, {1, 2}}, wantMatch: false, }, { name: "not match for unhashable extra elements", wanted: [][]int{{1}, {1, 2}}, given: [][]int{{1}, {1, 2}, {1, 2, 3}}, wantMatch: false, }, { name: "match for equal slices of assignable types", wanted: [][]string{{"a", "b"}}, given: []A{{"a", "b"}}, wantMatch: true, }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { if got := gomock.InAnyOrder(tt.wanted).Matches(tt.given); got != tt.wantMatch { t.Errorf("got = %v, wantMatch %v", got, tt.wantMatch) } }) } } ================================================ FILE: gomock/mock_test.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: example_test.go // Package gomock_test is a generated GoMock package. package gomock_test import ( reflect "reflect" "github.com/golang/mock/gomock" ) // MockFoo is a mock of Foo interface. type MockFoo struct { ctrl *gomock.Controller recorder *MockFooMockRecorder } // MockFooMockRecorder is the mock recorder for MockFoo. type MockFooMockRecorder struct { mock *MockFoo } // NewMockFoo creates a new mock instance. func NewMockFoo(ctrl *gomock.Controller) *MockFoo { mock := &MockFoo{ctrl: ctrl} mock.recorder = &MockFooMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockFoo) EXPECT() *MockFooMockRecorder { return m.recorder } // Bar mocks base method. func (m *MockFoo) Bar(arg0 string) string { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Bar", arg0) ret0, _ := ret[0].(string) return ret0 } // Bar indicates an expected call of Bar. func (mr *MockFooMockRecorder) Bar(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Bar", reflect.TypeOf((*MockFoo)(nil).Bar), arg0) } ================================================ FILE: mockgen/generic_go118.go ================================================ // Copyright 2022 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // See the License for the specific language governing permissions and // limitations under the License. //go:build go1.18 // +build go1.18 package main import ( "go/ast" "strings" "github.com/golang/mock/mockgen/model" ) func getTypeSpecTypeParams(ts *ast.TypeSpec) []*ast.Field { if ts == nil || ts.TypeParams == nil { return nil } return ts.TypeParams.List } func (p *fileParser) parseGenericType(pkg string, typ ast.Expr, tps map[string]bool) (model.Type, error) { switch v := typ.(type) { case *ast.IndexExpr: m, err := p.parseType(pkg, v.X, tps) if err != nil { return nil, err } nm, ok := m.(*model.NamedType) if !ok { return m, nil } t, err := p.parseType(pkg, v.Index, tps) if err != nil { return nil, err } nm.TypeParams = &model.TypeParametersType{TypeParameters: []model.Type{t}} return m, nil case *ast.IndexListExpr: m, err := p.parseType(pkg, v.X, tps) if err != nil { return nil, err } nm, ok := m.(*model.NamedType) if !ok { return m, nil } var ts []model.Type for _, expr := range v.Indices { t, err := p.parseType(pkg, expr, tps) if err != nil { return nil, err } ts = append(ts, t) } nm.TypeParams = &model.TypeParametersType{TypeParameters: ts} return m, nil } return nil, nil } func getIdentTypeParams(decl interface{}) string { if decl == nil { return "" } ts, ok := decl.(*ast.TypeSpec) if !ok { return "" } if ts.TypeParams == nil || len(ts.TypeParams.List) == 0 { return "" } var sb strings.Builder sb.WriteString("[") for i, v := range ts.TypeParams.List { if i != 0 { sb.WriteString(", ") } sb.WriteString(v.Names[0].Name) } sb.WriteString("]") return sb.String() } ================================================ FILE: mockgen/generic_notgo118.go ================================================ // Copyright 2022 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. //go:build !go1.18 // +build !go1.18 package main import ( "go/ast" "github.com/golang/mock/mockgen/model" ) func getTypeSpecTypeParams(ts *ast.TypeSpec) []*ast.Field { return nil } func (p *fileParser) parseGenericType(pkg string, typ ast.Expr, tps map[string]bool) (model.Type, error) { return nil, nil } func getIdentTypeParams(decl interface{}) string { return "" } ================================================ FILE: mockgen/internal/tests/aux_imports_embedded_interface/README.md ================================================ # Embedded Interfaces in aux_files Embedded interfaces in `aux_files` generate `unknown embedded interface XXX` errors. See below for example of the problem: ```go // source import ( alias "some.org/package/imported" ) type Source interface { alias.Foreign } ``` ```go // some.org/package/imported type Foreign interface { Embedded } type Embedded interface {} ``` Attempting to generate a mock will result in an `unknown embedded interface Embedded`. The issue is that the `fileParser` stores `auxInterfaces` underneath the package name explicitly specified in the `aux_files` flag. In the `parseInterface` method, there is an incorrect assumption about an embedded interface always being in the source file. ```go case *ast.Ident: // Embedded interface in this package. ei := p.auxInterfaces[""][v.String()] if ei == nil { return nil, p.errorf(v.Pos(), "unknown embedded interface %s", v.String()) } ``` ================================================ FILE: mockgen/internal/tests/aux_imports_embedded_interface/bugreport.go ================================================ package bugreport //go:generate mockgen -aux_files faux=faux/faux.go -destination bugreport_mock.go -package bugreport -source=bugreport.go Example import ( "log" "github.com/golang/mock/mockgen/internal/tests/aux_imports_embedded_interface/faux" ) // Source is an interface w/ an embedded foreign interface type Source interface { faux.Foreign } func CallForeignMethod(s Source) { log.Println(s.Method()) } ================================================ FILE: mockgen/internal/tests/aux_imports_embedded_interface/bugreport_mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: bugreport.go // Package bugreport is a generated GoMock package. package bugreport import ( reflect "reflect" gomock "github.com/golang/mock/gomock" faux "github.com/golang/mock/mockgen/internal/tests/aux_imports_embedded_interface/faux" ) // MockSource is a mock of Source interface. type MockSource struct { ctrl *gomock.Controller recorder *MockSourceMockRecorder } // MockSourceMockRecorder is the mock recorder for MockSource. type MockSourceMockRecorder struct { mock *MockSource } // NewMockSource creates a new mock instance. func NewMockSource(ctrl *gomock.Controller) *MockSource { mock := &MockSource{ctrl: ctrl} mock.recorder = &MockSourceMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockSource) EXPECT() *MockSourceMockRecorder { return m.recorder } // Error mocks base method. func (m *MockSource) Error() string { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Error") ret0, _ := ret[0].(string) return ret0 } // Error indicates an expected call of Error. func (mr *MockSourceMockRecorder) Error() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Error", reflect.TypeOf((*MockSource)(nil).Error)) } // Method mocks base method. func (m *MockSource) Method() faux.Return { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Method") ret0, _ := ret[0].(faux.Return) return ret0 } // Method indicates an expected call of Method. func (mr *MockSourceMockRecorder) Method() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Method", reflect.TypeOf((*MockSource)(nil).Method)) } ================================================ FILE: mockgen/internal/tests/aux_imports_embedded_interface/bugreport_test.go ================================================ package bugreport import ( "testing" "github.com/golang/mock/gomock" ) // TestValidInterface assesses whether or not the generated mock is valid func TestValidInterface(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() s := NewMockSource(ctrl) s.EXPECT().Method().Return("") CallForeignMethod(s) } ================================================ FILE: mockgen/internal/tests/aux_imports_embedded_interface/faux/faux.go ================================================ package faux type Foreign interface { Method() Return Embedded error } type Embedded interface{} type Return interface{} ================================================ FILE: mockgen/internal/tests/const_array_length/input.go ================================================ package const_length import "math" //go:generate mockgen -package const_length -destination mock.go -source input.go const C = 2 type I interface { Foo() [C]int Bar() [2]int Baz() [math.MaxInt8]int Qux() [1 + 2]int Quux() [(1 + 2)]int Corge() [math.MaxInt8 - 120]int } ================================================ FILE: mockgen/internal/tests/const_array_length/mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: input.go // Package const_length is a generated GoMock package. package const_length import ( reflect "reflect" gomock "github.com/golang/mock/gomock" ) // MockI is a mock of I interface. type MockI struct { ctrl *gomock.Controller recorder *MockIMockRecorder } // MockIMockRecorder is the mock recorder for MockI. type MockIMockRecorder struct { mock *MockI } // NewMockI creates a new mock instance. func NewMockI(ctrl *gomock.Controller) *MockI { mock := &MockI{ctrl: ctrl} mock.recorder = &MockIMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockI) EXPECT() *MockIMockRecorder { return m.recorder } // Bar mocks base method. func (m *MockI) Bar() [2]int { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Bar") ret0, _ := ret[0].([2]int) return ret0 } // Bar indicates an expected call of Bar. func (mr *MockIMockRecorder) Bar() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Bar", reflect.TypeOf((*MockI)(nil).Bar)) } // Baz mocks base method. func (m *MockI) Baz() [127]int { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Baz") ret0, _ := ret[0].([127]int) return ret0 } // Baz indicates an expected call of Baz. func (mr *MockIMockRecorder) Baz() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Baz", reflect.TypeOf((*MockI)(nil).Baz)) } // Corge mocks base method. func (m *MockI) Corge() [7]int { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Corge") ret0, _ := ret[0].([7]int) return ret0 } // Corge indicates an expected call of Corge. func (mr *MockIMockRecorder) Corge() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Corge", reflect.TypeOf((*MockI)(nil).Corge)) } // Foo mocks base method. func (m *MockI) Foo() [2]int { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Foo") ret0, _ := ret[0].([2]int) return ret0 } // Foo indicates an expected call of Foo. func (mr *MockIMockRecorder) Foo() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Foo", reflect.TypeOf((*MockI)(nil).Foo)) } // Quux mocks base method. func (m *MockI) Quux() [3]int { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Quux") ret0, _ := ret[0].([3]int) return ret0 } // Quux indicates an expected call of Quux. func (mr *MockIMockRecorder) Quux() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Quux", reflect.TypeOf((*MockI)(nil).Quux)) } // Qux mocks base method. func (m *MockI) Qux() [3]int { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Qux") ret0, _ := ret[0].([3]int) return ret0 } // Qux indicates an expected call of Qux. func (mr *MockIMockRecorder) Qux() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Qux", reflect.TypeOf((*MockI)(nil).Qux)) } ================================================ FILE: mockgen/internal/tests/copyright_file/input.go ================================================ package empty_interface //go:generate mockgen -package empty_interface -destination mock.go -source input.go -copyright_file=mock_copyright_header type Empty interface{} ================================================ FILE: mockgen/internal/tests/copyright_file/mock.go ================================================ // This is a mock copyright header. // // Lorem ipsum dolor sit amet, consectetur adipiscing elit, // sed do eiusmod tempor incididunt ut labore et dolore magna // aliqua. Velit ut tortor pretium viverra suspendisse potenti. // // Code generated by MockGen. DO NOT EDIT. // Source: input.go // Package empty_interface is a generated GoMock package. package empty_interface import ( gomock "github.com/golang/mock/gomock" ) // MockEmpty is a mock of Empty interface. type MockEmpty struct { ctrl *gomock.Controller recorder *MockEmptyMockRecorder } // MockEmptyMockRecorder is the mock recorder for MockEmpty. type MockEmptyMockRecorder struct { mock *MockEmpty } // NewMockEmpty creates a new mock instance. func NewMockEmpty(ctrl *gomock.Controller) *MockEmpty { mock := &MockEmpty{ctrl: ctrl} mock.recorder = &MockEmptyMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockEmpty) EXPECT() *MockEmptyMockRecorder { return m.recorder } ================================================ FILE: mockgen/internal/tests/copyright_file/mock_copyright_header ================================================ This is a mock copyright header. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Velit ut tortor pretium viverra suspendisse potenti. ================================================ FILE: mockgen/internal/tests/custom_package_name/README.md ================================================ # Tests for custom package names This directory contains test for mockgen generating mocks when imported package name does not match import path suffix. For example, package with name "client" is located under import path "github.com/golang/mock/mockgen/internal/tests/custom_package_name/client/v1". Prior to this patch: ```bash $ go generate greeter/greeter.go 2018/03/05 22:44:52 Loading input failed: greeter.go:17:11: failed parsing returns: greeter.go:17:14: unknown package "client" greeter/greeter.go:1: running "mockgen": exit status 1 ``` This can be fixed by manually providing `-imports` flag, like `-imports client=github.com/golang/mock/mockgen/internal/tests/custom_package_name/client/v1`. But, mockgen should be able to automatically resolve package names in such situations. With this patch applied: ```bash $ go generate greeter/greeter.go $ echo $? 0 ``` Mockgen runs successfully, produced output is equal to [greeter_mock_test.go](greeter/greeter_mock_test.go) content. ================================================ FILE: mockgen/internal/tests/custom_package_name/client/v1/client.go ================================================ package client import "fmt" type Client struct{} func (c *Client) Greet(in GreetInput) string { return fmt.Sprintf("Hello, %s!", in.Name) } type GreetInput struct { Name string } ================================================ FILE: mockgen/internal/tests/custom_package_name/greeter/greeter.go ================================================ package greeter //go:generate mockgen -source greeter.go -destination greeter_mock_test.go -package greeter import ( // stdlib import "fmt" // non-matching import suffix and package name "github.com/golang/mock/mockgen/internal/tests/custom_package_name/client/v1" // matching import suffix and package name "github.com/golang/mock/mockgen/internal/tests/custom_package_name/validator" ) type InputMaker interface { MakeInput() client.GreetInput } type Greeter struct { InputMaker InputMaker Client *client.Client } func (g *Greeter) Greet() (string, error) { in := g.InputMaker.MakeInput() if err := validator.Validate(in.Name); err != nil { return "", fmt.Errorf("validation failed: %v", err) } return g.Client.Greet(in), nil } ================================================ FILE: mockgen/internal/tests/custom_package_name/greeter/greeter_mock_test.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: greeter.go // Package greeter is a generated GoMock package. package greeter import ( reflect "reflect" gomock "github.com/golang/mock/gomock" client "github.com/golang/mock/mockgen/internal/tests/custom_package_name/client/v1" ) // MockInputMaker is a mock of InputMaker interface. type MockInputMaker struct { ctrl *gomock.Controller recorder *MockInputMakerMockRecorder } // MockInputMakerMockRecorder is the mock recorder for MockInputMaker. type MockInputMakerMockRecorder struct { mock *MockInputMaker } // NewMockInputMaker creates a new mock instance. func NewMockInputMaker(ctrl *gomock.Controller) *MockInputMaker { mock := &MockInputMaker{ctrl: ctrl} mock.recorder = &MockInputMakerMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockInputMaker) EXPECT() *MockInputMakerMockRecorder { return m.recorder } // MakeInput mocks base method. func (m *MockInputMaker) MakeInput() client.GreetInput { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "MakeInput") ret0, _ := ret[0].(client.GreetInput) return ret0 } // MakeInput indicates an expected call of MakeInput. func (mr *MockInputMakerMockRecorder) MakeInput() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "MakeInput", reflect.TypeOf((*MockInputMaker)(nil).MakeInput)) } ================================================ FILE: mockgen/internal/tests/custom_package_name/greeter/greeter_test.go ================================================ package greeter import ( "testing" "github.com/golang/mock/gomock" "github.com/golang/mock/mockgen/internal/tests/custom_package_name/client/v1" ) func TestGreeter_Greet(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() input := client.GreetInput{ Name: "Foo", } inputMaker := NewMockInputMaker(ctrl) inputMaker.EXPECT(). MakeInput(). Return(input) g := &Greeter{ InputMaker: inputMaker, Client: &client.Client{}, } greeting, err := g.Greet() if err != nil { t.Fatalf("Unexpected error: %v", err) } expected := "Hello, Foo!" if greeting != expected { t.Fatalf("Expected greeting to be %v but got %v", expected, greeting) } } ================================================ FILE: mockgen/internal/tests/custom_package_name/validator/validate.go ================================================ package validator func Validate(s string) error { return nil } ================================================ FILE: mockgen/internal/tests/dot_imports/input.go ================================================ package dot_imports //go:generate mockgen -package dot_imports -destination mock.go -source input.go import ( "bytes" . "context" . "net/http" ) type WithDotImports interface { Method1() Request Method2() *bytes.Buffer Method3() Context } ================================================ FILE: mockgen/internal/tests/dot_imports/mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: input.go // Package dot_imports is a generated GoMock package. package dot_imports import ( bytes "bytes" . "context" . "net/http" reflect "reflect" gomock "github.com/golang/mock/gomock" ) // MockWithDotImports is a mock of WithDotImports interface. type MockWithDotImports struct { ctrl *gomock.Controller recorder *MockWithDotImportsMockRecorder } // MockWithDotImportsMockRecorder is the mock recorder for MockWithDotImports. type MockWithDotImportsMockRecorder struct { mock *MockWithDotImports } // NewMockWithDotImports creates a new mock instance. func NewMockWithDotImports(ctrl *gomock.Controller) *MockWithDotImports { mock := &MockWithDotImports{ctrl: ctrl} mock.recorder = &MockWithDotImportsMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockWithDotImports) EXPECT() *MockWithDotImportsMockRecorder { return m.recorder } // Method1 mocks base method. func (m *MockWithDotImports) Method1() Request { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Method1") ret0, _ := ret[0].(Request) return ret0 } // Method1 indicates an expected call of Method1. func (mr *MockWithDotImportsMockRecorder) Method1() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Method1", reflect.TypeOf((*MockWithDotImports)(nil).Method1)) } // Method2 mocks base method. func (m *MockWithDotImports) Method2() *bytes.Buffer { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Method2") ret0, _ := ret[0].(*bytes.Buffer) return ret0 } // Method2 indicates an expected call of Method2. func (mr *MockWithDotImportsMockRecorder) Method2() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Method2", reflect.TypeOf((*MockWithDotImports)(nil).Method2)) } // Method3 mocks base method. func (m *MockWithDotImports) Method3() Context { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Method3") ret0, _ := ret[0].(Context) return ret0 } // Method3 indicates an expected call of Method3. func (mr *MockWithDotImportsMockRecorder) Method3() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Method3", reflect.TypeOf((*MockWithDotImports)(nil).Method3)) } ================================================ FILE: mockgen/internal/tests/empty_interface/input.go ================================================ package empty_interface //go:generate mockgen -package empty_interface -destination mock.go -source input.go type Empty interface{} ================================================ FILE: mockgen/internal/tests/empty_interface/mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: input.go // Package empty_interface is a generated GoMock package. package empty_interface import ( gomock "github.com/golang/mock/gomock" ) // MockEmpty is a mock of Empty interface. type MockEmpty struct { ctrl *gomock.Controller recorder *MockEmptyMockRecorder } // MockEmptyMockRecorder is the mock recorder for MockEmpty. type MockEmptyMockRecorder struct { mock *MockEmpty } // NewMockEmpty creates a new mock instance. func NewMockEmpty(ctrl *gomock.Controller) *MockEmpty { mock := &MockEmpty{ctrl: ctrl} mock.recorder = &MockEmptyMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockEmpty) EXPECT() *MockEmptyMockRecorder { return m.recorder } ================================================ FILE: mockgen/internal/tests/extra_import/import.go ================================================ // Package extra_import makes sure output does not import it. See #515. package extra_import //go:generate mockgen -destination mock.go -package extra_import . Foo type Message struct { Text string } type Foo interface { Bar(channels []string, message chan<- Message) } ================================================ FILE: mockgen/internal/tests/extra_import/mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: github.com/golang/mock/mockgen/internal/tests/extra_import (interfaces: Foo) // Package extra_import is a generated GoMock package. package extra_import import ( reflect "reflect" gomock "github.com/golang/mock/gomock" ) // MockFoo is a mock of Foo interface. type MockFoo struct { ctrl *gomock.Controller recorder *MockFooMockRecorder } // MockFooMockRecorder is the mock recorder for MockFoo. type MockFooMockRecorder struct { mock *MockFoo } // NewMockFoo creates a new mock instance. func NewMockFoo(ctrl *gomock.Controller) *MockFoo { mock := &MockFoo{ctrl: ctrl} mock.recorder = &MockFooMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockFoo) EXPECT() *MockFooMockRecorder { return m.recorder } // Bar mocks base method. func (m *MockFoo) Bar(arg0 []string, arg1 chan<- Message) { m.ctrl.T.Helper() m.ctrl.Call(m, "Bar", arg0, arg1) } // Bar indicates an expected call of Bar. func (mr *MockFooMockRecorder) Bar(arg0, arg1 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Bar", reflect.TypeOf((*MockFoo)(nil).Bar), arg0, arg1) } ================================================ FILE: mockgen/internal/tests/generated_identifier_conflict/README.md ================================================ # Generated Identifier Conflict The generated mock methods use some hardcoded variable/receiver names that can have conflicts with the argument names that are defined by the code for which the mock is generated when using the source generation method. Example: ```go type Example interface { Method(_m, _mr, m, mr int) } ``` ```go // Method mocks base method func (_m *MockExample) Method(_m int, _mr int, m int, mr int) { _m.ctrl.Call(_m, "Method", _m, _mr, m, mr) } ``` In the above example one of the interface method parameters is called `_m` but unfortunately the generated receiver name is also called `_m` so the mock code won't compile. The generator has to make sure that generated identifiers (e.g.: the receiver names) are always different from the arg names that might come from external sources. ================================================ FILE: mockgen/internal/tests/generated_identifier_conflict/bugreport.go ================================================ package bugreport //go:generate mockgen -destination bugreport_mock.go -package bugreport -source=bugreport.go type Example interface { // _m and _mr were used by the buggy code: the '_' prefix was there hoping // that no one will use method argument names starting with '_' reducing // the chance of collision with generated identifiers. // m and mr are used by the bugfixed new code, the '_' prefix has been // removed because the new code generator changes the names of the // generated identifiers in case they would collide with identifiers // coming from argument names. Method(_m, _mr, m, mr int) VarargMethod(_s, _x, a, ret int, varargs ...int) } ================================================ FILE: mockgen/internal/tests/generated_identifier_conflict/bugreport_mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: bugreport.go // Package bugreport is a generated GoMock package. package bugreport import ( reflect "reflect" gomock "github.com/golang/mock/gomock" ) // MockExample is a mock of Example interface. type MockExample struct { ctrl *gomock.Controller recorder *MockExampleMockRecorder } // MockExampleMockRecorder is the mock recorder for MockExample. type MockExampleMockRecorder struct { mock *MockExample } // NewMockExample creates a new mock instance. func NewMockExample(ctrl *gomock.Controller) *MockExample { mock := &MockExample{ctrl: ctrl} mock.recorder = &MockExampleMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockExample) EXPECT() *MockExampleMockRecorder { return m.recorder } // Method mocks base method. func (m_2 *MockExample) Method(_m, _mr, m, mr int) { m_2.ctrl.T.Helper() m_2.ctrl.Call(m_2, "Method", _m, _mr, m, mr) } // Method indicates an expected call of Method. func (mr_2 *MockExampleMockRecorder) Method(_m, _mr, m, mr interface{}) *gomock.Call { mr_2.mock.ctrl.T.Helper() return mr_2.mock.ctrl.RecordCallWithMethodType(mr_2.mock, "Method", reflect.TypeOf((*MockExample)(nil).Method), _m, _mr, m, mr) } // VarargMethod mocks base method. func (m *MockExample) VarargMethod(_s, _x, a, ret int, varargs ...int) { m.ctrl.T.Helper() varargs_2 := []interface{}{_s, _x, a, ret} for _, a_2 := range varargs { varargs_2 = append(varargs_2, a_2) } m.ctrl.Call(m, "VarargMethod", varargs_2...) } // VarargMethod indicates an expected call of VarargMethod. func (mr *MockExampleMockRecorder) VarargMethod(_s, _x, a, ret interface{}, varargs ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs_2 := append([]interface{}{_s, _x, a, ret}, varargs...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "VarargMethod", reflect.TypeOf((*MockExample)(nil).VarargMethod), varargs_2...) } ================================================ FILE: mockgen/internal/tests/generated_identifier_conflict/bugreport_test.go ================================================ package bugreport import ( "github.com/golang/mock/gomock" "testing" ) func TestExample_Method(t *testing.T) { ctrl := gomock.NewController(t) m := NewMockExample(ctrl) m.EXPECT().Method(1, 2, 3, 4) m.Method(1, 2, 3, 4) ctrl.Finish() } func TestExample_VarargMethod(t *testing.T) { ctrl := gomock.NewController(t) m := NewMockExample(ctrl) m.EXPECT().VarargMethod(1, 2, 3, 4, 6, 7) m.VarargMethod(1, 2, 3, 4, 6, 7) ctrl.Finish() } ================================================ FILE: mockgen/internal/tests/generics/external.go ================================================ package generics import ( "github.com/golang/mock/mockgen/internal/tests/generics/other" "golang.org/x/exp/constraints" ) //go:generate mockgen --source=external.go --destination=source/mock_external_test.go --package source type ExternalConstraint[I constraints.Integer, F constraints.Float] interface { One(string) string Two(I) string Three(I) F Four(I) Foo[I, F] Five(I) Baz[F] Six(I) *Baz[F] Seven(I) other.One[I] Eight(F) other.Two[I, F] Nine(Iface[I]) Ten(*I) } ================================================ FILE: mockgen/internal/tests/generics/generics.go ================================================ package generics import "github.com/golang/mock/mockgen/internal/tests/generics/other" //go:generate mockgen --source=generics.go --destination=source/mock_generics_test.go --package source ////go:generate mockgen --destination=reflect/mock_test.go --package reflect . Bar,Bar2 type Bar[T any, R any] interface { One(string) string Two(T) string Three(T) R Four(T) Foo[T, R] Five(T) Baz[T] Six(T) *Baz[T] Seven(T) other.One[T] Eight(T) other.Two[T, R] Nine(Iface[T]) Ten(*T) Eleven() (*other.One[T], error) Twelve() (*other.Two[T, R], error) Thirteen() (Baz[StructType], error) Fourteen() (*Foo[StructType, StructType2], error) Fifteen() (Iface[StructType], error) Sixteen() (Baz[other.Three], error) Seventeen() (*Foo[other.Three, other.Four], error) Eighteen() (Iface[*other.Five], error) Nineteen() AliasType } type Foo[T any, R any] struct{} type Baz[T any] struct{} type Iface[T any] interface{} type StructType struct{} type StructType2 struct{} type AliasType Baz[other.Three] ================================================ FILE: mockgen/internal/tests/generics/go.mod ================================================ module github.com/golang/mock/mockgen/internal/tests/generics go 1.18 require ( github.com/golang/mock v1.6.0 golang.org/x/exp v0.0.0-20220428152302-39d4317da171 ) replace github.com/golang/mock => ../../../.. ================================================ FILE: mockgen/internal/tests/generics/go.sum ================================================ github.com/yuin/goldmark v1.4.1/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/exp v0.0.0-20220428152302-39d4317da171 h1:TfdoLivD44QwvssI9Sv1xwa5DcL5XQr4au4sZ2F2NV4= golang.org/x/exp v0.0.0-20220428152302-39d4317da171/go.mod h1:lgLbSvA5ygNOMpwM/9anMpWVlVJ7Z+cHWq/eFuinpGE= golang.org/x/mod v0.5.1/go.mod h1:5OXOZSfqPIIbmVBIIKWRFfZjPR0E5r58TLhUjH0a2Ro= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20211019181941-9d821ace8654/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.1.8/go.mod h1:nABZi5QlRsZVlzPpHl034qft6wpY4eDcsTt5AaioBiU= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= ================================================ FILE: mockgen/internal/tests/generics/other/other.go ================================================ package other type One[T any] struct{} type Two[T any, R any] struct{} type Three struct{} type Four struct{} type Five interface{} ================================================ FILE: mockgen/internal/tests/generics/source/mock_external_test.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: external.go // Package source is a generated GoMock package. package source import ( reflect "reflect" gomock "github.com/golang/mock/gomock" generics "github.com/golang/mock/mockgen/internal/tests/generics" other "github.com/golang/mock/mockgen/internal/tests/generics/other" constraints "golang.org/x/exp/constraints" ) // MockExternalConstraint is a mock of ExternalConstraint interface. type MockExternalConstraint[I constraints.Integer, F constraints.Float] struct { ctrl *gomock.Controller recorder *MockExternalConstraintMockRecorder[I, F] } // MockExternalConstraintMockRecorder is the mock recorder for MockExternalConstraint. type MockExternalConstraintMockRecorder[I constraints.Integer, F constraints.Float] struct { mock *MockExternalConstraint[I, F] } // NewMockExternalConstraint creates a new mock instance. func NewMockExternalConstraint[I constraints.Integer, F constraints.Float](ctrl *gomock.Controller) *MockExternalConstraint[I, F] { mock := &MockExternalConstraint[I, F]{ctrl: ctrl} mock.recorder = &MockExternalConstraintMockRecorder[I, F]{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockExternalConstraint[I, F]) EXPECT() *MockExternalConstraintMockRecorder[I, F] { return m.recorder } // Eight mocks base method. func (m *MockExternalConstraint[I, F]) Eight(arg0 F) other.Two[I, F] { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Eight", arg0) ret0, _ := ret[0].(other.Two[I, F]) return ret0 } // Eight indicates an expected call of Eight. func (mr *MockExternalConstraintMockRecorder[I, F]) Eight(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Eight", reflect.TypeOf((*MockExternalConstraint[I, F])(nil).Eight), arg0) } // Five mocks base method. func (m *MockExternalConstraint[I, F]) Five(arg0 I) generics.Baz[F] { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Five", arg0) ret0, _ := ret[0].(generics.Baz[F]) return ret0 } // Five indicates an expected call of Five. func (mr *MockExternalConstraintMockRecorder[I, F]) Five(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Five", reflect.TypeOf((*MockExternalConstraint[I, F])(nil).Five), arg0) } // Four mocks base method. func (m *MockExternalConstraint[I, F]) Four(arg0 I) generics.Foo[I, F] { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Four", arg0) ret0, _ := ret[0].(generics.Foo[I, F]) return ret0 } // Four indicates an expected call of Four. func (mr *MockExternalConstraintMockRecorder[I, F]) Four(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Four", reflect.TypeOf((*MockExternalConstraint[I, F])(nil).Four), arg0) } // Nine mocks base method. func (m *MockExternalConstraint[I, F]) Nine(arg0 generics.Iface[I]) { m.ctrl.T.Helper() m.ctrl.Call(m, "Nine", arg0) } // Nine indicates an expected call of Nine. func (mr *MockExternalConstraintMockRecorder[I, F]) Nine(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Nine", reflect.TypeOf((*MockExternalConstraint[I, F])(nil).Nine), arg0) } // One mocks base method. func (m *MockExternalConstraint[I, F]) One(arg0 string) string { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "One", arg0) ret0, _ := ret[0].(string) return ret0 } // One indicates an expected call of One. func (mr *MockExternalConstraintMockRecorder[I, F]) One(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "One", reflect.TypeOf((*MockExternalConstraint[I, F])(nil).One), arg0) } // Seven mocks base method. func (m *MockExternalConstraint[I, F]) Seven(arg0 I) other.One[I] { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Seven", arg0) ret0, _ := ret[0].(other.One[I]) return ret0 } // Seven indicates an expected call of Seven. func (mr *MockExternalConstraintMockRecorder[I, F]) Seven(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Seven", reflect.TypeOf((*MockExternalConstraint[I, F])(nil).Seven), arg0) } // Six mocks base method. func (m *MockExternalConstraint[I, F]) Six(arg0 I) *generics.Baz[F] { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Six", arg0) ret0, _ := ret[0].(*generics.Baz[F]) return ret0 } // Six indicates an expected call of Six. func (mr *MockExternalConstraintMockRecorder[I, F]) Six(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Six", reflect.TypeOf((*MockExternalConstraint[I, F])(nil).Six), arg0) } // Ten mocks base method. func (m *MockExternalConstraint[I, F]) Ten(arg0 *I) { m.ctrl.T.Helper() m.ctrl.Call(m, "Ten", arg0) } // Ten indicates an expected call of Ten. func (mr *MockExternalConstraintMockRecorder[I, F]) Ten(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Ten", reflect.TypeOf((*MockExternalConstraint[I, F])(nil).Ten), arg0) } // Three mocks base method. func (m *MockExternalConstraint[I, F]) Three(arg0 I) F { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Three", arg0) ret0, _ := ret[0].(F) return ret0 } // Three indicates an expected call of Three. func (mr *MockExternalConstraintMockRecorder[I, F]) Three(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Three", reflect.TypeOf((*MockExternalConstraint[I, F])(nil).Three), arg0) } // Two mocks base method. func (m *MockExternalConstraint[I, F]) Two(arg0 I) string { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Two", arg0) ret0, _ := ret[0].(string) return ret0 } // Two indicates an expected call of Two. func (mr *MockExternalConstraintMockRecorder[I, F]) Two(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Two", reflect.TypeOf((*MockExternalConstraint[I, F])(nil).Two), arg0) } ================================================ FILE: mockgen/internal/tests/generics/source/mock_generics_test.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: generics.go // Package source is a generated GoMock package. package source import ( reflect "reflect" gomock "github.com/golang/mock/gomock" generics "github.com/golang/mock/mockgen/internal/tests/generics" other "github.com/golang/mock/mockgen/internal/tests/generics/other" ) // MockBar is a mock of Bar interface. type MockBar[T any, R any] struct { ctrl *gomock.Controller recorder *MockBarMockRecorder[T, R] } // MockBarMockRecorder is the mock recorder for MockBar. type MockBarMockRecorder[T any, R any] struct { mock *MockBar[T, R] } // NewMockBar creates a new mock instance. func NewMockBar[T any, R any](ctrl *gomock.Controller) *MockBar[T, R] { mock := &MockBar[T, R]{ctrl: ctrl} mock.recorder = &MockBarMockRecorder[T, R]{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockBar[T, R]) EXPECT() *MockBarMockRecorder[T, R] { return m.recorder } // Eight mocks base method. func (m *MockBar[T, R]) Eight(arg0 T) other.Two[T, R] { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Eight", arg0) ret0, _ := ret[0].(other.Two[T, R]) return ret0 } // Eight indicates an expected call of Eight. func (mr *MockBarMockRecorder[T, R]) Eight(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Eight", reflect.TypeOf((*MockBar[T, R])(nil).Eight), arg0) } // Eighteen mocks base method. func (m *MockBar[T, R]) Eighteen() (generics.Iface[*other.Five], error) { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Eighteen") ret0, _ := ret[0].(generics.Iface[*other.Five]) ret1, _ := ret[1].(error) return ret0, ret1 } // Eighteen indicates an expected call of Eighteen. func (mr *MockBarMockRecorder[T, R]) Eighteen() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Eighteen", reflect.TypeOf((*MockBar[T, R])(nil).Eighteen)) } // Eleven mocks base method. func (m *MockBar[T, R]) Eleven() (*other.One[T], error) { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Eleven") ret0, _ := ret[0].(*other.One[T]) ret1, _ := ret[1].(error) return ret0, ret1 } // Eleven indicates an expected call of Eleven. func (mr *MockBarMockRecorder[T, R]) Eleven() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Eleven", reflect.TypeOf((*MockBar[T, R])(nil).Eleven)) } // Fifteen mocks base method. func (m *MockBar[T, R]) Fifteen() (generics.Iface[generics.StructType], error) { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Fifteen") ret0, _ := ret[0].(generics.Iface[generics.StructType]) ret1, _ := ret[1].(error) return ret0, ret1 } // Fifteen indicates an expected call of Fifteen. func (mr *MockBarMockRecorder[T, R]) Fifteen() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Fifteen", reflect.TypeOf((*MockBar[T, R])(nil).Fifteen)) } // Five mocks base method. func (m *MockBar[T, R]) Five(arg0 T) generics.Baz[T] { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Five", arg0) ret0, _ := ret[0].(generics.Baz[T]) return ret0 } // Five indicates an expected call of Five. func (mr *MockBarMockRecorder[T, R]) Five(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Five", reflect.TypeOf((*MockBar[T, R])(nil).Five), arg0) } // Four mocks base method. func (m *MockBar[T, R]) Four(arg0 T) generics.Foo[T, R] { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Four", arg0) ret0, _ := ret[0].(generics.Foo[T, R]) return ret0 } // Four indicates an expected call of Four. func (mr *MockBarMockRecorder[T, R]) Four(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Four", reflect.TypeOf((*MockBar[T, R])(nil).Four), arg0) } // Fourteen mocks base method. func (m *MockBar[T, R]) Fourteen() (*generics.Foo[generics.StructType, generics.StructType2], error) { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Fourteen") ret0, _ := ret[0].(*generics.Foo[generics.StructType, generics.StructType2]) ret1, _ := ret[1].(error) return ret0, ret1 } // Fourteen indicates an expected call of Fourteen. func (mr *MockBarMockRecorder[T, R]) Fourteen() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Fourteen", reflect.TypeOf((*MockBar[T, R])(nil).Fourteen)) } // Nine mocks base method. func (m *MockBar[T, R]) Nine(arg0 generics.Iface[T]) { m.ctrl.T.Helper() m.ctrl.Call(m, "Nine", arg0) } // Nine indicates an expected call of Nine. func (mr *MockBarMockRecorder[T, R]) Nine(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Nine", reflect.TypeOf((*MockBar[T, R])(nil).Nine), arg0) } // Nineteen mocks base method. func (m *MockBar[T, R]) Nineteen() generics.AliasType { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Nineteen") ret0, _ := ret[0].(generics.AliasType) return ret0 } // Nineteen indicates an expected call of Nineteen. func (mr *MockBarMockRecorder[T, R]) Nineteen() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Nineteen", reflect.TypeOf((*MockBar[T, R])(nil).Nineteen)) } // One mocks base method. func (m *MockBar[T, R]) One(arg0 string) string { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "One", arg0) ret0, _ := ret[0].(string) return ret0 } // One indicates an expected call of One. func (mr *MockBarMockRecorder[T, R]) One(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "One", reflect.TypeOf((*MockBar[T, R])(nil).One), arg0) } // Seven mocks base method. func (m *MockBar[T, R]) Seven(arg0 T) other.One[T] { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Seven", arg0) ret0, _ := ret[0].(other.One[T]) return ret0 } // Seven indicates an expected call of Seven. func (mr *MockBarMockRecorder[T, R]) Seven(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Seven", reflect.TypeOf((*MockBar[T, R])(nil).Seven), arg0) } // Seventeen mocks base method. func (m *MockBar[T, R]) Seventeen() (*generics.Foo[other.Three, other.Four], error) { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Seventeen") ret0, _ := ret[0].(*generics.Foo[other.Three, other.Four]) ret1, _ := ret[1].(error) return ret0, ret1 } // Seventeen indicates an expected call of Seventeen. func (mr *MockBarMockRecorder[T, R]) Seventeen() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Seventeen", reflect.TypeOf((*MockBar[T, R])(nil).Seventeen)) } // Six mocks base method. func (m *MockBar[T, R]) Six(arg0 T) *generics.Baz[T] { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Six", arg0) ret0, _ := ret[0].(*generics.Baz[T]) return ret0 } // Six indicates an expected call of Six. func (mr *MockBarMockRecorder[T, R]) Six(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Six", reflect.TypeOf((*MockBar[T, R])(nil).Six), arg0) } // Sixteen mocks base method. func (m *MockBar[T, R]) Sixteen() (generics.Baz[other.Three], error) { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Sixteen") ret0, _ := ret[0].(generics.Baz[other.Three]) ret1, _ := ret[1].(error) return ret0, ret1 } // Sixteen indicates an expected call of Sixteen. func (mr *MockBarMockRecorder[T, R]) Sixteen() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Sixteen", reflect.TypeOf((*MockBar[T, R])(nil).Sixteen)) } // Ten mocks base method. func (m *MockBar[T, R]) Ten(arg0 *T) { m.ctrl.T.Helper() m.ctrl.Call(m, "Ten", arg0) } // Ten indicates an expected call of Ten. func (mr *MockBarMockRecorder[T, R]) Ten(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Ten", reflect.TypeOf((*MockBar[T, R])(nil).Ten), arg0) } // Thirteen mocks base method. func (m *MockBar[T, R]) Thirteen() (generics.Baz[generics.StructType], error) { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Thirteen") ret0, _ := ret[0].(generics.Baz[generics.StructType]) ret1, _ := ret[1].(error) return ret0, ret1 } // Thirteen indicates an expected call of Thirteen. func (mr *MockBarMockRecorder[T, R]) Thirteen() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Thirteen", reflect.TypeOf((*MockBar[T, R])(nil).Thirteen)) } // Three mocks base method. func (m *MockBar[T, R]) Three(arg0 T) R { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Three", arg0) ret0, _ := ret[0].(R) return ret0 } // Three indicates an expected call of Three. func (mr *MockBarMockRecorder[T, R]) Three(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Three", reflect.TypeOf((*MockBar[T, R])(nil).Three), arg0) } // Twelve mocks base method. func (m *MockBar[T, R]) Twelve() (*other.Two[T, R], error) { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Twelve") ret0, _ := ret[0].(*other.Two[T, R]) ret1, _ := ret[1].(error) return ret0, ret1 } // Twelve indicates an expected call of Twelve. func (mr *MockBarMockRecorder[T, R]) Twelve() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Twelve", reflect.TypeOf((*MockBar[T, R])(nil).Twelve)) } // Two mocks base method. func (m *MockBar[T, R]) Two(arg0 T) string { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Two", arg0) ret0, _ := ret[0].(string) return ret0 } // Two indicates an expected call of Two. func (mr *MockBarMockRecorder[T, R]) Two(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Two", reflect.TypeOf((*MockBar[T, R])(nil).Two), arg0) } // MockIface is a mock of Iface interface. type MockIface[T any] struct { ctrl *gomock.Controller recorder *MockIfaceMockRecorder[T] } // MockIfaceMockRecorder is the mock recorder for MockIface. type MockIfaceMockRecorder[T any] struct { mock *MockIface[T] } // NewMockIface creates a new mock instance. func NewMockIface[T any](ctrl *gomock.Controller) *MockIface[T] { mock := &MockIface[T]{ctrl: ctrl} mock.recorder = &MockIfaceMockRecorder[T]{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockIface[T]) EXPECT() *MockIfaceMockRecorder[T] { return m.recorder } ================================================ FILE: mockgen/internal/tests/import_embedded_interface/bugreport.go ================================================ // Copyright 2020 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package bugreport //go:generate mockgen -destination bugreport_mock.go -package bugreport -source=bugreport.go import ( "log" "github.com/golang/mock/mockgen/internal/tests/import_embedded_interface/ersatz" "github.com/golang/mock/mockgen/internal/tests/import_embedded_interface/faux" ) // Source is an interface w/ an embedded foreign interface type Source interface { ersatz.Embedded faux.Foreign error Foo } func CallForeignMethod(s Source) { log.Println(s.Ersatz()) log.Println(s.OtherErsatz()) } ================================================ FILE: mockgen/internal/tests/import_embedded_interface/bugreport_mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: bugreport.go // Package bugreport is a generated GoMock package. package bugreport import ( reflect "reflect" gomock "github.com/golang/mock/gomock" ersatz "github.com/golang/mock/mockgen/internal/tests/import_embedded_interface/ersatz" ersatz0 "github.com/golang/mock/mockgen/internal/tests/import_embedded_interface/other/ersatz" ) // MockSource is a mock of Source interface. type MockSource struct { ctrl *gomock.Controller recorder *MockSourceMockRecorder } // MockSourceMockRecorder is the mock recorder for MockSource. type MockSourceMockRecorder struct { mock *MockSource } // NewMockSource creates a new mock instance. func NewMockSource(ctrl *gomock.Controller) *MockSource { mock := &MockSource{ctrl: ctrl} mock.recorder = &MockSourceMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockSource) EXPECT() *MockSourceMockRecorder { return m.recorder } // Bar mocks base method. func (m *MockSource) Bar() Baz { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Bar") ret0, _ := ret[0].(Baz) return ret0 } // Bar indicates an expected call of Bar. func (mr *MockSourceMockRecorder) Bar() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Bar", reflect.TypeOf((*MockSource)(nil).Bar)) } // Error mocks base method. func (m *MockSource) Error() string { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Error") ret0, _ := ret[0].(string) return ret0 } // Error indicates an expected call of Error. func (mr *MockSourceMockRecorder) Error() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Error", reflect.TypeOf((*MockSource)(nil).Error)) } // Ersatz mocks base method. func (m *MockSource) Ersatz() ersatz.Return { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Ersatz") ret0, _ := ret[0].(ersatz.Return) return ret0 } // Ersatz indicates an expected call of Ersatz. func (mr *MockSourceMockRecorder) Ersatz() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Ersatz", reflect.TypeOf((*MockSource)(nil).Ersatz)) } // OtherErsatz mocks base method. func (m *MockSource) OtherErsatz() ersatz0.Return { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "OtherErsatz") ret0, _ := ret[0].(ersatz0.Return) return ret0 } // OtherErsatz indicates an expected call of OtherErsatz. func (mr *MockSourceMockRecorder) OtherErsatz() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "OtherErsatz", reflect.TypeOf((*MockSource)(nil).OtherErsatz)) } ================================================ FILE: mockgen/internal/tests/import_embedded_interface/bugreport_test.go ================================================ // Copyright 2020 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package bugreport import ( "testing" "github.com/golang/mock/gomock" ) // TestValidInterface assesses whether or not the generated mock is valid func TestValidInterface(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() s := NewMockSource(ctrl) s.EXPECT().Ersatz().Return("") s.EXPECT().OtherErsatz().Return("") CallForeignMethod(s) } ================================================ FILE: mockgen/internal/tests/import_embedded_interface/ersatz/ersatz.go ================================================ // Copyright 2020 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package ersatz type Embedded interface { Ersatz() Return } type Return interface{} ================================================ FILE: mockgen/internal/tests/import_embedded_interface/faux/conflict.go ================================================ // Copyright 2020 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package faux import "github.com/golang/mock/mockgen/internal/tests/import_embedded_interface/other/log" func Conflict1() { log.Foo() } ================================================ FILE: mockgen/internal/tests/import_embedded_interface/faux/faux.go ================================================ // Copyright 2020 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package faux import ( "log" "github.com/golang/mock/mockgen/internal/tests/import_embedded_interface/other/ersatz" ) type Foreign interface { ersatz.Embedded } func Conflict0() { log.Println() } ================================================ FILE: mockgen/internal/tests/import_embedded_interface/foo.go ================================================ package bugreport type Foo interface { Bar() Baz } type Baz interface{} ================================================ FILE: mockgen/internal/tests/import_embedded_interface/net.go ================================================ // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package bugreport //go:generate mockgen -destination net_mock.go -package bugreport -source=net.go import "net/http" type Net interface { http.ResponseWriter } func CallResponseWriterMethods(n Net) { n.WriteHeader(10) } ================================================ FILE: mockgen/internal/tests/import_embedded_interface/net_mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: net.go // Package bugreport is a generated GoMock package. package bugreport import ( http "net/http" reflect "reflect" gomock "github.com/golang/mock/gomock" ) // MockNet is a mock of Net interface. type MockNet struct { ctrl *gomock.Controller recorder *MockNetMockRecorder } // MockNetMockRecorder is the mock recorder for MockNet. type MockNetMockRecorder struct { mock *MockNet } // NewMockNet creates a new mock instance. func NewMockNet(ctrl *gomock.Controller) *MockNet { mock := &MockNet{ctrl: ctrl} mock.recorder = &MockNetMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockNet) EXPECT() *MockNetMockRecorder { return m.recorder } // Header mocks base method. func (m *MockNet) Header() http.Header { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Header") ret0, _ := ret[0].(http.Header) return ret0 } // Header indicates an expected call of Header. func (mr *MockNetMockRecorder) Header() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Header", reflect.TypeOf((*MockNet)(nil).Header)) } // Write mocks base method. func (m *MockNet) Write(arg0 []byte) (int, error) { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Write", arg0) ret0, _ := ret[0].(int) ret1, _ := ret[1].(error) return ret0, ret1 } // Write indicates an expected call of Write. func (mr *MockNetMockRecorder) Write(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Write", reflect.TypeOf((*MockNet)(nil).Write), arg0) } // WriteHeader mocks base method. func (m *MockNet) WriteHeader(statusCode int) { m.ctrl.T.Helper() m.ctrl.Call(m, "WriteHeader", statusCode) } // WriteHeader indicates an expected call of WriteHeader. func (mr *MockNetMockRecorder) WriteHeader(statusCode interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "WriteHeader", reflect.TypeOf((*MockNet)(nil).WriteHeader), statusCode) } ================================================ FILE: mockgen/internal/tests/import_embedded_interface/net_test.go ================================================ // Copyright 2020 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package bugreport import ( "testing" "github.com/golang/mock/gomock" ) // TestValidInterface assesses whether or not the generated mock is valid func TestValidNetInterface(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() s := NewMockNet(ctrl) s.EXPECT().WriteHeader(10) CallResponseWriterMethods(s) } ================================================ FILE: mockgen/internal/tests/import_embedded_interface/other/ersatz/ersatz.go ================================================ // Copyright 2020 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package ersatz type Embedded interface { OtherErsatz() Return } type Return interface{} ================================================ FILE: mockgen/internal/tests/import_embedded_interface/other/log/log.go ================================================ // Copyright 2020 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package log func Foo() {} ================================================ FILE: mockgen/internal/tests/import_source/README.md ================================================ # Import Source Test the case where the generated code uses a type defined in the source package (in source mode). There are two test cases: - the output is in a new package - the output is in the same package as the input ================================================ FILE: mockgen/internal/tests/import_source/definition/source.go ================================================ package source //go:generate mockgen -destination ../source_mock.go -source=source.go //go:generate mockgen -package source -destination source_mock.go -source=source.go type X struct{} type S interface { F(X) } ================================================ FILE: mockgen/internal/tests/import_source/definition/source_mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: source.go // Package source is a generated GoMock package. package source import ( reflect "reflect" gomock "github.com/golang/mock/gomock" ) // MockS is a mock of S interface. type MockS struct { ctrl *gomock.Controller recorder *MockSMockRecorder } // MockSMockRecorder is the mock recorder for MockS. type MockSMockRecorder struct { mock *MockS } // NewMockS creates a new mock instance. func NewMockS(ctrl *gomock.Controller) *MockS { mock := &MockS{ctrl: ctrl} mock.recorder = &MockSMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockS) EXPECT() *MockSMockRecorder { return m.recorder } // F mocks base method. func (m *MockS) F(arg0 X) { m.ctrl.T.Helper() m.ctrl.Call(m, "F", arg0) } // F indicates an expected call of F. func (mr *MockSMockRecorder) F(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "F", reflect.TypeOf((*MockS)(nil).F), arg0) } ================================================ FILE: mockgen/internal/tests/import_source/source_mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: source.go // Package mock_source is a generated GoMock package. package mock_source import ( reflect "reflect" gomock "github.com/golang/mock/gomock" source "github.com/golang/mock/mockgen/internal/tests/import_source/definition" ) // MockS is a mock of S interface. type MockS struct { ctrl *gomock.Controller recorder *MockSMockRecorder } // MockSMockRecorder is the mock recorder for MockS. type MockSMockRecorder struct { mock *MockS } // NewMockS creates a new mock instance. func NewMockS(ctrl *gomock.Controller) *MockS { mock := &MockS{ctrl: ctrl} mock.recorder = &MockSMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockS) EXPECT() *MockSMockRecorder { return m.recorder } // F mocks base method. func (m *MockS) F(arg0 source.X) { m.ctrl.T.Helper() m.ctrl.Call(m, "F", arg0) } // F indicates an expected call of F. func (mr *MockSMockRecorder) F(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "F", reflect.TypeOf((*MockS)(nil).F), arg0) } ================================================ FILE: mockgen/internal/tests/internal_pkg/generate.go ================================================ package test //go:generate mockgen -destination subdir/internal/pkg/reflect_output/mock.go github.com/golang/mock/mockgen/internal/tests/internal_pkg/subdir/internal/pkg Intf //go:generate mockgen -source subdir/internal/pkg/input.go -destination subdir/internal/pkg/source_output/mock.go ================================================ FILE: mockgen/internal/tests/internal_pkg/subdir/internal/pkg/input.go ================================================ package pkg type Arg interface { Foo() int } type Intf interface { F() Arg } ================================================ FILE: mockgen/internal/tests/internal_pkg/subdir/internal/pkg/reflect_output/mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: github.com/golang/mock/mockgen/internal/tests/internal_pkg/subdir/internal/pkg (interfaces: Intf) // Package mock_pkg is a generated GoMock package. package mock_pkg import ( reflect "reflect" gomock "github.com/golang/mock/gomock" pkg "github.com/golang/mock/mockgen/internal/tests/internal_pkg/subdir/internal/pkg" ) // MockIntf is a mock of Intf interface. type MockIntf struct { ctrl *gomock.Controller recorder *MockIntfMockRecorder } // MockIntfMockRecorder is the mock recorder for MockIntf. type MockIntfMockRecorder struct { mock *MockIntf } // NewMockIntf creates a new mock instance. func NewMockIntf(ctrl *gomock.Controller) *MockIntf { mock := &MockIntf{ctrl: ctrl} mock.recorder = &MockIntfMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockIntf) EXPECT() *MockIntfMockRecorder { return m.recorder } // F mocks base method. func (m *MockIntf) F() pkg.Arg { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "F") ret0, _ := ret[0].(pkg.Arg) return ret0 } // F indicates an expected call of F. func (mr *MockIntfMockRecorder) F() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "F", reflect.TypeOf((*MockIntf)(nil).F)) } ================================================ FILE: mockgen/internal/tests/internal_pkg/subdir/internal/pkg/source_output/mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: subdir/internal/pkg/input.go // Package mock_pkg is a generated GoMock package. package mock_pkg import ( reflect "reflect" gomock "github.com/golang/mock/gomock" pkg "github.com/golang/mock/mockgen/internal/tests/internal_pkg/subdir/internal/pkg" ) // MockArg is a mock of Arg interface. type MockArg struct { ctrl *gomock.Controller recorder *MockArgMockRecorder } // MockArgMockRecorder is the mock recorder for MockArg. type MockArgMockRecorder struct { mock *MockArg } // NewMockArg creates a new mock instance. func NewMockArg(ctrl *gomock.Controller) *MockArg { mock := &MockArg{ctrl: ctrl} mock.recorder = &MockArgMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockArg) EXPECT() *MockArgMockRecorder { return m.recorder } // Foo mocks base method. func (m *MockArg) Foo() int { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Foo") ret0, _ := ret[0].(int) return ret0 } // Foo indicates an expected call of Foo. func (mr *MockArgMockRecorder) Foo() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Foo", reflect.TypeOf((*MockArg)(nil).Foo)) } // MockIntf is a mock of Intf interface. type MockIntf struct { ctrl *gomock.Controller recorder *MockIntfMockRecorder } // MockIntfMockRecorder is the mock recorder for MockIntf. type MockIntfMockRecorder struct { mock *MockIntf } // NewMockIntf creates a new mock instance. func NewMockIntf(ctrl *gomock.Controller) *MockIntf { mock := &MockIntf{ctrl: ctrl} mock.recorder = &MockIntfMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockIntf) EXPECT() *MockIntfMockRecorder { return m.recorder } // F mocks base method. func (m *MockIntf) F() pkg.Arg { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "F") ret0, _ := ret[0].(pkg.Arg) return ret0 } // F indicates an expected call of F. func (mr *MockIntfMockRecorder) F() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "F", reflect.TypeOf((*MockIntf)(nil).F)) } ================================================ FILE: mockgen/internal/tests/missing_import/output/source_mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: source.go // Package source is a generated GoMock package. package source import ( reflect "reflect" gomock "github.com/golang/mock/gomock" source "github.com/golang/mock/mockgen/internal/tests/missing_import/source" ) // MockBar is a mock of Bar interface. type MockBar struct { ctrl *gomock.Controller recorder *MockBarMockRecorder } // MockBarMockRecorder is the mock recorder for MockBar. type MockBarMockRecorder struct { mock *MockBar } // NewMockBar creates a new mock instance. func NewMockBar(ctrl *gomock.Controller) *MockBar { mock := &MockBar{ctrl: ctrl} mock.recorder = &MockBarMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockBar) EXPECT() *MockBarMockRecorder { return m.recorder } // Baz mocks base method. func (m *MockBar) Baz(arg0 source.Foo) { m.ctrl.T.Helper() m.ctrl.Call(m, "Baz", arg0) } // Baz indicates an expected call of Baz. func (mr *MockBarMockRecorder) Baz(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Baz", reflect.TypeOf((*MockBar)(nil).Baz), arg0) } ================================================ FILE: mockgen/internal/tests/missing_import/source/source.go ================================================ // Package source makes sure output imports its. See #505. package source //go:generate mockgen -package source -destination=../output/source_mock.go -source=source.go type Foo struct{} type Bar interface { Baz(Foo) } ================================================ FILE: mockgen/internal/tests/mock_in_test_package/README.md ================================================ # Mock in Test Package Test the case where the package has the `_test` suffix. Prior to patch: ```bash $ go generate $ go test # github.com/golang/mock/mockgen/internal/tests/mock_in_test_package_test [github.com/golang/mock/mockgen/internal/tests/mock_in_test_package.test] ./mock_test.go:36:44: undefined: User ./mock_test.go:38:21: undefined: User FAIL github.com/golang/mock/mockgen/internal/tests/mock_in_test_package [build failed] ``` With this patch applied: ```bash $ go generate $ go test ok github.com/golang/mock/mockgen/internal/tests/mock_in_test_package 0.031s ``` ================================================ FILE: mockgen/internal/tests/mock_in_test_package/mock_test.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: user.go // Package users_test is a generated GoMock package. package users_test import ( reflect "reflect" gomock "github.com/golang/mock/gomock" users "github.com/golang/mock/mockgen/internal/tests/mock_in_test_package" ) // MockFinder is a mock of Finder interface. type MockFinder struct { ctrl *gomock.Controller recorder *MockFinderMockRecorder } // MockFinderMockRecorder is the mock recorder for MockFinder. type MockFinderMockRecorder struct { mock *MockFinder } // NewMockFinder creates a new mock instance. func NewMockFinder(ctrl *gomock.Controller) *MockFinder { mock := &MockFinder{ctrl: ctrl} mock.recorder = &MockFinderMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockFinder) EXPECT() *MockFinderMockRecorder { return m.recorder } // Add mocks base method. func (m *MockFinder) Add(u users.User) { m.ctrl.T.Helper() m.ctrl.Call(m, "Add", u) } // Add indicates an expected call of Add. func (mr *MockFinderMockRecorder) Add(u interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Add", reflect.TypeOf((*MockFinder)(nil).Add), u) } // FindUser mocks base method. func (m *MockFinder) FindUser(name string) users.User { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "FindUser", name) ret0, _ := ret[0].(users.User) return ret0 } // FindUser indicates an expected call of FindUser. func (mr *MockFinderMockRecorder) FindUser(name interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "FindUser", reflect.TypeOf((*MockFinder)(nil).FindUser), name) } ================================================ FILE: mockgen/internal/tests/mock_in_test_package/user.go ================================================ package users //go:generate mockgen --source=user.go --destination=mock_test.go --package=users_test type User struct { Name string } type Finder interface { FindUser(name string) User Add(u User) } ================================================ FILE: mockgen/internal/tests/overlapping_methods/interfaces.go ================================================ package overlap type ReadCloser interface { Read([]byte) (int, error) Close() error } type WriteCloser interface { Write([]byte) (int, error) Close() error } ================================================ FILE: mockgen/internal/tests/overlapping_methods/mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: overlap.go // Package overlap is a generated GoMock package. package overlap import ( reflect "reflect" gomock "github.com/golang/mock/gomock" ) // MockReadWriteCloser is a mock of ReadWriteCloser interface. type MockReadWriteCloser struct { ctrl *gomock.Controller recorder *MockReadWriteCloserMockRecorder } // MockReadWriteCloserMockRecorder is the mock recorder for MockReadWriteCloser. type MockReadWriteCloserMockRecorder struct { mock *MockReadWriteCloser } // NewMockReadWriteCloser creates a new mock instance. func NewMockReadWriteCloser(ctrl *gomock.Controller) *MockReadWriteCloser { mock := &MockReadWriteCloser{ctrl: ctrl} mock.recorder = &MockReadWriteCloserMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockReadWriteCloser) EXPECT() *MockReadWriteCloserMockRecorder { return m.recorder } // Close mocks base method. func (m *MockReadWriteCloser) Close() error { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Close") ret0, _ := ret[0].(error) return ret0 } // Close indicates an expected call of Close. func (mr *MockReadWriteCloserMockRecorder) Close() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Close", reflect.TypeOf((*MockReadWriteCloser)(nil).Close)) } // Read mocks base method. func (m *MockReadWriteCloser) Read(arg0 []byte) (int, error) { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Read", arg0) ret0, _ := ret[0].(int) ret1, _ := ret[1].(error) return ret0, ret1 } // Read indicates an expected call of Read. func (mr *MockReadWriteCloserMockRecorder) Read(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Read", reflect.TypeOf((*MockReadWriteCloser)(nil).Read), arg0) } // Write mocks base method. func (m *MockReadWriteCloser) Write(arg0 []byte) (int, error) { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Write", arg0) ret0, _ := ret[0].(int) ret1, _ := ret[1].(error) return ret0, ret1 } // Write indicates an expected call of Write. func (mr *MockReadWriteCloserMockRecorder) Write(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Write", reflect.TypeOf((*MockReadWriteCloser)(nil).Write), arg0) } ================================================ FILE: mockgen/internal/tests/overlapping_methods/overlap.go ================================================ package overlap //go:generate mockgen -package overlap -destination mock.go -source overlap.go -aux_files github.com/golang/mock/mockgen/internal/tests/overlapping_methods=interfaces.go type ReadWriteCloser interface { ReadCloser WriteCloser } ================================================ FILE: mockgen/internal/tests/overlapping_methods/overlap_test.go ================================================ package overlap import ( "errors" "testing" gomock "github.com/golang/mock/gomock" ) // TestValidInterface assesses whether or not the generated mock is valid func TestValidInterface(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() s := NewMockReadWriteCloser(ctrl) s.EXPECT().Close().Return(errors.New("test")) s.Close() } ================================================ FILE: mockgen/internal/tests/panicing_test/mock_test.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: panic.go // Package paniccode is a generated GoMock package. package paniccode import ( reflect "reflect" gomock "github.com/golang/mock/gomock" ) // MockFoo is a mock of Foo interface. type MockFoo struct { ctrl *gomock.Controller recorder *MockFooMockRecorder } // MockFooMockRecorder is the mock recorder for MockFoo. type MockFooMockRecorder struct { mock *MockFoo } // NewMockFoo creates a new mock instance. func NewMockFoo(ctrl *gomock.Controller) *MockFoo { mock := &MockFoo{ctrl: ctrl} mock.recorder = &MockFooMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockFoo) EXPECT() *MockFooMockRecorder { return m.recorder } // Bar mocks base method. func (m *MockFoo) Bar() string { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Bar") ret0, _ := ret[0].(string) return ret0 } // Bar indicates an expected call of Bar. func (mr *MockFooMockRecorder) Bar() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Bar", reflect.TypeOf((*MockFoo)(nil).Bar)) } // Baz mocks base method. func (m *MockFoo) Baz() string { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Baz") ret0, _ := ret[0].(string) return ret0 } // Baz indicates an expected call of Baz. func (mr *MockFooMockRecorder) Baz() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Baz", reflect.TypeOf((*MockFoo)(nil).Baz)) } ================================================ FILE: mockgen/internal/tests/panicing_test/panic.go ================================================ // Copyright 2020 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package paniccode //go:generate mockgen --source=panic.go --destination=mock_test.go --package=paniccode type Foo interface { Bar() string Baz() string } func Danger(f Foo) { if f.Bar() == "Bar" { panic("Danger, Will Robinson!") } } ================================================ FILE: mockgen/internal/tests/panicing_test/panic_test.go ================================================ //go:build panictest // +build panictest // Copyright 2020 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package paniccode import ( "testing" "github.com/golang/mock/gomock" ) func TestDanger_Panics_Explicit(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() mock := NewMockFoo(ctrl) mock.EXPECT().Bar().Return("Bar") mock.EXPECT().Bar().Return("Baz") Danger(mock) } func TestDanger_Panics_Implicit(t *testing.T) { ctrl := gomock.NewController(t) mock := NewMockFoo(ctrl) mock.EXPECT().Bar().Return("Bar") mock.EXPECT().Bar().Return("Baz") Danger(mock) } ================================================ FILE: mockgen/internal/tests/parenthesized_parameter_type/README.md ================================================ # Parenthesized Parameter Type Test for [Issue#416](https://github.com/golang/mock/issues/416). ================================================ FILE: mockgen/internal/tests/parenthesized_parameter_type/input.go ================================================ package parenthesized_parameter_type type Example interface { ParenthesizedParameterType(param *(int)) } ================================================ FILE: mockgen/internal/tests/parenthesized_parameter_type/mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: ./mockgen/internal/tests/parenthesized_parameter_type/input.go // Package parenthesized_parameter_type is a generated GoMock package. package parenthesized_parameter_type import ( gomock "github.com/golang/mock/gomock" reflect "reflect" ) // MockExample is a mock of Example interface. type MockExample struct { ctrl *gomock.Controller recorder *MockExampleMockRecorder } // MockExampleMockRecorder is the mock recorder for MockExample. type MockExampleMockRecorder struct { mock *MockExample } // NewMockExample creates a new mock instance. func NewMockExample(ctrl *gomock.Controller) *MockExample { mock := &MockExample{ctrl: ctrl} mock.recorder = &MockExampleMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockExample) EXPECT() *MockExampleMockRecorder { return m.recorder } // ParenthesizedParameterType mocks base method. func (m *MockExample) ParenthesizedParameterType(param *int) { m.ctrl.T.Helper() m.ctrl.Call(m, "ParenthesizedParameterType", param) } // ParenthesizedParameterType indicates an expected call of ParenthesizedParameterType. func (mr *MockExampleMockRecorder) ParenthesizedParameterType(param interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ParenthesizedParameterType", reflect.TypeOf((*MockExample)(nil).ParenthesizedParameterType), param) } ================================================ FILE: mockgen/internal/tests/performance/big_interface/big_interface.go ================================================ package big_interface type Bar struct{} type BigInterface interface { Foo1(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo2(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo3(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo4(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo5(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo6(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo7(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo8(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo9(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo10(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo11(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo12(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo13(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo14(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo15(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo16(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo17(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo18(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo19(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo20(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo21(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo22(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo23(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo24(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo25(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo26(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo27(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo28(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo29(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo30(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo31(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo32(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo33(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo34(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo35(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo36(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo37(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo38(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo39(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo40(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo41(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo42(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo43(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo44(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo45(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo46(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo47(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo48(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo49(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo50(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo51(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo52(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo53(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo54(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo55(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo56(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo57(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo58(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo59(bool, bool, bool, bool, bool, bool, bool, bool) Bar Foo60(bool, bool, bool, bool, bool, bool, bool, bool) Bar } ================================================ FILE: mockgen/internal/tests/self_package/mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: github.com/golang/mock/mockgen/internal/tests/self_package (interfaces: Methods) // Package core is a generated GoMock package. package core import ( reflect "reflect" gomock "github.com/golang/mock/gomock" ) // MockMethods is a mock of Methods interface. type MockMethods struct { ctrl *gomock.Controller recorder *MockMethodsMockRecorder } // MockMethodsMockRecorder is the mock recorder for MockMethods. type MockMethodsMockRecorder struct { mock *MockMethods } // NewMockMethods creates a new mock instance. func NewMockMethods(ctrl *gomock.Controller) *MockMethods { mock := &MockMethods{ctrl: ctrl} mock.recorder = &MockMethodsMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockMethods) EXPECT() *MockMethodsMockRecorder { return m.recorder } // getInfo mocks base method. func (m *MockMethods) getInfo() Info { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "getInfo") ret0, _ := ret[0].(Info) return ret0 } // getInfo indicates an expected call of getInfo. func (mr *MockMethodsMockRecorder) getInfo() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "getInfo", reflect.TypeOf((*MockMethods)(nil).getInfo)) } ================================================ FILE: mockgen/internal/tests/self_package/types.go ================================================ package core //go:generate mockgen -package core -self_package github.com/golang/mock/mockgen/internal/tests/self_package -destination mock.go github.com/golang/mock/mockgen/internal/tests/self_package Methods type Info struct{} type Methods interface { getInfo() Info } ================================================ FILE: mockgen/internal/tests/test_package/foo.go ================================================ package users ================================================ FILE: mockgen/internal/tests/test_package/mock_test.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: user_test.go // Package users_test is a generated GoMock package. package users_test import ( reflect "reflect" gomock "github.com/golang/mock/gomock" ) // MockFinder is a mock of Finder interface. type MockFinder struct { ctrl *gomock.Controller recorder *MockFinderMockRecorder } // MockFinderMockRecorder is the mock recorder for MockFinder. type MockFinderMockRecorder struct { mock *MockFinder } // NewMockFinder creates a new mock instance. func NewMockFinder(ctrl *gomock.Controller) *MockFinder { mock := &MockFinder{ctrl: ctrl} mock.recorder = &MockFinderMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockFinder) EXPECT() *MockFinderMockRecorder { return m.recorder } // Add mocks base method. func (m *MockFinder) Add(u User) { m.ctrl.T.Helper() m.ctrl.Call(m, "Add", u) } // Add indicates an expected call of Add. func (mr *MockFinderMockRecorder) Add(u interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Add", reflect.TypeOf((*MockFinder)(nil).Add), u) } // FindUser mocks base method. func (m *MockFinder) FindUser(name string) User { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "FindUser", name) ret0, _ := ret[0].(User) return ret0 } // FindUser indicates an expected call of FindUser. func (mr *MockFinderMockRecorder) FindUser(name interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "FindUser", reflect.TypeOf((*MockFinder)(nil).FindUser), name) } ================================================ FILE: mockgen/internal/tests/test_package/user_test.go ================================================ package users_test //go:generate mockgen --source=user_test.go --destination=mock_test.go --package=users_test type User struct { Name string } type Finder interface { FindUser(name string) User Add(u User) } ================================================ FILE: mockgen/internal/tests/unexported_method/README.md ================================================ # Unexported Method From #52, this tests an unexported method in the mocked interface. ================================================ FILE: mockgen/internal/tests/unexported_method/bugreport.go ================================================ package bugreport //go:generate mockgen -destination bugreport_mock.go -package bugreport -source=bugreport.go Example import "fmt" // Example is an interface with a non exported method type Example interface { someMethod(string) string } // CallExample is a simple function that uses the interface func CallExample(e Example) { fmt.Println(e.someMethod("test")) } ================================================ FILE: mockgen/internal/tests/unexported_method/bugreport_mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: bugreport.go // Package bugreport is a generated GoMock package. package bugreport import ( reflect "reflect" gomock "github.com/golang/mock/gomock" ) // MockExample is a mock of Example interface. type MockExample struct { ctrl *gomock.Controller recorder *MockExampleMockRecorder } // MockExampleMockRecorder is the mock recorder for MockExample. type MockExampleMockRecorder struct { mock *MockExample } // NewMockExample creates a new mock instance. func NewMockExample(ctrl *gomock.Controller) *MockExample { mock := &MockExample{ctrl: ctrl} mock.recorder = &MockExampleMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockExample) EXPECT() *MockExampleMockRecorder { return m.recorder } // someMethod mocks base method. func (m *MockExample) someMethod(arg0 string) string { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "someMethod", arg0) ret0, _ := ret[0].(string) return ret0 } // someMethod indicates an expected call of someMethod. func (mr *MockExampleMockRecorder) someMethod(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "someMethod", reflect.TypeOf((*MockExample)(nil).someMethod), arg0) } ================================================ FILE: mockgen/internal/tests/unexported_method/bugreport_test.go ================================================ package bugreport import ( "testing" "github.com/golang/mock/gomock" ) func TestCallExample(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() e := NewMockExample(ctrl) e.EXPECT().someMethod(gomock.Any()).Return("it works!") CallExample(e) } ================================================ FILE: mockgen/internal/tests/vendor_dep/README.md ================================================ # Vendor Dep Test for [Issue#4](https://github.com/golang/mock/issues/4). Also see discussion on [#28](https://github.com/golang/mock/pull/28). ================================================ FILE: mockgen/internal/tests/vendor_dep/doc.go ================================================ package vendor_dep //go:generate mockgen -package vendor_dep -destination mock.go github.com/golang/mock/mockgen/internal/tests/vendor_dep VendorsDep //go:generate mockgen -destination source_mock_package/mock.go -source=vendor_dep.go ================================================ FILE: mockgen/internal/tests/vendor_dep/mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: github.com/golang/mock/mockgen/internal/tests/vendor_dep (interfaces: VendorsDep) // Package vendor_dep is a generated GoMock package. package vendor_dep import ( reflect "reflect" gomock "github.com/golang/mock/gomock" present "golang.org/x/tools/present" ) // MockVendorsDep is a mock of VendorsDep interface. type MockVendorsDep struct { ctrl *gomock.Controller recorder *MockVendorsDepMockRecorder } // MockVendorsDepMockRecorder is the mock recorder for MockVendorsDep. type MockVendorsDepMockRecorder struct { mock *MockVendorsDep } // NewMockVendorsDep creates a new mock instance. func NewMockVendorsDep(ctrl *gomock.Controller) *MockVendorsDep { mock := &MockVendorsDep{ctrl: ctrl} mock.recorder = &MockVendorsDepMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockVendorsDep) EXPECT() *MockVendorsDepMockRecorder { return m.recorder } // Foo mocks base method. func (m *MockVendorsDep) Foo() present.Elem { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Foo") ret0, _ := ret[0].(present.Elem) return ret0 } // Foo indicates an expected call of Foo. func (mr *MockVendorsDepMockRecorder) Foo() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Foo", reflect.TypeOf((*MockVendorsDep)(nil).Foo)) } ================================================ FILE: mockgen/internal/tests/vendor_dep/source_mock_package/mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: vendor_dep.go // Package mock_vendor_dep is a generated GoMock package. package mock_vendor_dep import ( reflect "reflect" gomock "github.com/golang/mock/gomock" present "golang.org/x/tools/present" ) // MockVendorsDep is a mock of VendorsDep interface. type MockVendorsDep struct { ctrl *gomock.Controller recorder *MockVendorsDepMockRecorder } // MockVendorsDepMockRecorder is the mock recorder for MockVendorsDep. type MockVendorsDepMockRecorder struct { mock *MockVendorsDep } // NewMockVendorsDep creates a new mock instance. func NewMockVendorsDep(ctrl *gomock.Controller) *MockVendorsDep { mock := &MockVendorsDep{ctrl: ctrl} mock.recorder = &MockVendorsDepMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockVendorsDep) EXPECT() *MockVendorsDepMockRecorder { return m.recorder } // Foo mocks base method. func (m *MockVendorsDep) Foo() present.Elem { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Foo") ret0, _ := ret[0].(present.Elem) return ret0 } // Foo indicates an expected call of Foo. func (mr *MockVendorsDepMockRecorder) Foo() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Foo", reflect.TypeOf((*MockVendorsDep)(nil).Foo)) } ================================================ FILE: mockgen/internal/tests/vendor_dep/vendor_dep.go ================================================ package vendor_dep import "golang.org/x/tools/present" type VendorsDep interface { Foo() present.Elem } ================================================ FILE: mockgen/internal/tests/vendor_pkg/README.md ================================================ # Vendor Pkg Test for [Issue#4](https://github.com/golang/mock/issues/4). ================================================ FILE: mockgen/internal/tests/vendor_pkg/doc.go ================================================ package vendor_pkg //go:generate mockgen -destination mock.go -package vendor_pkg golang.org/x/tools/present Elem ================================================ FILE: mockgen/internal/tests/vendor_pkg/mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: golang.org/x/tools/present (interfaces: Elem) // Package vendor_pkg is a generated GoMock package. package vendor_pkg import ( reflect "reflect" gomock "github.com/golang/mock/gomock" ) // MockElem is a mock of Elem interface. type MockElem struct { ctrl *gomock.Controller recorder *MockElemMockRecorder } // MockElemMockRecorder is the mock recorder for MockElem. type MockElemMockRecorder struct { mock *MockElem } // NewMockElem creates a new mock instance. func NewMockElem(ctrl *gomock.Controller) *MockElem { mock := &MockElem{ctrl: ctrl} mock.recorder = &MockElemMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockElem) EXPECT() *MockElemMockRecorder { return m.recorder } // TemplateName mocks base method. func (m *MockElem) TemplateName() string { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "TemplateName") ret0, _ := ret[0].(string) return ret0 } // TemplateName indicates an expected call of TemplateName. func (mr *MockElemMockRecorder) TemplateName() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "TemplateName", reflect.TypeOf((*MockElem)(nil).TemplateName)) } ================================================ FILE: mockgen/mockgen.go ================================================ // Copyright 2010 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // MockGen generates mock implementations of Go interfaces. package main // TODO: This does not support recursive embedded interfaces. // TODO: This does not support embedding package-local interfaces in a separate file. import ( "bytes" "encoding/json" "errors" "flag" "fmt" "go/token" "io" "io/ioutil" "log" "os" "os/exec" "path" "path/filepath" "sort" "strconv" "strings" "unicode" "github.com/golang/mock/mockgen/model" "golang.org/x/mod/modfile" toolsimports "golang.org/x/tools/imports" ) const ( gomockImportPath = "github.com/golang/mock/gomock" ) var ( version = "" commit = "none" date = "unknown" ) var ( source = flag.String("source", "", "(source mode) Input Go source file; enables source mode.") destination = flag.String("destination", "", "Output file; defaults to stdout.") mockNames = flag.String("mock_names", "", "Comma-separated interfaceName=mockName pairs of explicit mock names to use. Mock names default to 'Mock'+ interfaceName suffix.") packageOut = flag.String("package", "", "Package of the generated code; defaults to the package of the input with a 'mock_' prefix.") selfPackage = flag.String("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. This can happen if the mock's package is set to one of its inputs (usually the main one) and the output is stdio so mockgen cannot detect the final output package. Setting this flag will then tell mockgen which import to exclude.") writePkgComment = flag.Bool("write_package_comment", true, "Writes package documentation comment (godoc) if true.") copyrightFile = flag.String("copyright_file", "", "Copyright file used to add copyright header") debugParser = flag.Bool("debug_parser", false, "Print out parser results only.") showVersion = flag.Bool("version", false, "Print version.") ) func main() { flag.Usage = usage flag.Parse() if *showVersion { printVersion() return } var pkg *model.Package var err error var packageName string if *source != "" { pkg, err = sourceMode(*source) } else { if flag.NArg() != 2 { usage() log.Fatal("Expected exactly two arguments") } packageName = flag.Arg(0) interfaces := strings.Split(flag.Arg(1), ",") if packageName == "." { dir, err := os.Getwd() if err != nil { log.Fatalf("Get current directory failed: %v", err) } packageName, err = packageNameOfDir(dir) if err != nil { log.Fatalf("Parse package name failed: %v", err) } } pkg, err = reflectMode(packageName, interfaces) } if err != nil { log.Fatalf("Loading input failed: %v", err) } if *debugParser { pkg.Print(os.Stdout) return } outputPackageName := *packageOut if outputPackageName == "" { // pkg.Name in reflect mode is the base name of the import path, // which might have characters that are illegal to have in package names. outputPackageName = "mock_" + sanitize(pkg.Name) } // outputPackagePath represents the fully qualified name of the package of // the generated code. Its purposes are to prevent the module from importing // itself and to prevent qualifying type names that come from its own // package (i.e. if there is a type called X then we want to print "X" not // "package.X" since "package" is this package). This can happen if the mock // is output into an already existing package. outputPackagePath := *selfPackage if outputPackagePath == "" && *destination != "" { dstPath, err := filepath.Abs(filepath.Dir(*destination)) if err == nil { pkgPath, err := parsePackageImport(dstPath) if err == nil { outputPackagePath = pkgPath } else { log.Println("Unable to infer -self_package from destination file path:", err) } } else { log.Println("Unable to determine destination file path:", err) } } g := new(generator) if *source != "" { g.filename = *source } else { g.srcPackage = packageName g.srcInterfaces = flag.Arg(1) } g.destination = *destination if *mockNames != "" { g.mockNames = parseMockNames(*mockNames) } if *copyrightFile != "" { header, err := ioutil.ReadFile(*copyrightFile) if err != nil { log.Fatalf("Failed reading copyright file: %v", err) } g.copyrightHeader = string(header) } if err := g.Generate(pkg, outputPackageName, outputPackagePath); err != nil { log.Fatalf("Failed generating mock: %v", err) } output := g.Output() dst := os.Stdout if len(*destination) > 0 { if err := os.MkdirAll(filepath.Dir(*destination), os.ModePerm); err != nil { log.Fatalf("Unable to create directory: %v", err) } existing, err := ioutil.ReadFile(*destination) if err != nil && !errors.Is(err, os.ErrNotExist) { log.Fatalf("Failed reading pre-exiting destination file: %v", err) } if len(existing) == len(output) && bytes.Compare(existing, output) == 0 { return } f, err := os.Create(*destination) if err != nil { log.Fatalf("Failed opening destination file: %v", err) } defer f.Close() dst = f } if _, err := dst.Write(output); err != nil { log.Fatalf("Failed writing to destination: %v", err) } } func parseMockNames(names string) map[string]string { mocksMap := make(map[string]string) for _, kv := range strings.Split(names, ",") { parts := strings.SplitN(kv, "=", 2) if len(parts) != 2 || parts[1] == "" { log.Fatalf("bad mock names spec: %v", kv) } mocksMap[parts[0]] = parts[1] } return mocksMap } func usage() { _, _ = io.WriteString(os.Stderr, usageText) flag.PrintDefaults() } const usageText = `mockgen has two modes of operation: source and reflect. Source mode generates mock interfaces from a source file. It is enabled by using the -source flag. Other flags that may be useful in this mode are -imports and -aux_files. Example: mockgen -source=foo.go [other options] Reflect mode generates mock interfaces by building a program that uses reflection to understand interfaces. It is enabled by passing two non-flag arguments: an import path, and a comma-separated list of symbols. Example: mockgen database/sql/driver Conn,Driver ` type generator struct { buf bytes.Buffer indent string mockNames map[string]string // may be empty filename string // may be empty destination string // may be empty srcPackage, srcInterfaces string // may be empty copyrightHeader string packageMap map[string]string // map from import path to package name } func (g *generator) p(format string, args ...interface{}) { fmt.Fprintf(&g.buf, g.indent+format+"\n", args...) } func (g *generator) in() { g.indent += "\t" } func (g *generator) out() { if len(g.indent) > 0 { g.indent = g.indent[0 : len(g.indent)-1] } } // sanitize cleans up a string to make a suitable package name. func sanitize(s string) string { t := "" for _, r := range s { if t == "" { if unicode.IsLetter(r) || r == '_' { t += string(r) continue } } else { if unicode.IsLetter(r) || unicode.IsDigit(r) || r == '_' { t += string(r) continue } } t += "_" } if t == "_" { t = "x" } return t } func (g *generator) Generate(pkg *model.Package, outputPkgName string, outputPackagePath string) error { if outputPkgName != pkg.Name && *selfPackage == "" { // reset outputPackagePath if it's not passed in through -self_package outputPackagePath = "" } if g.copyrightHeader != "" { lines := strings.Split(g.copyrightHeader, "\n") for _, line := range lines { g.p("// %s", line) } g.p("") } g.p("// Code generated by MockGen. DO NOT EDIT.") if g.filename != "" { g.p("// Source: %v", g.filename) } else { g.p("// Source: %v (interfaces: %v)", g.srcPackage, g.srcInterfaces) } g.p("") // Get all required imports, and generate unique names for them all. im := pkg.Imports() im[gomockImportPath] = true // Only import reflect if it's used. We only use reflect in mocked methods // so only import if any of the mocked interfaces have methods. for _, intf := range pkg.Interfaces { if len(intf.Methods) > 0 { im["reflect"] = true break } } // Sort keys to make import alias generation predictable sortedPaths := make([]string, len(im)) x := 0 for pth := range im { sortedPaths[x] = pth x++ } sort.Strings(sortedPaths) packagesName := createPackageMap(sortedPaths) g.packageMap = make(map[string]string, len(im)) localNames := make(map[string]bool, len(im)) for _, pth := range sortedPaths { base, ok := packagesName[pth] if !ok { base = sanitize(path.Base(pth)) } // 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"). // try base0, base1, ... pkgName := base i := 0 for localNames[pkgName] || token.Lookup(pkgName).IsKeyword() { pkgName = base + strconv.Itoa(i) i++ } // Avoid importing package if source pkg == output pkg if pth == pkg.PkgPath && outputPackagePath == pkg.PkgPath { continue } g.packageMap[pth] = pkgName localNames[pkgName] = true } if *writePkgComment { g.p("// Package %v is a generated GoMock package.", outputPkgName) } g.p("package %v", outputPkgName) g.p("") g.p("import (") g.in() for pkgPath, pkgName := range g.packageMap { if pkgPath == outputPackagePath { continue } g.p("%v %q", pkgName, pkgPath) } for _, pkgPath := range pkg.DotImports { g.p(". %q", pkgPath) } g.out() g.p(")") for _, intf := range pkg.Interfaces { if err := g.GenerateMockInterface(intf, outputPackagePath); err != nil { return err } } return nil } // The name of the mock type to use for the given interface identifier. func (g *generator) mockName(typeName string) string { if mockName, ok := g.mockNames[typeName]; ok { return mockName } return "Mock" + typeName } // formattedTypeParams returns a long and short form of type param info used for // printing. If analyzing a interface with type param [I any, O any] the result // will be: // "[I any, O any]", "[I, O]" func (g *generator) formattedTypeParams(it *model.Interface, pkgOverride string) (string, string) { if len(it.TypeParams) == 0 { return "", "" } var long, short strings.Builder long.WriteString("[") short.WriteString("[") for i, v := range it.TypeParams { if i != 0 { long.WriteString(", ") short.WriteString(", ") } long.WriteString(v.Name) short.WriteString(v.Name) long.WriteString(fmt.Sprintf(" %s", v.Type.String(g.packageMap, pkgOverride))) } long.WriteString("]") short.WriteString("]") return long.String(), short.String() } func (g *generator) GenerateMockInterface(intf *model.Interface, outputPackagePath string) error { mockType := g.mockName(intf.Name) longTp, shortTp := g.formattedTypeParams(intf, outputPackagePath) g.p("") g.p("// %v is a mock of %v interface.", mockType, intf.Name) g.p("type %v%v struct {", mockType, longTp) g.in() g.p("ctrl *gomock.Controller") g.p("recorder *%vMockRecorder%v", mockType, shortTp) g.out() g.p("}") g.p("") g.p("// %vMockRecorder is the mock recorder for %v.", mockType, mockType) g.p("type %vMockRecorder%v struct {", mockType, longTp) g.in() g.p("mock *%v%v", mockType, shortTp) g.out() g.p("}") g.p("") g.p("// New%v creates a new mock instance.", mockType) g.p("func New%v%v(ctrl *gomock.Controller) *%v%v {", mockType, longTp, mockType, shortTp) g.in() g.p("mock := &%v%v{ctrl: ctrl}", mockType, shortTp) g.p("mock.recorder = &%vMockRecorder%v{mock}", mockType, shortTp) g.p("return mock") g.out() g.p("}") g.p("") // XXX: possible name collision here if someone has EXPECT in their interface. g.p("// EXPECT returns an object that allows the caller to indicate expected use.") g.p("func (m *%v%v) EXPECT() *%vMockRecorder%v {", mockType, shortTp, mockType, shortTp) g.in() g.p("return m.recorder") g.out() g.p("}") g.GenerateMockMethods(mockType, intf, outputPackagePath, shortTp) return nil } type byMethodName []*model.Method func (b byMethodName) Len() int { return len(b) } func (b byMethodName) Swap(i, j int) { b[i], b[j] = b[j], b[i] } func (b byMethodName) Less(i, j int) bool { return b[i].Name < b[j].Name } func (g *generator) GenerateMockMethods(mockType string, intf *model.Interface, pkgOverride, shortTp string) { sort.Sort(byMethodName(intf.Methods)) for _, m := range intf.Methods { g.p("") _ = g.GenerateMockMethod(mockType, m, pkgOverride, shortTp) g.p("") _ = g.GenerateMockRecorderMethod(mockType, m, shortTp) } } func makeArgString(argNames, argTypes []string) string { args := make([]string, len(argNames)) for i, name := range argNames { // specify the type only once for consecutive args of the same type if i+1 < len(argTypes) && argTypes[i] == argTypes[i+1] { args[i] = name } else { args[i] = name + " " + argTypes[i] } } return strings.Join(args, ", ") } // GenerateMockMethod generates a mock method implementation. // If non-empty, pkgOverride is the package in which unqualified types reside. func (g *generator) GenerateMockMethod(mockType string, m *model.Method, pkgOverride, shortTp string) error { argNames := g.getArgNames(m) argTypes := g.getArgTypes(m, pkgOverride) argString := makeArgString(argNames, argTypes) rets := make([]string, len(m.Out)) for i, p := range m.Out { rets[i] = p.Type.String(g.packageMap, pkgOverride) } retString := strings.Join(rets, ", ") if len(rets) > 1 { retString = "(" + retString + ")" } if retString != "" { retString = " " + retString } ia := newIdentifierAllocator(argNames) idRecv := ia.allocateIdentifier("m") g.p("// %v mocks base method.", m.Name) g.p("func (%v *%v%v) %v(%v)%v {", idRecv, mockType, shortTp, m.Name, argString, retString) g.in() g.p("%s.ctrl.T.Helper()", idRecv) var callArgs string if m.Variadic == nil { if len(argNames) > 0 { callArgs = ", " + strings.Join(argNames, ", ") } } else { // Non-trivial. The generated code must build a []interface{}, // but the variadic argument may be any type. idVarArgs := ia.allocateIdentifier("varargs") idVArg := ia.allocateIdentifier("a") g.p("%s := []interface{}{%s}", idVarArgs, strings.Join(argNames[:len(argNames)-1], ", ")) g.p("for _, %s := range %s {", idVArg, argNames[len(argNames)-1]) g.in() g.p("%s = append(%s, %s)", idVarArgs, idVarArgs, idVArg) g.out() g.p("}") callArgs = ", " + idVarArgs + "..." } if len(m.Out) == 0 { g.p(`%v.ctrl.Call(%v, %q%v)`, idRecv, idRecv, m.Name, callArgs) } else { idRet := ia.allocateIdentifier("ret") g.p(`%v := %v.ctrl.Call(%v, %q%v)`, idRet, idRecv, idRecv, m.Name, callArgs) // Go does not allow "naked" type assertions on nil values, so we use the two-value form here. // The value of that is either (x.(T), true) or (Z, false), where Z is the zero value for T. // Happily, this coincides with the semantics we want here. retNames := make([]string, len(rets)) for i, t := range rets { retNames[i] = ia.allocateIdentifier(fmt.Sprintf("ret%d", i)) g.p("%s, _ := %s[%d].(%s)", retNames[i], idRet, i, t) } g.p("return " + strings.Join(retNames, ", ")) } g.out() g.p("}") return nil } func (g *generator) GenerateMockRecorderMethod(mockType string, m *model.Method, shortTp string) error { argNames := g.getArgNames(m) var argString string if m.Variadic == nil { argString = strings.Join(argNames, ", ") } else { argString = strings.Join(argNames[:len(argNames)-1], ", ") } if argString != "" { argString += " interface{}" } if m.Variadic != nil { if argString != "" { argString += ", " } argString += fmt.Sprintf("%s ...interface{}", argNames[len(argNames)-1]) } ia := newIdentifierAllocator(argNames) idRecv := ia.allocateIdentifier("mr") g.p("// %v indicates an expected call of %v.", m.Name, m.Name) g.p("func (%s *%vMockRecorder%v) %v(%v) *gomock.Call {", idRecv, mockType, shortTp, m.Name, argString) g.in() g.p("%s.mock.ctrl.T.Helper()", idRecv) var callArgs string if m.Variadic == nil { if len(argNames) > 0 { callArgs = ", " + strings.Join(argNames, ", ") } } else { if len(argNames) == 1 { // Easy: just use ... to push the arguments through. callArgs = ", " + argNames[0] + "..." } else { // Hard: create a temporary slice. idVarArgs := ia.allocateIdentifier("varargs") g.p("%s := append([]interface{}{%s}, %s...)", idVarArgs, strings.Join(argNames[:len(argNames)-1], ", "), argNames[len(argNames)-1]) callArgs = ", " + idVarArgs + "..." } } g.p(`return %s.mock.ctrl.RecordCallWithMethodType(%s.mock, "%s", reflect.TypeOf((*%s%s)(nil).%s)%s)`, idRecv, idRecv, m.Name, mockType, shortTp, m.Name, callArgs) g.out() g.p("}") return nil } func (g *generator) getArgNames(m *model.Method) []string { argNames := make([]string, len(m.In)) for i, p := range m.In { name := p.Name if name == "" || name == "_" { name = fmt.Sprintf("arg%d", i) } argNames[i] = name } if m.Variadic != nil { name := m.Variadic.Name if name == "" { name = fmt.Sprintf("arg%d", len(m.In)) } argNames = append(argNames, name) } return argNames } func (g *generator) getArgTypes(m *model.Method, pkgOverride string) []string { argTypes := make([]string, len(m.In)) for i, p := range m.In { argTypes[i] = p.Type.String(g.packageMap, pkgOverride) } if m.Variadic != nil { argTypes = append(argTypes, "..."+m.Variadic.Type.String(g.packageMap, pkgOverride)) } return argTypes } type identifierAllocator map[string]struct{} func newIdentifierAllocator(taken []string) identifierAllocator { a := make(identifierAllocator, len(taken)) for _, s := range taken { a[s] = struct{}{} } return a } func (o identifierAllocator) allocateIdentifier(want string) string { id := want for i := 2; ; i++ { if _, ok := o[id]; !ok { o[id] = struct{}{} return id } id = want + "_" + strconv.Itoa(i) } } // Output returns the generator's output, formatted in the standard Go style. func (g *generator) Output() []byte { src, err := toolsimports.Process(g.destination, g.buf.Bytes(), nil) if err != nil { log.Fatalf("Failed to format generated source code: %s\n%s", err, g.buf.String()) } return src } // createPackageMap returns a map of import path to package name // for specified importPaths. func createPackageMap(importPaths []string) map[string]string { var pkg struct { Name string ImportPath string } pkgMap := make(map[string]string) b := bytes.NewBuffer(nil) args := []string{"list", "-json"} args = append(args, importPaths...) cmd := exec.Command("go", args...) cmd.Stdout = b cmd.Run() dec := json.NewDecoder(b) for dec.More() { err := dec.Decode(&pkg) if err != nil { log.Printf("failed to decode 'go list' output: %v", err) continue } pkgMap[pkg.ImportPath] = pkg.Name } return pkgMap } func printVersion() { if version != "" { fmt.Printf("v%s\nCommit: %s\nDate: %s\n", version, commit, date) } else { printModuleVersion() } } // parseImportPackage get package import path via source file // an alternative implementation is to use: // cfg := &packages.Config{Mode: packages.NeedName, Tests: true, Dir: srcDir} // pkgs, err := packages.Load(cfg, "file="+source) // However, it will call "go list" and slow down the performance func parsePackageImport(srcDir string) (string, error) { moduleMode := os.Getenv("GO111MODULE") // trying to find the module if moduleMode != "off" { currentDir := srcDir for { dat, err := ioutil.ReadFile(filepath.Join(currentDir, "go.mod")) if os.IsNotExist(err) { if currentDir == filepath.Dir(currentDir) { // at the root break } currentDir = filepath.Dir(currentDir) continue } else if err != nil { return "", err } modulePath := modfile.ModulePath(dat) return filepath.ToSlash(filepath.Join(modulePath, strings.TrimPrefix(srcDir, currentDir))), nil } } // fall back to GOPATH mode goPaths := os.Getenv("GOPATH") if goPaths == "" { return "", fmt.Errorf("GOPATH is not set") } goPathList := strings.Split(goPaths, string(os.PathListSeparator)) for _, goPath := range goPathList { sourceRoot := filepath.Join(goPath, "src") + string(os.PathSeparator) if strings.HasPrefix(srcDir, sourceRoot) { return filepath.ToSlash(strings.TrimPrefix(srcDir, sourceRoot)), nil } } return "", errOutsideGoPath } ================================================ FILE: mockgen/mockgen_test.go ================================================ package main import ( "fmt" "io/ioutil" "os" "path/filepath" "reflect" "regexp" "strings" "testing" "github.com/golang/mock/mockgen/model" ) func TestMakeArgString(t *testing.T) { testCases := []struct { argNames []string argTypes []string argString string }{ { argNames: nil, argTypes: nil, argString: "", }, { argNames: []string{"arg0"}, argTypes: []string{"int"}, argString: "arg0 int", }, { argNames: []string{"arg0", "arg1"}, argTypes: []string{"int", "bool"}, argString: "arg0 int, arg1 bool", }, { argNames: []string{"arg0", "arg1"}, argTypes: []string{"int", "int"}, argString: "arg0, arg1 int", }, { argNames: []string{"arg0", "arg1", "arg2"}, argTypes: []string{"bool", "int", "int"}, argString: "arg0 bool, arg1, arg2 int", }, { argNames: []string{"arg0", "arg1", "arg2"}, argTypes: []string{"int", "bool", "int"}, argString: "arg0 int, arg1 bool, arg2 int", }, { argNames: []string{"arg0", "arg1", "arg2"}, argTypes: []string{"int", "int", "bool"}, argString: "arg0, arg1 int, arg2 bool", }, { argNames: []string{"arg0", "arg1", "arg2"}, argTypes: []string{"int", "int", "int"}, argString: "arg0, arg1, arg2 int", }, { argNames: []string{"arg0", "arg1", "arg2", "arg3"}, argTypes: []string{"bool", "int", "int", "int"}, argString: "arg0 bool, arg1, arg2, arg3 int", }, { argNames: []string{"arg0", "arg1", "arg2", "arg3"}, argTypes: []string{"int", "bool", "int", "int"}, argString: "arg0 int, arg1 bool, arg2, arg3 int", }, { argNames: []string{"arg0", "arg1", "arg2", "arg3"}, argTypes: []string{"int", "int", "bool", "int"}, argString: "arg0, arg1 int, arg2 bool, arg3 int", }, { argNames: []string{"arg0", "arg1", "arg2", "arg3"}, argTypes: []string{"int", "int", "int", "bool"}, argString: "arg0, arg1, arg2 int, arg3 bool", }, { argNames: []string{"arg0", "arg1", "arg2", "arg3", "arg4"}, argTypes: []string{"bool", "int", "int", "int", "bool"}, argString: "arg0 bool, arg1, arg2, arg3 int, arg4 bool", }, { argNames: []string{"arg0", "arg1", "arg2", "arg3", "arg4"}, argTypes: []string{"int", "bool", "int", "int", "bool"}, argString: "arg0 int, arg1 bool, arg2, arg3 int, arg4 bool", }, { argNames: []string{"arg0", "arg1", "arg2", "arg3", "arg4"}, argTypes: []string{"int", "int", "bool", "int", "bool"}, argString: "arg0, arg1 int, arg2 bool, arg3 int, arg4 bool", }, { argNames: []string{"arg0", "arg1", "arg2", "arg3", "arg4"}, argTypes: []string{"int", "int", "int", "bool", "bool"}, argString: "arg0, arg1, arg2 int, arg3, arg4 bool", }, { argNames: []string{"arg0", "arg1", "arg2", "arg3", "arg4"}, argTypes: []string{"int", "int", "bool", "bool", "int"}, argString: "arg0, arg1 int, arg2, arg3 bool, arg4 int", }, } for i, tc := range testCases { t.Run(fmt.Sprintf("#%d", i), func(t *testing.T) { s := makeArgString(tc.argNames, tc.argTypes) if s != tc.argString { t.Errorf("result == %q, want %q", s, tc.argString) } }) } } func TestNewIdentifierAllocator(t *testing.T) { a := newIdentifierAllocator([]string{"taken1", "taken2"}) if len(a) != 2 { t.Fatalf("expected 2 items, got %v", len(a)) } _, ok := a["taken1"] if !ok { t.Errorf("allocator doesn't contain 'taken1': %#v", a) } _, ok = a["taken2"] if !ok { t.Errorf("allocator doesn't contain 'taken2': %#v", a) } } func allocatorContainsIdentifiers(a identifierAllocator, ids []string) bool { if len(a) != len(ids) { return false } for _, id := range ids { _, ok := a[id] if !ok { return false } } return true } func TestIdentifierAllocator_allocateIdentifier(t *testing.T) { a := newIdentifierAllocator([]string{"taken"}) t2 := a.allocateIdentifier("taken_2") if t2 != "taken_2" { t.Fatalf("expected 'taken_2', got %q", t2) } expected := []string{"taken", "taken_2"} if !allocatorContainsIdentifiers(a, expected) { t.Fatalf("allocator doesn't contain the expected items - allocator: %#v, expected items: %#v", a, expected) } t3 := a.allocateIdentifier("taken") if t3 != "taken_3" { t.Fatalf("expected 'taken_3', got %q", t3) } expected = []string{"taken", "taken_2", "taken_3"} if !allocatorContainsIdentifiers(a, expected) { t.Fatalf("allocator doesn't contain the expected items - allocator: %#v, expected items: %#v", a, expected) } t4 := a.allocateIdentifier("taken") if t4 != "taken_4" { t.Fatalf("expected 'taken_4', got %q", t4) } expected = []string{"taken", "taken_2", "taken_3", "taken_4"} if !allocatorContainsIdentifiers(a, expected) { t.Fatalf("allocator doesn't contain the expected items - allocator: %#v, expected items: %#v", a, expected) } id := a.allocateIdentifier("id") if id != "id" { t.Fatalf("expected 'id', got %q", id) } expected = []string{"taken", "taken_2", "taken_3", "taken_4", "id"} if !allocatorContainsIdentifiers(a, expected) { t.Fatalf("allocator doesn't contain the expected items - allocator: %#v, expected items: %#v", a, expected) } } func TestGenerateMockInterface_Helper(t *testing.T) { for _, test := range []struct { Name string Identifier string HelperLine string Methods []*model.Method }{ {Name: "mock", Identifier: "MockSomename", HelperLine: "m.ctrl.T.Helper()"}, {Name: "recorder", Identifier: "MockSomenameMockRecorder", HelperLine: "mr.mock.ctrl.T.Helper()"}, { Name: "mock identifier conflict", Identifier: "MockSomename", HelperLine: "m_2.ctrl.T.Helper()", Methods: []*model.Method{ { Name: "MethodA", In: []*model.Parameter{ { Name: "m", Type: &model.NamedType{Type: "int"}, }, }, }, }, }, { Name: "recorder identifier conflict", Identifier: "MockSomenameMockRecorder", HelperLine: "mr_2.mock.ctrl.T.Helper()", Methods: []*model.Method{ { Name: "MethodA", In: []*model.Parameter{ { Name: "mr", Type: &model.NamedType{Type: "int"}, }, }, }, }, }, } { t.Run(test.Name, func(t *testing.T) { g := generator{} if len(test.Methods) == 0 { test.Methods = []*model.Method{ {Name: "MethodA"}, {Name: "MethodB"}, } } intf := &model.Interface{Name: "Somename"} for _, m := range test.Methods { intf.AddMethod(m) } if err := g.GenerateMockInterface(intf, "somepackage"); err != nil { t.Fatal(err) } lines := strings.Split(g.buf.String(), "\n") // T.Helper() should be the first line for _, method := range test.Methods { if strings.TrimSpace(lines[findMethod(t, test.Identifier, method.Name, lines)+1]) != test.HelperLine { t.Fatalf("method %s.%s did not declare itself a Helper method", test.Identifier, method.Name) } } }) } } func findMethod(t *testing.T, identifier, methodName string, lines []string) int { t.Helper() r := regexp.MustCompile(fmt.Sprintf(`func\s+\(.+%s\)\s*%s`, identifier, methodName)) for i, line := range lines { if r.MatchString(line) { return i } } t.Fatalf("unable to find 'func (m %s) %s'", identifier, methodName) panic("unreachable") } func TestGetArgNames(t *testing.T) { for _, testCase := range []struct { name string method *model.Method expected []string }{ { name: "NamedArg", method: &model.Method{ In: []*model.Parameter{ { Name: "firstArg", Type: &model.NamedType{Type: "int"}, }, { Name: "secondArg", Type: &model.NamedType{Type: "string"}, }, }, }, expected: []string{"firstArg", "secondArg"}, }, { name: "NotNamedArg", method: &model.Method{ In: []*model.Parameter{ { Name: "", Type: &model.NamedType{Type: "int"}, }, { Name: "", Type: &model.NamedType{Type: "string"}, }, }, }, expected: []string{"arg0", "arg1"}, }, { name: "MixedNameArg", method: &model.Method{ In: []*model.Parameter{ { Name: "firstArg", Type: &model.NamedType{Type: "int"}, }, { Name: "_", Type: &model.NamedType{Type: "string"}, }, }, }, expected: []string{"firstArg", "arg1"}, }, } { t.Run(testCase.name, func(t *testing.T) { g := generator{} result := g.getArgNames(testCase.method) if !reflect.DeepEqual(result, testCase.expected) { t.Fatalf("expected %s, got %s", result, testCase.expected) } }) } } func Test_createPackageMap(t *testing.T) { tests := []struct { name string importPath string wantPackageName string wantOK bool }{ {"golang package", "context", "context", true}, {"third party", "golang.org/x/tools/present", "present", true}, } var importPaths []string for _, t := range tests { importPaths = append(importPaths, t.importPath) } packages := createPackageMap(importPaths) for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { gotPackageName, gotOk := packages[tt.importPath] if gotPackageName != tt.wantPackageName { t.Errorf("createPackageMap() gotPackageName = %v, wantPackageName = %v", gotPackageName, tt.wantPackageName) } if gotOk != tt.wantOK { t.Errorf("createPackageMap() gotOk = %v, wantOK = %v", gotOk, tt.wantOK) } }) } } func TestParsePackageImport_FallbackGoPath(t *testing.T) { goPath, err := ioutil.TempDir("", "gopath") if err != nil { t.Error(err) } defer func() { if err = os.RemoveAll(goPath); err != nil { t.Error(err) } }() srcDir := filepath.Join(goPath, "src/example.com/foo") err = os.MkdirAll(srcDir, 0755) if err != nil { t.Error(err) } key := "GOPATH" value := goPath if err := os.Setenv(key, value); err != nil { t.Fatalf("unable to set environment variable %q to %q: %v", key, value, err) } key = "GO111MODULE" value = "on" if err := os.Setenv(key, value); err != nil { t.Fatalf("unable to set environment variable %q to %q: %v", key, value, err) } pkgPath, err := parsePackageImport(srcDir) expected := "example.com/foo" if pkgPath != expected { t.Errorf("expect %s, got %s", expected, pkgPath) } } func TestParsePackageImport_FallbackMultiGoPath(t *testing.T) { var goPathList []string // first gopath goPath, err := ioutil.TempDir("", "gopath1") if err != nil { t.Error(err) } goPathList = append(goPathList, goPath) defer func() { if err = os.RemoveAll(goPath); err != nil { t.Error(err) } }() srcDir := filepath.Join(goPath, "src/example.com/foo") err = os.MkdirAll(srcDir, 0755) if err != nil { t.Error(err) } // second gopath goPath, err = ioutil.TempDir("", "gopath2") if err != nil { t.Error(err) } goPathList = append(goPathList, goPath) defer func() { if err = os.RemoveAll(goPath); err != nil { t.Error(err) } }() goPaths := strings.Join(goPathList, string(os.PathListSeparator)) key := "GOPATH" value := goPaths if err := os.Setenv(key, value); err != nil { t.Fatalf("unable to set environment variable %q to %q: %v", key, value, err) } key = "GO111MODULE" value = "on" if err := os.Setenv(key, value); err != nil { t.Fatalf("unable to set environment variable %q to %q: %v", key, value, err) } pkgPath, err := parsePackageImport(srcDir) expected := "example.com/foo" if pkgPath != expected { t.Errorf("expect %s, got %s", expected, pkgPath) } } ================================================ FILE: mockgen/model/model.go ================================================ // Copyright 2012 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // Package model contains the data model necessary for generating mock implementations. package model import ( "encoding/gob" "fmt" "io" "reflect" "strings" ) // pkgPath is the importable path for package model const pkgPath = "github.com/golang/mock/mockgen/model" // Package is a Go package. It may be a subset. type Package struct { Name string PkgPath string Interfaces []*Interface DotImports []string } // Print writes the package name and its exported interfaces. func (pkg *Package) Print(w io.Writer) { _, _ = fmt.Fprintf(w, "package %s\n", pkg.Name) for _, intf := range pkg.Interfaces { intf.Print(w) } } // Imports returns the imports needed by the Package as a set of import paths. func (pkg *Package) Imports() map[string]bool { im := make(map[string]bool) for _, intf := range pkg.Interfaces { intf.addImports(im) for _, tp := range intf.TypeParams { tp.Type.addImports(im) } } return im } // Interface is a Go interface. type Interface struct { Name string Methods []*Method TypeParams []*Parameter } // Print writes the interface name and its methods. func (intf *Interface) Print(w io.Writer) { _, _ = fmt.Fprintf(w, "interface %s\n", intf.Name) for _, m := range intf.Methods { m.Print(w) } } func (intf *Interface) addImports(im map[string]bool) { for _, m := range intf.Methods { m.addImports(im) } } // AddMethod adds a new method, de-duplicating by method name. func (intf *Interface) AddMethod(m *Method) { for _, me := range intf.Methods { if me.Name == m.Name { return } } intf.Methods = append(intf.Methods, m) } // Method is a single method of an interface. type Method struct { Name string In, Out []*Parameter Variadic *Parameter // may be nil } // Print writes the method name and its signature. func (m *Method) Print(w io.Writer) { _, _ = fmt.Fprintf(w, " - method %s\n", m.Name) if len(m.In) > 0 { _, _ = fmt.Fprintf(w, " in:\n") for _, p := range m.In { p.Print(w) } } if m.Variadic != nil { _, _ = fmt.Fprintf(w, " ...:\n") m.Variadic.Print(w) } if len(m.Out) > 0 { _, _ = fmt.Fprintf(w, " out:\n") for _, p := range m.Out { p.Print(w) } } } func (m *Method) addImports(im map[string]bool) { for _, p := range m.In { p.Type.addImports(im) } if m.Variadic != nil { m.Variadic.Type.addImports(im) } for _, p := range m.Out { p.Type.addImports(im) } } // Parameter is an argument or return parameter of a method. type Parameter struct { Name string // may be empty Type Type } // Print writes a method parameter. func (p *Parameter) Print(w io.Writer) { n := p.Name if n == "" { n = `""` } _, _ = fmt.Fprintf(w, " - %v: %v\n", n, p.Type.String(nil, "")) } // Type is a Go type. type Type interface { String(pm map[string]string, pkgOverride string) string addImports(im map[string]bool) } func init() { gob.Register(&ArrayType{}) gob.Register(&ChanType{}) gob.Register(&FuncType{}) gob.Register(&MapType{}) gob.Register(&NamedType{}) gob.Register(&PointerType{}) // Call gob.RegisterName to make sure it has the consistent name registered // for both gob decoder and encoder. // // For a non-pointer type, gob.Register will try to get package full path by // calling rt.PkgPath() for a name to register. If your project has vendor // directory, it is possible that PkgPath will get a path like this: // ../../../vendor/github.com/golang/mock/mockgen/model gob.RegisterName(pkgPath+".PredeclaredType", PredeclaredType("")) } // ArrayType is an array or slice type. type ArrayType struct { Len int // -1 for slices, >= 0 for arrays Type Type } func (at *ArrayType) String(pm map[string]string, pkgOverride string) string { s := "[]" if at.Len > -1 { s = fmt.Sprintf("[%d]", at.Len) } return s + at.Type.String(pm, pkgOverride) } func (at *ArrayType) addImports(im map[string]bool) { at.Type.addImports(im) } // ChanType is a channel type. type ChanType struct { Dir ChanDir // 0, 1 or 2 Type Type } func (ct *ChanType) String(pm map[string]string, pkgOverride string) string { s := ct.Type.String(pm, pkgOverride) if ct.Dir == RecvDir { return "<-chan " + s } if ct.Dir == SendDir { return "chan<- " + s } return "chan " + s } func (ct *ChanType) addImports(im map[string]bool) { ct.Type.addImports(im) } // ChanDir is a channel direction. type ChanDir int // Constants for channel directions. const ( RecvDir ChanDir = 1 SendDir ChanDir = 2 ) // FuncType is a function type. type FuncType struct { In, Out []*Parameter Variadic *Parameter // may be nil } func (ft *FuncType) String(pm map[string]string, pkgOverride string) string { args := make([]string, len(ft.In)) for i, p := range ft.In { args[i] = p.Type.String(pm, pkgOverride) } if ft.Variadic != nil { args = append(args, "..."+ft.Variadic.Type.String(pm, pkgOverride)) } rets := make([]string, len(ft.Out)) for i, p := range ft.Out { rets[i] = p.Type.String(pm, pkgOverride) } retString := strings.Join(rets, ", ") if nOut := len(ft.Out); nOut == 1 { retString = " " + retString } else if nOut > 1 { retString = " (" + retString + ")" } return "func(" + strings.Join(args, ", ") + ")" + retString } func (ft *FuncType) addImports(im map[string]bool) { for _, p := range ft.In { p.Type.addImports(im) } if ft.Variadic != nil { ft.Variadic.Type.addImports(im) } for _, p := range ft.Out { p.Type.addImports(im) } } // MapType is a map type. type MapType struct { Key, Value Type } func (mt *MapType) String(pm map[string]string, pkgOverride string) string { return "map[" + mt.Key.String(pm, pkgOverride) + "]" + mt.Value.String(pm, pkgOverride) } func (mt *MapType) addImports(im map[string]bool) { mt.Key.addImports(im) mt.Value.addImports(im) } // NamedType is an exported type in a package. type NamedType struct { Package string // may be empty Type string TypeParams *TypeParametersType } func (nt *NamedType) String(pm map[string]string, pkgOverride string) string { if pkgOverride == nt.Package { return nt.Type + nt.TypeParams.String(pm, pkgOverride) } prefix := pm[nt.Package] if prefix != "" { return prefix + "." + nt.Type + nt.TypeParams.String(pm, pkgOverride) } return nt.Type + nt.TypeParams.String(pm, pkgOverride) } func (nt *NamedType) addImports(im map[string]bool) { if nt.Package != "" { im[nt.Package] = true } nt.TypeParams.addImports(im) } // PointerType is a pointer to another type. type PointerType struct { Type Type } func (pt *PointerType) String(pm map[string]string, pkgOverride string) string { return "*" + pt.Type.String(pm, pkgOverride) } func (pt *PointerType) addImports(im map[string]bool) { pt.Type.addImports(im) } // PredeclaredType is a predeclared type such as "int". type PredeclaredType string func (pt PredeclaredType) String(map[string]string, string) string { return string(pt) } func (pt PredeclaredType) addImports(map[string]bool) {} // TypeParametersType contains type paramters for a NamedType. type TypeParametersType struct { TypeParameters []Type } func (tp *TypeParametersType) String(pm map[string]string, pkgOverride string) string { if tp == nil || len(tp.TypeParameters) == 0 { return "" } var sb strings.Builder sb.WriteString("[") for i, v := range tp.TypeParameters { if i != 0 { sb.WriteString(", ") } sb.WriteString(v.String(pm, pkgOverride)) } sb.WriteString("]") return sb.String() } func (tp *TypeParametersType) addImports(im map[string]bool) { if tp == nil { return } for _, v := range tp.TypeParameters { v.addImports(im) } } // The following code is intended to be called by the program generated by ../reflect.go. // InterfaceFromInterfaceType returns a pointer to an interface for the // given reflection interface type. func InterfaceFromInterfaceType(it reflect.Type) (*Interface, error) { if it.Kind() != reflect.Interface { return nil, fmt.Errorf("%v is not an interface", it) } intf := &Interface{} for i := 0; i < it.NumMethod(); i++ { mt := it.Method(i) // TODO: need to skip unexported methods? or just raise an error? m := &Method{ Name: mt.Name, } var err error m.In, m.Variadic, m.Out, err = funcArgsFromType(mt.Type) if err != nil { return nil, err } intf.AddMethod(m) } return intf, nil } // t's Kind must be a reflect.Func. func funcArgsFromType(t reflect.Type) (in []*Parameter, variadic *Parameter, out []*Parameter, err error) { nin := t.NumIn() if t.IsVariadic() { nin-- } var p *Parameter for i := 0; i < nin; i++ { p, err = parameterFromType(t.In(i)) if err != nil { return } in = append(in, p) } if t.IsVariadic() { p, err = parameterFromType(t.In(nin).Elem()) if err != nil { return } variadic = p } for i := 0; i < t.NumOut(); i++ { p, err = parameterFromType(t.Out(i)) if err != nil { return } out = append(out, p) } return } func parameterFromType(t reflect.Type) (*Parameter, error) { tt, err := typeFromType(t) if err != nil { return nil, err } return &Parameter{Type: tt}, nil } var errorType = reflect.TypeOf((*error)(nil)).Elem() var byteType = reflect.TypeOf(byte(0)) func typeFromType(t reflect.Type) (Type, error) { // Hack workaround for https://golang.org/issue/3853. // This explicit check should not be necessary. if t == byteType { return PredeclaredType("byte"), nil } if imp := t.PkgPath(); imp != "" { return &NamedType{ Package: impPath(imp), Type: t.Name(), }, nil } // only unnamed or predeclared types after here // Lots of types have element types. Let's do the parsing and error checking for all of them. var elemType Type switch t.Kind() { case reflect.Array, reflect.Chan, reflect.Map, reflect.Ptr, reflect.Slice: var err error elemType, err = typeFromType(t.Elem()) if err != nil { return nil, err } } switch t.Kind() { case reflect.Array: return &ArrayType{ Len: t.Len(), Type: elemType, }, nil case reflect.Bool, reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr, reflect.Float32, reflect.Float64, reflect.Complex64, reflect.Complex128, reflect.String: return PredeclaredType(t.Kind().String()), nil case reflect.Chan: var dir ChanDir switch t.ChanDir() { case reflect.RecvDir: dir = RecvDir case reflect.SendDir: dir = SendDir } return &ChanType{ Dir: dir, Type: elemType, }, nil case reflect.Func: in, variadic, out, err := funcArgsFromType(t) if err != nil { return nil, err } return &FuncType{ In: in, Out: out, Variadic: variadic, }, nil case reflect.Interface: // Two special interfaces. if t.NumMethod() == 0 { return PredeclaredType("interface{}"), nil } if t == errorType { return PredeclaredType("error"), nil } case reflect.Map: kt, err := typeFromType(t.Key()) if err != nil { return nil, err } return &MapType{ Key: kt, Value: elemType, }, nil case reflect.Ptr: return &PointerType{ Type: elemType, }, nil case reflect.Slice: return &ArrayType{ Len: -1, Type: elemType, }, nil case reflect.Struct: if t.NumField() == 0 { return PredeclaredType("struct{}"), nil } } // TODO: Struct, UnsafePointer return nil, fmt.Errorf("can't yet turn %v (%v) into a model.Type", t, t.Kind()) } // impPath sanitizes the package path returned by `PkgPath` method of a reflect Type so that // it is importable. PkgPath might return a path that includes "vendor". These paths do not // compile, so we need to remove everything up to and including "/vendor/". // See https://github.com/golang/go/issues/12019. func impPath(imp string) string { if strings.HasPrefix(imp, "vendor/") { imp = "/" + imp } if i := strings.LastIndex(imp, "/vendor/"); i != -1 { imp = imp[i+len("/vendor/"):] } return imp } // ErrorInterface represent built-in error interface. var ErrorInterface = Interface{ Name: "error", Methods: []*Method{ { Name: "Error", Out: []*Parameter{ { Name: "", Type: PredeclaredType("string"), }, }, }, }, } ================================================ FILE: mockgen/model/model_test.go ================================================ package model import ( "fmt" "testing" ) func TestImpPath(t *testing.T) { nonVendor := "github.com/foo/bar" if nonVendor != impPath(nonVendor) { t.Errorf("") } testCases := []struct { input string want string }{ {"foo/bar", "foo/bar"}, {"vendor/foo/bar", "foo/bar"}, {"vendor/foo/vendor/bar", "bar"}, {"/vendor/foo/bar", "foo/bar"}, {"qux/vendor/foo/bar", "foo/bar"}, {"qux/vendor/foo/vendor/bar", "bar"}, {"govendor/foo", "govendor/foo"}, {"foo/govendor/bar", "foo/govendor/bar"}, {"vendors/foo", "vendors/foo"}, {"foo/vendors/bar", "foo/vendors/bar"}, } for _, tc := range testCases { t.Run(fmt.Sprintf("input %s", tc.input), func(t *testing.T) { if got := impPath(tc.input); got != tc.want { t.Errorf("got %s; want %s", got, tc.want) } }) } } ================================================ FILE: mockgen/parse.go ================================================ // Copyright 2012 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package main // This file contains the model construction by parsing source files. import ( "errors" "flag" "fmt" "go/ast" "go/build" "go/importer" "go/parser" "go/token" "go/types" "io/ioutil" "log" "path" "path/filepath" "strconv" "strings" "github.com/golang/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)) if err != nil { return nil, fmt.Errorf("failed getting source directory: %v", err) } packageImport, err := parsePackageImport(srcDir) if err != nil { return nil, err } fs := token.NewFileSet() file, err := parser.ParseFile(fs, source, nil, 0) if err != nil { return nil, fmt.Errorf("failed parsing source file %v: %v", source, err) } p := &fileParser{ fileSet: fs, imports: make(map[string]importedPackage), importedInterfaces: newInterfaceCache(), auxInterfaces: newInterfaceCache(), srcDir: srcDir, } // Handle -imports. dotImports := make(map[string]bool) if *imports != "" { for _, kv := range strings.Split(*imports, ",") { eq := strings.Index(kv, "=") k, v := kv[:eq], kv[eq+1:] if k == "." { dotImports[v] = true } else { p.imports[k] = importedPkg{path: v} } } } // Handle -aux_files. if err := p.parseAuxFiles(*auxFiles); err != nil { return nil, err } p.addAuxInterfacesFromFile(packageImport, file) // this file pkg, err := p.parseFile(packageImport, file) if err != nil { return nil, err } for pkgPath := range dotImports { pkg.DotImports = append(pkg.DotImports, pkgPath) } return pkg, nil } type importedPackage interface { Path() string Parser() *fileParser } type importedPkg struct { path string parser *fileParser } func (i importedPkg) Path() string { return i.path } func (i importedPkg) Parser() *fileParser { return i.parser } // duplicateImport is a bit of a misnomer. Currently the parser can't // handle cases of multi-file packages importing different packages // under the same name. Often these imports would not be problematic, // so this type lets us defer raising an error unless the package name // is actually used. type duplicateImport struct { name string duplicates []string } func (d duplicateImport) Error() string { return fmt.Sprintf("%q is ambiguous because of duplicate imports: %v", d.name, d.duplicates) } func (d duplicateImport) Path() string { log.Fatal(d.Error()); return "" } func (d duplicateImport) Parser() *fileParser { log.Fatal(d.Error()); return nil } type interfaceCache struct { m map[string]map[string]*namedInterface } func newInterfaceCache() *interfaceCache { return &interfaceCache{ m: make(map[string]map[string]*namedInterface), } } func (i *interfaceCache) Set(pkg, name string, it *namedInterface) { if _, ok := i.m[pkg]; !ok { i.m[pkg] = make(map[string]*namedInterface) } i.m[pkg][name] = it } func (i *interfaceCache) Get(pkg, name string) *namedInterface { if _, ok := i.m[pkg]; !ok { return nil } return i.m[pkg][name] } func (i *interfaceCache) GetASTIface(pkg, name string) *ast.InterfaceType { if _, ok := i.m[pkg]; !ok { return nil } it, ok := i.m[pkg][name] if !ok { return nil } return it.it } type fileParser struct { fileSet *token.FileSet imports map[string]importedPackage // package name => imported package importedInterfaces *interfaceCache auxFiles []*ast.File auxInterfaces *interfaceCache srcDir string } func (p *fileParser) errorf(pos token.Pos, format string, args ...interface{}) error { ps := p.fileSet.Position(pos) format = "%s:%d:%d: " + format args = append([]interface{}{ps.Filename, ps.Line, ps.Column}, args...) return fmt.Errorf(format, args...) } func (p *fileParser) parseAuxFiles(auxFiles string) error { auxFiles = strings.TrimSpace(auxFiles) if auxFiles == "" { return nil } for _, kv := range strings.Split(auxFiles, ",") { parts := strings.SplitN(kv, "=", 2) if len(parts) != 2 { return fmt.Errorf("bad aux file spec: %v", kv) } pkg, fpath := parts[0], parts[1] file, err := parser.ParseFile(p.fileSet, fpath, nil, 0) if err != nil { return err } p.auxFiles = append(p.auxFiles, file) p.addAuxInterfacesFromFile(pkg, file) } return nil } func (p *fileParser) addAuxInterfacesFromFile(pkg string, file *ast.File) { for ni := range iterInterfaces(file) { p.auxInterfaces.Set(pkg, ni.name.Name, ni) } } // parseFile loads all file imports and auxiliary files import into the // fileParser, parses all file interfaces and returns package model. func (p *fileParser) parseFile(importPath string, file *ast.File) (*model.Package, error) { allImports, dotImports := importsOfFile(file) // Don't stomp imports provided by -imports. Those should take precedence. for pkg, pkgI := range allImports { if _, ok := p.imports[pkg]; !ok { p.imports[pkg] = pkgI } } // Add imports from auxiliary files, which might be needed for embedded interfaces. // Don't stomp any other imports. for _, f := range p.auxFiles { auxImports, _ := importsOfFile(f) for pkg, pkgI := range auxImports { if _, ok := p.imports[pkg]; !ok { p.imports[pkg] = pkgI } } } var is []*model.Interface for ni := range iterInterfaces(file) { i, err := p.parseInterface(ni.name.String(), importPath, ni) if err != nil { return nil, err } is = append(is, i) } return &model.Package{ Name: file.Name.String(), PkgPath: importPath, Interfaces: is, DotImports: dotImports, }, nil } // parsePackage loads package specified by path, parses it and returns // a new fileParser with the parsed imports and interfaces. func (p *fileParser) parsePackage(path string) (*fileParser, error) { newP := &fileParser{ fileSet: token.NewFileSet(), imports: make(map[string]importedPackage), importedInterfaces: newInterfaceCache(), auxInterfaces: newInterfaceCache(), srcDir: p.srcDir, } var pkgs map[string]*ast.Package if imp, err := build.Import(path, newP.srcDir, build.FindOnly); err != nil { return nil, err } else if pkgs, err = parser.ParseDir(newP.fileSet, imp.Dir, nil, 0); err != nil { return nil, err } for _, pkg := range pkgs { file := ast.MergePackageFiles(pkg, ast.FilterFuncDuplicates|ast.FilterUnassociatedComments|ast.FilterImportDuplicates) for ni := range iterInterfaces(file) { newP.importedInterfaces.Set(path, ni.name.Name, ni) } imports, _ := importsOfFile(file) for pkgName, pkgI := range imports { newP.imports[pkgName] = pkgI } } return newP, nil } func (p *fileParser) parseInterface(name, pkg string, it *namedInterface) (*model.Interface, error) { iface := &model.Interface{Name: name} tps := make(map[string]bool) tp, err := p.parseFieldList(pkg, it.typeParams, tps) if err != nil { return nil, fmt.Errorf("unable to parse interface type parameters: %v", name) } iface.TypeParams = tp for _, v := range tp { tps[v.Name] = true } for _, field := range it.it.Methods.List { switch v := field.Type.(type) { case *ast.FuncType: if nn := len(field.Names); nn != 1 { return nil, fmt.Errorf("expected one name for interface %v, got %d", iface.Name, nn) } m := &model.Method{ Name: field.Names[0].String(), } var err error m.In, m.Variadic, m.Out, err = p.parseFunc(pkg, v, tps) if err != nil { return nil, err } iface.AddMethod(m) case *ast.Ident: // Embedded interface in this package. embeddedIfaceType := p.auxInterfaces.Get(pkg, v.String()) if embeddedIfaceType == nil { embeddedIfaceType = p.importedInterfaces.Get(pkg, v.String()) } var embeddedIface *model.Interface if embeddedIfaceType != nil { var err error embeddedIface, err = p.parseInterface(v.String(), pkg, embeddedIfaceType) if err != nil { return nil, err } } else { // This is built-in error interface. if v.String() == model.ErrorInterface.Name { embeddedIface = &model.ErrorInterface } else { ip, err := p.parsePackage(pkg) if err != nil { return nil, p.errorf(v.Pos(), "could not parse package %s: %v", pkg, err) } if embeddedIfaceType = ip.importedInterfaces.Get(pkg, v.String()); embeddedIfaceType == nil { return nil, p.errorf(v.Pos(), "unknown embedded interface %s.%s", pkg, v.String()) } embeddedIface, err = ip.parseInterface(v.String(), pkg, embeddedIfaceType) if err != nil { return nil, err } } } // Copy the methods. for _, m := range embeddedIface.Methods { iface.AddMethod(m) } case *ast.SelectorExpr: // Embedded interface in another package. filePkg, sel := v.X.(*ast.Ident).String(), v.Sel.String() embeddedPkg, ok := p.imports[filePkg] if !ok { return nil, p.errorf(v.X.Pos(), "unknown package %s", filePkg) } var embeddedIface *model.Interface var err error embeddedIfaceType := p.auxInterfaces.Get(filePkg, sel) if embeddedIfaceType != nil { embeddedIface, err = p.parseInterface(sel, filePkg, embeddedIfaceType) if err != nil { return nil, err } } else { path := embeddedPkg.Path() parser := embeddedPkg.Parser() if parser == nil { ip, err := p.parsePackage(path) if err != nil { return nil, p.errorf(v.Pos(), "could not parse package %s: %v", path, err) } parser = ip p.imports[filePkg] = importedPkg{ path: embeddedPkg.Path(), parser: parser, } } if embeddedIfaceType = parser.importedInterfaces.Get(path, sel); embeddedIfaceType == nil { return nil, p.errorf(v.Pos(), "unknown embedded interface %s.%s", path, sel) } embeddedIface, err = parser.parseInterface(sel, path, embeddedIfaceType) if err != nil { return nil, err } } // Copy the methods. // TODO: apply shadowing rules. for _, m := range embeddedIface.Methods { iface.AddMethod(m) } default: return nil, fmt.Errorf("don't know how to mock method of type %T", field.Type) } } return iface, nil } func (p *fileParser) parseFunc(pkg string, f *ast.FuncType, tps map[string]bool) (inParam []*model.Parameter, variadic *model.Parameter, outParam []*model.Parameter, err error) { if f.Params != nil { regParams := f.Params.List if isVariadic(f) { n := len(regParams) varParams := regParams[n-1:] regParams = regParams[:n-1] vp, err := p.parseFieldList(pkg, varParams, tps) if err != nil { return nil, nil, nil, p.errorf(varParams[0].Pos(), "failed parsing variadic argument: %v", err) } variadic = vp[0] } inParam, err = p.parseFieldList(pkg, regParams, tps) if err != nil { return nil, nil, nil, p.errorf(f.Pos(), "failed parsing arguments: %v", err) } } if f.Results != nil { outParam, err = p.parseFieldList(pkg, f.Results.List, tps) if err != nil { return nil, nil, nil, p.errorf(f.Pos(), "failed parsing returns: %v", err) } } return } func (p *fileParser) parseFieldList(pkg string, fields []*ast.Field, tps map[string]bool) ([]*model.Parameter, error) { nf := 0 for _, f := range fields { nn := len(f.Names) if nn == 0 { nn = 1 // anonymous parameter } nf += nn } if nf == 0 { return nil, nil } ps := make([]*model.Parameter, nf) i := 0 // destination index for _, f := range fields { t, err := p.parseType(pkg, f.Type, tps) if err != nil { return nil, err } if len(f.Names) == 0 { // anonymous arg ps[i] = &model.Parameter{Type: t} i++ continue } for _, name := range f.Names { ps[i] = &model.Parameter{Name: name.Name, Type: t} i++ } } return ps, nil } func (p *fileParser) parseType(pkg string, typ ast.Expr, tps map[string]bool) (model.Type, error) { switch v := typ.(type) { case *ast.ArrayType: ln := -1 if v.Len != nil { value, err := p.parseArrayLength(v.Len) if err != nil { return nil, err } ln, err = strconv.Atoi(value) if err != nil { return nil, p.errorf(v.Len.Pos(), "bad array size: %v", err) } } t, err := p.parseType(pkg, v.Elt, tps) if err != nil { return nil, err } return &model.ArrayType{Len: ln, Type: t}, nil case *ast.ChanType: t, err := p.parseType(pkg, v.Value, tps) if err != nil { return nil, err } var dir model.ChanDir if v.Dir == ast.SEND { dir = model.SendDir } if v.Dir == ast.RECV { dir = model.RecvDir } return &model.ChanType{Dir: dir, Type: t}, nil case *ast.Ellipsis: // assume we're parsing a variadic argument return p.parseType(pkg, v.Elt, tps) case *ast.FuncType: in, variadic, out, err := p.parseFunc(pkg, v, tps) if err != nil { return nil, err } return &model.FuncType{In: in, Out: out, Variadic: variadic}, nil case *ast.Ident: if v.IsExported() && !tps[v.Name] { // `pkg` may be an aliased imported pkg // if so, patch the import w/ the fully qualified import maybeImportedPkg, ok := p.imports[pkg] if ok { pkg = maybeImportedPkg.Path() } // assume type in this package return &model.NamedType{Package: pkg, Type: v.Name}, nil } // assume predeclared type return model.PredeclaredType(v.Name), nil case *ast.InterfaceType: if v.Methods != nil && len(v.Methods.List) > 0 { return nil, p.errorf(v.Pos(), "can't handle non-empty unnamed interface types") } return model.PredeclaredType("interface{}"), nil case *ast.MapType: key, err := p.parseType(pkg, v.Key, tps) if err != nil { return nil, err } value, err := p.parseType(pkg, v.Value, tps) if err != nil { return nil, err } return &model.MapType{Key: key, Value: value}, nil case *ast.SelectorExpr: pkgName := v.X.(*ast.Ident).String() pkg, ok := p.imports[pkgName] if !ok { return nil, p.errorf(v.Pos(), "unknown package %q", pkgName) } return &model.NamedType{Package: pkg.Path(), Type: v.Sel.String()}, nil case *ast.StarExpr: t, err := p.parseType(pkg, v.X, tps) if err != nil { return nil, err } return &model.PointerType{Type: t}, nil case *ast.StructType: if v.Fields != nil && len(v.Fields.List) > 0 { return nil, p.errorf(v.Pos(), "can't handle non-empty unnamed struct types") } return model.PredeclaredType("struct{}"), nil case *ast.ParenExpr: return p.parseType(pkg, v.X, tps) default: mt, err := p.parseGenericType(pkg, typ, tps) if err != nil { return nil, err } if mt == nil { break } return mt, nil } return nil, fmt.Errorf("don't know how to parse type %T", typ) } func (p *fileParser) parseArrayLength(expr ast.Expr) (string, error) { switch val := expr.(type) { case (*ast.BasicLit): return val.Value, nil case (*ast.Ident): // when the length is a const defined locally return val.Obj.Decl.(*ast.ValueSpec).Values[0].(*ast.BasicLit).Value, nil case (*ast.SelectorExpr): // when the length is a const defined in an external package usedPkg, err := importer.Default().Import(fmt.Sprintf("%s", val.X)) if err != nil { return "", p.errorf(expr.Pos(), "unknown package in array length: %v", err) } ev, err := types.Eval(token.NewFileSet(), usedPkg, token.NoPos, val.Sel.Name) if err != nil { return "", p.errorf(expr.Pos(), "unknown constant in array length: %v", err) } return ev.Value.String(), nil case (*ast.ParenExpr): return p.parseArrayLength(val.X) case (*ast.BinaryExpr): x, err := p.parseArrayLength(val.X) if err != nil { return "", err } y, err := p.parseArrayLength(val.Y) if err != nil { return "", err } biExpr := fmt.Sprintf("%s%v%s", x, val.Op, y) tv, err := types.Eval(token.NewFileSet(), nil, token.NoPos, biExpr) if err != nil { return "", p.errorf(expr.Pos(), "invalid expression in array length: %v", err) } return tv.Value.String(), nil default: return "", p.errorf(expr.Pos(), "invalid expression in array length: %v", val) } } // importsOfFile returns a map of package name to import path // of the imports in file. func importsOfFile(file *ast.File) (normalImports map[string]importedPackage, dotImports []string) { var importPaths []string for _, is := range file.Imports { if is.Name != nil { continue } importPath := is.Path.Value[1 : len(is.Path.Value)-1] // remove quotes importPaths = append(importPaths, importPath) } packagesName := createPackageMap(importPaths) normalImports = make(map[string]importedPackage) dotImports = make([]string, 0) for _, is := range file.Imports { var pkgName string importPath := is.Path.Value[1 : len(is.Path.Value)-1] // remove quotes if is.Name != nil { // Named imports are always certain. if is.Name.Name == "_" { continue } pkgName = is.Name.Name } else { pkg, ok := packagesName[importPath] if !ok { // Fallback to import path suffix. Note that this is uncertain. _, last := path.Split(importPath) // If the last path component has dots, the first dot-delimited // field is used as the name. pkgName = strings.SplitN(last, ".", 2)[0] } else { pkgName = pkg } } if pkgName == "." { dotImports = append(dotImports, importPath) } else { if pkg, ok := normalImports[pkgName]; ok { switch p := pkg.(type) { case duplicateImport: normalImports[pkgName] = duplicateImport{ name: p.name, duplicates: append([]string{importPath}, p.duplicates...), } case importedPkg: normalImports[pkgName] = duplicateImport{ name: pkgName, duplicates: []string{p.path, importPath}, } } } else { normalImports[pkgName] = importedPkg{path: importPath} } } } return } type namedInterface struct { name *ast.Ident it *ast.InterfaceType typeParams []*ast.Field } // Create an iterator over all interfaces in file. func iterInterfaces(file *ast.File) <-chan *namedInterface { ch := make(chan *namedInterface) go func() { for _, decl := range file.Decls { gd, ok := decl.(*ast.GenDecl) if !ok || gd.Tok != token.TYPE { continue } for _, spec := range gd.Specs { ts, ok := spec.(*ast.TypeSpec) if !ok { continue } it, ok := ts.Type.(*ast.InterfaceType) if !ok { continue } ch <- &namedInterface{ts.Name, it, getTypeSpecTypeParams(ts)} } } close(ch) }() return ch } // isVariadic returns whether the function is variadic. func isVariadic(f *ast.FuncType) bool { nargs := len(f.Params.List) if nargs == 0 { return false } _, ok := f.Params.List[nargs-1].Type.(*ast.Ellipsis) return ok } // packageNameOfDir get package import path via dir func packageNameOfDir(srcDir string) (string, error) { files, err := ioutil.ReadDir(srcDir) if err != nil { log.Fatal(err) } var goFilePath string for _, file := range files { if !file.IsDir() && strings.HasSuffix(file.Name(), ".go") { goFilePath = file.Name() break } } if goFilePath == "" { return "", fmt.Errorf("go source file not found %s", srcDir) } packageImport, err := parsePackageImport(srcDir) if err != nil { return "", err } return packageImport, nil } var errOutsideGoPath = errors.New("source directory is outside GOPATH") ================================================ FILE: mockgen/parse_test.go ================================================ package main import ( "go/parser" "go/token" "testing" ) func TestFileParser_ParseFile(t *testing.T) { fs := token.NewFileSet() file, err := parser.ParseFile(fs, "internal/tests/custom_package_name/greeter/greeter.go", nil, 0) if err != nil { t.Fatalf("Unexpected error: %v", err) } p := fileParser{ fileSet: fs, imports: make(map[string]importedPackage), importedInterfaces: newInterfaceCache(), } pkg, err := p.parseFile("", file) if err != nil { t.Fatalf("Unexpected error: %v", err) } checkGreeterImports(t, p.imports) expectedName := "greeter" if pkg.Name != expectedName { t.Fatalf("Expected name to be %v but got %v", expectedName, pkg.Name) } expectedInterfaceName := "InputMaker" if pkg.Interfaces[0].Name != expectedInterfaceName { t.Fatalf("Expected interface name to be %v but got %v", expectedInterfaceName, pkg.Interfaces[0].Name) } } func TestFileParser_ParsePackage(t *testing.T) { fs := token.NewFileSet() _, err := parser.ParseFile(fs, "internal/tests/custom_package_name/greeter/greeter.go", nil, 0) if err != nil { t.Fatalf("Unexpected error: %v", err) } p := fileParser{ fileSet: fs, imports: make(map[string]importedPackage), importedInterfaces: newInterfaceCache(), } newP, err := p.parsePackage("github.com/golang/mock/mockgen/internal/tests/custom_package_name/greeter") if err != nil { t.Fatalf("Unexpected error: %v", err) } checkGreeterImports(t, newP.imports) } func TestImportsOfFile(t *testing.T) { fs := token.NewFileSet() file, err := parser.ParseFile(fs, "internal/tests/custom_package_name/greeter/greeter.go", nil, 0) if err != nil { t.Fatalf("Unexpected error: %v", err) } imports, _ := importsOfFile(file) checkGreeterImports(t, imports) } func checkGreeterImports(t *testing.T, imports map[string]importedPackage) { // check that imports have stdlib package "fmt" if fmtPackage, ok := imports["fmt"]; !ok { t.Errorf("Expected imports to have key \"fmt\"") } else { expectedFmtPackage := "fmt" if fmtPackage.Path() != expectedFmtPackage { t.Errorf("Expected fmt key to have value %s but got %s", expectedFmtPackage, fmtPackage.Path()) } } // check that imports have package named "validator" if validatorPackage, ok := imports["validator"]; !ok { t.Errorf("Expected imports to have key \"fmt\"") } else { expectedValidatorPackage := "github.com/golang/mock/mockgen/internal/tests/custom_package_name/validator" if validatorPackage.Path() != expectedValidatorPackage { t.Errorf("Expected validator key to have value %s but got %s", expectedValidatorPackage, validatorPackage.Path()) } } // check that imports have package named "client" if clientPackage, ok := imports["client"]; !ok { t.Errorf("Expected imports to have key \"client\"") } else { expectedClientPackage := "github.com/golang/mock/mockgen/internal/tests/custom_package_name/client/v1" if clientPackage.Path() != expectedClientPackage { t.Errorf("Expected client key to have value %s but got %s", expectedClientPackage, clientPackage.Path()) } } // check that imports don't have package named "v1" if _, ok := imports["v1"]; ok { t.Errorf("Expected import not to have key \"v1\"") } } func Benchmark_parseFile(b *testing.B) { source := "internal/tests/performance/big_interface/big_interface.go" for n := 0; n < b.N; n++ { sourceMode(source) } } func TestParseArrayWithConstLength(t *testing.T) { fs := token.NewFileSet() srcDir := "internal/tests/const_array_length/input.go" file, err := parser.ParseFile(fs, srcDir, nil, 0) if err != nil { t.Fatalf("Unexpected error: %v", err) } p := fileParser{ fileSet: fs, imports: make(map[string]importedPackage), importedInterfaces: newInterfaceCache(), auxInterfaces: newInterfaceCache(), srcDir: srcDir, } pkg, err := p.parseFile("", file) if err != nil { t.Fatalf("Unexpected error: %v", err) } expects := []string{"[2]int", "[2]int", "[127]int", "[3]int", "[3]int", "[7]int"} for i, e := range expects { got := pkg.Interfaces[0].Methods[i].Out[0].Type.String(nil, "") if got != e { t.Fatalf("got %v; expected %v", got, e) } } } ================================================ FILE: mockgen/reflect.go ================================================ // Copyright 2012 Google Inc. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package main // This file contains the model construction by reflection. import ( "bytes" "encoding/gob" "flag" "fmt" "go/build" "io" "io/ioutil" "log" "os" "os/exec" "path/filepath" "runtime" "strings" "text/template" "github.com/golang/mock/mockgen/model" ) var ( progOnly = flag.Bool("prog_only", false, "(reflect mode) Only generate the reflection program; write it to stdout and exit.") execOnly = flag.String("exec_only", "", "(reflect mode) If set, execute this reflection program.") buildFlags = flag.String("build_flags", "", "(reflect mode) Additional flags for go build.") ) // reflectMode generates mocks via reflection on an interface. func reflectMode(importPath string, symbols []string) (*model.Package, error) { if *execOnly != "" { return run(*execOnly) } program, err := writeProgram(importPath, symbols) if err != nil { return nil, err } if *progOnly { if _, err := os.Stdout.Write(program); err != nil { return nil, err } os.Exit(0) } wd, _ := os.Getwd() // Try to run the reflection program in the current working directory. if p, err := runInDir(program, wd); err == nil { return p, nil } // Try to run the program in the same directory as the input package. if p, err := build.Import(importPath, wd, build.FindOnly); err == nil { dir := p.Dir if p, err := runInDir(program, dir); err == nil { return p, nil } } // Try to run it in a standard temp directory. return runInDir(program, "") } func writeProgram(importPath string, symbols []string) ([]byte, error) { var program bytes.Buffer data := reflectData{ ImportPath: importPath, Symbols: symbols, } if err := reflectProgram.Execute(&program, &data); err != nil { return nil, err } return program.Bytes(), nil } // run the given program and parse the output as a model.Package. func run(program string) (*model.Package, error) { f, err := ioutil.TempFile("", "") if err != nil { return nil, err } filename := f.Name() defer os.Remove(filename) if err := f.Close(); err != nil { return nil, err } // Run the program. cmd := exec.Command(program, "-output", filename) cmd.Stdout = os.Stdout cmd.Stderr = os.Stderr if err := cmd.Run(); err != nil { return nil, err } f, err = os.Open(filename) if err != nil { return nil, err } // Process output. var pkg model.Package if err := gob.NewDecoder(f).Decode(&pkg); err != nil { return nil, err } if err := f.Close(); err != nil { return nil, err } return &pkg, nil } // runInDir writes the given program into the given dir, runs it there, and // parses the output as a model.Package. func runInDir(program []byte, dir string) (*model.Package, error) { // We use TempDir instead of TempFile so we can control the filename. tmpDir, err := ioutil.TempDir(dir, "gomock_reflect_") if err != nil { return nil, err } defer func() { if err := os.RemoveAll(tmpDir); err != nil { log.Printf("failed to remove temp directory: %s", err) } }() const progSource = "prog.go" var progBinary = "prog.bin" if runtime.GOOS == "windows" { // Windows won't execute a program unless it has a ".exe" suffix. progBinary += ".exe" } if err := ioutil.WriteFile(filepath.Join(tmpDir, progSource), program, 0600); err != nil { return nil, err } cmdArgs := []string{} cmdArgs = append(cmdArgs, "build") if *buildFlags != "" { cmdArgs = append(cmdArgs, strings.Split(*buildFlags, " ")...) } cmdArgs = append(cmdArgs, "-o", progBinary, progSource) // Build the program. buf := bytes.NewBuffer(nil) cmd := exec.Command("go", cmdArgs...) cmd.Dir = tmpDir cmd.Stdout = os.Stdout cmd.Stderr = io.MultiWriter(os.Stderr, buf) if err := cmd.Run(); err != nil { sErr := buf.String() if strings.Contains(sErr, `cannot find package "."`) && strings.Contains(sErr, "github.com/golang/mock/mockgen/model") { fmt.Fprint(os.Stderr, "Please reference the steps in the README to fix this error:\n\thttps://github.com/golang/mock#reflect-vendoring-error.\n") return nil, err } return nil, err } return run(filepath.Join(tmpDir, progBinary)) } type reflectData struct { ImportPath string Symbols []string } // This program reflects on an interface value, and prints the // gob encoding of a model.Package to standard output. // JSON doesn't work because of the model.Type interface. var reflectProgram = template.Must(template.New("program").Parse(` package main import ( "encoding/gob" "flag" "fmt" "os" "path" "reflect" "github.com/golang/mock/mockgen/model" pkg_ {{printf "%q" .ImportPath}} ) var output = flag.String("output", "", "The output file name, or empty to use stdout.") func main() { flag.Parse() its := []struct{ sym string typ reflect.Type }{ {{range .Symbols}} { {{printf "%q" .}}, reflect.TypeOf((*pkg_.{{.}})(nil)).Elem()}, {{end}} } pkg := &model.Package{ // NOTE: This behaves contrary to documented behaviour if the // package name is not the final component of the import path. // The reflect package doesn't expose the package name, though. Name: path.Base({{printf "%q" .ImportPath}}), } for _, it := range its { intf, err := model.InterfaceFromInterfaceType(it.typ) if err != nil { fmt.Fprintf(os.Stderr, "Reflection: %v\n", err) os.Exit(1) } intf.Name = it.sym pkg.Interfaces = append(pkg.Interfaces, intf) } outfile := os.Stdout if len(*output) != 0 { var err error outfile, err = os.Create(*output) if err != nil { fmt.Fprintf(os.Stderr, "failed to open output file %q", *output) } defer func() { if err := outfile.Close(); err != nil { fmt.Fprintf(os.Stderr, "failed to close output file %q", *output) os.Exit(1) } }() } if err := gob.NewEncoder(outfile).Encode(pkg); err != nil { fmt.Fprintf(os.Stderr, "gob encode: %v\n", err) os.Exit(1) } } `)) ================================================ FILE: mockgen/version.go ================================================ // Copyright 2022 Google LLC // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package main import ( "fmt" "log" "runtime/debug" ) func printModuleVersion() { if bi, exists := debug.ReadBuildInfo(); exists { fmt.Println(bi.Main.Version) } else { log.Printf("No version information found. Make sure to use " + "GO111MODULE=on when running 'go get' in order to use specific " + "version of the binary.") } } ================================================ FILE: sample/README.md ================================================ # Samples This directory contains an example of a package containing a non-trivial interface that can be mocked with GoMock. The interesting files are: * `user.go`: Source code for the sample package, containing interfaces to be mocked. This file depends on the packages named imp[1-4] for various things. * `user_test.go`: A test for the sample package, in which mocks of the interfaces from `user.go` are used. This demonstrates how to create mock objects, set up expectations, and so on. * `mock_user_test.go`: The generated mock code. See ../gomock/matchers.go for the `go:generate` command used to generate it. To run the test, ```bash go test github.com/golang/mock/sample ``` ================================================ FILE: sample/concurrent/concurrent.go ================================================ // Package concurrent demonstrates how to use gomock with goroutines. package concurrent //go:generate mockgen -destination mock/concurrent_mock.go github.com/golang/mock/sample/concurrent Math type Math interface { Sum(a, b int) int } ================================================ FILE: sample/concurrent/concurrent_test.go ================================================ package concurrent import ( "testing" "context" "github.com/golang/mock/gomock" mock "github.com/golang/mock/sample/concurrent/mock" ) func call(ctx context.Context, m Math) (int, error) { result := make(chan int) go func() { result <- m.Sum(1, 2) close(result) }() select { case r := <-result: return r, nil case <-ctx.Done(): return 0, ctx.Err() } } // TestConcurrentFails is expected to fail (and is disabled). It // demonstrates how to use gomock.WithContext to interrupt the test // from a different goroutine. func TestConcurrentFails(t *testing.T) { t.Skip("Test is expected to fail, remove skip to trying running yourself.") ctrl, ctx := gomock.WithContext(context.Background(), t) defer ctrl.Finish() m := mock.NewMockMath(ctrl) if _, err := call(ctx, m); err != nil { t.Error("call failed:", err) } } func TestConcurrentWorks(t *testing.T) { ctrl, ctx := gomock.WithContext(context.Background(), t) defer ctrl.Finish() m := mock.NewMockMath(ctrl) m.EXPECT().Sum(1, 2).Return(3) if _, err := call(ctx, m); err != nil { t.Error("call failed:", err) } } ================================================ FILE: sample/concurrent/mock/concurrent_mock.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: github.com/golang/mock/sample/concurrent (interfaces: Math) // Package mock_concurrent is a generated GoMock package. package mock_concurrent import ( reflect "reflect" gomock "github.com/golang/mock/gomock" ) // MockMath is a mock of Math interface. type MockMath struct { ctrl *gomock.Controller recorder *MockMathMockRecorder } // MockMathMockRecorder is the mock recorder for MockMath. type MockMathMockRecorder struct { mock *MockMath } // NewMockMath creates a new mock instance. func NewMockMath(ctrl *gomock.Controller) *MockMath { mock := &MockMath{ctrl: ctrl} mock.recorder = &MockMathMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockMath) EXPECT() *MockMathMockRecorder { return m.recorder } // Sum mocks base method. func (m *MockMath) Sum(arg0, arg1 int) int { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Sum", arg0, arg1) ret0, _ := ret[0].(int) return ret0 } // Sum indicates an expected call of Sum. func (mr *MockMathMockRecorder) Sum(arg0, arg1 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Sum", reflect.TypeOf((*MockMath)(nil).Sum), arg0, arg1) } ================================================ FILE: sample/imp1/imp1.go ================================================ package imp1 import "bufio" type Imp1 struct{} type ImpT int type ForeignEmbedded interface { // The return value here also makes sure that // the generated mock picks up the "bufio" import. ForeignEmbeddedMethod() *bufio.Reader // This method uses a type in this package, // which should be qualified when this interface is embedded. ImplicitPackage(s string, t ImpT, st []ImpT, pt *ImpT, ct chan ImpT) } ================================================ FILE: sample/imp2/imp2.go ================================================ package imp2 type Imp2 struct{} ================================================ FILE: sample/imp3/imp3.go ================================================ package imp3 type Imp3 struct{} ================================================ FILE: sample/imp4/imp4.go ================================================ package imp_four type Imp4 struct{} ================================================ FILE: sample/mock_user_test.go ================================================ // Code generated by MockGen. DO NOT EDIT. // Source: github.com/golang/mock/sample (interfaces: Index,Embed,Embedded) // Package user_test is a generated GoMock package. package user_test import ( bufio "bufio" bytes "bytes" hash "hash" template "html/template" io "io" http "net/http" reflect "reflect" template0 "text/template" gomock "github.com/golang/mock/gomock" imp1 "github.com/golang/mock/sample/imp1" imp2 "github.com/golang/mock/sample/imp2" imp3 "github.com/golang/mock/sample/imp3" imp_four "github.com/golang/mock/sample/imp4" ) // MockIndex is a mock of Index interface. type MockIndex struct { ctrl *gomock.Controller recorder *MockIndexMockRecorder } // MockIndexMockRecorder is the mock recorder for MockIndex. type MockIndexMockRecorder struct { mock *MockIndex } // NewMockIndex creates a new mock instance. func NewMockIndex(ctrl *gomock.Controller) *MockIndex { mock := &MockIndex{ctrl: ctrl} mock.recorder = &MockIndexMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockIndex) EXPECT() *MockIndexMockRecorder { return m.recorder } // Anon mocks base method. func (m *MockIndex) Anon(arg0 string) { m.ctrl.T.Helper() m.ctrl.Call(m, "Anon", arg0) } // Anon indicates an expected call of Anon. func (mr *MockIndexMockRecorder) Anon(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Anon", reflect.TypeOf((*MockIndex)(nil).Anon), arg0) } // Chan mocks base method. func (m *MockIndex) Chan(arg0 chan int, arg1 chan<- hash.Hash) { m.ctrl.T.Helper() m.ctrl.Call(m, "Chan", arg0, arg1) } // Chan indicates an expected call of Chan. func (mr *MockIndexMockRecorder) Chan(arg0, arg1 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Chan", reflect.TypeOf((*MockIndex)(nil).Chan), arg0, arg1) } // ConcreteRet mocks base method. func (m *MockIndex) ConcreteRet() chan<- bool { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "ConcreteRet") ret0, _ := ret[0].(chan<- bool) return ret0 } // ConcreteRet indicates an expected call of ConcreteRet. func (mr *MockIndexMockRecorder) ConcreteRet() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ConcreteRet", reflect.TypeOf((*MockIndex)(nil).ConcreteRet)) } // Ellip mocks base method. func (m *MockIndex) Ellip(arg0 string, arg1 ...interface{}) { m.ctrl.T.Helper() varargs := []interface{}{arg0} for _, a := range arg1 { varargs = append(varargs, a) } m.ctrl.Call(m, "Ellip", varargs...) } // Ellip indicates an expected call of Ellip. func (mr *MockIndexMockRecorder) Ellip(arg0 interface{}, arg1 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() varargs := append([]interface{}{arg0}, arg1...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Ellip", reflect.TypeOf((*MockIndex)(nil).Ellip), varargs...) } // EllipOnly mocks base method. func (m *MockIndex) EllipOnly(arg0 ...string) { m.ctrl.T.Helper() varargs := []interface{}{} for _, a := range arg0 { varargs = append(varargs, a) } m.ctrl.Call(m, "EllipOnly", varargs...) } // EllipOnly indicates an expected call of EllipOnly. func (mr *MockIndexMockRecorder) EllipOnly(arg0 ...interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "EllipOnly", reflect.TypeOf((*MockIndex)(nil).EllipOnly), arg0...) } // ForeignFour mocks base method. func (m *MockIndex) ForeignFour(arg0 imp_four.Imp4) { m.ctrl.T.Helper() m.ctrl.Call(m, "ForeignFour", arg0) } // ForeignFour indicates an expected call of ForeignFour. func (mr *MockIndexMockRecorder) ForeignFour(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ForeignFour", reflect.TypeOf((*MockIndex)(nil).ForeignFour), arg0) } // ForeignOne mocks base method. func (m *MockIndex) ForeignOne(arg0 imp1.Imp1) { m.ctrl.T.Helper() m.ctrl.Call(m, "ForeignOne", arg0) } // ForeignOne indicates an expected call of ForeignOne. func (mr *MockIndexMockRecorder) ForeignOne(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ForeignOne", reflect.TypeOf((*MockIndex)(nil).ForeignOne), arg0) } // ForeignThree mocks base method. func (m *MockIndex) ForeignThree(arg0 imp3.Imp3) { m.ctrl.T.Helper() m.ctrl.Call(m, "ForeignThree", arg0) } // ForeignThree indicates an expected call of ForeignThree. func (mr *MockIndexMockRecorder) ForeignThree(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ForeignThree", reflect.TypeOf((*MockIndex)(nil).ForeignThree), arg0) } // ForeignTwo mocks base method. func (m *MockIndex) ForeignTwo(arg0 imp2.Imp2) { m.ctrl.T.Helper() m.ctrl.Call(m, "ForeignTwo", arg0) } // ForeignTwo indicates an expected call of ForeignTwo. func (mr *MockIndexMockRecorder) ForeignTwo(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ForeignTwo", reflect.TypeOf((*MockIndex)(nil).ForeignTwo), arg0) } // Func mocks base method. func (m *MockIndex) Func(arg0 func(http.Request) (int, bool)) { m.ctrl.T.Helper() m.ctrl.Call(m, "Func", arg0) } // Func indicates an expected call of Func. func (mr *MockIndexMockRecorder) Func(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Func", reflect.TypeOf((*MockIndex)(nil).Func), arg0) } // Get mocks base method. func (m *MockIndex) Get(arg0 string) interface{} { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Get", arg0) ret0, _ := ret[0].(interface{}) return ret0 } // Get indicates an expected call of Get. func (mr *MockIndexMockRecorder) Get(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Get", reflect.TypeOf((*MockIndex)(nil).Get), arg0) } // GetTwo mocks base method. func (m *MockIndex) GetTwo(arg0, arg1 string) (interface{}, interface{}) { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "GetTwo", arg0, arg1) ret0, _ := ret[0].(interface{}) ret1, _ := ret[1].(interface{}) return ret0, ret1 } // GetTwo indicates an expected call of GetTwo. func (mr *MockIndexMockRecorder) GetTwo(arg0, arg1 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetTwo", reflect.TypeOf((*MockIndex)(nil).GetTwo), arg0, arg1) } // Map mocks base method. func (m *MockIndex) Map(arg0 map[int]hash.Hash) { m.ctrl.T.Helper() m.ctrl.Call(m, "Map", arg0) } // Map indicates an expected call of Map. func (mr *MockIndexMockRecorder) Map(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Map", reflect.TypeOf((*MockIndex)(nil).Map), arg0) } // NillableRet mocks base method. func (m *MockIndex) NillableRet() error { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "NillableRet") ret0, _ := ret[0].(error) return ret0 } // NillableRet indicates an expected call of NillableRet. func (mr *MockIndexMockRecorder) NillableRet() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NillableRet", reflect.TypeOf((*MockIndex)(nil).NillableRet)) } // Other mocks base method. func (m *MockIndex) Other() hash.Hash { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Other") ret0, _ := ret[0].(hash.Hash) return ret0 } // Other indicates an expected call of Other. func (mr *MockIndexMockRecorder) Other() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Other", reflect.TypeOf((*MockIndex)(nil).Other)) } // Ptr mocks base method. func (m *MockIndex) Ptr(arg0 *int) { m.ctrl.T.Helper() m.ctrl.Call(m, "Ptr", arg0) } // Ptr indicates an expected call of Ptr. func (mr *MockIndexMockRecorder) Ptr(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Ptr", reflect.TypeOf((*MockIndex)(nil).Ptr), arg0) } // Put mocks base method. func (m *MockIndex) Put(arg0 string, arg1 interface{}) { m.ctrl.T.Helper() m.ctrl.Call(m, "Put", arg0, arg1) } // Put indicates an expected call of Put. func (mr *MockIndexMockRecorder) Put(arg0, arg1 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Put", reflect.TypeOf((*MockIndex)(nil).Put), arg0, arg1) } // Slice mocks base method. func (m *MockIndex) Slice(arg0 []int, arg1 []byte) [3]int { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "Slice", arg0, arg1) ret0, _ := ret[0].([3]int) return ret0 } // Slice indicates an expected call of Slice. func (mr *MockIndexMockRecorder) Slice(arg0, arg1 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Slice", reflect.TypeOf((*MockIndex)(nil).Slice), arg0, arg1) } // Struct mocks base method. func (m *MockIndex) Struct(arg0 struct{}) { m.ctrl.T.Helper() m.ctrl.Call(m, "Struct", arg0) } // Struct indicates an expected call of Struct. func (mr *MockIndexMockRecorder) Struct(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Struct", reflect.TypeOf((*MockIndex)(nil).Struct), arg0) } // StructChan mocks base method. func (m *MockIndex) StructChan(arg0 chan struct{}) { m.ctrl.T.Helper() m.ctrl.Call(m, "StructChan", arg0) } // StructChan indicates an expected call of StructChan. func (mr *MockIndexMockRecorder) StructChan(arg0 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "StructChan", reflect.TypeOf((*MockIndex)(nil).StructChan), arg0) } // Summary mocks base method. func (m *MockIndex) Summary(arg0 *bytes.Buffer, arg1 io.Writer) { m.ctrl.T.Helper() m.ctrl.Call(m, "Summary", arg0, arg1) } // Summary indicates an expected call of Summary. func (mr *MockIndexMockRecorder) Summary(arg0, arg1 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Summary", reflect.TypeOf((*MockIndex)(nil).Summary), arg0, arg1) } // Templates mocks base method. func (m *MockIndex) Templates(arg0 template.CSS, arg1 template0.FuncMap) { m.ctrl.T.Helper() m.ctrl.Call(m, "Templates", arg0, arg1) } // Templates indicates an expected call of Templates. func (mr *MockIndexMockRecorder) Templates(arg0, arg1 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Templates", reflect.TypeOf((*MockIndex)(nil).Templates), arg0, arg1) } // MockEmbed is a mock of Embed interface. type MockEmbed struct { ctrl *gomock.Controller recorder *MockEmbedMockRecorder } // MockEmbedMockRecorder is the mock recorder for MockEmbed. type MockEmbedMockRecorder struct { mock *MockEmbed } // NewMockEmbed creates a new mock instance. func NewMockEmbed(ctrl *gomock.Controller) *MockEmbed { mock := &MockEmbed{ctrl: ctrl} mock.recorder = &MockEmbedMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockEmbed) EXPECT() *MockEmbedMockRecorder { return m.recorder } // EmbeddedMethod mocks base method. func (m *MockEmbed) EmbeddedMethod() { m.ctrl.T.Helper() m.ctrl.Call(m, "EmbeddedMethod") } // EmbeddedMethod indicates an expected call of EmbeddedMethod. func (mr *MockEmbedMockRecorder) EmbeddedMethod() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "EmbeddedMethod", reflect.TypeOf((*MockEmbed)(nil).EmbeddedMethod)) } // ForeignEmbeddedMethod mocks base method. func (m *MockEmbed) ForeignEmbeddedMethod() *bufio.Reader { m.ctrl.T.Helper() ret := m.ctrl.Call(m, "ForeignEmbeddedMethod") ret0, _ := ret[0].(*bufio.Reader) return ret0 } // ForeignEmbeddedMethod indicates an expected call of ForeignEmbeddedMethod. func (mr *MockEmbedMockRecorder) ForeignEmbeddedMethod() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ForeignEmbeddedMethod", reflect.TypeOf((*MockEmbed)(nil).ForeignEmbeddedMethod)) } // ImplicitPackage mocks base method. func (m *MockEmbed) ImplicitPackage(arg0 string, arg1 imp1.ImpT, arg2 []imp1.ImpT, arg3 *imp1.ImpT, arg4 chan imp1.ImpT) { m.ctrl.T.Helper() m.ctrl.Call(m, "ImplicitPackage", arg0, arg1, arg2, arg3, arg4) } // ImplicitPackage indicates an expected call of ImplicitPackage. func (mr *MockEmbedMockRecorder) ImplicitPackage(arg0, arg1, arg2, arg3, arg4 interface{}) *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ImplicitPackage", reflect.TypeOf((*MockEmbed)(nil).ImplicitPackage), arg0, arg1, arg2, arg3, arg4) } // RegularMethod mocks base method. func (m *MockEmbed) RegularMethod() { m.ctrl.T.Helper() m.ctrl.Call(m, "RegularMethod") } // RegularMethod indicates an expected call of RegularMethod. func (mr *MockEmbedMockRecorder) RegularMethod() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "RegularMethod", reflect.TypeOf((*MockEmbed)(nil).RegularMethod)) } // MockEmbedded is a mock of Embedded interface. type MockEmbedded struct { ctrl *gomock.Controller recorder *MockEmbeddedMockRecorder } // MockEmbeddedMockRecorder is the mock recorder for MockEmbedded. type MockEmbeddedMockRecorder struct { mock *MockEmbedded } // NewMockEmbedded creates a new mock instance. func NewMockEmbedded(ctrl *gomock.Controller) *MockEmbedded { mock := &MockEmbedded{ctrl: ctrl} mock.recorder = &MockEmbeddedMockRecorder{mock} return mock } // EXPECT returns an object that allows the caller to indicate expected use. func (m *MockEmbedded) EXPECT() *MockEmbeddedMockRecorder { return m.recorder } // EmbeddedMethod mocks base method. func (m *MockEmbedded) EmbeddedMethod() { m.ctrl.T.Helper() m.ctrl.Call(m, "EmbeddedMethod") } // EmbeddedMethod indicates an expected call of EmbeddedMethod. func (mr *MockEmbeddedMockRecorder) EmbeddedMethod() *gomock.Call { mr.mock.ctrl.T.Helper() return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "EmbeddedMethod", reflect.TypeOf((*MockEmbedded)(nil).EmbeddedMethod)) } ================================================ FILE: sample/user.go ================================================ // Package user is an example package with an interface. package user //go:generate mockgen -destination mock_user_test.go -package user_test github.com/golang/mock/sample Index,Embed,Embedded // Random bunch of imports to test mockgen. import ( "io" btz "bytes" "hash" "log" "net" "net/http" // Two imports with the same base name. t1 "html/template" t2 "text/template" "github.com/golang/mock/sample/imp1" // Dependencies outside the standard library. renamed2 "github.com/golang/mock/sample/imp2" . "github.com/golang/mock/sample/imp3" imp_four "github.com/golang/mock/sample/imp4" ) // calls itself "imp_four" // A bizarre interface to test corner cases in mockgen. // This would normally be in its own file or package, // separate from the user of it (e.g. io.Reader). type Index interface { Get(key string) interface{} GetTwo(key1, key2 string) (v1, v2 interface{}) Put(key string, value interface{}) // Check that imports are handled correctly. Summary(buf *btz.Buffer, w io.Writer) Other() hash.Hash Templates(a t1.CSS, b t2.FuncMap) // A method with an anonymous argument. Anon(string) // Methods using foreign types outside the standard library. ForeignOne(imp1.Imp1) ForeignTwo(renamed2.Imp2) ForeignThree(Imp3) ForeignFour(imp_four.Imp4) // A method that returns a nillable type. NillableRet() error // A method that returns a non-interface type. ConcreteRet() chan<- bool // Methods with an ellipsis argument. Ellip(fmt string, args ...interface{}) EllipOnly(...string) // A method with a pointer argument that we will set. Ptr(arg *int) // A method with a slice argument and an array return. Slice(a []int, b []byte) [3]int // A method with channel arguments. Chan(a chan int, b chan<- hash.Hash) // A method with a function argument. Func(f func(http.Request) (int, bool)) // A method with a map argument. Map(a map[int]hash.Hash) // Methods with an unnamed empty struct argument. Struct(a struct{}) // not so likely StructChan(a chan struct{}) // a bit more common } // An interface with an embedded interface. type Embed interface { RegularMethod() Embedded imp1.ForeignEmbedded } type Embedded interface { EmbeddedMethod() } // some random use of another package that isn't needed by the interface. var _ net.Addr // A function that we will test that uses the above interface. // It takes a list of keys and values, and puts them in the index. func Remember(index Index, keys []string, values []interface{}) { for i, k := range keys { index.Put(k, values[i]) } err := index.NillableRet() if err != nil { log.Fatalf("Woah! %v", err) } if len(keys) > 0 && keys[0] == "a" { index.Ellip("%d", 0, 1, 1, 2, 3) index.Ellip("%d", 1, 3, 6, 10, 15) index.EllipOnly("arg") } } func GrabPointer(index Index) int { var a int index.Ptr(&a) return a } ================================================ FILE: sample/user_test.go ================================================ // A test that uses a mock. package user_test import ( "testing" "github.com/golang/mock/gomock" user "github.com/golang/mock/sample" "github.com/golang/mock/sample/imp1" ) func TestRemember(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() mockIndex := NewMockIndex(ctrl) mockIndex.EXPECT().Put("a", 1) // literals work mockIndex.EXPECT().Put("b", gomock.Eq(2)) // matchers work too // NillableRet returns error. Not declaring it should result in a nil return. mockIndex.EXPECT().NillableRet() // Calls that returns something assignable to the return type. boolc := make(chan bool) // In this case, "chan bool" is assignable to "chan<- bool". mockIndex.EXPECT().ConcreteRet().Return(boolc) // In this case, nil is assignable to "chan<- bool". mockIndex.EXPECT().ConcreteRet().Return(nil) // Should be able to place expectations on variadic methods. mockIndex.EXPECT().Ellip("%d", 0, 1, 1, 2, 3) // direct args tri := []interface{}{1, 3, 6, 10, 15} mockIndex.EXPECT().Ellip("%d", tri...) // args from slice mockIndex.EXPECT().EllipOnly(gomock.Eq("arg")) user.Remember(mockIndex, []string{"a", "b"}, []interface{}{1, 2}) // Check the ConcreteRet calls. if c := mockIndex.ConcreteRet(); c != boolc { t.Errorf("ConcreteRet: got %v, want %v", c, boolc) } if c := mockIndex.ConcreteRet(); c != nil { t.Errorf("ConcreteRet: got %v, want nil", c) } // Try one with an action. calledString := "" mockIndex.EXPECT().Put(gomock.Any(), gomock.Any()).Do(func(key string, _ interface{}) { calledString = key }) mockIndex.EXPECT().NillableRet() user.Remember(mockIndex, []string{"blah"}, []interface{}{7}) if calledString != "blah" { t.Fatalf(`Uh oh. %q != "blah"`, calledString) } // Use Do with a nil arg. mockIndex.EXPECT().Put("nil-key", gomock.Any()).Do(func(key string, value interface{}) { if value != nil { t.Errorf("Put did not pass through nil; got %v", value) } }) mockIndex.EXPECT().NillableRet() user.Remember(mockIndex, []string{"nil-key"}, []interface{}{nil}) } func TestVariadicFunction(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() mockIndex := NewMockIndex(ctrl) mockIndex.EXPECT().Ellip("%d", 5, 6, 7, 8).Do(func(format string, nums ...int) { sum := 0 for _, value := range nums { sum += value } if sum != 26 { t.Errorf("Expected 26, got %d", sum) } }) mockIndex.EXPECT().Ellip("%d", gomock.Any()).Do(func(format string, nums ...int) { sum := 0 for _, value := range nums { sum += value } if sum != 10 { t.Errorf("Expected 10, got %d", sum) } }) mockIndex.EXPECT().Ellip("%d", gomock.Any()).Do(func(format string, nums ...int) { sum := 0 for _, value := range nums { sum += value } if sum != 0 { t.Errorf("Expected 0, got %d", sum) } }) mockIndex.EXPECT().Ellip("%d", gomock.Any()).Do(func(format string, nums ...int) { sum := 0 for _, value := range nums { sum += value } if sum != 0 { t.Errorf("Expected 0, got %d", sum) } }) mockIndex.EXPECT().Ellip("%d").Do(func(format string, nums ...int) { sum := 0 for _, value := range nums { sum += value } if sum != 0 { t.Errorf("Expected 0, got %d", sum) } }) mockIndex.Ellip("%d", 1, 2, 3, 4) // Match second matcher. mockIndex.Ellip("%d", 5, 6, 7, 8) // Match first matcher. mockIndex.Ellip("%d", 0) mockIndex.Ellip("%d") mockIndex.Ellip("%d") } func TestGrabPointer(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() mockIndex := NewMockIndex(ctrl) mockIndex.EXPECT().Ptr(gomock.Any()).SetArg(0, 7) // set first argument to 7 i := user.GrabPointer(mockIndex) if i != 7 { t.Errorf("Expected 7, got %d", i) } } func TestEmbeddedInterface(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() mockEmbed := NewMockEmbed(ctrl) mockEmbed.EXPECT().RegularMethod() mockEmbed.EXPECT().EmbeddedMethod() mockEmbed.EXPECT().ForeignEmbeddedMethod() mockEmbed.RegularMethod() mockEmbed.EmbeddedMethod() var emb imp1.ForeignEmbedded = mockEmbed // also does interface check emb.ForeignEmbeddedMethod() } func TestExpectTrueNil(t *testing.T) { // Make sure that passing "nil" to EXPECT (thus as a nil interface value), // will correctly match a nil concrete type. ctrl := gomock.NewController(t) defer ctrl.Finish() mockIndex := NewMockIndex(ctrl) mockIndex.EXPECT().Ptr(nil) // this nil is a nil interface{} mockIndex.Ptr(nil) // this nil is a nil *int } func TestDoAndReturnSignature(t *testing.T) { t.Run("wrong number of return args", func(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() mockIndex := NewMockIndex(ctrl) mockIndex.EXPECT().Slice(gomock.Any(), gomock.Any()).DoAndReturn( func(_ []int, _ []byte) {}, ) defer func() { if r := recover(); r == nil { t.Error("expected panic") } }() mockIndex.Slice([]int{0}, []byte("meow")) }) t.Run("wrong type of return arg", func(t *testing.T) { ctrl := gomock.NewController(t) defer ctrl.Finish() mockIndex := NewMockIndex(ctrl) mockIndex.EXPECT().Slice(gomock.Any(), gomock.Any()).DoAndReturn( func(_ []int, _ []byte) bool { return true }) mockIndex.Slice([]int{0}, []byte("meow")) }) }