Stoobly Docs
  • Introduction
  • Use Cases
    • Generate Mock APIs
      • Empower Development
      • Scale API Testing
    • Enable E2E Testing
  • FAQ
    • Recording
    • Mocking
    • Terminology
  • Getting Started
    • Installing the Agent
      • Installation with pipx
      • Installation with Docker
  • Core Concepts
    • Agent
      • Intercept Modes
        • Mocking
        • Recording
      • Lifecycle Hooks
      • Proxy Settings
        • Data Rules
        • Firewall Rules
        • Rewrite Rules
        • Match Rules
    • Context
    • Mock API
      • Request
        • Response
        • Replay History
      • Scenarios
      • Snapshots
      • Fixtures
      • Public Folder
    • Scaffold
      • Service
      • Validation
      • Workflow
  • Guides
    • How to Run the Agent
      • Run with CLI
      • Run with Docker
    • How to Configure the Agent
      • Forward Proxy
        • Enable HTTPS Traffic
      • Reverse Proxy
    • How to Record Requests
      • Recording from the UI
      • Recording from the CLI
      • How to Create Contexts
      • How to Create Scenarios
        • Creating from the UI
        • Creating from the CLI
      • How to Create Requests
      • How to Customize Recordings
        • Customizing with Lifecycle Hooks
    • How to Update Requests
      • Editing from the UI
      • Editing with Snapshots
      • How to Update Scenarios
        • Updating from the UI
        • Updating from the CLI
      • Updating with Replay
        • Replaying from the UI
        • Replaying from the CLI
        • How to Customize Replays
          • Customizing with Lifecycle Hooks
      • Updating with Open API
    • How to Mock APIs
      • How to Enable Mocking
        • Enabling from the UI
        • Enabling from the CLI
      • How to Snapshot Requests
        • Deleting Snapshots
        • Sharing Snapshots
      • How to Use Fixtures
      • How to Customize Mocking
        • Customizing with Lifecycle Hooks
        • Customizing with Request Headers
      • Troubleshooting
    • How to Replay Requests
      • Replay with the UI
      • Replay with the CLI
    • How to Integrate E2E Testing
      • How to Scaffold an App
        • Scaffolding a Service
        • Customizing a Workflow
          • Customizing Container Services
          • Customizing Lifecycle Hooks
          • Customizing Init Scripts
          • Customizing Configure Scripts
          • Customizing Makefile
        • Troubleshooting
      • How to Run a Workflow
        • Running with CLI command
        • Running with Make
        • Troubleshooting
          • Validating
      • How to Stop a Workflow
        • Stopping with CLI command
        • Stopping with Make
      • How to Update a Scaffold
        • Deleting a Service
      • FAQ
  • Developer Guide
    • Installation from Source
    • Submitting Change Requests
    • Releases
  • Experimental
    • Experimental Features
      • Aliases
      • Endpoints
      • API Testing
        • Getting Started
        • Configuration
          • Assign
          • Lifecycle Hooks
          • Trace
      • Optional Components
Powered by GitBook
On this page
  • Prerequisite
  • Steps to Run a Workflow
  • Options

Was this helpful?

  1. Guides
  2. How to Integrate E2E Testing
  3. How to Run a Workflow

Running with CLI command

Prerequisite

Install CA cert with:

stoobly-agent ca-cert install

Steps to Run a Workflow

  1. For each each service that has a hostname, add an entry in /etc/hosts (for Unix based systems) . This will allow DNS resolution to route requests to the local container proxies. Run the following command to add all services:

stoobly-agent scaffold hostname install --workflow <WORKFLOW_NAME>
  • Optionally verify that /etc/hosts is now updated. Here's an example:

##### STOOBLY SCAFFOLD HOSTS BEGIN #####
127.0.0.1 api.sampleapis.com
::1       api.sampleapis.com
##### STOOBLY SCAFFOLD HOSTS END #####
  1. Run the workflow run command in the root of the app directory

stoobly-agent scaffold workflow up <WORKFLOW-NAME> <OPTIONS>

For example:

stoobly-agent scaffold workflow up record --detached
  1. Assuming we have created a service called sampleapis, then after running the command, the following containers will be running:

    1. <WORKFLOW-NAME>-<SERVICE-NAME>.proxy-1

    2. <WORKFLOW-NAME>-gateway.service-1

    3. <WORKFLOW-NAME>-stoobly_ui.service-1

The following shows which containers are expected to be running using docker ps

$ docker ps
CONTAINER ID   IMAGE                        COMMAND                  CREATED          STATUS          PORTS                                                 NAMES
4eb6965fbfa6   record-sampleapis.proxy      "docker-entrypoint.s…"   6 seconds ago    Up 3 seconds    4200/tcp, 8080/tcp                                    record-sampleapis.proxy-1
5c02c177a3bd   nginxproxy/nginx-proxy:1.5   "/app/docker-entrypo…"   6 seconds ago    Up 3 seconds    80/tcp, 0.0.0.0:443->443/tcp, :::443->443/tcp         record-gateway.service-1
01193cb75e03   record-stoobly_ui.service    "docker-entrypoint.s…"   6 seconds ago    Up 3 seconds    0.0.0.0:4200->4200/tcp, :::4200->4200/tcp, 8080/tcp   record-stoobly_ui.service-1
  1. To learn more about workflows, see:

Options

To see what options are available:

stoobly-agent scaffold workflow up -h
PreviousHow to Run a WorkflowNextRunning with Make

Last updated 23 days ago

Was this helpful?

Workflow