Blog

import ...  
String jql = 'project = "myproject" AND status = "Freigegeben" order by id'       
String daemonUserName = "technical_user" 
int actionId = 14242  
def componentManager = ComponentManager.getInstance() 
JiraAuthenticationContext ctx = componentManager.getJiraAuthenticationContext() 
UserManager userManager = componentManager.getComponentInstanceOfType(UserManager.class)  
User daemon = userManager.getUserObject(daemonUserName) 
User callingUser = ctx.getLoggedInUser()  

try {    
  ctx.setLoggedInUser(daemon)    
  SearchService.ParseResult parseResult =      
    componentManager.getSearchService().parseQuery(ctx.getLoggedInUser(), jql)
  if (!parseResult.isValid()) {         
     // error handling     
  }    
  SearchResults results = componentManager.getSearchProvider().search(
     parseResult.getQuery(),       
     ctx.getLoggedInUser(),       
     PagerFilter.getUnlimitedFilter() )      
  for ( Issue issue : results.getIssues() ) {       
      MutableIssue mutableIssue = omponentManager.getIssueManager()
        .getIssueObject(issue.getId())
      boolean wasIndexing = ImportUtils.isIndexIssues()        
      try {          
        ImportUtils.setIndexIssues(true)          
        WorkflowTransitionUtil workflowTransitionUtil = (WorkflowTransitionUtil)             
           JiraUtils.loadComponent(WorkflowTransitionUtilImpl.class)           
        workflowTransitionUtil.setIssue(mutableIssue)          
        workflowTransitionUtil.setUsername(daemonUserName)          
        workflowTransitionUtil.setAction(actionId)          
        ErrorCollection errors = workflowTransitionUtil.validate()           
        if (errors.hasAnyErrors()) {            
          // error handling          
        }          
        errors = workflowTransitionUtil.progress()          
        if (errors.hasAnyErrors()) {             
          // error handling           
        }       
     } finally {        
       ImportUtils.setIndexIssues(wasIndexing)     
     }  
   }
} finally {  
   ctx.setLoggedInUser(callingUser); 
}

Wenn man die ersten einfachen Beispiel betrachtet, dann stellen sich die folgenden Fragen:

1. Wieso hat das Issue nun Zugriffsmethoden, um CustomField Werte zu setzen, etwa issue.setVertreter(currentUser()) ?
2. Wo steckt der spezielle Handling für die Änderungshistorie?
3. Wieso kann ich die Optionen einer Auswahlliste so einfach setzen?
4. Und seit wann hat das Issue eine transition-Methode?
5. Wo sind nur die vielen Import Statements geblieben?
6. Was steckt hinter dem use Statement?
7. Warum finden sich in den Scripten keine CustomFieldManager, kein JiraAuthenticationContext, kein SearchProvider und die vielen sonst üblichen Manager und Services mehr?

    

Die Antwort zu all den Fragen ist: 

Es wird eine eigene Java-Bibliothek verwendet, die die manchmal etwas umständliche Java-API von JIRA kapselt. Diese Java Bibliothek nutzt Groovy Meta-Programmierung in Form von Catgeories (http://groovy.codehaus.org/Groovy+Categories), um die sonst übliche Komplexität von JIRA Groovy Scripten zu reduzieren.

Groovy erlaubt es, Klassen zur Laufzeit für eigene Erweiterungen zu öffnen und neue Methoden hinzuzufügen. Und hiervon wird in den Beispielen oben intensiv Gebrauch gemacht, so bekommt die Issue Klasse neue Methoden zum Lesen und Schreiben von benutzerdefinierten Feldern. java.lang.String Objekte können in User Objekte oder JQL Queries transformiert werden und auf Issues können direkt Transitionen angestoßen werden. Um diesen Groovy-Mechanismus zu nutzen, muss man nur eine Java/Groovy Klasse (Category) mit einer Reihe von statischen Methoden breitstellen. Per Konvention muss der erste Parameter dem Objekttypen entsprechen, den man öffnen möchte. Aktiviert wird ein Category durch die Verwendung des Schlüsselwortes use. Ein oder mehrere Categories sind dann innerhalb einer an use übergebenen Closure verwendbar.

Mein persönliches Fazit: 

Lange Importsequenzen entfallen, fehleranfällige Konstrukte wie die korrekte Handhabung der Änderungshistorie werden weggekapselt, gängige Script-Aufgaben, wie das Ausführen von Aufgaben im Kontext eines anderen Benutzers, die Suche nach Vorgängen und die Transition von Vorgängen gehen leicht von der Hand. Die Groovy-Scripte werden einfach, elegant, kurz, verständlich und nachvollziehbar. Groovy Scripting für JIRA macht mit der Bibliothek wieder Spaß.