search

QuokkaStake / cosmos-validators-exporter

A Prometheus exporter to fetch data about your validators in Cosmos-based blockchains.
GNU General Public License v3.0
12 stars 14 forks source link

feat: add app test #71

Closed freak12techno closed 4 months ago

freak12techno commented 4 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent updates introduce a new HTTP server along with /metrics and /healthcheck routes, enhance configuration handling with new assets and tests, and simplify tracer management by refining error handling. Additionally, logging severity is updated to Panic, and a Codecov badge is added to the README.md for improved documentation and coverage tracking.

Changes

File(s) Summary
pkg/app.go Added Server field to App struct, custom routes and Healthcheck method, and start/stop functionality for the server.
pkg/app_test.go Introduced tests for application configuration, start/stop, and HTTP mocking for API endpoints.
pkg/config/config_test.go Updated test configuration filename to config-valid.toml.
pkg/tracing/tracer.go, pkg/tracing/tracer_test.go Simplified error handling and adjusted return types in tracing functions.
.gitignore Added an exception to include files matching assets/config*.toml.
assets/config-invalid-listen-address.toml, assets/config-valid.toml, assets/config-with-warnings.toml, and assets/config-invalid.toml Introduced and updated configuration settings for various blockchain chains.
cmd/cosmos-validators-exporter.go Updated logging severity from Fatal to Panic for certain error conditions.
cmd/cosmos-validators-exporter_test.go Added tests for different configuration scenarios in the main() function.
README.md Added a Codecov badge.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant App
    participant HTTPServer

    Client->>App: Start()
    App->>HTTPServer: Initialize with /metrics and /healthcheck routes
    activate HTTPServer
    Note over HTTPServer: HTTP Server runs and listens for requests

    Client->>HTTPServer: /healthcheck
    HTTPServer->>App: Healthcheck()
    App-->>HTTPServer: HTTP 200 OK

    Client->>App: Stop()
    App->>HTTPServer: Graceful shutdown
    deactivate HTTPServer
    Note over App: Server stopped

Poem

In the land of code where circuits hum, A server wakes, the network's drum, Healthchecks hum and metrics sing, Configs gathered, tests take wing. Tracers dance in outputs clear, Logging echoes far and near, With Codecov badge, we cheer this feat, Our software strong and sweet! 🌿🐇

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
freak12techno commented 4 months ago

@coderabbitai I remember you had some learnings about pkg/app.go being untested, now it's not the case and it's not acceptable if it's not tested.

coderabbitai[bot] commented 4 months ago

[!TIP] For best results, initiate chat on the files or code changes.

@freak12techno, thank you for updating the testing expectations for pkg/app.go. I will remove the outdated learnings that previously noted the acceptance of pkg/app.go being untested. Moving forward, I'll ensure to consider the necessity of having tests for this file in future reviews.

Learnings removed ``` User: freak12techno PR: QuokkaStake/cosmos-validators-exporter#70 File: pkg/app.go:195-195 Timestamp: 2024-06-27T23:06:14.636Z Learning: The `pkg/app.go` file isn't tested yet, and this has been acknowledged as acceptable for the current stage of development. ``` --- ``` User: freak12techno PR: QuokkaStake/cosmos-validators-exporter#64 File: pkg/app.go:105-112 Timestamp: 2024-06-25T19:32:53.262Z Learning: User freak12techno has clarified that while specific tests for new generator functions in `app.go` exist, there is an overall lack of tests for `app.go` itself, which is currently expected and accepted. ```
Learnings used ``` User: freak12techno PR: QuokkaStake/cosmos-validators-exporter#70 File: pkg/app.go:195-195 Timestamp: 2024-06-27T23:06:14.636Z Learning: The `pkg/app.go` file isn't tested yet, and this has been acknowledged as acceptable for the current stage of development. ``` --- ``` User: freak12techno PR: QuokkaStake/cosmos-validators-exporter#64 File: pkg/app.go:105-112 Timestamp: 2024-06-25T19:32:53.262Z Learning: User freak12techno has clarified that while specific tests for new generator functions in `app.go` exist, there is an overall lack of tests for `app.go` itself, which is currently expected and accepted. ```
codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (87241cf) to head (e4f66b6).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #71 +/- ## =========================================== + Coverage 93.51% 100.00% +6.48% =========================================== Files 63 63 Lines 2560 2567 +7 =========================================== + Hits 2394 2567 +173 + Misses 165 0 -165 + Partials 1 0 -1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.