Bump cypress-xray-plugin from 7.3.0 to 7.4.0 (#390)

* Cleanup

* Cleanup

* Prefer issue data over deprecated options

* Clean up

* Bump cypress-xray-plugin from 7.3.0 to 7.3.1

* Fix ESLint issue

* Add issue transitioning

* Add explicit issue transitioning

* Move towards single issue update retrieval

* Add after run builder

* Fix test issues

* Refactor issue data handling

* Rename variable

* Fix Cypress tests

* Fix Cucumber tests

* Fix tests

* Fix test

* Bump cypress-xray-plugin from 7.3.1 to 7.4.0

* Fix test plan handling

* Update `CHANGELOG.md`

.eslintrc.json

@@ -12,6 +12,7 @@
     },
     "rules": {
         "no-shadow": "off",
+        "@typescript-eslint/no-deprecated": "off",
         "@typescript-eslint/parameter-properties": "error",
         "@typescript-eslint/non-nullable-type-assertion-style": "off",
         "@typescript-eslint/member-ordering": "error",

CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+# `7.4.0`
+
+## Notable changes
+
+-   Removed unused `jira.fields.testType`
+
+-   Projects other than the configured project key can now be used for the test execution issue key
+
+-   Added explicit issue transition call for server environments ([#389](https://github.com/Qytera-Gmbh/cypress-xray-plugin/pull/389))
+
+-   Added Cypress test results parameter to test execution issue callback
+
+-   Added Cypress test results parameter to test plan key callback
+
+## Dependency updates
+
+-   Bump @bahmutov/cypress-esbuild-preprocessor from 2.2.2 to 2.2.3
+
+-   Bump axios from 1.7.5 to 1.7.7
+
+-   Bump @badeball/cypress-cucumber-preprocessor from 20.1.1 to 21.0.0
+
+-   Bump cypress from 13.13.2 to 13.14.1
+
 # `7.3.0`
 
 ## Notable changes

package.json

@@ -1,6 +1,6 @@
 {
     "name": "cypress-xray-plugin",
-    "version": "7.3.0",
+    "version": "7.4.0",
     "description": "A Cypress plugin for uploading test results to Xray (test management for Jira)",
     "types": "index.d.ts",
     "author": "csvtuda",

src/client/jira/jira-client.spec.ts

@@ -609,5 +609,79 @@ describe(path.relative(process.cwd(), __filename), () => {
                 );
             });
         });
+
+        describe("transitionIssue", () => {
+            it("transitions issues", async () => {
+                restClient.post.onFirstCall().resolves({
+                    config: {
+                        headers: new AxiosHeaders(),
+                    },
+                    data: undefined,
+                    headers: {},
+                    status: HttpStatusCode.NoContent,
+                    statusText: HttpStatusCode[HttpStatusCode.NoContent],
+                });
+                await client.transitionIssue("CYP-XYZ", {
+                    transition: {
+                        name: "resolve",
+                        to: {
+                            name: "done",
+                        },
+                    },
+                });
+                expect(restClient.post).to.have.been.calledOnceWith(
+                    "https://example.org/rest/api/latest/issue/CYP-XYZ/transitions",
+                    {
+                        transition: {
+                            name: "resolve",
+                            to: {
+                                name: "done",
+                            },
+                        },
+                    },
+                    {
+                        headers: { ["Authorization"]: "Basic dXNlcjp0b2tlbg==" },
+                    }
+                );
+            });
+
+            it("handles bad responses", async () => {
+                const logger = getMockedLogger({ allowUnstubbedCalls: true });
+                const error = new AxiosError(
+                    "Request failed with status code 404",
+                    HttpStatusCode.NotFound.toString(),
+                    undefined,
+                    null,
+                    {
+                        config: { headers: new AxiosHeaders() },
+                        data: {
+                            errorMessages: ["issue CYP-XYZ does not exist"],
+                        },
+                        headers: {},
+                        status: HttpStatusCode.NotFound,
+                        statusText: HttpStatusCode[HttpStatusCode.NotFound],
+                    }
+                );
+                restClient.post.onFirstCall().rejects(error);
+                await expect(
+                    client.transitionIssue("CYP-XYZ", {
+                        transition: {
+                            name: "resolve",
+                            to: {
+                                name: "done",
+                            },
+                        },
+                    })
+                ).to.eventually.be.rejectedWith("Failed to transition issue");
+                expect(logger.message).to.have.been.calledWithExactly(
+                    Level.ERROR,
+                    "Failed to transition issue: Request failed with status code 404"
+                );
+                expect(logger.logErrorToFile).to.have.been.calledOnceWithExactly(
+                    error,
+                    "transitionIssue"
+                );
+            });
+        });
     });
 });

src/client/jira/jira-client.ts

@@ -83,6 +83,21 @@ export interface JiraClient {
      * @see https://docs.atlassian.com/software/jira/docs/api/REST/9.9.1/#api/2/search-searchUsingSearchRequest
      */
     search(request: SearchRequest): Promise<Issue[]>;
+    /**
+     * Performs an issue transition and, if the transition has a screen, updates the fields from the
+     * transition screen.
+     *
+     * To update the fields on the transition screen, specify the fields in the `fields` or `update`
+     * parameters in the request body. Get details about the fields using
+     * [Get transitions](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-transitions-get)
+     * with the `transitions.fields` expand.
+     *
+     * @param issueIdOrKey - the ID or key of the issue
+     * @param issueUpdateData - the issue update data
+     * @see https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-transitions-post
+     * @see https://docs.atlassian.com/software/jira/docs/api/REST/9.9.1/#api/2/issue-doTransition
+     */
+    transitionIssue(issueIdOrKey: string, issueUpdateData: IssueUpdate): Promise<void>;
 }
 
 /**
@@ -298,12 +313,35 @@ export class BaseJiraClient extends Client implements JiraClient {
                 }
             );
             LOG.message(Level.DEBUG, `Successfully edited issue: ${issueIdOrKey}`);
-
             return issueIdOrKey;
         } catch (error: unknown) {
             LOG.message(Level.ERROR, `Failed to edit issue: ${errorMessage(error)}`);
             LOG.logErrorToFile(error, "editIssue");
             throw new LoggedError("Failed to edit issue");
         }
     }
+
+    public async transitionIssue(
+        issueIdOrKey: string,
+        issueUpdateData: IssueUpdate
+    ): Promise<void> {
+        try {
+            const header = await this.credentials.getAuthorizationHeader();
+            LOG.message(Level.DEBUG, "Transitioning issue...");
+            await this.httpClient.post(
+                `${this.apiBaseUrl}/rest/api/latest/issue/${issueIdOrKey}/transitions`,
+                issueUpdateData,
+                {
+                    headers: {
+                        ...header,
+                    },
+                }
+            );
+            LOG.message(Level.DEBUG, `Successfully transitioned issue: ${issueIdOrKey}`);
+        } catch (error: unknown) {
+            LOG.message(Level.ERROR, `Failed to transition issue: ${errorMessage(error)}`);
+            LOG.logErrorToFile(error, "transitionIssue");
+            throw new LoggedError("Failed to transition issue");
+        }
+    }
 }