Fix recovery of crashed testbed (#6)

tolauwae · web-flow · commit f2d694ce8cc4 · 2024-01-22T09:29:26.000+01:00
* Use esm with mocha

* Test module upload

* Shutdown testbeds after test

* Fix testbed restart
diff --git a/bin/latch.cjs b/bin/latch.cjs
@@ -8,10 +8,9 @@
  * @module bin/latch
  * @private
  */
-
 const {spawn} = require('child_process');
 
-const args = ['--exit', '--color', '--reporter', `${require('path').dirname(__dirname)}/dist/cjs/framework/MochaReporter.cjs`, '--require', 'ts-node/register', '--ui', 'bdd', ].concat(process.argv.slice(2));
+const args = ['--exit', '--color', '--reporter', `${require('path').dirname(__dirname)}/dist/cjs/framework/MochaReporter.cjs`, '--loader=ts-node/esm', '--experimental-specifier-resolution=node', '--require', 'ts-node/register', '--ui', 'bdd' ].concat(process.argv.slice(2));
 const proc = spawn('mocha', args, {
     stdio: 'inherit'
 });
@@ -45,4 +44,4 @@ process.on('SIGINT', () => {
             proc.kill('SIGTERM');
         }
     }
-});
+});
diff --git a/mocharc.json b/mocharc.json
@@ -0,0 +1,6 @@
+{
+    "node-option": [
+        "experimental-specifier-resolution=node",
+        "loader=ts-node/esm"
+    ]
+}
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "latch",
   "description": "A testing language for constraint environments",
   "version": "0.0.1",
-  "type": "commonjs",
+  "type": "module",
   "exports": {
     "types": "./dist/types/index.d.ts",
     "require": "./dist/cjs/index.cjs"
@@ -14,7 +14,7 @@
     "bin"
   ],
   "bin": {
-    "latch": "bin/latch"
+    "latch": "bin/latch.cjs"
   },
   "scripts": {
     "clean": "rm -rf dist",
diff --git a/src/framework/Framework.ts b/src/framework/Framework.ts
@@ -70,7 +70,7 @@ export class Framework {
                     await testee.initialize(first.program, first.args ?? []);
                 });
 
-                describe(`Testing on ${testee.name}.`, () => {
+                describe(`${testee.name}: ${suite.title}`, () => {
                     // todo add parallelism
 
                     // if (!bed.disabled) { // TODO necessary? isn't this done in de test itself?
@@ -86,6 +86,10 @@ export class Framework {
                         testee.describe(test, this.runs);
                     });
                 });
+
+                after('Shutdown testbed', async function () {
+                    await testee.shutdown();
+                });
             });
         });
     }
diff --git a/src/framework/Testee.ts b/src/framework/Testee.ts
@@ -13,7 +13,7 @@ import {TestScenario} from './scenario/TestScenario';
 import {TestbedSpecification} from '../testbeds/TestbedSpecification';
 import {Scheduler} from './Scheduler';
 import {CompileOutput, CompilerFactory} from '../manage/Compiler';
-import {WABT} from '../util/deps';
+import {WABT} from '../util/env';
 
 function timeout<T>(label: string, time: number, promise: Promise<T>): Promise<T> {
     return Promise.race([promise, new Promise<T>((resolve, reject) => setTimeout(() => reject(`timeout when ${label}`), time))]);
@@ -86,6 +86,10 @@ export class Testee { // TODO unified with testbed interface
         });
     }
 
+    public async shutdown(): Promise<void> {
+        return this.testbed?.kill();
+    }
+
     public describe(description: TestScenario, runs: number = 1) {
         const testee = this;
         const call: SuiteFunction | PendingSuiteFunction = description.skip ? describe.skip : this.suiteFunction;
@@ -107,7 +111,7 @@ export class Testee { // TODO unified with testbed interface
                 this.timeout(testee.connector.timeout(testee.specification.type));
                 let compiled: CompileOutput = await new CompilerFactory(WABT).pickCompiler(description.program).compile(description.program);
                 try {
-                    await testee.testbed!.sendRequest(new SourceMap.Mapping(), Message.updateModule(compiled.file));
+                     await timeout<Object | void>(`uploading module`, testee.timeout, testee.testbed!.sendRequest(new SourceMap.Mapping(), Message.updateModule(compiled.file)));
                 } catch (e) {
                     await testee.initialize(description.program, description.args ?? []);
                 }
diff --git a/src/index.ts b/src/index.ts
@@ -2,7 +2,7 @@ import {Framework} from './framework/Framework';
 
 export * from './manage/Compiler';
 export * from './manage/Uploader';
-export * from './util/deps';
+export * from './util/env';
 export * from './framework/scenario/Actions';
 export * from './framework/Testee';
 export * from './framework/Framework';
diff --git a/src/messaging/Message.ts b/src/messaging/Message.ts
@@ -9,6 +9,8 @@ import Interrupt = WARDuino.Interrupt;
 import State = WARDuino.State;
 import Value = WASM.Value;
 import Type = WASM.Type;
+import {CompileOutput, CompilerFactory} from '../manage/Compiler';
+import {WABT} from '../util/env';
 
 // An acknowledgement returned by the debugger
 export interface Ack {
@@ -125,9 +127,14 @@ export namespace Message {
         }
     }
 
-    export function updateModule(program: string): Request<Ack> {
-        function payload(wasm: Buffer): string {
-            const w = new Uint8Array(wasm);
+    export async function uploadFile(program: string): Promise<Request<Ack>> {
+        let compiled: CompileOutput = await new CompilerFactory(WABT).pickCompiler(program).compile(program);
+        return updateModule(compiled.file);
+    }
+
+    export function updateModule(wasm: string): Request<Ack> {
+        function payload(binary: Buffer): string {
+            const w = new Uint8Array(binary);
             const sizeHex: string = WASM.leb128(w.length);
             const sizeBuffer = Buffer.allocUnsafe(4);
             sizeBuffer.writeUint32BE(w.length);
@@ -137,7 +144,7 @@ export namespace Message {
 
         return {
             type: Interrupt.updateModule,
-            payload: (map: SourceMap.Mapping) => payload(readFileSync(program)),
+            payload: (map: SourceMap.Mapping) => payload(readFileSync(wasm)),
             parser: (line: string) => {
                 return ackParser(line, 'CHANGE Module');
             }
diff --git a/src/sourcemap/SourceMapFactory.ts b/src/sourcemap/SourceMapFactory.ts
@@ -1,7 +1,7 @@
 import {getFileExtension} from '../util/util';
 import {CompileOutput, CompilerFactory} from '../manage/Compiler';
 import {AsScriptMapper, WatMapper} from './SourceMapper';
-import {WABT} from '../util/deps';
+import {WABT} from '../util/env';
 import {SourceMap} from './SourceMap';
 import * as path from 'path';
 
diff --git a/src/testbeds/TestbedFactory.ts b/src/testbeds/TestbedFactory.ts
@@ -1,5 +1,5 @@
 import {Testbed} from './Testbed';
-import {ARDUINO, EMULATOR, WABT} from '../util/deps';
+import {ARDUINO, EMULATOR, WABT} from '../util/env';
 import {CompileOutput, CompilerFactory} from '../manage/Compiler';
 import {Emulator} from './Emulator';
 import {UploaderFactory} from '../manage/Uploader';
diff --git a/src/util/deps.ts b/src/util/deps.ts
diff --git a/src/util/env.ts b/src/util/env.ts
@@ -0,0 +1,7 @@
+import {homedir} from 'os';
+
+export const WABT: string = process.env.WABT ?? '/home/tom/Documents/TOPL/plugin/WABT/build/';
+
+export const EMULATOR: string = process.env.EMULATOR ?? `${homedir()}/Arduino/libraries/WARDuino/build-emu/wdcli`;
+
+export const ARDUINO: string = `${homedir()}/Arduino/libraries/WARDuino/platforms/Arduino/`;
diff --git a/test/module.ts b/test/module.ts
@@ -0,0 +1,31 @@
+// module regression test
+
+import {EmulatorSpecification, Framework, Kind, Message} from '../src';
+import {readdirSync} from 'fs';
+
+const folder: string = process.env.CORESUITE ?? '.';
+
+const framework = Framework.getImplementation();
+
+framework.suite('Test update module functionality');
+
+framework.testee('emulator [:8500]', new EmulatorSpecification(8500));
+
+const files: string[] = readdirSync(folder).filter((file) => file.endsWith('.asserts.wast'));
+
+for (const file of files) {
+    const module: string = file.replace('.asserts.wast', '.wast');
+
+    const request = await Message.uploadFile(folder + module);
+    framework.test({
+        title: `Test upload ${module}`,
+        program: 'test/address.wast',
+        dependencies: [],
+        steps: [{
+            title: `upload ${module}`,
+            instruction: {kind: Kind.Request, value: request}
+        }]
+    });
+}
+
+framework.run();
diff --git a/test/test.ts b/test/test.ts
@@ -1,4 +1,4 @@
-import {ArduinoSpecification, EmulatorSpecification, Expected, Framework, Invoker, Kind, Message, Step, WASM} from '../src';
+import {ArduinoSpecification, EmulatorSpecification, Expected, Framework, Invoker, Kind, Message, Step, WASM} from '../src/index';
 import dump = Message.dump;
 import stepOver = Message.stepOver;
 
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "compilerOptions": {
-    "module": "commonjs",
+    "module": "esnext",
+    "moduleResolution": "node",
     "target": "ES2020",
     "outDir": "out",
     "lib": [
