A collection of +180 reusable WebAssembly modules for building composable CI/CD pipelines with FluentCI fluentci.io/modules
7.8 kB · 223 lines
Markdown
at main

Playwright #

Native WebAssembly component written in PureScript. Requires FluentCI v0.17.3+. Function signatures and argument descriptions come from the compiled PureScript source and are embedded in the component; no raw JSON plugin input is required.

Usage #

fluentci run playwright test --project . --run-dir .fluentci/runs/playwright-001
fluentci run playwright --help
fluentci run playwright test --help

See COMPONENT.md for every named argument, description, required flag, and return type. The schema describes the same contract. Optional values retain the native module defaults. Lists use JSON array syntax; boolean arguments accept switches. Native function/flag names use kebab-case.

Requirements and behavior #

Install Node.js and @playwright/test in your test project. Add its node_modules/.bin to the host PATH or set executable to the absolute path of node_modules/.bin/playwright. testProject selects a Playwright test project; project selects the local working directory. Use install to download matching browsers and install_deps for system dependencies. Official browser support is limited to supported Linux, macOS, and Windows versions; the module rejects Windows hosts and does not provide BSD browser builds. Tests default to headless execution. Test reports, traces, and screenshots go to Playwright-configured paths under project, separate from the execution report in runDir.

The return value is a typed record containing outcome, run-dir, report-path, stdout-path, and stderr-path. Each invocation needs a fresh run directory. Native command failures, cancellation, and timeouts fail the component call. Use --artifacts '["package=dist/package.zip"]' to declare output files for the execution report. Authentication stays in native configuration or host environment.

Development #

From this module directory, with Node.js, Bun, PureScript, and Spago installed:

bun install --cwd ../../lib/component --frozen-lockfile
npm ci
npm run build
npm test

dist/plugin.wasm is the native component; dist/fluentci.metadata.json is its checksummed contract sidecar. The CJS bundles and legacy-entry.mjs exist only for private regression tests and are not the published module interface.

See the component migration guide and MIT License.

Setup component dependency #

This module declares setup-playwright as typed native component dependencies. FluentCI v0.17.3+ resolves their source references while building and composes them into the published Wasm. Consumers need no relative source paths. Available tools are reused; missing prerequisites invoke setup with default arguments. Explicit executable overrides remain caller-managed. Configure pinned versions or privileged/custom installations in an earlier setup step. See dependency behavior and publishing for command-specific prerequisites, validation, credential skips, and CI coverage.

Compose this module from code #

Requires FluentCI 0.17.6 or newer for generated pipeline bindings. From your caller module's directory, add the dependency:

fluentci add playwright --path /path/to/fluentci-modules/testing/playwright

For a published module, use fluentci add @fluentci.io/playwright@VERSION with an available version. Commit the caller's manifest and lockfile. FluentCI generates named bindings from the installed component's WIT; no handwritten FFI or CLI subprocess is needed. Include generated source directories in the caller's SDK project. The callee can use a different SDK from the caller.

Run Playwright Test headlessly, optionally filtering projects and tests.

Replace the sample organization, paths and identifiers with your own. Configure credentials through your CI secret provider before running authenticated operations. Optional arguments use the callee's defaults, and public list fields use comma-separated strings. See COMPONENT.md for argument descriptions and return types.

These examples use the generated composition API and builder chaining in FluentCI 0.17.6; full cross-SDK compilation and execution coverage is still pending. See composition support and limitations.

PureScript #

module Main where

import Prelude
import Effect (Effect)
import FluentCI.Flow as Flow
import FluentCI.Modules.Playwright as Playwright

run :: Effect String
run =
  Flow.pipeline "playwright-test"
    # Flow.workdir "."
    # Playwright.test (Playwright.testArgs)
    # Flow.map (\result -> result.reportPath)
    # Flow.run

Gleam #

import fluentci/flow
import fluentci_modules/playwright

pub fn run() -> String {
  flow.pipeline("playwright-test")
  |> flow.workdir(".")
  |> playwright.test(playwright.test_args())
  |> flow.map(fn(result) { result.report_path })
  |> flow.run
}

Use Gleam's JavaScript target for the Wasm guest. BEAM escripts used for repository automation are separate from component guests.

Elixir #

defmodule Main do
  use FluentCI.Plugin
  alias FluentCI.Flow
  alias FluentCI.Modules.Playwright

  defplugin run do
    Flow.pipeline("playwright-test")
    |> Flow.workdir(".")
    |> Playwright.test(%{})
    |> Flow.stdout()
  end
end

Elixir compiles this sequence to Rust/Wasm. Its initial Flow API does not yet provide the typed result callbacks or cleanup combinators of the other examples.

ClojureScript #

(ns main.plugin
  (:require [fluentci.flow :as flow]
            [fluentci-modules.playwright :as playwright]))

(defn run []
  (-> (flow/pipeline "playwright-test")
      (flow/workdir ".")
      (playwright/test {})
      flow/run!))

ReScript #

let run = (): string =>
  Flow.pipeline("playwright-test")
  ->Flow.workdir(".")
  ->FluentciModulesPlaywright.test(FluentciModulesPlaywright.testArgs)
  ->Flow.map(result => result.reportPath)
  ->Flow.run

Python #

from fluentci.flow import pipeline
from fluentci_modules import playwright


def run() -> str:
    return (
        pipeline("playwright-test")
        .workdir(".")
        .pipe(playwright.test, {})
        .map(lambda result: result.report_path)
        .run()
    )

TypeScript #

import * as flow from "./fluentci_modules/flow";
import * as playwright from "./fluentci_modules/playwright/index";

export function run(): string {
  return flow.pipeline("playwright-test")
    .workdir(".")
    .pipe(playwright.test, {})
    .map(result => result.reportPath)
    .run();
}

Python and TypeScript use FluentCI builder chains: .pipe(module.function, args) composes generated module functions with .workdir, .env, and .exec. Functions return a pipeline carrying their typed result. Use a generated result callback (With/_with, or a callback argument in TypeScript/Python) when a later module needs a preceding result; use Flow's map operation to select a result field. Execution begins at run (or the Elixir plugin terminal), in declared order.

Exported functions #

Function Purpose
run Execute arbitrary literal CLI arguments.
version Print the CLI version.
setup Install the test framework in project using Bun. Browser binaries are installed separately with install.
test Run Playwright Test headlessly, optionally filtering projects and tests.
list List matching tests without launching browsers.
install Install browser binaries matching the installed Playwright package.
install_deps Install operating-system browser dependencies; may require elevated privileges.