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

fix: allow HTTPS credentials when SSH configured #48

Merged
merged 1 commit into from
May 27, 2024

Conversation

jamestelfer
Copy link
Collaborator

@jamestelfer jamestelfer commented May 27, 2024

Allow a pipeline to request HTTPS credentials of a repository that has been configured for SSH, as long as the requested repository matches the configured repository.

Summary by CodeRabbit

  • New Features

    • Introduced a feature to automatically convert SSH URLs to HTTPS URLs for improved compatibility and security.
  • Tests

    • Added comprehensive tests to ensure the correct transformation of SSH URLs to HTTPS URLs across various scenarios.

Copy link

coderabbitai bot commented May 27, 2024

Warning

Rate Limit Exceeded

@jamestelfer has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 38 minutes and 18 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between fd8899a and c573bdc.

Walkthrough

The recent changes introduce a new function, TranslateSSHToHTTPS, in the internal/vendor package to convert SSH URLs to HTTPS URLs. Corresponding tests have been added to ensure the function works correctly across various scenarios. This improves URL handling flexibility within the codebase.

Changes

File Path Change Summary
internal/vendor/vendor.go Added import for regexp and the TranslateSSHToHTTPS function to convert SSH URLs to HTTPS URLs.
internal/vendor/vendor_test.go Added TestTransformSSHToHTTPS function with test cases to validate the SSH to HTTPS URL transformation.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant Tester
    participant Vendor
    Tester->>Vendor: Call TranslateSSHToHTTPS(sshURL)
    Vendor-->>Tester: Return httpsURL
Loading

Poem

Amidst the code, a change so neat,
SSH to HTTPS, a simple feat.
With tests to guide the way so clear,
Transforming URLs, no need to fear.
A bunny's work, both swift and bright,
Ensures the code is always right. 🐇✨


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as 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 full the 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 help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link

codecov bot commented May 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.02%. Comparing base (1332f34) to head (c573bdc).

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #48      +/-   ##
==========================================
+ Coverage   89.89%   90.02%   +0.13%     
==========================================
  Files          12       12              
  Lines         455      461       +6     
==========================================
+ Hits          409      415       +6     
  Misses         32       32              
  Partials       14       14              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 1332f34 and fd8899a.
Files selected for processing (2)
  • internal/vendor/vendor.go (3 hunks)
  • internal/vendor/vendor_test.go (1 hunks)
Additional comments not posted (4)
internal/vendor/vendor.go (3)

7-7: Added import for "regexp" package.

This is necessary for the new TranslateSSHToHTTPS function which uses regular expressions.


64-66: Integration of TranslateSSHToHTTPS in the New function.

This change aligns with the PR's objective to allow HTTPS credentials for SSH-configured repositories. Ensure that this logic is covered by unit tests to verify the correct transformation of URLs.


97-106: Implementation of TranslateSSHToHTTPS.

The function correctly uses a regular expression to transform SSH URLs to HTTPS URLs. However, consider adding error handling or logging for cases where the URL format does not match the expected pattern.

internal/vendor/vendor_test.go (1)

155-219: Added TestTransformSSHToHTTPS function with comprehensive test cases.

The test function is well-structured and covers a variety of scenarios for SSH to HTTPS URL transformation. This is crucial for ensuring the reliability of the TranslateSSHToHTTPS function. Consider adding a test case for URLs that do not match any expected format to ensure that the function behaves correctly in unexpected scenarios.

Allow a pipeline to request HTTPS credentials of a repository that has been configured for SSH, as long as the requested repository matches the configured repository.
@jamestelfer jamestelfer merged commit a6b4d66 into chinmina:main May 27, 2024
3 checks passed
@jamestelfer jamestelfer deleted the translate-ssh branch May 27, 2024 11:30
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.

1 participant