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

Add unit test job #110

Merged
merged 1 commit into from
Apr 7, 2024
Merged

Add unit test job #110

merged 1 commit into from
Apr 7, 2024

Conversation

isZumpo
Copy link
Contributor

@isZumpo isZumpo commented Apr 6, 2024

Adds a basic unit test workflow job that will run on every pull request. It makes use of gotestfmt to format the console output in a nice way.

Copy link
Contributor

coderabbitai bot commented Apr 6, 2024

Walkthrough

The recent updates introduce a GitHub Actions workflow to automate Go unit tests, enhancing code quality and reliability. Additionally, modifications in the observation.go file standardize time representation by converting timestamps before formatting, ensuring consistency across outputs.

Changes

File Summary
.github/workflows/golangci-test.yml Added a workflow for Go unit tests, triggered on main branch pushes.
internal/observation/observation.go Standardized time representation by converting to Unix timestamps in WriteNotesTable and WriteNotesCsv.

🐇✨
In a burrow deep and wide,
A rabbit worked with utmost pride.
"Let's automate," it said with glee,
And timestamps, consistent they shall be!
🌟📅
With each push, tests run so bright,
Ensuring the code's just right.
🐾🎉

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

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.

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.
  • 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/coderabbit-overrides.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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between b34c445 and 866a37e.
Files selected for processing (2)
  • .github/workflows/golangci-test.yml (1 hunks)
  • internal/observation/observation.go (2 hunks)
Additional comments not posted (7)
.github/workflows/golangci-test.yml (5)

19-19: Ensure that the make check-tensorflow command is documented within the project, including its purpose and any prerequisites. This is important for maintainability and for new contributors to understand the project setup.


22-25: Setting environment variables for CGO is crucial for projects that depend on C libraries. Verify that the path $HOME/src/tensorflow is correctly set up in the project's documentation and that it aligns with the TensorFlow installation instructions.


27-27: Using gotestfmt for formatting test output is a good practice for readability. Ensure that the version pinned (@latest) aligns with the project's dependency management strategy to avoid potential incompatibilities with future updates.


32-32: The use of set -euo pipefail is a good practice for shell scripts to ensure that errors are handled properly. However, ensure that the test command go test -json -v ./... and its piping to gotestfmt are thoroughly tested to handle all possible outcomes, including test failures, without unintended side effects.


40-40: Using if-no-files-found: error is a good practice to ensure that the absence of test logs is treated as an error condition. This helps in identifying issues where tests may not have run as expected.

internal/observation/observation.go (2)

101-101: The formatting of the output line in WriteNotesTable is clear and follows the expected structure. Ensure that the choice of fixed precision for beginTime and endTime (%.1f) aligns with the application's requirements for time accuracy.


164-164: In WriteNotesCsv, the formatting of the CSV line is consistent and adheres to CSV standards. Similar to WriteNotesTable, verify that the precision used for beginTime and endTime is appropriate for the application's needs.

.github/workflows/golangci-test.yml Show resolved Hide resolved
internal/observation/observation.go Outdated Show resolved Hide resolved
Makes use of https://github.com/GoTestTools/gotestfmt to generate
readable unit test reports.
@isZumpo isZumpo force-pushed the unit_test_workflow branch from 866a37e to caee7f1 Compare April 6, 2024 19:24
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 98ec6f4 and caee7f1.
Files selected for processing (1)
  • .github/workflows/golangci-test.yml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/golangci-test.yml

@tphakala tphakala merged commit 6ec875e into tphakala:main Apr 7, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants