docs(blog): introduce Detox Copilot. #4596
Conversation
|
|
||
| Detox Copilot leverages advanced Large Language Models (LLMs) to interpret natural language instructions and translate them into Detox actions and assertions. This means you can describe your test scenarios in everyday language, aligning perfectly with **Behavior-Driven Development (BDD)** principles. | ||
|
|
||
| ### Why Natural Language Testing? |
There was a problem hiding this comment.
I think we also need to preset the benefits of the reduced maintenance cost (i.e. thanks to the decoupling from specific test ID's, not to mention xpath, etc). Let's try to come up with some examples? It's too important to be overlooked 🤔
| gosha212: | ||
| name: Georgy Steshin | ||
| title: Detox Core Contributor | ||
| url: https://github.com/jonathanmos | ||
| image_url: https://github.com/jonathanmos.png | ||
| url: https://github.com/gosha212 | ||
| image_url: https://github.com/gosha212.png |
|
|
||
| ### Seamless Integration with Detox | ||
|
|
||
| Detox Copilot is built into Detox and requires no additional installation. Simply initialize it in your test setup, and you're ready to start writing natural language tests. |
|
|
||
| Initialize Detox Copilot in your test setup by implementing a `PromptHandler` that connects to your LLM service. This abstraction allows Detox Copilot to communicate with any LLM you choose, promoting versatility across different testing frameworks. | ||
|
|
||
| In our [Testing with Copilot guide](https://wix.github.io/Detox/docs/next/guide/testing-with-copilot), you can find implementation examples and more detailed descriptions for this part. |
There was a problem hiding this comment.
yeah, next/ is the most up-to-date docs (on master). I'll try to use the latest published version instead.
| **Hybrid Example:** | ||
|
|
||
| ```javascript | ||
| it('should add an item to the cart', async () => { |
| const pageTitle = await copilot.perform( | ||
| 'Launch the app', | ||
| 'Navigate to the "Profile" page', | ||
| 'Return the text of the page title' |
There was a problem hiding this comment.
Woah, can't believe this actually works (!)
| ); | ||
|
|
||
| // Use the returned value in a hard-coded assertion | ||
| jestExpect(pageTitle).toBe('Profile'); |
There was a problem hiding this comment.
Hmm isn't this discouraged? I wonder
There was a problem hiding this comment.
hmm, yeahhh.. you're right. not the best example for this ability. smells like a bad practice 😄 . I'll try to come with a better one / remove it
|
|
||
| You can also use Copilot for locating the elements and then use them in your hard-coded assertions. | ||
|
|
||
| **Locating Elements Example:** |
|
|
||
| In our [Testing with Copilot guide](https://wix.github.io/Detox/docs/next/guide/testing-with-copilot), you can find implementation examples and more detailed descriptions for this part. | ||
|
|
||
| ### Step 2: Write Tests Using Natural Language |
There was a problem hiding this comment.
Shouldn't this be a part of the "Testing with CoPilot" guide?
| 'Verify that the product is listed in the cart' | ||
| ); | ||
| }); | ||
| ``` |
There was a problem hiding this comment.
BTW, what about attributes inspection (as prompts)?
- Color assertions
- Element size
Value of progress bar / check-box / etc
Maybe this is a 1st in a whole new set of questions we can ask, IDK
|
+ Need'a update the dir-structure doc |
|
Not directly related of course, but I think we REALLY need to offer the community with out-of-the-box implementations for this... If the goal was to call for contributions on that, then let's voice that more explicitly 💬 
|
No description provided.