testdriverai 5.3.1 → 5.3.3

package/agent.js

@@ -461,9 +461,17 @@ const aiExecute = async (message, validateAndLoop = false, dry = false) => {
 
     if (checkCodeblocks.length > 0) {
       logger.debug("check thinks more needs to be done");
+      
+      logger.info(chalk.dim("not done yet!"), "testdriver");
+      logger.info("");
+
       return await aiExecute(response, validateAndLoop);
     } else {
       logger.debug("seems complete, returning");
+
+      logger.info(chalk.green("success!"), "testdriver");
+      logger.info("");
+
       return response;
     }
   }
@@ -1010,10 +1018,25 @@ let runRawYML = async (yml) => {
 
   let decoded = decodeURIComponent(yml);
 
-  // saved the yml to a temp file using tmp
-  // and run it with run()
-  fs.writeFileSync(tmpobj.name, await generator.rawToFormatted(decoded));
+  // parse the yaml
+  let ymlObj = null;
+  try {
+    ymlObj = await yaml.load(decoded);
+  } catch (e) {
+    logger.error("%s", e);
+  }
+
+  // add the root key steps: with array of commands:
+  if (ymlObj && !ymlObj.steps) {
+    ymlObj = {
+      steps: [ymlObj],
+    };
+  }
+
+  // write the yaml to a file
+  fs.writeFileSync(tmpobj.name, yaml.dump(ymlObj));
   
+  // and run it with run()
   await run(tmpobj.name, false, true);
 
 }

package/docs/action/browser.mdx

@@ -2,6 +2,7 @@
 title: "Testing Multiple Browsers"
 sidebarTitle: "Browsers"
 description: "Configure prerun scripts to launch different browsers in TestDriver."
+icon: "chrome"
 ---
 
 ## Overview

package/docs/action/os.mdx

@@ -2,6 +2,7 @@
 title: "Testing Multiple Operating Systems"
 sidebarTitle: "Operating Systems"
 description: "Configuring Operating Systems in TestDriver GitHub Action"
+icon: "windows"
 ---
 
 ## Overview

package/docs/action/output.mdx

@@ -2,6 +2,7 @@
 title: "GitHub Action Output"
 sidebarTitle: "Action Output"
 description: "Understanding and utilizing the output variables from the TestDriver GitHub Action"
+icon: "film"
 ---
 
 ## Overview

package/docs/action/performance.mdx

@@ -2,6 +2,7 @@
 title: "Optimizing Performance in TestDriver"
 sidebarTitle: "Performance Optimization"
 description: "Optimizing Performance in TestDriver"
+icon: "rabbit-running"
 ---
 
 ## Overview

package/docs/action/prerun.mdx

@@ -2,6 +2,7 @@
 title: "Prerun Scripts"
 sidebarTitle: "Prerun Scripts"
 description: "Learn how to customize and set up your TestDriver environment to optimize your CI/CD pipeline."
+icon: "hammer"
 ---
 
 ## Overview

package/docs/action/secrets.mdx

@@ -2,6 +2,7 @@
 title: "Managing Secrets in GitHub Actions"
 sidebarTitle: "Secrets Management"
 description: "Discover how to securely configure and optimize your TestDriver environment for seamless CI/CD workflows."
+icon: "mask"
 ---
 
 ## Overview

package/docs/action/setup.mdx

@@ -2,6 +2,7 @@
 title: "GitHub Action Setup Guide"
 sidebarTitle: "Setup Guide"
 description: "Learn how to set up and configure the TestDriver GitHub Action for automated cloud-based testing in your CI/CD workflows."
+icon: "wrench"
 ---
 
 ## Overview

package/docs/commands/assert.mdx

@@ -1,5 +1,6 @@
 ---
 title: "assert"
+icon: "check"
 ---
 
 ## Description

package/docs/commands/exec.mdx

@@ -1,5 +1,6 @@
 ---
 title: "exec"
+icon: "code"
 ---
 
 ## Description

package/docs/commands/focus-application.mdx

@@ -1,5 +1,6 @@
 ---
 title: "focus-application"
+icon: "window-restore"
 ---
 
 ## Description

package/docs/commands/hover-image.mdx

@@ -1,5 +1,6 @@
 ---
 title: "hover-image"
+icon: "image"
 ---
 
 ## Description

package/docs/commands/hover-text.mdx

@@ -1,5 +1,6 @@
 ---
 title: "hover-text"
+icon: "text"
 ---
 
 ## Description

package/docs/commands/if.mdx

@@ -1,5 +1,6 @@
 ---
 title: "if"
+icon: "code-branch"
 ---
 
 ## Description

package/docs/commands/match-image.mdx

@@ -1,5 +1,6 @@
 ---
 title: "match-image"
+icon: "images"
 ---
 
 ## Description

package/docs/commands/press-keys.mdx

@@ -1,5 +1,6 @@
 ---
 title: "press-keys"
+icon: "keyboard-brightness"
 ---
 
 ## Description

package/docs/commands/run.mdx

@@ -1,5 +1,6 @@
 ---
 title: "run"
+icon: "play"
 ---
 
 ## Description

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

@@ -1,5 +1,6 @@
 ---
 title: "scroll-until-image"
+icon: "scroll"
 ---
 
 ## Description

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

@@ -1,5 +1,6 @@
 ---
 title: "scroll-until-text"
+icon: "scroll"
 ---
 
 ## Description

package/docs/commands/scroll.mdx

@@ -1,5 +1,6 @@
 ---
 title: "scroll"
+icon: "scroll"
 ---
 
 # Command: `scroll`

package/docs/commands/type.mdx

@@ -1,5 +1,6 @@
 ---
 title: "type"
+icon: "keyboard"
 ---
 
 ## Description

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

@@ -1,5 +1,6 @@
 ---
 title: "wait-for-image"
+icon: "hourglass"
 ---
 
 ## Description

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

@@ -1,5 +1,6 @@
 ---
 title: "wait-for-text"
+icon: "hourglass"
 ---
 
 ## Description

package/docs/commands/wait.mdx

@@ -1,5 +1,6 @@
 ---
 title: "wait"
+icon: "hourglass"
 ---
 
 ## Description

package/docs/docs-future.json.txt

@@ -0,0 +1,114 @@
+
+{
+  "group": "Features",
+  "pages": [
+    "/features/selectorless",
+    "/features/generation",
+    "/features/visual-assertions",
+    "/features/auto-healing",
+    "/features/cross-platform",
+    "/features/reusable-snippets",
+    "/features/parallel-testing",
+    "/features/github"
+  ]
+},
+{
+  "tab": "Examples",
+  "groups": [
+    {
+      "group": "Scenarios",
+      "pages": [
+        "cookie-banner",
+        "log-in",
+        "spell-check",
+        "form-filling",
+        "file-upload",
+        "pdf-generation",
+        "ai-chatbot"
+      ]
+    },
+    {
+      "group": "Apps",
+      "pages": [
+        "static-websites",
+        "chrome-extensions",
+        "mobile-apps",
+        "desktop-apps"
+      ]
+    }]
+},
+{
+  "tab": "Integrations",
+  "groups": [
+    {
+      "group": "Buidling",
+      "pages": [
+        "/integrations/vercel",
+        "/integrations/netlify",
+        "/integrations/electron"
+      ]
+    },
+    {
+      "group": "Importing",
+      "pages": [
+        "/importing/testrail",
+        "/importing/jira",
+        "/importing/gherkin",
+        "/importing/csv"
+      ]
+    },
+    {
+      "group": "Exporting",
+      "pages": [
+        "/exploting/playwright"
+      ]
+    },
+    {
+      "group": "Bug Reporting",
+      "pages": [
+        "/bugs/jira"
+      ]
+    }]
+},
+
+
+
+      {
+        "tab": "Guide",
+        "groups": [
+          {
+            "group": "Getting Started",
+            "pages": [
+              "/getting-started/vscode",
+              "/getting-started/setup",
+              "/getting-started/writing",
+              "/getting-started/generating",
+              "/getting-started/running",
+              "/getting-started/ci"
+            ]
+          },
+          {
+            "group": "Writing Tests",
+            "pages": [
+              "/guide/locating",
+              "/guide/waiting",
+              "/guide/assertions",
+              "/guide/variables",
+              "/guide/authentication",
+              "/guide/setup-teardown",
+              "/guide/code"
+            ]
+          },
+          {
+            "group": "Running in CI",
+            "pages": [
+              "/action/setup",
+              "/action/browser",
+              "/action/os",
+              "/action/output",
+              "/action/performance",
+              "/action/prerun",
+              "/action/secrets"
+            ]
+          }]
+      },

package/docs/docs.json

@@ -1,10 +1,10 @@
 {
   "$schema": "https://mintlify.com/docs.json",
-  "theme": "palm",
+  "theme": "mint",
   "name": "TestDriver",
   "colors": {
     "primary": "#b3d334",
-    "light": "#a3a4a0",
+    "light": "#b3d334",
     "dark": "#050d23"
   },
   "favicon": "/images/template/icon.png",
@@ -22,40 +22,17 @@
               "/overview/comparison"
             ]
           },
-          {
-            "group": "Features",
-            "pages": [
-              "/features/selectorless",
-              "/features/generation",
-              "/features/visual-assertions",
-              "/features/auto-healing",
-              "/features/cross-platform",
-              "/features/reusable-snippets",
-              "/features/parallel-testing",
-              "/features/github"
-            ]
-          },
-          {
-            "group": "Security & Privacy",
-            "pages": [
-              "/security/agent",
-              "/security/action",
-              "/security/platform"
-            ]
-          }
-        ]
-      },
-      {
-        "tab": "Guide",
-        "groups": [
           {
             "group": "Getting Started",
             "pages": [
+              "/getting-started/vscode",
               "/getting-started/setup",
-              "/getting-started/writing",
               "/getting-started/generating",
+              "/getting-started/writing",
               "/getting-started/running",
-              "/getting-started/ci"
+              "/getting-started/ci",
+              "/features/auto-healing",
+              "/getting-started/editing"
             ]
           },
           {
@@ -81,65 +58,16 @@
               "/action/prerun",
               "/action/secrets"
             ]
-          }]
-      },
-      {
-        "tab": "Examples",
-        "groups": [
-          {
-            "group": "Scenarios",
-            "pages": [
-              "cookie-banner",
-              "log-in",
-              "spell-check",
-              "form-filling",
-              "file-upload",
-              "pdf-generation",
-              "ai-chatbot"
-            ]
           },
           {
-            "group": "Apps",
-            "pages": [
-              "static-websites",
-              "chrome-extensions",
-              "mobile-apps",
-              "desktop-apps"
-            ]
-          }]
-      },
-      {
-        "tab": "Integrations",
-        "groups": [
-          {
-            "group": "Buidling",
-            "pages": [
-              "/integrations/vercel",
-              "/integrations/netlify",
-              "/integrations/electron"
-            ]
-          },
-          {
-            "group": "Importing",
-            "pages": [
-              "/importing/testrail",
-              "/importing/jira",
-              "/importing/gherkin",
-              "/importing/csv"
-            ]
-          },
-          {
-            "group": "Exporting",
-            "pages": [
-              "/exploting/playwright"
-            ]
-          },
-          {
-            "group": "Bug Reporting",
+            "group": "Security & Privacy",
             "pages": [
-              "/bugs/jira"
+              "/security/agent",
+              "/security/action",
+              "/security/platform"
             ]
-          }]
+          }
+        ]
       },
       {
         "tab": "Reference",
@@ -151,8 +79,8 @@
               "/commands/exec",
               "/commands/focus-application",
               "/commands/hover-image",
-              "/commands/match-image",
               "/commands/hover-text",
+              "/commands/match-image",
               "/commands/if",
               "/commands/press-keys",
               "/commands/run",
@@ -188,13 +116,13 @@
       "anchors": [
         {
           "anchor": "Community",
-          "href": "https://mintlify.com/community",
+          "href": "https://discord.com/invite/cWDFW8DzPm",
           "icon": "discord"
         },
         {
-          "anchor": "Enterprise",
-          "href": "https://mintlify.com/docs",
-          "icon": "book-open-cover"
+          "anchor": "Book a Demo",
+          "href": "https://calendly.com/d/cq23-qyn-3v6/testdriver-ai-demo",
+          "icon": "calendar"
         }
       ]
     }
@@ -208,7 +136,7 @@
     "links": [
       {
         "label": "Support",
-        "href": "mailto:hi@mintlify.com"
+        "href": "https://testdriver.canny.io/testdriver"
       }
     ],
     "primary": {

package/docs/features/auto-healing.mdx

@@ -2,21 +2,14 @@
 title: "Auto-Healing in TestDriver.ai"
 sidebarTitle: "Auto-Healing"
 description: "Learn how TestDriver.ai's auto-healing feature keeps your tests resilient and up-to-date with minimal manual effort."
+icon: "bandage"
 ---
 
-Auto-healing is a powerful feature in TestDriver.ai that ensures your tests remain resilient even when the application under test changes. When text, UI elements, or other visual cues are modified, TestDriver.ai can detect the failure, adapt to the changes, and automatically update the test. It then opens a pull request (PR) with the updated test, ensuring your test suite stays up-to-date with minimal manual intervention.
+Auto-healing is a powerful feature in TestDriver.ai that ensures your tests remain resilient even when the application under test changes. 
 
----
-
-## How Auto-Healing Works
-
-1. **Test Execution**: TestDriver.ai runs your test suite as usual.
-2. **Failure Detection**: If a test fails due to a change in the application (e.g., text or UI updates), the AI identifies the failure point.
-3. **Recovery Attempt**: The AI uses its adaptive capabilities to locate the updated element or text and retries the action.
-4. **Test Update**: If the recovery is successful, TestDriver.ai updates the test script with the new element or text.
-5. **Pull Request Creation**: The updated test script is committed to a new branch, and a pull request is automatically opened in your repository for review.
+When TestDriver steps fail, the AI will progressively fall back to attemp to complete the test.
 
----
+If running on CI, TestDriver will open a pull request (PR) with the updated test, ensuring your test suite stays up-to-date with minimal manual intervention.
 
 ## Benefits of Auto-Healing
 
@@ -25,15 +18,19 @@ Auto-healing is a powerful feature in TestDriver.ai that ensures your tests rema
 - **Continuous Integration**: Keeps your test suite aligned with the latest application changes.
 - **Developer Collaboration**: Automatically opens a PR, allowing developers to review and approve updates.
 
----
+## How Auto-Healing Works
 
-## Example Workflow
+1. **Test Execution**: TestDriver.ai runs your test suite as usual.
+2. **Failure Detection**: If a test fails due to a change in the application (e.g., text or UI updates), the AI identifies the failure point.
+3. **Recovery Attempt**: The AI uses its adaptive capabilities to locate the updated element or text and retries the action.
+4. **Test Update**: If the recovery is successful, TestDriver.ai updates the test script with the new element or text.
+5. **Pull Request Creation**: The updated test script is committed to a new branch, and a pull request is automatically opened in your repository for review.
 
-### Scenario: Button Text Changes from "Submit" to "Send"
+### Example: Button Text Changes from "Submit" to "Send"
 
 1. **Initial Test**:
 
-```yaml
+```yaml {2}
 - command: hover-text
   text: Submit
   description: Submit button in the form
@@ -53,7 +50,7 @@ Auto-healing is a powerful feature in TestDriver.ai that ensures your tests rema
 5. **Test Update**:
   - The test script is updated to reflect the new button text:
   
-  ```yaml
+  ```yaml {2}
   - command: hover-text
     text: Send
     description: Submit button in the form
@@ -65,13 +62,11 @@ Auto-healing is a powerful feature in TestDriver.ai that ensures your tests rema
      - **Branch Name**: `auto-heal-update-submit-to-send`
      - **PR Title**: `Auto-Healed Test: Updated "Submit" to "Send"`
 
----
-
 ## Example GitHub Action for Auto-Healing
 
 Here’s how you can configure a GitHub Action to enable auto-healing and PR creation:
 
-```yaml
+```yaml {24-30} 
 name: TestDriver.ai Auto-Healing
 
 on:
@@ -103,22 +98,8 @@ jobs:
 
 ---
 
-## Best Practices for Auto-Healing
-
-1. **Enable PR Reviews**: Always review auto-healed PRs to ensure the updates align with the intended application behavior.
-2. **Use Descriptive Descriptions**: Provide clear descriptions for elements in your tests to help the AI identify changes more effectively.
-3. **Run Tests Frequently**: Integrate TestDriver.ai into your CI/CD pipeline to catch and heal changes as soon as they occur.
-4. **Monitor Auto-Healing Logs**: Review logs and screenshots provided by TestDriver.ai to understand why a test was updated.
-
----
-
 ## Limitations of Auto-Healing
 
 - **Major UI Overhauls**: Auto-healing is best suited for minor changes (e.g., text updates, small layout adjustments). Significant UI changes may still require manual intervention.
 - **Ambiguous Changes**: If multiple elements match the updated criteria, the AI may require additional context to make the correct decision.
-
----
-
-## Conclusion
-
-Auto-healing in TestDriver.ai reduces the burden of test maintenance by automatically adapting to changes in your application. By leveraging this feature, you can ensure your test suite remains robust and up-to-date, allowing your team to focus on delivering high-quality software.
+- **Step Deletion**: If UI or wizard pages are removed, the AI may not be able to recover. In such cases, manual updates are necessary.