Skip to content

Enhancement: Progress Monitoring and Summary Reporting for Initialization #53

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

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

Vaibhav701161
Copy link

@Vaibhav701161 Vaibhav701161 commented Mar 19, 2025

fixes: #46
Description:
This PR enhances the initialization process by introducing real-time progress monitoring and a summary report for long-running operations in init.sh and utils.sh. The improvements ensure better visibility, error tracking, and debugging during script execution.

Key Changes:
Progress Indicators:

  • Added detailed logs and progress tracking for downloads using wget --progress=bar:force.
  • Implemented retry logic with dynamic delays and failure handling.

Summary Report Generation:

  • Introduced init_report.txt to log successes and failures of initialization steps.
  • Implemented generate_summary_report() to summarize operations, including execution time, successful downloads, and failures.
  • The summary report is stored as init_summary_YYYYMMDDHHMMSS.txt.

Error Handling & Logging Enhancements:

  • Improved error reporting for missing scripts and permission issues.
  • Added timestamps and structured logs for better debugging.

Why This Change?

Previously, the initialization process lacked structured progress tracking and failure reporting, making it difficult to debug errors. With these updates:
✅ Users get real-time feedback on downloads and script executions.
✅ Failures are logged systematically, aiding in troubleshooting.
✅ The summary report provides a comprehensive execution overview.


Testing Performed:

1️⃣ Environment Setup

cd cbioportal-docker-compose
chmod +x utils.sh init.sh

✅ Ensured execution permissions are set correctly.

2️⃣ Running Initialization

./init.sh

✅ Verified expected logs and progress indicators appear during execution.

3️⃣ Verifying Summary Report

cat init_report.txt
cat init_summary_*.txt

✅ Confirmed that successful and failed operations are correctly logged.

4️⃣ Download Progress & Retry Mechanism

wget https://example.com/test.tar.gz -O test.tar.gz

✅ Observed progress bar and validated retry logic for failed downloads.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants