This PR modifies createIssueLink() so that it accepts a new property in the options param, testSequenceNumber. In all instances where this function is used, the generated number used for rendering the test number ("Test X:") is passed. This handles confusion about which test is referenced when creating issues. The test row number which is now decoupled from the specific report's sequence is still stored in the hiddenMetadata of the issue.
I wanted to add a unit test but this would be difficult with the current design of this method since the testable logic for this particular problem has more to do with the generated sequence passed in. I can think of ways to adjust the design but none is an absolute win so I decided this was out of scope. Let me know if reviewers think otherwise.
addresses #1110
To see the specific tasks where the Asana app for GitHub is being used, see below:
This PR modifies
createIssueLink()
so that it accepts a new property in the options param,testSequenceNumber
. In all instances where this function is used, the generated number used for rendering the test number ("Test X:") is passed. This handles confusion about which test is referenced when creating issues. The test row number which is now decoupled from the specific report's sequence is still stored in thehiddenMetadata
of the issue.I wanted to add a unit test but this would be difficult with the current design of this method since the testable logic for this particular problem has more to do with the generated sequence passed in. I can think of ways to adjust the design but none is an absolute win so I decided this was out of scope. Let me know if reviewers think otherwise.
addresses #1110