Configuration Checks and Resource Validation for HA Configuration Validation #146
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new configuration checks framework (v2 of SAP Quality Checks) alongside significant updates to the existing functional test framework. The changes include renaming variables from snake_case to UPPER_SNAKE_CASE for consistency, adding comprehensive test coverage for new modules, and enhancing the HTML reporting template.
Key Changes
- Introduction of a new configuration checks module with comprehensive validation capabilities
- Variable naming standardization from
sap_functional_test_typetoSAP_FUNCTIONAL_TEST_TYPE - Addition of resource name separation for HANA clone vs primitive resources (SAPHanaSR-angi support)
- Enhanced HTML templates for configuration checks reporting
- New test files with over 2400 lines of comprehensive test coverage
Reviewed Changes
Copilot reviewed 65 out of 66 changed files in this pull request and generated 22 comments.
Show a summary per file
| File | Description |
|---|---|
| vars.yaml | Updated variable names and added ConfigurationChecks as new TEST_TYPE option |
| src/vars/input-api.yaml | Added configuration_test_type_map and renamed HANA resource command references |
| src/templates/azure-pipeline.yml | Renamed parameters to use UPPER_SNAKE_CASE and updated template references |
| src/templates/report.html | Added test message formatting and improved newline handling |
| src/templates/config_checks_report.html | New comprehensive HTML template for configuration checks (1603 lines) |
| src/roles/misc/tasks/*.yml | Updated to use new variable naming and added primitive resource ID support |
| src/roles/ha_db_hana/tasks/*.yml | Enhanced HANA resource handling for both clone and primitive IDs |
| src/roles/ha_db_hana/tasks/files/constants.yaml | Added azureevents resource, updated pcmk_delay_max values, restructured GLOBAL_INI |
| src/roles/ha_scs/tasks/files/constants.yaml | Updated pcmk_delay_max to support both numeric and time unit formats |
| src/roles/configuration_checks/* | New role with comprehensive configuration check framework |
| tests/* | Added extensive test coverage for new modules (3 new test files with 2300+ lines) |
| requirements.in | Added azure-mgmt-compute dependency |
…n collector and filesystem_collector modules; enhance tests by removing unnecessary assertions and print statements. (#147)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces significant documentation improvements and adds a new guide for configuration checks to the SAP Testing Automation Framework. The main changes clarify the framework’s supported scenarios, improve onboarding instructions, and provide detailed usage information for configuration validation and offline cluster validation. These updates enhance clarity for users and contributors, and better organize documentation for both high availability and configuration checks scenarios.
Documentation and Usage Improvements
README.mdhas been extensively revised to clarify supported scenarios, distinguish between High Availability Testing (GA) and Configuration Checks (Public Preview), and provide improved onboarding instructions for both standalone and SDAF-integrated setups. New sections detail key features, architecture, and test execution modes, and deprecated the prior configuration matrix in favor of scenario-driven documentation.README.mdto reference the new Configuration Checks and High Availability Testing guides, making it easier for users to find scenario-specific documentation.New and Enhanced Guides
docs/CONFIGURATION_CHECKS.mdguide has been added, providing comprehensive instructions for running SAP configuration checks, including prerequisites, access requirements, execution steps, and report viewing. This guide formalizes and extends previous quality check scripts, offering a more extensible and maintainable solution.docs/HA_OFFLINE_VALIDATION.mdguide has been rewritten for clarity, with improved explanations of offline validation, architecture, required directory structure, and step-by-step instructions for performing SAP HA cluster validation using CIB XML files. [1] [2]Configuration and Linting Updates
.ansible-lintconfiguration has been updated to exclude thesrc/roles/configuration_checks/tasks/files/directory from linting, aligning the linting process with the new configuration checks module.