Deprecate port option (#860)

* Deprecate port aliases in favor of login_port

Author: Andersson007

changelogs/fragments/0-port.yml

@@ -0,0 +1,2 @@
+deprecated_features:
+- postgresql modules - the ``port`` alias is deprecated and will be removed in ``community.postgresql 5.0.0``, use the ``login_port`` argument instead.

plugins/doc_fragments/postgres.py

@@ -35,12 +35,13 @@ class ModuleDocFragment(object):
     type: str
     default: ''
     aliases: [ unix_socket ]
-  port:
+  login_port:
     description:
       - Database port to connect to.
+      - The C(port) alias is deprecated and will be removed in the next major release. Use C(login_port) instead.
     type: int
     default: 5432
-    aliases: [ login_port ]
+    aliases: [ port ]
   ssl_mode:
     description:
       - Determines whether or with what priority a secure SSL TCP/IP connection will be negotiated with the server.

plugins/module_utils/postgres.py

@@ -104,10 +104,16 @@ def postgres_common_argument_spec():
                 'collection_name': 'community.postgresql',
             }],
         ),
-        port=dict(
+        login_port=dict(
             type='int',
             default=int(env_vars.get("PGPORT", 5432)),
-            aliases=['login_port']
+            aliases=['port'], deprecated_aliases=[
+                {
+                    'name': 'port',
+                    'version': '5.0.0',
+                    'collection_name': 'community.postgresql',
+                }
+            ],
         ),
         ssl_mode=dict(
             default='prefer',
@@ -286,7 +292,7 @@ def get_conn_params(module, params_dict, warn_db_default=True):
         "login_host": "host",
         "login_user": "user",
         "login_password": "password",
-        "port": "port",
+        "login_port": "port",
         "ssl_mode": "sslmode",
         "ca_cert": "sslrootcert",
         "ssl_cert": "sslcert",

plugins/modules/postgresql_slot.py

@@ -129,7 +129,7 @@
   community.postgresql.postgresql_slot:
     name: logical_one
     login_host: mydatabase.example.org
-    port: 5433
+    login_port: 5433
     login_user: ourSuperuser
     login_password: thePassword
     state: absent

tests/integration/targets/setup_postgresql_db/tasks/main.yml

@@ -2,7 +2,6 @@
 # WARNING: These are designed specifically for Ansible tests       #
 # and should not be used as examples of how to write Ansible roles #
 ####################################################################
-
 - name: python 2
   set_fact:
     python_suffix: ''
@@ -49,15 +48,14 @@
 
 - name: remove old db config and files (debian)
   file:
-    path: '{{ loop_item }}'
+    path: '{{ item }}'
     state: absent
   ignore_errors: true
   when: ansible_os_family == "Debian"
   loop:
+  - '{{ pg_dir }}'
   - /etc/postgresql
   - /var/lib/postgresql
-  loop_control:
-    loop_var: loop_item
 
 #
 # Prepare Ubuntu for PostgreSQL install

tests/unit/plugins/module_utils/test_postgres.py

@@ -17,7 +17,7 @@
     login_password=dict(default='test', no_log=True),
     login_host=dict(default='test'),
     login_unix_socket=dict(default=''),
-    port=dict(type='int', default=5432, aliases=['login_port']),
+    login_port=dict(type='int', default=5432, aliases=['port']),
     ssl_mode=dict(
         default='prefer',
         choices=['allow', 'disable', 'prefer', 'require', 'verify-ca', 'verify-full']
@@ -31,7 +31,7 @@
     user=dict(default='postgres'),
     password=dict(default='test', no_log=True),
     host=dict(default='test'),
-    port=dict(type='int', default=5432, aliases=['login_port']),
+    port=dict(type='int', aliases=['port'], default=5432),
     sslmode=dict(
         default='prefer',
         choices=['allow', 'disable', 'prefer', 'require', 'verify-ca', 'verify-full']
@@ -79,7 +79,13 @@ def test_postgres_common_argument_spec(self):
                     'collection_name': 'community.postgresql',
                 }
             ]),
-            port=dict(type='int', default=5432, aliases=['login_port']),
+            login_port=dict(type='int', default=5432, aliases=['port'], deprecated_aliases=[
+                {
+                    'collection_name': 'community.postgresql',
+                    'name': 'port',
+                    'version': '5.0.0'
+                }
+            ]),
             ssl_mode=dict(
                 default='prefer',
                 choices=['allow', 'disable', 'prefer', 'require', 'verify-ca', 'verify-full']
@@ -92,7 +98,7 @@ def test_postgres_common_argument_spec(self):
         assert pg.postgres_common_argument_spec() == expected_dict
 
         # Setting new values for checking environment variables
-        expected_dict['port']['default'] = 5435
+        expected_dict['login_port']['default'] = 5435
         expected_dict['login_user']['default'] = 'test_user'
 
         # Setting environment variables