test: add test for duplicated jobs

[meskill]

Summary by CodeRabbit

• Tests
  • Introduced a new test module for validating job dependencies in the workflow generation.
  • Added two test functions to ensure correctness of the workflow structure.

[coderabbitai]

Walkthrough

The pull request introduces a new test module for the Generate struct in the GitHub workflow generation code. The tests focus on validating the behavior of job dependencies within workflow generation. Two test functions are added: add_needs_job and missing_add_job, which create workflows with multiple jobs and verify their correct generation using snapshot testing with the insta crate.

Changes

File	Change Summary
crates/gh-workflow/src/generate.rs	Added new test module tests with two test functions for validating job dependency handling

Poem

🐰 Workflows dance, jobs intertwine,
Dependencies mapped with design so fine!
Snapshots capture each intricate flow,
Testing GitHub's magic, watch it grow!
A rabbit's code review, precise and bright 🔍

---

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)

crates/gh-workflow/src/generate.rs (1)

169-185: Excellent negative scenario test.

The missing_add_job test covers the scenario where the base job is not initially added to the workflow. This ensures that the organize_job_dependency logic properly creates the missing job and updates dependencies. The snapshot approach effectively validates this behavior.

As a future enhancement, consider adding more corner cases (e.g., circular dependencies or multiple missing dependencies) to further strengthen coverage.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d3ab323 and 88bbf36.

⛔ Files ignored due to path filters (2)

• crates/gh-workflow/src/snapshots/gh_workflow__generate__tests__add_needs_job.snap is excluded by !**/*.snap
• crates/gh-workflow/src/snapshots/gh_workflow__generate__tests__missing_add_job.snap is excluded by !**/*.snap

📒 Files selected for processing (1)

• crates/gh-workflow/src/generate.rs (1 hunks)

🔇 Additional comments (3)

crates/gh-workflow/src/generate.rs (3)

144-145: Good approach enabling test mode.

The addition of #[cfg(test)] and the tests module helps maintain a clear separation between production and test code, ensuring that tests are only compiled and run in test mode. This is a best practice in Rust.

---

146-148: Using insta for snapshot testing and use super::* is effective.

Snapshot testing with insta can quickly catch unintentional changes, and importing from the parent module (use super::*) helps referencing the tested items directly. This setup is concise and robust.

---

150-167: Thorough test for existing job dependencies.

The add_needs_job test effectively covers the scenario where the base job is included in the workflow from the start. It ensures that the final generated workflow correctly reflects the dependencies. Consider also verifying the resulting YAML structure by asserting specific keys or fields within the snapshot if you need granular checks.