Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Current »

Starting with version 2.0.0, the JMCF add-on comes with a Groovy script editor and tester in the configuration screens of the calculated custom field. This document details the Groovy script tester, its availability and features.

The Groovy script tester tool lets you test your written script against any issue. The main advantage of this tool is that you can quickly test and debug your script and make changes without having to actually save the custom field and recalculate the calculated field value.

On this page:

Groovy script tester availability

The Groovy script tester in JMCF is available on the Custom field configuration screen when you write a Groovy script to return a value expected by the calculated custom field in the Groovy Formula field.

Using the Groovy Script tester

After writing your Groovy script in the editor, click on the Test Groovy Script button on the toolbar. A modal dialog window opens, asking you to pick an issue to run the Groovy script against, as well as a linked issue, where applicable. 

Selecting an issue

You can select the issue from one of the following options:

  • Issue key: start typing an issue key, you will be offered options based on your issue browsing history
  • [Select issue]: if you click on [Select Issue], an Issue selector window gets displayed. You can select the issue either from:
    • Recent Issues: Displays issues that you have recently viewed and first 50 issues from your current search or
    • From Filter: Displays issues of your saved searches.

The issue variable used in your script will point to the above-selected issue. 

Testing your Groovy script

After selecting issue against which the script should be tested (as explained above), click on Test. The following information will be displayed. This information can be used for debugging.

  1. Message: Success/error message based on the test result.

  2. Result type: Data type of the result.
  3. Result value: Value of the result.
  4. Stack: If an exception was thrown during the execution of the script, a stack trace will be displayed.
  5. Logs: Information logged using the log variable.

Example

Test a script that returns the sum of two number fields:

  1. Locate the custom field on the Custom Fields administration page.
  2. Click on the cog wheel and click on Configure.
  3. In the Groovy editor, write the following lines of code:

    issue.get("customfield_10114") + issue.get("customfield_10150")
  4. Click on the Test Groovy Script button on the toolbar.
  5. Type an Issue key.
  6. Click on Test.
  7. The following result is displayed:

Debugging your script

If you encounter an error during testing, you will need to debug your script. The Message, Stack and Log information displayed in the script tester result panel aids in debugging the script.

Using the Message and Stack trace

In the above example, after encountering the error,

  • Identify the problem, from the Message that displayed a null pointer exception error and the Stack that displayed the line number on which the error occurred.
  • Correct the problem, checking for null values and then returning the result.

    • In the Groovy editor, write the following lines of code:

      if (issue.get("customfield_10028") == null || issue.get("customfield_10006") == null)
          return null;
      else  
      return issue.get("customfield_10028") + issue.get("customfield_10006");
    • Click on Test again.

    • The following result is displayed:

Using the log variable

Using the log variable, you can debug your script, a step further, by adding information into the log. For example, while testing a condition in your script, if the result evaluates to false when you expect it to be true, you might want to know what values are being compared in your condition. In such cases, you can use the log variable to display the value.

The log calls should always be used before the return statement because they would never get executed after it.

  • Use log variable, in the above script to know the values of the custom fields.

    log.warn("Value of field 10028 is: "+issue.get("customfield_10028"));
    log.warn("Value of field 10006 is: "+issue.get("customfield_10006"));
    if (issue.get("customfield_10028") == null || issue.get("customfield_10006") == null)
        return null;
    else  
    return issue.get("customfield_10028") + issue.get("customfield_10006");
  • Re-test the script, the following result is displayed.
  • Remove your logging code, so that log entries don't get written to Jira's logfile each time the field is calculated.
  • No labels