Script to update live Nakamochi with locally built nd and ngui #46
Conversation
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughAdds a new Bash script to deploy locally built Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Script as update-nakamochi.sh
participant Local as Local FS
participant Remote as Nakamochi (root)
User->>Script: run with <ip> [binaries-path]
Script->>Script: validate args
Script->>Local: check `nd` & `ngui` exist
alt binaries missing
Script-->>User: print usage & exit(1)
else binaries present
Script->>Remote: ssh -> parse nd path from `/etc/sv/nd/run`
Remote-->>Script: nd installation path or empty
alt path found
Script->>Remote: sha256sum (before)
Script->>Remote: sv stop nd
Script->>Local: scp `nd`,`ngui` -> remote path
Local->>Remote: files copied
Script->>Remote: sha256sum (after)
Script->>Remote: sv start nd
Script->>Remote: tail nd logs (grep ndg ... | tail)
Remote-->>User: log output & completion
else path not found
Script-->>User: error & exit
end
end
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
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. Comment |
There was a problem hiding this comment.
Pull Request Overview
This PR adds a shell script for updating a live Nakamochi device with locally built nd and ngui binaries, facilitating local testing before pushing to sysupdates channels.
- Adds a new shell script that automates the process of copying locally built binaries to a remote Nakamochi device
- Includes automatic path detection for the Nakamochi installation directory
- Provides hash verification and service management capabilities
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (3)
tools/update-nakamochi.sh (3)
3-13: Add input validation for Nakamochi IP address.The script accepts the IP address as a positional argument but does not validate its format. An invalid IP could lead to confusing error messages or unexpected SSH connection attempts.
Consider adding basic IP validation:
NAKAMOCHI_IP=$1 + +# Basic IP validation (IPv4 dotted-quad format) +if ! [[ $NAKAMOCHI_IP =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then + echo "Error: Invalid IP address format: $NAKAMOCHI_IP" + exit 1 +fi
28-31: Verify file transfer success before restarting service.After copying binaries, the script should verify that the checksums have changed, confirming successful file transfer. Currently, there is no check that the transferred files actually replaced the original binaries.
After the SCP commands, capture and compare checksums to confirm successful transfer:
scp "$BINARIES_PATH/nd" "root@$NAKAMOCHI_IP:$nakamochi_nd_path/nd" scp "$BINARIES_PATH/ngui" "root@$NAKAMOCHI_IP:$nakamochi_nd_path/ngui" -$ssh_cmd "sha256sum $nakamochi_nd_path/*; sv start nd; grep ndg /var/log/socklog/daemon/current | tail" +echo "Verifying file transfer..." +$ssh_cmd "sha256sum '$nakamochi_nd_path'/*; sv start nd; grep ndg /var/log/socklog/daemon/current | tail"Alternatively, store and compare checksums before/after:
-$ssh_cmd "sha256sum $nakamochi_nd_path/*; sv stop nd" +echo "Pre-update checksums:" +pre_sums="$($ssh_cmd "sha256sum '$nakamochi_nd_path'/*")" +echo "$pre_sums" +$ssh_cmd "sv stop nd"
1-32: Consider adding SSH connection timeout.SSH and SCP commands lack timeouts. On unreliable networks, these commands could hang indefinitely, blocking deployment automation.
Add connection timeout options to SSH and SCP commands:
-ssh_cmd="ssh root@$NAKAMOCHI_IP" +ssh_cmd="ssh -o ConnectTimeout=10 -o BatchMode=yes root@$NAKAMOCHI_IP"And update SCP commands with timeout:
-scp "$BINARIES_PATH/nd" "root@$NAKAMOCHI_IP:$nakamochi_nd_path/nd" -scp "$BINARIES_PATH/ngui" "root@$NAKAMOCHI_IP:$nakamochi_nd_path/ngui" +scp -o ConnectTimeout=10 "$BINARIES_PATH/nd" "root@$NAKAMOCHI_IP:$nakamochi_nd_path/nd" +scp -o ConnectTimeout=10 "$BINARIES_PATH/ngui" "root@$NAKAMOCHI_IP:$nakamochi_nd_path/ngui"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
tools/update-nakamochi.sh(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
kristapsk
force-pushed
the
update-nakamochi-sh
branch
from
5d15de2 to
104a7e1
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
tools/update-nakamochi.sh (1)
29-30: Consider atomic file transfers to prevent partial corruption.The binaries are copied directly to their target location. If
scpis interrupted or fails partway through, the binary could be left in a corrupted or incomplete state. Consider copying to a temporary filename first and then atomically moving it into place after verifying the transfer succeeded:-scp "$BINARIES_PATH/nd" "root@$NAKAMOCHI_IP:$nakamochi_nd_path/nd" || { echo "Failed to copy nd binary"; exit 1; } -scp "$BINARIES_PATH/ngui" "root@$NAKAMOCHI_IP:$nakamochi_nd_path/ngui" || { echo "Failed to copy ngui binary"; exit 1; } +scp "$BINARIES_PATH/nd" "root@$NAKAMOCHI_IP:$nakamochi_nd_path/nd.tmp" || { echo "Failed to copy nd binary"; exit 1; } +$ssh_cmd "mv $nakamochi_nd_path/nd.tmp $nakamochi_nd_path/nd" || { echo "Failed to move nd binary into place"; exit 1; } +scp "$BINARIES_PATH/ngui" "root@$NAKAMOCHI_IP:$nakamochi_nd_path/ngui.tmp" || { echo "Failed to copy ngui binary"; exit 1; } +$ssh_cmd "mv $nakamochi_nd_path/ngui.tmp $nakamochi_nd_path/ngui" || { echo "Failed to move ngui binary into place"; exit 1; }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
tools/update-nakamochi.sh(1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-10-17T13:19:04.146Z
Learnt from: kristapsk
PR: nakamochi/ndg#46
File: tools/update-nakamochi.sh:22-26
Timestamp: 2025-10-17T13:19:04.146Z
Learning: In the nakamochi/ndg repository, the versioning format (X.Y.Z) and directory structure (/home/uiuser/vX.Y.Z) are stable and controlled by the maintainers through explicit sysupdates pushes, so pattern matching on these paths is considered reliable for internal tooling.
Applied to files:
tools/update-nakamochi.sh
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: build
🔇 Additional comments (2)
tools/update-nakamochi.sh (2)
3-10: Input validation is robust and user-friendly.Clear usage message, proper exit code, and early failure for missing arguments.
15-18: Local binary verification is appropriately defensive.Explicit checks for both nd and ngui binaries before proceeding, with clear error messaging.
kristapsk
force-pushed
the
update-nakamochi-sh
branch
from
104a7e1 to
772aa2c
Compare
1 participant
Useful for local testing before pushing binaries to any sysupdates channel.
Summary by CodeRabbit