added switch case to detect blank pointers in keeper (#2403)

* added switch case to detect blank pointers in keeper * updated changelog.md * updated error message for keeper * fixed switch-case; added test cases * added function to check for empty keeper Co-authored-by: Carlos Rodriguez <carlos@interchain.io> Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com> (cherry picked from commit 462ccb6) # Conflicts: # CHANGELOG.md
cosmos · Sep 29, 2022 · 0ec5315 · 0ec5315
1 parent 770b57f
commit 0ec5315
Show file tree

Hide file tree

Showing 3 changed files with 54 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -67,6 +67,26 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 * (apps/27-interchain-accounts) [\#2147](https://github.com/cosmos/ibc-go/pull/2147) Adding a `SubmitTx` gRPC endpoint for the ICS27 Controller module which allows owners of interchain accounts to submit transactions. This replaces the previously existing need for authentication modules to implement this standard functionality.
 * (testing/simapp) [\#2190](https://github.com/cosmos/ibc-go/pull/2190) Adding the new `x/group` cosmos-sdk module to simapp.
+<<<<<<< HEAD
+=======
+
+### Bug Fixes
+
+* (makefile) [\#1785](https://github.com/cosmos/ibc-go/pull/1785) Fetch the correct versions of protocol buffers dependencies from tendermint, cosmos-sdk, and ics23.
+* (light-clients/solomachine) [#1839](https://github.com/cosmos/ibc-go/issues/1839) Fixed usage of the new diversifier in validation of changing diversifiers for the solo machine. The current diversifier must sign over the new diversifier.
+* (light-clients/07-tendermint) [\#1674](https://github.com/cosmos/ibc-go/pull/1674) Submitted ClientState is zeroed out before checking the proof in order to prevent the proposal from containing information governance is not actually voting on.
+* (modules/core/02-client)[\#1676](https://github.com/cosmos/ibc-go/pull/1676) ClientState must be zeroed out for `UpgradeProposals` to pass validation. This prevents a proposal containing information governance is not actually voting on.
+* (modules/core/keeper) [\#2268](https://github.com/cosmos/ibc-go/pull/2403) Added a function in keeper to cater for blank pointers.
+
+## [v4.1.0](https://github.com/cosmos/ibc-go/releases/tag/v4.1.0) - 2022-09-20
+
+### Dependencies
+
+* [\#2288](https://github.com/cosmos/ibc-go/pull/2288) Bump SDK version to v0.45.8 and Tendermint to v0.34.21.
+
+### Features
+
+>>>>>>> 462ccb6 (added switch case to detect blank pointers in keeper (#2403))
 * (apps/27-interchain-accounts) [\#2193](https://github.com/cosmos/ibc-go/pull/2193) Adding `InterchainAccount` gRPC query endpont to ICS27 `controller` submodule to allow users to retrieve registered interchain account addresses.
 
 ### Bug Fixes

diff --git a/modules/core/keeper/keeper.go b/modules/core/keeper/keeper.go
@@ -50,11 +50,10 @@ func NewKeeper(
 	}
 
 	// panic if any of the keepers passed in is empty
-	if reflect.ValueOf(stakingKeeper).IsZero() {
+	if isEmpty(stakingKeeper) {
 		panic(fmt.Errorf("cannot initialize IBC keeper: empty staking keeper"))
 	}
-
-	if reflect.ValueOf(upgradeKeeper).IsZero() {
+	if isEmpty(upgradeKeeper) {
 		panic(fmt.Errorf("cannot initialize IBC keeper: empty upgrade keeper"))
 	}
 
@@ -92,3 +91,19 @@ func (k *Keeper) SetRouter(rtr *porttypes.Router) {
 	k.Router = rtr
 	k.Router.Seal()
 }
+
+// isEmpty checks if the interface is an empty struct or a pointer pointing
+// to an empty struct
+func isEmpty(keeper interface{}) bool {
+	switch reflect.TypeOf(keeper).Kind() {
+	case reflect.Ptr:
+		if reflect.ValueOf(keeper).Elem().IsZero() {
+			return true
+		}
+	default:
+		if reflect.ValueOf(keeper).IsZero() {
+			return true
+		}
+	}
+	return false
+}
diff --git a/modules/core/keeper/keeper_test.go b/modules/core/keeper/keeper_test.go
@@ -79,21 +79,31 @@ func (suite *KeeperTestSuite) TestNewKeeper() {
 		malleate func()
 		expPass  bool
 	}{
-		{"failure: empty staking keeper", func() {
-			emptyStakingKeeper := stakingkeeper.Keeper{}
+		{"failure: empty staking keeper value", func() {
+			emptyStakingKeeperValue := stakingkeeper.Keeper{}
 
-			stakingKeeper = emptyStakingKeeper
+			stakingKeeper = emptyStakingKeeperValue
+		}, false},
+		{"failure: empty staking keeper pointer", func() {
+			emptyStakingKeeperPointer := &stakingkeeper.Keeper{}
+
+			stakingKeeper = emptyStakingKeeperPointer
 		}, false},
 		{"failure: empty mock staking keeper", func() {
 			// use a different implementation of clienttypes.StakingKeeper
 			emptyMockStakingKeeper := MockStakingKeeper{}
 
 			stakingKeeper = emptyMockStakingKeeper
 		}, false},
-		{"failure: empty upgrade keeper", func() {
-			emptyUpgradeKeeper := upgradekeeper.Keeper{}
+		{"failure: empty upgrade keeper value", func() {
+			emptyUpgradeKeeperValue := upgradekeeper.Keeper{}
+
+			upgradeKeeper = emptyUpgradeKeeperValue
+		}, false},
+		{"failure: empty upgrade keeper pointer", func() {
+			emptyUpgradeKeeperPointer := &upgradekeeper.Keeper{}
 
-			upgradeKeeper = emptyUpgradeKeeper
+			upgradeKeeper = emptyUpgradeKeeperPointer
 		}, false},
 		{"failure: empty scoped keeper", func() {
 			emptyScopedKeeper := capabilitykeeper.ScopedKeeper{}