feat: response error handling, SPS version, verbosity, plan debug

Author: marcelmamula

plugins/module_utils/sap_api_common.py

@@ -37,9 +37,23 @@ def _request(url, **kwargs):
     method = 'POST' if kwargs.get('data') or kwargs.get('json') else 'GET'
     res = https_session.request(method, url, **kwargs)
 
-    if (res.status_code == 403
-            and res.json()['errorMessage'].startswith('Account Temporarily Locked Out')):
-        raise Exception('SAP ID Service has reported `Account Temporarily Locked Out`. Please reset password to regain access and try again.')
+    # Validating against `res.text` can cause long execution time, because fuzzy search result can contain large `res.text`.
+    # This can be prevented by validating `res.status_code` check before `res.text`.
+    # Example: 'Two-Factor Authentication' is only in `res.text`, which can lead to long execution.
+
+    if res.status_code == 403:
+        if 'You are not authorized to download this file' in res.text:
+            raise Exception(f'You are not authorized to download this file.')
+        elif 'Account Temporarily Locked Out' in res.text:
+            raise Exception(f'Account Temporarily Locked Out. Please reset password to regain access and try again.')
+        else:
+            res.raise_for_status()
+
+    if res.status_code == 404:
+        if 'The file you have requested cannot be found' in res.text:
+            raise Exception(f'The file you have requested cannot be found.')
+        else:
+            res.raise_for_status()
 
     res.raise_for_status()
 

roles/sap_software_download/meta/main.yml

@@ -0,0 +1,20 @@
+# SPDX-License-Identifier: Apache-2.0
+---
+galaxy_info:
+  namespace: community
+  author: SUSE, Marcel Mamula
+  description: Downloads SAP Software Media from SAP using an S-User ID and password, supporting both direct file downloads and Maintenance Plan transactions.
+  company: SUSE
+  license: Apache-2.0
+  min_ansible_version: 2.16
+  platforms:
+    - name: EL
+      versions: ["7", "8", "9"]
+    - name: SLES
+      versions: ["15", "16"]
+  galaxy_tags:
+    - sap
+    - download
+    - suse
+    - redhat
+dependencies: []

roles/sap_software_download/tasks/download_plan.yml

@@ -51,7 +51,7 @@
 - name: Download - Maintenance Plan - Show failed results
   ansible.builtin.fail:
     msg: |
-      Maintenance Plan file(s) not found:  {{ __failed_items | map(attribute='Filename') | list | join(', ') }}
+      Maintenance Plan file(s) not found:  {{ __failed_items | map(attribute='item.Filename') | list | join(', ') }}
       Verify your Maintenance Plan on SAP Launchpad before retrying.
   vars:
     __failed_items: "{{ __sap_software_download_files_plan_results.results

roles/sap_software_download/tasks/pre_steps/03_validate_credentials.yml

@@ -2,7 +2,7 @@
 ---
 # This task attempts dry run to check SAPCAR file in order to validate provided credentials.
 
-- name: Validate Credentials - Dry run to download test file with Python venv
+- name: Validate Credentials - Dry run check user credentials and download privilege with Python venv
   when: sap_software_download_use_venv | d(true)
   community.sap_launchpad.software_center_download:
     suser_id: "{{ sap_software_download_suser_id }}"
@@ -13,6 +13,8 @@
     deduplicate: "last"
     dry_run: true
   register: __sap_software_download_validate_credentials_venv
+  retries: 1
+  delay: 5
   environment:
     PATH: "{{ __sap_software_download_venv.path }}/bin:{{ ansible_env.PATH }}" 
     PYTHONPATH: "{{ __sap_software_download_venv.path }}/lib/{{ sap_software_download_python_interpreter }}/site-packages" 
@@ -21,7 +23,7 @@
     ansible_python_interpreter: "{{ __sap_software_download_venv.path ~ '/bin/' ~ sap_software_download_python_interpreter }}"
   ignore_errors: true  # Errors are ignored and validated afterwards
 
-- name: Validate Credentials - Dry run to download test file with Python system default
+- name: Validate Credentials - Dry run check user credentials and download privilege with Python system default
   when: not sap_software_download_use_venv | d(true)
   community.sap_launchpad.software_center_download:
     suser_id: "{{ sap_software_download_suser_id }}"
@@ -32,6 +34,8 @@
     deduplicate: "last"
     dry_run: true
   register: __sap_software_download_validate_credentials_default
+  retries: 1
+  delay: 5
   vars:
     ansible_python_interpreter: "{{ '/usr/bin/' ~ sap_software_download_python_interpreter }}"
   ignore_errors: true  # Errors are ignored and validated afterwards

roles/sap_software_download/tasks/pre_steps/06_validate_sap_hana_1.yml

@@ -6,7 +6,7 @@
     # 122 for IMDB_SERVER100_122_35-10009569.SAR
     __sap_software_download_sap_hana_1_version:
       "{{ __sap_software_download_sap_hana.split('_')[2] | regex_replace('[^0-9]', '') }}"
-    
+
     # 35 for IMDB_SERVER100_122_35-10009569.SAR
     __sap_software_download_sap_hana_1_revision:
       "{{ __sap_software_download_sap_hana.split('_')[3].split('-')[0] | regex_replace('[^0-9]', '') }}"
@@ -21,8 +21,9 @@
 - name: Relationship Validation - SAP HANA 1.00 - IMDB_SERVER and IMDB_LCAPPS
   ansible.builtin.fail:
     msg: |
-      Warning: Incompatible SAP HANA component LCAPPS files were found for detected SAP HANA DATABASE 1.0 {{
-        __sap_software_download_sap_hana_1_version }}.{{ __sap_software_download_sap_hana_1_revision }}.
+      Warning: Incompatible SAP HANA component LCAPPS files were found for detected SAP HANA DATABASE 1.0 SPS {{
+        __sap_software_download_sap_hana_1_version[:2] }} Revision {{ __sap_software_download_sap_hana_1_version
+        }}.{{ __sap_software_download_sap_hana_1_revision }}.
   
       Expected file pattern: IMDB_LCAPPS_{{
         __sap_software_download_sap_hana_1_version }}*_{{__sap_software_download_sap_hana_1_revision }}*
@@ -48,8 +49,9 @@
 - name: Relationship Validation - SAP HANA 1.00 - IMDB_SERVER and IMDB_AFL
   ansible.builtin.fail:
     msg: |
-      Warning: Incompatible SAP HANA component AFL files were found for detected SAP HANA DATABASE 1.0 {{
-        __sap_software_download_sap_hana_1_version }}.{{ __sap_software_download_sap_hana_1_revision }}.
+      Warning: Incompatible SAP HANA component AFL files were found for detected SAP HANA DATABASE 1.0 SPS {{
+        __sap_software_download_sap_hana_1_version[:2] }} Revision {{ __sap_software_download_sap_hana_1_version
+        }}.{{ __sap_software_download_sap_hana_1_revision }}.
 
       Expected file pattern: IMDB_AFL100_{{ __sap_software_download_sap_hana_1_version }}*_{{ __sap_software_download_sap_hana_1_revision }}*
       Actual files detected: {{ __sap_software_download_sap_hana_1_afl_list | unique | join(', ') }}

roles/sap_software_download/tasks/pre_steps/07_validate_sap_hana_2.yml

@@ -17,8 +17,8 @@
 - name: Relationship Validation - SAP HANA 2.00 - IMDB_SERVER and IMDB_LCAPPS
   ansible.builtin.fail:
     msg: |
-      Warning: Incompatible SAP HANA component LCAPPS files were found for detected SAP HANA DATABASE 2.0 Revision {{
-        __sap_software_download_sap_hana_2_version }}.
+      Warning: Incompatible SAP HANA component LCAPPS files were found for detected SAP HANA DATABASE 2.0 SPS {{
+        __sap_software_download_sap_hana_2_version[:2] }} Revision {{ __sap_software_download_sap_hana_2_version }}.
 
       Expected file pattern: IMDB_LCAPPS_2{{ __sap_software_download_sap_hana_2_version }}*
       Actual files detected: {{ __sap_software_download_sap_hana_2_lcapps_list | unique | join(', ') }}
@@ -42,8 +42,8 @@
 - name: Relationship Validation - SAP HANA 2.00 - IMDB_SERVER and IMDB_AFL
   ansible.builtin.fail:
     msg: |
-      Warning: Incompatible SAP HANA component AFL files were found for detected SAP HANA DATABASE 2.0 Revision {{
-        __sap_software_download_sap_hana_2_version }}.
+      Warning: Incompatible SAP HANA component AFL files were found for detected SAP HANA DATABASE 2.0 SPS {{
+        __sap_software_download_sap_hana_2_version[:2] }} Revision {{ __sap_software_download_sap_hana_2_version }}.
 
       Expected file pattern: IMDB_AFL20_{{ __sap_software_download_sap_hana_2_version }}*
       Actual files detected: {{ __sap_software_download_sap_hana_2_afl_list | unique | join(', ') }}