mysql_replication: remove mode values and ret values containing maste…

…r / slave (#252) * mysql_replication: remove mode values containing master / slave * Add tests
ansible-collections · Dec 1, 2021 · 1f796d9 · 1f796d9
1 parent dd47009
commit 1f796d9
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 101 deletions.
diff --git a/changelogs/fragments/300-mysql_replication_remove_master_slave.yml b/changelogs/fragments/300-mysql_replication_remove_master_slave.yml
@@ -0,0 +1,3 @@
+breaking_changes:
+- mysql_replication - remove the mode options values containing ``master``/``slave`` and the master_use_gtid option ``slave_pos`` (were replaced with corresponding ``primary``/``replica`` values) (https://github.com/ansible-collections/community.mysql/issues/145).
+- mysql_replication - remove ``Is_Slave`` and ``Is_Master`` return values (were replaced with ``Is_Primary`` and ``Is_Replica`` (https://github.com/ansible-collections    /community.mysql/issues/145).
diff --git a/plugins/modules/mysql_replication.py b/plugins/modules/mysql_replication.py
@@ -23,32 +23,24 @@
   mode:
     description:
     - Module operating mode. Could be
-      C(changeprimary | changemaster) (CHANGE PRIMARY | MASTER TO),
-      C(getprimary | getmaster) (SHOW PRIMARY | MASTER STATUS),
-      C(getreplica | getslave) (SHOW REPLICA | SLAVE STATUS),
-      C(startreplica | startslave) (START REPLICA | SLAVE),
-      C(stopreplica | stopslave) (STOP REPLICA | SLAVE),
-      C(resetprimary | resetmaster) (RESET PRIMARY | MASTER) - supported since community.mysql 0.1.0,
-      C(resetreplica, resetslave) (RESET REPLICA | SLAVE),
-      C(resetreplicaall, resetslave) (RESET REPLICA | SLAVE ALL).
+      C(changeprimary) (CHANGE PRIMARY TO),
+      C(getprimary) (SHOW PRIMARY STATUS),
+      C(getreplica) (SHOW REPLICA),
+      C(startreplica) (START REPLICA),
+      C(stopreplica) (STOP REPLICA),
+      C(resetprimary) (RESET PRIMARY) - supported since community.mysql 0.1.0,
+      C(resetreplica) (RESET REPLICA),
+      C(resetreplicaall) (RESET REPLICA ALL).
     type: str
     choices:
     - changeprimary
-    - changemaster
     - getprimary
-    - getmaster
     - getreplica
-    - getslave
     - startreplica
-    - startslave
     - stopreplica
-    - stopslave
     - resetprimary
-    - resetmaster
     - resetreplica
-    - resetslave
     - resetreplicaall
-    - resetslaveall
     default: getreplica
   primary_host:
     description:
@@ -153,9 +145,7 @@
     - To find information about available values see
       U(https://mariadb.com/kb/en/library/change-master-to/#master_use_gtid).
     - Available since MariaDB 10.0.2.
-    - C(replica_pos) has been introduced in MariaDB 10.5.1 and
-      it is an alias for C(slave_pos).
-    choices: [current_pos, replica_pos, slave_pos, disabled]
+    choices: [current_pos, replica_pos, disabled]
     type: str
     version_added: '0.1.0'
     aliases: [master_use_gtid]
@@ -441,14 +431,14 @@ def main():
     argument_spec = mysql_common_argument_spec()
     argument_spec.update(
         mode=dict(type='str', default='getreplica', choices=[
-            'getprimary', 'getmaster',
-            'getreplica', 'getslave',
-            'changeprimary', 'changemaster',
-            'stopreplica', 'stopslave',
-            'startreplica', 'startslave',
-            'resetprimary', 'resetmaster',
-            'resetreplica', 'resetslave',
-            'resetreplicaall', 'resetslaveall']),
+            'getprimary',
+            'getreplica',
+            'changeprimary',
+            'stopreplica',
+            'startreplica',
+            'resetprimary',
+            'resetreplica',
+            'resetreplicaall']),
         primary_auto_position=dict(type='bool', default=False, aliases=['master_auto_position']),
         primary_host=dict(type='str', aliases=['master_host']),
         primary_user=dict(type='str', aliases=['master_user']),
@@ -466,7 +456,7 @@ def main():
         primary_ssl_key=dict(type='str', no_log=False, aliases=['master_ssl_key']),
         primary_ssl_cipher=dict(type='str', aliases=['master_ssl_cipher']),
         primary_use_gtid=dict(type='str', choices=[
-            'current_pos', 'replica_pos', 'slave_pos', 'disabled'], aliases=['master_use_gtid']),
+            'current_pos', 'replica_pos', 'disabled'], aliases=['master_use_gtid']),
         primary_delay=dict(type='int', aliases=['master_delay']),
         connection_name=dict(type='str'),
         channel=dict(type='str'),
@@ -540,60 +530,29 @@ def main():
     # "REPLICA" must be used instead of "SLAVE"
     if impl.uses_replica_terminology(cursor):
         replica_term = 'REPLICA'
-        if primary_use_gtid == 'slave_pos':
-            module.deprecate('primary_use_gtid | master_use_gtid "slave_pos" value is '
-                             'deprecated, use "replica_pos" instead.',
-                             version='3.0.0', collection_name='community.mysql')
-            primary_use_gtid = 'replica_pos'
     else:
         replica_term = 'SLAVE'
-        if primary_use_gtid == 'replica_pos':
-            primary_use_gtid = 'slave_pos'
-
-    if mode in ('getprimary', 'getmaster'):
-        if mode == 'getmaster':
-            module.deprecate('"getmaster" option is deprecated, use "getprimary" instead.',
-                             version='3.0.0', collection_name='community.mysql')
 
+    if mode == 'getprimary':
         status = get_primary_status(cursor)
         if not isinstance(status, dict):
-            # TODO: change the word master to primary in 3.0.0
-            status = dict(Is_Master=False, Is_Primary=False,
-                          msg="Server is not configured as mysql master")
+            status = dict(Is_Primary=False,
+                          msg="Server is not configured as mysql primary")
         else:
-            status['Is_Master'] = True
             status['Is_Primary'] = True
 
-        module.deprecate('"Is_Master" and "Is_Slave" return values are deprecated '
-                         'and will be replaced with "Is_Primary" and "Is_Replica" '
-                         'in the next major release. Use "Is_Primary" and "Is_Replica" instead.',
-                         version='3.0.0', collection_name='community.mysql')
-
         module.exit_json(queries=executed_queries, **status)
 
-    elif mode in ("getreplica", "getslave"):
-        if mode == "getslave":
-            module.deprecate('"getslave" option is deprecated, use "getreplica" instead.',
-                             version='3.0.0', collection_name='community.mysql')
-
+    elif mode == "getreplica":
         status = get_replica_status(cursor, connection_name, channel, replica_term)
         if not isinstance(status, dict):
-            status = dict(Is_Slave=False, Is_Replica=False, msg="Server is not configured as mysql replica")
+            status = dict(Is_Replica=False, msg="Server is not configured as mysql replica")
         else:
-            status['Is_Slave'] = True
             status['Is_Replica'] = True
 
-        module.deprecate('"Is_Master" and "Is_Slave" return values are deprecated '
-                         'and will be replaced with "Is_Primary" and "Is_Replica" '
-                         'in the next major release. Use "Is_Primary" and "Is_Replica" instead.',
-                         version='3.0.0', collection_name='community.mysql')
-
         module.exit_json(queries=executed_queries, **status)
 
-    elif mode in ('changeprimary', 'changemaster'):
-        if mode == 'changemaster':
-            module.deprecate('"changemaster" option is deprecated, use "changeprimary" instead.',
-                             version='3.0.0', collection_name='community.mysql')
+    elif mode == 'changeprimary':
         chm = []
         result = {}
         if primary_host is not None:
@@ -640,53 +599,31 @@ def main():
             module.fail_json(msg='%s. Query == CHANGE MASTER TO %s' % (to_native(e), chm))
         result['changed'] = True
         module.exit_json(queries=executed_queries, **result)
-    elif mode in ("startreplica", "startslave"):
-        if mode == "startslave":
-            module.deprecate('"startslave" option is deprecated, use "startreplica" instead.',
-                             version='3.0.0', collection_name='community.mysql')
-
+    elif mode == "startreplica":
         started = start_replica(module, cursor, connection_name, channel, fail_on_error, replica_term)
         if started is True:
             module.exit_json(msg="Replica started ", changed=True, queries=executed_queries)
         else:
             module.exit_json(msg="Replica already started (Or cannot be started)", changed=False, queries=executed_queries)
-    elif mode in ("stopreplica", "stopslave"):
-        if mode == "stopslave":
-            module.deprecate('"stopslave" option is deprecated, use "stopreplica" instead.',
-                             version='3.0.0', collection_name='community.mysql')
-
+    elif mode == "stopreplica":
         stopped = stop_replica(module, cursor, connection_name, channel, fail_on_error, replica_term)
         if stopped is True:
             module.exit_json(msg="Replica stopped", changed=True, queries=executed_queries)
         else:
             module.exit_json(msg="Replica already stopped", changed=False, queries=executed_queries)
-    elif mode in ('resetprimary', 'resetmaster'):
-        if mode == 'resetmaster':
-            module.deprecate('"resetmaster" option is deprecated, use "resetprimary" instead.',
-                             version='3.0.0', collection_name='community.mysql')
-
+    elif mode == 'resetprimary':
         reset = reset_primary(module, cursor, fail_on_error)
         if reset is True:
-            # TODO: Change "Master" to "Primary" in release 3.0.0
-            module.exit_json(msg="Master reset", changed=True, queries=executed_queries)
+            module.exit_json(msg="Primary reset", changed=True, queries=executed_queries)
         else:
-            # TODO: Change "Master" to "Primary" in release 3.0.0
-            module.exit_json(msg="Master already reset", changed=False, queries=executed_queries)
-    elif mode in ("resetreplica", "resetslave"):
-        if mode == "resetslave":
-            module.deprecate('"resetslave" option is deprecated, use "resetreplica" instead.',
-                             version='3.0.0', collection_name='community.mysql')
-
+            module.exit_json(msg="Primary already reset", changed=False, queries=executed_queries)
+    elif mode == "resetreplica":
         reset = reset_replica(module, cursor, connection_name, channel, fail_on_error, replica_term)
         if reset is True:
             module.exit_json(msg="Replica reset", changed=True, queries=executed_queries)
         else:
             module.exit_json(msg="Replica already reset", changed=False, queries=executed_queries)
-    elif mode in ("resetreplicaall", "resetslaveall"):
-        if mode == "resetslaveall":
-            module.deprecate('"resetslaveall" option is deprecated, use "resetreplicaall" instead.',
-                             version='3.0.0', collection_name='community.mysql')
-
+    elif mode == "resetreplicaall":
         reset = reset_replica_all(module, cursor, connection_name, channel, fail_on_error, replica_term)
         if reset is True:
             module.exit_json(msg="Replica reset", changed=True, queries=executed_queries)

diff --git a/tests/integration/targets/test_mysql_replication/tasks/mysql_replication_initial.yml b/tests/integration/targets/test_mysql_replication/tasks/mysql_replication_initial.yml
@@ -64,11 +64,11 @@
         - mysql_primary_status is not changed
 
     # Test startreplica fails without changeprimary first. This needs fail_on_error
-    - name: Start replica (using deprecated startslave choice) and fail because primary is not specified; failing on error as requested
+    - name: Start replica and fail because primary is not specified; failing on error as requested
       mysql_replication:
         <<: *mysql_params
         login_port: '{{ mysql_replica1_port }}'
-        mode: startslave
+        mode: startreplica
         fail_on_error: yes
       register: result
       ignore_errors: yes
@@ -139,11 +139,11 @@
         - result.queries == ["START SLAVE"] or result.queries == ["START REPLICA"]
 
     # Test getreplica mode:
-    - name: Get replica status using deprecated getslave choice
+    - name: Get replica status
       mysql_replication:
         <<: *mysql_params
         login_port: '{{ mysql_replica1_port }}'
-        mode: getslave
+        mode: getreplica
       register: replica_status
 
     - assert:
@@ -159,7 +159,7 @@
 
     - assert:
         that:
-        - replica_status.Is_Slave == true
+        - replica_status.Is_Replica == true
         - replica_status.Source_Host == '{{ mysql_host }}'
         - replica_status.Exec_Source_Log_Pos == mysql_primary_status.Position
         - replica_status.Source_Port == {{ mysql_primary_port }}
@@ -216,11 +216,11 @@
       when: (pymysql_version.stdout | default('1000', true)) is version('0.9.3', '<=')
 
     # Test stopreplica mode:
-    - name: Stop replica using deprecated stopslave choice
+    - name: Stop replica
       mysql_replication:
         <<: *mysql_params
         login_port: '{{ mysql_replica1_port }}'
-        mode: stopslave
+        mode: stopreplica
       register: result
 
     - assert:
@@ -241,3 +241,19 @@
         that:
         - result is not changed
       when: (pymysql_version.stdout | default('1000', true)) is version('0.9.3', '<=')
+
+    # master / slave related choices were removed in 3.0.0
+    # https://github.com/ansible-collections/community.mysql/pull/252
+    - name: Test invoking the module with unsupported choice
+      mysql_replication:
+        <<: *mysql_params
+        login_port: '{{ mysql_replica1_port }}'
+        mode: stopslave
+        fail_on_error: true
+      register: result
+      ignore_errors: yes
+
+    - assert:
+        that:
+        - result.msg == "value of mode must be one of{{ ":" }} getprimary, getreplica, changeprimary, stopreplica, startreplica, resetprimary, resetreplica, resetreplicaall, got{{ ":" }} stopslave"
+        - result is failed