Issues not transitioned to status when using Jira Server

[aufdenpunkt]

Description

Hi,

This is actually not a bug in your really nice plugin. We noticed that it is not possible to set the status/transition via the Jira Server REST API, when the issue POST endpoint is used.

...
      await configureXrayPlugin(fixedOn, config, {
        jira: {
          projectKey: 'TTEST',
          url: 'server url',
          testExecutionIssue: {
            transition: {
              id: '6',
            },
          },
        },
      });
...

Unfortunately, when it comes to transitions, the Jira Server and Jira Cloud REST APIs work slightly differently. See https://jira.atlassian.com/browse/JRASERVER-66881

Is it possible to implement some kind of "hooks" that can be used to make another request to the API per issue, e.g. to call an additional endpoint to set the status?

Thanks and best,
Chris

Cypress version

13.14.2

Plugin version

7.3.0

Jira/Xray type

Server

Configuration

No response

Acknowledgements

• I have made sure not to include any sensitive data in screenshots or obfuscated all occurrences.
• I have made sure not to include any sensitive data in descriptions or replaced all values with placeholders.
• I have made sure not to include any sensitive data in code snippets or replaced all values with placeholders.

[csvtuda]

Hi @aufdenpunkt,

interesting, I've never actually used the transition property.

Is it possible to implement some kind of "hooks" that can be used to make another request to the API per issue, e.g. to call an additional endpoint to set the status?

This would work, yes. Maybe something like:

await configureXrayPlugin(fixedOn, config, {
  jira: {
    projectKey: 'TTEST',
    url: 'server url',
    onResultUpload: ({issue, jiraClient, xrayClient }) => {
      // call transition issue endpoint yourself here
      jiraClient.transitionIssue(issue.key, "done");
    }
  },
});

I could optionally make the clients my plugin uses available there, too. Some of the endpoints there could maybe be reused.

---

Alternatively, I can also implement a transition detection and perform transition calls in the plugin, too. Shouldn't be too difficult.

Let me know what you think.

[aufdenpunkt]

Hi @csvtuda,

thanks for your quick response. So, basically, having hooks would enable a certain flexibility. But, as this is more an edge case in my opinion, I would prefer the transition detecktion.

[csvtuda]

A quick update: I have not been able to work on this yet. I'll probably implement it this weekend, there's a lot of other stuff going on at the moment.

[aufdenpunkt]

Don't worry and thanks for the update. Let me know if I can support you in any way or can contribute.
Have a great weekend.

[csvtuda]

Hi @aufdenpunkt,

I have released version 7.4.0, which now explicitly performs the transition iff:

• a transition is specified in jira.testExecutionIssue.transition
• no existing test execution issue is reused via jira.testExecutionIssue.key or the deprecated jira.testExecutionIssueKey (as the bug only affects new issues)
• Jira server is used

The code from your example should hopefully work now. Let me know if it does!

[aufdenpunkt]

Hi @csvtuda,

Sorry for my late response, and thanks for the release! I will have a look in the upcoming days.

[aufdenpunkt]

Hi @csvtuda,

It is working now, thank you very much. 🙂

During my testing, I stepped into a minor bug. Setting the transition ID as a property inside the transition object, like in my example configuration above, leads to a 400 Bad request. After some debugging, I've figured out that the request has been made with the body { "id": "123" }. But the body needs to be like { "transition": { "id": "123" } }. I was able to fix it using a workaround, wrapping it into another transition object like so:

...
      await configureXrayPlugin(fixedOn, config, {
        jira: {
          projectKey: 'TTEST',
          url: 'server url',
          testExecutionIssue: {
            transition: {
              transition: {
                id: '6',
              },
            },
          },
        },
      });
...

[csvtuda]

Oops, sorry! Fixed in 7.4.1.

---

Unfortunately, I cannot write a proper integration test for this feature because:

• my Jira cloud instance is obviously not affected by it
• the Jira server instance provided by Xray (🙏) does not allow such manual transitions (all automated/workflow-based)

Thanks for trying it out and reporting this oversight.

[aufdenpunkt]

That was quick, thanks! 🙏

Then, from my side, it's all fine now.