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

feat: Add legacy simapp testing via build tags #12121

Merged
merged 21 commits into from
Jul 1, 2022
Merged

Conversation

facundomedica
Copy link
Member

Description

This is a PoC just to know what the team thinks of it.

Pros:

  • No need to re-write tests
  • We make sure that we are running all the same tests on both files

Cons:

  • We need to run tests twice (although we would be running them twice if we copy&paste all of them)

Closes: #12068


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...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • 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 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)

@facundomedica
Copy link
Member Author

@aaronc @kocubinski @alexanderbez would like your input on this 🙏
There's no difference between the 2 files at the moment, just putting this out to see if the team likes it before moving forward.

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is fine for now, we can run these tests hourly or something just not in every pr to avoid clogging the system

@facundomedica
Copy link
Member Author

I think this is fine for now, we can run these tests hourly or something just not in every pr to avoid clogging the system

Gotcha, ok, will work on this and then will ask for help to add it to the CI :)

@tac0turtle
Copy link
Member

lmk I can knock out the ci things quickly

@facundomedica facundomedica marked this pull request as ready for review June 10, 2022 13:20
@facundomedica facundomedica requested a review from a team as a code owner June 10, 2022 13:20
@facundomedica
Copy link
Member Author

This is ready for review. We have to decide when to run the legacy simapp tests. To do so we just add the build tag legacy_simapp.
I took app.go from the latest commit before starting the app wiring PRs and did some small adjustments to accommodate to changing APIs (https://github.com/cosmos/cosmos-sdk/blob/27869a5af3f02aab0a8cc94ba3e36443b67e3824/simapp/app.go)

simapp/app_legacy.go Fixed Show fixed Hide fixed
Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I honestly would prefer to have this under app/legacy if possible? Otherwise, build tags is OK

@facundomedica
Copy link
Member Author

I honestly would prefer to have this under app/legacy if possible? Otherwise, build tags is OK

Wouldn't that mean that we need to re-write all tests? I'm open to other options but what I really like of this approach is that we would be running the exact same tests for both app wiring and legacy app.go.

@aaronc
Copy link
Member

aaronc commented Jun 10, 2022

We should use the version of app.go before app wiring started. If it's under legacy and not a build tag tests can't actually be run. Eventually we probably don't want to maintain the legacy form but it's useful for maybe one release?

@facundomedica
Copy link
Member Author

We should use the version of app.go before app wiring started. If it's under legacy and not a build tag tests can't actually be run. Eventually we probably don't want to maintain the legacy form but it's useful for maybe one release?

I went back in history and picked up the last commit before your first PR got merged, that's what you mean?
Some changes had to be done because we did modify modules. There's a small mention of depinject in app_legacy.go but it's just so we don't have to use the build tag anywhere else (There's a test helper function using AppConfig so I defined a dummy one).

@alexanderbez
Copy link
Contributor

I mean keep the build tag but just move it under a legacy package.

@facundomedica
Copy link
Member Author

@marbar3778 should we merge and you do the CI in a separate PR or want to work on it on this same branch?

@aaronc
Copy link
Member

aaronc commented Jun 14, 2022

I mean keep the build tag but just move it under a legacy package.

It wouldn't be possible to run the same tests then afaik

@facundomedica facundomedica requested a review from tac0turtle June 16, 2022 13:35
@tac0turtle
Copy link
Member

ill knock it out in this pr quickly

name: Legacy App Testing
on:
schedule:
- cron: "0 0,12 * * *"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

set it to run twice a day, is that okay?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@facundomedica facundomedica requested a review from aaronc June 28, 2022 13:39
@facundomedica facundomedica changed the base branch from main to epic/app-wiring June 29, 2022 13:40
@julienrbrt julienrbrt changed the base branch from epic/app-wiring to main June 29, 2022 15:42
@julienrbrt julienrbrt added the A:automerge Automatically merge PR once all prerequisites pass. label Jun 30, 2022
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need some changes, as we have changed NewSimApp arguments.

simapp/app_legacy.go Show resolved Hide resolved
@facundomedica facundomedica removed the A:automerge Automatically merge PR once all prerequisites pass. label Jul 1, 2022
@facundomedica facundomedica added the A:automerge Automatically merge PR once all prerequisites pass. label Jul 1, 2022
@mergify mergify bot merged commit 0cc82cf into main Jul 1, 2022
@mergify mergify bot deleted the facu/simapp-legacy-test branch July 1, 2022 13:48
larry0x pushed a commit to larry0x/cosmos-sdk that referenced this pull request May 22, 2023
## Description

This is a PoC just to know what the team thinks of it.

Pros:

- No need to re-write tests
- We make sure that we are running all the same tests on both files

Cons:

- We need to run tests twice (although we would be running them twice if we copy&paste all of them)

Closes: cosmos#12068



---

### 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...

- [ ] 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
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting))
- [ ] provided a link to the relevant issue or specification
- [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules)
- [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass. Type: CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create legacy simapp to test along new app wiring simapp
5 participants