Skip to content

chore: loading resources to run locally #74

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

Merged
merged 6 commits into from
Nov 21, 2024
Merged

Conversation

tchow-zlai
Copy link
Collaborator

@tchow-zlai tchow-zlai commented Nov 21, 2024

Summary

  • Load local resources irrespective of where the tests are currently being run from. This allows us to run them from Intellij.

Checklist

  • Added Unit Tests
  • Covered by existing CI
  • Integration tested
  • Documentation update

Summary by CodeRabbit

  • Bug Fixes

    • Improved test robustness by replacing hardcoded file paths with dynamic resource URI retrieval for loading test data.
  • Tests

    • Enhanced flexibility in test cases for locating resources, ensuring consistent access regardless of the working directory.

Copy link

coderabbitai bot commented Nov 21, 2024

Walkthrough

The changes in this pull request focus on the LocalDataLoaderTest class, specifically modifying how file paths are managed for loading test data. Hardcoded file paths for CSV files have been replaced with dynamic resource URI retrieval methods. This adjustment enhances the robustness of the tests by allowing them to access resources without being dependent on the working directory.

Changes

File Path Change Summary
spark/src/test/scala/ai/chronon/spark/test/LocalDataLoaderTest.scala Updated file paths in loadDataFileAsTableShouldBeCorrect and loadDataRecursivelyShouldBeCorrect methods to use dynamic resource URI retrieval instead of hardcoded paths.

Poem

In the land of tests, where data flows,
A rabbit hops where the resource glows.
Paths once fixed, now dance with glee,
Dynamic routes set the data free!
Hooray for changes, let’s all cheer,
For testing’s bright future, oh so near! 🐇✨


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

CodeRabbit Configuration 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.

Copy link

@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: 1

🧹 Outside diff range and nitpick comments (1)
spark/src/test/scala/ai/chronon/spark/test/LocalDataLoaderTest.scala (1)

Line range hint 1-76: Consider adding test cases for error scenarios

The test coverage could be improved by adding test cases for:

  1. Missing resources
  2. Invalid file formats
  3. Empty directories
  4. Files with incorrect schemas

Would you like me to provide example test implementations for these scenarios?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6cb6273 and f0215a2.

📒 Files selected for processing (1)
  • spark/src/test/scala/ai/chronon/spark/test/LocalDataLoaderTest.scala (2 hunks)
🔇 Additional comments (1)
spark/src/test/scala/ai/chronon/spark/test/LocalDataLoaderTest.scala (1)

66-67: ⚠️ Potential issue

Verify directory structure and handle resource access

The directory resource loading has similar issues as the file loading, with additional directory-specific concerns.

Let's verify the test resources structure:

Consider adding these improvements:

-    val resourceURI = getClass.getResource("/local_data_csv")
-    val path = new File(resourceURI.getFile)
+    val resourceURL = Option(getClass.getResource("/local_data_csv"))
+      .getOrElse(throw new IllegalStateException("Required test directory not found"))
+    val path = new File(resourceURL.getFile)
+    require(path.exists() && path.isDirectory, "Test resource must be an accessible directory")

For better test isolation and JAR compatibility:

  1. Consider creating a temporary directory with test files for each test run
  2. Add explicit verification of the expected directory structure
  3. Document the required test resource structure in the test class

tchow-zlai and others added 2 commits November 20, 2024 20:41
….scala

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@tchow-zlai tchow-zlai changed the title fix loading resources to run locally chore: loading resources to run locally Nov 21, 2024
@tchow-zlai
Copy link
Collaborator Author

PTAL @piyush-zlai - lmk if you have feedback. A small one.

@tchow-zlai tchow-zlai merged commit fc7f408 into main Nov 21, 2024
8 checks passed
@tchow-zlai tchow-zlai deleted the tchow/fix-local-fs branch November 21, 2024 20:49
kumar-zlai pushed a commit that referenced this pull request Apr 25, 2025
## Summary

- Load local resources irrespective of where the tests are currently
being run from. This allows us to run them from Intellij.
- 
## Checklist
- [x] Added Unit Tests
- [x] Covered by existing CI
- [x] Integration tested
- [x] Documentation update



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Bug Fixes**
- Improved test robustness by replacing hardcoded file paths with
dynamic resource URI retrieval for loading test data.
  
- **Tests**
- Enhanced flexibility in test cases for locating resources, ensuring
consistent access regardless of the working directory.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
kumar-zlai pushed a commit that referenced this pull request Apr 29, 2025
## Summary

- Load local resources irrespective of where the tests are currently
being run from. This allows us to run them from Intellij.
- 
## Checklist
- [x] Added Unit Tests
- [x] Covered by existing CI
- [x] Integration tested
- [x] Documentation update



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Bug Fixes**
- Improved test robustness by replacing hardcoded file paths with
dynamic resource URI retrieval for loading test data.
  
- **Tests**
- Enhanced flexibility in test cases for locating resources, ensuring
consistent access regardless of the working directory.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
chewy-zlai pushed a commit that referenced this pull request May 15, 2025
## Summary

- Load local resources irrespective of where the tests are currently
being run from. This allows us to run them from Intellij.
- 
## Checklist
- [x] Added Unit Tests
- [x] Covered by existing CI
- [x] Integration tested
- [x] Documentation update



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Bug Fixes**
- Improved test robustness by replacing hardcoded file paths with
dynamic resource URI retrieval for loading test data.
  
- **Tests**
- Enhanced flexibility in test cases for locating resources, ensuring
consistent access regardless of the working directory.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
chewy-zlai pushed a commit that referenced this pull request May 16, 2025
## Summary

- Load local resources irrespective of where the tests are currently
being run from. This allows us to run them from Intellij.
- 
## Cheour clientslist
- [x] Added Unit Tests
- [x] Covered by existing CI
- [x] Integration tested
- [x] Documentation update



<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Bug Fixes**
- Improved test robustness by replacing hardcoded file paths with
dynamic resource URI retrieval for loading test data.
  
- **Tests**
- Enhanced flexibility in test cases for locating resources, ensuring
consistent access regardless of the working directory.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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