fix(rabbitmq_plugin): add node to module args by rockandska · Pull Request #106 · ansible-collections/community.rabbitmq

rockandska · 2021-10-27T22:49:49Z

SUMMARY

Add node argument to rabbitmq_plugin the same way as other module ( close #59 )

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME

rabbitmq_plugin

ADDITIONAL INFORMATION

Integration test and unit test ok
Minimal test added

ansible-test units --docker default -v --color --python 3.8
ansible-test integration rabbitmq_plugin --docker default -v --color --python 3.8

@odyssey4me / @Andersson007 : since #101 is still a WIP.

Regards,

rockandska · 2021-10-28T12:54:14Z

For an obscure reason, previously to ansible 2.12 if the node argument contain an @ as rabbibt@node-1, in cmd output the node is replaced with by '' but the error reflect that the argument -n rabbit@node-1 was provided.

I updated the test to remove @ and be able to test cmd, but there is definitely something odd

Andersson007

@rockandska hi, thanks for the PR and welcome to the project!

Could you also please

Add a changelog fragment.
Maybe it's worth adding an example to the EXAMPLES block?
Clarify if this option works for any supported rabbitmq versions?

Thank you

cc @cognifloyd @Im0 @odyssey4me

plugins/modules/rabbitmq_plugin.py

Im0 · 2021-10-30T11:23:44Z

@rockandska good one. Looks good to me. It would be great if you could add suggestions 1 & 2 from @Andersson007

rockandska · 2021-11-02T08:18:56Z

Done

Im0

Thanks again for this. When I tried to find when -n was introduced to rabbitmq-plugins I thought perhaps we don't default for -n in the code? Please see comments near line 155.

Im0 · 2021-11-03T01:26:21Z

plugins/modules/rabbitmq_plugin.py

    arg_spec = dict(
        names=dict(required=True, aliases=['name']),
        new_only=dict(default='no', type='bool'),
+        node=dict(default='rabbit'),


I was just wondering, by specifying default='rabbit' here would this always populate self.module.params['node'] with rabbit regardless of what's in the playbook?

I was looking through the rabbitmq.server code on github, but, it seems quite time consuming to go back through all the versions looking for when -n was introduced to rabbitmqctl/rabbitmq-plugins...

I was wondering, can we guarantee backward compatibility by changing line 155 to:

node=dict(type='str')

At least then, the user can chose not to put node in their playbook at it will work as before. What do you think?

The option is here at least since rabbitmq:3.4.4 ( 11 February 2015 )

$ docker run --rm -ti --entrypoint /bin/bash rabbitmq:3.4.4 root@cfd69b2f4d2c:/# rabbitmq-plugins Error: could not recognise command Usage: rabbitmq-plugins [-n <node>] <command> [<command options>] Commands: list [-v] [-m] [-E] [-e] [<pattern>] enable [--offline] [--online] <plugin> ... disable [--offline] [--online] <plugin> ... set [--offline] [--online] <plugin> ... root@cfd69b2f4d2c:/#

At least then, the user can chose not to put node in their playbook at it will work as before. What do you think?

I personally prefer to have all modules working the same that having some specificities depending on the module

Thanks for checking that. It appears that 3.4.4 is the earliest docker container.

I personally prefer to have all modules working the same that having some specificities depending on the module

The only risk with the proposed PR is that it will specify -n on the command line all the time as default specifies rabbit. In it self, that is fine but if someone is using an older than 3.4.4. version which does not support -n and they use the latest community.rabbitmq version a rabbitmq_plugin playbook will fail. I was just trying to avoid this potential backwards compatibility issue... although it maybe quite a small risk?

If we proceed as is, perhaps we consider adjusting the changelog fragment to include a message that this will be a breaking change if the users rabbitmq-plugins does not support the -n flag. How does that sound?

IMO all module should not force options if not mandatory but for an obscure reason -n seems forced in many rabbitmq module and is the only reason why I add it.
So it is your call here, but it will be more consistent to apply this choice to all modules in a future PR.

Off-topic : For an example, #35 broke my ansible role because the choice was made to force --online when this option is not mandatory and rabbitmq-plugins is able to do the choice itself.....

@Im0 / @Andersson007 : so, force or not force -n ?

@cognifloyd @Im0 @odyssey4me what do you think?

@rockandska I'm unfortunately not an expert in the context, so i can provide only general feedback.
I can say that if we're gonna introduce any breaking changes, it would be nice:

to announce this in advance, i.e. that it's gonna happen in the next major release or so

release the major version in some time after the announcement

@cognifloyd @Im0 @odyssey4me PTAL ^ Hope you folks have great holidays:)

Andersson007

@rockandska thanks for working on this and sorry for the delayed feedback - I'm not a specialist at all and I've hoped the folks had a look.
As @Im0 has taken part in the discussion and there were no objections from his side, please take a look at my suggestions and, I think, I'll merge the PR right after they are implemented.
Thank you!

Andersson007 · 2022-01-11T09:35:30Z

changelogs/fragments/106-use-node-with-plugin.yml

@@ -0,0 +1,2 @@
+minor_changes:
+  - rabbitmq_plugin - add node arguments.


Suggested change

- rabbitmq_plugin - add node arguments.

- rabbitmq_plugin - add the ``node`` argument (https://github.com/ansible-collections/community.rabbitmq/pull/106).

Andersson007 · 2022-01-11T09:37:06Z

plugins/modules/rabbitmq_plugin.py

+    description:
+      - Erlang node name of the rabbit we wish to configure.
+    type: str
+    default: rabbit


Suggested change

default: rabbit

default: rabbit

version_added: '1.2.0'

Andersson007 · 2022-01-11T09:43:22Z

plugins/modules/rabbitmq_plugin.py

    default: "no"
+  node:
+    description:
+      - Erlang node name of the rabbit we wish to configure.


Suggested change

- Erlang node name of the rabbit we wish to configure.

- Erlang node name of the rabbit we wish to configure.

Please also add a note that this use -n under the hood and since which version this is supported.
If users don't use this argument, everything should be OK in terms of backwards compatibility, right?

fix(rabbitmq_plugin): add node to module args

2a6d1c2

rockandska force-pushed the fix_node_plugin branch from 690639a to 2a6d1c2 Compare October 28, 2021 12:45

Andersson007 reviewed Oct 29, 2021

View reviewed changes

plugins/modules/rabbitmq_plugin.py Outdated Show resolved Hide resolved

rockandska added 2 commits November 2, 2021 09:04

chore(changelog): add fragment

2ca7511

chore(rabbitmq_plugin): add example for node arg

e129073

rockandska force-pushed the fix_node_plugin branch from edddbc7 to e129073 Compare November 2, 2021 08:17

Im0 self-requested a review November 3, 2021 01:11

Im0 reviewed Nov 3, 2021

View reviewed changes

Andersson007 reviewed Jan 11, 2022

View reviewed changes

		@@ -0,0 +1,2 @@
		minor_changes:
		- rabbitmq_plugin - add node arguments.

	- rabbitmq_plugin - add node arguments.
	- rabbitmq_plugin - add the ``node`` argument (https://github.com/ansible-collections/community.rabbitmq/pull/106).

	- Erlang node name of the rabbit we wish to configure.
	- Erlang node name of the rabbit we wish to configure.

Conversation

rockandska commented Oct 27, 2021

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

Uh oh!

rockandska commented Oct 28, 2021

Uh oh!

Andersson007 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Im0 commented Oct 30, 2021

Uh oh!

rockandska commented Nov 2, 2021

Uh oh!

Im0 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rockandska Nov 3, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Andersson007 left a comment

Choose a reason for hiding this comment

Uh oh!

Andersson007 Jan 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rockandska Nov 3, 2021 •

edited

Loading

Andersson007 Jan 11, 2022 •

edited

Loading