feat: python default module packages

marcelmamula · marcelmamula · commit 2631c71794f0 · 2025-04-01T15:59:58.000+02:00
diff --git a/roles/sap_software_download/README.md b/roles/sap_software_download/README.md
@@ -8,6 +8,22 @@ The Ansible Role `sap_software_download` is used to download SAP Software Media
 <!-- END Description -->
 
 <!-- BEGIN Dependencies -->
+## Dependencies
+This role requires the following Python modules to be installed on the target node (the machine where SAP software will be downloaded):
+
+- wheel
+- urllib3
+- requests
+- beautifulsoup4
+- lxml
+
+The role installs these modules if they are not already present. Installation can be done in one of the following ways:
+
+- **Virtual Environment (Default):**
+  - When `sap_software_download_use_venv` is `true` (default), a temporary virtual environment is created, and modules are installed via `pip`.
+  - The Python version is determined by `sap_software_download_python_interpreter`.
+- **System Environment:**
+  - When `sap_software_download_use_venv` is `false`, modules are installed directly into the system's Python environment using OS packages specified by `sap_software_download_python_module_packages`.
 <!-- END Dependencies -->
 
 <!-- BEGIN Prerequisites -->
@@ -34,13 +50,14 @@ The target node must meet the following requirements:
 2.  **Python Environment Preparation:** The role prepares the Python environment:
     *   **Virtual Environment (Default):** A temporary Python virtual environment is created, and all necessary dependencies are installed within it.
     *   **System Environment:** Alternatively, if `sap_software_download_use_venv` is set to `false`, dependencies are installed directly into the system's default Python environment.
-3.  **Maintenance Plan File List:** If the `sap_software_download_mp_transaction` variable is provided, the role retrieves the list of files associated with the specified Maintenance Plan transaction.
-4.  **File Relationship Validation:** If `sap_software_download_validate_relationships` is `true`, the role performs validation checks on the relationships between the files to be downloaded.
+3.  **Validate provided S-User credentials** The role will search for `SAPCAR` file to validate credentials and download authorization. 
+4.  **Maintenance Plan File List:** If the `sap_software_download_mp_transaction` variable is provided, the role retrieves the list of files associated with the specified Maintenance Plan transaction.
+5.  **File Relationship Validation:** If `sap_software_download_validate_relationships` is `true`, the role performs validation checks on the relationships between the files to be downloaded.
     *   **Alternative File Search:** If `sap_software_download_find_alternatives` is `true`, the role will search for alternative files if the requested files are not found.
     *   More information about validation logic is available at [Explanation of relationship validation logic](#explanation-of-relationship-validation-logic)
-5.  **Maintenance Plan File Download:** If `sap_software_download_mp_transaction` is provided, the role downloads the files associated with the Maintenance Plan.
-6.  **Direct File Download:** If `sap_software_download_files` is provided, the role downloads the specified files.
-7.  **Virtual Environment Cleanup:** If a temporary Python virtual environment was used, it is removed.
+6.  **Maintenance Plan File Download:** If `sap_software_download_mp_transaction` is provided, the role downloads the files associated with the Maintenance Plan.
+7.  **Direct File Download:** If `sap_software_download_files` is provided, the role downloads the specified files.
+8.  **Virtual Environment Cleanup:** If a temporary Python virtual environment was used, it is removed.
 
 <!-- END Execution Flow -->
 
@@ -81,6 +98,62 @@ Download of SAP Software files using Maintenance Plan
         sap_software_download_directory: "/software"
         sap_software_download_mp_transaction: 'Transaction Name or Display ID from Maintenance Planner'
 ```
+
+Combined download of SAP Software files and Maintenance Plan transaction together with settings:
+- Use default Python instead of Python virtual environment
+- No validation of S-User credentials
+- No validation of relationships
+- No warnings for unavailable files
+- No warnings for unavailable Maintenance Plan transaction
+```yaml
+- name: Ansible Play for downloading SAP Software
+  hosts: localhost
+  become: true
+  tasks:
+    - name: Include role sap_software_download
+      ansible.builtin.include_role:
+        name: community.sap_launchpad.sap_software_download
+      vars:
+        sap_software_download_suser_id: "Enter SAP S-User ID"
+        sap_software_download_suser_password: "Enter SAP S-User Password"
+        sap_software_download_directory: "/software"
+        sap_software_download_use_venv: false
+        sap_software_download_ignore_validate_credentials: true
+        sap_software_download_ignore_file_not_found: true
+        sap_software_download_ignore_plan_not_found: true
+        sap_software_download_validate_relationships: false
+        sap_software_download_deduplicate: first
+        sap_software_download_files:
+          - 'SAPCAR_1115-70006178.EXE'
+          - 'SAPEXE_100-80005509.SAR'
+        sap_software_download_mp_transaction: 'Transaction Name or Display ID from Maintenance Planner'
+```
+Download of SAP Software files using Python version `3.13`.
+```yaml
+---
+- name: Ansible Play for downloading SAP Software
+  hosts: localhost
+  become: true
+  tasks:
+    - name: Include role sap_software_download
+      ansible.builtin.include_role:
+        name: community.sap_launchpad.sap_software_download
+      vars:
+        sap_software_download_python_interpreter: python3.13
+        sap_software_download_python_package: python313
+        sap_software_download_python_module_packages:
+          - python313-wheel
+          - python313-urllib3
+          - python313-requests
+          - python313-beautifulsoup4
+          - python313-lxml
+        sap_software_download_suser_id: "Enter SAP S-User ID"
+        sap_software_download_suser_password: "Enter SAP S-User Password"
+        sap_software_download_directory: "/software"
+        sap_software_download_files:
+          - 'SAPCAR_1115-70006178.EXE'
+          - 'SAPEXE_100-80005509.SAR'
+```
 <!-- END Execution Example -->
 
 <!-- BEGIN Role Tags -->
@@ -93,20 +166,20 @@ Validation is executed for known combinations of files, where we can validate th
 Example for SAP HANA Database Server 2.0 with LCAPPS and AFL.<br>
 
 1. All files are examined, and a file starting with `IMDB_SERVER2` is found: `IMDB_SERVER20_084_0-80002031.SAR (Revision 2.00.084.0 (SPS08))`. This indicates a SAP HANA 2.0 database server file.
-2. The HANA version and revision are extracted from the file name: `HANA 2.0`, `Revision 084`.
+2. The HANA version and revision are extracted from the file name: `HANA 2.0`, `Version 084`.
 3. Validation for HANA 1.0 is skipped because it expects files starting with `IMDB_SERVER1`. The following steps are only for `IMDB_SERVER2` (HANA 2.0).
 4. All files are examined for files starting with `IMDB_LCAPPS_2` (indicating LCAPPS for HANA 2.0). Then the list is filtered to only include files starting with `IMDB_LCAPPS_2084` (indicating LCAPPS for HANA 2.0 revision 084).
 5. Validation will have two outcomes:
    - A file like `IMDB_LCAPPS_2084_0-20010426.SAR` is present. In this case, validation will pass because the LCAPPS version is compatible with the HANA revision.
    - No file starting with `IMDB_LCAPPS_2084` is present, but there are files starting with `IMDB_LCAPPS_2`.<br>
      This indicates a mismatch because the LCAPPS version is not compatible with the specific HANA revision (084) found in step 2.<br>
-     In this case, validation will fail. This can be prevented by setting `sap_software_download_ignore_relationship_warning` to `true`.
+     In this case, validation will fail. This can be ignored by setting `sap_software_download_ignore_relationship_warning` to `true`.
 6. All files are examined for files starting with `IMDB_AFL20` (indicating AFL for HANA 2.0). Then the list is filtered to only include files starting with `IMDB_AFL20_084` (indicating AFL for HANA 2.0 revision 084).
 7. Validation will have two outcomes:
    - A file like `IMDB_AFL20_084_1-80001894.SAR` is present. In this case, validation will pass because the AFL version is compatible with the HANA revision.
    - No file starting with `IMDB_AFL20_084` is present, but there are files starting with `IMDB_AFL20`.<br>
      This indicates a mismatch because the AFL version is not compatible with the specific HANA revision (084) found in step 2.<br>
-     In this case, validation will fail. This can be prevented by setting `sap_software_download_ignore_relationship_warning` to `true`.
+     In this case, validation will fail. This can be ignored by setting `sap_software_download_ignore_relationship_warning` to `true`.
 
 This validation example checks major and minor release (SPS and Revision), but it does not validate patch version.
 <!-- END Further Information -->
@@ -125,6 +198,7 @@ Apache 2.0
 <!-- BEGIN Role Variables -->
 ### sap_software_download_python_interpreter
 - _Type:_ `string`<br>
+- _Default:_ **Determined by the operating system.**<br>
 
 The Python interpreter executable to use when creating a Python virtual environment.<br>
 **Mandatory** when `sap_software_download_use_venv` is `true`.<br>
@@ -134,12 +208,25 @@ Examples: `python3.11` (SUSE), `python3.9` (Red Hat)<br>
 
 ### sap_software_download_python_package
 - _Type:_ `string`<br>
+- _Default:_ **Determined by the operating system.**<br>
 
 The name of the OS package that provides the desired Python version.<br>
 The Python version provided by this package must match the version specified by `sap_software_download_python_interpreter`.<br>
 The default value is determined by the operating system and is set in the corresponding OS-specific variables file.<br>
 Examples: `python311` (SUSE), `python3.9` (Red Hat)<br>
 
+### sap_software_download_python_module_packages
+- _Type:_ `list` with elements of type `string`<br>
+- _Default:_ **Determined by the operating system.**<br>
+
+The list of the OS packages that provide modules for the desired Python version.<br>
+Required modules are wheel, urllib3, requests, beautifulsoup4, lxml<br>
+The listed package versions must match the Python version specified by `sap_software_download_python_interpreter`.<br>
+The default value is determined by the operating system and is set in the corresponding OS-specific variables file.<br>
+Examples:<br>
+- `['python311-wheel', 'python311-urllib3', 'python311-requests', 'python311-beautifulsoup4', 'python311-lxml']` (SUSE)<br>
+- `['python3.9-wheel', 'python3.9-urllib3', 'python3.9-requests', 'python3.9-beautifulsoup4', 'python3.9-lxml']` (Red Hat)<br>
+
 ### sap_software_download_use_venv
 - _Type:_ `boolean`<br>
 - _Default:_ `true`<br>
diff --git a/roles/sap_software_download/defaults/main.yml b/roles/sap_software_download/defaults/main.yml
@@ -16,6 +16,15 @@ sap_software_download_python_interpreter:
 sap_software_download_python_package:
   "{{ __sap_software_download_python_package }}"
 
+# The list of the OS packages that provide modules for the desired Python version.
+# Required modules: wheel, urllib3, requests, beautifulsoup4, lxml
+# The listed package versions must match the Python version specified by `sap_software_download_python_interpreter`.
+# The default value is determined by the operating system and is set in the corresponding OS-specific variables file. Examples:
+# python311-wheel, python311-urllib3, python311-requests, python311-beautifulsoup4, python311-lxml (SUSE)
+# python3.9-wheel, python3.9-urllib3, python3.9-requests, python3.9-beautifulsoup4, python3.9-lxml (Red Hat)
+sap_software_download_python_module_packages:
+  "{{ __sap_software_download_python_module_packages }}"
+
 # Determines whether to execute the role within a Python virtual environment.
 # Using a virtual environment is strongly recommended to isolate dependencies.
 # If set to `false`, the role will install Python dependencies directly into the system's Python environment.
diff --git a/roles/sap_software_download/meta/argument_spec.yml b/roles/sap_software_download/meta/argument_spec.yml
@@ -25,13 +25,25 @@ argument_specs:
 
       sap_software_download_python_package:
         type: str
-        required: true
+        required: false
         description:
           - The name of the OS package that provides the desired Python version.
           - The Python version provided by this package must match the version specified by `sap_software_download_python_interpreter`.
           - The default value is determined by the operating system and is set in the corresponding OS-specific variables file.
           - Examples are `python311` (SUSE), `python3.9` (Red Hat)
 
+      sap_software_download_python_module_packages:
+        type: list
+        elements: str
+        required: false
+        description:
+          - The list of the OS packages that provide modules for the desired Python version.
+          - Required modules are wheel, urllib3, requests, beautifulsoup4, lxml
+          - The listed package versions must match the Python version specified by `sap_software_download_python_interpreter`.
+          - The default value is determined by the operating system and is set in the corresponding OS-specific variables file. Examples are
+          - python311-wheel, python311-urllib3, python311-requests, python311-beautifulsoup4, python311-lxml (SUSE)
+          - python3.9-wheel, python3.9-urllib3, python3.9-requests, python3.9-beautifulsoup4, python3.9-lxml (Red Hat)
+
       sap_software_download_use_venv:
         type: bool
         required: false
diff --git a/roles/sap_software_download/tasks/pre_steps/01_include_variables.yml b/roles/sap_software_download/tasks/pre_steps/01_include_variables.yml
@@ -34,7 +34,7 @@
 - name: Pre-Steps - Assert that SAP Software files were specified
   ansible.builtin.assert:
     that:
-      - (sap_software_download_files is defined and sap_software_download_files | length > 0)
+      - (sap_software_download_files is defined and sap_software_download_files | type_debug == 'list' and sap_software_download_files | length > 0)
         or (sap_software_download_mp_transaction is defined and sap_software_download_mp_transaction | length > 0)
     fail_msg: |
       Neither `sap_software_download_files` or `sap_software_download_mp_transaction` are valid.
@@ -76,6 +76,16 @@
       Empty variable `sap_software_download_python_package`.
       Ensure that it contains correct Python package name or revert back to defaults. 
 
+- name: "Pre-Steps - Verify variable: sap_software_download_python_module_packages"
+  ansible.builtin.assert:
+    that:
+      - sap_software_download_python_module_packages is defined
+      - sap_software_download_python_module_packages | type_debug == 'list'
+      - sap_software_download_python_module_packages | length > 0
+    fail_msg: |
+      Empty variable `sap_software_download_python_module_packages`.
+      Ensure that it contains correct list of Python module package names or revert back to defaults. 
+
 - name: "Pre-Steps - Verify variable: sap_software_download_suser_id"
   ansible.builtin.assert:
     that:
diff --git a/roles/sap_software_download/tasks/pre_steps/02_prepare_python_environment.yml b/roles/sap_software_download/tasks/pre_steps/02_prepare_python_environment.yml
@@ -35,6 +35,9 @@
 - name: Pre-Steps - Block for default Python preparation
   when: not sap_software_download_use_venv | d(true)
   block:
-    - name: Pre-Steps - Install Python modules in default Python
-      ansible.builtin.pip:
-        name: "{{ __sap_software_download_python_modules }}"
+    # Packages with python modules are installed instead of modules to avoid error:
+    # `externally-managed-environment` which requires `--break-system-packages`
+    - name: Pre-Steps - Install Python module packages
+      ansible.builtin.package:
+        name: "{{ __sap_software_download_python_module_packages }}"
+        state: present
diff --git a/roles/sap_software_download/vars/RedHat.yml b/roles/sap_software_download/vars/RedHat.yml
@@ -11,3 +11,12 @@ __sap_software_download_python_interpreter: 'python3.9'
 
 # Set which Python package will be installed on destination node.
 __sap_software_download_python_package: 'python3.9'
+
+# The list of required Python Modules in packages
+# This is required in order to avoid externally-managed-environment error.
+__sap_software_download_python_module_packages:
+  - python3.9-wheel
+  - python3.9-urllib3
+  - python3.9-requests
+  - python3.9-beautifulsoup4
+  - python3.9-lxml
diff --git a/roles/sap_software_download/vars/RedHat_10.yml b/roles/sap_software_download/vars/RedHat_10.yml
@@ -10,3 +10,12 @@ __sap_software_download_python_interpreter: 'python3.12'
 
 # Set which Python package will be installed on destination node.
 __sap_software_download_python_package: 'python3.12'
+
+# The list of required Python Modules in packages
+# This is required in order to avoid externally-managed-environment error.
+__sap_software_download_python_module_packages:
+  - python3.12-wheel
+  - python3.12-urllib3
+  - python3.12-requests
+  - python3.12-beautifulsoup4
+  - python3.12-lxml
diff --git a/roles/sap_software_download/vars/Suse.yml b/roles/sap_software_download/vars/Suse.yml
@@ -23,3 +23,24 @@ __sap_software_download_python_package: >-
   {%- else -%}
     python311
   {%- endif -%}
+
+# The list of required Python Modules in packages
+# This is required in order to avoid externally-managed-environment error.
+__sap_software_download_python_module_packages: >-
+    {%- if ansible_distribution_major_version == '15' and ansible_distribution_version.split('.')[1] | int < 5 -%}
+    [
+      "python3-wheel",
+      "python3-urllib3",
+      "python3-requests",
+      "python3-beautifulsoup4",
+      "python3-lxml"
+    ]
+    {%- else -%}
+    [
+      "python311-wheel",
+      "python311-urllib3",
+      "python311-requests",
+      "python311-beautifulsoup4",
+      "python311-lxml"
+    ]
+    {%- endif -%}
diff --git a/roles/sap_software_download/vars/main.yml b/roles/sap_software_download/vars/main.yml
@@ -8,3 +8,13 @@ __sap_software_download_python_modules:
   - requests
   - beautifulsoup4
   - lxml
+
+# The list of required Python Modules in packages
+# This is required in order to avoid externally-managed-environment error.
+# Specific packages are available in OS specific var files
+__sap_software_download_python_module_packages:
+  - python3-wheel
+  - python3-urllib3
+  - python3-requests
+  - python3-beautifulsoup4
+  - python3-lxml
