Improve Action interface + add testee param to act

Author: tolauwae

src/framework/Testee.ts

@@ -39,10 +39,6 @@ export function getValue(object: any, field: string): any {
     return object;
 }
 
-function act<T>(action: Action<T>): Promise<T> {
-    return action();
-}
-
 export class Testee { // TODO unified with testbed interface
 
     /** The current state for each described test */
@@ -153,7 +149,7 @@ export class Testee { // TODO unified with testbed interface
                         let actual: Object | void;
                         if (step.instruction.kind === Kind.Action) {
                             actual = await timeout<Object | void>(`performing action . ${step.title}`, testee.timeout,
-                                act(step.instruction.value));
+                                step.instruction.value.act(testee));
                         } else {
                             actual = await timeout<Object | void>(`sending instruction ${step.instruction.value.type}`, testee.timeout,
                                 testee.testbed.sendRequest(map, step.instruction.value));

src/framework/scenario/Actions.ts

@@ -1,7 +1,40 @@
 import {setTimeout} from 'timers/promises';
+import {Testee} from '../Testee';
+import {TestbedEvents} from '../../testbeds/Testbed';
+import {Breakpoint} from '../../debug/Breakpoint';
+import {breakpointHitParser} from '../../messaging/Parsers';
 
-export type Action<T> = () => Promise<T>;
+export interface Action<T> {
+    act: (testee: Testee) => Promise<T>;
+}
+
+export interface PureAction<T> extends Action<T> {
+    act: () => Promise<T>;
+}
+
+export function wait(time: number): PureAction<boolean> {
+    return {act: () => setTimeout(time).then(() => true)}
+}
+
+export function awaitBreakpoint(): Action<Breakpoint> {
+    return {
+        act: (testee: Testee) => {
+            return new Promise<Breakpoint>((resolve) => {
+                function breakpointListener(message: string) {
+                    // check breakpoint hit message
+                    try {
+                        const breakpoint = breakpointHitParser(message);
+                        // on success: remove listener + resolve
+                        testee.testbed?.removeListener(TestbedEvents.OnMessage, breakpointListener);
+                        resolve(breakpoint);
+                    } catch (e) {
+
+                    }
+                }
 
-export function wait(time: number): Action<boolean> {
-    return () => setTimeout(time).then(() => true)
+                // await breakpoint hit
+                testee.testbed?.on(TestbedEvents.OnMessage, breakpointListener)
+            });
+        }
+    };
 }

src/framework/scenario/Invoker.ts

@@ -8,9 +8,9 @@ export class Invoker implements Step {
     readonly instruction: Instruction;
     readonly expected?: Expectation[];
 
-    constructor(func: string, args: Value[], result: number) {
-        this.title = `ASSERT: ${func} ${args.map(val => val.value).join(' ')} ${result}`;
+    constructor(func: string, args: Value[], result: Value) {
+        this.title = `ASSERT: ${func} ${args.map(val => val.value).join(' ')} ${result.value}`;
         this.instruction = {kind: Kind.Request, value: Message.invoke(func, args)}
-        this.expected = [{'value': {kind: 'primitive', value: result} as Expected<number>}];
+        this.expected = [{'value': {kind: 'primitive', value: result.value} as Expected<number>}];
     }
 }

src/messaging/Parsers.ts

@@ -43,7 +43,7 @@ export function breakpointParser(text: string): Breakpoint {
     throw new Error('Could not messaging BREAKPOINT address in ack.');
 }
 
-function breakpointHitParser(text: string): Breakpoint {
+export function breakpointHitParser(text: string): Breakpoint {
     const ack: Ack = ackParser(text, 'AT ');
 
     let breakpointInfo = ack.text.match(/AT (0x.*)!/);

src/sourcemap/Wasm.ts

@@ -19,6 +19,10 @@ export namespace WASM {
         value: number;
     }
 
+    export function i32(n: number): WASM.Value {
+        return {value: n, type: Type.i32};
+    }
+
     export interface Frame {
         type: number;
         fidx: string;

src/testbeds/Platform.ts

@@ -1,4 +1,4 @@
-import {Testbed, TesteeEvents} from './Testbed';
+import {Testbed, TestbedEvents} from './Testbed';
 import {EventEmitter} from 'events';
 import {Request} from '../messaging/Message';
 import {MessageQueue} from '../messaging/MessageQueue';
@@ -49,7 +49,7 @@ export abstract class Platform extends EventEmitter implements Testbed {
                 // messaging and resolve
                 const [candidate, resolver] = this.requests[index];
                 resolver(candidate.parser(message));
-                this.emit(TesteeEvents.OnMessage, message);
+                this.emit(TestbedEvents.OnMessage, message);
 
                 this.requests.splice(index, 1);  // delete resolved request
             }

src/testbeds/Testbed.ts

@@ -3,7 +3,7 @@ import {EventEmitter} from 'events';
 import {Connection} from '../bridge/Connection';
 import {SourceMap} from '../sourcemap/SourceMap';
 
-export enum TesteeEvents {
+export enum TestbedEvents {
     OnMessage = 'message',
     OnPushEvent = 'push'
 }
@@ -17,7 +17,7 @@ export declare interface Testbed extends EventEmitter {
 
     kill(): Promise<void>;
 
-    on(event: TesteeEvents.OnMessage, listener: (message: string) => void): this;
+    on(event: TestbedEvents.OnMessage, listener: (message: string) => void): this;
 
-    on(event: TesteeEvents.OnPushEvent, listener: (data: string) => void): this;
+    on(event: TestbedEvents.OnPushEvent, listener: (data: string) => void): this;
 }

test/test.ts

@@ -11,10 +11,10 @@ framework.testee('emulator [:8500]', new EmulatorSpecification(8500));
 const steps: Step[] = [];
 
 // ✔ ((invoke "8u_good1" (i32.const 0)) (i32.const 97))
-steps.push(new Invoker('8u_good1', [{value: 0, type: WASM.Type.i32}] as WASM.Value[], 97));
+steps.push(new Invoker('8u_good1', [{value: 0, type: WASM.Type.i32}] as WASM.Value[], WASM.i32(97)));
 
 // ✔ ((invoke "8u_good3" (i32.const 0)) (i32.const 98))
-steps.push(new Invoker('8u_good3', [{value: 0, type: WASM.Type.i32}] as WASM.Value[], 98));
+steps.push(new Invoker('8u_good3', [{value: 0, type: WASM.Type.i32}] as WASM.Value[], WASM.i32(98)));
 
 framework.test({
     title: `Test with address_0.wast`,