fix: parametrize the connector name in the template code documentation

[dbgold17]

update template code block generated by airbyte-cdk connector test command to include the connector name in the comments.

Summary by CodeRabbit

• Refactor
  • Updated generated test file templates to dynamically display the actual connector name instead of a fixed example name.

[coderabbitai]

📝 Walkthrough

Walkthrough

The update modifies the test file template in the connector CLI code to dynamically insert the actual connector name, replacing a previously hardcoded example. This ensures that generated test files reference the correct connector. No other logic or exported entities are changed.

Changes

File(s)	Change Summary
airbyte_cdk/cli/airbyte_cdk/_connector.py	Updated TEST_FILE_TEMPLATE to use {connector_name} placeholder instead of a hardcoded name; adjusted test function to provide connector_name for formatting.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

airbyte_cdk/cli/airbyte_cdk/_connector.py (2)

80-88: Clean up commented-out TestSuite stub

I see we still include a commented-out TestSuite class stub with placeholders. Could we consider removing this block to reduce clutter in the generated template, since it’s not actively used? wdyt?

---

155-155: Add coverage for template rendering

The .format() call now correctly injects connector_name, which is perfect. Would you consider adding a unit test for the test CLI command to validate that the generated test file contains the actual connector name in its docstring? wdyt?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2f11bfa and 68e91a8.

📒 Files selected for processing (1)

• airbyte_cdk/cli/airbyte_cdk/_connector.py (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (4)

• GitHub Check: Check: 'source-amplitude' (skip=false)
• GitHub Check: Check: 'source-shopify' (skip=false)
• GitHub Check: Pytest (All, Python 3.11, Ubuntu)
• GitHub Check: Pytest (All, Python 3.10, Ubuntu)

🔇 Additional comments (1)

airbyte_cdk/cli/airbyte_cdk/_connector.py (1)

66-66: Dynamic connector placeholder in the docstring

Nice update! The docstring now references {connector_name} dynamically, ensuring that generated tests accurately reflect the actual connector. Great improvement!

[aaronsteers]

LGTM! Nice fix to the hardcoded connector name there.

(You can ignore the unrelated Shopify CI failure.)