@lvce-editor/test-worker 6.1.0 → 6.3.0

package/dist/api.d.ts

@@ -1,4 +1,34 @@
 
+export interface LocatorExpect {
+	/**
+	 * @internal
+	 */
+	negated: boolean;
+	/**
+	 * @internal
+	 */
+	readonly checkSingleElementCondition: (fnName: string, options?: any) => Promise<void>;
+	/**
+	 * @internal
+	 */
+	readonly checkMultiElementCondition: (fnName: string, options: any) => Promise<void>;
+	readonly toBeVisible: () => Promise<void>;
+	readonly toHaveText: (text: string) => Promise<void>;
+	readonly toContainText: (text: string) => Promise<void>;
+	readonly toHaveValue: (value: string) => Promise<void>;
+	readonly toBeFocused: () => Promise<void>;
+	readonly toHaveCSS: (key: string, value: string) => Promise<void>;
+	readonly toHaveAttribute: (key: string, value: string) => Promise<void>;
+	readonly toHaveJSProperty: (key: string, value: any) => Promise<void>;
+	readonly toHaveClass: (className: string) => Promise<void>;
+	readonly toHaveId: (id: string) => Promise<void>;
+	readonly toHaveCount: (count: number) => Promise<void>;
+	readonly toBeHidden: () => Promise<void>;
+	readonly not: LocatorExpect;
+}
+
+
+
 interface LocatorClickOptions {
 	readonly button?: string;
 }
@@ -27,6 +57,7 @@ export interface FileSystemTmpDirOptions {
 
 interface Workspace {
   readonly openTmpDir: () => Promise<string>;
+  readonly resolveFileUrl: (url: string) => string;
   readonly setPath: (path: string) => Promise<void>;
 }
 
@@ -513,7 +544,7 @@ export interface TestApi {
   readonly TitleBarMenuBar: TitleBarMenuBar
   readonly Url: Url
   readonly WebView: WebView
-  readonly expect: any
+  readonly expect: (locator: ILocatorExternal) => LocatorExpect
   readonly Locator: (selector: string, option?: any) => ILocatorExternal
 }
 

package/dist/testWorkerMain.js

@@ -1079,10 +1079,55 @@ const sendMessagePortToEditorWorker = async (port, rpcId) => {
   await invokeAndTransfer('SendMessagePortToExtensionHostWorker.sendMessagePortToEditorWorker', port, command, rpcId);
 };
 
+const callFunction = async (fn, args) => {
+  try {
+    await fn(args);
+    return undefined;
+  } catch (error) {
+    return error;
+  }
+};
+
 const formatDuration = duration => {
   return duration.toFixed(2) + 'ms';
 };
 
+const Fail = 'fail';
+const Pass = 'pass';
+
+const executeTest2 = async (name, fn, globals, timestampGenerator) => {
+  const getTimestamp = timestampGenerator;
+  const start = getTimestamp();
+  const error = await callFunction(fn, globals);
+  const end = getTimestamp();
+  const duration = end - start;
+  const formattedDuration = formatDuration(duration);
+  if (error) {
+    return {
+      error,
+      start,
+      end,
+      duration,
+      formattedDuration,
+      name,
+      type: Fail,
+      background: 'red',
+      text: `test failed: ${error}`
+    };
+  }
+  return {
+    error: undefined,
+    start,
+    end,
+    duration,
+    formattedDuration,
+    name,
+    type: Pass,
+    background: 'green',
+    text: `test passed in ${formattedDuration}`
+  };
+};
+
 const printError = error => {
   if (error && error.constructor.name === 'AssertionError') {
     console.error(error.message);
@@ -1096,66 +1141,26 @@ const printTestError = async error => {
   printError(error);
 };
 
-const stringifyError = error => {
-  if (!error) {
-    return `${error}`;
-  }
-  if (error && error.message && error.constructor.name && error.constructor.name !== 'Error' && error.constructor.name !== 'VError') {
-    return `${error}`;
-  }
-  return `${error.message}`;
-};
-
-const Fail = 'fail';
-const Pass = 'pass';
-
 const now = () => {
   return performance.now();
 };
 
-// TODO make this code more functional, returning a test result
-// and a separate function prints out the test result
 const executeTest = async (name, fn, globals = {}) => {
-  let _error;
-  let _start;
-  let _end;
-  let _duration;
-  let _formattedDuration;
-  try {
-    _start = now();
-    await fn(globals);
-    _end = now();
-    _duration = _end - _start;
-    _formattedDuration = formatDuration(_duration);
-    // eslint-disable-next-line no-console
-    console.info(`PASS ${name} in ${_formattedDuration}`);
-  } catch (error) {
-    if (error &&
-    // @ts-ignore
-    error.message.startsWith('Failed to load command TestFrameWork.')) {
-      console.error(error);
-      return;
-    }
-    _error = stringifyError(error);
-    if (!(error instanceof VError)) {
-      error = new VError(error, `Test failed: ${name}`);
-    }
+  const {
+    error,
+    formattedDuration,
+    background,
+    text,
+    type
+  } = await executeTest2(name, fn, globals, now);
+  if (error) {
     await printTestError(error);
-  }
-  let state;
-  let background;
-  let text;
-  if (_error) {
-    state = Fail;
-    background = 'red';
-    text = `test failed: ${_error}`;
   } else {
-    background = 'green';
-    text = `test passed in ${_formattedDuration}`;
-    state = Pass;
+    // eslint-disable-next-line no-console
+    console.info(`PASS ${name} in ${formattedDuration}`);
   }
   // @ts-ignore
-  await invoke$1('TestFrameWork.showOverlay', state, background, text);
+  await invoke$1('TestFrameWork.showOverlay', type, background, text);
 };
 
 const importScript = async url => {
@@ -1240,6 +1245,20 @@ const toHaveText = async (locator, options) => {
   }
   return `expected selector ${locatorString} to have text "${text}" but was "${actual}"`;
 };
+const toContainText = async (locator, options) => {
+  const locatorString = printLocator(locator);
+  const {
+    wasFound,
+    actual
+  } = await locatorInvoke(locator, 'TestFrameWork.checkConditionError', 'toContainText', locator, options);
+  const {
+    text
+  } = options;
+  if (!wasFound) {
+    return `expected selector ${locatorString} to contain text "${text}" element was not found`;
+  }
+  return `expected selector ${locatorString} to contain text "${text}" but was "${actual}"`;
+};
 const toHaveAttribute = async (locator, options) => {
   const locatorString = printLocator(locator);
   const {
@@ -1341,6 +1360,8 @@ const getFunction = fnName => {
       return toHaveValue;
     case 'toHaveText':
       return toHaveText;
+    case 'toContainText':
+      return toContainText;
     case 'toHaveAttribute':
       return toHaveAttribute;
     case 'toHaveCount':
@@ -3503,6 +3524,12 @@ const setWebViewPort = async (uid, port, origin, portType) => {
   await invokeAndTransfer('WebView.setPort', uid, port, origin, portType);
 };
 
+const transferWebViewPort = async (webViewId, port) => {
+  const info = await getWebViewInfo(webViewId);
+  const portType = 'test';
+  await setWebViewPort(info.uid, port, info.origin, portType);
+};
+
 const waitForFirstEventEvent = async port => {
   const {
     resolve,
@@ -3521,9 +3548,7 @@ const createPortRpc = async webViewId => {
   } = getPortTuple();
   const firstEventPromise = waitForFirstEventEvent(port1);
   // TODO ask extension host worker about webview uid
-  const info = await getWebViewInfo(webViewId);
-  const portType = 'test';
-  await setWebViewPort(info.uid, port2, info.origin, portType);
+  await transferWebViewPort(webViewId, port2);
   const firstEvent = await firstEventPromise;
   if (firstEvent.data !== 'ready') {
     throw new Error('unexpected first message');
@@ -3554,6 +3579,16 @@ const TestFrameWorkComponentWebView = {
   fromId
 };
 
+const toFileUrl = url => {
+  const urlObject = new URL(url);
+  const pathName = urlObject.pathname;
+  if (!pathName.startsWith('/remote')) {
+    throw new Error(`url must start with /remote`);
+  }
+  const rest = pathName.slice('/remote'.length);
+  return `file://${rest}`;
+};
+
 const setPath = async path => {
   await invoke$1('Workspace.setPath', path);
 };
@@ -3562,10 +3597,20 @@ const openTmpDir = async () => {
   await setPath(tmpDir);
   return tmpDir;
 };
+const resolveFileUrl = url => {
+  // TODO in web, convert to memfs or fetch url
+  // TODO on web: read filemap for that fixture
+  // else, use filesystem to read the files
+  // TODO covert remote url to file url
+  // then set that as workspace path
+
+  return toFileUrl(url);
+};
 
 const TestFrameWorkComponentWorkspace = {
   __proto__: null,
   openTmpDir,
+  resolveFileUrl,
   setPath
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/test-worker",
-  "version": "6.1.0",
+  "version": "6.3.0",
   "description": "Test Worker",
   "repository": {
     "type": "git",