testdriverai 6.1.5 → 6.1.6

package/agent/lib/commander.js

@@ -154,7 +154,11 @@ commands:
             events.log.narration,
             `${object.action} image ${object.path}`,
           );
-          response = await commands["match-image"](object.path, object.action);
+          response = await commands["match-image"](
+            object.path,
+            object.action,
+            object.invert,
+          );
           break;
         case "wait-for-image":
           emitter.emit(events.log.log, generator.jsonToManual(object));
@@ -165,6 +169,7 @@ commands:
           response = await commands["wait-for-image"](
             object.description,
             object.timeout,
+            object.invert,
           );
           break;
         case "wait-for-text":
@@ -175,6 +180,7 @@ commands:
             object.text,
             object.timeout,
             object.method,
+            object.invert,
           );
           break;
         case "scroll-until-text":
@@ -187,6 +193,7 @@ commands:
             object.distance,
             object.textMatchMethod,
             object.method,
+            object.invert,
           );
           break;
         case "scroll-until-image": {
@@ -199,6 +206,7 @@ commands:
             object.distance,
             object.method,
             object.path,
+            object.invert,
           );
           break;
         }
@@ -217,7 +225,11 @@ commands:
         case "assert":
           emitter.emit(events.log.log, generator.jsonToManual(object));
           emitter.emit(events.log.narration, `asserting ${object.expect}`);
-          response = await commands.assert(object.expect, object.async);
+          response = await commands.assert(
+            object.expect,
+            object.async,
+            object.invert,
+          );
 
           break;
         case "exec":

package/agent/lib/commands.js

@@ -170,7 +170,12 @@ const createCommands = (
     return result;
   };
 
-  const assert = async (assertion, shouldThrow = false, async = false) => {
+  const assert = async (
+    assertion,
+    shouldThrow = false,
+    async = false,
+    invert = false,
+  ) => {
     if (async) {
       shouldThrow = true;
     }
@@ -178,12 +183,21 @@ const createCommands = (
     const handleAssertResponse = (response) => {
       emitter.emit(events.log.log, response);
 
-      if (response.indexOf("The task passed") > -1) {
+      let valid = response.indexOf("The task passed") > -1;
+
+      if (invert) {
+        valid = !valid;
+      }
+
+      if (valid) {
         return true;
       } else {
         if (shouldThrow) {
           // Is fatal, othewise it just changes the assertion to be true
-          throw new MatchError(`AI Assertion failed`, true);
+          throw new MatchError(
+            `AI Assertion failed ${invert && "(Inverted)"}`,
+            true,
+          );
         } else {
           return false;
         }
@@ -399,7 +413,7 @@ const createCommands = (
         return response.data;
       }
     },
-    "match-image": async (relativePath, action = "click") => {
+    "match-image": async (relativePath, action = "click", invert = false) => {
       // Resolve the image path relative to the current file
       const resolvedPath = resolveRelativePath(relativePath);
 
@@ -407,6 +421,10 @@ const createCommands = (
 
       let result = await findImageOnScreen(resolvedPath, image);
 
+      if (invert) {
+        result = !result;
+      }
+
       if (!result) {
         throw new CommandError(`Image not found: ${resolvedPath}`);
       } else {
@@ -445,7 +463,7 @@ const createCommands = (
     wait: async (timeout = 3000) => {
       return await delay(timeout);
     },
-    "wait-for-image": async (description, timeout = 10000) => {
+    "wait-for-image": async (description, timeout = 10000, invert = false) => {
       emitter.emit(
         events.log.narration,
         theme.dim(
@@ -463,6 +481,7 @@ const createCommands = (
           `An image matching the description "${description}" appears on screen.`,
           false,
           false,
+          invert,
         );
 
         durationPassed = new Date().getTime() - startTime;
@@ -493,7 +512,12 @@ const createCommands = (
         );
       }
     },
-    "wait-for-text": async (text, timeout = 5000, method = "turbo") => {
+    "wait-for-text": async (
+      text,
+      timeout = 5000,
+      method = "turbo",
+      invert = false,
+    ) => {
       await redraw.start();
 
       emitter.emit(
@@ -523,7 +547,12 @@ const createCommands = (
         );
 
         passed = response.data;
+
+        if (invert) {
+          passed = !passed;
+        }
         durationPassed = new Date().getTime() - startTime;
+
         if (!passed) {
           emitter.emit(
             events.log.narration,
@@ -551,6 +580,7 @@ const createCommands = (
       maxDistance = 10000,
       textMatchMethod = "turbo",
       method = "keyboard",
+      invert = false,
     ) => {
       await redraw.start();
 
@@ -594,6 +624,11 @@ const createCommands = (
         );
 
         passed = response.data;
+
+        if (invert) {
+          passed = !passed;
+        }
+
         if (!passed) {
           emitter.emit(
             events.log.narration,
@@ -622,6 +657,7 @@ const createCommands = (
       maxDistance = 10000,
       method = "keyboard",
       path,
+      invert = false,
     ) => {
       const needle = description || path;
 
@@ -651,6 +687,7 @@ const createCommands = (
             `An image matching the description "${description}" appears on screen.`,
             false,
             false,
+            invert,
           );
         }
 
@@ -703,8 +740,10 @@ const createCommands = (
       });
       return result.data;
     },
-    assert: async (assertion, async = false) => {
-      return await assert(assertion, true, async);
+    assert: async (assertion, async = false, invert = false) => {
+      let response = await assert(assertion, true, async, invert);
+
+      return response;
     },
     exec: async (language, code, timeout, silent = false) => {
       emitter.emit(events.log.narration, theme.dim(`calling exec...`), true);

package/docs/commands/assert.mdx

@@ -22,6 +22,7 @@ The `assert` command validates that a specific condition is true. It ensures tha
 | -------- | --------- | ------------------------------------------------------------------------------------------------------------------ |
 | `expect` | `string`  | The condition to check. This should describe what you expect to see on the screen.                                 |
 | `async`  | `boolean` | (Optional) If set to `true`, the test will continue without waiting for the assertion to pass. Default is `false`. |
+| `invert` | `boolean` | (Optional) If set to `true`, will fail if the assertion passes.                                                    |
 
 ## Example usage
 

package/docs/commands/hover-text.mdx

@@ -18,13 +18,13 @@ The `hover-text` command is used to locate text on the screen based on a descrip
 
 ## Arguments
 
-|   Argument    |   Type   | Description                                             |
-| :-----------: | :------: | :------------------------------------------------------ |
-|    `text`     | `string` | The text to find on the screen. Longer and unique is better.   |
-| `description` | `string` | A description of the text and what it represents. The actual text itself shouldn't be included here. |
+|   Argument    |   Type   | Description                                                                                                                                                                                                                 |
+| :-----------: | :------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|    `text`     | `string` | The text to find on the screen. Longer and unique is better.                                                                                                                                                                |
+| `description` | `string` | A description of the text and what it represents. The actual text itself shouldn't be included here.                                                                                                                        |
 |   `action`    | `string` | The action to take when the text is found. Available actions are: `click`, `right-click`, `double-click`, `hover`. Also supports `drag-start` and `drag-end` for [dragging text](/commands/hover-image#drag-functionality). |
-|   `method`    |  `enum`  | The matching algorithm to use. Possible values are `turbo` (default) and `ai`.|
-| `timeout`     | `number` | **(Optional)** The duration in milliseconds to wait for the text to appear. Default is `5000` (5 seconds).|
+|   `method`    |  `enum`  | The matching algorithm to use. Possible values are `turbo` (default) and `ai`.                                                                                                                                              |
+|   `timeout`   | `number` | **(Optional)** The duration in milliseconds to wait for the text to appear. Default is `5000` (5 seconds).                                                                                                                  |
 
 ## Example usage
 

package/docs/commands/match-image.mdx

@@ -18,10 +18,11 @@ The `match-image` command is used to locate an image on the screen by matching i
 
 ## Arguments
 
-| Argument | Type     | Description                                                                                                                                                                                                                   |
-| -------- | -------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `path`   | `string` | The path to the image that needs to be matched. The path needs to be relative to the current test file                                                                                                                        |
-| `action` | `string` | The action to take when the image is found. Available actions are: `click`, `right-click`, `double-click`, `hover`. Also supports `drag-start` and `drag-end` for [dragging images](/commands/hover-image#drag-functionality) |
+| Argument | Type      | Description                                                                                                                                                                                                                   |
+| -------- | --------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `path`   | `string`  | The path to the image that needs to be matched. The path needs to be relative to the current test file                                                                                                                        |
+| `action` | `string`  | The action to take when the image is found. Available actions are: `click`, `right-click`, `double-click`, `hover`. Also supports `drag-start` and `drag-end` for [dragging images](/commands/hover-image#drag-functionality) |
+| `invert` | `boolean` | (Optional) If set to `true`, the command will pass when the specified image is NOT detected. Default is `false`.                                                                                                              |
 
 ## Example usage
 

package/docs/commands/press-keys.mdx

@@ -28,8 +28,7 @@ The keys supported are the standard [Windows keys](https://learn.microsoft.com/e
 
 <Tabs>
   <Tab title="Modifiers">
-    - `ctrl`, `shift`, `alt`, `command`, `option`, `win` 
-    - Left/right variants:
+    - `ctrl`, `shift`, `alt`, `command`, `option`, `win` - Left/right variants:
     `ctrlleft`, `ctrlright`, `shiftleft`, `shiftright`, `altleft`, `altright`,
     `optionleft`, `optionright`, `winleft`, `winright`
   </Tab>
@@ -37,9 +36,7 @@ The keys supported are the standard [Windows keys](https://learn.microsoft.com/e
     - All ASCII printable characters: letters `a`–`z`, digits `0`–`9`, common
     punctuation, and `space`.
   </Tab>
-  <Tab title="Function keys">
-  - `f1`–`f24`
-  </Tab>
+  <Tab title="Function keys">- `f1`–`f24`</Tab>
   <Tab title="Navigation">
     - `up`, `down`, `left`, `right`, `home`, `end`, `pageup`, `pagedown`,
     `pgup`, `pgdn`
@@ -57,9 +54,10 @@ The keys supported are the standard [Windows keys](https://learn.microsoft.com/e
     `separator`
   </Tab>
   <Tab title="Media & Browser">
-    - `playpause`, `stop`, `nexttrack`, `prevtrack`, `volumedown`, `volumeup`, `volumemute` 
-    - `browserback`, `browserforward`, `browserrefresh`, `browsersearch`, `browserstop`, `browserfavorites`, `browserhome` 
-    - `launchapp1`, `launchapp2`, `launchmail`, `launchmediaselect`
+    - `playpause`, `stop`, `nexttrack`, `prevtrack`, `volumedown`, `volumeup`,
+    `volumemute` - `browserback`, `browserforward`, `browserrefresh`,
+    `browsersearch`, `browserstop`, `browserfavorites`, `browserhome` -
+    `launchapp1`, `launchapp2`, `launchmail`, `launchmediaselect`
   </Tab>
   <Tab title="IME / International">
     - `hangul`, `hanguel`, `hanja`, `junja`, `kana`, `kanji`, `modechange`,

package/docs/commands/scroll-until-image.mdx

@@ -18,13 +18,14 @@ The `scroll-until-image` command is used to scroll the screen in a specified dir
 
 ## Arguments
 
-|   Argument    |   Type   | Description                                                                                                             |
-| :-----------: | :------: | :---------------------------------------------------------------------------------------------------------------------- |
-| `description` | `string` | A description of the image and what it represents.                                                                      |
-|  `direction`  | `string` | (Optional) The direction to scroll. Available directions are: `up`, `down`, `left`, `right`. Defaults to `down`.        |
-|  `distance`   | `number` | (Optional) The maximum number of pixels to scroll before giving up. Default is `10000`.                                 |
-|   `method`    | `string` | (Optional) The method to use to scroll the page. Available methods are: `mouse` and `keyboard`. Defaults to `keyboard`. |
-|    `path`     | `string` | (Optional) The relative path to the image file that needs to be matched on the screen.                                  |
+|   Argument    |   Type    | Description                                                                                                             |
+| :-----------: | :-------: | :---------------------------------------------------------------------------------------------------------------------- |
+| `description` | `string`  | A description of the image and what it represents.                                                                      |
+|  `direction`  | `string`  | (Optional) The direction to scroll. Available directions are: `up`, `down`, `left`, `right`. Defaults to `down`.        |
+|  `distance`   | `number`  | (Optional) The maximum number of pixels to scroll before giving up. Default is `10000`.                                 |
+|   `method`    | `string`  | (Optional) The method to use to scroll the page. Available methods are: `mouse` and `keyboard`. Defaults to `keyboard`. |
+|    `path`     | `string`  | (Optional) The relative path to the image file that needs to be matched on the screen.                                  |
+|   `invert`    | `boolean` | (Optional) If set to `true`, the command will scroll until the specified image is NOT detected. Default is `false`.     |
 
 <Note>
   Use either the `description` or `path` argument to match an image on the

package/docs/commands/scroll-until-text.mdx

@@ -18,12 +18,13 @@ The `scroll-until-text` command is used to scroll the screen in a specified dire
 
 ## Arguments
 
-|  Argument   |   Type   | Description                                                                                                             |
-| :---------: | :------: | :---------------------------------------------------------------------------------------------------------------------- |
-|   `text`    | `string` | The text to find on the screen. Longer and unique are better. Note this is **case sensitive**                           |
-| `direction` | `string` | (Optional) The direction to scroll. Available directions are: `up`, `down`, `left`, `right`. Defaults to `down`.        |
-|  `method`   | `string` | (Optional) The method to use to scroll the page. Available methods are: `mouse` and `keyboard`. Defaults to `keyboard`. |
-| `distance`  | `number` | (Optional) The maximum number of pixels to scroll before giving up. Default is `10000`.                                 |
+|  Argument   |   Type    | Description                                                                                                             |
+| :---------: | :-------: | :---------------------------------------------------------------------------------------------------------------------- |
+|   `text`    | `string`  | The text to find on the screen. Longer and unique are better. Note this is **case sensitive**                           |
+| `direction` | `string`  | (Optional) The direction to scroll. Available directions are: `up`, `down`, `left`, `right`. Defaults to `down`.        |
+|  `method`   | `string`  | (Optional) The method to use to scroll the page. Available methods are: `mouse` and `keyboard`. Defaults to `keyboard`. |
+| `distance`  | `number`  | (Optional) The maximum number of pixels to scroll before giving up. Default is `10000`.                                 |
+|  `invert`   | `boolean` | (Optional) If set to `true`, the command will scroll until the specified text is NOT detected. Default is `false`.      |
 
 <Note>
 If the method is `keyboard` it just searches for the string by doing `ctrl + f`. 

package/docs/commands/wait-for-image.mdx

@@ -18,10 +18,11 @@ The `wait-for-image` command waits until the specified image is detected on the
 
 ## Arguments
 
-|   Argument    |   Type   | Description                                                                                               |
-| :-----------: | :------: | :-------------------------------------------------------------------------------------------------------- |
-| `description` | `string` | A description of the image.                                                                               |
-|   `timeout`   | `number` | (Optional) The duration in milliseconds to wait for the image to appear. Default is `10000` (10 seconds). |
+|   Argument    |   Type    | Description                                                                                                       |
+| :-----------: | :-------: | :---------------------------------------------------------------------------------------------------------------- |
+| `description` | `string`  | A description of the image.                                                                                       |
+|   `timeout`   | `number`  | (Optional) The duration in milliseconds to wait for the image to appear. Default is `10000` (10 seconds).         |
+|   `invert`    | `boolean` | (Optional) If set to `true`, the command will wait until the specified image is NOT detected. Default is `false`. |
 
 ## Example usage
 

package/docs/commands/wait-for-text.mdx

@@ -18,11 +18,12 @@ The `wait-for-text` command waits until the specified text is detected on the sc
 
 ## Arguments
 
-| Argument  |   Type   | Description                                                                                            |
-| :-------: | :------: | :----------------------------------------------------------------------------------------------------- |
-|  `text`   | `string` | The text to find on the screen.                                                                        |
-| `timeout` | `number` | (Optional) The duration in milliseconds to wait for the text to appear. Default is `5000` (5 seconds). |
-| `method`  |  `enum`  | (Optional) The matching algorithm to use. Possible values are `ai` and `turbo`. Default is `turbo`     |
+| Argument  |   Type    | Description                                                                                                      |
+| :-------: | :-------: | :--------------------------------------------------------------------------------------------------------------- |
+|  `text`   | `string`  | The text to find on the screen.                                                                                  |
+| `timeout` | `number`  | (Optional) The duration in milliseconds to wait for the text to appear. Default is `5000` (5 seconds).           |
+| `method`  |  `enum`   | (Optional) The matching algorithm to use. Possible values are `ai` and `turbo`. Default is `turbo`               |
+| `invert`  | `boolean` | (Optional) If set to `true`, the command will wait until the specified text is NOT detected. Default is `false`. |
 
 ## Example usage
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testdriverai",
-  "version": "6.1.5",
+  "version": "6.1.6",
   "description": "Next generation autonomous AI agent for end-to-end testing of web & desktop",
   "main": "index.js",
   "bin": {

package/schema.json

@@ -474,6 +474,9 @@
               "drag-start",
               "drag-end"
             ]
+          },
+          "invert": {
+            "type": "boolean"
           }
         }
       },
@@ -493,6 +496,9 @@
           },
           "timeout": {
             "type": "integer"
+          },
+          "invert": {
+            "type": "boolean"
           }
         }
       },
@@ -519,6 +525,9 @@
               "ai",
               "turbo"
             ]
+          },
+          "invert": {
+            "type": "boolean"
           }
         }
       },
@@ -555,6 +564,9 @@
               "keyboard",
               "mouse"
             ]
+          },
+          "invert": {
+            "type": "boolean"
           }
         }
       },
@@ -593,6 +605,9 @@
               "keyboard",
               "mouse"
             ]
+          },
+          "invert": {
+            "type": "boolean"
           }
         },
         "anyOf": [
@@ -660,6 +675,9 @@
           },
           "async": {
             "type": "boolean"
+          },
+          "invert": {
+            "type": "boolean"
           }
         }
       },
@@ -1045,4 +1063,4 @@
       }
     }
   }
-}
+}

package/testdriver/acceptance/scroll-until-image.yaml

@@ -19,3 +19,8 @@ steps:
       - command: scroll-until-image
         description: a brown colored house
         direction: down
+
+  - prompt: assert image of brown colored house appears on screen
+    commands:
+      - command: assert
+        expect: image of brown colored house appears on screen