Testing package

@alienplatform/testing deploys your stack from inside a test and returns a handle to the running deployment. Use it for integration tests that exercise real bindings, commands, and HTTP endpoints, locally or in a cloud account.

import { type Deployment, deploy } from "@alienplatform/testing"
import { afterAll, beforeAll, describe, expect, it } from "vitest"

describe("api", () => {
  let deployment: Deployment

  beforeAll(async () => {
    deployment = await deploy({ app: ".", platform: "local" })
  }, 300_000)

  afterAll(async () => {
    await deployment?.destroy()
  })

  it("answers health checks", async () => {
    const response = await fetch(`${deployment.url}/health`)
    expect(response.ok).toBe(true)
  })

  it("runs the get-summary command", async () => {
    const input = { accountId: "acct_1" }
    const result = await deployment.invokeCommand<{ total: number }>("get-summary", input)
    expect(result.total).toBe(0)
  })
})

The package works with any test runner; the example uses Vitest. For test strategy, see Testing.

InstallCopy Anchor Link

npm install --save-dev @alienplatform/testing

The alien CLI must be installed. See Install the CLI.

deploy(options)Copy Anchor Link

Deploys the app and resolves once it is ready.

How each platform deploys:

• local: runs alien dev in the background and waits for its status file to report ready. You need no cloud credentials.
• aws, gcp, azure: builds the stack, creates a release and a deployment through the Alien API, and waits for it to run. Requires ALIEN_API_KEY and cloud credentials for the target account.

DeploymentCopy Anchor Link

Errors from the package are TestingOperationFailedError and TestingUnsupportedPlatformError.

Environment variablesCopy Anchor Link

NextCopy Anchor Link

• Testing: what to test locally and what to test in a real cloud
• Local development
• TypeScript SDK