dev to main (#18)

* devel Python version exclusive (#14) (#15) * devel Python version exclusive to 3.10 * change default python version to 3.10 * rename and restructure Ansible Modules (#16) * devel Python version exclusive (#14) * devel Python version exclusive to 3.10 * change default python version to 3.10 * fix: gitignore update * move swpm2 inifile generate from sap_install * sap_control_exec: rename from sapcontrol Ansible Module * sap_hdbsql: rename from hana_query Ansible Module * all: amend text and dir structure * all: remove symlinks * all: flatten modules dir * all: move tests to parent dir Co-authored-by: Rainer Leber <[email protected]> * Refactoring Modules, make things more clear (#17) * remove symlinks, add redirection * adding missing library exception * fix tests * change error logic * add changelog * change changelog * change galaxy yaml Co-authored-by: Sean Freeman <[email protected]>
sap-linuxlab · Sep 9, 2022 · bc0cff6 · bc0cff6
1 parent dd74f02
commit bc0cff6
Show file tree

Hide file tree

Showing 42 changed files with 2,369 additions and 1,905 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,55 @@
 /tests/output/
 /changelogs/.plugin-cache.yaml
 
+# .gitignore defines files to ignore and remain untracked in Git
+# Each line in a gitignore file specifies a pattern, eg. directory or file extension
+
+# Git should not track binary artifacts such as images, libraries, executables, archive files etc.
+# Until the team has mature processes, a Binary Artifacts Repository Manager is not in use.
+
+# Therefore some binary artifacts are tracked in this Git repository
+
+
+# Further .gitignore templates available at:
+# https://github.com/github/gitignore
+
+
+# macOS OS generated files
+.DS_Store
+._*
+.Spotlight-V100
+.Trashes
+
+# Windows OS generated files #
+ehthumbs.db
+Thumbs.db
+
+# Compressed Archives
+# git has built-in compression
+# *.7z
+# *.dmg
+# *.gz
+# *.iso
+# *.jar
+# *.rar
+# *.tar
+# *.zip
+
+# Binaries / Compiled source
+# *.com
+# *.class
+# *.dll
+# *.exe
+# *.o
+# *.so
+
+# Logs and databases
+# *.log
+# *.sqlite
+
+# VSCode
+.vscode
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,14 +5,33 @@ Community SAP Release Notes
 .. contents:: Topics
 
 
+v1.3.0
+======
+
+Release Summary
+---------------
+
+This is the 1.3.0 minor release of the ``community.sap_libs`` collection.
+This changelog contains all changes to the modules and plugins in this collection
+that have been made after the previous release.
+
+Minor Changes
+-------------
+
+- License requirements are updated.
+- The modules purposes are described clearer.
+- The namespaces of the modules are removed to provide a flatter design.
+- hana_query - module is moved to sap_hdbsql.
+- sapcontrol - module is moved to sap_control_exec to have a clearer separation to other roles and references.
+
 v1.2.0
 ======
 
 Release Summary
 ---------------
 
 This is the minor release of the ``community.sap_libs`` collection.
-This changelog contains changes to the modules and plugins in this collection
+This changelog contains all changes to the modules and plugins in this collection
 that have been made after the previous release.
 
 Bugfixes
@@ -23,7 +42,7 @@ Bugfixes
 New Modules
 -----------
 
-- sap_pyrfc - This module executes rfc functions.
+- sap_pyrfc - Ansible Module for use of SAP PyRFC to execute SAP RFCs (Remote Function Calls) to SAP remote-enabled function modules
 
 v1.1.0
 ======
@@ -41,7 +60,7 @@ New Modules
 System
 ~~~~~~
 
-- sapcontrol - Manages SAPCONTROL
+- sapcontrol - Ansible Module to execute SAPCONTROL
 
 v1.0.0
 ======
@@ -60,7 +79,7 @@ Database
 saphana
 ^^^^^^^
 
-- hana_query - Execute SQL on HANA
+- hana_query - Ansible Module to execute SQL on SAP HANA
 
 Files
 ~~~~~

diff --git a/README.md b/README.md
@@ -99,14 +99,14 @@ For some modules the below requirements are needed on the host that executes a m
 ## Included content
 
 - **Modules**:
-  - [hana_query](https://docs.ansible.com/ansible/latest/collections/community/sap_libs/hana_query.html)
+  - [sap_hdbsql](https://docs.ansible.com/ansible/latest/collections/community/sap_libs/sap_hdbsql.html)
   - [sap_task_list_execute](https://docs.ansible.com/ansible/latest/collections/community/sap_libs/sap_task_list_execute.html)
   - [sapcar_extract](https://docs.ansible.com/ansible/latest/collections/community/sap_libs/sapcar_extract.html)
   - [sap_company](https://docs.ansible.com/ansible/latest/collections/community/sap_libs/sap_company.html)
   - [sap_snote](https://docs.ansible.com/ansible/latest/collections/community/sap_libs/sap_snote.html)
   - [sap_user](https://docs.ansible.com/ansible/latest/collections/community/sap_libs/sap_user.html)
   - [sap_system_facts](https://docs.ansible.com/ansible/latest/collections/community/sap_libs/sap_system_facts.html)
-  - [sapcontrol](https://docs.ansible.com/ansible/latest/collections/community/sap_libs/sapcontrol.html)
+  - [sap_control_exec](https://docs.ansible.com/ansible/latest/collections/community/sap_libs/sap_control_exec.html)
 
 ## Using this collection
 

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -7,7 +7,7 @@ releases:
     fragments:
     - 1.0.0.yml
     modules:
-    - description: Execute SQL on HANA
+    - description: Ansible Module to execute SQL on SAP HANA
       name: hana_query
       namespace: database.saphana
     - description: This module will manage a company entities in a SAP S4HANA environment
@@ -39,7 +39,7 @@ releases:
     fragments:
     - 1.1.0.yml
     modules:
-    - description: Manages SAPCONTROL
+    - description: Ansible Module to execute SAPCONTROL
       name: sapcontrol
       namespace: system
     release_date: '2022-05-17'
@@ -57,7 +57,25 @@ releases:
     - 1.2.0.yml
     - 11-sap_system_facts_fix_typo.yml
     modules:
-    - description: This module executes rfc functions.
+    - description: Ansible Module for use of SAP PyRFC to execute SAP RFCs (Remote
+        Function Calls) to SAP remote-enabled function modules
       name: sap_pyrfc
       namespace: ''
     release_date: '2022-07-18'
+  1.3.0:
+    changes:
+      breaking_changes:
+      minor_changes:
+      - License requirements are updated.
+      - The modules purposes are described clearer.
+      - The namespaces of the modules are removed to provide a flatter design.
+      - hana_query - module is moved to sap_hdbsql.
+      - sapcontrol - module is moved to sap_control_exec to have a clearer separation
+        to other roles and references.
+      release_summary: 'This is the 1.3.0 minor release of the ``community.sap_libs``
+        collection.
+        This changelog contains all changes to the modules and plugins in this collection
+        that have been made after the previous release.'
+    fragments:
+    - 1.3.0.yml
+    release_date: '2022-09-09'
diff --git a/galaxy.yml b/galaxy.yml
@@ -2,11 +2,12 @@
 
 namespace: community
 name: sap_libs
-version: 1.2.0
+version: 1.3.0
 readme: README.md
 authors:
   - Rainer Leber (github.com/rainerleber)
   - Robert Kraemer (github.com/rkpobe)
+  - Sean Freeman (github.com/sean-freeman)
 description: SAP Module community collection for Ansible
 license_file: LICENSE
 tags:

diff --git a/meta/runtime.yml b/meta/runtime.yml
@@ -1,2 +1,15 @@
 ---
-requires_ansible: '>=2.9.10'
+requires_ansible: ">=2.9.10"
+
+plugin_routing:
+  modules:
+    hana_query:
+      redirect: community.sap_libs.sap_hdbsql
+      deprecation:
+        removal_version: 2.0.0
+        warning_text: Use community.sap_libs.sap_hdbsql instead.
+    sapcontrol:
+      redirect: community.sap_libs.sap_control_exec
+      deprecation:
+        removal_version: 2.0.0
+        warning_text: Use community.sap_libs.sap_control_exec instead.
diff --git a/plugins/module_utils/pyrfc_handler.py b/plugins/module_utils/pyrfc_handler.py
@@ -32,7 +32,7 @@
 def get_connection(module, conn_params):
     if not HAS_PYRFC_LIBRARY:
         module.fail_json(msg=missing_required_lib(
-            "python-gitlab"), exception=PYRFC_LIBRARY_IMPORT_ERROR)
+            "pyrfc"), exception=PYRFC_LIBRARY_IMPORT_ERROR)
 
     module.warn('Connecting ... %s' % conn_params['ashost'])
     if "saprouter" in conn_params: