refactor: improve leverage keeper tests and errors

CHANGELOG.md

@@ -98,6 +98,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 - [1012](https://github.com/umee-network/umee/pull/1012) Improve negative time elapsed error message
 - [1236](https://github.com/umee-network/umee/pull/1236) Improve leverage event fields.
 - [1294](https://github.com/umee-network/umee/pull/1294) Simplify window progress query math.
+- [1300](https://github.com/umee-network/umee/pull/1300) Improve leverage test suite and error specificity.
 
 ### Bug Fixes
 

app/app.go

@@ -703,7 +703,6 @@ func (app *UmeeApp) setAnteHandler(txConfig client.TxConfig) {
 			OracleKeeper:    app.OracleKeeper,
 		},
 	)
-
 	if err != nil {
 		panic(err)
 	}

swagger/swagger.yaml

@@ -184,6 +184,60 @@ paths:
           type: string
       tags:
         - Query
+  /umee/leverage/v1/bad_debts:
+    get:
+      summary: >-
+        BadDebts queries a list of borrow positions that have been marked for
+        bad debt repayment.
+      operationId: BadDebts
+      responses:
+        '200':
+          description: A successful response.
+          schema:
+            type: object
+            properties:
+              targets:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    address:
+                      type: string
+                    denom:
+                      type: string
+                  description: >-
+                    BadDebt is a bad debt instance used in the leverage module's
+                    genesis state.
+                description: >-
+                  Targets are borrow positions currently marked for bad debt
+                  repayment. Each contains an Address and a Denom.
+            description: >-
+              QueryBadDebtsResponse defines the response structure for the
+              BedDebts gRPC service handler.
+        default:
+          description: An unexpected error response.
+          schema:
+            type: object
+            properties:
+              error:
+                type: string
+              code:
+                type: integer
+                format: int32
+              message:
+                type: string
+              details:
+                type: array
+                items:
+                  type: object
+                  properties:
+                    type_url:
+                      type: string
+                    value:
+                      type: string
+                      format: byte
+      tags:
+        - Query
   /umee/leverage/v1/liquidation_targets:
     get:
       summary: >-
@@ -205,9 +259,7 @@ paths:
                   liquidation.
             description: >-
               QueryLiquidationTargetsResponse defines the response structure for
-              the
-
-              LiquidationTargets gRPC service handler.
+              the LiquidationTargets gRPC service handler.
         default:
           description: An unexpected error response.
           schema:
@@ -475,13 +527,13 @@ paths:
                   direct_liquidation_fee:
                     type: string
                     description: >-
-                      Direct Liquidation Fee is the reduction in liquidation
-                      incentive experienced
+                      Direct Liquidation Fee is a reduction factor in
+                      liquidation incentive
 
-                      by liquidators who choose to receive base assets instead
-                      of uTokens as
+                      experienced by liquidators who choose to receive base
+                      assets instead of
 
-                      liquidation rewards.
+                      uTokens as liquidation rewards.
                 description: Params defines the parameters for the leverage module.
             description: >-
               QueryParamsResponse defines the response structure for the Params
@@ -1368,6 +1420,16 @@ definitions:
             value:
               type: string
               format: byte
+  umee.leverage.v1.BadDebt:
+    type: object
+    properties:
+      address:
+        type: string
+      denom:
+        type: string
+    description: >-
+      BadDebt is a bad debt instance used in the leverage module's genesis
+      state.
   umee.leverage.v1.Params:
     type: object
     properties:
@@ -1403,12 +1465,12 @@ definitions:
       direct_liquidation_fee:
         type: string
         description: >-
-          Direct Liquidation Fee is the reduction in liquidation incentive
-          experienced
+          Direct Liquidation Fee is a reduction factor in liquidation incentive
 
-          by liquidators who choose to receive base assets instead of uTokens as
+          experienced by liquidators who choose to receive base assets instead
+          of
 
-          liquidation rewards.
+          uTokens as liquidation rewards.
     description: Params defines the parameters for the leverage module.
   umee.leverage.v1.QueryAccountBalancesResponse:
     type: object
@@ -1504,6 +1566,27 @@ definitions:
     description: >-
       QueryAccountSummaryResponse defines the response structure for the
       AccountSummary gRPC service handler.
+  umee.leverage.v1.QueryBadDebtsResponse:
+    type: object
+    properties:
+      targets:
+        type: array
+        items:
+          type: object
+          properties:
+            address:
+              type: string
+            denom:
+              type: string
+          description: >-
+            BadDebt is a bad debt instance used in the leverage module's genesis
+            state.
+        description: >-
+          Targets are borrow positions currently marked for bad debt repayment.
+          Each contains an Address and a Denom.
+    description: >-
+      QueryBadDebtsResponse defines the response structure for the BedDebts gRPC
+      service handler.
   umee.leverage.v1.QueryLiquidationTargetsResponse:
     type: object
     properties:
@@ -1512,7 +1595,7 @@ definitions:
         items:
           type: string
         description: Targets are the addresses of borrowers eligible for liquidation.
-    description: |-
+    description: >-
       QueryLiquidationTargetsResponse defines the response structure for the
       LiquidationTargets gRPC service handler.
   umee.leverage.v1.QueryMarketSummaryResponse:
@@ -1703,13 +1786,13 @@ definitions:
           direct_liquidation_fee:
             type: string
             description: >-
-              Direct Liquidation Fee is the reduction in liquidation incentive
-              experienced
+              Direct Liquidation Fee is a reduction factor in liquidation
+              incentive
 
-              by liquidators who choose to receive base assets instead of
-              uTokens as
+              experienced by liquidators who choose to receive base assets
+              instead of
 
-              liquidation rewards.
+              uTokens as liquidation rewards.
         description: Params defines the parameters for the leverage module.
     description: |-
       QueryParamsResponse defines the response structure for the Params gRPC

x/leverage/client/tests/suite.go

@@ -17,8 +17,6 @@ import (
 type IntegrationTestSuite struct {
 	suite.Suite
 
-	abort bool // stop interdependent tests on the first error for clarity
-
 	cfg     network.Config
 	network *network.Network
 }
@@ -44,38 +42,37 @@ func (s *IntegrationTestSuite) TearDownSuite() {
 	s.network.Cleanup()
 }
 
-// TestCases are queries and transactions that can be run, and return a boolean
-// which indicates to abort the test suite if true
-type TestCase interface {
-	Run(s *IntegrationTestSuite) bool
+// runTestQuery
+func (s *IntegrationTestSuite) runTestQueries(tqs ...testQuery) {
+	for _, t := range tqs {
+		t.Run(s)
+	}
 }
 
 // runTestCases runs test transactions or queries, stopping early if an error occurs
-func (s *IntegrationTestSuite) runTestCases(tcs ...TestCase) {
-	for _, t := range tcs {
-		if !s.abort {
-			s.abort = t.Run(s)
-		}
+func (s *IntegrationTestSuite) runTestTransactions(txs ...testTransaction) {
+	for _, t := range txs {
+		t.Run(s)
 	}
 }
 
 type testTransaction struct {
-	name        string
+	msg         string
 	command     *cobra.Command
 	args        []string
 	expectedErr *errors.Error
 }
 
 type testQuery struct {
-	name             string
+	msg              string
 	command          *cobra.Command
 	args             []string
 	expectErr        bool
 	responseType     proto.Message
 	expectedResponse proto.Message
 }
 
-func (t testTransaction) Run(s *IntegrationTestSuite) (abort bool) {
+func (t testTransaction) Run(s *IntegrationTestSuite) {
 	clientCtx := s.network.Validators[0].ClientCtx
 
 	txFlags := []string{
@@ -87,36 +84,21 @@ func (t testTransaction) Run(s *IntegrationTestSuite) (abort bool) {
 
 	t.args = append(t.args, txFlags...)
 
-	s.Run(t.name, func() {
-		out, err := clitestutil.ExecTestCLICmd(clientCtx, t.command, t.args)
-		s.Require().NoError(err)
-		if err != nil {
-			abort = true
-		}
-
-		resp := &sdk.TxResponse{}
-		err = clientCtx.Codec.UnmarshalJSON(out.Bytes(), resp)
-		s.Require().NoError(err, out.String())
-		if err != nil {
-			abort = true
-		}
-
-		if t.expectedErr == nil {
-			s.Require().Equal(0, int(resp.Code), "events %v", resp.Events)
-			if int(resp.Code) != 0 {
-				abort = true
-			}
-		} else {
-			s.Require().Equal(int(t.expectedErr.ABCICode()), int(resp.Code))
-			if int(resp.Code) != int(t.expectedErr.ABCICode()) {
-				abort = true
-			}
-		}
-	})
-	return abort
+	out, err := clitestutil.ExecTestCLICmd(clientCtx, t.command, t.args)
+	s.Require().NoError(err, t.msg)
+
+	resp := &sdk.TxResponse{}
+	err = clientCtx.Codec.UnmarshalJSON(out.Bytes(), resp)
+	s.Require().NoError(err, t.msg)
+
+	if t.expectedErr == nil {
+		s.Require().Equal(0, int(resp.Code), t.msg)
+	} else {
+		s.Require().Equal(int(t.expectedErr.ABCICode()), int(resp.Code), t.msg)
+	}
 }
 
-func (t testQuery) Run(s *IntegrationTestSuite) (abort bool) {
+func (t testQuery) Run(s *IntegrationTestSuite) {
 	clientCtx := s.network.Validators[0].ClientCtx
 
 	queryFlags := []string{
@@ -125,31 +107,16 @@ func (t testQuery) Run(s *IntegrationTestSuite) (abort bool) {
 
 	t.args = append(t.args, queryFlags...)
 
-	s.Run(t.name, func() {
-		out, err := clitestutil.ExecTestCLICmd(clientCtx, t.command, t.args)
-
-		if t.expectErr {
-			s.Require().Error(err)
-			if err == nil {
-				abort = true
-			}
-		} else {
-			s.Require().NoError(err)
-			if err != nil {
-				abort = true
-			}
-
-			err = clientCtx.Codec.UnmarshalJSON(out.Bytes(), t.responseType)
-			s.Require().NoError(err, out.String())
-			if err != nil {
-				abort = true
-			}
-
-			s.Require().Equal(t.expectedResponse, t.responseType)
-			if !s.Assert().Equal(t.expectedResponse, t.responseType) {
-				abort = true
-			}
-		}
-	})
-	return abort
+	out, err := clitestutil.ExecTestCLICmd(clientCtx, t.command, t.args)
+
+	if t.expectErr {
+		s.Require().Error(err, t.msg)
+	} else {
+		s.Require().NoError(err, t.msg)
+
+		err = clientCtx.Codec.UnmarshalJSON(out.Bytes(), t.responseType)
+		s.Require().NoError(err, t.msg)
+
+		s.Require().Equal(t.expectedResponse, t.responseType)
+	}
 }