Add script to automate RS org settings updates for local testing

[basiliskus]

Script to automate the RS Setup step to edit the organization YAML files in RS

The script uses yq to update the organization settings YAML files in RS to:

• use local REST transport settings for Flexion's etor-service-receiver receivers
• use local SFTP transport settings for Flexion's simulated-hospital and simulated-lab receivers
• use local SFTP transport settings for partner organizations

Issue

#1488

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ 1488 - Fully compliant Fully compliant requirements: Add script to automate updating RS org settings for local testing

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Hardcoded URLs The script contains hardcoded URLs for token and report endpoints, which might not be suitable for all environments. Hardcoded File Paths The script uses hardcoded file paths for SFTP uploads, which could lead to issues if the directory structure changes or is different in other environments.

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Best practice	Add a check to ensure the 'yq' command is available before running the script Ensure that the yq command is installed and available in the script's environment to avoid runtime errors. You can add a check at the beginning of the script to verify this and provide a clear error message if yq is not found. scripts/rs/update_org_yaml.sh [1] #!/bin/bash +if ! command -v yq &> /dev/null +then + echo "yq could not be found. Please install yq to run this script." + exit 1 +fi ... Suggestion importance[1-10]: 8 Why: This suggestion is crucial for ensuring the script runs successfully in environments where 'yq' might not be installed, preventing runtime errors and improving user experience.	8
	Implement error handling for the 'yq' command to manage failures gracefully Add error handling for the yq command to manage any failures during the YAML file updates, such as permission issues or malformed YAML content. scripts/rs/update_org_yaml.sh [4-20] -yq eval '.[0].receivers[] |= ( +if ! yq eval '.[0].receivers[] |= ( ... -)' -i settings/STLTs/Flexion/flexion.yml +)' -i settings/STLTs/Flexion/flexion.yml; then + echo "Failed to update YAML file." + exit 1 +fi Suggestion importance[1-10]: 7 Why: Adding error handling for the 'yq' command is important to manage potential failures like permission issues or malformed YAML, which enhances the robustness of the script.	7
	Use absolute paths for file operations to avoid path-related errors Consider using absolute paths for the YAML files being modified or ensure the script is always run from a consistent directory to prevent path-related errors. scripts/rs/update_org_yaml.sh [4-20] yq eval '.[0].receivers[] |= ( ... -)' -i settings/STLTs/Flexion/flexion.yml +)' -i /absolute/path/to/settings/STLTs/Flexion/flexion.yml Suggestion importance[1-10]: 6 Why: Using absolute paths can indeed prevent errors related to the current working directory, which is a good practice, especially for scripts that might be run from different locations.	6
Maintainability	Encapsulate the loop body in a function for better readability and maintainability Wrap the loop body in a function to improve readability and maintainability of the script, especially if the loop or its body grows in complexity. scripts/rs/update_org_yaml.sh [23-30] -for file in settings/STLTs/CA/ucsd.yml settings/STLTs/LA/la-ochsner.yml settings/STLTs/LA/la-phl.yml; do +update_yaml() { yq eval '.[0].receivers[] |= select(.name == "etor-nbs-results" or .name == "etor-nbs-orders").transport = { ... - }' -i "$file" + }' -i "$1" +} +for file in settings/STLTs/CA/ucsd.yml settings/STLTs/LA/la-ochsner.yml settings/STLTs/LA/la-phl.yml; do + update_yaml "$file" done Suggestion importance[1-10]: 5 Why: Wrapping the loop body in a function can improve readability and maintainability, especially if the script grows in complexity, although the current complexity does not make this critical.	5

[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

[halprin]

Wow, that's for sure some yq dark magic.