Skip to content

Commit

Permalink
Issue model: refactor test cases
Browse files Browse the repository at this point in the history
  • Loading branch information
@NereusWB922
NereusWB922 committed Feb 7, 2024
1 parent 70e2907 commit e5b59ed
Showing 1 changed file with 6 additions and 109 deletions.
115 changes: 6 additions & 109 deletions tests/model/issue.model.spec.ts
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
import { IssueDispute } from '../../src/app/core/models/issue-dispute.model';
import * as moment from 'moment';
import { Issue } from '../../src/app/core/models/issue.model';
import { Phase } from '../../src/app/core/models/phase.model';
import { TesterResponse } from '../../src/app/core/models/tester-response.model';
import { TEAM_4 } from '../constants/data.constants';

import { ISSUE_WITH_ASSIGNEES, ISSUE_WITH_EMPTY_DESCRIPTION } from '../constants/githubissue.constants';

describe('Issue model class', () => {
Expand All @@ -12,132 +8,33 @@ describe('Issue model class', () => {
const issue = Issue.createPhaseBugReportingIssue(ISSUE_WITH_EMPTY_DESCRIPTION);
expect(issue.title).toBe('App starts to lag when given large amount of input');
expect(issue.description).toBe('No details provided by bug reporter.');
expect(issue.severity).toBe('Medium');
expect(issue.type).toBe('FunctionalityBug');
});
});
describe('.createPhaseTeamResponseIssue(githubIssue, githubComment)', () => {
it('correctly creates a team response issue that has an empty team response', async () => {
const dummyTeam = null;
const issue = Issue.createPhaseTeamResponseIssue(ISSUE_WITH_ASSIGNEES, dummyTeam);
expect(issue.title).toBe('Screen freezes');
expect(issue.teamResponse).toBe('No details provided by team.');
expect(issue.severity).toBe('Medium');
expect(issue.assignees).toContain('anubh-v');
expect(issue.assignees.length).toBe(1);
expect(issue.updated_at).toBe(moment(ISSUE_WITH_EMPTY_DESCRIPTION.updated_at).format('lll'));
expect(issue.state).toBe(ISSUE_WITH_EMPTY_DESCRIPTION.state);
});
});
describe('.updateDescription(description) and .updateTeamResponse(teamResponse)', () => {
describe('.updateDescription(description)', () => {
it('correctly clean strings obtained from users', () => {
const noDetailsFromBugReporter = 'No details provided by bug reporter.';
const noDetailsFromTeam = 'No details provided by team.';
expect(Issue.updateDescription('')).toBe(noDetailsFromBugReporter);
expect(Issue.updateTeamResponse('')).toBe(noDetailsFromTeam);
expect(Issue.updateDescription(null)).toBe(noDetailsFromBugReporter);
expect(Issue.updateTeamResponse(undefined)).toBe(noDetailsFromTeam);

const typicalDescription = 'The app crashes after parsing config files.';
const typicalTeamResponse = 'Cannot replicate the bug.';
expect(Issue.updateDescription(typicalDescription)).toBe(typicalDescription + '\n\n');
expect(Issue.updateTeamResponse(typicalTeamResponse)).toBe(typicalTeamResponse + '\n\n');

const inputWithSpecialChars = '$%^!@&-_test';
expect(Issue.updateDescription(inputWithSpecialChars)).toBe(inputWithSpecialChars + '\n\n');
expect(Issue.updateTeamResponse(inputWithSpecialChars)).toBe(inputWithSpecialChars + '\n\n');
});
});
});

describe('Issue', () => {
const dummyTeam = TEAM_4;
const dummyIssue = Issue.createPhaseBugReportingIssue(ISSUE_WITH_EMPTY_DESCRIPTION);
const otherDummyIssue = Issue.createPhaseBugReportingIssue(ISSUE_WITH_ASSIGNEES);
const dummyIssueWithTeam = Issue.createPhaseTeamResponseIssue(ISSUE_WITH_EMPTY_DESCRIPTION, dummyTeam);

const noReportedDescriptionString = 'No details provided by bug reporter.\n';
const tutorResponseStringHeader = '# Tutor Moderation\n\n';

const newIssueDispute = new IssueDispute('Cannot Work', 'Help Please');
const newTesterResponse = new TesterResponse('Cannot Work', 'Help Please', 'Not Done', false, 'Reason');

it('.clone() should intialise the cloned issue with the correct phase and team', () => {
const phaseBugReportingIssue = dummyIssue.clone(Phase.phaseBugReporting);
expect(phaseBugReportingIssue).toEqual(dummyIssue);

const phaseTeamResponseIssue = dummyIssueWithTeam.clone(Phase.phaseTeamResponse);
expect(phaseTeamResponseIssue.githubComments).toEqual(dummyIssueWithTeam.githubComments);
expect(phaseTeamResponseIssue.teamAssigned).toEqual(dummyTeam);

const phaseTesterResponseIssue = dummyIssueWithTeam.clone(Phase.phaseTesterResponse);
expect(phaseTesterResponseIssue.githubComments).toEqual(dummyIssueWithTeam.githubComments);

const phaseModerationIssue = dummyIssueWithTeam.clone(Phase.phaseModeration);
expect(phaseModerationIssue.githubComments).toEqual(dummyIssueWithTeam.githubComments);
expect(phaseModerationIssue.teamAssigned).toEqual(dummyTeam);
});

it('.createGithubIssueDescription() forms the correct GitHub Issue description for the issue', () => {
const phaseBugReportingIssue = dummyIssue.clone(Phase.phaseBugReporting);
expect(phaseBugReportingIssue.createGithubIssueDescription()).toEqual(noReportedDescriptionString);

const phaseBugReportingIssueWithDescription = otherDummyIssue.clone(Phase.phaseBugReporting);
expect(phaseBugReportingIssueWithDescription.createGithubIssueDescription()).toEqual(
`${phaseBugReportingIssueWithDescription.description}\n`
);
});

it('.createGithubTeamResponse() should be able to get the proper Team Response', () => {
const phaseTeamResponseIssue = dummyIssue.clone(Phase.phaseTeamResponse);
phaseTeamResponseIssue.teamResponse = 'Sample Text';
expect(phaseTeamResponseIssue.createGithubTeamResponse()).toEqual(
`# Team\'s Response\n${phaseTeamResponseIssue.teamResponse}\n## Duplicate status (if any):\n--`
);

const phaseTeamResponseIssue2 = dummyIssue.clone(Phase.phaseTeamResponse);
phaseTeamResponseIssue2.teamResponse = 'Sample Text';
phaseTeamResponseIssue2.duplicateOf = 10;
expect(phaseTeamResponseIssue2.createGithubTeamResponse()).toEqual(
`# Team\'s Response\n${phaseTeamResponseIssue2.teamResponse}\n` +
`## Duplicate status (if any):\nDuplicate of #${phaseTeamResponseIssue2.duplicateOf}`
);
});

it('.createGithubTutorResponse() should be able to get the proper Tutor Response', () => {
const phaseModerationIssue = dummyIssueWithTeam.clone(Phase.phaseModeration);
expect(phaseModerationIssue.createGithubTutorResponse()).toEqual(tutorResponseStringHeader);

const phaseModerationIssue2 = dummyIssueWithTeam.clone(Phase.phaseModeration);
phaseModerationIssue2.issueDisputes = [newIssueDispute];
expect(phaseModerationIssue2.createGithubTutorResponse()).toEqual(tutorResponseStringHeader + newIssueDispute.toTutorResponseString());
});

it('.createGithubTesterResponse() should be able to get the proper Tester Response', () => {
const phaseTesterResponseIssue = dummyIssueWithTeam.clone(Phase.phaseTesterResponse);
phaseTesterResponseIssue.teamResponse = 'Sample Text';
phaseTesterResponseIssue.testerResponses = [];
expect(phaseTesterResponseIssue.createGithubTesterResponse()).toEqual(
`# Team\'s Response\n${phaseTesterResponseIssue.teamResponse}\n` + `# Items for the Tester to Verify\n${''}`
);

const phaseTesterResponseIssue2 = dummyIssueWithTeam.clone(Phase.phaseTesterResponse);
phaseTesterResponseIssue2.teamResponse = 'Sample Text';
phaseTesterResponseIssue2.testerResponses = [newTesterResponse];
expect(phaseTesterResponseIssue2.createGithubTesterResponse()).toEqual(
`# Team\'s Response\n${phaseTesterResponseIssue.teamResponse}\n` + `# Items for the Tester to Verify\n${newTesterResponse.toString()}`
);
});

it('.numOfUnresolvedDisputes() returns the correct number of issue disputes', () => {
const phaseModerationIssue = dummyIssueWithTeam.clone(Phase.phaseModeration);
expect(phaseModerationIssue.numOfUnresolvedDisputes()).toEqual(0);

const phaseModerationIssue2 = dummyIssueWithTeam.clone(Phase.phaseModeration);
phaseModerationIssue2.issueDisputes = [newIssueDispute];
expect(phaseModerationIssue2.numOfUnresolvedDisputes()).toEqual(1);
expect(dummyIssue.createGithubIssueDescription()).toEqual(noReportedDescriptionString);

const phaseModerationIssue3 = dummyIssueWithTeam.clone(Phase.phaseModeration);
phaseModerationIssue3.issueDisputes = [newIssueDispute];
newIssueDispute.setIsDone(true);
expect(phaseModerationIssue3.numOfUnresolvedDisputes()).toEqual(0);
expect(otherDummyIssue.createGithubIssueDescription()).toEqual(`${otherDummyIssue.description}\n`);
});
});

0 comments on commit e5b59ed

Please sign in to comment.