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

chore: Add notification condition tests #1385

Merged
merged 8 commits into from
Nov 4, 2024

Conversation

oskogstad
Copy link
Collaborator

@oskogstad oskogstad commented Nov 3, 2024

Summary by CodeRabbit

  • New Features

    • Introduced integration tests for notification conditions in the Dialogporten application, ensuring accurate notification sending based on various conditions.
  • Chores

    • Added a configuration setting to suppress specific IDE warnings, enhancing the development experience without impacting functionality.

@oskogstad oskogstad requested a review from a team as a code owner November 3, 2024 22:12
Copy link
Contributor

coderabbitai bot commented Nov 3, 2024

Caution

Review failed

The pull request is closed.

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces changes to two primary files. First, it updates the .editorconfig file to suppress severity warnings for the IDE0010 rule related to switch statement cases. Second, it adds a new file containing integration tests for notification conditions in the Dialogporten application. This new test file includes a test class with multiple methods to validate notification sending behavior and handle non-existent dialog scenarios.

Changes

File Change Summary
tests/.editorconfig Added setting: dotnet_diagnostic.IDE0010.severity = none to suppress warnings for missing switch cases.
tests/Digdir.Domain.Dialogporten.Application.Integration.Tests/Features/V1/ServiceOwner/NotificationCondition/NotificationConditionTests.cs Added new test class NotificationConditionTests with methods for testing notification conditions and scenarios.

Possibly related PRs

  • chore: Add notification condition tests #1385: The changes in this PR include the addition of a new setting in the .editorconfig file to suppress the severity warning for the IDE0010 rule, which is directly related to the changes made in the main PR regarding the same configuration file.

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

🧹 Outside diff range and nitpick comments (4)
tests/Digdir.Domain.Dialogporten.Application.Integration.Tests/Features/V1/ServiceOwner/NotificationCondition/NotificationConditionTests.cs (4)

16-20: Consider documenting test data combinations.

The test data generation creates all possible combinations, but it would be helpful to document which combinations are expected to pass/fail and why. This would make the test intentions clearer and help with maintenance.

Consider adding a comment explaining the test matrix, for example:

 public static IEnumerable<object[]> NotificationConditionTestData() =>
+    // Test matrix:
+    // - expectedSendNotificationValue: true when activity exists and condition is Exists, or when activity doesn't exist and condition is NotExists
+    // - activityType: all possible dialog activity types
+    // - conditionType: Exists/NotExists conditions
     from bool expectedSendNotificationValue in ExpectedSendNotificationsValues
     from DialogActivityType.Values activityType in Enum.GetValues(typeof(DialogActivityType.Values))
     from NotificationConditionType conditionType in Enum.GetValues(typeof(NotificationConditionType))
     select new object[] { activityType, conditionType, expectedSendNotificationValue };

23-28: Test name could be more specific.

The current test name SendNotification_Should_Be_True_When_Conditions_Are_Met doesn't fully reflect that it tests both positive and negative cases.

Consider renaming to something like SendNotification_Should_Match_Expected_Value_Based_On_Conditions.


31-37: Improve switch statement readability.

The switch statement's intent could be clearer. It's setting up test conditions based on whether we expect the notification to be sent or not.

Consider extracting the logic to a helper method with a descriptive name:

-switch (conditionType)
-{
-    case NotificationConditionType.Exists when expectedSendNotificationValue:
-    case NotificationConditionType.NotExists when !expectedSendNotificationValue:
-        AddActivityRequirements(createDialogCommand, activityType);
-        break;
-}
+if (ShouldAddActivity(conditionType, expectedSendNotificationValue))
+{
+    AddActivityRequirements(createDialogCommand, activityType);
+}

+private static bool ShouldAddActivity(NotificationConditionType conditionType, bool expectedSendNotificationValue) =>
+    (conditionType == NotificationConditionType.Exists && expectedSendNotificationValue) ||
+    (conditionType == NotificationConditionType.NotExists && !expectedSendNotificationValue);

64-76: Consider improving helper method design.

The helper method could be more flexible and maintainable.

Consider these improvements:

  1. Return the modified command instead of modifying it directly
  2. Make the transmission type configurable
  3. Add validation for required parameters
-private static void AddActivityRequirements(
+private static CreateDialogCommand AddActivityRequirements(
     CreateDialogCommand createDialogCommand,
-    DialogActivityType.Values activityType)
+    DialogActivityType.Values activityType,
+    DialogTransmissionType.Values transmissionType = DialogTransmissionType.Values.Information)
 {
+    ArgumentNullException.ThrowIfNull(createDialogCommand);
+
     var activity = DialogGenerator.GenerateFakeDialogActivity(type: activityType);
     createDialogCommand.Activities.Add(activity);

     if (activityType is not DialogActivityType.Values.TransmissionOpened) return;

-    var transmission = DialogGenerator.GenerateFakeDialogTransmissions(type: DialogTransmissionType.Values.Information)[0];
+    var transmission = DialogGenerator.GenerateFakeDialogTransmissions(type: transmissionType)[0];
     createDialogCommand.Transmissions.Add(transmission);
     createDialogCommand.Activities[0].TransmissionId = createDialogCommand.Transmissions[0].Id;
+
+    return createDialogCommand;
 }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b74f32e and f24bf97.

📒 Files selected for processing (2)
  • tests/.editorconfig (1 hunks)
  • tests/Digdir.Domain.Dialogporten.Application.Integration.Tests/Features/V1/ServiceOwner/NotificationCondition/NotificationConditionTests.cs (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • tests/.editorconfig
🔇 Additional comments (1)
tests/Digdir.Domain.Dialogporten.Application.Integration.Tests/Features/V1/ServiceOwner/NotificationCondition/NotificationConditionTests.cs (1)

78-96: LGTM! Well-structured test for the not found scenario.

The test follows best practices:

  • Clear naming
  • Proper AAA pattern
  • Thorough assertions

@oskogstad oskogstad merged commit 4be1e53 into main Nov 4, 2024
8 of 9 checks passed
@oskogstad oskogstad deleted the chore/add-notification-condition-tests branch November 4, 2024 10:20
Copy link

sonarqubecloud bot commented Nov 4, 2024

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