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

feat(tools/cosmovisor): pass stdin to process #21462

Merged
merged 2 commits into from
Aug 29, 2024
Merged

feat(tools/cosmovisor): pass stdin to process #21462

merged 2 commits into from
Aug 29, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Aug 29, 2024

Description

Closes: #17053


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title, you can find examples of the prefixes below:
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

  • New Features

    • Enhanced configurability of the cosmovisor tool, allowing users to specify alternative configuration file paths.
    • Added support for passing standard input (stdin) to improve input handling flexibility during command execution.
  • Bug Fixes

    • Various improvements related to configuration management have been implemented to enhance usability.
  • Tests

    • Updated test functions to validate new input handling capabilities, ensuring robust testing of the launcher.Run method.

@julienrbrt julienrbrt requested a review from a team as a code owner August 29, 2024 11:05
@github-actions github-actions bot added the C:Cosmovisor Issues and PR related to Cosmovisor label Aug 29, 2024
Copy link
Contributor

coderabbitai bot commented Aug 29, 2024

Walkthrough

Walkthrough

The changes to the cosmovisor tool introduce the capability to pass standard input (stdin) to the binary executed by the tool. This includes modifications to the configuration management commands, allowing users to specify alternative configuration file paths. The updates enhance the internal handling of input and output streams, improving the tool's flexibility and usability.

Changes

Files Change Summary
tools/cosmovisor/cmd/cosmovisor/run.go, tools/cosmovisor/cmd/cosmovisor/run_config.go, tools/cosmovisor/process.go, tools/cosmovisor/process_test.go Added stdin handling to the Run method and associated configurations, allowing for input redirection.

Assessment against linked issues

Objective Addressed Explanation
Make cosmovisor run pass piped input to the binary (#17053)

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.
    • @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 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
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

Outside diff range, codebase verification and nitpick comments (1)
tools/cosmovisor/CHANGELOG.md (1)

49-52: Fix unordered list indentation.

The unordered list indentation is inconsistent. Apply this diff to fix the indentation:

-  * `init command` writes the configuration to the config file only at the default path `DAEMON_HOME/cosmovisor/config.toml`.
-  * Provide `--cosmovisor-config` flag with value as args to provide the path to the configuration file in the `run` command. `run --cosmovisor-config <path> (other cmds with flags) ...`.
-  * Add `--cosmovisor-config` flag to provide `config.toml` path to the configuration file in root command used by `add-upgrade` and `config` subcommands.
-  * `config command` now displays the configuration from the config file if it is provided. If the config file is not provided, it will display the configuration from the environment variables.
+    * `init command` writes the configuration to the config file only at the default path `DAEMON_HOME/cosmovisor/config.toml`.
+    * Provide `--cosmovisor-config` flag with value as args to provide the path to the configuration file in the `run` command. `run --cosmovisor-config <path> (other cmds with flags) ...`.
+    * Add `--cosmovisor-config` flag to provide `config.toml` path to the configuration file in root command used by `add-upgrade` and `config` subcommands.
+    * `config command` now displays the configuration from the config file if it is provided. If the config file is not provided, it will display the configuration from the environment variables.
Tools
Markdownlint

49-49: Expected: 4; Actual: 2
Unordered list indentation

(MD007, ul-indent)


50-50: Expected: 4; Actual: 2
Unordered list indentation

(MD007, ul-indent)


51-51: Expected: 4; Actual: 2
Unordered list indentation

(MD007, ul-indent)


52-52: Expected: 4; Actual: 2
Unordered list indentation

(MD007, ul-indent)

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 17d864f and 356b2bc.

Files selected for processing (5)
  • tools/cosmovisor/CHANGELOG.md (1 hunks)
  • tools/cosmovisor/cmd/cosmovisor/run.go (1 hunks)
  • tools/cosmovisor/cmd/cosmovisor/run_config.go (1 hunks)
  • tools/cosmovisor/process.go (2 hunks)
  • tools/cosmovisor/process_test.go (19 hunks)
Additional context used
Path-based instructions (5)
tools/cosmovisor/cmd/cosmovisor/run_config.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

tools/cosmovisor/cmd/cosmovisor/run.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

tools/cosmovisor/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

tools/cosmovisor/process.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

tools/cosmovisor/process_test.go (2)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

Markdownlint
tools/cosmovisor/CHANGELOG.md

49-49: Expected: 4; Actual: 2
Unordered list indentation

(MD007, ul-indent)


50-50: Expected: 4; Actual: 2
Unordered list indentation

(MD007, ul-indent)


51-51: Expected: 4; Actual: 2
Unordered list indentation

(MD007, ul-indent)


52-52: Expected: 4; Actual: 2
Unordered list indentation

(MD007, ul-indent)

Additional comments not posted (13)
tools/cosmovisor/cmd/cosmovisor/run_config.go (3)

10-12: LGTM!

The code changes are approved.


17-19: LGTM!

The code changes are approved.


24-29: LGTM!

The code changes are approved.

tools/cosmovisor/cmd/cosmovisor/run.go (2)

48-48: LGTM!

The code changes are approved.


52-52: LGTM!

The code changes are approved.

tools/cosmovisor/CHANGELOG.md (1)

39-42: LGTM!

The documentation change is approved.

tools/cosmovisor/process.go (1)

Line range hint 42-54: LGTM! But verify the function usage in the codebase.

The function is correctly implemented. However, ensure that all function calls to Launcher.Run match the new signature.

The code changes are approved.

Run the following script to verify the function usage:

tools/cosmovisor/process_test.go (6)

Line range hint 32-44: LGTM!

The changes to the TestLaunchProcess function are correctly implemented.

Also applies to: 59-59


Line range hint 77-89: LGTM!

The changes to the TestPlanDisableRecase function are correctly implemented.

Also applies to: 104-104


Line range hint 121-133: LGTM!

The changes to the TestLaunchProcessWithRestartDelay function are correctly implemented.


Line range hint 152-164: LGTM!

The changes to the TestPlanShutdownGrace function are correctly implemented.

Also applies to: 179-179


209-212: LGTM!

The changes to the TestLaunchProcessWithDownloads function are correctly implemented.

Also applies to: 225-225, 240-240


279-282: LGTM!

The changes to the TestLaunchProcessWithDownloadsAndPreupgrade function are correctly implemented.

Also applies to: 315-318, 335-335, 353-353

@julienrbrt julienrbrt added this pull request to the merge queue Aug 29, 2024
Merged via the queue into main with commit aeaa756 Aug 29, 2024
75 of 76 checks passed
@julienrbrt julienrbrt deleted the julien/stdin branch August 29, 2024 21:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:Cosmovisor Issues and PR related to Cosmovisor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature]: Make cosmovisor run pass piped input to the binary
4 participants