Initial commit

plugins/modules/database/postgresql/postgresql_schema.py

@@ -0,0 +1,279 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2016, Ansible Project
+# 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
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+DOCUMENTATION = r'''
+---
+module: postgresql_schema
+short_description: Add or remove PostgreSQL schema
+description:
+- Add or remove PostgreSQL schema.
+options:
+  name:
+    description:
+    - Name of the schema to add or remove.
+    required: true
+    type: str
+    aliases:
+    - schema
+  database:
+    description:
+    - Name of the database to connect to and add or remove the schema.
+    type: str
+    default: postgres
+    aliases:
+    - db
+    - login_db
+  owner:
+    description:
+    - Name of the role to set as owner of the schema.
+    type: str
+  session_role:
+    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 schema state.
+    type: str
+    default: present
+    choices: [ absent, present ]
+  cascade_drop:
+    description:
+    - Drop schema with CASCADE to remove child objects.
+    type: bool
+    default: false
+  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.
+    type: str
+    default: prefer
+    choices: [ allow, disable, prefer, require, verify-ca, verify-full ]
+  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.
+    type: str
+    aliases: [ ssl_rootcert ]
+seealso:
+- name: PostgreSQL schemas
+  description: General information about PostgreSQL schemas.
+  link: https://www.postgresql.org/docs/current/ddl-schemas.html
+- name: CREATE SCHEMA reference
+  description: Complete reference of the CREATE SCHEMA command documentation.
+  link: https://www.postgresql.org/docs/current/sql-createschema.html
+- name: ALTER SCHEMA reference
+  description: Complete reference of the ALTER SCHEMA command documentation.
+  link: https://www.postgresql.org/docs/current/sql-alterschema.html
+- name: DROP SCHEMA reference
+  description: Complete reference of the DROP SCHEMA command documentation.
+  link: https://www.postgresql.org/docs/current/sql-dropschema.html
+author:
+- Flavien Chantelot (@Dorn-) <contact@flavien.io>
+- Thomas O'Donnell (@andytom)
+extends_documentation_fragment:
+- community.general.postgres
+
+'''
+
+EXAMPLES = r'''
+- name: Create a new schema with name acme in test database
+  postgresql_schema:
+    db: test
+    name: acme
+
+- name: Create a new schema acme with a user bob who will own it
+  postgresql_schema:
+    name: acme
+    owner: bob
+
+- name: Drop schema "acme" with cascade
+  postgresql_schema:
+    name: acme
+    state: absent
+    cascade_drop: yes
+'''
+
+RETURN = r'''
+schema:
+  description: Name of the schema.
+  returned: success, changed
+  type: str
+  sample: "acme"
+queries:
+  description: List of executed queries.
+  returned: always
+  type: list
+  sample: ["CREATE SCHEMA \"acme\""]
+'''
+
+import traceback
+
+try:
+    from psycopg2.extras import DictCursor
+except ImportError:
+    # psycopg2 is checked by connect_to_db()
+    # from ansible.module_utils.postgres
+    pass
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.community.general.plugins.module_utils.postgres import (
+    connect_to_db,
+    get_conn_params,
+    postgres_common_argument_spec,
+)
+from ansible_collections.community.general.plugins.module_utils.database import SQLParseError, pg_quote_identifier
+from ansible.module_utils._text import to_native
+
+executed_queries = []
+
+
+class NotSupportedError(Exception):
+    pass
+
+
+# ===========================================
+# PostgreSQL module specific support methods.
+#
+
+def set_owner(cursor, schema, owner):
+    query = "ALTER SCHEMA %s OWNER TO %s" % (
+            pg_quote_identifier(schema, 'schema'),
+            pg_quote_identifier(owner, 'role'))
+    cursor.execute(query)
+    executed_queries.append(query)
+    return True
+
+
+def get_schema_info(cursor, schema):
+    query = ("SELECT schema_owner AS owner "
+             "FROM information_schema.schemata "
+             "WHERE schema_name = %(schema)s")
+    cursor.execute(query, {'schema': schema})
+    return cursor.fetchone()
+
+
+def schema_exists(cursor, schema):
+    query = ("SELECT schema_name FROM information_schema.schemata "
+             "WHERE schema_name = %(schema)s")
+    cursor.execute(query, {'schema': schema})
+    return cursor.rowcount == 1
+
+
+def schema_delete(cursor, schema, cascade):
+    if schema_exists(cursor, schema):
+        query = "DROP SCHEMA %s" % pg_quote_identifier(schema, 'schema')
+        if cascade:
+            query += " CASCADE"
+        cursor.execute(query)
+        executed_queries.append(query)
+        return True
+    else:
+        return False
+
+
+def schema_create(cursor, schema, owner):
+    if not schema_exists(cursor, schema):
+        query_fragments = ['CREATE SCHEMA %s' % pg_quote_identifier(schema, 'schema')]
+        if owner:
+            query_fragments.append('AUTHORIZATION %s' % pg_quote_identifier(owner, 'role'))
+        query = ' '.join(query_fragments)
+        cursor.execute(query)
+        executed_queries.append(query)
+        return True
+    else:
+        schema_info = get_schema_info(cursor, schema)
+        if owner and owner != schema_info['owner']:
+            return set_owner(cursor, schema, owner)
+        else:
+            return False
+
+
+def schema_matches(cursor, schema, owner):
+    if not schema_exists(cursor, schema):
+        return False
+    else:
+        schema_info = get_schema_info(cursor, schema)
+        if owner and owner != schema_info['owner']:
+            return False
+        else:
+            return True
+
+# ===========================================
+# Module execution.
+#
+
+
+def main():
+    argument_spec = postgres_common_argument_spec()
+    argument_spec.update(
+        schema=dict(type="str", required=True, aliases=['name']),
+        owner=dict(type="str", default=""),
+        database=dict(type="str", default="postgres", aliases=["db", "login_db"]),
+        cascade_drop=dict(type="bool", default=False),
+        state=dict(type="str", default="present", choices=["absent", "present"]),
+        session_role=dict(type="str"),
+    )
+
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        supports_check_mode=True,
+    )
+
+    schema = module.params["schema"]
+    owner = module.params["owner"]
+    state = module.params["state"]
+    cascade_drop = module.params["cascade_drop"]
+    changed = False
+
+    conn_params = get_conn_params(module, module.params)
+    db_connection = connect_to_db(module, conn_params, autocommit=True)
+    cursor = db_connection.cursor(cursor_factory=DictCursor)
+
+    try:
+        if module.check_mode:
+            if state == "absent":
+                changed = not schema_exists(cursor, schema)
+            elif state == "present":
+                changed = not schema_matches(cursor, schema, owner)
+            module.exit_json(changed=changed, schema=schema)
+
+        if state == "absent":
+            try:
+                changed = schema_delete(cursor, schema, cascade_drop)
+            except SQLParseError as e:
+                module.fail_json(msg=to_native(e), exception=traceback.format_exc())
+
+        elif state == "present":
+            try:
+                changed = schema_create(cursor, schema, owner)
+            except SQLParseError as e:
+                module.fail_json(msg=to_native(e), exception=traceback.format_exc())
+    except NotSupportedError as e:
+        module.fail_json(msg=to_native(e), exception=traceback.format_exc())
+    except SystemExit:
+        # Avoid catching this on Python 2.4
+        raise
+    except Exception as e:
+        module.fail_json(msg="Database query failed: %s" % to_native(e), exception=traceback.format_exc())
+
+    db_connection.close()
+    module.exit_json(changed=changed, schema=schema, queries=executed_queries)
+
+
+if __name__ == '__main__':
+    main()