Merge pull request #837 from Speech-Rule-Engine/tests/work_tests

Tests/work tests

Author: zorkow

testsuite/expected/base/api_test.json

@@ -400,7 +400,7 @@
     },
     "SpeechStructure_1": {
       "type": "toSpeechStructure",
-      "input": "<math xmlns=\"http://www.w3.org/1998/Math/MathML\" display=\"block\"><msup data-semantic-type=\"superscript\" data-semantic-role=\"latinletter\" data-semantic-annotation=\"depth:1\" data-semantic-id=\"2\" data-semantic-children=\"0,1\"><mi data-semantic-type=\"identifier\" data-semantic-role=\"latinletter\" data-semantic-font=\"italic\" data-semantic-annotation=\"clearspeak:simple;nemeth:number;depth:2\" data-semantic-id=\"0\" data-semantic-parent=\"2\">x</mi><mn data-semantic-type=\"number\" data-semantic-role=\"integer\" data-semantic-font=\"normal\" data-semantic-annotation=\"clearspeak:simple;depth:2\" data-semantic-id=\"1\" data-semantic-parent=\"2\">2</mn></msup></math>",
+      "input": "square",
       "expected": "{\"0\":{\"speech-none\":\"x\",\"prefix-none\":\"Base\",\"postfix-none\":\"\",\"summary-none\":\"identifier\",\"speech-ssml\":\"<say-as interpret-as=\\\"character\\\">x</say-as>\",\"prefix-ssml\":\"Base\",\"postfix-ssml\":\"\",\"summary-ssml\":\"identifier\"},\"1\":{\"speech-none\":\"2\",\"prefix-none\":\"Exponent\",\"postfix-none\":\"\",\"summary-none\":\"number\",\"speech-ssml\":\"2\",\"prefix-ssml\":\"Exponent\",\"postfix-ssml\":\"\",\"summary-ssml\":\"number\"},\"2\":{\"speech-none\":\"x squared\",\"prefix-none\":\"\",\"postfix-none\":\"\",\"summary-none\":\"power\",\"speech-ssml\":\"<say-as interpret-as=\\\"character\\\">x</say-as> squared\",\"prefix-ssml\":\"\",\"postfix-ssml\":\"\",\"summary-ssml\":\"power\"}}",
       "json": true
     }

testsuite/expected/base/worker_test.json

@@ -29,6 +29,83 @@ import { Key } from './keycodes.js';
 import { AbstractJsonTest } from './abstract_test.js';
 import { jest, expect } from '@jest/globals';
 
+enum Expression {
+  Quadratic = 'quadratic',
+  Square = 'square',
+  Maction = 'maction',
+  Href = 'href'
+}
+
+const Samples: Record<Expression, string> = {
+  [Expression.Quadratic]:
+  '<math xmlns="http://www.w3.org/1998/Math/MathML" display="block">' +
+    '<mi>x</mi>' +
+    '<mo>=</mo>' +
+    '<mfrac>' +
+    '<mrow>' +
+    '<mo>&#x2212;<!-- − --></mo>' +
+    '<mi>b</mi>' +
+    '<mo>&#x00B1;<!-- ± --></mo>' +
+    '<msqrt>' +
+    '<msup>' +
+    '<mi>b</mi>' +
+    '<mn>2</mn>' +
+    '</msup>' +
+    '<mo>&#x2212;<!-- − --></mo>' +
+    '<mn>4</mn>' +
+    '<mi>a</mi>' +
+    '<mi>c</mi>' +
+    '</msqrt>' +
+    '</mrow>' +
+    '<mrow>' +
+    '<mn>2</mn>' +
+    '<mi>a</mi>' +
+    '</mrow>' +
+    '</mfrac>' +
+    '</math>',
+  [Expression.Square]:
+  '<math xmlns="http://www.w3.org/1998/Math/MathML" display="block">' +
+    '<msup>' +
+    '<mi>x</mi>' +
+    '<mn>2</mn>' +
+    '</msup>' +
+    '</math>',
+  [Expression.Maction]: 
+  '<math xmlns="http://www.w3.org/1998/Math/MathML" display="block">' +
+    '<maction actiontype="toggle" selection="2" data-collapsible="true" id="mjx-collapse-0">' +
+    '<mtext>&#x25C2;f()&#x25B8;</mtext>' +
+    '<mrow>' +
+    '<mi>f</mi>' +
+    '<mo>&#x2061;</mo>' +
+    '<maction actiontype="toggle" selection="2" data-collapsible="true" id="mjx-collapse-1">' +
+    '<mtext>&#x25C2;()&#x25B8;</mtext>' +
+    '<mrow>' +
+    '<mo stretchy="false">(</mo>' +
+    '<mrow>' +
+    '<mi>a</mi>' +
+    '<mo>+</mo>' +
+    '<mi>b</mi>' +
+    '<mo>+</mo>' +
+    '<mi>c</mi>' +
+    '<mo>+</mo>' +
+    '<mi>d</mi>' +
+    '</mrow>' +
+    '<mo stretchy="false">)</mo>' +
+    '</mrow>' +
+    '</maction>' +
+    '</mrow>' +
+    '</maction>' +
+    '</math>',
+  [Expression.Href]:
+  '<math xmlns="http://www.w3.org/1998/Math/MathML" display="block">' +
+    '<mrow href="c">' +
+    '<mi href="a">a</mi>' +
+    '<mo>+</mo>' +
+    '<mi href="b">b</mi>' +
+    '</mrow>' +
+    '</math>'
+}
+
 export class ApiTest extends AbstractJsonTest {
   /**
    * Feature vector for setting up the engine.
@@ -40,12 +117,6 @@ export class ApiTest extends AbstractJsonTest {
     speech: EngineConst.Speech.NONE
   };
 
-  /**
-   * The quadratic equation as a MathML string. By default tests are run against
-   * the quadratic equation unless a different input is provided.
-   */
-  public static QUADRATIC: string;
-
   /**
    * @override
    */
@@ -66,6 +137,19 @@ export class ApiTest extends AbstractJsonTest {
     });
   }
 
+  /**
+   * The sample equations.
+   */
+  protected static SAMPLES: Record<Expression, string> = Samples;
+
+  /*
+   * Quadratic equation as a MathML string. By default tests are run against
+   * the quadratic equation unless a different input is provided.
+   */
+  protected getSample(expr: Expression) {
+    return ApiTest.SAMPLES[expr] || ApiTest.SAMPLES[Expression.Quadratic];
+  }
+
   /**
    * Executes single API tests.
    *
@@ -78,14 +162,14 @@ export class ApiTest extends AbstractJsonTest {
    */
   public executeTest(
     func: string,
-    expr: any,
+    input: any,
     result: string | null,
     feature: { [key: string]: string },
     json: boolean,
     move: boolean
   ) {
     System.setupEngine(feature || ApiTest.SETUP);
-    expr = move ? Key.get(expr) : expr || ApiTest.QUADRATIC;
+    const expr = move ? Key.get(input) : this.getSample(input);
     let output = (System as any)[func](expr);
     output = output
       ? json
@@ -98,8 +182,8 @@ export class ApiTest extends AbstractJsonTest {
   /**
    * @override
    */
-  public method() {
-    this.executeTest(
+  public async method() {
+    await this.executeTest(
       this.field('type'),
       this.field('input'),
       this.field('expected'),
@@ -110,32 +194,53 @@ export class ApiTest extends AbstractJsonTest {
   }
 }
 
-ApiTest.QUADRATIC =
-  '<math xmlns="http://www.w3.org/1998/Math/MathML" display="block">' +
-  '<mi>x</mi>' +
-  '<mo>=</mo>' +
-  '<mfrac>' +
-  '<mrow>' +
-  '<mo>&#x2212;<!-- − --></mo>' +
-  '<mi>b</mi>' +
-  '<mo>&#x00B1;<!-- ± --></mo>' +
-  '<msqrt>' +
-  '<msup>' +
-  '<mi>b</mi>' +
-  '<mn>2</mn>' +
-  '</msup>' +
-  '<mo>&#x2212;<!-- − --></mo>' +
-  '<mn>4</mn>' +
-  '<mi>a</mi>' +
-  '<mi>c</mi>' +
-  '</msqrt>' +
-  '</mrow>' +
-  '<mrow>' +
-  '<mn>2</mn>' +
-  '<mi>a</mi>' +
-  '</mrow>' +
-  '</mfrac>' +
-  '</math>';
+import { semanticMathmlSync } from '#js/enrich_mathml/enrich.js';
+
+export class WorkerTest extends ApiTest {
+
+  /**
+   * Executes single API tests.
+   *
+   * @param func The API function to test.
+   * @param expr The input expression.
+   * @param result The expected result.
+   * @param feature Feature vector for engine setup.
+   * @param json Json output expected?
+   * @param move Is this a move with some keyboard input?
+   */
+  public async executeTest(
+    func: string,
+    input: Expression,
+    result: string | null,
+    feature: { [key: string]: string },
+    json: boolean,
+    _move: boolean
+  ) {
+    const sample = this.getSample(input);
+    const options = Object.assign({}, feature, ApiTest.SETUP);
+    await System.setupEngine(options);
+    const sxml = semanticMathmlSync(sample, options as any);
+    let promise = (System as any)[func](sxml.toString(), options);
+    promise.catch((err: Error) => console.log(`THIS PROMISE ERROR: ${err}`));
+    let output = await promise;
+    output = output
+      ? json
+        ? JSON.stringify(output)
+        : output.toString()
+      : output;
+    this.assert.equal(output, result);
+  }
+
+  /**
+   * @override
+   */
+  public async setUpTest() {
+    ApiTest.SETUP['locale'] = 'en';
+    ApiTest.SETUP['braille'] = 'nemeth';
+    return super.setUpTest();
+  }
+
+}
 
 
 export class DebugTest extends ApiTest {
@@ -145,16 +250,18 @@ export class DebugTest extends ApiTest {
    */
   public information = 'Debugger test.';
 
-
+  private oldDebug: boolean | string = null;
+  
   constructor() {
     super();
     this.pickFields.push('strings');
   }
-  
+
   /**
    * @override
    */
   public async setUpTest() {
+    this.oldDebug = ApiTest.SETUP['debug'] ?? null;
     ApiTest.SETUP['debug'] = true;
     jest.clearAllMocks();
     return super.setUpTest();
@@ -164,7 +271,11 @@ export class DebugTest extends ApiTest {
    * @override
    */
   public async tearDownTest(): Promise<string> {
-    ApiTest.SETUP['debug'] = false;
+    if (this.oldDebug === null) {
+      delete ApiTest.SETUP['debug'];
+    } else {
+      ApiTest.SETUP['debug'] = this.oldDebug;
+    }
     jest.clearAllMocks();
     return super.tearDownTest();
   }
@@ -174,21 +285,21 @@ export class DebugTest extends ApiTest {
    */
   public async executeTest(
     func: string,
-    expr: any,
+    input: string,
     result: string,
     feature: { [key: string]: string },
     _json: boolean,
-    move: boolean
+    _move: boolean
   ) {
     await System.setupEngine(feature || ApiTest.SETUP);
-    expr = move ? Key.get(expr) : expr || ApiTest.QUADRATIC;
     console.info = jest.fn();
-    await (System as any)[func](expr);
+    await (System as any)[func](input);
     expect(console.info).toHaveBeenCalledTimes(parseInt(result, 10));
     const strings = Object.entries(this.field('strings') as null | { [key: string]: string[]});
     for (let [index, res] of strings) {
-      expect(console.info).toHaveBeenNthCalledWith(parseInt(index, 10), "Speech Rule Engine Debugger:", ...res);
+      expect(console.info).
+        toHaveBeenNthCalledWith(parseInt(index, 10), "Speech Rule Engine Debugger:", ...res);
     }
-  }  
+  }
 
 }

testsuite/ts/classes/api_test.ts

@@ -22,7 +22,7 @@
 import { TestError, TestPath, TestUtil } from '../base/test_util.js';
 import { AbstractJsonTest } from './abstract_test.js';
 
-import { ApiTest, DebugTest } from './api_test.js';
+import * as api from './api_test.js';
 import * as cs from './clearspeak_annotation_test.js';
 import { BrailleLayoutTest, ClearspeakTest, SpeechMarkupTest } from './clearspeak_test.js';
 import { CollapseTest } from './collapse_test.js';
@@ -39,9 +39,9 @@ import { SymbolTest } from './symbol_test.js';
 import { ExplorationTest, WalkerTest, SemanticSkeletonTest } from './walker_test.js';
 
 const map = new Map<string, any>([
-  ['api', ApiTest],
+  ['api', api.ApiTest],
   ['braille2D', BrailleLayoutTest],
-  ['debug', DebugTest],
+  ['debug', api.DebugTest],
   ['deepSpeech', st.DeepSpeechTest],
   ['category', st.CategoryTest],
   ['clearspeak', ClearspeakTest],
@@ -75,6 +75,7 @@ const map = new Map<string, any>([
   ['summarySpeech', SummarySpeechTest],
   ['symbol', SymbolTest],
   ['walker', WalkerTest],
+  ['worker', api.WorkerTest],
   ['xpath', XpathTest]
 ]);
 

testsuite/ts/classes/test_factory.ts

@@ -28,9 +28,9 @@ export function runJsonTest(file: string) {
       if (!testcase.test) {
         continue;
       }
-      test(testcase.name, () => {
+      test(testcase.name, async () => {
         AnalyticsTest.currentTestcase = testcase.name;
-        testcases.method.bind(testcases).apply(null, testcases.pick(testcase));
+        await testcases.method.bind(testcases).apply(null, testcases.pick(testcase));
       });
     }
   });

testsuite/ts/jest.ts

@@ -64,7 +64,7 @@ export function parseInput(input: string): Element {
   const allValues = clean_input.match(/&(?!lt|gt|amp|quot|apos)\w+;/g);
   const html = !!allValues;
   if (!clean_input) {
-    throw new Error('Empty input!');
+    throw new SREError('Empty input!');
   }
   try {
     const doc = dp.parseFromString(

ts/common/dom_util.ts

@@ -76,8 +76,11 @@ export function process<T>(name: string, expr: string): T {
   const processor = get(name);
   try {
     return processor.processor(expr) as T;
-  } catch (_e) {
-    throw new SREError('Processing error for expression ' + expr);
+  } catch (error) {
+    if (error instanceof SREError) {
+      throw error;
+    }
+    throw new SREError(`Processing error for expression\n ${expr}`);
   }
 }
 
@@ -110,8 +113,11 @@ export function output(name: string, expr: string): string {
     return Engine.getInstance().options.pprint
       ? processor.pprint(data)
       : processor.print(data);
-  } catch (_e) {
-    throw new SREError('Processing error for expression ' + expr);
+  } catch (error) {
+    if (error instanceof SREError) {
+      throw error;
+    }
+    throw new SREError(`Processing error for expression\n ${expr}`);
   }
 }
 
@@ -527,6 +533,9 @@ export function assembleSpeechStructure(
 ) {
   json.options = options;
   json.mactions = SpeechGeneratorUtil.connectMactionSelections(mml, sxml);
+  if ((options as any).enableSpeech === false) {
+    return;
+  }
   json.speech = SpeechGeneratorUtil.computeSpeechStructure(sxml);
   const root = (sxml.childNodes[0] as Element)?.getAttribute('id');
   // Here we have to add the postfix correctly and then ensure that it is also

ts/common/processor_factory.ts

@@ -535,7 +535,7 @@ async function assembleWorkerStructure(
   Engine.getInstance().options.automark = true;
   const json: WorkerStructure = {};
   ProcessorFactory.assembleSpeechStructure(json, mml, sxml, options);
-  if (options.braille === 'none') {
+  if ((options as any).enableBraille === false) {
     return json;
   }
   await setupEngine({