fix(tests): ensure consistent order of ResourceDefinition in tests

[kasugamirai]

Summary by CodeRabbit

• Bug Fixes
  • Improved test reliability by adding sorting logic to ensure consistent comparison of resource results.

[coderabbitai]

Walkthrough

The pull request modifies the builder_test.go file in the generator package to improve test reliability. The change introduces sorting logic to the TestResourceBuilder_Build function, ensuring that resource comparisons are order-independent. By using sort.Slice, the test now compares sorted slices of resources, which prevents potential test failures due to non-deterministic ordering.

Changes

File	Change Summary
cerbos/generator/builder_test.go	Added sort package import and implemented sorting of resources using sort.Slice in test comparison

Poem

🐰 A testing tale of sorted might,
Where resources dance in ordered flight,
No more failures from random array,
Sorted slices now save the day!
Rabbit's code, precise and neat, ✨

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

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
• Mastodon
• Reddit
• LinkedIn

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

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

cerbos/generator/builder_test.go (1)

180-185: LGTM with suggestions for improvement

The sorting implementation successfully addresses the non-deterministic test behavior. However, consider these improvements:

1. Extract the sorting logic into a helper function to avoid duplication
2. Consider sorting Actions within each ResourceDefinition for complete determinism

Here's a suggested refactor:

+func sortResourceDefinitions(defs []ResourceDefinition) {
+    sort.Slice(defs, func(i, j int) bool {
+        return defs[i].Resource < defs[j].Resource
+    })
+    // Sort actions within each definition for complete determinism
+    for i := range defs {
+        sort.Slice(defs[i].Actions, func(x, y int) bool {
+            return defs[i].Actions[x].Action < defs[i].Actions[y].Action
+        })
+    }
+}

 func TestResourceBuilder_Build(t *testing.T) {
     // ... existing code ...
     result := builder.Build()
-    sort.Slice(result, func(i, j int) bool {
-        return result[i].Resource < result[j].Resource
-    })
-    sort.Slice(tt.expected, func(i, j int) bool {
-        return tt.expected[i].Resource < tt.expected[j].Resource
-    })
+    sortResourceDefinitions(result)
+    sortResourceDefinitions(tt.expected)
     assert.Equal(t, tt.expected, result)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9b8bc8a and 988663d.

📒 Files selected for processing (1)

• cerbos/generator/builder_test.go (2 hunks)

🔇 Additional comments (1)

cerbos/generator/builder_test.go (1)

4-4: LGTM: Import addition is appropriate

The sort package import is correctly placed and necessary for the new sorting functionality.