chore: add tests + action

[freak12techno]

Summary by CodeRabbit

• New Features

  • Introduced automated testing for the project, including test coverage reporting.
  • Enhanced the build process with new testing and coverage targets in the Makefile.

• Chores

  • Updated .gitignore to exclude coverage reports (cover.out).
  • Configured the testpackage linter in .golangci.yml.

• Tests

  • Added tests for BalanceGenerator to ensure proper functionality based on state information.

[coderabbitai]

Walkthrough

The changes incorporate adding CI workflows for testing a Go project, enhancing the build process with new make targets for testing and coverage, updating linters, and adding test cases for BalanceGenerator. These enhancements streamline development and ensure higher code quality through automated testing and meticulous linting.

Changes

File	Change Summary
.github/workflows/actions.yaml	Added a new job named test for running Go project tests and uploading coverage reports to Codecov.
.gitignore	Added cover.out to ignore coverage reports generated by tests.
.golangci.yml	Added testpackage linter to the list of linters.
Makefile	Introduced test and coverage targets for enhanced build process.
pkg/.../balance_test.go	New file introducing test functions for BalanceGenerator, verifying its behavior with and without validator state information.

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant CI as CI System
    participant Code as Code Repository
    participant Go as Go Environment
    participant Codecov as Codecov

    Dev->>Code: Push Code Changes
    Code->>CI: Trigger Workflow
    CI->>Go: Setup Go Environment
    CI->>Code: Checkout Code
    CI->>Go: Run Tests with Coverage
    Go->>CI: Test Results and Coverage Data
    CI->>Codecov: Upload Coverage Report
    Codecov->>CI: Coverage Report Confirmation
    CI-->>Dev: Notify about Test and Coverage Results

Loading

Poem

In the land of code so bright,
A bunny doth take to flight,
Tests and coverage now in play,
Ensuring quality night and day.
With linting keen and targets set,
A better world for Go is met. 🐇✨

---

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

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.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

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.

[codecov]

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e5cd57b and 1cd43cc.

Files selected for processing (5)

• .github/workflows/actions.yaml (1 hunks)
• .gitignore (1 hunks)
• .golangci.yml (1 hunks)
• Makefile (1 hunks)
• pkg/generators/balance_test.go (1 hunks)

Files skipped from review due to trivial changes (3)

• .github/workflows/actions.yaml
• .gitignore
• .golangci.yml

Additional comments not posted (4)

Makefile (2)

13-14: The test target correctly sets up testing with coverage across all packages.

---

16-17: The coverage target is well-configured to generate HTML coverage reports, which will improve visibility and manageability of test coverage.

pkg/generators/balance_test.go (2)

13-20: The TestBalanceGeneratorNoState function is well-implemented, testing the generator's behavior with an empty state. Using t.Parallel() is a good practice to speed up the test suite.

---

22-40: The TestBlockSetValidators function correctly tests the BalanceGenerator with a state containing data. Consistent use of t.Parallel() across tests is commendable for parallel test execution.