Show custom error messages

[santiagodoldan]

No description provided.

[santiagodoldan]

This should fix this issue #51

[coveralls]

Coverage increased (+0.7%) to 95.38% when pulling b8bbb01 on suttna:show-custom-error-messages into 14aa478 on microsoftly:master.

[coveralls]

Coverage remained the same at 95.372% when pulling 49b8732 on suttna:show-custom-error-messages into 04f6abe on microsoftly:dev.

[microsoftly]

Looks good to me.

Please add a test to BotTester.spec.ts with the title "Can show custom error messages" and add the test to the README.md documentation and I'll be ready to merge and release an updated package.

sidenote: I've changed the base to from master to dev. Once dev is ready for publishing, the docs are recompiled, version number bumped, package is published, then dev is merged into master.

[santiagodoldan]

@microsoftly should I add a tests for each matcher? https://github.com/microsoftly/BotTester/blob/master/src/assertionLibraries/ChaiExpectation.ts#L39-L53 looks like the deep include doesn't use the given message

[microsoftly]

@santiagodoldan yes, please explicitly test each method.

I think having deep include also have the message could be useful. It shouldn't be too much work to extend it as well.

Only one of the new tests needs to be added to the documentation. The rest can be put in the cases not for docs

[santiagodoldan]

@microsoftly

First of all, there's already a test file https://github.com/microsoftly/BotTester/blob/master/test/BotTesterFailure.spec.ts that test the error messages, the issue I see there is that chai includes both messages in the Error object (the format is "new-message:old-message") and this expectation https://github.com/microsoftly/BotTester/blob/master/test/BotTesterFailure.spec.ts is not comparing if the string is equal, it checks if the error message contains that string, which is true because is the default message that chai uses.

Regarding the test file, I was able to test the toInclude just passing the new custom message, I also was able to test the notToBeEmpty passing an empty array to the sendMessageToBot and also the toBeTrue passing a regexp.

The only one I can't test is the toEqual, I think the line that uses that expectation can't be reached, here you have the code https://github.com/microsoftly/BotTester/blob/master/src/ExpectedMessage.ts#L71-L72 and https://github.com/microsoftly/BotTester/blob/master/src/ExpectedMessage.ts#L71-L72, that default block isn't executed IMO.

[santiagodoldan]

@microsoftly another thing, would you like to move this expectation https://github.com/microsoftly/BotTester/blob/master/src/ExpectedMessage.ts#L50 out of the constructor? because that fails without executing runTest()

[coveralls]

Coverage decreased (-0.1%) to 95.254% when pulling 932bdad on suttna:show-custom-error-messages into 04f6abe on microsoftly:dev.

[santiagodoldan]

@microsoftly regarding what chai does with the message https://github.com/chaijs/chai/blob/master/lib/chai/utils/getMessage.js#L49, do you want to remove the old message or is that ok? let me know what would you like to do, so I can finish the PR, thanks :)

[microsoftly]

Removing the expect out of the constructor is fine.

I'm not sure which old message you're referring to, but I'll let you pick your best judgement. I'm fine W/ the PR as is.

[microsoftly]

as for https://github.com/microsoftly/BotTester/blob/master/src/ExpectedMessage.ts#L71-L72, it's been a while, but I'm pretty sure that's for ignoring internal save messages that are used to get the session loader to work properly

[coveralls]

Coverage increased (+1.3%) to 95.254% when pulling b0e06c6 on suttna:show-custom-error-messages into f34cfd5 on microsoftly:dev.

[santiagodoldan]

@microsoftly

About the message, here you have an example of how it looks

Bot should have responded with 'NOPE', but was 'how are you doing?: expected [ 'NOPE' ] to include 'how are you doing?'

If that's ok, let's merge the PR then :)

[microsoftly]

great