e2e: add workflow for e2e module.

[DimitrisJim]

Description

this has bugged me for some time, running make lint locally always found something in the e2e module to complain about. This workflow adds the linting step for the e2e module and it runs a few of the tests it defines.

closes: #3695

---

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

• Targeted PR against the correct branch (see CONTRIBUTING.md).
• Linked to GitHub issue with discussion and accepted design, OR link to spec that describes this work.
• Code follows the module structure standards and Go style guide.
• Wrote unit and integration tests.
• Updated relevant documentation (docs/).
• Added relevant godoc comments.
• Provide a conventional commit message to follow the repository standards.
• Include a descriptive changelog entry when appropriate. This may be left to the discretion of the PR reviewers. (e.g. chores should be omitted from changelog)
• Re-reviewed Files changed in the GitHub PR explorer.
• Review SonarCloud Report in the comment section below once CI passes.

Summary by CodeRabbit

• New Features
  • Introduced a GitHub Actions workflow "E2E Module" for automated testing and linting on PRs targeting the e2e module.
• Refactor
  • Simplified type conversion and comparison logic in GenesisTestSuite within the e2e tests.

[coderabbitai]

Walkthrough

The update introduces a new GitHub Actions workflow named "E2E Unit tests/Lint" tailored for the e2e module codebase, triggered by PRs. It focuses on linting and running Go tests on the e2e module's code. Additionally, refinements were made in the genesis_test.go file within the E2E tests, enhancing code quality and readability.

Changes

File Path	Change Summary
.github/workflows/e2emodule.yml	Added a new GitHub Actions workflow for linting and running Go tests on the e2e module codebase.
e2e/tests/upgrades/.../genesis_test.go	Modified HaltChainAndExportGenesis function call and simplified height comparison in GenesisTestSuite.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

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>.
  • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 5514d56 and 8d6630a.

Files selected for processing (2)

• .github/workflows/e2emodule.yml (1 hunks)
• e2e/tests/upgrades/genesis_test.go (2 hunks)

Additional comments: 3

.github/workflows/e2emodule.yml (1)

• 1-33: The GitHub Actions workflow is well-defined and adheres to best practices. It correctly targets the e2e module for both linting and testing, ensuring code quality and functionality. The use of Ubuntu latest, Go 1.21, and specific versions of actions/setup-go, actions/checkout, and golangci-lint-action are appropriate. The workflow is triggered by pull requests affecting the e2e module or the workflow file itself, which is a sensible choice to ensure that changes are validated.

e2e/tests/upgrades/genesis_test.go (2)

• 128-128: The modification in the TestIBCGenesis test case, specifically the simplification of the HaltChainAndExportGenesis function call, improves code clarity and maintainability. Removing explicit type conversions where unnecessary is a good practice that enhances readability.
• 245-245: The HaltChainAndExportGenesis function correctly implements the logic for halting the chain, exporting the genesis state, and ensuring the chain height increments after the halt. The function adheres to best practices, including the use of context with timeout and comprehensive error handling. This contributes to the robustness and maintainability of the test suite.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 8d6630a and 08c6bb8.

Files selected for processing (1)

• .github/workflows/e2emodule.yml (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• .github/workflows/e2emodule.yml

[crodriguezvega]

🙏

[chatton]

LGTM! Thanks for adding this, has bugged me a few times in the past also!

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 572d8e8 and eefd5dd.

Files selected for processing (2)

• .github/workflows/e2emodule.yml (1 hunks)
• e2e/tests/upgrades/genesis_test.go (2 hunks)

Files skipped from review as they are similar to previous changes (2)

• .github/workflows/e2emodule.yml
• e2e/tests/upgrades/genesis_test.go

[sonarcloud]

Quality Gate passed for 'ibc-go'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

[chatton]

I believe this closes #3695 as well.

[damiannolan]

Thank you @DimitrisJim!