cisco_spark -> cisco_webex rename and message option fix #457

networkers-pl · 2020-06-04T05:03:46Z

…ge is associated with the change of the product name from Cisco Spark to Cisco Webex Teams. In addition, the current version (cisco_spark) does not work due to a name collision with MESSAGE. I had to modify the name from "message" to "msg" in many places in cisco_webex. It works fine in this version.

SUMMARY

new module cisco_webex and old module removal (cisco_spark)

ISSUE TYPE

Bugfix Pull Request
New Module Pull Request

COMPONENT NAME

cisco_webex

ADDITIONAL INFORMATION

The original author has been preserved and copied from cisco_spark to cisco_webex.

The current version of cisco_spark module does not work due to a name collision with MESSAGE. I had to modify the name from "message" to "msg" in many places in cisco_webex.py file. It works fine in this version.

cisco_spark module has been deleted, as it doesn't work anymore.

On May 12, 2020, the API URL also changed.
The old one still works, but now instead of api.ciscospark.com, you should use webexapis.com.
I also added it to the changes.

More details can be found here:
https://developer.webex.com/blog/introducing-the-new-webexapis-com

Also the old links from documentation section didn't work, as Spark is no longer there.
I changed them to other Cisco Webex.

The name change is associated with the change of the product name from Cisco Spark to Cisco Webex Teams.

@drew-russell

…is associated with the change of the product name from Cisco Spark to Cisco Webex Teams. In addition, the current version (cisco_spark) does not work due to a name collision with MESSAGE. I had to modify the name from "message" to "webexmsg" in many places in cisco_webex. It works fine in this version. The original author has been preserved and copied from cisco_spark to cisco_webex. @drew-russell The current version of cisco_spark module does not work due to a name collision with MESSAGE. I had to modify the name from "message" to "webexmsg" in many places in cisco_webex.py file. It works fine in this version. The name change is associated with the change of the product name from Cisco Spark to Cisco Webex Teams.

ansibullbot · 2020-06-04T05:08:42Z

@networkers-pl This PR contains @ mentions in at least one commit message. Those mentions can cause cascading notifications through GitHub and need to be removed. Please squash or amend your commits to remove the mentions.

click here for bot help

ansibullbot · 2020-06-04T05:20:19Z

cc @drew-russell
click here for bot help

Andersson007

felixfontein

This is a breaking change, and needs to be properly documented (changelog fragment, breaking_changes)!

plugins/modules/notification/cisco_webex.py

felixfontein · 2020-06-04T07:40:29Z

plugins/modules/notification/cisco_webex.py

  returned: always
  type: int
  sample: 200

-message:
+msg:


You are removing an existing return value. The old one needs to be deprecated (and not removed) and returned until the deprecation period is over.

there was a collision with the name of the message and therefore the module stopped working, hence the change from message to msg.

That's for module options, not for return values. Please keep the old name of the return value.

plugins/modules/notification/cisco_webex.py

felixfontein

Marking as Request Changes to it is not accidentally merged.

Andersson007 · 2020-06-04T07:48:22Z

@networkers-pl can the old spark api (and the old module resp.) be used by users somehow?

felixfontein · 2020-06-04T07:50:07Z

If you open the URLs in a browser, both the old and new API URLs work and return the same thing (no auth token).

networkers-pl · 2020-06-04T07:51:37Z

Yes, the old API is still working, but due to the change of product name from Spark to Webex, it is recommended to use the new URL.

…

On 4 Jun 2020, at 09:50, Felix Fontein ***@***.***> wrote: If you open the URLs in a browser, both the old and new API URLs work and return the same thing (no auth token). — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#457 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/APVNUU5DZA6FXU5O2WSUECLRU5G33ANCNFSM4NSIVNJA>.

Andersson007 · 2020-06-04T07:53:31Z

my bad..

networkers-pl · 2020-06-04T07:54:30Z

I'm starting to make changes.

…

On 4 Jun 2020, at 09:41, Felix Fontein ***@***.***> wrote: @felixfontein commented on this pull request. This is a breaking change, and needs to be properly documented (changelog fragment, breaking_changes)! In plugins/modules/notification/cisco_webex.py <#457 (comment)>: > @@ -10,99 +10,102 @@ DOCUMENTATION = ''' --- -module: cisco_spark -short_description: Send a message to a Cisco Spark Room or Individual. +module: cisco_webex +short_description: Send a msg to a Cisco Webex Teams Room or Individual ⬇️ Suggested change -short_description: Send a msg to a Cisco Webex Teams Room or Individual +short_description: Send a message to a Cisco Webex Teams Room or Individual In plugins/modules/notification/cisco_webex.py <#457 (comment)>: > description: - - Send a message to a Cisco Spark Room or Individual with options to control the formatting. + - Send a msg to a Cisco Webex Teams Room or Individual with options to control the formatting. Please use correct English words. ⬇️ Suggested change - - Send a msg to a Cisco Webex Teams Room or Individual with options to control the formatting. + - Send a message to a Cisco Webex Teams Room or Individual with options to control the formatting. In plugins/modules/notification/cisco_webex.py <#457 (comment)>: > options: recipient_type: description: - - The request parameter you would like to send the message to. + - The request parameter you would like to send the I(msg) to. ⬇️ Suggested change - - The request parameter you would like to send the I(msg) to. + - The request parameter you would like to send the message to. This is an English word, not the module option. In plugins/modules/notification/cisco_webex.py <#457 (comment)>: > - message_type: + msg_type: You need to provide an alias. Otherwise existing usage will break. In plugins/modules/notification/cisco_webex.py <#457 (comment)>: > description: - - Specifies how you would like the message formatted. - required: False + - Specifies how you would like the msg formatted. ⬇️ Suggested change - - Specifies how you would like the msg formatted. + - Specifies how you would like the message formatted. In plugins/modules/notification/cisco_webex.py <#457 (comment)>: > personal_token: description: - - Your personal access token required to validate the Spark API. - required: true - aliases: ['token'] To remove an alias, it needs to be deprecated first, and removed after the deprecation period expired. So please keep this. In plugins/modules/notification/cisco_webex.py <#457 (comment)>: > returned: always type: int sample: 200 -message: +msg: You are removing an existing return value. The old one needs to be deprecated (and not removed) and returned until the deprecation period is over. In plugins/modules/notification/cisco_webex.py <#457 (comment)>: > @@ -111,9 +114,9 @@ from ansible.module_utils.urls import fetch_url -def spark_message(module): - """ When check mode is specified, establish a read only connection, that does not return any user specific - data, to validate connectivity. In regular mode, send a message to a Cisco Spark Room or Individual""" +def spark_msg(module): + """When check mode is specified, establish a read only connection, that does not return any user specific + data, to validate connectivity. In regular mode, send a msg to a Cisco Webex Teams Room or Individual""" ⬇️ Suggested change - data, to validate connectivity. In regular mode, send a msg to a Cisco Webex Teams Room or Individual""" + data, to validate connectivity. In regular mode, send a message to a Cisco Webex Teams Room or Individual""" — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#457 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/APVNUU7JNVQOSVJ3DUL3CUDRU5F2ZANCNFSM4NSIVNJA>.

Andersson007

i thought the api doesn't work..

ansibullbot · 2020-06-04T08:18:00Z

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

plugins/modules/notification/cisco_webex.py:0:0: nonexistent-parameter-documented: Argument 'token' is listed in DOCUMENTATION.options, but not accepted by the module argument_spec

click here for bot help

networkers-pl · 2020-06-04T13:13:20Z

@networkers-pl can the old spark api (and the old module resp.) be used by users somehow?

no, the old module does not work. the reason is a collision with "message".

felixfontein

You need to keep the symlink plugin/modules/cisco_spark.py (to plugins/modules/notification/cisco_spark.py), and create a symlink from plugins/modules/notification/cisco_spark.py pointing to ./cisco_webex.py.

plugins/modules/notification/cisco_webex.py

felixfontein · 2020-06-04T18:25:34Z

plugins/modules/notification/cisco_webex.py

  returned: always
  type: int
  sample: 200

-message:
+msg:


That's for module options, not for return values. Please keep the old name of the return value.

plugins/modules/notification/cisco_webex.py

networkers-pl · 2020-06-05T04:44:57Z

I introduced all suggestions. if I miss or misunderstand something, please let me know.

felixfontein · 2020-06-06T19:59:20Z

plugins/modules/notification/cisco_webex.py

+  type: int
+  sample: 200
+
+msg:


This change is still missing:

Suggested change

msg:

message:

felixfontein · 2020-06-06T20:01:18Z

Also, please adjust the commit messages and remove the @. I don't want to receive 1000s of notifications whenever someone pushes this commit to their branches.

ansibullbot · 2020-06-06T20:04:57Z

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

plugins/modules/notification/cisco_webex.py:0:0: invalid-argument-name: Argument alias 'message' in argument_spec must not be one of message,syslog_facility as it is used internally by Ansible Core Engine

click here for bot help

felixfontein · 2020-06-06T20:52:45Z

You need to add plugins/modules/notification/cisco_webex.py validate-modules:invalid-argument-name to tests/sanity/ignore-2.10.txt (at the same place where you removed the old entries).

networkers-pl · 2020-06-07T05:02:02Z

Also, please adjust the commit messages and remove the @. I don't want to receive 1000s of notifications whenever someone pushes this commit to their branches.

I do not add @ to the commit message. If that's not the case, I can't find any other option anywhere to control it or change it. I am asking for information where I can change it and then I will do it.

felixfontein

Looks good now from my POV.

@Andersson007 what do you think?

felixfontein

Sorry, I missed one thing: please remove the @ from the commit message of this commit: f2baff7

…argument-name added to tests/sanity/ignore-2.10.txt

networkers-pl · 2020-06-07T12:20:03Z

Sorry, I missed one thing: please remove the @ from the commit message of this commit: f2baff7

done

felixfontein

LGTM

felixfontein · 2020-06-07T12:34:02Z

@networkers-pl thanks!

networkers-pl · 2020-06-07T12:36:02Z

Thank you both for your help and patience ;-)

…

On 7 Jun 2020, at 14:34, Felix Fontein ***@***.***> wrote: @networkers-pl <https://github.com/networkers-pl> thanks! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#457 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/APVNUUZDYS3BZO6O7WEZWP3RVOCMPANCNFSM4NSIVNJA>.

Andersson007

LGTM

Andersson007 · 2020-06-09T06:38:19Z

merged #457 into master

Andersson007 · 2020-06-09T06:39:30Z

@networkers-pl my congratulations! thanks for being persistent:)
@felixfontein thanks for reviewing!

networkers-pl mentioned this pull request Jun 4, 2020

New module cisco_webex #401

Closed

cisco_spark rm

af78c33

Andersson007 approved these changes Jun 4, 2020

View reviewed changes

felixfontein reviewed Jun 4, 2020

View reviewed changes

felixfontein requested changes Jun 4, 2020

View reviewed changes

ansibullbot removed the needs_triage label Jun 4, 2020

Andersson007 requested changes Jun 4, 2020

View reviewed changes

suggested change

d2c2497

ansibullbot added the ci_verified Push fixes to PR branch to re-run CI label Jun 4, 2020

aliases added to in def main funcitons

7cc2e6e

ansibullbot removed the ci_verified Push fixes to PR branch to re-run CI label Jun 4, 2020

felixfontein requested changes Jun 4, 2020

View reviewed changes

felixfontein changed the title ~~This is a modified copy of the cisco_spark.py file. The name chan…~~ cisco_spark -> cisco_webex rename and message option fix Jun 4, 2020

ansibullbot added the plugins label Jun 5, 2020

felixfontein requested changes Jun 6, 2020

View reviewed changes

ansibullbot added the ci_verified Push fixes to PR branch to re-run CI label Jun 6, 2020

ansibullbot removed the ci_verified Push fixes to PR branch to re-run CI label Jun 7, 2020

felixfontein approved these changes Jun 7, 2020

View reviewed changes

felixfontein requested changes Jun 7, 2020

View reviewed changes

networkers-pl added 3 commits June 7, 2020 14:18

felixfontein requested changes on this pull request.

4172ab7

Return value change from msg to message.

e673c2e

plugins/modules/notification/cisco_webex.py validate-modules:invalid-…

ced3e6e

…argument-name added to tests/sanity/ignore-2.10.txt

networkers-pl force-pushed the new-cisco_webex branch from fdbcb0b to ced3e6e Compare June 7, 2020 12:18

felixfontein approved these changes Jun 7, 2020

View reviewed changes

Andersson007 approved these changes Jun 9, 2020

View reviewed changes

Andersson007 merged commit ab26dc8 into ansible-collections:master Jun 9, 2020

felixfontein added a commit that referenced this pull request Jun 13, 2020

Added missing changelog fragment for #457.

31ffc68

This was referenced Jul 1, 2020

Replace 'message' in module cisco_spark.py ansible/ansible#68004

Closed

Cisco Spark Module TypeError: send() got multiple values for keyword argument 'MESSAGE' ansible/ansible#68000

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cisco_spark -> cisco_webex rename and message option fix #457

cisco_spark -> cisco_webex rename and message option fix #457

networkers-pl commented Jun 4, 2020 •

edited

ansibullbot commented Jun 4, 2020

ansibullbot commented Jun 4, 2020

Andersson007 left a comment •

edited

felixfontein left a comment

felixfontein Jun 4, 2020

networkers-pl Jun 4, 2020

felixfontein Jun 4, 2020

felixfontein left a comment

Andersson007 commented Jun 4, 2020

felixfontein commented Jun 4, 2020

networkers-pl commented Jun 4, 2020 via email

Andersson007 commented Jun 4, 2020

networkers-pl commented Jun 4, 2020 via email

Andersson007 left a comment

ansibullbot commented Jun 4, 2020

networkers-pl commented Jun 4, 2020

felixfontein left a comment

felixfontein Jun 4, 2020

networkers-pl commented Jun 5, 2020

felixfontein Jun 6, 2020

felixfontein commented Jun 6, 2020

ansibullbot commented Jun 6, 2020

felixfontein commented Jun 6, 2020

networkers-pl commented Jun 7, 2020

felixfontein left a comment

felixfontein left a comment

networkers-pl commented Jun 7, 2020

felixfontein left a comment

felixfontein commented Jun 7, 2020

networkers-pl commented Jun 7, 2020 via email

Andersson007 left a comment

Andersson007 commented Jun 9, 2020

Andersson007 commented Jun 9, 2020

cisco_spark -> cisco_webex rename and message option fix #457

cisco_spark -> cisco_webex rename and message option fix #457

Conversation

networkers-pl commented Jun 4, 2020 • edited

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

ansibullbot commented Jun 4, 2020

ansibullbot commented Jun 4, 2020

Andersson007 left a comment • edited

Choose a reason for hiding this comment

felixfontein left a comment

Choose a reason for hiding this comment

felixfontein Jun 4, 2020

Choose a reason for hiding this comment

networkers-pl Jun 4, 2020

Choose a reason for hiding this comment

felixfontein Jun 4, 2020

Choose a reason for hiding this comment

felixfontein left a comment

Choose a reason for hiding this comment

Andersson007 commented Jun 4, 2020

felixfontein commented Jun 4, 2020

networkers-pl commented Jun 4, 2020 via email

Andersson007 commented Jun 4, 2020

networkers-pl commented Jun 4, 2020 via email

Andersson007 left a comment

Choose a reason for hiding this comment

ansibullbot commented Jun 4, 2020

networkers-pl commented Jun 4, 2020

felixfontein left a comment

Choose a reason for hiding this comment

felixfontein Jun 4, 2020

Choose a reason for hiding this comment

networkers-pl commented Jun 5, 2020

felixfontein Jun 6, 2020

Choose a reason for hiding this comment

felixfontein commented Jun 6, 2020

ansibullbot commented Jun 6, 2020

felixfontein commented Jun 6, 2020

networkers-pl commented Jun 7, 2020

felixfontein left a comment

Choose a reason for hiding this comment

felixfontein left a comment

Choose a reason for hiding this comment

networkers-pl commented Jun 7, 2020

felixfontein left a comment

Choose a reason for hiding this comment

felixfontein commented Jun 7, 2020

networkers-pl commented Jun 7, 2020 via email

Andersson007 left a comment

Choose a reason for hiding this comment

Andersson007 commented Jun 9, 2020

Andersson007 commented Jun 9, 2020

networkers-pl commented Jun 4, 2020 •

edited

Andersson007 left a comment •

edited