[#12588] Improve test code coverage of core components #13000
Conversation
|
hi @skylar-mo, thank you for your PR, do fix the failing tests before we proceed to review it also do refer to the guidelines here: https://teammates.github.io/teammates/unit-testing.html for writing unit tests, at a glance it appears that the method name is missing from the test descriptor strings, do add that in, thank you! also there is no need to add the test case in a new describe block, do remove that as well |
fixed test descriptor strings, and describe block
| expect(component).toBeTruthy(); | ||
| }); | ||
| }); | ||
|
|
||
| it('updateNoneOfTheAbove: should update answers based on isNoneOfTheAboveEnabled', () => { | ||
| const component = new MsqQuestionEditAnswerFormComponent(); |
There was a problem hiding this comment.
component is declared in beforeEach
this can be deleted
|
|
||
| it('updateNoneOfTheAbove: should update answers based on isNoneOfTheAboveEnabled', () => { | ||
| const component = new MsqQuestionEditAnswerFormComponent(); | ||
| component.responseDetails = { |
There was a problem hiding this comment.
the type of responseDetails is
FeedbackMsqResponseDetails extends FeedbackResponseDetails
so the three missing properties and their types are
isOther: boolean
otherFieldContent: string
questionType: FeedbackQuestionType
FeedbackQuestionType is an enum
use createBuilder to create responseDetails so you don't have to enter all four properties every time you create responseDetails, here is an example of createBuilder
https://teammates.github.io/teammates/unit-testing.html#creating-test-data
you will need these imports
import { createBuilder } from '../../../../test-helpers/generic-builder';
import { FeedbackMsqResponseDetails } from '../../../../types/api-output';
import { FeedbackQuestionType } from '../../../../types/api-request';
| // Simulate isNoneOfTheAboveEnabled being false | ||
| component.updateNoneOfTheAbove(); | ||
|
|
||
| expect(component.responseDetails.answers).toEqual(['NoneOfTheAbove']); |
There was a problem hiding this comment.
responseDetails has an @Input() decorator so it is set by the parent component, not updateNoneOfTheAbove()
responseDetails.answers is not used for data binding in the html
so instead of testing the value of responseDetails.answers
test the behavior of updateNoneOfTheAbove()
it calls this.triggerResponseDetailsChangeBatch() with values for the properties answers: isOther: otherFieldContent:
use testEventEmission
https://teammates.github.io/teammates/unit-testing.html#testing-event-emission
import testEventEmission from '../../../../test-helpers/test-event-emitter';
you will need to look at the parent class of MsqQuestionEditAnswerFormComponent
which is QuestionEditAnswerFormComponent
it is in the file question-edit-answer-form.ts, the same folder as your test
Fixes #12588
Outline of Solution
I added some unit tests to help improve code coverage for "QuestionEditAnswerForm".