[Confluence] Unable to pass attachment stored in memory to add_attachment method

[jcdbautista]

In the official Python library for JIRA docs, JIRA's add_attachment method expects an issue_key and attachment. It only expects a filename if the attachment is being passed from memory as a StringIO object .
https://jira.readthedocs.io/examples.html#:~:text=.name)-,2.1.11.%20Attachments,-%23

In the Atlassian Python API documentation, the add_attachment method only expects an issue_key and a filename. This prevents the attachment of files stored only in memory.
https://atlassian-python-api.readthedocs.io/jira.html

[gonchik]

@dizoncruz we can implement it.

[jcdbautista]

@gonchik Perfect, thank you!

[jcdbautista]

Thank you @gonchik for implementing this so quickly. I see that it's been merged to master, but I'm unable to use the new method.

Using apache-airflow-providers-atlassian-jira, which according to the docs utilizes this Atlassian JIRA SDK
https://airflow.apache.org/docs/apache-airflow-providers-atlassian-jira/stable/_api/airflow/providers/atlassian/jira/operators/jira/index.html

Code:

from airflow.providers.atlassian.jira.hooks.jira import JiraHook
hook = JiraHook('jira_web_staging')
jira = hook.client

getattr(jira,'add_attachment_object')(issue['key'],attachment=attachment)

Log output:

<atlassian.jira.Jira object at 0x7f6a28b3b1f0> <class 'atlassian.jira.Jira'>
AttributeError: 'Jira' object has no attribute 'add_attachment_object'

[gonchik]

@dizoncruz I did not released yet that.
Let me collect changes into 1 chunk and make a release.

[jcdbautista]

Hi @gonchik, thank you so much for implementing this. I can confirm that the add_attachment_object method is working as intended.

One last question: the original add_attachment method takes in an optional filename string in cases where the attachment is a StringIO object in memory. It looks like this new add_attachment_object does not though. Would that functionality have to be built in as well, or is there another way I pass in a filename string so that the attached file isn't just called "file"?

[gonchik]

@dizoncruz could you send a PR, i would like to see how do you want to implement it.

[jcdbautista]

@gonchik Python Jira library takes in a third param, filename:

https://jira.readthedocs.io/examples.html#:~:text=%23%20attach%20file%20from%20memory%20(you%20can%20skip%20IO%20operations).%20In%20this%20case%20you%20MUST%20provide%20%60filename%60.

I don't have a public PR I can share, but here's a snippet of our code.

        if context['ti'].xcom_pull(task_ids='load_configs_and_run_query', key='jira_attach_results') is True:
            filename = '{}.csv'.format(context['dag'].dag_id)
            attachment = StringIO()
            attachment.write(context['ti'].xcom_pull(task_ids='load_configs_and_run_query', key='query_results'))
            getattr(jira,'add_attachment_object')(issue['key'],attachment=attachment)

The file generates and attaches to the issue in JIRA but it is always just named "file" instead of having a name and extension.