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

chore(tools/cosmovisor): add multiarch bin references #21911

Merged
merged 2 commits into from
Sep 26, 2024

Conversation

troian
Copy link
Contributor

@troian troian commented Sep 25, 2024

required by #21891
allows cosmovisor tests to natively run on following os/arch pairs linux/amd64, linux/arm64
darwin/amd64, darwin/arm64

Description

Closes: #XXXX


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 upgrade information now supports multiple binary links for various operating systems: Linux (amd64, arm64) and macOS (darwin/amd64, darwin/arm64).
    • Improved JSON format for better readability and extensibility.
  • Bug Fixes

    • Corrected binary references to include checksums for verification.

required by cosmos#21891
allows cosmovisor tests to natively run on following os/arch pairs
linux/amd64, linux/arm64
darwin/amd64, darwin/arm64

Signed-off-by: Artur Troian <[email protected]>
Copy link
Contributor

coderabbitai bot commented Sep 25, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes involve modifications to the upgrade information generation for a software upgrade process within the Cosmovisor tool. The updates include transitioning from a single-line JSON format to a multi-line heredoc format for improved readability. Additionally, the upgrade information now supports multiple binary links for various operating systems, specifically adding support for linux/arm64, darwin/amd64, and darwin/arm64, alongside the existing linux/amd64. This expansion enhances the overall architecture support in the upgrade process.

Changes

File Path Change Summary
tools/cosmovisor/testdata/download/cosmovisor/genesis/bin/autod, tools/cosmovisor/testdata/repo/chain2-zip_bin/autod Updated JSON output format from single-line to multi-line heredoc, adding multiple binary links for various architectures (linux/arm64, darwin/amd64, darwin/arm64).
tools/cosmovisor/testdata/repo/ref_to_chain3-zip_dir.json Expanded binaries object to include new entries for linux/arm64, darwin/amd64, and darwin/arm64, each with a URL and checksum.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Cosmovisor
    participant Repository

    User->>Cosmovisor: Request upgrade information
    Cosmovisor->>Repository: Fetch upgrade data
    Repository-->>Cosmovisor: Return JSON with binary links
    Cosmovisor-->>User: Provide upgrade information
Loading

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

@github-actions github-actions bot added the C:Cosmovisor Issues and PR related to Cosmovisor label Sep 25, 2024
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 and nitpick comments (1)
tools/cosmovisor/testdata/download/cosmovisor/genesis/bin/autod (1)

9-15: Approved: Multiarch support added successfully

The changes successfully implement the multiarch binary references as per the PR objectives. The use of a heredoc for the JSON structure improves readability. The upgrade info now includes binary links for linux/amd64, linux/arm64, darwin/amd64, and darwin/arm64, which aligns with the goal of supporting multiple OS and architecture combinations.

Consider adding a comment explaining the purpose of the checksum in the binary URLs. This would enhance code maintainability. For example:

# The checksum in the URL is used to verify the integrity of the downloaded binary
📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3856e77 and c66b854.

📒 Files selected for processing (3)
  • tools/cosmovisor/testdata/download/cosmovisor/genesis/bin/autod (1 hunks)
  • tools/cosmovisor/testdata/repo/chain2-zip_bin/autod (1 hunks)
  • tools/cosmovisor/testdata/repo/ref_to_chain3-zip_dir.json (1 hunks)
🔇 Additional comments not posted (2)
tools/cosmovisor/testdata/repo/ref_to_chain3-zip_dir.json (1)

3-6: Verify architecture-specific binaries and update file naming

The changes successfully add support for multiple architectures (linux/arm64, darwin/amd64, darwin/arm64) alongside the existing linux/amd64. However, there are some concerns:

  1. All architectures are pointing to the same binary file (autod.zip). This might not be correct as typically, different architectures require different binary builds.

  2. The filename autod.zip doesn't indicate any architecture specificity, which is unusual for multi-architecture support.

Please confirm that:

  1. The same binary is indeed intended to work across all these architectures.
  2. If not, update the URLs to point to architecture-specific binaries.
  3. Consider updating the filename to include architecture information (e.g., autod-linux-amd64.zip, autod-darwin-arm64.zip, etc.) for clarity.

To verify the contents of the zip file, you can run:

This will help ensure that the zip file contains the correct binaries for all supported architectures.

tools/cosmovisor/testdata/repo/chain2-zip_bin/autod (1)

9-15: Improved JSON structure with multi-architecture support

The changes enhance the upgrade information generation process:

  1. The switch from a single-line echo to a multi-line heredoc improves readability and maintainability.
  2. The JSON structure now includes binary references for multiple architectures (linux/amd64, linux/arm64, darwin/amd64, darwin/arm64), which aligns with the PR objective of supporting multiarch environments.
  3. The URL and checksum are consistent across all architectures, which is correct if the same binary is compatible with all listed architectures.

To ensure the consistency of the checksum across different parts of the codebase, run the following script:

✅ Verification successful

Checksum Consistently Used as Intended

The checksum a95075f4dd83bc9f0f556ef73e64ce000f9bf3a6beeb9d4ae32f594b1417ef7a is consistently used in tools/cosmovisor/testdata/repo/chain2-zip_bin/autod without any conflicting instances elsewhere in the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the consistency of the checksum used in the upgrade information.

# Test: Search for the checksum value in the codebase. Expect: Consistent usage.
rg "a95075f4dd83bc9f0f556ef73e64ce000f9bf3a6beeb9d4ae32f594b1417ef7a"

Length of output: 975

@julienrbrt julienrbrt changed the title feat(tools/cosmovisor): add multiarch bin references chore(tools/cosmovisor): add multiarch bin references Sep 25, 2024
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK

@tac0turtle tac0turtle added this pull request to the merge queue Sep 26, 2024
Merged via the queue into cosmos:main with commit 0ab189c Sep 26, 2024
72 checks passed
troian added a commit to akash-network/cosmos-sdk that referenced this pull request Sep 26, 2024
fixes incorrect checksums introduced in cosmos#21911

Signed-off-by: Artur Troian <[email protected]>
@troian troian deleted the cosmovisor-multiarch-test branch September 26, 2024 19:21
troian added a commit to akash-network/cosmos-sdk that referenced this pull request Oct 3, 2024
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.

4 participants