ci: add support for isolated balance tracker repository in e2e scripts

[mayconamaroCW]

PR Type

Enhancement

---

Description

This PR adds support for an isolated Balance Tracker repository in various e2e scripts:

• Clone script: Added cloning of brlc-balance-tracker and improved error handling for npm install
• Compile script: Added fallback compilation for BalanceTracker from different repositories
• Coverage script: Included brlc-balance-tracker in coverage calculation
• Flatten script: Updated to support BalanceTracker in new repository
• Remove script: Added removal of brlc-balance-tracker repository
• Test script: Adapted to support BalanceTracker in new repository

These changes ensure smooth transition and compatibility with the isolated Balance Tracker repository while maintaining support for the existing structure.

---

Changes walkthrough 📝

Relevant files

Enhancement

contracts-clone.sh Improve clone script robustness and add balance tracker support e2e/cloudwalk-contracts/contracts-clone.sh Added error handling for npm install failure Added cloning of brlc-balance-tracker repository +6/-1      contracts-compile.sh Add flexible BalanceTracker compilation                                    e2e/cloudwalk-contracts/contracts-compile.sh Added fallback compilation for BalanceTracker from different repositories +3/-1      contracts-coverage.sh Include balance tracker in coverage calculation                    e2e/cloudwalk-contracts/contracts-coverage.sh Added coverage calculation for brlc-balance-tracker with fallback +1/-0      contracts-flatten.sh Adapt flattening for isolated BalanceTracker                          e2e/cloudwalk-contracts/contracts-flatten.sh Updated flattening process to support BalanceTracker in new repository +1/-1      contracts-remove.sh Include balance tracker in removal process                              e2e/cloudwalk-contracts/contracts-remove.sh Added removal of brlc-balance-tracker repository +1/-0      contracts-test.sh Adapt testing for isolated BalanceTracker                                e2e/cloudwalk-contracts/contracts-test.sh Updated testing process to support BalanceTracker in new repository +3/-1

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Error Handling The new error handling for npm install removes the target directory on failure. This might lead to unexpected behavior if the directory contains important files not managed by npm. Silent Failure The clone operation for brlc-balance-tracker silently continues if the clone fails. This might lead to issues in subsequent steps that depend on this repository. Coverage Gap The coverage calculation for brlc-balance-tracker is skipped if the repository is not isolated. This might lead to incomplete coverage reports.

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Enhancement	Improve error handling and logging for npm install failures to aid in debugging Consider using a more robust error handling mechanism for the npm install command. The current approach of removing the directory and returning might not provide enough context about the failure. e2e/cloudwalk-contracts/contracts-clone.sh [40-44] if ! npm --prefix "$target" --silent install; then - log "Dependencies install failed. Removing folder and exiting." - rm -rf "$target" + log "Dependencies install failed for $repo. Error code: $?" + log "Keeping folder for debugging. Please check $target for issues." return 1 fi Suggestion importance[1-10]: 7 Why: The suggestion improves error handling by providing more context about the failure, which can significantly aid in debugging. It also suggests keeping the folder for inspection instead of removing it, which is a valuable change for troubleshooting.	7
	Enhance logging to clearly indicate which repository was used for compiling BalanceTracker Consider adding a log message to indicate which repository was successfully used for compiling BalanceTracker, as it improves traceability and debugging. e2e/cloudwalk-contracts/contracts-compile.sh [48] -compile_contract brlc-balance-tracker BalanceTracker || compile_contract brlc-yield-streamer BalanceTracker +if compile_contract brlc-balance-tracker BalanceTracker; then + log "Compiled BalanceTracker from brlc-balance-tracker" +elif compile_contract brlc-yield-streamer BalanceTracker; then + log "Compiled BalanceTracker from brlc-yield-streamer" +else + log "Failed to compile BalanceTracker from either repository" + exit 1 +fi Suggestion importance[1-10]: 6 Why: This suggestion improves traceability by clearly indicating which repository was used for compiling BalanceTracker. It also adds proper error handling, which enhances the script's robustness.	6
	Improve logging to clearly indicate which repository was used for testing BalanceTracker Consider adding a log message to indicate which repository was successfully used for testing BalanceTracker, as it improves traceability and debugging. e2e/cloudwalk-contracts/contracts-test.sh [155] -test brlc-balance-tracker BalanceTracker "$@" || test brlc-yield-streamer BalanceTracker "$@" +if test brlc-balance-tracker BalanceTracker "$@"; then + log "Tested BalanceTracker from brlc-balance-tracker" +elif test brlc-yield-streamer BalanceTracker "$@"; then + log "Tested BalanceTracker from brlc-yield-streamer" +else + log "Failed to test BalanceTracker from either repository" + exit 1 +fi Suggestion importance[1-10]: 6 Why: This suggestion enhances traceability and debugging by clearly indicating which repository was used for testing BalanceTracker. It also adds proper error handling, improving the script's robustness.	6
Best practice	Standardize logging method for consistency across the script Instead of using echo for skipping Balance Tracker coverage, consider using the log function for consistency with other logging in the script. e2e/cloudwalk-contracts/contracts-coverage.sh [55] -coverage brlc-balance-tracker || echo "Balance Tracker is not isolated yet. Skipping..." +coverage brlc-balance-tracker || log "Balance Tracker is not isolated yet. Skipping..." Suggestion importance[1-10]: 4 Why: While this suggestion improves consistency in logging, it's a minor change that doesn't significantly impact functionality. It's a good practice but has a relatively low impact on the overall script.	4