-
Notifications
You must be signed in to change notification settings - Fork 274
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #942 from microsoft/johtaylo/inspection-unit-test
Johtaylo/inspection unit test
- Loading branch information
Showing
7 changed files
with
145 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
120 changes: 120 additions & 0 deletions
120
libraries/botbuilder/tests/inspectionMiddleware.test.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
|
|
||
| /** | ||
| * Copyright (c) Microsoft Corporation. All rights reserved. | ||
| * Licensed under the MIT License. | ||
| */ | ||
|
|
||
| const nock = require('nock'); | ||
| const assert = require('assert'); | ||
| const { TestAdapter, MemoryStorage, MessageFactory, UserState, ConversationState } = require('botbuilder-core'); | ||
| const { InspectionMiddleware, InspectionState } = require('../'); | ||
|
|
||
| beforeEach(function(done){ | ||
| nock.cleanAll(); | ||
|
|
||
| done(); | ||
| }); | ||
|
|
||
| afterEach(function(done){ | ||
| nock.cleanAll(); | ||
| done(); | ||
| }); | ||
|
|
||
| describe('InspectionMiddleware', function() { | ||
|
|
||
| it('should not change behavior when inspection middleware is added', async function() { | ||
|
|
||
| var inspectionState = new InspectionState(new MemoryStorage()); | ||
| var inspectionMiddleware = new InspectionMiddleware(inspectionState); | ||
|
|
||
| const adapter = new TestAdapter(async (turnContext) => { | ||
|
|
||
| await turnContext.sendActivity(MessageFactory.text('hi')); | ||
| }); | ||
|
|
||
| adapter.use(inspectionMiddleware); | ||
|
|
||
| await adapter.receiveActivity(MessageFactory.text('hello')); | ||
|
|
||
| assert(adapter.activityBuffer.length === 1, 'expected a single adapter response'); | ||
| assert(adapter.activityBuffer[0].type === 'message', 'expected a message activity'); | ||
| assert(adapter.activityBuffer[0].text === 'hi', `expected text saying 'hi'`); | ||
| }); | ||
| it('should replicate activity data to listening emulator following open and attach', async function() { | ||
|
|
||
| // set up our expectations in nock - each corresponds to a trace message we expect to receive in the emulator | ||
|
|
||
| const inboundExpectation = nock('https://test.com') | ||
| .post('/v3/conversations/Convo1/activities', activity => activity.type === 'trace' | ||
| && activity.value.text == 'hi') | ||
| .reply(200, { id: 'test' }); | ||
|
|
||
| const outboundExpectation = nock('https://test.com') | ||
| .post('/v3/conversations/Convo1/activities', activity => activity.type === 'trace' | ||
| && activity.value.text == 'echo: hi') | ||
| .reply(200, { id: 'test' }); | ||
|
|
||
| const stateExpectation = nock('https://test.com') | ||
| .post('/v3/conversations/Convo1/activities', activity => activity.type === 'trace' | ||
| && activity.value.userState && activity.value.userState.x.property == 'hello' | ||
| && activity.value.conversationState && activity.value.conversationState.y.property == 'world') | ||
| .reply(200, { id: 'test' }); | ||
|
|
||
| // create the various storage and middleware objects we will be using | ||
|
|
||
| var storage = new MemoryStorage(); | ||
| var inspectionState = new InspectionState(storage); | ||
| var userState = new UserState(storage); | ||
| var conversationState = new ConversationState(storage); | ||
| var inspectionMiddleware = new InspectionMiddleware(inspectionState, userState, conversationState); | ||
|
|
||
| // the emulator sends an /INSPECT open command - we can use another adapter here | ||
|
|
||
| var openActivity = MessageFactory.text('/INSPECT open'); | ||
|
|
||
| const inspectionAdapter = new TestAdapter(async (turnContext) => { | ||
| await inspectionMiddleware.processCommand(turnContext); | ||
| }, null, true); | ||
|
|
||
| await inspectionAdapter.receiveActivity(openActivity); | ||
|
|
||
| var inspectionOpenResultActivity = inspectionAdapter.activityBuffer[0]; | ||
| var attachCommand = inspectionOpenResultActivity.value; | ||
|
|
||
| // the logic of teh bot including replying with a message and updating user and conversation state | ||
|
|
||
| var x = userState.createProperty('x'); | ||
| var y = conversationState.createProperty('y'); | ||
|
|
||
| var applicationAdapter = new TestAdapter(async (turnContext) => { | ||
|
|
||
| await turnContext.sendActivity(MessageFactory.text(`echo: ${ turnContext.activity.text }`)); | ||
|
|
||
| (await x.get(turnContext, { property: '' })).property = 'hello'; | ||
| (await y.get(turnContext, { property: '' })).property = 'world'; | ||
|
|
||
| await userState.saveChanges(turnContext); | ||
| await conversationState.saveChanges(turnContext); | ||
|
|
||
| }, null, true); | ||
|
|
||
| // IMPORTANT add the InspectionMiddleware to the adapter that is running our bot | ||
|
|
||
| applicationAdapter.use(inspectionMiddleware); | ||
|
|
||
| await applicationAdapter.receiveActivity(MessageFactory.text(attachCommand)); | ||
|
|
||
| // the attach command response is a informational message | ||
|
|
||
| await applicationAdapter.receiveActivity(MessageFactory.text('hi')); | ||
|
|
||
| // trace activities should be sent to the emulator using the connector and the conversation reference | ||
|
|
||
| // verify that all our expectations have been met | ||
|
|
||
| assert(inboundExpectation.isDone(), 'The expectation of a trace message for the inbound activity was not met'); | ||
| assert(outboundExpectation.isDone(), 'The expectation of a trace message for the outbound activity was not met'); | ||
| assert(stateExpectation.isDone(), 'The expectation of a trace message for the bot state was not met'); | ||
| }); | ||
| }); | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters