Jira writeback reporter to add subtasks with test results (#935)
* Progress toward Jira integration * Jira Writeback reporter working * Added correct timeouts * Added Jira Writeback reporter to pipeline * Added tag for testing * Removed unnecessary async * Fixed rate limit issue * Moved to only transition existing test case subtasks * Changing to transition issues by key * Enabled mocking for scenario 2 * Added better error handling in api util * Changed workers to 1 to eliminate duplicate test runs * Streamlined batch creation and retry check * Modified test data structure to remove undeterministic sort * Increased workers * Increased heap size for jira upload * Cleanup * Made logs more specific for JiraWritebackReporter
This commit is contained in:
parent
a27da26835
commit
55bb84cca4
6 changed files with 614 additions and 17 deletions
|
|
@ -76,8 +76,8 @@ stages:
|
|||
- script: |
|
||||
branch_name=$(System.PullRequest.SourceBranch)
|
||||
echo "Retrieved branch name: '$branch_name'"
|
||||
jira_card_number="${branch_name##*/}"
|
||||
echo "Extracted JIRA Card number: '$jira_card_number'"
|
||||
JIRA_CARD_NUMBER="${branch_name##*/}"
|
||||
echo "Extracted JIRA Card number: '$JIRA_CARD_NUMBER'"
|
||||
# Create container and run tests
|
||||
container_id=$(docker create \
|
||||
--ipc=host \
|
||||
|
|
@ -87,11 +87,13 @@ stages:
|
|||
-e ADMIN_SERVICE_API_URL=$(ADMIN_SERVICE_API_URL) \
|
||||
-e SHARD=$(shardNumber) \
|
||||
-e CI=true \
|
||||
-e ENABLE_MOCK_TESTING=true \
|
||||
-e ENABLE_ACCESSIBILITY_TESTING=true \
|
||||
-e NODE_ENV=$(NODE_ENV) \
|
||||
$(dockerImageName):$(imageTag) \
|
||||
npx concurrently -k -n "server,playwright"\
|
||||
"sed -i \"s|^process\.env\.VUE_APP_CONSUMER_CF_DISTRO = .*|process\.env\.VUE_APP_CONSUMER_CF_DISTRO='https://digitalapi.test.safelite.io'|\" \"./vue.config.js\" && echo \"Updated config file to use TEST APIs\" && npm run serve -- --port=8080"\
|
||||
"npx wait-on http://localhost:8080 && npm run test:playwright -- --shard=$(shardNumber)/$(totalShards) --reporter=list,blob --grep \"@$jira_card_number\"")
|
||||
"npx wait-on http://localhost:8080 && npm run test:playwright -- --shard=$(shardNumber)/$(totalShards) --reporter=list,blob --grep \"@$JIRA_CARD_NUMBER\"")
|
||||
|
||||
# Start container and stream logs
|
||||
echo "Starting tests for shard $(shardNumber)..."
|
||||
|
|
@ -131,7 +133,7 @@ stages:
|
|||
|
||||
- job: download_and_merge_reports
|
||||
dependsOn: playwright_tests
|
||||
timeoutInMinutes: 8
|
||||
timeoutInMinutes: 10
|
||||
cancelTimeoutInMinutes: 10
|
||||
steps:
|
||||
- task: DownloadPipelineArtifact@2
|
||||
|
|
@ -148,26 +150,27 @@ stages:
|
|||
- bash: |
|
||||
branch_name=$(System.PullRequest.SourceBranch)
|
||||
echo "Retrieved branch name: '$branch_name'"
|
||||
jira_card_number="${branch_name##*/}"
|
||||
echo "Extracted JIRA Card number: '$jira_card_number'"
|
||||
JIRA_CARD_NUMBER="${branch_name##*/}"
|
||||
echo "Extracted JIRA Card number: '$JIRA_CARD_NUMBER'"
|
||||
# Create container for jira writeback
|
||||
container_id=$(docker create \
|
||||
--ipc=host \
|
||||
-e JIRA_SERVER=$(JIRA_SERVER) \
|
||||
-e JIRA_USERNAME=$(JIRA_USERNAME) \
|
||||
-e JIRA_API_KEY=$(JIRA_API_KEY) \
|
||||
-e jira_card_number="$jira_card_number" \
|
||||
-e JIRA_CARD_NUMBER="$JIRA_CARD_NUMBER" \
|
||||
$(dockerImageName):$(imageTag) \
|
||||
bash -c "echo \"Moving Playwright reports out of subfolders...\" &&
|
||||
find ./playwright-reports/ -mindepth 2 -type f -exec mv {} ./playwright-reports/ \; &&
|
||||
echo \"Merging reports...\" &&
|
||||
PLAYWRIGHT_JUNIT_OUTPUT_DIR='/app/test-results' PLAYWRIGHT_JUNIT_OUTPUT_NAME='junit_results.xml' npx playwright merge-reports --reporter=ortoni-report,junit ./playwright-reports
|
||||
export NODE_OPTIONS=--max_old_space_size=4096
|
||||
PLAYWRIGHT_JUNIT_OUTPUT_DIR='/app/test-results' PLAYWRIGHT_JUNIT_OUTPUT_NAME='junit_results.xml' npx playwright merge-reports --reporter=ortoni-report,junit,\"/app/playwright-tests/impl/reporter/JiraWritebackReporter.ts\" ./playwright-reports
|
||||
echo \"Contents of ortoni-report:\" && ls ./ortoni-report &&
|
||||
echo 'Current dir: ' && pwd
|
||||
echo 'Contents of current dir: ' && ls
|
||||
echo 'Contents of /app/test-results' && ls /app/test-results
|
||||
echo \"Writing report to Jira card '$jira_card_number'...\" &&
|
||||
/app/devops/scripts/jira_writeback.sh add_comment \"$jira_card_number\" /app/ortoni-report/ortoni-report.html \"AUTOMATED TEST RUN: $(date)\" ")
|
||||
echo \"Writing report to Jira card '$JIRA_CARD_NUMBER'...\" &&
|
||||
/app/devops/scripts/jira_writeback.sh add_comment \"$JIRA_CARD_NUMBER\" /app/ortoni-report/ortoni-report.html \"AUTOMATED TEST RUN: $(date)\" ")
|
||||
|
||||
# Start container and stream logs
|
||||
echo "Starting merge"
|
||||
|
|
|
|||
|
|
@ -240,19 +240,19 @@ const defaultPaypalDetails: IPaymentDetails = {
|
|||
|
||||
export default class ClientData {
|
||||
static getEssentialClients() {
|
||||
return essentialClients.sort(() => 0.5 - Math.random());
|
||||
return essentialClients;
|
||||
}
|
||||
|
||||
static getEssentialClientsWithTpaEnabled() {
|
||||
return essentialClients.sort(() => 0.5 - Math.random()).filter(value => {
|
||||
return value.clientFlags.isTpaEnabled;
|
||||
return essentialClients.filter(value => {
|
||||
return value.clientFlags.isTpaEnabled;
|
||||
});
|
||||
}
|
||||
|
||||
static getEssentialClientsWithTpaDisabled() {
|
||||
return essentialClients.sort(() => 0.5 - Math.random()).filter(value => {
|
||||
return essentialClients.filter(value => {
|
||||
return !value.clientFlags.isTpaEnabled;
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
static getAdvancedClients() {
|
||||
|
|
|
|||
111
playwright-tests/business-logic/types/JiraApi.ts
Normal file
111
playwright-tests/business-logic/types/JiraApi.ts
Normal file
|
|
@ -0,0 +1,111 @@
|
|||
export interface PutEditIssueRequestBody {
|
||||
fields: Partial<JiraIssueFields>
|
||||
}
|
||||
|
||||
export interface PostTransitionIssueRequestBody {
|
||||
transition: { id: string }
|
||||
}
|
||||
|
||||
export interface PostCreateIssueRequestBody extends JiraIssue {}
|
||||
|
||||
export interface PostCreateIssueResponse {
|
||||
id: string,
|
||||
key: string
|
||||
}
|
||||
|
||||
export interface PostBulkCreateIssueRequestBody {
|
||||
issueUpdates: PostCreateIssueRequestBody[]
|
||||
}
|
||||
|
||||
export interface BulkTransitionInput {
|
||||
selectedIssueIdsOrKeys: string[],
|
||||
transitionId: string
|
||||
}
|
||||
|
||||
export interface PostBulkTransitionIssuesRequestBody {
|
||||
bulkTransitionInputs: BulkTransitionInput[],
|
||||
sendBulkNotification: false
|
||||
}
|
||||
|
||||
export interface PostBulkCreateIssueResponse {
|
||||
issues: PostCreateIssueResponse[]
|
||||
}
|
||||
|
||||
export interface PostAddCommentResponse {
|
||||
body: JiraContent
|
||||
}
|
||||
|
||||
export interface JiraIssueFields {
|
||||
summary: string,
|
||||
description: JiraContent,
|
||||
project?: JiraProject,
|
||||
issuetype?: { id: string },
|
||||
parent?: JiraParent,
|
||||
fixVersions?: JiraVersion[],
|
||||
subtasks?: JiraSubTask[],
|
||||
customfield_14857?: JiraContent // Test Steps field
|
||||
}
|
||||
|
||||
export interface JiraSubTask {
|
||||
id: string,
|
||||
key: string
|
||||
}
|
||||
|
||||
export interface JiraProject {
|
||||
key: string
|
||||
}
|
||||
|
||||
export interface JiraParent {
|
||||
key: string
|
||||
}
|
||||
|
||||
export interface JiraContent {
|
||||
type?: string,
|
||||
text?: string,
|
||||
version?: number
|
||||
content?: JiraContent[]
|
||||
}
|
||||
|
||||
export interface JiraVersion {
|
||||
id: string
|
||||
}
|
||||
|
||||
export interface JiraTransition {
|
||||
id: string,
|
||||
name: string
|
||||
}
|
||||
|
||||
export interface JiraIssueType {
|
||||
id: string,
|
||||
self: string,
|
||||
description: string,
|
||||
iconUrl: string,
|
||||
name: string,
|
||||
untranslatedName: string,
|
||||
subtask: boolean,
|
||||
}
|
||||
|
||||
export interface GetIssueTransitionsResponse {
|
||||
transitions: JiraTransition[]
|
||||
}
|
||||
|
||||
export interface GetIssueTypesResponse {
|
||||
issueTypes: JiraIssueType[]
|
||||
}
|
||||
|
||||
export interface PostBulkFetchIssuesRequestBody {
|
||||
issueIdsOrKeys: string[]
|
||||
}
|
||||
|
||||
export interface PostBulkFetchIssuesResponse {
|
||||
issues: GetIssueResponse[];
|
||||
}
|
||||
|
||||
export interface JiraIssue {
|
||||
key?: string,
|
||||
id?: string,
|
||||
transition?: { id: string },
|
||||
fields: JiraIssueFields
|
||||
}
|
||||
|
||||
export interface GetIssueResponse extends JiraIssue {}
|
||||
143
playwright-tests/impl/api/JiraApiUtil.ts
Normal file
143
playwright-tests/impl/api/JiraApiUtil.ts
Normal file
|
|
@ -0,0 +1,143 @@
|
|||
import { PostBulkFetchIssuesRequestBody, PostBulkFetchIssuesResponse, GetIssueResponse, GetIssueTransitionsResponse, GetIssueTypesResponse, PostAddCommentResponse, PostBulkCreateIssueRequestBody, PostBulkCreateIssueResponse, PostCreateIssueRequestBody, PostCreateIssueResponse, PostTransitionIssueRequestBody, PutEditIssueRequestBody, PostBulkTransitionIssuesRequestBody } from "@business-logic/types/JiraApi";
|
||||
import axios, { request } from "axios";
|
||||
import axiosRetry from "axios-retry";
|
||||
|
||||
const jiraUrl = process.env.JIRA_SERVER!;
|
||||
const jiraUsername = process.env.JIRA_USERNAME!;
|
||||
const jiraApiKey = process.env.JIRA_API_KEY!;
|
||||
const encodedAuthKey = Buffer.from(`${jiraUsername}:${jiraApiKey}`).toString('base64');
|
||||
|
||||
export default class JiraApiUtil {
|
||||
readonly baseUrl: string;
|
||||
readonly issueUrl: string;
|
||||
readonly bulkIssueCreateUrl: string;
|
||||
readonly bulkIssueFetchUrl: string;
|
||||
readonly bulkTransitionIssuesUrl: string;
|
||||
readonly axiosClient: axios.AxiosInstance;
|
||||
|
||||
constructor() {
|
||||
this.baseUrl = jiraUrl;
|
||||
this.issueUrl = `${this.baseUrl}/rest/api/3/issue`;
|
||||
this.bulkIssueCreateUrl = `${this.issueUrl}/bulk`;
|
||||
this.bulkIssueFetchUrl = `${this.issueUrl}/bulkfetch`;
|
||||
this.bulkTransitionIssuesUrl = `${this.baseUrl}/rest/api/3/bulk/issues/transition`
|
||||
this.axiosClient = axios.create();
|
||||
// interceptor to log error message from api
|
||||
this.axiosClient.interceptors.response.use(
|
||||
response => response,
|
||||
error => {
|
||||
console.error('Axios Error:', error?.response?.data || error.message);
|
||||
return Promise.reject(error);
|
||||
}
|
||||
);
|
||||
// Set up retries if requests are made too quickly
|
||||
axiosRetry(this.axiosClient, {
|
||||
retries: 4,
|
||||
retryDelay: (retryCount) => { return Math.pow(2, retryCount) * 1000; }, // Exponential backoff
|
||||
retryCondition: (error) => { return error.response?.status === 429 } // If rate-limit error
|
||||
});
|
||||
}
|
||||
|
||||
getIssue(issueKey: string) {
|
||||
const url = `${this.issueUrl}/${issueKey}`;
|
||||
return this.axiosClient.get<GetIssueResponse>(url, {
|
||||
headers: {
|
||||
Authorization: `Basic ${encodedAuthKey}`,
|
||||
Accept: 'application/json'
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
postBulkFetchIssues(requestBody: PostBulkFetchIssuesRequestBody) {
|
||||
return this.axiosClient.post<PostBulkFetchIssuesResponse>(this.bulkIssueFetchUrl, requestBody, {
|
||||
headers: {
|
||||
Authorization: `Basic ${encodedAuthKey}`,
|
||||
'Accept': 'application/json',
|
||||
'Content-Type': 'application/json'
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
getIssueTransitions(issueKey: string) {
|
||||
const url = `${this.issueUrl}/${issueKey}/transitions`
|
||||
return this.axiosClient.get<GetIssueTransitionsResponse>(url, {
|
||||
headers: {
|
||||
Authorization: `Basic ${encodedAuthKey}`,
|
||||
Accept: 'application/json'
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
getIssueTypes(projectKey: string) {
|
||||
const url = `${this.baseUrl}/rest/api/3/issue/createmeta/${projectKey}/issuetypes`;
|
||||
return this.axiosClient.get<GetIssueTypesResponse>(url, {
|
||||
headers: {
|
||||
Authorization: `Basic ${encodedAuthKey}`,
|
||||
Accept: 'application/json'
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
postAddComment(issueKey: string, commentBody: PostAddCommentResponse) {
|
||||
const url = `${this.issueUrl}/${issueKey}/comment`;
|
||||
return this.axiosClient.post(url, commentBody, {
|
||||
headers: {
|
||||
Authorization: `Basic ${encodedAuthKey}`,
|
||||
'Accept': 'application/json',
|
||||
'Content-Type': 'application/json'
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
postTransitionIssue(issueKey: string, requestBody: PostTransitionIssueRequestBody) {
|
||||
const transitionUrl = `${this.issueUrl}/${issueKey}/transitions`
|
||||
return this.axiosClient.post(transitionUrl, requestBody, {
|
||||
headers: {
|
||||
Authorization: `Basic ${encodedAuthKey}`,
|
||||
'Accept': 'application/json',
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
putEditIssue(issueKey: string, requestBody: PutEditIssueRequestBody) {
|
||||
const editIssueUrl = `${this.issueUrl}/${issueKey}`
|
||||
return this.axiosClient.put(editIssueUrl, requestBody, {
|
||||
headers: {
|
||||
Authorization: `Basic ${encodedAuthKey}`,
|
||||
'Accept': 'application/json',
|
||||
'Content-Type': 'application/json'
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
postBulkTransitionIssues(requestBody: PostBulkTransitionIssuesRequestBody) {
|
||||
return this.axiosClient.post(this.bulkTransitionIssuesUrl, requestBody, {
|
||||
headers: {
|
||||
Authorization: `Basic ${encodedAuthKey}`,
|
||||
'Accept': 'application/json',
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
postCreateIssue(requestBody: PostCreateIssueRequestBody) {
|
||||
return this.axiosClient.post<PostCreateIssueResponse>(this.issueUrl, requestBody, {
|
||||
headers: {
|
||||
Authorization: `Basic ${encodedAuthKey}`,
|
||||
'Accept': 'application/json',
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
postBulkCreateIssue(requestBody: PostBulkCreateIssueRequestBody) {
|
||||
return this.axiosClient.post<PostBulkCreateIssueResponse>(this.bulkIssueCreateUrl, requestBody, {
|
||||
headers: {
|
||||
Authorization: `Basic ${encodedAuthKey}`,
|
||||
'Accept': 'application/json',
|
||||
'Content-Type': 'application/json'
|
||||
},
|
||||
});
|
||||
}
|
||||
}
|
||||
339
playwright-tests/impl/reporter/JiraWritebackReporter.ts
Normal file
339
playwright-tests/impl/reporter/JiraWritebackReporter.ts
Normal file
|
|
@ -0,0 +1,339 @@
|
|||
import JiraApiUtil from "@impl/api/JiraApiUtil";
|
||||
import type { FullResult, Reporter, TestCase, TestResult } from "@playwright/test/reporter";
|
||||
import { formatDate } from "@impl/utils/DateUtils";
|
||||
import { GetIssueResponse, JiraIssue, JiraIssueFields } from "@business-logic/types/JiraApi";
|
||||
|
||||
const jiraCardNumber = process.env.JIRA_CARD_NUMBER!;
|
||||
const jiraProjectKey = 'INSR';
|
||||
const passTransitionId = '111';
|
||||
const failTransitionId = '101';
|
||||
|
||||
export default class JiraWritebackReporter implements Reporter {
|
||||
readonly jiraApiUtil: JiraApiUtil = new JiraApiUtil();
|
||||
readonly loadIssueCalls: (() => void)[] = []; // Calls to loadIssue must be deferred because they depend on information from the API.
|
||||
readonly issuesToPass: string[] = []; // Issues to transition to "Pass".
|
||||
readonly issuesToFail: string[] = []; // Issues to transition to "Fail".
|
||||
readonly issuesToCreate: JiraIssue[] = []; // Issues to be batch created.
|
||||
existingSubtasks: JiraIssue[] = []; // Array to hold existing subtasks of the dev card.
|
||||
testCaseTypeId: string|undefined = undefined; // ID of the test case subtask type in Jira. Will be filled by API call.
|
||||
bugTypeId:string|undefined = undefined; // ID of the bug subtask type.
|
||||
parentCard: GetIssueResponse | undefined = undefined; // Variable to hold the parent card. Will be filled by API call.
|
||||
|
||||
// Will need this if we want to move ortoni report upload into this reporter.
|
||||
// readonly ortoniReport = new OrtoniReport(reportConfig);
|
||||
|
||||
/**
|
||||
* This function loads the IDs for the Jira Issue Types we use.
|
||||
*
|
||||
*/
|
||||
async loadJiraIssueTypes() {
|
||||
console.log(`JiraWritebackReporter >> Loading Jira Issue Types for project '${jiraProjectKey}'...`);
|
||||
const issueTypesRes = await this.jiraApiUtil.getIssueTypes(jiraProjectKey);
|
||||
const issueTypes = issueTypesRes.data;
|
||||
this.testCaseTypeId = issueTypes.issueTypes.find(issueType => {
|
||||
return issueType.subtask === true && issueType.name === 'Test Case Sub-task'
|
||||
})?.id;
|
||||
this.bugTypeId = issueTypes.issueTypes.find(issueType => {
|
||||
return issueType.subtask === true && issueType.name === 'Bug Sub-task'
|
||||
})?.id;
|
||||
console.log('JiraWritebackReporter >> Loaded issue types.');
|
||||
}
|
||||
|
||||
/**
|
||||
* This function generates a test subtask based on the test results we pass in.
|
||||
* @param test TestCase from onTestEnd()
|
||||
* @param result TestResult from onTestEnd()
|
||||
* @returns Jira Test Subtask based on test result.
|
||||
*/
|
||||
getCreateTestSubtask(test: TestCase, result: TestResult) {
|
||||
if (result.status === 'skipped') {
|
||||
return undefined;
|
||||
}
|
||||
const testStepTitles = result.steps.map(step => {
|
||||
return `-\t${step.title}`;
|
||||
}).join('\n');
|
||||
const allErrors = result.errors.map(value => {
|
||||
return value.message
|
||||
}).join('\n');
|
||||
|
||||
const description = `Most recent test status: ${result.status}.\nDuration: ${result.duration/1000} seconds.\nErrors:\n${allErrors}`
|
||||
const testSubtaskBody: JiraIssueFields = {
|
||||
summary: test.title,
|
||||
description: {
|
||||
content: [
|
||||
{
|
||||
"content": [
|
||||
{
|
||||
"text": description,
|
||||
"type": "text"
|
||||
}
|
||||
],
|
||||
"type": "paragraph"
|
||||
}
|
||||
],
|
||||
"type": "doc",
|
||||
"version": 1
|
||||
},
|
||||
project: {
|
||||
key: jiraProjectKey
|
||||
},
|
||||
issuetype: {
|
||||
id: this.testCaseTypeId!
|
||||
},
|
||||
parent: {
|
||||
key: jiraCardNumber
|
||||
},
|
||||
customfield_14857: {
|
||||
type: 'doc',
|
||||
version: 1,
|
||||
content: [
|
||||
{
|
||||
type: 'paragraph',
|
||||
content: [
|
||||
{
|
||||
type: 'text',
|
||||
text: testStepTitles
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
};
|
||||
return testSubtaskBody;
|
||||
}
|
||||
|
||||
/**
|
||||
* This function generates a bug subtask based on the test results we pass in.
|
||||
* @param test TestCase from onTestEnd()
|
||||
* @param result TestResult from onTestEnd()
|
||||
* @returns Jira Bug Subtask based on test result.
|
||||
*/
|
||||
getCreateBug(test: TestCase, result: TestResult) {
|
||||
if (result.status === 'passed' || result.status === 'skipped') {
|
||||
return undefined;
|
||||
}
|
||||
const allErrors = result.errors.map(value => {
|
||||
return value.message
|
||||
}).join('\n');
|
||||
|
||||
const bug: JiraIssueFields = {
|
||||
summary: `TEST FAILED ${formatDate(new Date())}: ${test.title}`,
|
||||
description: {
|
||||
content: [
|
||||
{
|
||||
"content": [
|
||||
{
|
||||
"text": allErrors,
|
||||
"type": "text"
|
||||
}
|
||||
],
|
||||
"type": "paragraph"
|
||||
}
|
||||
],
|
||||
"type": "doc",
|
||||
"version": 1
|
||||
},
|
||||
project: {
|
||||
key: jiraProjectKey
|
||||
},
|
||||
issuetype: {
|
||||
id: this.bugTypeId!
|
||||
},
|
||||
parent: {
|
||||
key: jiraCardNumber
|
||||
}
|
||||
};
|
||||
return bug;
|
||||
}
|
||||
|
||||
/**
|
||||
* This function gives us the correct transition for a test subtask based on this test result.
|
||||
* @param result TestResult from onTestEnd()
|
||||
* @returns Correct transition to pass to the Jira API.
|
||||
*/
|
||||
getSubtaskTransition(result: TestResult): { id: string } | undefined {
|
||||
if (result.status === 'skipped') {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
if (result.status === 'passed') {
|
||||
return {
|
||||
id: passTransitionId
|
||||
};
|
||||
} else {
|
||||
return {
|
||||
id: failTransitionId
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Grabs parent card and existing subtasks.
|
||||
*/
|
||||
async loadReporterData() {
|
||||
await this.loadJiraIssueTypes();
|
||||
|
||||
console.log('JiraWritebackReporter >> Searching for parent card...');
|
||||
const parentRes = await this.jiraApiUtil.getIssue(jiraCardNumber);
|
||||
const parentCard = parentRes.data;
|
||||
console.log(`JiraWritebackReporter >> Retrieved parent card: ${parentCard.key}: ${parentCard.fields.summary}`);
|
||||
|
||||
console.log(`JiraWritebackReporter >> Searching for all subtasks of parent card '${jiraCardNumber}'...`);
|
||||
const subtaskIds = parentCard.fields.subtasks?.map(subtask => {
|
||||
return subtask.id;
|
||||
});
|
||||
|
||||
if (subtaskIds && subtaskIds.length > 0) {
|
||||
for (let i = 0; i < subtaskIds.length; i+=50) {
|
||||
const batch = subtaskIds.slice(i, i+50);
|
||||
const subTasksRes = await this.jiraApiUtil.postBulkFetchIssues({ issueIdsOrKeys: batch });
|
||||
this.existingSubtasks.push(...subTasksRes.data.issues);
|
||||
}
|
||||
console.log('JiraWritebackReporter >> Subtasks retrieved.');
|
||||
} else {
|
||||
console.log('JiraWritebackReporter >> No subtasks were found.');
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Bulk creates test cases and bugs in batches of up to 50. Bulk transitions existing test case subtasks.
|
||||
*/
|
||||
async writeResults() {
|
||||
for (let i = 0; i < this.issuesToCreate.length; i+=50) {
|
||||
const batch = this.issuesToCreate.slice(i, i + 50);
|
||||
console.log('JiraWritebackReporter >> Creating issue batch...');
|
||||
// fire request
|
||||
await this.jiraApiUtil.postBulkCreateIssue({ issueUpdates: batch });
|
||||
console.log('JiraWritebackReporter >> Issue batch created.');
|
||||
}
|
||||
|
||||
if (this.issuesToPass.length > 0) {
|
||||
console.log('JiraWritebackReporter >> Transitioning passed test cases to "Pass"...')
|
||||
await this.jiraApiUtil.postBulkTransitionIssues( {
|
||||
bulkTransitionInputs: [{
|
||||
selectedIssueIdsOrKeys: this.issuesToPass,
|
||||
transitionId: passTransitionId
|
||||
}],
|
||||
sendBulkNotification: false
|
||||
});
|
||||
console.log('JiraWritebackReporter >> Transition success.');
|
||||
}
|
||||
|
||||
if (this.issuesToFail.length > 0) {
|
||||
console.log('JiraWritebackReporter >> Transitioning failed test cases to "Fail"...')
|
||||
await this.jiraApiUtil.postBulkTransitionIssues( {
|
||||
bulkTransitionInputs: [{
|
||||
selectedIssueIdsOrKeys: this.issuesToFail,
|
||||
transitionId: failTransitionId
|
||||
}],
|
||||
sendBulkNotification: false
|
||||
});
|
||||
console.log('JiraWritebackReporter >> Transition success.')
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Builds and loads appropriate response based on test result. This can be a test subtask/bug subtask or a call to transition a test subtask.
|
||||
* @param test TestCase from onTestEnd()
|
||||
* @param result TestResult from onTestEnd()
|
||||
* @returns Void
|
||||
*/
|
||||
loadIssue(test: TestCase, result: TestResult) {
|
||||
if (result.status === 'skipped') return;
|
||||
if (result.status !== 'passed' && result.retry < test.retries) return; // Skip if test case failed and this isn't the last retry.
|
||||
|
||||
let existingTestSubtask: JiraIssue | undefined = undefined;
|
||||
let existingBug: JiraIssue | undefined = undefined;
|
||||
const subtaskTransition = this.getSubtaskTransition(result)!; // Get either a Pass or Fail transition depending on test results.
|
||||
|
||||
console.log('JiraWritebackReporter >> Checking for existing subtasks for this test...');
|
||||
for (const card of this.existingSubtasks) {
|
||||
if (card.fields.issuetype?.id === this.testCaseTypeId) {
|
||||
if (card.fields.summary === test.title) {
|
||||
existingTestSubtask = card;
|
||||
console.log('JiraWritebackReporter >> Found existing test subtask.');
|
||||
}
|
||||
} else if (card.fields.issuetype?.id === this.bugTypeId) {
|
||||
if (new RegExp(`^TEST FAILED [0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9]: ${test.title}$`).test(card.fields.summary)) {
|
||||
existingBug = card;
|
||||
console.log('JiraWritebackReporter >> Found existing bug.');
|
||||
// TODO: Handle multiple matches for bug/test case. Currently picks one in that case.
|
||||
}
|
||||
}
|
||||
}
|
||||
if (!(existingTestSubtask || existingBug)) {
|
||||
console.log('JiraWritebackReporter >> No existing test subtask or bug was found.')
|
||||
}
|
||||
|
||||
const subTask = this.getCreateTestSubtask(test, result); // Will return undefined if test status is 'skipped'
|
||||
const bug = this.getCreateBug(test, result); // Will return undefined if we don't need one
|
||||
if (subTask) {
|
||||
// Create or Edit Subtask
|
||||
if (existingTestSubtask) {
|
||||
if (result.status === 'passed') {
|
||||
this.issuesToPass.push(existingTestSubtask.key!);
|
||||
} else {
|
||||
this.issuesToFail.push(existingTestSubtask.key!);
|
||||
}
|
||||
} else {
|
||||
this.issuesToCreate.push({
|
||||
fields: subTask,
|
||||
transition: subtaskTransition
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
if (bug) {
|
||||
// Create or Edit Bug
|
||||
if (existingBug) {
|
||||
// Leave it alone. This reporter should not modify existing bugs.
|
||||
} else {
|
||||
this.issuesToCreate.push({
|
||||
fields: bug
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This function loads calls to loadIssue() in an array to be executed when the necessary information from the Jira API is available.
|
||||
* @param test
|
||||
* @param result
|
||||
*/
|
||||
onTestEnd(test: TestCase, result: TestResult) {
|
||||
// this.ortoniReport.onTestEnd(test, result);
|
||||
this.loadIssueCalls.push(() => { this.loadIssue(test, result); });
|
||||
}
|
||||
|
||||
/**
|
||||
* Makes calls to load and execute API calls to Jira.
|
||||
* @param result
|
||||
* @returns Promise to write results to Jira.
|
||||
*/
|
||||
onEnd(result: FullResult): Promise<{ status?: FullResult["status"]; } | undefined | void>|void {
|
||||
// this.ortoniReport.onEnd(result);
|
||||
return this.loadReporterData().then(async () => {
|
||||
this.loadIssueCalls.map(fn => fn());
|
||||
await this.writeResults();
|
||||
console.log(`JiraWritebackReporter >> Posted necessary changes for '${jiraCardNumber}'`);
|
||||
});
|
||||
}
|
||||
|
||||
// These overloads will become necessary if we move the ortoni report upload into this reporter
|
||||
// onBegin(config: FullConfig, suite: Suite): void {
|
||||
// this.ortoniReport.onBegin(config, suite);
|
||||
// }
|
||||
|
||||
// onError(error: TestError): void {
|
||||
// this.ortoniReport.onError(error);
|
||||
// }
|
||||
|
||||
// onExit(): Promise<void> {
|
||||
// return this.ortoniReport.onExit();
|
||||
// }
|
||||
|
||||
// onStdOut(chunk: string | Buffer, test: void | TestCase, result: void | TestResult): void {
|
||||
// this.ortoniReport.onStdOut(chunk, test, result);
|
||||
// }
|
||||
}
|
||||
|
|
@ -51,7 +51,7 @@ export default defineConfig({
|
|||
/* Retry on CI only */
|
||||
retries: process.env.CI ? 1 : 0,
|
||||
/* Opt out of parallel tests on CI. */
|
||||
workers: process.env.CI ? 2 : 5,
|
||||
workers: process.env.CI ? 4 : 5,
|
||||
/* Reporter to use. See https://playwright.dev/docs/test-reporters */
|
||||
reporter: [
|
||||
['ortoni-report', reportConfig],
|
||||
|
|
@ -68,7 +68,8 @@ export default defineConfig({
|
|||
trace: 'on-first-retry',
|
||||
headless: process.env.CI ? true : false,
|
||||
screenshot: "only-on-failure",
|
||||
|
||||
actionTimeout: 5_000,
|
||||
navigationTimeout: 20_000
|
||||
},
|
||||
|
||||
/* Configure projects for major browsers */
|
||||
|
|
|
|||
Loading…
Reference in a new issue