Fix epochs modules tests #1893

ValarDragon · 2022-06-28T21:39:45Z

Part of: #1834

What is the purpose of the change

Update the epochs modules tests to be readable, make sense & cover more relevant cases.

As part of this, we remove the prior SetEpochInfo API, and solely use a safer AddEpochInfo api, that includes relevant entries if they're left blank, and errors if its an invalid configuration

Brief Changelog

Remove epochskeeper.SetEpochInfo API, in favor of epochskeeper.AddEpochInfo

Testing and Verifying

This change added tests and can be verified as follows:

Added unit test that validates expected epoch behavior on begin block
- Open to any other test cases we can think of for edge cases / etc.

Documentation and Release Note

Does this pull request introduce a new feature or user-facing behavior changes? yes
Is a relevant changelog entry added to the Unreleased section in CHANGELOG.md? yes
How is the feature or change documented? not applicable

ValarDragon · 2022-06-28T21:41:08Z

x/epochs/keeper/abci_test.go

-// This test ensures legacy EpochInfo messages will not throw errors via InitGenesis and BeginBlocker
-func TestLegacyEpochSerialization(t *testing.T) {


This is deadcode / for an obsoleted concern. (it was for the v4 upgrade, when we added some more fields to this struct, and deleted a dead one)

ValarDragon · 2022-06-28T21:44:45Z

x/epochs/keeper/abci_test.go

+			heights := maps.Keys(test.blockHeightTimePairs)
+			osmoutils.SortSlice(heights)
+			for _, h := range heights {


This go 1.18 deterministic iteration over maps API 😍

alexanderbez

🧀

CHANGELOG.md

osmoutils/slice_helper.go

x/epochs/keeper/abci_test.go

alexanderbez · 2022-06-28T22:34:12Z

x/epochs/keeper/abci_test.go

+			heights := maps.Keys(test.blockHeightTimePairs)
+			osmoutils.SortSlice(heights)
+			for _, h := range heights {


Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

p0mvn

I feel like reviewing this has really improved my understanding of epochs implementation details. Great work on the refactor and tests!

go.mod

x/epochs/keeper/genesis.go

p0mvn · 2022-06-29T00:46:41Z

x/epochs/keeper/epoch_test.go

+	expectedEpochInfo := epochInfo
+	expectedEpochInfo.StartTime = suite.Ctx.BlockTime()
+	expectedEpochInfo.CurrentEpochStartHeight = suite.Ctx.BlockHeight()
+	suite.Require().Equal(expectedEpochInfo, epochInfoSaved)

 	allEpochs := suite.App.EpochsKeeper.AllEpochInfos(suite.Ctx)


Does it make sense splitting up the AllEpochInfos test into its own test fixture? It seems that we are testing 2 separate methods in one fixture

Not really sure theres much to add as a general test here that'd be of value, versus us making this test have documentation for what exactly its doing. I guess we could provide a list of []types.EpochInfo and then call AllEpochInfos on it

x/epochs/keeper/epoch.go

x/epochs/keeper/abci_test.go

Co-authored-by: Roman <roman@osmosis.team>

ValarDragon · 2022-06-29T02:49:34Z

All comments resolved I believe!
Thanks for the detailed review =)

p0mvn

🚀

p0mvn · 2022-06-29T03:05:18Z

x/epochs/keeper/abci_test.go

+	block1Time := time.Unix(1656907200, 0).UTC()
+	const defaultIdentifier = "hourly"
+	const defaultDuration = time.Hour
+	const eps = time.Nanosecond


Consider adding a comment with the explanation from our earlier discussion please:
#1893 (comment)

x/epochs/keeper/abci_test.go

* Fix epochs modules tests * Remove debug code * Fix altered API usage within superfluid * Add changelog entry * Add more AddEpochInfo checks * Fix superfluid tests * Update osmoutils/slice_helper.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Changelog nit * Apply Roman's suggestions! Co-authored-by: Roman <roman@osmosis.team> * add const * Apply roman's suggestion of tests w/ non-default values * Apply roman's comment update suggestions * AddEpochInfo comment * fix gomod order Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: Roman <roman@osmosis.team> (cherry picked from commit 21f7f98) # Conflicts: # CHANGELOG.md # go.mod # x/epochs/abci_test.go # x/epochs/keeper/epoch.go # x/epochs/keeper/genesis.go # x/superfluid/keeper/keeper.go # x/superfluid/keeper/twap_price_test.go

* Fix epochs modules tests (#1893) * Fix epochs modules tests * Remove debug code * Fix altered API usage within superfluid * Add changelog entry * Add more AddEpochInfo checks * Fix superfluid tests * Update osmoutils/slice_helper.go Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com> * Changelog nit * Apply Roman's suggestions! Co-authored-by: Roman <roman@osmosis.team> * add const * Apply roman's suggestion of tests w/ non-default values * Apply roman's comment update suggestions * AddEpochInfo comment * fix gomod order

Fix epochs modules tests

23d9904

ValarDragon requested a review from a team June 28, 2022 21:39

Remove debug code

8915190

github-actions bot added the C:x/epochs label Jun 28, 2022

ValarDragon commented Jun 28, 2022

View reviewed changes

Fix altered API usage within superfluid

1de1759

github-actions bot added the C:x/superfluid label Jun 28, 2022

Add changelog entry

f4ef09a

github-actions bot added the C:docs Improvements or additions to documentation label Jun 28, 2022

ValarDragon commented Jun 28, 2022

View reviewed changes

ValarDragon added 2 commits June 28, 2022 16:49

Add more AddEpochInfo checks

d6f4c29

Fix superfluid tests

c520bae

ValarDragon requested a review from p0mvn June 28, 2022 22:28

alexanderbez approved these changes Jun 28, 2022

View reviewed changes

ValarDragon and others added 2 commits June 28, 2022 17:55

Update osmoutils/slice_helper.go

d7c3f6b

Co-authored-by: Aleksandr Bezobchuk <alexanderbez@users.noreply.github.com>

Changelog nit

4020b2b

p0mvn reviewed Jun 29, 2022

View reviewed changes

ValarDragon and others added 6 commits June 28, 2022 21:27

Apply Roman's suggestions!

b0e4c16

Co-authored-by: Roman <roman@osmosis.team>

add const

d576203

Apply roman's suggestion of tests w/ non-default values

5941e9d

Apply roman's comment update suggestions

23c067f

AddEpochInfo comment

fd72bbe

fix gomod order

844758e

p0mvn approved these changes Jun 29, 2022

View reviewed changes

Add eps comment

e90e497

ValarDragon merged commit 21f7f98 into main Jun 29, 2022

ValarDragon deleted the dev/epochs_test branch June 29, 2022 13:08

ValarDragon mentioned this pull request Jun 29, 2022

Write test for AddEpochInfo #1895

Merged

osmo-bot added the A:backport/v11.x backport patches to v11.x branch label Aug 4, 2022

mergify bot mentioned this pull request Aug 4, 2022

Fix epochs modules tests (backport #1893) #2309

Merged

github-actions bot mentioned this pull request May 15, 2024

Broken Links Detected #8269

Closed

github-actions bot mentioned this pull request Oct 15, 2024

Broken Links Detected notional-labs/osmosis#75

Closed

github-actions bot mentioned this pull request Nov 1, 2024

Broken Links Detected notional-labs/osmosis#76

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix epochs modules tests #1893

Fix epochs modules tests #1893

ValarDragon commented Jun 28, 2022 •

edited

Loading

ValarDragon Jun 28, 2022

ValarDragon Jun 28, 2022

alexanderbez Jun 28, 2022

alexanderbez left a comment

alexanderbez Jun 28, 2022

p0mvn left a comment

p0mvn Jun 29, 2022

ValarDragon Jun 29, 2022

ValarDragon commented Jun 29, 2022 •

edited

Loading

p0mvn left a comment

p0mvn Jun 29, 2022

		// This test ensures legacy EpochInfo messages will not throw errors via InitGenesis and BeginBlocker
		func TestLegacyEpochSerialization(t *testing.T) {

Fix epochs modules tests #1893

Fix epochs modules tests #1893

Conversation

ValarDragon commented Jun 28, 2022 • edited Loading

What is the purpose of the change

Brief Changelog

Testing and Verifying

Documentation and Release Note

ValarDragon Jun 28, 2022

Choose a reason for hiding this comment

ValarDragon Jun 28, 2022

Choose a reason for hiding this comment

alexanderbez Jun 28, 2022

Choose a reason for hiding this comment

alexanderbez left a comment

Choose a reason for hiding this comment

alexanderbez Jun 28, 2022

Choose a reason for hiding this comment

p0mvn left a comment

Choose a reason for hiding this comment

p0mvn Jun 29, 2022

Choose a reason for hiding this comment

ValarDragon Jun 29, 2022

Choose a reason for hiding this comment

ValarDragon commented Jun 29, 2022 • edited Loading

p0mvn left a comment

Choose a reason for hiding this comment

p0mvn Jun 29, 2022

Choose a reason for hiding this comment

ValarDragon commented Jun 28, 2022 •

edited

Loading

ValarDragon commented Jun 29, 2022 •

edited

Loading