refactor(systemtests): Extract system test framework (backport #22578)

[mergify]

Description

Extract framework code.
Minor refactorings

---

Closes: #22562

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, you can find examples of the prefixes below:

• confirmed ! in 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

• reviewed "Files changed" and left comments if necessary

• included the necessary unit and integration tests

• added a changelog entry to CHANGELOG.md

• updated the relevant documentation or specification, including comments for documenting Go code

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

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• New Features

  • Introduced a comprehensive README.md for the systemtests package, detailing the testing framework and execution instructions.
  • Added a getting_started.md guide for writing and executing system tests.
  • Implemented a new systest package to streamline system test utilities and enhance modularity.
  • Added a CHANGELOG.md section outlining guiding principles and usage instructions for maintaining the changelog.
  • Updated the go.work.example file to include the systemtests module.

• Bug Fixes

  • Updated error handling and transaction success checks to use the new systest methods for consistency.

• Documentation

  • Restructured and clarified the tests/systemtests/README.md for improved usability.
  • Enhanced documentation in systemtests files to reflect changes and provide clearer instructions.

• Refactor

  • Transitioned from direct references to a sut object to utilizing a systest package across multiple test files for better organization and maintainability.

---

This is an automatic backport of pull request #22578 done by [Mergify](https://mergify.com).

[mergify]

Cherry-pick of 14d98d2 has failed:

On branch mergify/bp/release/v0.52.x/pr-22578
Your branch is up to date with 'origin/release/v0.52.x'.

You are currently cherry-picking commit 14d98d277.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	new file:   systemtests/CHANGELOG.md
	new file:   systemtests/README.md
	renamed:    tests/systemtests/cli.go -> systemtests/cli.go
	renamed:    tests/systemtests/genesis_io.go -> systemtests/genesis_io.go
	new file:   systemtests/getting_started.md
	new file:   systemtests/go.mod
	new file:   systemtests/go.sum
	renamed:    tests/systemtests/io_utils.go -> systemtests/io_utils.go
	renamed:    tests/systemtests/node_utils.go -> systemtests/node_utils.go
	renamed:    tests/systemtests/rest_cli.go -> systemtests/rest_support.go
	renamed:    tests/systemtests/rpc_client.go -> systemtests/rpc_client.go
	renamed:    tests/systemtests/system.go -> systemtests/system.go
	renamed:    tests/systemtests/test_runner.go -> systemtests/test_runner.go
	renamed:    tests/systemtests/testnet_init.go -> systemtests/testnet_init.go
	modified:   tests/systemtests/.gitignore
	modified:   tests/systemtests/README.md
	modified:   tests/systemtests/account_test.go
	modified:   tests/systemtests/auth_test.go
	modified:   tests/systemtests/authz_test.go
	modified:   tests/systemtests/bank_test.go
	modified:   tests/systemtests/circuit_test.go
	modified:   tests/systemtests/distribution_test.go
	modified:   tests/systemtests/export_test.go
	modified:   tests/systemtests/fraud_test.go
	modified:   tests/systemtests/go.sum
	modified:   tests/systemtests/gov_test.go
	modified:   tests/systemtests/group_test.go
	modified:   tests/systemtests/main_test.go
	modified:   tests/systemtests/mint_test.go
	modified:   tests/systemtests/snapshots_test.go
	modified:   tests/systemtests/staking_test.go
	modified:   tests/systemtests/unordered_tx_test.go

Unmerged paths:
  (use "git add/rm <file>..." as appropriate to mark resolution)
	both modified:   go.work.example
	deleted by us:   tests/systemtests/bankv2_test.go
	both modified:   tests/systemtests/cometbft_client_test.go
	both modified:   tests/systemtests/go.mod
	both modified:   tests/systemtests/tx_test.go
	both modified:   tests/systemtests/upgrade_test.go

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[julienrbrt]

needs to delete systemtests and use that in tests/systemtests