Fix for scenario test failure (#597)

Added wait for events step for chaincode listener.

Signed-off-by: sapthasurendran <[email protected]>

Author: sapthasurendran

test/ts-scenario/features/base_api_v1.feature

@@ -38,7 +38,7 @@ Scenario: Using only fabric-common V1 channel
 	And I regisister a transaction listener named myFilteredTransactionListener with myFilteredEventService for all transactions as client leon
 	When I create an event service myFullEventService as client leon on channel baseapichannel
 	And I regisister a block listener named myFullBlockListener with myFullEventService for startBlock 1 and endBlock 4 as client leon
-	And I regisister a chaincode listener named myFullChaincodeListener with myFullEventService for createCar event on contract fabcar as client leon
+	And I regisister a chaincode listener named myFullChaincodeListener with myFullEventService with a maximum event count of 3 as client leon for createCar event on contract fabcar
 	And I regisister a transaction listener named myFullTransactionListener with myFullEventService for all transactions as client leon
 	And I start the event service myFilteredEventService as filtered blocks to start at block 0 and end at block 4 as client leon
 	And I start the event service myFullEventService as full blocks to start at block 0 and end at block END as client leon
@@ -48,5 +48,6 @@ Scenario: Using only fabric-common V1 channel
 	Then the event listener myFilteredChaincodeListener of myFilteredEventService has results matching {"createCar":""} as client leon
 	Then the event listener myFilteredTransactionListener of myFilteredEventService has results matching {"transaction":"3"} as client leon
 	Then the event listener myFullBlockListener of myFullEventService has results matching {"block":"4"} as client leon
+	Then I wait for events from chaincode listener named myFullChaincodeListener with myFullEventService as client leon
 	Then the event listener myFullChaincodeListener of myFullEventService has results matching {"createCar":"Focus"} as client leon
 	Then the event listener myFullTransactionListener of myFullEventService has results matching {"transaction":"4"} as client leon

test/ts-scenario/features/base_api_v2.feature

@@ -50,7 +50,7 @@ Scenario: Using only fabric-common on V2 channel
 	And I regisister a transaction listener named myFilteredTransactionListener with myFilteredEventService for all transactions as client fred
 	When I create an event service myFullEventService as client fred on channel basev2channel
 	And I regisister a block listener named myFullBlockListener with myFullEventService for startBlock 1 and endBlock 4 as client fred
-	And I regisister a chaincode listener named myFullChaincodeListener with myFullEventService for createCar event on contract fabcar as client fred
+	And I regisister a chaincode listener named myFullChaincodeListener with myFullEventService with a maximum event count of 3 as client fred for createCar event on contract fabcar
 	And I regisister a transaction listener named myFullTransactionListener with myFullEventService for all transactions as client fred
 	And I start the event service myFilteredEventService as filtered blocks to start at block 0 and end at block 6 as client fred
 	And I start the event service myFullEventService as full blocks to start at block 0 and end at block END as client fred
@@ -60,6 +60,7 @@ Scenario: Using only fabric-common on V2 channel
 	Then the event listener myFilteredChaincodeListener of myFilteredEventService has results matching {"createCar":""} as client fred
 	Then the event listener myFilteredTransactionListener of myFilteredEventService has results matching {"transaction":"5"} as client fred
 	Then the event listener myFullBlockListener of myFullEventService has results matching {"block":"4"} as client fred
+	Then I wait for events from chaincode listener named myFullChaincodeListener with myFullEventService as client fred
 	Then the event listener myFullChaincodeListener of myFullEventService has results matching {"createCar":"Focus"} as client fred
 	Then the event listener myFullTransactionListener of myFullEventService has results matching {"transaction":"7"} as client fred
 

test/ts-scenario/steps/base_api.ts

@@ -84,11 +84,21 @@ Then(/^I regisister a chaincode listener named (.+?) with (.+?) for (.+?) event
 		ClientHelper.registerEventListener(eventServiceName, clientName, listenerName, 'chaincode', '', '', eventName, contractName);
 	});
 
+Then(/^I regisister a chaincode listener named (.+?) with (.+?) with a maximum event count of ([0-9]+) as client (.+?) for (.+?) event on contract (.+?)$/, {timeout: Constants.INC_SHORT},
+	(listenerName: string, eventServiceName: string, eventCount:number, clientName: string, eventName: string, contractName: string,) => {
+		ClientHelper.registerEventListener(eventServiceName, clientName, listenerName, 'chaincode', '', '', eventName, contractName, eventCount);
+	});
+
 Then(/^I regisister a transaction listener named (.+?) with (.+?) for all transactions as client (.+?)$/, {timeout: Constants.INC_SHORT},
 	(listenerName: string, eventServiceName: string, clientName: string) => {
 		ClientHelper.registerEventListener(eventServiceName, clientName, listenerName, 'transaction', '', '', '', '');
 	});
 
+Then(/^I wait for events from chaincode listener named (.+?) with (.+?) as client (.+?)$/, {timeout: Constants.INC_SHORT},
+	async(listenerName: string, eventServiceName: string, clientName: string) => {
+		await ClientHelper.waitForEvent(eventServiceName, clientName, listenerName);
+	});
+
 Then(/^the event listener (.+?) of (.+?) has results matching (.+?) as client (.+?)$/, {timeout: Constants.INC_SHORT},
 	(listenerName: string, eventServiceName: string, check: string, clientName: string) => {
 		ClientHelper.checkEventListenerResults(eventServiceName, clientName, listenerName, check);

test/ts-scenario/steps/lib/utility/clientUtils.ts

@@ -70,6 +70,7 @@ interface ListenerState {
 		block?: string;
 		transaction?: string;
 	},
+	completePromise?: Promise<void>;
 }
 
 function assertNoErrors(endorsementResults: ProposalResponse): void {
@@ -710,7 +711,7 @@ export async function startEventService(
 			buildOptions.startBlock = Number.parseInt(startBlock, 10);
 		}
 		if (endBlock.localeCompare('END') === 0) {
-			// do not add start block
+			// do not add end block
 		} else {
 			buildOptions.endBlock = Number.parseInt(endBlock, 10);
 		}
@@ -762,7 +763,7 @@ export async function startEventService(
 export function registerEventListener(
 	eventServiceName: string, clientName: string, listenerName: string, type: string,
 	startBlock: string, endBlock: string,
-	chaincodeEventName: string, chaincodeName: string): void {
+	chaincodeEventName: string, chaincodeName: string, count?:number): void {
 
 	const clientObject = retrieveClientObject(clientName);
 	const eventServiceObject = clientObject.eventServices?.get(eventServiceName);
@@ -820,6 +821,10 @@ export function registerEventListener(
 			);
 		} else if (type === 'chaincode') {
 			BaseUtils.logMsg(`Registering a chaincode event with chaincodeName ${chaincodeName} chaincodeEventName ${chaincodeEventName}`);
+
+			let resolve: () => void;
+			const completePromise = new Promise<void>((_resolve) => resolve = _resolve);
+
 			listenerObject.eventListener = eventService.registerChaincodeListener(
 				chaincodeName,
 				chaincodeEventName,
@@ -837,15 +842,24 @@ export function registerEventListener(
 
 					if (event?.chaincodeEvents) {
 						for (const chaincodeEvent of event.chaincodeEvents) {
+							if (count !== undefined) {
+								count--;
+							}
 							const results: any = {};
 							results[chaincodeEvent.eventName] = chaincodeEvent.payload ? chaincodeEvent.payload.toString() : '';
 							listenerObject.results = results;
 							BaseUtils.logMsg(`Store chaincode event listener ${listenerName} results of ${JSON.stringify(results)}`);
+							if (count === 0) {
+								resolve();
+							}
 						}
 					}
 				},
 				listenerOptions
 			);
+
+			listenerObject.completePromise = completePromise;
+
 		} else if (type === 'transaction') {
 			BaseUtils.logMsg('Registering a transaction event for all transactions');
 
@@ -905,6 +919,23 @@ export function checkEventListenerResults(
 	}
 }
 
+export async function waitForEvent(
+	eventServiceName: string, clientName: string, listenerName: string): Promise<void> {
+	const clientObject: any = retrieveClientObject(clientName);
+	const eventServiceObject: any = clientObject.eventServices.get(eventServiceName);
+	const listenerObject: any = eventServiceObject.eventListeners.get(listenerName);
+
+	if (listenerObject) {
+		if (listenerObject.error) {
+			BaseUtils.logMsg(`Received an error for ${listenerName} of ${util.inspect(listenerObject.error)}`);
+			throw listenerObject.error;
+		}
+		await listenerObject.completePromise;
+	} else {
+		BaseUtils.logAndThrow(`Listener object not found ${listenerName}`);
+	}
+}
+
 export function disconnectEventService(
 	eventServiceName: string, clientName: string): void {
 	const clientObject: any = retrieveClientObject(clientName);