Skip to content

Improved Shell Detection #1658

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

Merged
merged 4 commits into from
Dec 31, 2024
Merged

Improved Shell Detection #1658

merged 4 commits into from
Dec 31, 2024

Conversation

oneirocosm
Copy link
Member

Use the SHELL environment variable instead of the /etc/passwd file for determining the shell on Linux.

This replaces the /etc/passwd check with the output of the SHELL
environment variable.
This is a fix for the FilterValidArch function
Copy link
Contributor

coderabbitai bot commented Dec 31, 2024

Walkthrough

The pull request introduces modifications to two files: cmd/wsh/cmd/wshcmd-shell-unix.go and pkg/util/utilfn/utilfn.go.

In wshcmd-shell-unix.go, the shellCmdInner function has been modified to utilize the SHELL environment variable for determining the user's shell, replacing the previous user lookup from /etc/passwd. The function now defaults to returning "/bin/bash\n" if the SHELL variable is not set. This change results in the removal of the os/user and bufio package imports.

In utilfn.go, the FilterValidArch function has been updated to include two new cases for the input strings "amd64" and "x86_64", both returning "x64". This enhancement allows the function to standardize additional architecture names while maintaining its existing behavior for other inputs.


📜 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 2156493 and c0bcfc7.

📒 Files selected for processing (1)
  • cmd/wsh/cmd/wshcmd-shell-unix.go (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • cmd/wsh/cmd/wshcmd-shell-unix.go

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

Copy link
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 (1)
cmd/wsh/cmd/wshcmd-shell-unix.go (1)

39-39: Ensure consistent newline usage.

Currently, the code returns strings.TrimSpace(shell) without appending a newline, whereas the fallback above ("/bin/bash\n") includes one. If consistent output formatting is desired, consider appending a newline here as well.

-  return strings.TrimSpace(shell)
+  return strings.TrimSpace(shell) + "\n"
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b59e9e9 and 2156493.

📒 Files selected for processing (2)
  • cmd/wsh/cmd/wshcmd-shell-unix.go (1 hunks)
  • pkg/util/utilfn/utilfn.go (1 hunks)
🔇 Additional comments (3)
cmd/wsh/cmd/wshcmd-shell-unix.go (1)

35-36: Use of environment variable improves simplicity and portability.

This approach of reading the SHELL environment variable is more straightforward than parsing /etc/passwd. However, consider the edge case where SHELL is incorrectly set by the user. Currently, the code silently defaults to "/bin/bash\n", which might differ from the true login shell, but it seems acceptable given the PR's objectives.

If you’d like, I can provide a quick verification script to locate and audit any references to /etc/passwd or environment variable usage across the codebase.

pkg/util/utilfn/utilfn.go (2)

977-977: Unifying "amd64" to "x64" is correct and enhances consistency.

This standardization helps avoid confusion caused by multiple architecture labels for the same underlying platform. Good job!


979-979: Same logic applies to "x86_64".

Also aligns with common synonyms for x64. If other aliases arise (e.g., "em64t"), a separate PR can extend this further if needed.

@oneirocosm oneirocosm merged commit 7d0fb03 into main Dec 31, 2024
8 checks passed
@oneirocosm oneirocosm deleted the sylvie/shell-detect-improved branch December 31, 2024 06:18
xxyy2024 pushed a commit to xxyy2024/waveterm_aipy that referenced this pull request Jun 24, 2025
Use the SHELL environment variable instead of the /etc/passwd file for
determining the shell on Linux.
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