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

Docker Shells configuration #3295

Merged

Conversation

JaiPannu-IITI
Copy link

@JaiPannu-IITI JaiPannu-IITI commented Feb 24, 2025

Related issue #3214

Description

Configure docker login shells and bash non interactive shells to use fnm.

  • Bash Non-Interactive (New) (Main requirement of issue)
  • Bash Login (New)
  • Bash Interactive (Already Supported)
  • Sh Login (Was used by initializeCommand by default)

Conclusion: Bash can we widely used as per needs.

Following can be used to at ease now as one line commands directly from cli:

  1. Non-Interactive Shells

docker exec talawa-api-1 /bin/bash -c 'pnpm run add:sample_data && exit'

  1. Login Shells

docker exec talawa-api-1 /bin/bash -l -c 'pnpm run add:sample_data && exit'

docker exec talawa-api-1 /bin/sh -l -c 'pnpm run add:sample_data && exit'

  1. Interactive Shells

docker exec -it talawa-api-1 /bin/bash -i -c 'pnpm run add:sample_data && exit'

docker exec -it talawa-api-1 /bin/bash -l -i -c 'pnpm run add:sample_data && exit'

docker exec -it talawa-api-1 /bin/sh -l -i -c 'pnpm run add:sample_data && exit'

Key Changes

  • Configured environment before handing over to talawa.
  • Updated Docs

Using reset:data script (interactive)

docker exec -it talawa-api-1 /bin/bash -c 'pnpm run reset:data'

Next Steps For issue

Improve code coverage for helpers script.

Summary by CodeRabbit

Summary by CodeRabbit

  • Refactor

    • Centralized the configuration for the Fast Node Manager tool, ensuring consistent environment settings are applied across both interactive and non-interactive sessions.
  • Chores

    • Streamlined the process for importing sample data into the Talawa API database by combining multiple steps into a single command for improved efficiency.

@JaiPannu-IITI JaiPannu-IITI marked this pull request as ready for review February 24, 2025 16:36
Copy link

coderabbitai bot commented Feb 24, 2025

Walkthrough

The changes centralize the fnm (Fast Node Manager) environment setup by introducing a global profile script at /etc/profile.d/fnm.sh. This script is configured to load in both login and non-interactive shells via sourcing in the talawa user's .bashrc and by setting the BASH_ENV variable. Additionally, the instructions for importing sample data into the Talawa API database have been streamlined into a single command executed within the Docker container, replacing the previous multi-step process.

Changes

File(s) Change Summary
docker/api/Containerfile Added a global profile script /etc/profile.d/fnm.sh for configuring fnm in all shell sessions. Updated the talawa user's .bashrc to source this script and removed the previous direct configuration alongside the extraneous line continuation character in the RUN command.
docs/docs/docs/getting-started/installation.md Modified the instructions for importing sample data to streamline the process into a single command executed within the Docker container, changing the command from pnpm run import:sample-data to pnpm run add:sample_data.

Suggested labels

ignore-sensitive-files-pr

Suggested Reviewers

  • palisadoes

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.

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

Our Pull Request Approval Process

Thanks for contributing!

Testing Your Code

Remember, your PRs won't be reviewed until these criteria are met:

  1. We don't merge PRs with poor code quality.
    1. Follow coding best practices such that CodeRabbit.ai approves your PR.
  2. We don't merge PRs with failed tests.
    1. When tests fail, click on the Details link to learn more.
    2. Write sufficient tests for your changes (CodeCov Patch Test). Your testing level must be better than the target threshold of the repository
    3. Tests may fail if you edit sensitive files. Ask to add the ignore-sensitive-files-pr label if the edits are necessary.
  3. We cannot merge PRs with conflicting files. These must be fixed.

Our policies make our code better.

Reviewers

Do not assign reviewers. Our Queue Monitors will review your PR and assign them.
When your PR has been assigned reviewers contact them to get your code reviewed and approved via:

  1. comments in this PR or
  2. our slack channel

Reviewing Your Code

Your reviewer(s) will have the following roles:

  1. arbitrators of future discussions with other contributors about the validity of your changes
  2. point of contact for evaluating the validity of your work
  3. person who verifies matching issues by others that should be closed.
  4. person who gives general guidance in fixing your tests

CONTRIBUTING.md

Read our CONTRIBUTING.md file. Most importantly:

  1. PRs with issues not assigned to you will be closed by the reviewer
  2. Fix the first comment in the PR so that each issue listed automatically closes

Other

  1. 🎯 Please be considerate of our volunteers' time. Contacting the person who assigned the reviewers is not advised unless they ask for your input. Do not @ the person who did the assignment otherwise.
  2. Read the CONTRIBUTING.md file make

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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2438e61 and acab66a.

📒 Files selected for processing (1)
  • docker/api.Containerfile (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Run tests for talawa api
  • GitHub Check: Analyse Code With CodeQL (typescript)
🔇 Additional comments (3)
docker/api.Containerfile (3)

35-39: Well-structured shell initialization setup!

Good implementation of the global profile script following best practices:

  • Correct location in /etc/profile.d/
  • Proper executable permissions
  • Comprehensive fnm initialization with all necessary flags

41-41: Excellent non-interactive shell configuration!

Setting BASH_ENV ensures consistent fnm availability in non-interactive bash shells, which is crucial for CI/CD pipelines and scripts.


43-43: Good shell coverage with explicit sourcing!

Adding explicit sourcing in .bashrc ensures the fnm environment is consistently available across all shell types (login, non-interactive, and interactive).

Copy link

codecov bot commented Feb 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 48.36%. Comparing base (2438e61) to head (d2317f6).
Report is 1 commits behind head on develop-postgres.

Additional details and impacted files
@@                Coverage Diff                @@
##           develop-postgres    #3295   +/-   ##
=================================================
  Coverage             48.36%   48.36%           
=================================================
  Files                   458      458           
  Lines                 34516    34516           
  Branches                966      966           
=================================================
  Hits                  16695    16695           
  Misses                17821    17821           

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

coderabbitai[bot]
coderabbitai bot previously approved these changes Feb 24, 2025
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: 1

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between acab66a and d2317f6.

📒 Files selected for processing (2)
  • docker/api.Containerfile (1 hunks)
  • docs/docs/docs/getting-started/installation.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/docs/docs/getting-started/installation.md

396-396: Fenced code blocks should be surrounded by blank lines
null

(MD031, blanks-around-fences)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Run tests for talawa api
  • GitHub Check: Analyse Code With CodeQL (typescript)
🔇 Additional comments (2)
docker/api.Containerfile (2)

35-43: LGTM! Well-structured shell environment configuration.

The changes effectively centralize the fnm configuration by:

  1. Creating a global profile script that loads in both login and non-interactive shells
  2. Setting BASH_ENV to ensure non-interactive shells load the configuration
  3. Explicitly sourcing in .bashrc for login shells

46-46: LGTM! Secure curl command implementation.

The curl command properly implements security best practices by using:

  • HTTPS-only connections (--proto '=https')
  • Modern TLS version (--tlsv1.2)

@JaiPannu-IITI
Copy link
Author

@palisadoes PR is ready for review

@palisadoes palisadoes merged commit b8d4a95 into PalisadoesFoundation:develop-postgres Feb 24, 2025
17 checks passed
@JaiPannu-IITI JaiPannu-IITI deleted the docker-shell branch February 26, 2025 15:57
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.

2 participants