@luma.gl/test-utils 9.0.0-alpha.21 → 9.0.0-alpha.23

package/dist/test-runner.js

@@ -1,23 +1,26 @@
 import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
-import { AnimationLoop } from '@luma.gl/webgl-legacy';
 import { webglDevice } from "./create-test-device.js";
-function noop() {}
+import { ClassicAnimationLoop as AnimationLoop } from "./engine/classic-animation-loop.js";
 const DEFAULT_TEST_CASE = {
   name: 'Unnamed test',
-  onInitialize: noop,
+  onInitialize: async () => {},
   onRender: _ref => {
     let {
       done
     } = _ref;
     return done();
   },
-  onFinalize: noop
+  onFinalize: () => {}
 };
 const DEFAULT_TEST_PROPS = {
+  width: undefined,
+  height: undefined,
   onTestStart: testCase => console.log("# ".concat(testCase.name)),
-  onTestPass: testCase => console.log("ok ".concat(testCase.name, " passed")),
-  onTestFail: testCase => console.log("not ok ".concat(testCase.name, " failed")),
-  timeout: 2000
+  onTestPass: (testCase, result) => console.log("ok ".concat(testCase.name, " passed")),
+  onTestFail: (testCase, error) => console.log("not ok ".concat(testCase.name, " failed")),
+  timeout: 2000,
+  maxFramesToRender: undefined,
+  imageDiffOptions: undefined
 };
 export class TestRunner {
   constructor() {
@@ -28,10 +31,14 @@ export class TestRunner {
     _defineProperty(this, "testOptions", {
       ...DEFAULT_TEST_PROPS
     });
-    _defineProperty(this, "_animationProps", {});
+    _defineProperty(this, "_animationProps", void 0);
     _defineProperty(this, "_animationLoop", void 0);
     _defineProperty(this, "_testCases", []);
     _defineProperty(this, "_testCaseData", null);
+    _defineProperty(this, "_currentTestCase", void 0);
+    _defineProperty(this, "_currentTestCaseStartTime", void 0);
+    _defineProperty(this, "_currentTestCaseStartTick", void 0);
+    _defineProperty(this, "isDiffing", false);
     _defineProperty(this, "isHeadless", Boolean(window.browserTestDriver_isHeadless));
     this.props = props;
   }
@@ -134,7 +141,7 @@ export class TestRunner {
       for (const key in this._testCaseData) {
         const value = this._testCaseData[key];
         if (value && value.delete) {
-          value.delete();
+          value.destroy();
         }
       }
       this._currentTestCase.onFinalize(Object.assign({}, animationProps, this._testCaseData));

package/dist/test-runner.js.map

@@ -1 +1 @@
-{"version":3,"file":"test-runner.js","names":["AnimationLoop","webglDevice","noop","DEFAULT_TEST_CASE","name","onInitialize","onRender","_ref","done","onFinalize","DEFAULT_TEST_PROPS","onTestStart","testCase","console","log","concat","onTestPass","onTestFail","timeout","TestRunner","constructor","props","arguments","length","undefined","_defineProperty","Boolean","window","browserTestDriver_isHeadless","add","testCases","Array","isArray","_testCases","push","run","options","testOptions","Promise","resolve","reject","_animationLoop","device","_onRender","bind","isRunning","start","isDiffing","_currentTestCase","catch","error","_fail","message","initTestCase","animationLoop","key","shouldRender","animationProps","assert","_pass","_next","result","_nextTestCase","_animationProps","stop","isDone","testCaseAnimationProps","_testCaseData","startTime","_currentTestCaseStartTime","time","tick","_currentTestCaseStartTick","value","delete","Object","assign","popState","shift","pushState","initProps","then","userData"],"sources":["../src/test-runner.ts"],"sourcesContent":["// @ts-nocheck TODO remove\n/* eslint-disable no-console */\nimport {AnimationLoop, AnimationProps} from '@luma.gl/webgl-legacy';\nimport {webglDevice} from './create-test-device';\n\n/** Describes a test case */\nexport type TestRunnerTestCase = {\n  /** Name of the test case (for logging) */\n  name: string;\n  /** Initialize the test case. Can return a promise */\n  onInitialize: (props: AnimationProps) => Promise<unknown>;\n  /** Perform rendering */\n  onRender: (props: AnimationProps & {done}) => void;\n  /** Clean up after the test case */\n  onFinalize: (props: AnimationProps) => void;\n};\n\nfunction noop() {}\n\nconst DEFAULT_TEST_CASE: TestRunnerTestCase = {\n  name: 'Unnamed test',\n  onInitialize: noop,\n  onRender: ({done}) => done(),\n  onFinalize: noop\n};\n\n/** Options for a TestRunner */\nexport type TestRunnerProps = {\n  width?: number;\n  height?: number;\n  // test lifecycle callback\n  onTestStart?: (testCase: TestRunnerTestCase) => void;\n  onTestPass?: (testCase: TestRunnerTestCase) => void;\n  onTestFail?: (testCase: TestRunnerTestCase) => void;\n  /** milliseconds to wait for each test case before aborting */\n  timeout?: number;\n  maxFramesToRender?: number;\n  // HACK - this is for the snapshot test runner\n  imageDiffOptions?: any;\n};\n\nconst DEFAULT_TEST_PROPS: Required<TestRunnerProps> = {\n  // test lifecycle callback\n  onTestStart: (testCase: TestRunnerTestCase) => console.log(`# ${testCase.name}`),\n  onTestPass: (testCase: TestRunnerTestCase) => console.log(`ok ${testCase.name} passed`),\n  onTestFail: (testCase: TestRunnerTestCase) => console.log(`not ok ${testCase.name} failed`),\n\n  // milliseconds to wait for each test case before aborting\n  timeout: 2000\n};\n\n/** Runs an array of test cases */\nexport class TestRunner {\n  device = webglDevice;\n  props: Record<string, any>;\n  isRunning: boolean = false;\n  readonly testOptions: Required<TestRunnerProps> = {...DEFAULT_TEST_PROPS};\n  readonly _animationProps?: AnimationProps = {};\n  private _animationLoop: AnimationLoop | null;\n  private _testCases: TestRunnerTestCase[] = [];\n  private _testCaseData: any = null;\n\n  // @ts-expect-error\n  isHeadless: boolean = Boolean(window.browserTestDriver_isHeadless);\n\n  /**\n   * props\n   *   AnimationLoop props\n   */\n  constructor(props: Record<string, any> = {}) {\n    this.props = props;\n  }\n\n  /**\n   * Add testCase(s)\n   */\n  add(testCases: TestRunnerTestCase[]): this {\n    if (!Array.isArray(testCases)) {\n      testCases = [testCases];\n    }\n    for (const testCase of testCases) {\n      this._testCases.push(testCase);\n    }\n    return this;\n  }\n\n  /**\n    * Returns a promise that resolves when all the test cases are done\n    */\n  run(options: object = {}): Promise<void>  {\n    this.testOptions = {...this.testOptions, ...options};\n\n    return new Promise<void>((resolve, reject) => {\n      this._animationLoop = new AnimationLoop({\n        // @ts-expect-error TODO\n        ...this.props,\n        device: this.device,\n        onRender: this._onRender.bind(this),\n        onFinalize: () => {\n          this.isRunning = false;\n          resolve();\n        }\n      });\n      this._animationLoop.start(this.props);\n\n      this.isRunning = true;\n      this.isDiffing = false;\n      this._currentTestCase = null;\n    }).catch (error => {\n      this._fail({error: error.message});\n      // reject(error);\n    });\n  }\n\n  /* Lifecycle methods for subclassing */\n\n  initTestCase(testCase: TestRunnerTestCase) {\n    const {animationLoop} = testCase;\n    if (animationLoop) {\n      testCase.onInitialize = animationLoop.props.onInitialize.bind(animationLoop);\n      testCase.onRender = animationLoop.props.onRender.bind(animationLoop);\n      testCase.onFinalize = animationLoop.props.onFinalize.bind(animationLoop);\n    }\n    for (const key in DEFAULT_TEST_CASE) {\n      testCase[key] = testCase[key] || DEFAULT_TEST_CASE[key];\n    }\n  }\n\n  shouldRender(animationProps): boolean {\n    return true;\n  }\n\n  assert(testCase: TestRunnerTestCase): void {\n    this._pass(testCase);\n    this._next();\n  }\n\n  /* Utilities */\n\n  _pass(result: unknown): void {\n    this.testOptions.onTestPass(this._currentTestCase, result);\n    // this._animationLoop?.stop();\n  }\n\n  _fail(result: unknown): void {\n    this.testOptions.onTestFail(this._currentTestCase, result);\n    // this._animationLoop?.stop();\n  }\n\n  _next(): void {\n    this._nextTestCase();\n  }\n\n  /* Private methods */\n\n  _onRender(animationProps): void {\n    this._animationProps = animationProps;\n\n    const testCase = this._currentTestCase || this._nextTestCase();\n    if (!testCase) {\n      // all test cases are done\n      this._animationLoop.stop();\n      return;\n    }\n\n    let isDone = false;\n    const testCaseAnimationProps: AnimationProps = {\n      ...animationProps, \n      ...this._testCaseData,\n      // tick/time starts from 0 for each test case\n      startTime: this._currentTestCaseStartTime,\n      time: animationProps.time - this._currentTestCaseStartTime,\n      tick: animationProps.tick - this._currentTestCaseStartTick,\n      // called by the test case when it is done rendering and ready for capture and diff\n      done: () => {\n        isDone = true;\n      }\n    };\n\n    if (this._testCaseData && this.shouldRender(testCaseAnimationProps)) {\n      // try {\n      // test case is initialized, render frame\n      testCase.onRender(testCaseAnimationProps);\n      // } catch {\n      //   isDone = true;\n      // }\n    }\n\n    const timeout = testCase.timeout || this.testOptions.timeout;\n    if (timeout && testCaseAnimationProps.time > timeout) {\n      isDone = true;\n    }\n\n    if (isDone) {\n      this.assert(testCase);\n    }\n  }\n\n  _nextTestCase(): Promise<TestRunnerTestCase> {\n    const animationProps = this._animationProps;\n\n    // finalize the current test case\n    if (this._testCaseData) {\n      for (const key in this._testCaseData) {\n        const value = this._testCaseData[key];\n        if (value && value.delete) {\n          value.delete();\n        }\n      }\n      this._currentTestCase.onFinalize(Object.assign({}, animationProps, this._testCaseData));\n\n      // reset WebGL context\n      this.device.popState();\n\n      this._currentTestCase = null;\n      this._testCaseData = null;\n    }\n\n    // get the next test case\n    const testCase = this._testCases.shift();\n    if (testCase) {\n      // start new test case\n      this._currentTestCase = testCase;\n      this._currentTestCaseStartTime = animationProps.time;\n      this._currentTestCaseStartTick = animationProps.tick;\n      this.initTestCase(testCase);\n\n      // initialize test case\n\n      // save WebGL context\n      this.device.pushState();\n\n      // aligned with the behavior of AnimationLoop.onInitialized\n      // onInitialized could return a plain object or a promise\n      const initProps = {\n        ...animationProps,\n        // tick/time starts from 0 for each test case\n        startTime: animationProps.time,\n        time: 0,\n        tick: 0\n      };\n\n      // aligned with the behavior of AnimationLoop.onInitialized\n      // onInitialized could return a plain object or a promise\n      Promise.resolve(testCase.onInitialize(initProps)).then((userData) => {\n        this._testCaseData = userData || {};\n      });\n\n      // invoke user callback\n      this.testOptions.onTestStart(testCase);\n    }\n    return testCase;\n  }\n}\n"],"mappings":";AAEA,SAAQA,aAAa,QAAuB,uBAAuB;AAAC,SAC5DC,WAAW;AAcnB,SAASC,IAAIA,CAAA,EAAG,CAAC;AAEjB,MAAMC,iBAAqC,GAAG;EAC5CC,IAAI,EAAE,cAAc;EACpBC,YAAY,EAAEH,IAAI;EAClBI,QAAQ,EAAEC,IAAA;IAAA,IAAC;MAACC;IAAI,CAAC,GAAAD,IAAA;IAAA,OAAKC,IAAI,EAAE;EAAA;EAC5BC,UAAU,EAAEP;AACd,CAAC;AAiBD,MAAMQ,kBAA6C,GAAG;EAEpDC,WAAW,EAAGC,QAA4B,IAAKC,OAAO,CAACC,GAAG,MAAAC,MAAA,CAAMH,QAAQ,CAACR,IAAI,EAAG;EAChFY,UAAU,EAAGJ,QAA4B,IAAKC,OAAO,CAACC,GAAG,OAAAC,MAAA,CAAOH,QAAQ,CAACR,IAAI,aAAU;EACvFa,UAAU,EAAGL,QAA4B,IAAKC,OAAO,CAACC,GAAG,WAAAC,MAAA,CAAWH,QAAQ,CAACR,IAAI,aAAU;EAG3Fc,OAAO,EAAE;AACX,CAAC;AAGD,OAAO,MAAMC,UAAU,CAAC;EAiBtBC,WAAWA,CAAA,EAAkC;IAAA,IAAjCC,KAA0B,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;IAAAG,eAAA,iBAhBlCxB,WAAW;IAAAwB,eAAA;IAAAA,eAAA,oBAEC,KAAK;IAAAA,eAAA,sBACwB;MAAC,GAAGf;IAAkB,CAAC;IAAAe,eAAA,0BAC7B,CAAC,CAAC;IAAAA,eAAA;IAAAA,eAAA,qBAEH,EAAE;IAAAA,eAAA,wBAChB,IAAI;IAAAA,eAAA,qBAGXC,OAAO,CAACC,MAAM,CAACC,4BAA4B,CAAC;IAOhE,IAAI,CAACP,KAAK,GAAGA,KAAK;EACpB;EAKAQ,GAAGA,CAACC,SAA+B,EAAQ;IACzC,IAAI,CAACC,KAAK,CAACC,OAAO,CAACF,SAAS,CAAC,EAAE;MAC7BA,SAAS,GAAG,CAACA,SAAS,CAAC;IACzB;IACA,KAAK,MAAMlB,QAAQ,IAAIkB,SAAS,EAAE;MAChC,IAAI,CAACG,UAAU,CAACC,IAAI,CAACtB,QAAQ,CAAC;IAChC;IACA,OAAO,IAAI;EACb;EAKAuB,GAAGA,CAAA,EAAuC;IAAA,IAAtCC,OAAe,GAAAd,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,CAAC,CAAC;IACtB,IAAI,CAACe,WAAW,GAAG;MAAC,GAAG,IAAI,CAACA,WAAW;MAAE,GAAGD;IAAO,CAAC;IAEpD,OAAO,IAAIE,OAAO,CAAO,CAACC,OAAO,EAAEC,MAAM,KAAK;MAC5C,IAAI,CAACC,cAAc,GAAG,IAAIzC,aAAa,CAAC;QAEtC,GAAG,IAAI,CAACqB,KAAK;QACbqB,MAAM,EAAE,IAAI,CAACA,MAAM;QACnBpC,QAAQ,EAAE,IAAI,CAACqC,SAAS,CAACC,IAAI,CAAC,IAAI,CAAC;QACnCnC,UAAU,EAAEA,CAAA,KAAM;UAChB,IAAI,CAACoC,SAAS,GAAG,KAAK;UACtBN,OAAO,EAAE;QACX;MACF,CAAC,CAAC;MACF,IAAI,CAACE,cAAc,CAACK,KAAK,CAAC,IAAI,CAACzB,KAAK,CAAC;MAErC,IAAI,CAACwB,SAAS,GAAG,IAAI;MACrB,IAAI,CAACE,SAAS,GAAG,KAAK;MACtB,IAAI,CAACC,gBAAgB,GAAG,IAAI;IAC9B,CAAC,CAAC,CAACC,KAAK,CAAEC,KAAK,IAAI;MACjB,IAAI,CAACC,KAAK,CAAC;QAACD,KAAK,EAAEA,KAAK,CAACE;MAAO,CAAC,CAAC;IAEpC,CAAC,CAAC;EACJ;EAIAC,YAAYA,CAACzC,QAA4B,EAAE;IACzC,MAAM;MAAC0C;IAAa,CAAC,GAAG1C,QAAQ;IAChC,IAAI0C,aAAa,EAAE;MACjB1C,QAAQ,CAACP,YAAY,GAAGiD,aAAa,CAACjC,KAAK,CAAChB,YAAY,CAACuC,IAAI,CAACU,aAAa,CAAC;MAC5E1C,QAAQ,CAACN,QAAQ,GAAGgD,aAAa,CAACjC,KAAK,CAACf,QAAQ,CAACsC,IAAI,CAACU,aAAa,CAAC;MACpE1C,QAAQ,CAACH,UAAU,GAAG6C,aAAa,CAACjC,KAAK,CAACZ,UAAU,CAACmC,IAAI,CAACU,aAAa,CAAC;IAC1E;IACA,KAAK,MAAMC,GAAG,IAAIpD,iBAAiB,EAAE;MACnCS,QAAQ,CAAC2C,GAAG,CAAC,GAAG3C,QAAQ,CAAC2C,GAAG,CAAC,IAAIpD,iBAAiB,CAACoD,GAAG,CAAC;IACzD;EACF;EAEAC,YAAYA,CAACC,cAAc,EAAW;IACpC,OAAO,IAAI;EACb;EAEAC,MAAMA,CAAC9C,QAA4B,EAAQ;IACzC,IAAI,CAAC+C,KAAK,CAAC/C,QAAQ,CAAC;IACpB,IAAI,CAACgD,KAAK,EAAE;EACd;EAIAD,KAAKA,CAACE,MAAe,EAAQ;IAC3B,IAAI,CAACxB,WAAW,CAACrB,UAAU,CAAC,IAAI,CAACgC,gBAAgB,EAAEa,MAAM,CAAC;EAE5D;EAEAV,KAAKA,CAACU,MAAe,EAAQ;IAC3B,IAAI,CAACxB,WAAW,CAACpB,UAAU,CAAC,IAAI,CAAC+B,gBAAgB,EAAEa,MAAM,CAAC;EAE5D;EAEAD,KAAKA,CAAA,EAAS;IACZ,IAAI,CAACE,aAAa,EAAE;EACtB;EAIAnB,SAASA,CAACc,cAAc,EAAQ;IAC9B,IAAI,CAACM,eAAe,GAAGN,cAAc;IAErC,MAAM7C,QAAQ,GAAG,IAAI,CAACoC,gBAAgB,IAAI,IAAI,CAACc,aAAa,EAAE;IAC9D,IAAI,CAAClD,QAAQ,EAAE;MAEb,IAAI,CAAC6B,cAAc,CAACuB,IAAI,EAAE;MAC1B;IACF;IAEA,IAAIC,MAAM,GAAG,KAAK;IAClB,MAAMC,sBAAsC,GAAG;MAC7C,GAAGT,cAAc;MACjB,GAAG,IAAI,CAACU,aAAa;MAErBC,SAAS,EAAE,IAAI,CAACC,yBAAyB;MACzCC,IAAI,EAAEb,cAAc,CAACa,IAAI,GAAG,IAAI,CAACD,yBAAyB;MAC1DE,IAAI,EAAEd,cAAc,CAACc,IAAI,GAAG,IAAI,CAACC,yBAAyB;MAE1DhE,IAAI,EAAEA,CAAA,KAAM;QACVyD,MAAM,GAAG,IAAI;MACf;IACF,CAAC;IAED,IAAI,IAAI,CAACE,aAAa,IAAI,IAAI,CAACX,YAAY,CAACU,sBAAsB,CAAC,EAAE;MAGnEtD,QAAQ,CAACN,QAAQ,CAAC4D,sBAAsB,CAAC;IAI3C;IAEA,MAAMhD,OAAO,GAAGN,QAAQ,CAACM,OAAO,IAAI,IAAI,CAACmB,WAAW,CAACnB,OAAO;IAC5D,IAAIA,OAAO,IAAIgD,sBAAsB,CAACI,IAAI,GAAGpD,OAAO,EAAE;MACpD+C,MAAM,GAAG,IAAI;IACf;IAEA,IAAIA,MAAM,EAAE;MACV,IAAI,CAACP,MAAM,CAAC9C,QAAQ,CAAC;IACvB;EACF;EAEAkD,aAAaA,CAAA,EAAgC;IAC3C,MAAML,cAAc,GAAG,IAAI,CAACM,eAAe;IAG3C,IAAI,IAAI,CAACI,aAAa,EAAE;MACtB,KAAK,MAAMZ,GAAG,IAAI,IAAI,CAACY,aAAa,EAAE;QACpC,MAAMM,KAAK,GAAG,IAAI,CAACN,aAAa,CAACZ,GAAG,CAAC;QACrC,IAAIkB,KAAK,IAAIA,KAAK,CAACC,MAAM,EAAE;UACzBD,KAAK,CAACC,MAAM,EAAE;QAChB;MACF;MACA,IAAI,CAAC1B,gBAAgB,CAACvC,UAAU,CAACkE,MAAM,CAACC,MAAM,CAAC,CAAC,CAAC,EAAEnB,cAAc,EAAE,IAAI,CAACU,aAAa,CAAC,CAAC;MAGvF,IAAI,CAACzB,MAAM,CAACmC,QAAQ,EAAE;MAEtB,IAAI,CAAC7B,gBAAgB,GAAG,IAAI;MAC5B,IAAI,CAACmB,aAAa,GAAG,IAAI;IAC3B;IAGA,MAAMvD,QAAQ,GAAG,IAAI,CAACqB,UAAU,CAAC6C,KAAK,EAAE;IACxC,IAAIlE,QAAQ,EAAE;MAEZ,IAAI,CAACoC,gBAAgB,GAAGpC,QAAQ;MAChC,IAAI,CAACyD,yBAAyB,GAAGZ,cAAc,CAACa,IAAI;MACpD,IAAI,CAACE,yBAAyB,GAAGf,cAAc,CAACc,IAAI;MACpD,IAAI,CAAClB,YAAY,CAACzC,QAAQ,CAAC;MAK3B,IAAI,CAAC8B,MAAM,CAACqC,SAAS,EAAE;MAIvB,MAAMC,SAAS,GAAG;QAChB,GAAGvB,cAAc;QAEjBW,SAAS,EAAEX,cAAc,CAACa,IAAI;QAC9BA,IAAI,EAAE,CAAC;QACPC,IAAI,EAAE;MACR,CAAC;MAIDjC,OAAO,CAACC,OAAO,CAAC3B,QAAQ,CAACP,YAAY,CAAC2E,SAAS,CAAC,CAAC,CAACC,IAAI,CAAEC,QAAQ,IAAK;QACnE,IAAI,CAACf,aAAa,GAAGe,QAAQ,IAAI,CAAC,CAAC;MACrC,CAAC,CAAC;MAGF,IAAI,CAAC7C,WAAW,CAAC1B,WAAW,CAACC,QAAQ,CAAC;IACxC;IACA,OAAOA,QAAQ;EACjB;AACF"}
+{"version":3,"file":"test-runner.js","names":["webglDevice","ClassicAnimationLoop","AnimationLoop","DEFAULT_TEST_CASE","name","onInitialize","onRender","_ref","done","onFinalize","DEFAULT_TEST_PROPS","width","undefined","height","onTestStart","testCase","console","log","concat","onTestPass","result","onTestFail","error","timeout","maxFramesToRender","imageDiffOptions","TestRunner","constructor","props","arguments","length","_defineProperty","Boolean","window","browserTestDriver_isHeadless","add","testCases","Array","isArray","_testCases","push","run","options","testOptions","Promise","resolve","reject","_animationLoop","device","_onRender","bind","isRunning","start","isDiffing","_currentTestCase","catch","_fail","message","initTestCase","animationLoop","key","shouldRender","animationProps","assert","_pass","_next","_nextTestCase","_animationProps","stop","isDone","testCaseAnimationProps","_testCaseData","startTime","_currentTestCaseStartTime","time","tick","_currentTestCaseStartTick","value","delete","destroy","Object","assign","popState","shift","pushState","initProps","then","userData"],"sources":["../src/test-runner.ts"],"sourcesContent":["// @ts-nocheck\n/* eslint-disable */\n\nimport {AnimationProps} from '@luma.gl/engine';\nimport {webglDevice} from './create-test-device';\n\n// TODO - Replace with new AnimationLoop from `@luma.gl/engine`\nimport {ClassicAnimationLoop as AnimationLoop} from './engine/classic-animation-loop';\n\n/** Describes a test case */\nexport type TestRunnerTestCase = {\n  /** Name of the test case (for logging) */\n  name: string;\n  /** Initialize the test case. Can return a promise */\n  onInitialize: (props: AnimationProps) => Promise<void | {}>;\n  /** Perform rendering */\n  onRender: (props: AnimationProps & {done}) => void;\n  /** Clean up after the test case */\n  onFinalize: (props: AnimationProps) => void;\n  animationLoop?: AnimationLoop;\n};\n\nconst DEFAULT_TEST_CASE: TestRunnerTestCase = {\n  name: 'Unnamed test',\n  onInitialize: async () => {},\n  onRender: ({done}) => done(),\n  onFinalize: () => {}\n};\n\n/** Options for a TestRunner */\nexport type TestRunnerProps = {\n  width?: number;\n  height?: number;\n  // test lifecycle callback\n  onTestStart?: (testCase: TestRunnerTestCase) => void;\n  onTestPass?: (testCase: TestRunnerTestCase, result?: unknown) => void;\n  onTestFail?: (testCase: TestRunnerTestCase, error?: unknown) => void;\n  /** milliseconds to wait for each test case before aborting */\n  timeout?: number;\n  maxFramesToRender?: number;\n  // HACK - this is for the snapshot test runner\n  imageDiffOptions?: any;\n};\n\nconst DEFAULT_TEST_PROPS: Required<TestRunnerProps> = {\n  width: undefined,\n  height: undefined,\n\n  // test lifecycle callback\n  onTestStart: (testCase: TestRunnerTestCase) => console.log(`# ${testCase.name}`),\n  onTestPass: (testCase: TestRunnerTestCase, result?: unknown) => console.log(`ok ${testCase.name} passed`),\n  onTestFail: (testCase: TestRunnerTestCase, error?: unknown) => console.log(`not ok ${testCase.name} failed`),\n\n  // milliseconds to wait for each test case before aborting\n  timeout: 2000,\n  maxFramesToRender: undefined,\n  imageDiffOptions: undefined\n};\n\n/** Runs an array of test cases */\nexport class TestRunner {\n  device = webglDevice;\n  props: Record<string, any>;\n  isRunning: boolean = false;\n  testOptions: Required<TestRunnerProps> = {...DEFAULT_TEST_PROPS};\n  readonly _animationProps?: AnimationProps;\n  private _animationLoop: AnimationLoop | null;\n  private _testCases: TestRunnerTestCase[] = [];\n  private _testCaseData: any = null;\n  private _currentTestCase: TestRunnerTestCase | null;\n  private _currentTestCaseStartTime: number;\n  private _currentTestCaseStartTick: number;\n\n  // should be defined in snapshot-test-runner\n  isDiffing: boolean = false;\n\n  // @ts-expect-error\n  isHeadless: boolean = Boolean(window.browserTestDriver_isHeadless);\n\n  /**\n   * props\n   *   AnimationLoop props\n   */\n  constructor(props: Record<string, any> = {}) {\n    this.props = props;\n  }\n\n  /**\n   * Add testCase(s)\n   */\n  add(testCases: TestRunnerTestCase[]): this {\n    if (!Array.isArray(testCases)) {\n      testCases = [testCases];\n    }\n    for (const testCase of testCases) {\n      this._testCases.push(testCase);\n    }\n    return this;\n  }\n\n  /**\n    * Returns a promise that resolves when all the test cases are done\n    */\n  run(options: object = {}): Promise<void>  {\n    this.testOptions = {...this.testOptions, ...options};\n\n    return new Promise<void>((resolve, reject) => {\n      this._animationLoop = new AnimationLoop({\n        ...this.props,\n        device: this.device,\n        onRender: this._onRender.bind(this),\n        onFinalize: () => {\n          this.isRunning = false;\n          resolve();\n        }\n      });\n      this._animationLoop.start(this.props);\n\n      this.isRunning = true;\n      this.isDiffing = false;\n      this._currentTestCase = null;\n    }).catch (error => {\n      this._fail({error: error.message});\n      // reject(error);\n    });\n  }\n\n  /* Lifecycle methods for subclassing */\n\n  initTestCase(testCase: TestRunnerTestCase) {\n    const {animationLoop} = testCase;\n    if (animationLoop) {\n      testCase.onInitialize = animationLoop.props.onInitialize.bind(animationLoop);\n      testCase.onRender = animationLoop.props.onRender.bind(animationLoop);\n      testCase.onFinalize = animationLoop.props.onFinalize.bind(animationLoop);\n    }\n    for (const key in DEFAULT_TEST_CASE) {\n      testCase[key] = testCase[key] || DEFAULT_TEST_CASE[key];\n    }\n  }\n\n  shouldRender(animationProps): boolean {\n    return true;\n  }\n\n  assert(testCase: TestRunnerTestCase): void {\n    this._pass(testCase);\n    this._next();\n  }\n\n  /* Utilities */\n\n  _pass(result: unknown): void {\n    this.testOptions.onTestPass(this._currentTestCase, result);\n    // this._animationLoop?.stop();\n  }\n\n  _fail(result: unknown): void {\n    this.testOptions.onTestFail(this._currentTestCase, result);\n    // this._animationLoop?.stop();\n  }\n\n  _next(): void {\n    this._nextTestCase();\n  }\n\n  /* Private methods */\n\n  _onRender(animationProps): void {\n    this._animationProps = animationProps;\n\n    const testCase = this._currentTestCase || this._nextTestCase();\n    if (!testCase) {\n      // all test cases are done\n      this._animationLoop.stop();\n      return;\n    }\n\n    let isDone = false;\n    const testCaseAnimationProps: AnimationProps = {\n      ...animationProps, \n      ...this._testCaseData,\n      // tick/time starts from 0 for each test case\n      startTime: this._currentTestCaseStartTime,\n      time: animationProps.time - this._currentTestCaseStartTime,\n      tick: animationProps.tick - this._currentTestCaseStartTick,\n      // called by the test case when it is done rendering and ready for capture and diff\n      done: () => {\n        isDone = true;\n      }\n    };\n\n    if (this._testCaseData && this.shouldRender(testCaseAnimationProps)) {\n      // try {\n      // test case is initialized, render frame\n      testCase.onRender(testCaseAnimationProps);\n      // } catch {\n      //   isDone = true;\n      // }\n    }\n\n    const timeout = testCase.timeout || this.testOptions.timeout;\n    if (timeout && testCaseAnimationProps.time > timeout) {\n      isDone = true;\n    }\n\n    if (isDone) {\n      this.assert(testCase);\n    }\n  }\n\n  _nextTestCase(): Promise<TestRunnerTestCase> {\n    const animationProps = this._animationProps;\n\n    // finalize the current test case\n    if (this._testCaseData) {\n      for (const key in this._testCaseData) {\n        const value = this._testCaseData[key];\n        if (value && value.delete) {\n          value.destroy();\n        }\n      }\n      this._currentTestCase.onFinalize(Object.assign({}, animationProps, this._testCaseData));\n\n      // reset WebGL context\n      this.device.popState();\n\n      this._currentTestCase = null;\n      this._testCaseData = null;\n    }\n\n    // get the next test case\n    const testCase = this._testCases.shift();\n    if (testCase) {\n      // start new test case\n      this._currentTestCase = testCase;\n      this._currentTestCaseStartTime = animationProps.time;\n      this._currentTestCaseStartTick = animationProps.tick;\n      this.initTestCase(testCase);\n\n      // initialize test case\n\n      // save WebGL context\n      this.device.pushState();\n\n      // aligned with the behavior of AnimationLoop.onInitialized\n      // onInitialized could return a plain object or a promise\n      const initProps = {\n        ...animationProps,\n        // tick/time starts from 0 for each test case\n        startTime: animationProps.time,\n        time: 0,\n        tick: 0\n      };\n\n      // aligned with the behavior of AnimationLoop.onInitialized\n      // onInitialized could return a plain object or a promise\n      Promise.resolve(testCase.onInitialize(initProps)).then((userData) => {\n        this._testCaseData = userData || {};\n      });\n\n      // invoke user callback\n      this.testOptions.onTestStart(testCase);\n    }\n    return testCase;\n  }\n}\n"],"mappings":";SAIQA,WAAW;AAAA,SAGXC,oBAAoB,IAAIC,aAAa;AAe7C,MAAMC,iBAAqC,GAAG;EAC5CC,IAAI,EAAE,cAAc;EACpBC,YAAY,EAAE,MAAAA,CAAA,KAAY,CAAC,CAAC;EAC5BC,QAAQ,EAAEC,IAAA;IAAA,IAAC;MAACC;IAAI,CAAC,GAAAD,IAAA;IAAA,OAAKC,IAAI,EAAE;EAAA;EAC5BC,UAAU,EAAEA,CAAA,KAAM,CAAC;AACrB,CAAC;AAiBD,MAAMC,kBAA6C,GAAG;EACpDC,KAAK,EAAEC,SAAS;EAChBC,MAAM,EAAED,SAAS;EAGjBE,WAAW,EAAGC,QAA4B,IAAKC,OAAO,CAACC,GAAG,MAAAC,MAAA,CAAMH,QAAQ,CAACX,IAAI,EAAG;EAChFe,UAAU,EAAEA,CAACJ,QAA4B,EAAEK,MAAgB,KAAKJ,OAAO,CAACC,GAAG,OAAAC,MAAA,CAAOH,QAAQ,CAACX,IAAI,aAAU;EACzGiB,UAAU,EAAEA,CAACN,QAA4B,EAAEO,KAAe,KAAKN,OAAO,CAACC,GAAG,WAAAC,MAAA,CAAWH,QAAQ,CAACX,IAAI,aAAU;EAG5GmB,OAAO,EAAE,IAAI;EACbC,iBAAiB,EAAEZ,SAAS;EAC5Ba,gBAAgB,EAAEb;AACpB,CAAC;AAGD,OAAO,MAAMc,UAAU,CAAC;EAuBtBC,WAAWA,CAAA,EAAkC;IAAA,IAAjCC,KAA0B,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAjB,SAAA,GAAAiB,SAAA,MAAG,CAAC,CAAC;IAAAE,eAAA,iBAtBlC/B,WAAW;IAAA+B,eAAA;IAAAA,eAAA,oBAEC,KAAK;IAAAA,eAAA,sBACe;MAAC,GAAGrB;IAAkB,CAAC;IAAAqB,eAAA;IAAAA,eAAA;IAAAA,eAAA,qBAGrB,EAAE;IAAAA,eAAA,wBAChB,IAAI;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA,oBAMZ,KAAK;IAAAA,eAAA,qBAGJC,OAAO,CAACC,MAAM,CAACC,4BAA4B,CAAC;IAOhE,IAAI,CAACN,KAAK,GAAGA,KAAK;EACpB;EAKAO,GAAGA,CAACC,SAA+B,EAAQ;IACzC,IAAI,CAACC,KAAK,CAACC,OAAO,CAACF,SAAS,CAAC,EAAE;MAC7BA,SAAS,GAAG,CAACA,SAAS,CAAC;IACzB;IACA,KAAK,MAAMrB,QAAQ,IAAIqB,SAAS,EAAE;MAChC,IAAI,CAACG,UAAU,CAACC,IAAI,CAACzB,QAAQ,CAAC;IAChC;IACA,OAAO,IAAI;EACb;EAKA0B,GAAGA,CAAA,EAAuC;IAAA,IAAtCC,OAAe,GAAAb,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAjB,SAAA,GAAAiB,SAAA,MAAG,CAAC,CAAC;IACtB,IAAI,CAACc,WAAW,GAAG;MAAC,GAAG,IAAI,CAACA,WAAW;MAAE,GAAGD;IAAO,CAAC;IAEpD,OAAO,IAAIE,OAAO,CAAO,CAACC,OAAO,EAAEC,MAAM,KAAK;MAC5C,IAAI,CAACC,cAAc,GAAG,IAAI7C,aAAa,CAAC;QACtC,GAAG,IAAI,CAAC0B,KAAK;QACboB,MAAM,EAAE,IAAI,CAACA,MAAM;QACnB1C,QAAQ,EAAE,IAAI,CAAC2C,SAAS,CAACC,IAAI,CAAC,IAAI,CAAC;QACnCzC,UAAU,EAAEA,CAAA,KAAM;UAChB,IAAI,CAAC0C,SAAS,GAAG,KAAK;UACtBN,OAAO,EAAE;QACX;MACF,CAAC,CAAC;MACF,IAAI,CAACE,cAAc,CAACK,KAAK,CAAC,IAAI,CAACxB,KAAK,CAAC;MAErC,IAAI,CAACuB,SAAS,GAAG,IAAI;MACrB,IAAI,CAACE,SAAS,GAAG,KAAK;MACtB,IAAI,CAACC,gBAAgB,GAAG,IAAI;IAC9B,CAAC,CAAC,CAACC,KAAK,CAAEjC,KAAK,IAAI;MACjB,IAAI,CAACkC,KAAK,CAAC;QAAClC,KAAK,EAAEA,KAAK,CAACmC;MAAO,CAAC,CAAC;IAEpC,CAAC,CAAC;EACJ;EAIAC,YAAYA,CAAC3C,QAA4B,EAAE;IACzC,MAAM;MAAC4C;IAAa,CAAC,GAAG5C,QAAQ;IAChC,IAAI4C,aAAa,EAAE;MACjB5C,QAAQ,CAACV,YAAY,GAAGsD,aAAa,CAAC/B,KAAK,CAACvB,YAAY,CAAC6C,IAAI,CAACS,aAAa,CAAC;MAC5E5C,QAAQ,CAACT,QAAQ,GAAGqD,aAAa,CAAC/B,KAAK,CAACtB,QAAQ,CAAC4C,IAAI,CAACS,aAAa,CAAC;MACpE5C,QAAQ,CAACN,UAAU,GAAGkD,aAAa,CAAC/B,KAAK,CAACnB,UAAU,CAACyC,IAAI,CAACS,aAAa,CAAC;IAC1E;IACA,KAAK,MAAMC,GAAG,IAAIzD,iBAAiB,EAAE;MACnCY,QAAQ,CAAC6C,GAAG,CAAC,GAAG7C,QAAQ,CAAC6C,GAAG,CAAC,IAAIzD,iBAAiB,CAACyD,GAAG,CAAC;IACzD;EACF;EAEAC,YAAYA,CAACC,cAAc,EAAW;IACpC,OAAO,IAAI;EACb;EAEAC,MAAMA,CAAChD,QAA4B,EAAQ;IACzC,IAAI,CAACiD,KAAK,CAACjD,QAAQ,CAAC;IACpB,IAAI,CAACkD,KAAK,EAAE;EACd;EAIAD,KAAKA,CAAC5C,MAAe,EAAQ;IAC3B,IAAI,CAACuB,WAAW,CAACxB,UAAU,CAAC,IAAI,CAACmC,gBAAgB,EAAElC,MAAM,CAAC;EAE5D;EAEAoC,KAAKA,CAACpC,MAAe,EAAQ;IAC3B,IAAI,CAACuB,WAAW,CAACtB,UAAU,CAAC,IAAI,CAACiC,gBAAgB,EAAElC,MAAM,CAAC;EAE5D;EAEA6C,KAAKA,CAAA,EAAS;IACZ,IAAI,CAACC,aAAa,EAAE;EACtB;EAIAjB,SAASA,CAACa,cAAc,EAAQ;IAC9B,IAAI,CAACK,eAAe,GAAGL,cAAc;IAErC,MAAM/C,QAAQ,GAAG,IAAI,CAACuC,gBAAgB,IAAI,IAAI,CAACY,aAAa,EAAE;IAC9D,IAAI,CAACnD,QAAQ,EAAE;MAEb,IAAI,CAACgC,cAAc,CAACqB,IAAI,EAAE;MAC1B;IACF;IAEA,IAAIC,MAAM,GAAG,KAAK;IAClB,MAAMC,sBAAsC,GAAG;MAC7C,GAAGR,cAAc;MACjB,GAAG,IAAI,CAACS,aAAa;MAErBC,SAAS,EAAE,IAAI,CAACC,yBAAyB;MACzCC,IAAI,EAAEZ,cAAc,CAACY,IAAI,GAAG,IAAI,CAACD,yBAAyB;MAC1DE,IAAI,EAAEb,cAAc,CAACa,IAAI,GAAG,IAAI,CAACC,yBAAyB;MAE1DpE,IAAI,EAAEA,CAAA,KAAM;QACV6D,MAAM,GAAG,IAAI;MACf;IACF,CAAC;IAED,IAAI,IAAI,CAACE,aAAa,IAAI,IAAI,CAACV,YAAY,CAACS,sBAAsB,CAAC,EAAE;MAGnEvD,QAAQ,CAACT,QAAQ,CAACgE,sBAAsB,CAAC;IAI3C;IAEA,MAAM/C,OAAO,GAAGR,QAAQ,CAACQ,OAAO,IAAI,IAAI,CAACoB,WAAW,CAACpB,OAAO;IAC5D,IAAIA,OAAO,IAAI+C,sBAAsB,CAACI,IAAI,GAAGnD,OAAO,EAAE;MACpD8C,MAAM,GAAG,IAAI;IACf;IAEA,IAAIA,MAAM,EAAE;MACV,IAAI,CAACN,MAAM,CAAChD,QAAQ,CAAC;IACvB;EACF;EAEAmD,aAAaA,CAAA,EAAgC;IAC3C,MAAMJ,cAAc,GAAG,IAAI,CAACK,eAAe;IAG3C,IAAI,IAAI,CAACI,aAAa,EAAE;MACtB,KAAK,MAAMX,GAAG,IAAI,IAAI,CAACW,aAAa,EAAE;QACpC,MAAMM,KAAK,GAAG,IAAI,CAACN,aAAa,CAACX,GAAG,CAAC;QACrC,IAAIiB,KAAK,IAAIA,KAAK,CAACC,MAAM,EAAE;UACzBD,KAAK,CAACE,OAAO,EAAE;QACjB;MACF;MACA,IAAI,CAACzB,gBAAgB,CAAC7C,UAAU,CAACuE,MAAM,CAACC,MAAM,CAAC,CAAC,CAAC,EAAEnB,cAAc,EAAE,IAAI,CAACS,aAAa,CAAC,CAAC;MAGvF,IAAI,CAACvB,MAAM,CAACkC,QAAQ,EAAE;MAEtB,IAAI,CAAC5B,gBAAgB,GAAG,IAAI;MAC5B,IAAI,CAACiB,aAAa,GAAG,IAAI;IAC3B;IAGA,MAAMxD,QAAQ,GAAG,IAAI,CAACwB,UAAU,CAAC4C,KAAK,EAAE;IACxC,IAAIpE,QAAQ,EAAE;MAEZ,IAAI,CAACuC,gBAAgB,GAAGvC,QAAQ;MAChC,IAAI,CAAC0D,yBAAyB,GAAGX,cAAc,CAACY,IAAI;MACpD,IAAI,CAACE,yBAAyB,GAAGd,cAAc,CAACa,IAAI;MACpD,IAAI,CAACjB,YAAY,CAAC3C,QAAQ,CAAC;MAK3B,IAAI,CAACiC,MAAM,CAACoC,SAAS,EAAE;MAIvB,MAAMC,SAAS,GAAG;QAChB,GAAGvB,cAAc;QAEjBU,SAAS,EAAEV,cAAc,CAACY,IAAI;QAC9BA,IAAI,EAAE,CAAC;QACPC,IAAI,EAAE;MACR,CAAC;MAID/B,OAAO,CAACC,OAAO,CAAC9B,QAAQ,CAACV,YAAY,CAACgF,SAAS,CAAC,CAAC,CAACC,IAAI,CAAEC,QAAQ,IAAK;QACnE,IAAI,CAAChB,aAAa,GAAGgB,QAAQ,IAAI,CAAC,CAAC;MACrC,CAAC,CAAC;MAGF,IAAI,CAAC5C,WAAW,CAAC7B,WAAW,CAACC,QAAQ,CAAC;IACxC;IACA,OAAOA,QAAQ;EACjB;AACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@luma.gl/test-utils",
-  "version": "9.0.0-alpha.21",
+  "version": "9.0.0-alpha.23",
   "description": "Automated WebGL testing utilities with Puppeteer and image diffing",
   "type": "module",
   "license": "MIT",
@@ -39,14 +39,18 @@
     "pre-build": "echo test utils has no bundle"
   },
   "dependencies": {
+    "@luma.gl/api": "9.0.0-alpha.23",
+    "@luma.gl/engine": "9.0.0-alpha.23",
+    "@luma.gl/webgl": "9.0.0-alpha.23",
+    "@luma.gl/webgpu": "9.0.0-alpha.23",
     "@probe.gl/env": "^4.0.2",
     "@types/gl": "^6.0.2",
     "gl": "^6.0.1"
   },
   "peerDependencies": {
-    "@luma.gl/api": "9.0.0-alpha.13",
-    "@luma.gl/webgl": "9.0.0-alpha.13",
-    "@luma.gl/webgpu": "9.0.0-alpha.13",
+    "@luma.gl/api": "9.0.0-alpha.21",
+    "@luma.gl/webgl": "9.0.0-alpha.21",
+    "@luma.gl/webgpu": "9.0.0-alpha.21",
     "@probe.gl/test-utils": "^4.0.2"
   },
   "engines_comment": [
@@ -55,5 +59,5 @@
   "engines": {
     "node": ">=16.18.0"
   },
-  "gitHead": "7ee95470a6a2f62753201beb0c36b00e37c70455"
+  "gitHead": "5e4a30497333bea4be8f2b3f3db33c0b67931b9c"
 }