Labsco
mastra-ai logo

mastra-smoke-test

25,800

by mastra-ai · part of mastra-ai/mastra

Smoke test Mastra projects locally or deploy to staging/production. Tests Studio UI, agents, tools, workflows, traces, memory, and more. Supports both local…

🔥🔥🔥✓ VerifiedFreeQuick setup
🧰 Not standalone. This skill ships with mastra-ai/mastra and only works together with that tool — install the tool first, then add this skill.

Smoke test Mastra projects locally or deploy to staging/production. Tests Studio UI, agents, tools, workflows, traces, memory, and more. Supports both local…

Inspect the full instructions your agent will receiveExpand

This is the exact playbook injected into your agent when the skill activates — shown here so you can audit it before installing. You don't need to read it to use the skill.


name: mastra-smoke-test description: Smoke test Mastra projects locally or deploy to staging/production. Tests Studio UI, agents, tools, workflows, traces, memory, and more. Supports both local development and cloud deployments.

Mastra Smoke Test

Comprehensive smoke testing for Mastra projects.

Release smoke workflows

Use progressive disclosure: stay in this file until the workflow branches, then read only the reference for the branch you are on. references/release-smoke.md is a short index if you need the full map.

Alpha release branch point

Before alpha smoke testing, identify the alpha versioning PR state. Prefer the standard Changesets release branch:

Copy & paste — that's it
gh pr view changeset-release/main \
  --json number,title,state,url,headRefName,baseRefName,isDraft,mergeable,reviewDecision,updatedAt,mergedAt,mergeCommit

Expected shape:

Copy & paste — that's it
title: chore: version packages (alpha)
head: changeset-release/main
base: main

If that branch lookup fails, search open and recently merged PRs:

Copy & paste — that's it
gh pr list --state open --search 'version packages alpha in:title' --limit 20
gh pr list --state merged --search 'version packages alpha in:title' --limit 20

Then branch:

  • If the versioning PR is open, read references/alpha-versioning-pr.md.
  • If the versioning PR is merged, read references/alpha-publish.md.
  • If no versioning PR exists, report that and wait for the scheduled alpha versioning flow or user direction.

Do not create the alpha smoke-test project until the automatic alpha publish workflow has completed and the intended packages are installable.

Stable release branch point

If the user is running the stable/full release workflow, read references/stable-release-smoke.md. If that workflow fails after some packages publish, switch to references/stable-partial-publish-recovery.md.

Scope and targeted checks

After the release package is published and before running smoke tests, read references/release-scope-discovery.md to identify changed features. Use the default generated project for the baseline checklist, then add targeted checks for changed features the generated project does not exercise.

When scope discovery identifies a branch:

  • For general changed-feature coverage, read references/targeted-feature-smoke.md.
  • For storage/provider schema or migration changes, read references/storage-provider-migration-smoke.md.

⚠️ Mandatory Test Checklist

Use task_write to track progress. Run ALL tests unless --test specifies otherwise.

Do not skip tests unless you hit an actual blocker. "Seemed complex" or "wasn't sure" are not valid reasons. Attempt everything - only stop a test when you literally cannot proceed. Report what you tried and what blocked you.

#TestReferenceWhen Required
1Setupreferences/tests/setup.mdAlways
2Agentsreferences/tests/agents.md--test agents or full
3Toolsreferences/tests/tools.md--test tools or full
4Workflowsreferences/tests/workflows.md--test workflows or full
5Tracesreferences/tests/traces.md--test traces or full
6Scorersreferences/tests/scorers.md--test scorers or full
7Memoryreferences/tests/memory.md--test memory or full
8MCPreferences/tests/mcp.md--test mcp or full
9Errorsreferences/tests/errors.md--test errors or full
10Studio Deployreferences/tests/studio.md--test studio (cloud only)
11Server Deployreferences/tests/server.md--test server (cloud only)

Execution Flow

  1. Read the reference file for each test you're about to run
  2. Execute the steps in that reference file
  3. Mark the test complete before moving to the next

Partial Testing (--test)

If --test is provided:

  1. Always run Setup (step 1)
  2. Run only the specified test(s)
  3. Skip other tests

Example: --test agents,traces → Run steps 1, 2, and 5 only.

Local Studio Browser Smoke

For local release smoke tests, do both API/curl checks and a Studio browser pass unless --skip-browser is explicitly requested or browser access is genuinely blocked. API checks prove runtime endpoints work; browser checks prove the Playground/Studio UI can load, submit forms, and display results.

Before opening the browser:

  1. Confirm the dev server is alive on the expected port:

    Copy & paste — that's it
    curl -s -o /dev/null -w '%{http_code}\n' http://localhost:4111
    lsof -i :4111 || true
  2. If the process died, restart it from the generated project and wait for readiness:

    Copy & paste — that's it
    cd "$SMOKE_DIR/smoke-project"
    pnpm run dev > "$SMOKE_DIR/logs/dev-server-browser.log" 2>&1 &
    
    for i in {1..60}; do
      code=$(curl -s -o /dev/null -w '%{http_code}' http://localhost:4111 || true)
      [ "$code" = 200 ] && break
      sleep 1
    done
  3. Use browser tools to navigate to http://localhost:4111. If networkidle times out but domcontentloaded succeeds and the UI is usable, continue and note the timeout.

Recommended browser task list:

Copy & paste — that's it
1. Verify Studio shell loads
2. Smoke test agent chat UI
3. Smoke test tools UI
4. Smoke test workflows UI
5. Smoke test observability, scorers, and MCP pages
6. Report browser smoke results

Run these page checks:

AreaRouteWhat to verify
Studio shell/ or /agentsSidebar/nav visible, Mastra version visible, no crash/error overlay
Agents/agents → agent chatAgent list shows expected agent, chat input is visible, sending What's the weather in Tokyo? returns a coherent response, tool call badge/result appears when expected
Tools/tools → tool detailTool list shows get-weather, input form renders, submitting a city such as Paris displays JSON result with weather fields
Workflows/workflows → workflow detailWorkflow list shows weather-workflow, graph/details render, running with a city such as Berlin completes as success, steps show timings/output controls
Traces/observabilityRecent agent/workflow traces appear, including runs triggered during the browser pass
Scorers/scorersRegistered scorers appear with names/descriptions, e.g. Tool Call Accuracy, Completeness, Translation Quality
MCP/mcpsPage loads. Empty state is a pass for default templates: No MCP Servers yet

If a browser interaction does not expose enough text in the accessibility snapshot, inspect document.body.innerText or take a screenshot, then record the visible evidence. Do not rely only on API output for browser smoke.

Append browser results to $SMOKE_DIR/smoke-report.md with a separate section, for example:

Copy & paste — that's it

## Studio Browser Smoke Results

| Area         | Result | Evidence                                                          |
| ------------ | ------ | ----------------------------------------------------------------- |
| Studio shell | PASS   | Browser loaded localhost:4111; sidebar/nav visible; version shown |
| Agents UI    | PASS   | Weather Agent chat returned Tokyo weather and displayed tool call |
| Tools UI     | PASS   | get-weather form returned Paris weather JSON                      |
| Workflows UI | PASS   | weather-workflow Berlin run completed as success                  |
| Traces UI    | PASS   | Recent agent/workflow traces listed                               |
| Scorers UI   | PASS   | Expected scorers listed                                           |
| MCP UI       | PASS   | Expected empty MCP state shown                                    |

Call out separately whether browser smoke was local Studio only or cloud Studio/deployed server.


Multi-Environment Support

One project can target all environments using separate config files:

EnvironmentConfig FileWhat Happens
LocalN/Apnpm dev → localhost:4111
Staging.mastra-project-staging.jsonDeploys to staging.mastra.cloud
Production.mastra-project.jsonDeploys to mastra.cloud

See references/tests/setup.md for setup details.

Parameters

ParameterRequiredDefaultDescription
--envYes-local, staging, production
--directory*~/mastra-smoke-testsParent dir for new project
--name*-Project name
--existing-project*-Path to existing project
--tagNolatestVersion tag (e.g., alpha)
--pmNopnpmPackage manager
--llmNoopenaiLLM provider
--dbNolibsqlStorage: libsql, pg, turso
--testNo(full)Specific test(s) to run
--browser-agentNofalseAdd browser agent
--skip-browserNofalseCurl-only (no browser UI)
--byokNofalseTest bring-your-own-key

* Either --directory + --name OR --existing-project required

Test Options (--test)

OptionDescriptionEnvironments
agentsAgent page and chatAll
toolsTools page and executionAll
workflowsWorkflows page and runAll
tracesObservability/tracesAll
scorersEvaluation/scorers pageAll
memoryConversation persistenceAll
mcpMCP servers pageAll
errorsError handlingAll
studioStudio deploy onlyCloud
serverServer deploy onlyCloud

References

FilePurpose
references/tests/*.mdDetailed steps for each mandatory test
references/release-smoke.mdShort release-smoke reference index
references/alpha-versioning-pr.mdOpen alpha versioning PR readiness
references/alpha-publish.mdMerged alpha PR publish verification
references/stable-release-smoke.mdStable publish and final stable smoke
references/stable-partial-publish-recovery.mdPartial stable publish recovery
references/release-scope-discovery.mdRelease PR scope discovery and planning
references/targeted-feature-smoke.mdTargeted changed-feature smoke patterns
references/storage-provider-migration-smoke.mdStorage/provider migration smoke pattern
references/local-setup.mdLocal dev server setup
references/cloud-deploy.mdCloud deploy details
references/cloud-advanced.mdBYOK, storage testing
references/common-errors.mdTroubleshooting
references/gcp-debugging.mdInfrastructure debugging
references/architecture.mdSmoke-test architecture notes
references/environment-variables.mdEnvironment variable setup
scripts/test-server.shServer API test script
scripts/discover-release-scope.shRelease PR scope discovery
scripts/check-versioning-pr.shAlpha versioning PR spot-check helper

Platform Dashboards

  • Production: https://projects.mastra.ai
  • Staging: https://projects.staging.mastra.ai

For Gateway API testing (memory, threads, BYOK via gateway), use platform-smoke-test.

Result Reporting

After testing, provide:

Copy & paste — that's it

## Smoke Test Results

**Environment**: local/staging/production
**Project**: <name>

| Test   | Status | Notes |
| ------ | ------ | ----- |
| Setup  | ✅/❌  |       |
| Agents | ✅/❌  |       |
| Tools  | ✅/❌  |       |
| ...    |        |       |

**Issues Found**: (list any)
**Warnings**: (list any deploy/runtime warnings)
**Skipped Tests**: (list with reason - e.g., "Server Deploy - not applicable in local environment")