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

Mock DNS result in SSH spec #3371

Merged
merged 1 commit into from
Jan 15, 2025
Merged

Mock DNS result in SSH spec #3371

merged 1 commit into from
Jan 15, 2025

Conversation

ytti
Copy link
Owner

@ytti ytti commented Jan 15, 2025

Fixes #3370

Summary by CodeRabbit

  • Tests
    • Updated SSH connection test to use a stubbed IP address for consistent DNS resolution
    • Replaced hardcoded IP address with a controlled test IP
    • Improved test reliability by controlling DNS resolution behavior

Copy link

coderabbitai bot commented Jan 15, 2025

Walkthrough

The changes modify the SSH connection testing logic in the spec/input/ssh_spec.rb file. A new stub for the Resolv class's getaddress method is introduced to return a specific IP address ('192.0.2.2') for 'example.com'. This change ensures that the SSH connection test is not dependent on external DNS resolution, making the test more consistent and reliable by using a controlled IP address.

Changes

File Change Summary
spec/input/ssh_spec.rb - Added stub for Resolv.getaddress to return '192.0.2.2' for 'example.com'
- Updated Net::SSH.start expectation to use '192.0.2.2' instead of '93.184.215.14'

Assessment against linked issues

Objective Addressed Explanation
Mock SSH to remove DNS dependency [#3370]

Poem

🐰 A bunny's test, no DNS in sight
Stubbed addresses, making connections tight
'192.0.2.2' takes the stage
Resolving worries on our test page
SSH specs now hop with glee! 🌐


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c7f0bdc and 5a30576.

📒 Files selected for processing (1)
  • spec/input/ssh_spec.rb (2 hunks)
🔇 Additional comments (2)
spec/input/ssh_spec.rb (2)

14-14: Well implemented DNS mocking!

Good choice using an IP from TEST-NET-1 range (192.0.2.0/24) for the mock. This makes the tests more deterministic by removing external DNS dependencies.


48-48: LGTM - Consistent with DNS mock!

The updated expectation correctly matches the stubbed DNS resolution while maintaining the test's original intent. Good that the second test case remains unchanged as it verifies the DNS-disabled scenario.

Finishing Touches

  • 📝 Generate Docstrings (Beta)

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

@ytti ytti merged commit 7fb4f09 into master Jan 15, 2025
13 checks passed
tschafer pushed a commit to tschafer/oxidized that referenced this pull request Jan 15, 2025
@robertcheramy robertcheramy deleted the fix/spec_dns branch January 24, 2025 06:40
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.

SSH spec fails when DNS changes
1 participant