Jira: Fix bug in "Get Comments", failing normalize_user in Jira Cloud

[ax-rpipkin]

Proposed Changes (WIP - Collecting screenshot validation)

Description

Describe the proposed changes:

• Pass Jira client is_cloud boolean into normalize_comment function
• Pass is_cloud from normalize_comment as is required for dependency normalize_user

PR Requirements

Developers, verify you have completed the following items by checking them off:

Testing

Unit Tests

Review our documentation on generating and writing plugin unit tests

• Unit tests written for any new or updated code
  • Note: unnecessary to adjust, as it does not introduce any new functionality.

In-Product Tests

If you are an InsightConnect customer or have access to an InsightConnect instance, the following in-product tests should be done:

• Screenshot of job output with the plugin changes
• Screenshot of the changed connection, actions, or triggers input within the InsightConnect workflow builder

Style

Review the style guide

• N/A : minor edits to existing codebase

Functional Checklist

• Work fully completed
• Functional

Assessment

You must validate your work to reviewers:

1. Run make validate and make sure everything passes
2. Run the assessment tool: icon-plugin run -A -R all -T all. For single action validation: icon-plugin run -A -R tests/my_action.json -T tests/my_action.json
3. Copy (icon-plugin ... | pbcopy) and paste the output in a new post on this PR
4. Add required screenshots from the In-Product Tests section

[ax-rpipkin]

Error from current 6.1.0 jira plugin:

rapid7/Jira:6.1.0. Step name: get_comments
<class 'jira.resources.UnknownResource'> object has no attribute 'name' ('UnknownResource' object is not subscriptable)
Traceback (most recent call last):
  File "/usr/local/lib/python3.8/site-packages/jira/resources.py", line 161, in __getattr__
    return self[item]
TypeError: 'UnknownResource' object is not subscriptable

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/usr/local/lib/python3.8/site-packages/insightconnect_plugin_runtime-4.2.0-py3.8.egg/insightconnect_plugin_runtime/plugin.py", line 326, in handle_step
    output = self.start_step(
  File "/usr/local/lib/python3.8/site-packages/insightconnect_plugin_runtime-4.2.0-py3.8.egg/insightconnect_plugin_runtime/plugin.py", line 476, in start_step
    output = func(params)
  File "/usr/local/lib/python3.8/site-packages/jira_rapid7_plugin-6.1.0-py3.8.egg/komand_jira/actions/get_comments/action.py", line 30, in run
    results = list(map(lambda comment: normalize_comment(comment, logger=self.logger), comments))
  File "/usr/local/lib/python3.8/site-packages/jira_rapid7_plugin-6.1.0-py3.8.egg/komand_jira/actions/get_comments/action.py", line 30, in <lambda>
    results = list(map(lambda comment: normalize_comment(comment, logger=self.logger), comments))
  File "/usr/local/lib/python3.8/site-packages/jira_rapid7_plugin-6.1.0-py3.8.egg/komand_jira/util/util.py", line 8, in normalize_comment
    author = normalize_user(source.author, logger=logger)
  File "/usr/local/lib/python3.8/site-packages/jira_rapid7_plugin-6.1.0-py3.8.egg/komand_jira/util/util.py", line 88, in normalize_user
    output["name"] = user.name
  File "/usr/local/lib/python3.8/site-packages/jira/resources.py", line 177, in __getattr__
    raise AttributeError("%r object has no attribute %r (%s)" % (self.__class__, item, e))
AttributeError: <class 'jira.resources.UnknownResource'> object has no attribute 'name' ('UnknownResource' object is not subscriptable)

[ax-rpipkin]

Job after implementing updated python egg with fixes provided here;

[mberezin-r7]

Hi @ax-rpipkin, thank you for the contribution! There are a few additional steps we ask you to take before we can approve this PR. These steps are documented on our Plugin Development docs here: https://docs.rapid7.com/insightconnect/getting-started/

• Please include some unit tests that cover this code change, if possible. Documentation here: https://docs.rapid7.com/insightconnect/unit-test-primer
• Please bump the minor version number of the plugin in the plugin.spec.yaml and the setup.py files.
• Please describe the change in the Version History section of the help.md file.
• Please regenerate the plugin using the icon-plugin tool. You will need to be in the insightconnect-plugins/plugins/jira path and run icon-plugin generate --regenerate python plugin.spec.yaml. This will update the .CHECKSUM file. This is documented here: https://docs.rapid7.com/insightconnect/regenerating-plugins/
• Please confirm that the PR passes our GitHub Actions validation checks.

Please let us know if you have any questions or concerns.

[mrinehart-r7]

LGTM, will merge this when our checks start working again @ax-rpipkin

[pmara-r7]

@mrinehart-r7 any idea why these checks aren't running?

[mrinehart-r7]

@mrinehart-r7 any idea why these checks aren't running?

It could be due to the commits coming in from a fork - our CI checks don't work the greatest with forks.

[mberezin-r7]

I validated the jira plugin locally on this PR branch and it passes.

$ pwd 
/Users/mberezin/go/src/github.com/rapid7/insightconnect-plugins/plugins/jira
$ git branch
bug/jira_cloud_get_comments_failure
$ icon-validate .
[*] Validating plugin at .

[*] Running Integration Validators...
[*] Executing validator HelpValidator
[*] Executing validator ChangelogValidator
[*] Executing validator CloudReadyConnectionCredentialTokenValidator
[*] Executing validator RequiredKeysValidator
[*] Executing validator UseCaseValidator
[*] Executing validator SpecPropertiesValidator
[*] Executing validator SpecVersionValidator
[*] Executing validator FilesValidator
[*] Executing validator TagValidator
[*] Executing validator DescriptionValidator
[*] Executing validator TitleValidator
[*] Executing validator VendorValidator
[*] Executing validator DefaultValueValidator
[*] Executing validator IconValidator
[*] Executing validator RequiredValidator
[*] Executing validator VersionValidator
[*] Executing validator DockerfileParentValidator
[*] Executing validator LoggingValidator
[*] Executing validator ProfanityValidator
[*] Executing validator AcronymValidator
[*] Executing validator JSONValidator
[*] Executing validator OutputValidator
[*] Executing validator RegenerationValidator
[*] Executing validator HelpInputOutputValidator
[*] Executing validator SupportValidator
[*] Executing validator RuntimeValidator
[*] Executing validator VersionPinValidator
[*] Executing validator EncodingValidator
[*] Executing validator ExampleInputValidator
[*] Plugin successfully validated!

----
[*] Total time elapsed: 907.1329999999999ms

[pmara-r7]

Approving per a team review, and @mberezin-r7 validation