ansible-collections/community.mysql
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.mysql.git synced 2025-04-05 10:10:32 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

mysql_replication: add deprecation warning about future replacement of Is_Slave and Is_Master return values, add alternatives (#147)

Browse source 
* mysql_replication: add deprecation warning about future replacement of Is_Slave and Is_Master return values, add alternatives

* Add changelog fragment
This commit is contained in:
Andrew Klychkov 2021-04-16 06:34:35 +02:00 • committed by GitHub
parent f7c84a71e5
commit 853db5a2a4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 26 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
changelogs/fragments/147-mysql_replication_deprecate_ret_vals.yml Normal file
View file

@ -0,0 +1,5 @@
major_changes:
- mysql_replication - add deprecation warning that the ``Is_Slave`` and ``Is_Master`` return values will be replaced with ``Is_Primary`` and ``Is_Replica`` in ``community.mysql`` 3.0.0 (https://github.com/ansible-collections/community.mysql/pull/147).
minor_changes:
- mysql_replication - add the ``Is_Primary`` and ``Is_Replica`` alternatives to the ``Is_Slave`` and ``Is_Master`` return values as a preparation for replacement in ``community.mysql`` 3.0.0 (https://github.com/ansible-collections/community.mysql/pull/147).

23
plugins/modules/mysql_replication.py
View file

@ -524,9 +524,17 @@ def main():
if mode in "getmaster": if mode in "getmaster":
status = get_master_status(cursor) status = get_master_status(cursor)
if not isinstance(status, dict): if not isinstance(status, dict):
status = dict(Is_Master=False, msg="Server is not configured as mysql master") status = dict(Is_Master=False, Is_Primary=False,
msg="Server is not configured as mysql master")
else: else:
status['Is_Master'] = True 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) module.exit_json(queries=executed_queries, **status)
elif mode in ("getreplica", "getslave"): elif mode in ("getreplica", "getslave"):
@ -536,13 +544,16 @@ def main():
status = get_replica_status(cursor, connection_name, channel, replica_term) status = get_replica_status(cursor, connection_name, channel, replica_term)
if not isinstance(status, dict): if not isinstance(status, dict):
# TODO: announce it and replace with Replica status = dict(Is_Slave=False, Is_Replica=False, msg="Server is not configured as mysql replica")
# in the next major release. Maybe a warning?
status = dict(Is_Slave=False, msg="Server is not configured as mysql replica")
else: else:
# TODO: announce it and replace with Replica
# in the next major release. Maybe a warning?
status['Is_Slave'] = True 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) module.exit_json(queries=executed_queries, **status)
elif mode in "changemaster": elif mode in "changemaster":

4
tests/integration/targets/test_mysql_replication/tasks/mysql_replication_channel.yml
View file

@ -61,7 +61,7 @@
- assert: - assert:
that: that:
- replica_status.Is_Slave == true - replica_status.Is_Replica == true
- replica_status.Master_Host == '{{ mysql_host }}' - replica_status.Master_Host == '{{ mysql_host }}'
- replica_status.Exec_Master_Log_Pos == mysql_primary_status.Position - replica_status.Exec_Master_Log_Pos == mysql_primary_status.Position
- replica_status.Master_Port == {{ mysql_primary_port }} - replica_status.Master_Port == {{ mysql_primary_port }}
@ -73,7 +73,7 @@
- assert: - assert:
that: that:
- replica_status.Is_Slave == true - replica_status.Is_Replica == true
- replica_status.Source_Host == '{{ mysql_host }}' - replica_status.Source_Host == '{{ mysql_host }}'
- replica_status.Exec_Source_Log_Pos == mysql_primary_status.Position - replica_status.Exec_Source_Log_Pos == mysql_primary_status.Position
- replica_status.Source_Port == {{ mysql_primary_port }} - replica_status.Source_Port == {{ mysql_primary_port }}

4
tests/integration/targets/test_mysql_replication/tasks/mysql_replication_initial.yml
View file

@ -59,7 +59,7 @@
- assert: - assert:
that: that:
- mysql_primary_status.Is_Master == true - mysql_primary_status.Is_Primary == true
- mysql_primary_status.Position != 0 - mysql_primary_status.Position != 0
- mysql_primary_status is not changed - mysql_primary_status is not changed
@ -148,7 +148,7 @@
- assert: - assert:
that: that:
- replica_status.Is_Slave == true - replica_status.Is_Replica == true
- replica_status.Master_Host == '{{ mysql_host }}' - replica_status.Master_Host == '{{ mysql_host }}'
- replica_status.Exec_Master_Log_Pos == mysql_primary_status.Position - replica_status.Exec_Master_Log_Pos == mysql_primary_status.Position
- replica_status.Master_Port == {{ mysql_primary_port }} - replica_status.Master_Port == {{ mysql_primary_port }}