Refactoring of hurl scripts

[basiliskus]

Refactoring of hurl scripts

• Renamed message_submission_utils.sh => utils.sh
• Refactored hrl scripts to use functions and reuse code in utils.sh
• Moved and renamed hrl scripts
  • rs/hrl => rs.sh
  • ti/hrl => ti.sh
  • epic/hrl => epic.sh
• Consolidated readme files into one
• Refactored submit_message.sh to extract reusable code and add argument to pass environment
• Refactored rs.sh and ti.sh scripts to handle deployed env and change parameters and naming for consistency
• Added error handling for hurl calls and user prompt for outbound submission id when not possible to get from metadata API in deployed env

Issue

#1485

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review File Path Hardcoding The script hardcodes the path to the hurl file which might lead to issues if the directory structure changes or if the script is run from a different directory. Script Argument Handling The script modifies the argument list which could lead to unexpected behavior if not properly documented or understood by users.

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Possible bug	Check for the existence of the script file before execution to prevent errors Ensure that the epic/results.hurl script file exists at the specified path to avoid runtime errors. scripts/hurl/epic.sh [12] -epic/results.hurl +[ -f epic/results.hurl ] || { echo "Error: epic/results.hurl does not exist."; exit 1; } Suggestion importance[1-10]: 7 Why: This suggestion is relevant as it ensures the existence of the 'epic/results.hurl' script before execution, preventing runtime errors. This is a practical and necessary check for robust script execution.	7
	Ensure the directory exists before using it in script paths Validate the existence of the directory rs/ before attempting to assign files from it to avoid script failures. scripts/hurl/rs.sh [47] +[ -d rs/ ] || { echo "Error: rs/ directory does not exist."; exit 1; } hurl_file=rs/"$1" Suggestion importance[1-10]: 7 Why: The suggestion to check for the existence of the 'rs/' directory before using it in the script path is valid and enhances the script's reliability by preventing errors related to non-existent directories.	7
	Check if the script is executable and exists before attempting to execute it Ensure that the rs.sh script is executable and exists in the expected path to prevent runtime errors when calling it. scripts/hurl/message_submission_utils.sh [41] +[ -x ./rs.sh ] || { echo "Error: rs.sh is not executable or missing."; exit 1; } history_response=$(./rs.sh history.hurl -i "$submission_id") Suggestion importance[1-10]: 7 Why: This suggestion is crucial as it ensures that the 'rs.sh' script is executable and exists before it is called. This check prevents runtime errors and enhances the script's reliability when integrating with other components.	7

[basiliskus]

/review

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ 1485 - Fully compliant Fully compliant requirements: Refactor and improve scripts in /scripts/hurl so submit_message.sh can handle message submission and tracking in staging and potentially other deployed environments

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

🧪 No relevant tests

🔒 Security concerns Sensitive information exposure: The script contains hardcoded secrets for Azure connection strings which could lead to security vulnerabilities if exposed. This is found in scripts/hurl/utils.sh.

⚡ Recommended focus areas for review Hardcoded Secrets The script contains hardcoded secrets for Azure connection strings which could lead to security vulnerabilities if exposed. Error Handling The error handling in the script does not differentiate between different types of errors, which could lead to misleading error messages or improper error resolution.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[pluckyswan]

Might've missed it or just be out of the loop on what's changed, but did the MSH Header replacement get removed?

[basiliskus]

Might've missed it or just be out of the loop on what's changed, but did the MSH Header replacement get removed?

Yes, it's not needed anymore. We're now routing internal tests with MSH-11 instead of MSH-6.2