Flow driven testing library

Library for creating flow base integration tests

Getting Started

Build Status

Usage

Install the package:

pnpm add @elliemae/flow-driven-testing

Development

To start development locally:

pnpm run setup      # Clean and install all dependencies
pnpm run build      # Build the project

To lint and auto-fix code style issues:

pnpm run lint:fix

To generate and preview documentation locally:

pnpm run docs:start

Example Test Creation with FlowRunner

import { FlowRunner } from '@elliemae/flow-driven-testing';

class MyTestRunner extends FlowRunner {
  // Implement required methods
  async mountApp() {
    // Mount or Render your application here
  }

  async init() {
    // Any Application initialization logic before flows run
  }

  get flows() {
    // Return your flow definitions here
    return {
      // flowName: flowDefinition
    };
  }
}

// Running the Test
new MyTestRunner();

Flow Overview

Documentation

For detailed API documentation, see the Documentation Portal. The portal provides comprehensive documentation for every public method and API exposed by library