Enhance SCS cluster status tests with additional resource attributes

[devanshjainms]

This pull request introduces several updates across workflows, configuration files, and documentation to enhance functionality, improve test coverage, and ensure compatibility with the latest tools. The changes include updates to CodeQL actions, the addition of new configuration parameters, and extensive updates to high availability (HA) test cases and pseudocode documentation.

Workflow Updates:

• .github/workflows/codeql.yml, .github/workflows/ossf-scoreboard.yml, .github/workflows/trivy.yml: Updated CodeQL action versions from v3.28.15 to v3.28.16 for init, autobuild, analyze, and upload-sarif steps to ensure compatibility with the latest security analysis tools. [1] [2] [3]

Configuration Enhancements:

• WORKSPACES/SYSTEM/DEV-WEEU-SAP01-X00/sap-parameters.yaml: Added optional parameters for Azure Key Vault (key_vault_id and secret_id) and user-assigned managed identity (user_assigned_identity_client_id) to support secure credential management and identity authentication.

Documentation Improvements:

High Availability Test Cases:

• docs/SCS_HIGH_AVAILABILITY.md: Added new HA test cases, including Azure Load Balancer configuration, SAPControl validation, and various process-specific failure simulations (e.g., message server, enqueue server). Enhanced the descriptions of existing tests for better clarity.

Pseudocode for Test Scenarios:

• Introduced detailed pseudocode for new and existing HA test scenarios, such as:
  • block-network.md: Extended pseudocode for ASCS-specific network block scenarios.
  • ha-failover-to-node.md: Added pseudocode for controlled failover tests using SAP's built-in HA functionality.
  • kill-message-server.md: Detailed pseudocode for simulating message server and other process failures (enqueue, enqueue replication, sapstartsrv).
  • manual-restart.md: Added pseudocode for manual ASCS instance restart tests.
  • node-crash.md: Extended pseudocode for ASCS node crash scenarios.
  • resource-migration.md: Added ASCS-specific pseudocode for resource migration tests.

Telemetry Configuration:

• docs/SDAF_INTEGRATION.md: Updated telemetry configuration instructions to include detailed steps for setting up Azure Log Analytics and Azure Data Explorer as telemetry destinations.

[Copilot]

Pull Request Overview

This pull request enhances the SCS cluster status tests and overall HA test coverage by updating resource attribute processing, modifying configuration parameters for secure credential management, and adding extensive pseudocode documentation for various HA scenarios. Key changes include:

• Renaming and updating parameter names for improved clarity in cluster status processing.
• Adding support for user-assigned Managed Identity in the Azure load balancer module and updating CodeQL action versions.
• Enhancing documentation with new pseudocode test cases and telemetry configuration details.

Reviewed Changes

Copilot reviewed 79 out of 81 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/modules/get_cluster_status_db.py	Updated parameter naming and XML parsing logic in node attribute processing.
src/modules/get_azure_lb.py	Added optional MSI client ID parameter and refined error messages for authentication and load balancer retrieval.
src/modules/filesystem_freeze.py	Updated module options and examples to include the database SID for proper filesystem identification.
src/module_utils/get_cluster_status.py	Consistently updated function parameter names used in cluster status validation.
docs/pseudocode/*.md	Added extensive new pseudocode tests covering SAPControl, resource migration, node crash, manual restart, process kill, and network block scenarios.
docs/SDAF_INTEGRATION.md	Updated telemetry configuration instructions with detailed examples and guidance for both Azure Log Analytics and Data Explorer.
docs/SCS_HIGH_AVAILABILITY.md	Revised HA test case table to reflect new tests and configuration updates.
.github/workflows/*.yml	Upgraded CodeQL action versions across workflow files.
WORKSPACES/SYSTEM/DEV-WEEU-SAP01-X00/sap-parameters.yaml	Introduced optional Key Vault and MSI client ID parameters for secure credential management.

Files not reviewed (2)

• requirements.in: Language not supported
• scripts/sap_automation_qa.sh: Language not supported

Comments suppressed due to low confidence (1)

src/modules/get_azure_lb.py:193

• [nitpick] Consider using a consistent error logging strategy for authentication failures, such as using a complete f-string or a dedicated logging function, to reduce duplication and improve clarity.

self.result["message"] += (" Failed to authenticate to Azure to read the Load " + f"Balancer Details. {ex} \n")

[hdamecharla]

Approved

[dhruvmicrosoft]

LG!