Merge pull request #37 from thedatabaseme/develop

thedatabaseme · web-flow · commit 999f7cc27578 · 2022-04-06T13:52:09.000+02:00
Merge oracle_sql module usage to master
diff --git a/.github/workflows/ansible_lint.yml b/.github/workflows/ansible_lint.yml
@@ -17,7 +17,7 @@ jobs:
 
     - name: Lint Ansible Playbook
       # replace "master" with any valid ref
-      uses: ansible/ansible-lint-action@master
+      uses: ansible/ansible-lint-action@main
       with:
         # [required]
         # Paths to ansible files (i.e., playbooks, tasks, handlers etc..)
diff --git a/Changelog.txt b/Changelog.txt
@@ -1,5 +1,9 @@
 Changelog of Pythia:
 
+Version 2.3.5
+  - New Feature #34: using the shell command with sqlplus has been replaced by the oracle_sql
+    module
+
 Version 2.3.0
   - New Feature #25: You can now specify a list of instance parameters which will get set
     when a database is getting created. See docs/CREATE_DB.md
diff --git a/docs/07_DATAPUMP.md b/docs/07_DATAPUMP.md
@@ -1,7 +1,5 @@
 # Datapump Export / Import a Database with Pythia
 
-# UPDATE STARTS HERE!
-
 Pythia is able to do a Datapump Export / Import over a NETWORK_LINK (Database Link). You may either do a FULL Export / Import or an Import of a List of Schemas. Pythia also supports you by remapping the schemas.
 
 Be aware, that all restrictions for doing an Export / Import over a Database Link are applying here. More informations can be found [here](https://docs.oracle.com/database/121/SUTIL/GUID-0871E56B-07EB-43B3-91DA-D1F457CF6182.htm#SUTIL919)
diff --git a/roles/pythia/library/oracle_sql.py b/roles/pythia/library/oracle_sql.py
@@ -0,0 +1,101 @@
+#!/usr/bin/python
+
+# Copyright: (c) 2022, Philip Haberkern / TheDatabaseMe <info@thedatabaseme.de>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import (absolute_import, division, print_function)
+__metaclass__ = type
+
+DOCUMENTATION = r'''
+---
+module: oracle_sql
+
+short_description: This module runs SQL queries on an Oracle database
+
+version_added: "1.0.0"
+
+description: This module runs SQL queries on an Oracle database.
+
+options:
+    orahome:
+        description: Oracle Home Directory.
+        type: str
+        required: true
+    sql:
+        description: SQL command to run on Oracle database.
+        type: str
+        required: true
+
+author:
+    - Philip Haberkern (@thedatabaseme)
+'''
+
+EXAMPLES = r'''
+- name: Run SQL query on Oracle database
+  oracle_sql:
+    orahome: "/oracle/product/19_ENT/"
+    sql: "select * from dba_users where username = 'SYSTEM';"
+  environment:
+    ORACLE_HOME: "/oracle/product/19_ENT"
+    ORACLE_SID: "ORA19"
+  become: yes
+  become_user: "oracle"
+'''
+
+RETURN = r'''
+query_command:
+    description: The final sqlplus command after it has been built.
+    type: str
+    returned: always
+    sample: "echo select account_status from dba_users where username = 'SYSTEM' | /oracle/product/19_ENT/bin/sqlplus -s / as sysdba"
+query_result:
+    description: The query result / output that the module generates.
+    type: str
+    returned: always
+    sample: 'OPEN'
+'''
+
+from ansible.module_utils.basic import AnsibleModule
+
+
+def run_module():
+    # define available arguments/parameters a user can pass to the module
+    module_args = dict(
+        orahome=dict(type='str', required=True),
+        sql=dict(type='str', required=True)
+    )
+
+    module = AnsibleModule(
+        argument_spec=module_args,
+        supports_check_mode=True
+    )
+
+    if module.check_mode:
+        module.exit_json(msg="Running |" + module.params['sql'] )
+
+    cmd='echo "' + module.params['sql'] + '" | ' + module.params['orahome'] + '/bin/sqlplus -s / as sysdba'
+    rc, out, err = module.run_command(cmd, use_unsafe_shell=True)
+
+    if rc != 0:
+        module.fail_json(msg='failed with error:' + err)
+
+    result = dict(
+        changed=True,
+        query_command=cmd,
+        query_result=out,
+        rc=rc
+    )
+
+    if module.params['sql'].lower().startswith('select'):
+        result['changed']=False
+
+    # in the event of a successful module execution, you will want to
+    # simple AnsibleModule.exit_json(), passing the key/value results
+    module.exit_json(**result)
+
+
+def main():
+    run_module()
+
+
+if __name__ == '__main__':
+    main()
diff --git a/roles/pythia/tasks/datapump.yml b/roles/pythia/tasks/datapump.yml
@@ -20,8 +20,9 @@
 - name: Check if Target Database is Open
   become: true
   become_user: "{{ oracle_user }}"
-  shell: "echo -e \"select status from v\\$instance;\" | {{ datapump_target_home.stdout }}/bin/sqlplus -s / as sysdba"
-  changed_when: false
+  oracle_sql:
+    orahome: "{{ datapump_target_home.stdout }}"
+    sql: "select status from v\\$instance;"
   environment:
     ORACLE_HOME: "{{ datapump_target_home.stdout }}"
     ORACLE_SID: "{{ datapump_target_sid }}"
@@ -33,7 +34,7 @@
 
 - name: Oracle SID for Import is NOT in OPEN State
   assert:
-    that: '"OPEN" | string in item.stdout'
+    that: '"OPEN" | string in item.query_result'
     fail_msg: The Target Database {{ datapump_target_sid }} is not in OPEN State.
     success_msg: Oracle SID {{ datapump_target_sid }} is in OPEN State. Proceed with Datapump.
   become: true
@@ -68,10 +69,11 @@
 - name: Drop maybe existing Database Link to Source Database {{ datapump_source_sid }}
   become: true
   become_user: "{{ oracle_user }}"
-  shell: "echo -e \"set heading off; \\n drop public database link pythia_dp_{{ datapump_source_sid }};\" | {{ datapump_target_home.stdout }}/bin/sqlplus -s / as sysdba"  # noqa line-length
-  changed_when: true
+  oracle_sql:
+    orahome: "{{ datapump_target_home.stdout }}"
+    sql: "drop public database link pythia_dp_{{ datapump_source_sid }};"
   register: result
-  failed_when: ("FATAL" in result.stdout)
+  failed_when: ("FATAL" in result.query_result)
   environment:
     ORACLE_HOME: "{{ datapump_target_home.stdout }}"
     ORACLE_SID: "{{ datapump_target_sid }}"
@@ -83,8 +85,9 @@
 - name: Create Database Link to Source Database {{ datapump_source_sid }}
   become: true
   become_user: "{{ oracle_user }}"
-  shell: "echo -e \"set heading off; \\n create public database link pythia_dp_{{ datapump_source_sid }} connect to {{ datapump_source_user }} identified by \"{{ lookup('vars', 'vault_datapump_' + datapump_source_sid) }}\" using 'PYTHIA_DP_{{ datapump_source_sid }}';\" | {{ datapump_target_home.stdout }}/bin/sqlplus -s / as sysdba"  # noqa line-length
-  changed_when: true
+  oracle_sql:
+    orahome: "{{ datapump_target_home.stdout }}"
+    sql: "create public database link pythia_dp_{{ datapump_source_sid }} connect to {{ datapump_source_user }} identified by {{ lookup('vars', 'vault_datapump_' + datapump_source_sid) }} using 'PYTHIA_DP_{{ datapump_source_sid }}';"  # noqa line-length
   environment:
     ORACLE_HOME: "{{ datapump_target_home.stdout }}"
     ORACLE_SID: "{{ datapump_target_sid }}"
@@ -96,8 +99,9 @@
 - name: Create Directory Object for Logfiles
   become: true
   become_user: "{{ oracle_user }}"
-  shell: "echo -e \"set heading off; \\n create or replace directory PYTHIA_DP_DIR as '{{ remote_stage_directory }}';\" | {{ datapump_target_home.stdout }}/bin/sqlplus -s / as sysdba"  # noqa line-length
-  changed_when: true
+  oracle_sql:
+    orahome: "{{ datapump_target_home.stdout }}"
+    sql: "create or replace directory PYTHIA_DP_DIR as '{{ remote_stage_directory }}';"
   environment:
     ORACLE_HOME: "{{ datapump_target_home.stdout }}"
     ORACLE_SID: "{{ datapump_target_sid }}"
@@ -136,7 +140,7 @@
   async: "{{ datapump_max_runtime }}"
   poll: 30
   register: result
-  failed_when: ("FATAL" in result.stdout)
+  failed_when: ("fatal" in result.stderr_lines)
   no_log: true
   tags:
     - datapump
diff --git a/roles/pythia/tasks/duplicate.yml b/roles/pythia/tasks/duplicate.yml
@@ -65,8 +65,9 @@
 - name: Check if Source Database is Open
   become: true
   become_user: "{{ oracle_user }}"
-  shell: "echo -e \"select status from v\\$instance;\" | {{ duplicate_source_home.stdout }}/bin/sqlplus -s / as sysdba"
-  changed_when: false
+  oracle_sql:
+    orahome: "{{ duplicate_source_home.stdout }}"
+    sql: "select status from v\\$instance;"
   environment:
     ORACLE_HOME: "{{ duplicate_source_home.stdout }}"
     ORACLE_SID: "{{ duplicate_source_sid }}"
@@ -78,7 +79,7 @@
 
 - name: Oracle SID to Duplicate is NOT in OPEN State
   assert:
-    that: '"OPEN" | string in item.stdout'
+    that: '"OPEN" | string in item.query_result'
     fail_msg: The Source Database {{ duplicate_source_sid }} is not in OPEN State.
     success_msg: Oracle SID {{ duplicate_source_sid }} is in OPEN State. Proceed with Duplicate.
   become: true
@@ -200,8 +201,9 @@
 - name: Check if Target Database is Open
   become: true
   become_user: "{{ oracle_user }}"
-  shell: "echo -e \"set heading off; \\n set feedback off; \\n select status from v\\$instance;\" | {{ duplicate_source_home.stdout }}/bin/sqlplus -s / as sysdba"  # noqa line-length
-  changed_when: false
+  oracle_sql:
+    orahome: "{{ duplicate_source_home.stdout }}"
+    sql: "select status from v\\$instance;"
   environment:
     ORACLE_HOME: "{{ duplicate_source_home.stdout }}"
     ORACLE_SID: "{{ duplicate_target_sid }}"
@@ -213,7 +215,7 @@
 
 - name: Oracle SID on Target System is in OPEN State
   assert:
-    that: '"OPEN" | string not in item.stdout'
+    that: '"OPEN" | string not in item.query_result'
     fail_msg: "The Source Database {{ duplicate_target_sid }} is in OPEN State. If you want to remove it prior to duplication, specify so in the duplicate_remove_target variable!"  # noqa line-length
     success_msg: "Oracle SID {{ duplicate_target_sid }} is not in OPEN State. Proceed with Duplicate."
   become: true
@@ -234,20 +236,21 @@
   environment:
     ORACLE_HOME: "{{ duplicate_source_home.stdout }}"
     ORACLE_SID: "{{ duplicate_target_sid }}"
-  register: target_controlfiles
+  register: target_passwords
   with_items:
     - "{{ target_db_status }}"
   delegate_to: "{{ duplicate_target_host }}"
   run_once: true
-  when: (duplicate_preserve_passwords) and ("OPEN" | string in item.stdout_lines)
+  when: (duplicate_preserve_passwords) and ("OPEN" | string in item.query_result)
   tags:
     - duplicate
 
 - name: Gather Controlfiles from running Target Database
   become: true
   become_user: "{{ oracle_user }}"
-  shell: "echo -e \"set heading off; \\n set lines 500; \\n set feedback off; \\n select value from v\\$parameter where name = 'control_files';\" | {{ duplicate_source_home.stdout }}/bin/sqlplus -s / as sysdba"  # noqa line-length
-  changed_when: false
+  oracle_sql:
+    orahome: "{{ duplicate_source_home.stdout }}"
+    sql: "select value from v\\$parameter where name = 'control_files';"
   environment:
     ORACLE_HOME: "{{ duplicate_source_home.stdout }}"
     ORACLE_SID: "{{ duplicate_target_sid }}"
@@ -256,14 +259,16 @@
     - "{{ target_db_status }}"
   delegate_to: "{{ duplicate_target_host }}"
   run_once: true
-  when: (duplicate_remove_target) and ("OPEN" | string in item.stdout_lines)
+  when: (duplicate_remove_target) and ("OPEN" | string in item.query_result)
   tags:
     - duplicate
 
 - name: Gather Datafiles from running Target Database
   become: true
   become_user: "{{ oracle_user }}"
-  shell: "echo -e \"set heading off; \\n set lines 500; \\n set pages 500; \\n set feedback off; \\n select file_name from dba_data_files;\" | {{ duplicate_source_home.stdout }}/bin/sqlplus -s / as sysdba"  # noqa line-length
+  oracle_sql:
+    orahome: "{{ duplicate_source_home.stdout }}"
+    sql: "select file_name from dba_data_files;"
   environment:
     ORACLE_HOME: "{{ duplicate_source_home.stdout }}"
     ORACLE_SID: "{{ duplicate_target_sid }}"
@@ -272,14 +277,16 @@
     - "{{ target_db_status }}"
   delegate_to: "{{ duplicate_target_host }}"
   run_once: true
-  when: (duplicate_remove_target) and ("OPEN" | string in item.stdout)
+  when: (duplicate_remove_target) and ("OPEN" | string in item.query_result)
   tags:
     - duplicate
 
 - name: Gather Tempfiles from running Target Database
   become: true
   become_user: "{{ oracle_user }}"
-  shell: "echo -e \"set heading off; \\n set lines 500; \\n set pages 500; \\n set feedback off; \\n select file_name from dba_temp_files;\" | {{ duplicate_source_home.stdout }}/bin/sqlplus -s / as sysdba"  # noqa line-length
+  oracle_sql:
+    orahome: "{{ duplicate_source_home.stdout }}"
+    sql: "select file_name from dba_temp_files;"
   environment:
     ORACLE_HOME: "{{ duplicate_source_home.stdout }}"
     ORACLE_SID: "{{ duplicate_target_sid }}"
@@ -288,14 +295,16 @@
     - "{{ target_db_status }}"
   delegate_to: "{{ duplicate_target_host }}"
   run_once: true
-  when: (duplicate_remove_target) and ("OPEN" | string in item.stdout)
+  when: (duplicate_remove_target) and ("OPEN" | string in item.query_result)
   tags:
     - duplicate
 
 - name: Gather Redologs from running Target Database
   become: true
   become_user: "{{ oracle_user }}"
-  shell: "echo -e \"set heading off; \\n set lines 500; \\n set pages 500; \\n set feedback off; \\n select member from v\\$logfile;\" | {{ duplicate_source_home.stdout }}/bin/sqlplus -s / as sysdba"  # noqa line-length
+  oracle_sql:
+    orahome: "{{ duplicate_source_home.stdout }}"
+    sql: "select member from v\\$logfile;"
   environment:
     ORACLE_HOME: "{{ duplicate_source_home.stdout }}"
     ORACLE_SID: "{{ duplicate_target_sid }}"
@@ -304,7 +313,7 @@
     - "{{ target_db_status }}"
   delegate_to: "{{ duplicate_target_host }}"
   run_once: true
-  when: (duplicate_remove_target) and ("OPEN" | string in item.stdout)
+  when: (duplicate_remove_target) and ("OPEN" | string in item.query_result)
   tags:
     - duplicate
 
@@ -319,7 +328,7 @@
     - "{{ target_db_status }}"
   delegate_to: "{{ duplicate_target_host }}"
   run_once: true
-  when: (duplicate_remove_target) and ("OPEN" | string in item.stdout)
+  when: (duplicate_remove_target) and ("OPEN" | string in item.query_result)
   tags:
     - duplicate
 
@@ -675,7 +684,9 @@
 - name: Shutdown Target Database for restoring the original SPFILE
   become: true
   become_user: "{{ oracle_user }}"
-  shell: "echo -e \"shutdown immediate;\" | {{ duplicate_source_home.stdout }}/bin/sqlplus -s / as sysdba"
+  oracle_sql:
+    orahome: "{{ duplicate_source_home.stdout }}"
+    sql: "shutdown immediate;" 
   environment:
     ORACLE_HOME: "{{ duplicate_source_home.stdout }}"
     ORACLE_SID: "{{ duplicate_target_sid }}"
@@ -702,7 +713,9 @@
 - name: Startup Target Database for restoring the original SPFILE
   become: true
   become_user: "{{ oracle_user }}"
-  shell: "echo -e \"startup;\" | {{ duplicate_source_home.stdout }}/bin/sqlplus -s / as sysdba"
+  oracle_sql:
+    orahome: "{{ duplicate_source_home.stdout }}"
+    sql: "startup;" 
   environment:
     ORACLE_HOME: "{{ duplicate_source_home.stdout }}"
     ORACLE_SID: "{{ duplicate_target_sid }}"
diff --git a/roles/pythia/tasks/install_db.yml b/roles/pythia/tasks/install_db.yml
@@ -114,11 +114,16 @@
 - name: Setting SYS and SYSTEM Password after Creation
   become: true
   become_user: "{{ oracle_user }}"
-  shell: "{{ item }}"
-  changed_when: true
+  # shell: "{{ item }}"
+  # changed_when: true
+  oracle_sql:
+    orahome: "{{ rdbms[oracle_version|string].oracle_home }}"
+    sql: "{{ item }}"
   with_items:
-    - "echo -e \"alter user system identified by \"{{ system_user_password }}\";\" | {{ rdbms[oracle_version|string].oracle_home }}/bin/sqlplus -s / as sysdba"
-    - "echo -e \"alter user system identified by \"{{ sys_user_password }}\";\" | {{ rdbms[oracle_version|string].oracle_home }}/bin/sqlplus -s / as sysdba"
+    # - "echo -e \"alter user system identified by \"{{ system_user_password }}\";\" | {{ rdbms[oracle_version|string].oracle_home }}/bin/sqlplus -s / as sysdba"
+    # - "echo -e \"alter user system identified by \"{{ sys_user_password }}\";\" | {{ rdbms[oracle_version|string].oracle_home }}/bin/sqlplus -s / as sysdba"
+    - 'alter user system identified by "{{ system_user_password }}";'
+    - 'alter user sys identified by "{{ sys_user_password }}";'
   environment:
     ORACLE_HOME: "{{ rdbms[oracle_version|string].oracle_home }}"
     ORACLE_SID: "{{ oracle_sid }}"
@@ -148,7 +153,10 @@
 - name: Setting Password for Default DB Users
   become: true
   become_user: "{{ oracle_user }}"
-  shell: "echo -e \"alter user {{ item }} identified by \"{{ default_user_password }}\";\" | {{ rdbms[oracle_version|string].oracle_home }}/bin/sqlplus -s / as sysdba"  # noqa line-length
+  # shell: "echo -e \"alter user {{ item }} identified by \"{{ default_user_password }}\";\" | {{ rdbms[oracle_version|string].oracle_home }}/bin/sqlplus -s / as sysdba"  # noqa line-length
+  oracle_sql:
+    orahome: "{{ rdbms[oracle_version|string].oracle_home }}"
+    sql: 'alter user {{ item }} identified by "{{ default_user_password }}";'
   environment:
     ORACLE_HOME: "{{ rdbms[oracle_version|string].oracle_home }}"
     ORACLE_SID: "{{ oracle_sid }}"
diff --git a/roles/pythia/tasks/install_patch.yml b/roles/pythia/tasks/install_patch.yml
diff --git a/roles/pythia/tasks/main.yml b/roles/pythia/tasks/main.yml
diff --git a/roles/pythia/tasks/upgrade.yml b/roles/pythia/tasks/upgrade.yml
