nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

How to read a text file attached to an issue with scriptrunner?

ABoerio

Hi,

I'm trying to read a text file attached to an issue, using a script.

Here below the code I'm trying to use:

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.issue.comments.CommentManager
import com.atlassian.jira.issue.AttachmentManager
import com.atlassian.jira.issue.attachment.Attachment

def issueManager = ComponentAccessor.getIssueManager()
def aM= ComponentAccessor.getAttachmentManager()
def pM = ComponentAccessor.getAttachmentPathManager()
def issue = issueManager.getIssueObject("TEST-129")

List attachments = aM.getAttachments(issue)

if (!attachments.isEmpty()) {
for (Attachment a in attachments) {
String fileName=a.getFilename()
log.warn(fileName)
String storePath=pM.getAttachmentPath() 
def attachmentFilePath = new File(storePath).path
def attachmentFile= new File(attachmentFilePath,fileName)
log.warn(attachmentFile)
log.warn(attachmentFile.text)
}
}

Quite sure I'm missing something, because the logs I get are the following:

Thanks in advance for any hint.

Andrea

Accepted answers

PD Sheehan

The file is stored in a special path under the storePath.

storePath/projectKey/bucket/issueKey/attachmentId

There is a really easy way to get the correct file path using AttachmentUtils but it's deprecated.

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.util.AttachmentUtils

def issueManager = ComponentAccessor.getIssueManager()
def aM= ComponentAccessor.getAttachmentManager()

def issue = issueManager.getIssueObject("TEST-129")

def attachments = aM.getAttachments(issue)

attachments.each{a ->
def fileName = a.fileName
log.warn(filename)
def filePath = AttachmentUtils.getAttachmentFile(a)
def attachmentFile = new File(filePath)
log.warn(attachmentFile)
log.warn(attachmentFile.text)
}
The current way to access the content of a file is using AttachmentManager.steamAttachmentContent

There are some examples here: https://community.atlassian.com/t5/Answers-Developer-Questions/Accessing-jira-attachment-file-data-from-a-jira-plugin/qaq-p/564803

All comments

PD Sheehan

The file is stored in a special path under the storePath.

storePath/projectKey/bucket/issueKey/attachmentId

There is a really easy way to get the correct file path using AttachmentUtils but it's deprecated.

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.util.AttachmentUtils

def issueManager = ComponentAccessor.getIssueManager()
def aM= ComponentAccessor.getAttachmentManager()

def issue = issueManager.getIssueObject("TEST-129")

def attachments = aM.getAttachments(issue)

There are some examples here: https://community.atlassian.com/t5/Answers-Developer-Questions/Accessing-jira-attachment-file-data-from-a-jira-plugin/qaq-p/564803

ABoerio

Thank you! I'll try to follow your suggestments and let you know.

Andrea

ABoerio

Hi @PD Sheehan

I tried to follow your hint, read the links, and spent some time on the StreamAttachmentContent. The file to be read has become an XML.

I did something like this

import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.issue.comments.CommentManager
import com.atlassian.jira.issue.AttachmentManager
import com.atlassian.jira.issue.attachment.Attachment
import com.atlassian.jira.issue.attachment.FileAttachments
import com.atlassian.jira.util.AttachmentUtils
import org.apache.commons.io.FilenameUtils
import com.atlassian.jira.util.io.InputStreamConsumer
import org.springframework.util.StreamUtils
import java.io.FileOutputStream
import java.io.InputStream
import java.io.IOException
import groovy.util.XmlParser
import groovy.util.XmlSlurper

def issueManager = ComponentAccessor.getIssueManager()
def aM= ComponentAccessor.getAttachmentManager()
def pM = ComponentAccessor.getAttachmentPathManager()
def issue = issueManager.getIssueObject("TEST-129")
def attachments = aM.getAttachments(issue)

String attachmentFileText=""

if (!attachments.isEmpty()) {
for (Attachment a in attachments) {
def fileName=FilenameUtils.getBaseName(a.getFilename())
//log.warn (fileName)
def fileExtension=FilenameUtils.getExtension(a.getFilename())
//log.warn (fileExtension) 
def attachmentFile = aM.streamAttachmentContent(a, new FileInputStreamConsumer(a.getFilename()))

List attachmentFileLines = attachmentFile.text.split('\n')
def righeFile=1
attachmentFileLines.each(){
singleLine->
//log.warn(righeFile)
//log.warn(singleLine)
attachmentFileText=attachmentFileText+singleLine
righeFile=righeFile+1
}
}
}





def inputXML = new XmlParser().parseText(attachmentFileText)

inputXML.requirement.each{
req->
log.warn(req.Key.text())
}


/**

inputXML.requirements.requirement.findAll{ 
req ->
req.Key!=null
}.each { reqK ->
log.warn("${reqK.Summary.text()}")
}

**/

class FileInputStreamConsumer implements InputStreamConsumer{

private final String filename;
public FileInputStreamConsumer(String filename) {
this.filename = filename;
}
@Override
public File withInputStream(InputStream is) throws IOException {
final File f = File.createTempFile(FilenameUtils.getBaseName(filename), FilenameUtils.getExtension(filename));
StreamUtils.copy(is, new FileOutputStream(f));
return f;
}
}

and it seems it reads the file, even though with a lot of warnings.

The file I am reading is an XML exported from Excel.

It seems I'm reading it. Now I need some experience with XML parser.

PD Sheehan

Nice job.

Yeah I'm not a big fan of working with xml node and the xmlparser. Json is so much easier.

I always get tons of "static type checking" errors in the scriptrunner editor. That's because the editor tries to validate your code but is missing information about what the data type of various variable will be. Those types will be assigned only at runtime.

I mostly ignore those warnings. I only use them as clues to find when code actually fails to run. The "proof is in the pudding" as they say.

Ondrej Kvinta_hi2t35

Hi @PD Sheehan ,

Is any chance to read attachment similar way at JIRA Cloud.
Thank you

PD Sheehan

I have no experience with Jira cloud.

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

server

scriptrunner

jira

jira-software

jira-software-server