Do you remember the old post LasCommentContains: New JQL custom function in groovy?

With JIRA 7.2 and the new Adaptavist Scriptrunner, the JQL function must be rewrited to work properly. Because after the JIRA migration from JIRA 6.3 to JIRA 7.2 changes a lot of very common classes, etc.

You can see the usual changes in the code after the migration in this mini-tutorial

You will see basically that ComponentManager now is obsolete and you must use ComponentAccessor. The “Crowd” class for users is obsolete, now is ApplicationUser… now createIssue is createIssueObject, or setProject is setProjectObject… this kind of things.

In the case of the JQL Functions, there are another change in the part of the PARAMETERS.

In JIRA 6.3

 @Override
List<Map> getArguments() {
[
[
"description": "Subquery",
"contains": "#phrase#"
]
]
}

In JIRA 7.2 must be


@Override
List<Map> getArguments() {
[
[ "description": "Subquery", "optional": false],
[ "contains": "phrase", "optional": false]
]
}

The new code can be like this:


package com.onresolve.jira.groovy.jql

import com.atlassian.jira.issue.Issue
import com.atlassian.jira.ComponentManager
import com.atlassian.jira.ComponentManager
import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.issue.Issue
import com.atlassian.jira.issue.search.SearchProvider
import com.atlassian.jira.jql.operand.QueryLiteral
import com.atlassian.jira.jql.parser.JqlQueryParser
import com.atlassian.jira.jql.query.RangeQueryFactory
import com.atlassian.jira.util.MessageSetImpl
import com.atlassian.jira.web.bean.PagerFilter
import com.atlassian.query.operand.FunctionOperand
import com.atlassian.query.operator.Operator
import org.apache.log4j.Category
import com.atlassian.jira.util.MessageSet
import com.atlassian.crowd.embedded.api.User
import com.atlassian.query.clause.TerminalClause
import com.atlassian.jira.jql.query.QueryCreationContext
import org.apache.lucene.document.NumberTools
import org.apache.lucene.index.Term
import org.apache.lucene.search.Query
import org.apache.lucene.search.TermQuery
import com.onresolve.jira.groovy.jql.AbstractScriptedJqlFunction
import org.apache.lucene.search.BooleanClause
import org.apache.lucene.search.BooleanQuery
import org.apache.lucene.search.Query
import org.apache.lucene.search.TermQuery
import com.atlassian.jira.issue.fields.CustomField
import com.atlassian.jira.issue.CustomFieldManager
import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.user.ApplicationUser;
import com.atlassian.jira.security.JiraAuthenticationContext;
import com.atlassian.jira.security.roles.*
import com.atlassian.jira.project.ProjectManager
import com.atlassian.jira.project.Project
import com.atlassian.jira.issue.comments.CommentManager

import com.atlassian.jira.bc.issue.search.SearchService
import com.atlassian.jira.component.ComponentAccessor
import com.atlassian.jira.jql.parser.JqlQueryParser
import com.atlassian.jira.jql.query.LuceneQueryBuilder
import com.atlassian.jira.jql.query.QueryCreationContext
import com.atlassian.jira.jql.validator.NumberOfArgumentsValidator
import com.atlassian.jira.user.ApplicationUser
import com.atlassian.jira.util.MessageSet
import com.atlassian.query.clause.TerminalClause
import com.atlassian.query.operand.FunctionOperand
import groovy.util.logging.Log4j
import org.apache.lucene.search.Query

import java.text.MessageFormat

class LastCommentContains extends AbstractScriptedJqlFunction implements JqlQueryFunction{

 def queryParser = ComponentAccessor.getComponent(JqlQueryParser)
 def luceneQueryBuilder = ComponentAccessor.getComponent(LuceneQueryBuilder)
 def searchService = ComponentAccessor.getComponent(SearchService)

 @Override
 String getDescription() {
 "Function to validate if the last comment contains certain text"
 }

@Override
 List<Map> getArguments() {
 [
 [ "description": "Subquery", "optional": false],
 [ "contains": "phrase", "optional": false]
 ]
 }

@Override
 String getFunctionName() {
 "LastCommentContains"
 }

def String subquery
 //@Override
 MessageSet validate(User user, FunctionOperand operand, TerminalClause terminalClause) {
 def messageSet = new MessageSetImpl()
 return messageSet
 }

@Override
 Query getQuery(QueryCreationContext queryCreationContext, FunctionOperand operand, TerminalClause terminalClause) {
 JiraAuthenticationContext context = ComponentAccessor.getJiraAuthenticationContext();
 ApplicationUser applicationUser = context.getLoggedInUser();
 def booleanQuery = new BooleanQuery()
 issues = getIssues(operand.args[0], applicationUser)
 def comments
 def lastcommen
 String lastcomment
 String texttofind
 issues.each {Issue issue ->
 try{
 comments = ComponentAccessor.commentManager.getComments(issue)
 if (comments) {
 lastcommen = comments.last();
 lastcomment = lastcommen.body.toLowerCase();
 texttofind = operand.args[1].toLowerCase()
 if ( lastcomment.contains(texttofind) ) {
 booleanQuery.add(new TermQuery(new Term("issue_id", issue.id as String)), BooleanClause.Occur.SHOULD)
 }
 }

 }catch(NullPointerException NPE){

 }
 } 

 return booleanQuery
 }
}

Advertisements
Posted by:.

2 replies on “LastCommentContains JQL Function for JIRA 7.2 + Scriptrunner

  1. New version compatible with Jira 8.
    Syntax example:

    issuefunction in LastCommentContains("project = JIRA", "raul")
    

    Source code compatible with Jira 8

    package com.onresolve.jira.groovy.jql
    
    import com.atlassian.jira.issue.Issue
    import com.atlassian.jira.component.ComponentAccessor
    import com.atlassian.jira.issue.Issue
    import com.atlassian.jira.issue.search.SearchProvider
    import com.atlassian.jira.jql.operand.QueryLiteral
    import com.atlassian.jira.jql.parser.JqlQueryParser
    import com.atlassian.jira.jql.query.RangeQueryFactory
    import com.atlassian.jira.util.MessageSetImpl
    import com.atlassian.jira.web.bean.PagerFilter
    import com.atlassian.query.operand.FunctionOperand
    import com.atlassian.query.operator.Operator
    import org.apache.log4j.Category
    import com.atlassian.jira.util.MessageSet
    import com.atlassian.crowd.embedded.api.User
    import com.atlassian.query.clause.TerminalClause
    import com.atlassian.jira.jql.query.QueryCreationContext
    import org.apache.lucene.index.Term
    import org.apache.lucene.search.Query
    import org.apache.lucene.search.TermQuery
    import com.onresolve.jira.groovy.jql.AbstractScriptedJqlFunction
    import org.apache.lucene.search.BooleanClause
    import org.apache.lucene.search.BooleanQuery
    import org.apache.lucene.search.Query
    import org.apache.lucene.search.TermQuery
    import com.atlassian.jira.issue.fields.CustomField
    import com.atlassian.jira.issue.CustomFieldManager
    import com.atlassian.jira.component.ComponentAccessor
    import com.atlassian.jira.user.ApplicationUser;
    import com.atlassian.jira.security.JiraAuthenticationContext;
    import com.atlassian.jira.security.roles.*
    import com.atlassian.jira.project.ProjectManager
    import com.atlassian.jira.project.Project
    import com.atlassian.jira.issue.comments.CommentManager
    
    import com.atlassian.jira.bc.issue.search.SearchService
    import com.atlassian.jira.component.ComponentAccessor
    import com.atlassian.jira.jql.parser.JqlQueryParser
    import com.atlassian.jira.jql.query.LuceneQueryBuilder
    import com.atlassian.jira.jql.query.QueryCreationContext
    import com.atlassian.jira.jql.validator.NumberOfArgumentsValidator
    import com.atlassian.jira.user.ApplicationUser
    import com.atlassian.jira.util.MessageSet
    import com.atlassian.query.clause.TerminalClause
    import com.atlassian.query.operand.FunctionOperand
    import groovy.util.logging.Log4j
    import org.apache.lucene.search.Query
    
    import java.text.MessageFormat
    
    
    
    class LastCommentContains extends AbstractScriptedJqlFunction implements JqlQueryFunction{
    	
    	def queryParser = ComponentAccessor.getComponent(JqlQueryParser)
        def luceneQueryBuilder = ComponentAccessor.getComponent(LuceneQueryBuilder)
        def searchService = ComponentAccessor.getComponent(SearchService)
    	
        @Override
        String getDescription() {
            "Function to validate if the last comment contains certain text"
        }
    
        @Override
        List<Map> getArguments() {
            [
                [ "description": "Subquery", "optional": false],
                [ "contains": "phrase", "optional": false]
            ]
        }
    
        @Override
        String getFunctionName() {
            "LastCommentContains"
        }
    
        def String subquery
        //@Override
        MessageSet validate(User user, FunctionOperand operand, TerminalClause terminalClause) {
    		 def messageSet = new MessageSetImpl()
    		 return messageSet
        }
    
        @Override
        Query getQuery(QueryCreationContext queryCreationContext, FunctionOperand operand, TerminalClause terminalClause) {
    		 JiraAuthenticationContext context = ComponentAccessor.getJiraAuthenticationContext();
    		 ApplicationUser applicationUser = context.getLoggedInUser();
    		  //def booleanQuery = new BooleanQuery()
             //JIRA 8
     		 BooleanQuery.Builder boolQueryBuilder = new BooleanQuery.Builder(); 
    		 issues = getIssues(operand.args[0], applicationUser)
    		 def comments
    		 def lastcommen
             String lastcomment
    		 String texttofind
    		 issues.each {Issue issue ->
                            try{
    							comments = ComponentAccessor.commentManager.getComments(issue)
    							if (comments) {
    								lastcommen = comments.last();
    								lastcomment = lastcommen.body.toLowerCase();
    								texttofind = operand.args[1].toLowerCase()
    								if ( lastcomment.contains(texttofind) ) {
    									boolQueryBuilder.add(new TermQuery(new Term("issue_id", issue.id as String)), BooleanClause.Occur.SHOULD)
    								}
    							}
    							
    								
                            }catch(NullPointerException NPE){
                               
                            }
                        }                                 
             
            return boolQueryBuilder.build();
        }
    }
    
    

    Liked by 1 person

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s