fix mockery generation script (#9094) (#9114)

.github/workflows/check-generated.yml

@@ -7,7 +7,7 @@ name: Check generated code
 on:
   pull_request:
     branches:
-      - v0.34.x
+      - main
 
 permissions:
   contents: read

Makefile

@@ -74,9 +74,9 @@ install:
 ###                                Mocks                                    ###
 ###############################################################################
 
-mockery: 
+mockery:
 	go generate -run="./scripts/mockery_generate.sh" ./...
-.PHONY: mockery 
+.PHONY: mockery
 
 ###############################################################################
 ###                                Protobuf                                 ###

evidence/mocks/block_store.go

@@ -1,4 +1,4 @@
-// Code generated by mockery v2.14.0. DO NOT EDIT.
+// Code generated by mockery. DO NOT EDIT.
 
 package mocks
 
@@ -58,13 +58,13 @@ func (_m *BlockStore) LoadBlockMeta(height int64) *types.BlockMeta {
 	return r0
 }
 
-type mockConstructorTestingTNewBlockStore interface {
+type NewBlockStoreT interface {
 	mock.TestingT
 	Cleanup(func())
 }
 
 // NewBlockStore creates a new instance of BlockStore. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
-func NewBlockStore(t mockConstructorTestingTNewBlockStore) *BlockStore {
+func NewBlockStore(t NewBlockStoreT) *BlockStore {
 	mock := &BlockStore{}
 	mock.Mock.Test(t)
 

evidence/services.go

@@ -4,7 +4,7 @@ import (
 	"github.com/tendermint/tendermint/types"
 )
 
-//go:generate mockery --case underscore --name BlockStore
+//go:generate ../scripts/mockery_generate.sh BlockStore
 
 type BlockStore interface {
 	LoadBlockMeta(height int64) *types.BlockMeta

light/rpc/client.go

@@ -27,7 +27,7 @@ var errNegOrZeroHeight = errors.New("negative or zero height")
 type KeyPathFunc func(path string, key []byte) (merkle.KeyPath, error)
 
 // LightClient is an interface that contains functionality needed by Client from the light client.
-//go:generate mockery --case underscore --name LightClient
+//go:generate ../../scripts/mockery_generate.sh LightClient
 type LightClient interface {
 	ChainID() string
 	Update(ctx context.Context, now time.Time) (*types.LightBlock, error)

light/rpc/mocks/light_client.go

@@ -1,4 +1,4 @@
-// Code generated by mockery v2.14.0. DO NOT EDIT.
+// Code generated by mockery. DO NOT EDIT.
 
 package mocks
 
@@ -100,13 +100,13 @@ func (_m *LightClient) VerifyLightBlockAtHeight(ctx context.Context, height int6
 	return r0, r1
 }
 
-type mockConstructorTestingTNewLightClient interface {
+type NewLightClientT interface {
 	mock.TestingT
 	Cleanup(func())
 }
 
 // NewLightClient creates a new instance of LightClient. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
-func NewLightClient(t mockConstructorTestingTNewLightClient) *LightClient {
+func NewLightClient(t NewLightClientT) *LightClient {
 	mock := &LightClient{}
 	mock.Mock.Test(t)
 

p2p/mocks/peer.go

@@ -1,4 +1,4 @@
-// Code generated by mockery v2.14.0. DO NOT EDIT.
+// Code generated by mockery. DO NOT EDIT.
 
 package mocks
 
@@ -330,13 +330,13 @@ func (_m *Peer) TrySend(_a0 byte, _a1 []byte) bool {
 	return r0
 }
 
-type mockConstructorTestingTNewPeer interface {
+type NewPeerT interface {
 	mock.TestingT
 	Cleanup(func())
 }
 
 // NewPeer creates a new instance of Peer. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
-func NewPeer(t mockConstructorTestingTNewPeer) *Peer {
+func NewPeer(t NewPeerT) *Peer {
 	mock := &Peer{}
 	mock.Mock.Test(t)
 

p2p/peer.go

@@ -12,7 +12,7 @@ import (
 	tmconn "github.com/tendermint/tendermint/p2p/conn"
 )
 
-//go:generate mockery --case underscore --name Peer
+//go:generate ../scripts/mockery_generate.sh Peer
 
 const metricsTickerDuration = 10 * time.Second
 

proxy/app_conn.go

@@ -5,7 +5,7 @@ import (
 	"github.com/tendermint/tendermint/abci/types"
 )
 
-//go:generate mockery --case underscore --name AppConnConsensus|AppConnMempool|AppConnQuery|AppConnSnapshot
+//go:generate ../scripts/mockery_generate.sh AppConnConsensus|AppConnMempool|AppConnQuery|AppConnSnapshot
 
 //----------------------------------------------------------------------------------------
 // Enforce which abci msgs can be sent on a connection at the type level

proxy/client.go

@@ -11,6 +11,8 @@ import (
 	e2e "github.com/tendermint/tendermint/test/e2e/app"
 )
 
+//go:generate ../scripts/mockery_generate.sh ClientCreator
+
 // ClientCreator creates new ABCI clients.
 type ClientCreator interface {
 	// NewABCIClient returns a new ABCI client.

proxy/mocks/app_conn_consensus.go

@@ -1,4 +1,4 @@
-// Code generated by mockery v2.14.0. DO NOT EDIT.
+// Code generated by mockery. DO NOT EDIT.
 
 package mocks
 
@@ -141,13 +141,13 @@ func (_m *AppConnConsensus) SetResponseCallback(_a0 abcicli.Callback) {
 	_m.Called(_a0)
 }
 
-type mockConstructorTestingTNewAppConnConsensus interface {
+type NewAppConnConsensusT interface {
 	mock.TestingT
 	Cleanup(func())
 }
 
 // NewAppConnConsensus creates a new instance of AppConnConsensus. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
-func NewAppConnConsensus(t mockConstructorTestingTNewAppConnConsensus) *AppConnConsensus {
+func NewAppConnConsensus(t NewAppConnConsensusT) *AppConnConsensus {
 	mock := &AppConnConsensus{}
 	mock.Mock.Test(t)
 

proxy/mocks/app_conn_mempool.go

@@ -1,4 +1,4 @@
-// Code generated by mockery v2.14.0. DO NOT EDIT.
+// Code generated by mockery. DO NOT EDIT.
 
 package mocks
 
@@ -102,13 +102,13 @@ func (_m *AppConnMempool) SetResponseCallback(_a0 abcicli.Callback) {
 	_m.Called(_a0)
 }
 
-type mockConstructorTestingTNewAppConnMempool interface {
+type NewAppConnMempoolT interface {
 	mock.TestingT
 	Cleanup(func())
 }
 
 // NewAppConnMempool creates a new instance of AppConnMempool. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
-func NewAppConnMempool(t mockConstructorTestingTNewAppConnMempool) *AppConnMempool {
+func NewAppConnMempool(t NewAppConnMempoolT) *AppConnMempool {
 	mock := &AppConnMempool{}
 	mock.Mock.Test(t)
 

proxy/mocks/app_conn_query.go

@@ -1,4 +1,4 @@
-// Code generated by mockery v2.14.0. DO NOT EDIT.
+// Code generated by mockery. DO NOT EDIT.
 
 package mocks
 
@@ -96,13 +96,13 @@ func (_m *AppConnQuery) QuerySync(_a0 types.RequestQuery) (*types.ResponseQuery,
 	return r0, r1
 }
 
-type mockConstructorTestingTNewAppConnQuery interface {
+type NewAppConnQueryT interface {
 	mock.TestingT
 	Cleanup(func())
 }
 
 // NewAppConnQuery creates a new instance of AppConnQuery. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
-func NewAppConnQuery(t mockConstructorTestingTNewAppConnQuery) *AppConnQuery {
+func NewAppConnQuery(t NewAppConnQueryT) *AppConnQuery {
 	mock := &AppConnQuery{}
 	mock.Mock.Test(t)
 

proxy/mocks/app_conn_snapshot.go

@@ -1,4 +1,4 @@
-// Code generated by mockery v2.14.0. DO NOT EDIT.
+// Code generated by mockery. DO NOT EDIT.
 
 package mocks
 
@@ -119,13 +119,13 @@ func (_m *AppConnSnapshot) OfferSnapshotSync(_a0 types.RequestOfferSnapshot) (*t
 	return r0, r1
 }
 
-type mockConstructorTestingTNewAppConnSnapshot interface {
+type NewAppConnSnapshotT interface {
 	mock.TestingT
 	Cleanup(func())
 }
 
 // NewAppConnSnapshot creates a new instance of AppConnSnapshot. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
-func NewAppConnSnapshot(t mockConstructorTestingTNewAppConnSnapshot) *AppConnSnapshot {
+func NewAppConnSnapshot(t NewAppConnSnapshotT) *AppConnSnapshot {
 	mock := &AppConnSnapshot{}
 	mock.Mock.Test(t)
 

proxy/mocks/client_creator.go

@@ -1,10 +1,9 @@
-// Code generated by mockery v1.1.1. DO NOT EDIT.
+// Code generated by mockery. DO NOT EDIT.
 
 package mocks
 
 import (
 	mock "github.com/stretchr/testify/mock"
-
 	abcicli "github.com/tendermint/tendermint/abci/client"
 )
 
@@ -35,3 +34,18 @@ func (_m *ClientCreator) NewABCIClient() (abcicli.Client, error) {
 
 	return r0, r1
 }
+
+type NewClientCreatorT interface {
+	mock.TestingT
+	Cleanup(func())
+}
+
+// NewClientCreator creates a new instance of ClientCreator. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
+func NewClientCreator(t NewClientCreatorT) *ClientCreator {
+	mock := &ClientCreator{}
+	mock.Mock.Test(t)
+
+	t.Cleanup(func() { mock.AssertExpectations(t) })
+
+	return mock
+}

scripts/mockery_generate.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+#
+# Invoke Mockery v2 to update generated mocks for the given type.
+#
+# This script runs a locally-installed "mockery" if available, otherwise it
+# runs the published Docker container. This legerdemain is so that the CI build
+# and a local build can work off the same script.
+#
+if ! which mockery ; then
+  mockery() {
+    docker run --rm -v "$PWD":/w --workdir=/w vektra/mockery:v2.12.3
+  }
+fi
+
+mockery --disable-version-string --case underscore --name "$@"

state/indexer/block.go

@@ -7,7 +7,7 @@ import (
 	"github.com/tendermint/tendermint/types"
 )
 
-//go:generate mockery --case underscore --name BlockIndexer
+//go:generate ../../scripts/mockery_generate.sh BlockIndexer
 
 // BlockIndexer defines an interface contract for indexing block events.
 type BlockIndexer interface {

state/indexer/mocks/block_indexer.go

@@ -1,4 +1,4 @@
-// Code generated by mockery v2.12.3. DO NOT EDIT.
+// Code generated by mockery. DO NOT EDIT.
 
 package mocks
 

state/mocks/block_store.go

@@ -1,4 +1,4 @@
-// Code generated by mockery v2.14.0. DO NOT EDIT.
+// Code generated by mockery. DO NOT EDIT.
 
 package mocks
 
@@ -193,13 +193,13 @@ func (_m *BlockStore) Size() int64 {
 	return r0
 }
 
-type mockConstructorTestingTNewBlockStore interface {
+type NewBlockStoreT interface {
 	mock.TestingT
 	Cleanup(func())
 }
 
 // NewBlockStore creates a new instance of BlockStore. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
-func NewBlockStore(t mockConstructorTestingTNewBlockStore) *BlockStore {
+func NewBlockStore(t NewBlockStoreT) *BlockStore {
 	mock := &BlockStore{}
 	mock.Mock.Test(t)
 

state/mocks/evidence_pool.go

@@ -1,4 +1,4 @@
-// Code generated by mockery v2.14.0. DO NOT EDIT.
+// Code generated by mockery. DO NOT EDIT.
 
 package mocks
 
@@ -70,13 +70,13 @@ func (_m *EvidencePool) Update(_a0 state.State, _a1 types.EvidenceList) {
 	_m.Called(_a0, _a1)
 }
 
-type mockConstructorTestingTNewEvidencePool interface {
+type NewEvidencePoolT interface {
 	mock.TestingT
 	Cleanup(func())
 }
 
 // NewEvidencePool creates a new instance of EvidencePool. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
-func NewEvidencePool(t mockConstructorTestingTNewEvidencePool) *EvidencePool {
+func NewEvidencePool(t NewEvidencePoolT) *EvidencePool {
 	mock := &EvidencePool{}
 	mock.Mock.Test(t)
 

state/mocks/store.go

@@ -1,4 +1,4 @@
-// Code generated by mockery v2.14.0. DO NOT EDIT.
+// Code generated by mockery. DO NOT EDIT.
 
 package mocks
 
@@ -218,13 +218,13 @@ func (_m *Store) SaveABCIResponses(_a0 int64, _a1 *tendermintstate.ABCIResponses
 	return r0
 }
 
-type mockConstructorTestingTNewStore interface {
+type NewStoreT interface {
 	mock.TestingT
 	Cleanup(func())
 }
 
 // NewStore creates a new instance of Store. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
-func NewStore(t mockConstructorTestingTNewStore) *Store {
+func NewStore(t NewStoreT) *Store {
 	mock := &Store{}
 	mock.Mock.Test(t)
 

state/services.go

@@ -12,7 +12,7 @@ import (
 //------------------------------------------------------
 // blockstore
 
-//go:generate mockery --case underscore --name BlockStore
+//go:generate ../scripts/mockery_generate.sh BlockStore
 
 // BlockStore defines the interface used by the ConsensusState.
 type BlockStore interface {
@@ -38,7 +38,7 @@ type BlockStore interface {
 //-----------------------------------------------------------------------------
 // evidence pool
 
-//go:generate mockery --case underscore --name EvidencePool
+//go:generate ../scripts/mockery_generate.sh EvidencePool
 
 // EvidencePool defines the EvidencePool interface used by State.
 type EvidencePool interface {

state/store.go

@@ -39,7 +39,7 @@ func calcABCIResponsesKey(height int64) []byte {
 
 //----------------------
 
-//go:generate mockery --case underscore --name Store
+//go:generate ../scripts/mockery_generate.sh Store
 
 // Store defines the state store interface
 //

state/txindex/indexer.go

@@ -10,7 +10,7 @@ import (
 
 // XXX/TODO: These types should be moved to the indexer package.
 
-//go:generate mockery --case underscore --name TxIndexer
+//go:generate ../../scripts/mockery_generate.sh TxIndexer
 
 // TxIndexer interface defines methods to index and search transactions.
 type TxIndexer interface {

state/txindex/mocks/tx_indexer.go

@@ -1,4 +1,4 @@
-// Code generated by mockery v2.12.3. DO NOT EDIT.
+// Code generated by mockery. DO NOT EDIT.
 
 package mocks
 

statesync/mocks/state_provider.go

@@ -1,4 +1,4 @@
-// Code generated by mockery v2.14.0. DO NOT EDIT.
+// Code generated by mockery. DO NOT EDIT.
 
 package mocks
 
@@ -83,13 +83,13 @@ func (_m *StateProvider) State(ctx context.Context, height uint64) (state.State,
 	return r0, r1
 }
 
-type mockConstructorTestingTNewStateProvider interface {
+type NewStateProviderT interface {
 	mock.TestingT
 	Cleanup(func())
 }
 
 // NewStateProvider creates a new instance of StateProvider. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
-func NewStateProvider(t mockConstructorTestingTNewStateProvider) *StateProvider {
+func NewStateProvider(t NewStateProviderT) *StateProvider {
 	mock := &StateProvider{}
 	mock.Mock.Test(t)
 

statesync/stateprovider.go

@@ -22,7 +22,7 @@ import (
 	"github.com/tendermint/tendermint/version"
 )
 
-//go:generate mockery --case underscore --name StateProvider
+//go:generate ../scripts/mockery_generate.sh StateProvider
 
 // StateProvider is a provider of trusted state data for bootstrapping a node. This refers
 // to the state.State object, not the state machine.