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

Unit test event service #2673

Conversation

MohitMaulekhi
Copy link
Contributor

@MohitMaulekhi MohitMaulekhi commented Dec 23, 2024

What kind of change does this PR introduce?

Unit test for Event service

Issue Number:

Fixes #2616

Did you add tests for your changes?

Yes

Snapshots/Videos:

image

Summary

This PR aims to increase the code coverage of the specified file by adding comprehensive unit tests. It ensures that all methods, functions, and widgets are thoroughly tested, improving the overall reliability and maintainability of the codebase. The Pr will resolve issue #2616.

Does this PR introduce a breaking change?

No

Have you read the contributing guide?

Yes

Summary by CodeRabbit

  • New Features

    • Introduced a new getter for accessing current organization information in the Event Service.
  • Bug Fixes

    • Enhanced error handling and functionality verification through additional tests for various methods in the Event Service.
  • Tests

    • Expanded test suite to cover success and failure scenarios for fetching volunteer groups and organization updates, as well as data retrieval handling.

Copy link
Contributor

coderabbitai bot commented Dec 23, 2024

Walkthrough

The pull request introduces a new getter method currentOrg in the EventService class, which provides access to the current organization information. This addition enhances the service's functionality by allowing external components to retrieve organization details. The changes are accompanied by updates to the test suite, including new tests for error handling, data retrieval, and organization stream subscription management.

Changes

File Change Summary
lib/services/event_service.dart Added OrgInfo get currentOrg getter method
test/service_tests/event_service_test.dart - Added tests for fetchVolunteerGroupsByEvent method (success and failure scenarios)
- Added tests for setOrgStreamSubscription method
- Enhanced fetchDataFromApi method testing
- Updated import statements

Sequence Diagram

sequenceDiagram
    participant Client
    participant EventService
    participant OrgStream
    
    Client->>EventService: Request current organization
    EventService->>OrgStream: Get current org info
    OrgStream-->>EventService: Return OrgInfo
    EventService-->>Client: Provide current organization details
Loading

Possibly related PRs

Suggested reviewers

  • palisadoes
  • noman2002

Poem

🐰 A rabbit's tale of code so bright,
Where currentOrg shines with delight!
Services dancing, tests in glee,
Revealing org's sweet mystery
With every line, our code takes flight! 🚀


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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

Other

🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.

Copy link

codecov bot commented Dec 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.08%. Comparing base (3fe1d19) to head (d473c39).
Report is 6 commits behind head on develop-postgres.

Additional details and impacted files
@@                 Coverage Diff                  @@
##           develop-postgres    #2673      +/-   ##
====================================================
+ Coverage             95.98%   96.08%   +0.10%     
====================================================
  Files                   187      187              
  Lines                  9887     9892       +5     
====================================================
+ Hits                   9490     9505      +15     
+ Misses                  397      387      -10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Cioppolo14 Cioppolo14 requested review from Cioppolo14 and removed request for palisadoes and noman2002 December 23, 2024 15:02
Copy link
Contributor

@Cioppolo14 Cioppolo14 left a comment

Choose a reason for hiding this comment

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

@coderabbitai review

@Cioppolo14
Copy link
Contributor

@MohitMaulekhi Please make sure coderabbit reviews your PR and any comments it has are addressed. Please do not assign reviewers.

@palisadoes palisadoes requested a review from noman2002 December 23, 2024 17:19
@palisadoes
Copy link
Contributor

Please make coderabbit.ai approve your changes

@MohitMaulekhi
Copy link
Contributor Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Dec 24, 2024

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

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

🧹 Nitpick comments (2)
lib/services/event_service.dart (1)

56-63: Ensure doc comments match the returned entity.
The doc comment references an "event stream," but this new getter returns OrgInfo. Update the comment to accurately reflect its purpose.

test/service_tests/event_service_test.dart (1)

677-768: Consider assertions to validate returned event objects.
The debug prints are helpful, but including assertions on the event data (e.g., title fields) would make these tests more robust and guard against regressions.

-  print(events);
-  // ...
-  // expect(events, isA<List<Event>>());
-  // expect(events.length, 2);
-  // expect(events[0].title, "Test Event 1");
-  // expect(events[1].title, "Test Event 2");
+  expect(events, isA<List<Event>>());
+  expect(events.length, 2);
+  expect(events[0].title, "Test Event 1");
+  expect(events[1].title, "Test Event 2");
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between db0d597 and 89c2e73.

📒 Files selected for processing (2)
  • lib/services/event_service.dart (1 hunks)
  • test/service_tests/event_service_test.dart (5 hunks)
🔇 Additional comments (3)
test/service_tests/event_service_test.dart (3)

Line range hint 420-482: Great test coverage for volunteer groups.
The new tests correctly validate both the success and failure scenarios of fetchVolunteerGroupsByEvent. This ensures robust coverage for edge cases.


639-653: Good verification of organization updates in the stream.
This test effectively ensures that _currentOrg is updated whenever setOrgStreamSubscription emits a new organization object.


655-675: Validate exception handling for null data.
The test successfully checks that fetchDataFromApi throws an exception when the query returns null data, increasing code resilience.

@palisadoes
Copy link
Contributor

@noman2002 PTAL

@noman2002 noman2002 merged commit e771527 into PalisadoesFoundation:develop-postgres Dec 28, 2024
10 checks passed
@MohitMaulekhi MohitMaulekhi deleted the unit_test_event_service branch December 29, 2024 06:10
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.

5 participants