Documentation Index
Fetch the complete documentation index at: https://docs.qawolf.com/llms.txt
Use this file to discover all available pages before exploring further.
@qawolf/flows is the wrapper around QA Wolf test code. It tells the runner what to run, where to run it, and which runtime objects to inject.
Most users should start with a launch-enabled flow.
import { expect, flow } from "@qawolf/flows/web";
export default flow(
"Sign in",
{ target: "Web - Chrome", launch: true },
async ({ page }) => {
await page.goto("https://example.com/login");
await page.getByLabel("Email").fill("qa@example.com");
await page.getByRole("button", { name: "Continue" }).click();
await expect(page.getByText("Check your email")).toBeVisible();
},
);
Pick The Entry Point
Import from the package that matches the target you are authoring for.
import { expect, flow } from "@qawolf/flows/web";
import { platform } from "@qawolf/flows";
if (platform.target === "Web - Chrome") {
// Target-specific branch.
}
Start With launch: true
launch: true asks QA Wolf to start the browser or mobile app before your callback runs.
export default flow(
"Open dashboard",
{ target: "Web - Chrome", launch: true },
async ({ page }) => {
await page.goto("https://example.com/dashboard");
},
);
inputs, setOutput(...), and test(...).
When launch is enabled, the callback also receives platform runtime objects:
| Platform | Additional callback parameters |
|---|
| Web browser | page, context, optional browser |
| Web Electron | page |
| Android | driver |
| iOS | driver |
Pass Launch Options In The Definition
If startup needs options and those options are known up front, pass an object to launch.
import { flow } from "@qawolf/flows/web";
export default flow(
"Open account with profile",
{
target: "Web - Chrome",
launch: {
browserContext: "persistent",
userDataDir: "/tmp/qawolf-profile",
},
},
async ({ page }) => {
await page.goto("https://example.com/account");
},
);
page or driver.
Launch Manually For Advanced Flow Control
Pass the target directly and call launch(...) in the callback only when the flow must decide startup at runtime.
import { flow, isElectron, isPersistent, launch } from "@qawolf/flows/web";
export default flow("Open account", "Web - Chrome", async () => {
const useSavedProfile = process.env["USE_SAVED_PROFILE"] === "true";
const launchResult = useSavedProfile
? await launch({
browserContext: "persistent",
userDataDir: "/tmp/qawolf-profile",
})
: await launch();
if (isElectron(launchResult)) throw new Error("Expected browser launch");
const page =
isPersistent(launchResult)
? launchResult.page
: await launchResult.context.newPage();
await page.goto("https://example.com/dashboard");
});
Next Steps
