mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-28 13:21:25 -07:00
postgresql_lang module: fixed doc formatting, added aliases, pg_utils, added missing CI tests (#54672)
* postgresql_lang: fixed doc * postgresql_lang: add pg_utils * postgresql_lang: added return value - queries * postgresql_lang: added CI tests * postgresql_lang: restricted CI using CentOS * postgresql_lang: fixed typos in CI comments
This commit is contained in:
Andrey Klychkov
John R Barker
parent
2176b53a55
commit
48ec8d13a0
3 changed files with 379 additions and 95 deletions
|
|
@ -12,186 +12,225 @@ ANSIBLE_METADATA = {'metadata_version': '1.1',
|
|||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: postgresql_lang
|
||||
short_description: Adds, removes or changes procedural languages with a PostgreSQL database.
|
||||
short_description: Adds, removes or changes procedural languages with a PostgreSQL database
|
||||
description:
|
||||
- Adds, removes or changes procedural languages with a PostgreSQL database.
|
||||
- This module allows you to add a language, remote a language or change the trust
|
||||
relationship with a PostgreSQL database. The module can be used on the machine
|
||||
where executed or on a remote host.
|
||||
- When removing a language from a database, it is possible that dependencies prevent
|
||||
the database from being removed. In that case, you can specify casade to
|
||||
automatically drop objects that depend on the language (such as functions in the
|
||||
language). In case the language can't be deleted because it is required by the
|
||||
database system, you can specify fail_on_drop=no to ignore the error.
|
||||
- Be carefull when marking a language as trusted since this could be a potential
|
||||
security breach. Untrusted languages allow only users with the PostgreSQL superuser
|
||||
privilege to use this language to create new functions.
|
||||
version_added: "1.7"
|
||||
- Adds, removes or changes procedural languages with a PostgreSQL database.
|
||||
- This module allows you to add a language, remote a language or change the trust
|
||||
relationship with a PostgreSQL database.
|
||||
- The module can be used on the machine where executed or on a remote host.
|
||||
- When removing a language from a database, it is possible that dependencies prevent
|
||||
the database from being removed. In that case, you can specify casade to
|
||||
automatically drop objects that depend on the language (such as functions in the
|
||||
language).
|
||||
- In case the language can't be deleted because it is required by the
|
||||
database system, you can specify fail_on_drop=no to ignore the error.
|
||||
- Be carefull when marking a language as trusted since this could be a potential
|
||||
security breach. Untrusted languages allow only users with the PostgreSQL superuser
|
||||
privilege to use this language to create new functions.
|
||||
- For more information about PostgreSQL languages see the official documentation
|
||||
U(https://www.postgresql.org/docs/current/sql-createlanguage.html),
|
||||
U(https://www.postgresql.org/docs/current/sql-alterlanguage.html),
|
||||
U(https://www.postgresql.org/docs/current/sql-droplanguage.html).
|
||||
version_added: '1.7'
|
||||
options:
|
||||
lang:
|
||||
description:
|
||||
- name of the procedural language to add, remove or change
|
||||
- Name of the procedural language to add, remove or change.
|
||||
required: true
|
||||
type: str
|
||||
aliases:
|
||||
- name
|
||||
trust:
|
||||
description:
|
||||
- make this language trusted for the selected db
|
||||
- Make this language trusted for the selected db.
|
||||
type: bool
|
||||
default: 'no'
|
||||
db:
|
||||
description:
|
||||
- name of database where the language will be added, removed or changed
|
||||
- Name of database to connect to and where the language will be added, removed or changed.
|
||||
type: str
|
||||
aliases:
|
||||
- login_db
|
||||
force_trust:
|
||||
description:
|
||||
- marks the language as trusted, even if it's marked as untrusted in pg_pltemplate.
|
||||
- use with care!
|
||||
- Marks the language as trusted, even if it's marked as untrusted in pg_pltemplate.
|
||||
- Use with care!
|
||||
type: bool
|
||||
default: 'no'
|
||||
fail_on_drop:
|
||||
description:
|
||||
- if C(yes), fail when removing a language. Otherwise just log and continue
|
||||
- in some cases, it is not possible to remove a language (used by the db-system). When dependencies block the removal, consider using C(cascade).
|
||||
- If C(yes), fail when removing a language. Otherwise just log and continue.
|
||||
- In some cases, it is not possible to remove a language (used by the db-system).
|
||||
- When dependencies block the removal, consider using C(cascade).
|
||||
type: bool
|
||||
default: 'yes'
|
||||
cascade:
|
||||
description:
|
||||
- when dropping a language, also delete object that depend on this language.
|
||||
- only used when C(state=absent).
|
||||
- When dropping a language, also delete object that depend on this language.
|
||||
- Only used when C(state=absent).
|
||||
type: bool
|
||||
default: 'no'
|
||||
port:
|
||||
description:
|
||||
- Database port to connect to.
|
||||
- Database port to connect to.
|
||||
default: 5432
|
||||
type: int
|
||||
aliases:
|
||||
- login_port
|
||||
login_user:
|
||||
description:
|
||||
- User used to authenticate with PostgreSQL
|
||||
- User to authenticate with PostgreSQL.
|
||||
type: str
|
||||
default: postgres
|
||||
login_password:
|
||||
description:
|
||||
- Password used to authenticate with PostgreSQL (must match C(login_user))
|
||||
- Password used to authenticate with PostgreSQL (must match C(login_user)).
|
||||
type: str
|
||||
login_host:
|
||||
description:
|
||||
- Host running PostgreSQL where you want to execute the actions.
|
||||
- Host running PostgreSQL where you want to execute the actions.
|
||||
type: str
|
||||
default: localhost
|
||||
session_role:
|
||||
version_added: "2.8"
|
||||
description: |
|
||||
Switch to session_role after connecting. The specified session_role must be a role that the current login_user is a member of.
|
||||
Permissions checking for SQL commands is carried out as though the session_role were the one that had logged in originally.
|
||||
version_added: '2.8'
|
||||
description:
|
||||
- Switch to session_role after connecting.
|
||||
- The specified session_role must be a role that the current login_user is a member of.
|
||||
- Permissions checking for SQL commands is carried out as though the session_role were the one that had logged in originally.
|
||||
type: str
|
||||
state:
|
||||
description:
|
||||
- The state of the language for the selected database
|
||||
- The state of the language for the selected database.
|
||||
type: str
|
||||
default: present
|
||||
choices: [ "present", "absent" ]
|
||||
choices: [ absent, present ]
|
||||
login_unix_socket:
|
||||
description:
|
||||
- Path to a Unix domain socket for local connections.
|
||||
- Path to a Unix domain socket for local connections.
|
||||
type: str
|
||||
version_added: '2.8'
|
||||
ssl_mode:
|
||||
description:
|
||||
- Determines whether or with what priority a secure SSL TCP/IP connection
|
||||
will be negotiated with the server.
|
||||
- See U(https://www.postgresql.org/docs/current/static/libpq-ssl.html) for
|
||||
more information on the modes.
|
||||
- Default of C(prefer) matches libpq default.
|
||||
- Determines whether or with what priority a secure SSL TCP/IP connection
|
||||
will be negotiated with the server.
|
||||
- See U(https://www.postgresql.org/docs/current/static/libpq-ssl.html) for
|
||||
more information on the modes.
|
||||
- Default of C(prefer) matches libpq default.
|
||||
type: str
|
||||
default: prefer
|
||||
choices: ["disable", "allow", "prefer", "require", "verify-ca", "verify-full"]
|
||||
choices: [ allow, disable, prefer, require, verify-ca, verify-full ]
|
||||
version_added: '2.8'
|
||||
ca_cert:
|
||||
description:
|
||||
- Specifies the name of a file containing SSL certificate authority (CA)
|
||||
certificate(s). If the file exists, the server's certificate will be
|
||||
verified to be signed by one of these authorities.
|
||||
- Specifies the name of a file containing SSL certificate authority (CA)
|
||||
certificate(s). If the file exists, the server's certificate will be
|
||||
verified to be signed by one of these authorities.
|
||||
type: str
|
||||
version_added: '2.8'
|
||||
aliases: [ ssl_rootcert ]
|
||||
|
||||
notes:
|
||||
- The default authentication assumes that you are either logging in as or
|
||||
sudo'ing to the postgres account on the host.
|
||||
- This module uses psycopg2, a Python PostgreSQL database adapter. You must
|
||||
ensure that psycopg2 is installed on the host before using this module. If
|
||||
the remote host is the PostgreSQL server (which is the default case), then
|
||||
PostgreSQL must also be installed on the remote host. For Ubuntu-based
|
||||
systems, install the postgresql, libpq-dev, and python-psycopg2 packages
|
||||
on the remote host before using this module.
|
||||
- The default authentication assumes that you are either logging in as or
|
||||
sudo'ing to the postgres account on the host.
|
||||
- This module uses psycopg2, a Python PostgreSQL database adapter. You must
|
||||
ensure that psycopg2 is installed on the host before using this module.
|
||||
- If the remote host is the PostgreSQL server (which is the default case), then
|
||||
PostgreSQL must also be installed on the remote host.
|
||||
- For Ubuntu-based systems, install the postgresql, libpq-dev, and python-psycopg2 packages
|
||||
on the remote host before using this module.
|
||||
requirements: [ psycopg2 ]
|
||||
|
||||
author:
|
||||
- "Jens Depuydt (@jensdepuydt)"
|
||||
- "Thomas O'Donnell (@andytom)"
|
||||
- Jens Depuydt (@jensdepuydt)
|
||||
- Thomas O'Donnell (@andytom)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
# Add language pltclu to database testdb if it doesn't exist:
|
||||
- postgresql_lang db=testdb lang=pltclu state=present
|
||||
EXAMPLES = r'''
|
||||
- name: Add language pltclu to database testdb if it doesn't exist
|
||||
postgresql_lang: db=testdb lang=pltclu state=present
|
||||
|
||||
# Add language pltclu to database testdb if it doesn't exist and mark it as trusted:
|
||||
# Marks the language as trusted if it exists but isn't trusted yet
|
||||
# Add language pltclu to database testdb if it doesn't exist and mark it as trusted.
|
||||
# Marks the language as trusted if it exists but isn't trusted yet.
|
||||
# force_trust makes sure that the language will be marked as trusted
|
||||
- postgresql_lang:
|
||||
- name: Add language pltclu to database testdb if it doesn't exist and mark it as trusted
|
||||
postgresql_lang:
|
||||
db: testdb
|
||||
lang: pltclu
|
||||
state: present
|
||||
trust: yes
|
||||
force_trust: yes
|
||||
|
||||
# Remove language pltclu from database testdb:
|
||||
- postgresql_lang:
|
||||
- name: Remove language pltclu from database testdb
|
||||
postgresql_lang:
|
||||
db: testdb
|
||||
lang: pltclu
|
||||
state: absent
|
||||
|
||||
# Remove language pltclu from database testdb and remove all dependencies:
|
||||
- postgresql_lang:
|
||||
- name: Remove language pltclu from database testdb and remove all dependencies
|
||||
postgresql_lang:
|
||||
db: testdb
|
||||
lang: pltclu
|
||||
state: absent
|
||||
cascade: yes
|
||||
|
||||
# Remove language c from database testdb but ignore errors if something prevents the removal:
|
||||
- postgresql_lang:
|
||||
- name: Remove language c from database testdb but ignore errors if something prevents the removal
|
||||
postgresql_lang:
|
||||
db: testdb
|
||||
lang: pltclu
|
||||
state: absent
|
||||
fail_on_drop: no
|
||||
'''
|
||||
|
||||
RETURN = r'''
|
||||
queries:
|
||||
description: List of executed queries.
|
||||
returned: always
|
||||
type: list
|
||||
sample: ['CREATE LANGUAGE "acme"']
|
||||
version_added: '2.8'
|
||||
'''
|
||||
|
||||
import traceback
|
||||
|
||||
PSYCOPG2_IMP_ERR = None
|
||||
try:
|
||||
import psycopg2
|
||||
postgresqldb_found = True
|
||||
except ImportError:
|
||||
PSYCOPG2_IMP_ERR = traceback.format_exc()
|
||||
postgresqldb_found = False
|
||||
else:
|
||||
postgresqldb_found = True
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
|
||||
from ansible.module_utils.postgres import postgres_common_argument_spec
|
||||
from ansible.module_utils.six import iteritems
|
||||
from ansible.module_utils._text import to_native
|
||||
from ansible.module_utils.database import pg_quote_identifier
|
||||
|
||||
executed_queries = []
|
||||
|
||||
|
||||
def lang_exists(cursor, lang):
|
||||
"""Checks if language exists for db"""
|
||||
query = "SELECT lanname FROM pg_language WHERE lanname='%s'" % lang
|
||||
query = "SELECT lanname FROM pg_language WHERE lanname = '%s'" % lang
|
||||
cursor.execute(query)
|
||||
return cursor.rowcount > 0
|
||||
|
||||
|
||||
def lang_istrusted(cursor, lang):
|
||||
"""Checks if language is trusted for db"""
|
||||
query = "SELECT lanpltrusted FROM pg_language WHERE lanname='%s'" % lang
|
||||
query = "SELECT lanpltrusted FROM pg_language WHERE lanname = '%s'" % lang
|
||||
cursor.execute(query)
|
||||
return cursor.fetchone()[0]
|
||||
|
||||
|
||||
def lang_altertrust(cursor, lang, trust):
|
||||
"""Changes if language is trusted for db"""
|
||||
query = "UPDATE pg_language SET lanpltrusted = %s WHERE lanname=%s"
|
||||
cursor.execute(query, (trust, lang))
|
||||
query = "UPDATE pg_language SET lanpltrusted = '%s' WHERE lanname = '%s'" % (trust, lang)
|
||||
executed_queries.append(query)
|
||||
cursor.execute(query)
|
||||
return True
|
||||
|
||||
|
||||
|
|
@ -201,6 +240,7 @@ def lang_add(cursor, lang, trust):
|
|||
query = 'CREATE TRUSTED LANGUAGE "%s"' % lang
|
||||
else:
|
||||
query = 'CREATE LANGUAGE "%s"' % lang
|
||||
executed_queries.append(query)
|
||||
cursor.execute(query)
|
||||
return True
|
||||
|
||||
|
|
@ -210,9 +250,11 @@ def lang_drop(cursor, lang, cascade):
|
|||
cursor.execute("SAVEPOINT ansible_pgsql_lang_drop")
|
||||
try:
|
||||
if cascade:
|
||||
cursor.execute("DROP LANGUAGE \"%s\" CASCADE" % lang)
|
||||
query = "DROP LANGUAGE \"%s\" CASCADE" % lang
|
||||
else:
|
||||
cursor.execute("DROP LANGUAGE \"%s\"" % lang)
|
||||
query = "DROP LANGUAGE \"%s\"" % lang
|
||||
executed_queries.append(query)
|
||||
cursor.execute(query)
|
||||
except Exception:
|
||||
cursor.execute("ROLLBACK TO SAVEPOINT ansible_pgsql_lang_drop")
|
||||
cursor.execute("RELEASE SAVEPOINT ansible_pgsql_lang_drop")
|
||||
|
|
@ -222,26 +264,25 @@ def lang_drop(cursor, lang, cascade):
|
|||
|
||||
|
||||
def main():
|
||||
argument_spec = postgres_common_argument_spec()
|
||||
argument_spec.update(
|
||||
db=dict(type="str", required=True, aliases=["login_db"]),
|
||||
port=dict(type="int", default=5432, aliases=["login_port"]),
|
||||
lang=dict(type="str", required=True, aliases=["name"]),
|
||||
state=dict(type="str", default="present", choices=["absent", "present"]),
|
||||
trust=dict(type="bool", default="no"),
|
||||
force_trust=dict(type="bool", default="no"),
|
||||
cascade=dict(type="bool", default="no"),
|
||||
fail_on_drop=dict(type="bool", default="yes"),
|
||||
ssl_mode=dict(default='prefer', choices=[
|
||||
'allow', 'disable', 'prefer', 'require', 'verify-ca', 'verify-full']),
|
||||
ca_cert=dict(default=None, aliases=["ssl_rootcert"]),
|
||||
session_role=dict(type="str"),
|
||||
)
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
login_user=dict(default="postgres"),
|
||||
login_password=dict(default="", no_log=True),
|
||||
login_host=dict(default=""),
|
||||
login_unix_socket=dict(default=""),
|
||||
db=dict(required=True),
|
||||
port=dict(default='5432'),
|
||||
lang=dict(required=True),
|
||||
state=dict(default="present", choices=["absent", "present"]),
|
||||
trust=dict(type='bool', default='no'),
|
||||
force_trust=dict(type='bool', default='no'),
|
||||
cascade=dict(type='bool', default='no'),
|
||||
fail_on_drop=dict(type='bool', default='yes'),
|
||||
ssl_mode=dict(default='prefer', choices=[
|
||||
'disable', 'allow', 'prefer', 'require', 'verify-ca', 'verify-full']),
|
||||
ca_cert=dict(default=None, aliases=['ssl_rootcert']),
|
||||
session_role=dict(),
|
||||
),
|
||||
supports_check_mode=True
|
||||
argument_spec=argument_spec,
|
||||
supports_check_mode=True,
|
||||
)
|
||||
|
||||
db = module.params["db"]
|
||||
|
|
@ -336,6 +377,7 @@ def main():
|
|||
db_connection.commit()
|
||||
|
||||
kw['changed'] = changed
|
||||
kw['queries'] = executed_queries
|
||||
module.exit_json(**kw)
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue