mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 11:21:25 -07:00
316d1db29f
* postgresql modules: move connect_to_db, get_pg_version to module_utils * postgresql modules: move connect_to_db, get_pg_version to module_utils 2 * postgresql modules: move connect_to_db, get_pg_version to module_utils 3
90 lines
3.6 KiB
Python
90 lines
3.6 KiB
Python
# This code is part of Ansible, but is an independent component.
|
|
# This particular file snippet, and this file snippet only, is BSD licensed.
|
|
# Modules you write using this snippet, which is embedded dynamically by Ansible
|
|
# still belong to the author of the module, and may assign their own license
|
|
# to the complete work.
|
|
#
|
|
# Copyright (c), Ted Timmons <ted@timmons.me>, 2017.
|
|
# Most of this was originally added by other creators in the postgresql_user module.
|
|
# All rights reserved.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without modification,
|
|
# are permitted provided that the following conditions are met:
|
|
#
|
|
# * Redistributions of source code must retain the above copyright
|
|
# notice, this list of conditions and the following disclaimer.
|
|
# * Redistributions in binary form must reproduce the above copyright notice,
|
|
# this list of conditions and the following disclaimer in the documentation
|
|
# and/or other materials provided with the distribution.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
|
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
try:
|
|
import psycopg2
|
|
import psycopg2.extras
|
|
HAS_PSYCOPG2 = True
|
|
except ImportError:
|
|
HAS_PSYCOPG2 = False
|
|
|
|
from ansible.module_utils._text import to_native
|
|
|
|
|
|
class LibraryError(Exception):
|
|
pass
|
|
|
|
|
|
def ensure_libs(sslrootcert=None):
|
|
if not HAS_PSYCOPG2:
|
|
raise LibraryError('psycopg2 is not installed. we need psycopg2.')
|
|
if sslrootcert and psycopg2.__version__ < '2.4.3':
|
|
raise LibraryError('psycopg2 must be at least 2.4.3 in order to use the ca_cert parameter')
|
|
|
|
# no problems
|
|
return None
|
|
|
|
|
|
def postgres_common_argument_spec():
|
|
return dict(
|
|
login_user=dict(default='postgres'),
|
|
login_password=dict(default='', no_log=True),
|
|
login_host=dict(default=''),
|
|
login_unix_socket=dict(default=''),
|
|
port=dict(type='int', default=5432, aliases=['login_port']),
|
|
ssl_mode=dict(default='prefer', choices=['allow', 'disable', 'prefer', 'require', 'verify-ca', 'verify-full']),
|
|
ca_cert=dict(aliases=['ssl_rootcert']),
|
|
)
|
|
|
|
|
|
def connect_to_db(module, kw, autocommit=False):
|
|
try:
|
|
db_connection = psycopg2.connect(**kw)
|
|
if autocommit:
|
|
if psycopg2.__version__ >= '2.4.2':
|
|
db_connection.set_session(autocommit=True)
|
|
else:
|
|
db_connection.set_isolation_level(psycopg2.extensions.ISOLATION_LEVEL_AUTOCOMMIT)
|
|
|
|
except TypeError as e:
|
|
if 'sslrootcert' in e.args[0]:
|
|
module.fail_json(msg='Postgresql server must be at least '
|
|
'version 8.4 to support sslrootcert')
|
|
|
|
module.fail_json(msg="unable to connect to database: %s" % to_native(e))
|
|
|
|
except Exception as e:
|
|
module.fail_json(msg="unable to connect to database: %s" % to_native(e))
|
|
|
|
return db_connection
|
|
|
|
|
|
def get_pg_version(cursor):
|
|
cursor.execute("select current_setting('server_version_num')")
|
|
return int(cursor.fetchone()[0])
|