Initial PR (#5)

Initial PR

---------

Co-authored-by: hdamecharla <[email protected]>

Author: devanshjainms

.ansible-lint

@@ -2,9 +2,13 @@ exclude_paths:
   - src/modules
   - src/module_utils
   - .github
+  - src/roles/ha_db_hana/tasks/files/
+  - src/roles/ha_scs/tasks/files/
 
 skip_list:
   - no-handler
+  - run-once[task]
+  - run-once[play]
   - key-order[task]
   - key-order[play]
   - name[casing]

.editorconfig

@@ -0,0 +1,40 @@
+# EditorConfig is awesome: https://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+# Python files
+[*.py]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+
+[*.{y{a,}ml}]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.{diff,md}]
+trim_trailing_whitespace = false
+insert_final_newline = false
+
+[*.{sh,bat}]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = tab

.gitattributes

@@ -0,0 +1,9 @@
+# Specific formats to always use LF
+*.py    text eol=lf
+*.yml   text eol=lf
+*.yaml  text eol=lf
+*.sh    text eol=lf
+*.cfg   text eol=lf
+
+# Retain execution permissions for scripts
+*.sh    text eol=lf diff=sh

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# This file is used to define the code owners for the repository
+
+* @Azure/azure-sap-deployment-automation

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/github-actions-ansible-lint.yml

@@ -1,5 +1,5 @@
 
-name: Pull Request - Ansible Lint and Code Coverage
+name: Pull Request - Ansible Lint
 on: [push, pull_request]
 permissions:
   contents: read
@@ -39,11 +39,3 @@ jobs:
       - name: Run ansible-lint
         run: |
           ansible-lint src/ -c .ansible-lint
-
-      # - name: Run pytest with coverage
-      #   run: |
-      #     pytest --cov=src/ --cov-report=xml tests/
-
-      - name: Check code formatting with black
-        run: |
-          black --check src/ --config pyproject.toml

.github/workflows/github-actions-code-coverage.yml

@@ -0,0 +1,35 @@
+
+name: Pull Request - Code Coverage
+on: [push, pull_request]
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Harden Runner
+        uses: step-security/harden-runner@cb605e52c26070c328afc4562f0b4ada7618a84e # v2.10.4
+        with:
+          egress-policy: audit
+
+      - name: Checkout the code
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 #v4.2.2
+
+      - name: Setup Python
+        uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 #v5.4.0
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Run pytest with coverage
+        run: |
+          pytest --cov=src/ --cov-fail-under=85 --cov-report=xml tests/
+
+      - name: Check code formatting with black
+        run: |
+          black --check src/ tests/ --config pyproject.toml

.pre-commit-config.yaml

@@ -0,0 +1,6 @@
+repos:
+- repo: https://github.com/psf/black
+  rev: 23.12.1
+  hooks:
+  -   id: black
+      args: [--check, --diff]

README.md

@@ -1,64 +1,75 @@
 # SAP Testing Automation Framework
 
-## Overview
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Azure](https://img.shields.io/badge/Microsoft-SAP%20on%20Azure-0078D4?logo=microsoft)](https://docs.microsoft.com/azure/sap)
+[![Python Coverage](https://img.shields.io/badge/Code%20Coverage-85%25-success?logo=python&logoColor=white)](https://github.com/Azure/sap-automation-qa/actions/workflows/github-actions-code-coverage.yml)
+[![Ansible Lint](https://github.com/Azure/sap-automation-qa/actions/workflows/github-actions-ansible-lint.yml/badge.svg)](https://github.com/Azure/sap-automation-qa/actions/workflows/github-actions-ansible-lint.yml)
+[![OpenSSF Scorecard](https://img.shields.io/ossf-scorecard/github.com/Azure/sap-automation-qa)](https://scorecard.dev/viewer/?uri=github.com/Azure/sap-automation-qa)
 
-The SAP Testing Automation Framework is a automation solution designed to validate the configuration and performance of SAP systems on Azure under a wide array of scenarios. This framework not only streamlines the testing of SAP environments but also brings confidence and assurance by simulating real-world conditions.
 
-Currently, the framework offers test scenarios focusing on high availability functional testing and configuration checks. Under the high availability category, we address critical components including:
+## 🔍 Overview
 
-- **SAP HANA Database HA Configurations:** Validate SAP HANA database configurations, ensuring resilience, rapid failover, and optimal performance even in adverse conditions.
-- **SAP Central Services (SCS/ERS) HA Setups:** Test and verify the configuration integrity and robustness of SAP Central Services, including load balancing, failover mechanisms, and component interoperability.
+The SAP Testing Automation Framework is an open-source orchestration tool for validating SAP deployments on Microsoft Azure. This framework systematically evaluates system configuration, performance, and resilience across diverse operational scenarios, providing organizations with actionable insights and quantifiable results. Through thorough testing, the framework helps SAP admins ensure their environments meet performance benchmarks and availability requirements. By simulating real conditions in controlled environments, admins can identify potential issues before they affect production systems.
 
-By integrating comprehensive monitoring, detailed logging, and automated evaluation, our framework transforms how organizations maintain and enhance the reliability of their SAP landscapes on Azure.
+The framework incorporates advanced monitoring capabilities, detailed analytical reporting, and fully automated evaluation processes, delivering significant operational efficiencies while enhancing the overall reliability of SAP landscapes on Azure.
 
-### Purpose
+### 📊 Key Features
 
-Testing is crucial for maintaining business continuity in SAP environments. This framework addresses several critical needs:
+- **High Availability Testing** - Comprehensive validation of failover mechanisms for both SAP HANA database clusters and Central Services components, ensuring business continuity under adverse conditions. Currently, the framework offers test scenarios focusing on high availability functional testing and configuration checks. Under the high availability category, we address critical components including:
 
-**Risk Mitigation**:
+  - **SAP HANA Database HA Configurations:** Validate SAP HANA database configurations, ensuring resilience, rapid failover, and optimal performance even in adverse conditions.
+  
+  - **SAP Central Services (SCS/ERS) HA Setups:** Test and verify the configuration integrity and robustness of SAP Central Services, including load balancing, failover mechanisms, and component interoperability.
+
+- **Configuration Validation** - Systematic assessment of SAP system configurations against established best practices and Microsoft-recommended architecture standards to ensure optimal deployment.
+
+- **Detailed Reporting** - Generation of comprehensive test result documentation with analytical summaries and specific remediation guidance for identified issues.
+
+### 🏆 Purpose
+
+Testing is essential for ensuring business continuity in mission-critical SAP environments. This framework systematically addresses the following critical business needs:
+
+- **Risk Mitigation**:
 The framework provides systematic testing of failure scenarios, helping organizations identify and address potential issues before they impact production systems. It simulates various failure modes, including node failures, network interruptions, and storage issues, ensuring that recovery mechanisms function as designed.
 
-**Compliance**:
+- **Compliance**:
 Organizations must often demonstrate that their SAP systems meet specific availability requirements. This framework provides documented evidence of HA testing, including detailed logs and reports that can be used for audit purposes. It helps ensure that HA implementations align with organizational standards and regulatory requirements.
 
-**Quality Assurance**:
+- **Quality Assurance**:
 Through automated and consistent testing procedures, the framework helps maintain high quality standards across SAP infrastructure components. It validates that all HA mechanisms, including clustering software, storage replication, and application-level failover, work together seamlessly.
 
-**Automation**:
+- **Automation**:
 Manual testing of HA configurations is time-consuming and prone to human error. This framework automates the entire testing process, from setup to execution and reporting, significantly reducing the operational overhead of HA testing while improving accuracy and consistency.
 
-## Get Started
+## 🚦 Get Started
 
 There are two primary ways to get started with the SAP Testing Automated Framework. Choose the path that best fits your current environment and objectives:
 
-### [Integration with SAP Deployment Automation Framework (SDAF)](./docs/SDAF_INTEGRATION.md)
+### Option 1: [Integration with SAP Deployment Automation Framework (SDAF)](./docs/SDAF_INTEGRATION.md)
 
 If you already have [SDAF](https://github.com/Azure/sap-automation) environment set up, integrating the SAP Testing Automation Framework is a natural extension that allows you to leverage existing deployment pipelines and configurations.
 
-### [Getting Started with High Availability Testing (Standalone)](./docs/GETTING_STARTED.md)
+### Option 2: [Getting Started with High Availability Testing (Standalone)](./docs/HIGH_AVAILABILITY.md)
 
 For users focused solely on validating SAP functionality and configurations, the standalone approach offers a streamlined process to test critical SAP components without the complexity of full deployment integration.
 
+### 🏗️ [Architecture and Components](./docs/ARCHITECTURE.md)
 
-### [Architecture and Components](./docs/ARCHITECTURE.md)
+Curious about how it all works? Check out our detailed architecture documentation.
 
-## License
+## 🆘Support
 
-Copyright (c) Microsoft Corporation.
-Licensed under the MIT License.
+For support and questions, please:
 
-## Support
+1. Check [existing issues](https://github.com/Azure/sap-automation-qa/issues/)
+2. Create new issue if needed and provide detailed information about the problem
 
-For support and questions, please:
-1. Check existing issues
-2. Create new issue if needed
-3. Provide detailed information about the problem
+## 📚 Additional Resources
 
-## Additional Resources
 - [Azure SAP Documentation](https://docs.microsoft.com/azure/sap)
 - [SAP on Azure: High Availability Guide](https://docs.microsoft.com/azure/sap/workloads/sap-high-availability-guide-start)
 
-## Contributing
+## 🤝 Contributing
 
 This project welcomes contributions and suggestions.  Most contributions require you to agree to a
 Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
@@ -72,7 +83,14 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
 For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
 contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
 
-## Trademarks
+## ⚖️ Legal
+
+### License
+
+> Copyright (c) Microsoft Corporation.
+> Licensed under the MIT License.
+
+### Trademarks
 
 This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
 trademarks or logos is subject to and must follow