Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

Inject truststore earlier#487

Merged
NickCao merged 1 commit intomainfrom
truststore
May 16, 2025
Merged

Inject truststore earlier#487
NickCao merged 1 commit intomainfrom
truststore

Conversation

@NickCao
Copy link
Copy Markdown
Collaborator

@NickCao NickCao commented May 14, 2025

Summary by CodeRabbit

  • Bug Fixes

    • Improved handling of SSL certificates to avoid issues on macOS by skipping system certificate injection by default, with an option to override this behavior using an environment variable.
  • Chores

    • Updated internal logic to manage SSL certificate injection at a different stage, ensuring more reliable platform-specific behavior.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 14, 2025

Walkthrough

The changes relocate the logic for injecting system certificates into the SSL context from the OIDC utility module to the CLI package's initialization code. The platform-specific handling for macOS and the JUMPSTARTER_FORCE_SYSTEM_CERTS environment variable is now performed during CLI initialization rather than within the OIDC module.

Changes

Files Change Summary
packages/jumpstarter-cli-common/jumpstarter_cli_common/oidc.py Removed imports and platform-specific logic for SSL certificate injection; deleted related environment variable check.
packages/jumpstarter-cli/jumpstarter_cli/init.py Added initialization code to conditionally inject system certificates into SSL based on OS and environment variable.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI (jumpstarter_cli)
    participant truststore
    participant OS

    User->>CLI (jumpstarter_cli): Start CLI
    CLI (jumpstarter_cli)->>OS: Check system type (uname)
    CLI (jumpstarter_cli)->>OS: Check JUMPSTARTER_FORCE_SYSTEM_CERTS env
    alt Not macOS or forced by env
        CLI (jumpstarter_cli)->>truststore: inject_into_ssl()
    end
    CLI (jumpstarter_cli)->>User: Continue CLI execution
Loading

Possibly related PRs

Suggested reviewers

  • kirkbrauer

Poem

A bunny hopped through code so neat,
Moving certs from OIDC’s seat.
Now CLI checks the system’s name,
Mac or not, it’s not the same!
With truststore’s help, SSL’s secure—
Hopping forward, that’s for sure! 🐇🔒

✨ 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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 14, 2025

Deploy Preview for jumpstarter-docs ready!

Name Link
🔨 Latest commit fbccac2
🔍 Latest deploy log https://app.netlify.com/sites/jumpstarter-docs/deploys/6824ce2a43ddac00082684d5
😎 Deploy Preview https://deploy-preview-487--jumpstarter-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Copy Markdown
Contributor

@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

🧹 Nitpick comments (2)
packages/jumpstarter-cli/jumpstarter_cli/__init__.py (2)

9-9: Consider Windows compatibility for os.uname().

The os.uname() function is not available on Windows platforms, which might cause issues if this code needs to run on Windows. Consider adding a platform check that's compatible with all operating systems.

-if os.uname().sysname != "Darwin" or os.environ.get("JUMPSTARTER_FORCE_SYSTEM_CERTS") == "1":
+import platform
+if platform.system() != "Darwin" or os.environ.get("JUMPSTARTER_FORCE_SYSTEM_CERTS") == "1":

10-10: Consider adding error handling around truststore injection.

If truststore.inject_into_ssl() fails for any reason, it could cause the application to crash during import. Consider adding try-except handling to gracefully handle any potential errors.

-    truststore.inject_into_ssl()
+    try:
+        truststore.inject_into_ssl()
+    except Exception as e:
+        print(f"Warning: Could not inject system certificates: {e}")
+        # Optionally add logging here instead of print
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between de5cae4 and fbccac2.

📒 Files selected for processing (2)
  • packages/jumpstarter-cli-common/jumpstarter_cli_common/oidc.py (0 hunks)
  • packages/jumpstarter-cli/jumpstarter_cli/__init__.py (1 hunks)
💤 Files with no reviewable changes (1)
  • packages/jumpstarter-cli-common/jumpstarter_cli_common/oidc.py
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: pytest-matrix (macos-15, 3.12)
  • GitHub Check: pytest-matrix (macos-15, 3.11)
  • GitHub Check: pytest-matrix (macos-15, 3.13)
  • GitHub Check: pytest-matrix (ubuntu-24.04, 3.12)
  • GitHub Check: pytest-matrix (ubuntu-24.04, 3.13)
  • GitHub Check: pytest-matrix (ubuntu-24.04, 3.11)
  • GitHub Check: e2e
  • GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-dev .devfile/Containerfile)
  • GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-utils Dockerfile.utils)
  • GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter Dockerfile)
  • GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-devspace .devfile/Containerfile.client)
🔇 Additional comments (2)
packages/jumpstarter-cli/jumpstarter_cli/__init__.py (2)

1-3: Import modules added to support certificate injection.

These imports are necessary for the certificate injection functionality that has been moved from the OIDC module to this package initialization.


5-10: Certificate injection logic properly relocated and documented.

Moving the certificate injection to the CLI package initialization is a good architectural decision as it centralizes this one-time setup operation. The code is well-documented with comments explaining the special handling for MacOS and the environment variable override.

@NickCao NickCao merged commit f1542f5 into main May 16, 2025
22 checks passed
@NickCao NickCao deleted the truststore branch May 16, 2025 16:31
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants