Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Increase coverage for DecCoins #7031

Closed
4 tasks
fedekunze opened this issue Aug 13, 2020 · 2 comments
Closed
4 tasks

Increase coverage for DecCoins #7031

fedekunze opened this issue Aug 13, 2020 · 2 comments

Comments

@fedekunze
Copy link
Collaborator

During #7027 I noticed that there are a lot of DecCoin(s) functions that don't have tests. It would be nice to increase coverage for them and refactor the tests to use table tests instead.

cc: @clevinson @aaronc


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@levicook
Copy link

I decided to look at this, mainly as a way to familiarize myself with the codebase. I wanted to get a sense of what the current coverage was and found this useful:

$ go tool cover -func=coverage.out | grep dec_coin # w/in types
github.com/cosmos/cosmos-sdk/types/dec_coin.go:15:      NewDecCoin                              100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:25:      NewDecCoinFromDec                       100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:39:      NewDecCoinFromCoin                      100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:52:      NewInt64DecCoin                         100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:57:      IsZero                                  100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:63:      IsGTE                                   0.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:73:      IsLT                                    0.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:82:      IsEqual                                 66.7%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:91:      Add                                     100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:99:      Sub                                     100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:112:     TruncateDecimal                         100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:121:     IsPositive                              100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:128:     IsNegative                              100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:134:     String                                  100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:139:     Validate                                80.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:150:     IsValid                                 100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:163:     NewDecCoins                             75.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:172:     sanitizeDecCoins                        100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:184:     NewDecCoinsFromCoins                    100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:196:     String                                  100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:212:     TruncateDecimal                         100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:233:     Add                                     100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:242:     safeAdd                                 100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:291:     negative                                100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:303:     Sub                                     100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:314:     SafeSub                                 100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:324:     Intersect                               100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:337:     GetDenomByIndex                         0.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:346:     IsAnyNegative                           100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:359:     MulDec                                  0.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:379:     MulDecTruncate                          0.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:399:     QuoDec                                  0.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:423:     QuoDecTruncate                          100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:444:     Empty                                   0.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:449:     AmountOf                                100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:479:     IsEqual                                 75.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:497:     IsZero                                  0.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:508:     Validate                                100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:556:     IsValid                                 100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:564:     IsAllPositive                           0.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:578:     removeZeroDecCoins                      100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:596:     Len                                     100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:599:     Less                                    100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:602:     Swap                                    100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:605:     Sort                                    100.0%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:615:     ParseDecCoin                            81.8%
github.com/cosmos/cosmos-sdk/types/dec_coin.go:643:     ParseDecCoins                           100.0%

Taking it one step further, this highlights what isn't covered:

go tool cover -func=coverage.out | grep dec_coin | awk '{print $3 " " $2}' | sort -n
0.0% Empty
0.0% GetDenomByIndex
0.0% IsAllPositive
0.0% IsGTE
0.0% IsLT
0.0% IsZero
0.0% MulDec
0.0% MulDecTruncate
0.0% QuoDec
66.7% IsEqual
75.0% IsEqual
75.0% NewDecCoins
80.0% Validate
81.8% ParseDecCoin
100.0% Add
100.0% Add
100.0% AmountOf
100.0% Intersect
100.0% IsAnyNegative
100.0% IsNegative
100.0% IsPositive
100.0% IsValid
100.0% IsValid
100.0% IsZero
100.0% Len
100.0% Less
100.0% NewDecCoin
100.0% NewDecCoinFromCoin
100.0% NewDecCoinFromDec
100.0% NewDecCoinsFromCoins
100.0% NewInt64DecCoin
100.0% ParseDecCoins
100.0% QuoDecTruncate
100.0% SafeSub
100.0% Sort
100.0% String
100.0% String
100.0% Sub
100.0% Sub
100.0% Swap
100.0% TruncateDecimal
100.0% TruncateDecimal
100.0% Validate
100.0% negative
100.0% removeZeroDecCoins
100.0% safeAdd
100.0% sanitizeDecCoins

mergify bot pushed a commit that referenced this issue Jul 26, 2021
<!--
The default pull request template is for types feat, fix, or refactor.
For other templates, add one of the following parameters to the url:
- template=docs.md
- template=other.md
-->

## Description

Ref: #7031 

<!-- Add a description of the changes that this PR introduces and the files that
are the most critical to review. -->

Note/todo : 
1. Not sure if [this](https://github.com/cosmos/cosmos-sdk/blob/spoorthi/7031-deccoins-adding-tests/types/dec_coin.go#L631) line is reachable. The condition is already checked in [this ](https://github.com/cosmos/cosmos-sdk/blob/spoorthi/7031-deccoins-adding-tests/types/dec_coin.go#L618) line. Therefore, 100% coverage for `ParseDecCoin` function likely not possible
2. Clarification needed [here](https://github.com/cosmos/cosmos-sdk/blob/spoorthi/7031-deccoins-adding-tests/types/dec_coin_test.go#L883-L884)
3. Clarification needed [here](https://github.com/cosmos/cosmos-sdk/blob/spoorthi/7031-deccoins-adding-tests/types/dec_coin_test.go#L1124-L1125)

---

### Author Checklist

*All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.*

I have...

- [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting))
- [x] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
- [ ] included comments for [documenting Go code](https://blog.golang.org/godoc)
- [ ] updated the relevant documentation or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed

### Reviewers Checklist

*All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.*

I have...

- [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] confirmed `!` in the type prefix if API or client breaking change
- [ ] confirmed all author checklist items have been addressed 
- [ ] reviewed state machine logic
- [ ] reviewed API design and naming
- [ ] reviewed documentation is accurate
- [ ] reviewed tests and test coverage
- [ ] manually tested (if applicable)
@spoo-bar
Copy link
Contributor

Fixed with #9752

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants