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
  • Background
  • Command
  • Arguments
  • Options
  • Example

Was this helpful?

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

Validating

PreviousTroubleshootingNextHow to Stop a Workflow

Last updated 2 days ago

Was this helpful?

Scaffold validate is a stoobly-agent CLI command used to validate application workflows.

Background

Command

stoobly-agent scaffold workflow validate <WORKFLOW-NAME>

Arguments

<WORKFLOW-NAME>

Name of the Stoobly workflow you want to validate. Workflows available by default:

  • mock

  • record

  • test

Options

--app-dir-path

path to the directory where your scaffolded application is.

Example

In this example, we have created our scaffolded application in ./app and are looking to validate the record workflow. The record workflow comprises of two services called example-service and example-custom-container-service. Our goal with the following command is to ensure that application is ready for recording requests.

$ stoobly-agent scaffold workflow validate --app-dir-path ./app record

After running a series of checks and collecting the results, here's an example output:

Validating workflow: record

Validating core services: ['build', 'entrypoint', 'stoobly-ui', 'gateway']
Validating core service: gateway
Validating core service: stoobly-ui
Validating setup containers: record-build.init-1, record-build.configure-1
Validating core service: entrypoint
✔ Done validating core services for workflow: record, success!

Validating service: example-service
Validating hostname: example.com
Validating hostname exists in hosts file for hostname: example.com
Correct hosts mapping found for example.com
Validating connection to hostname: example.com, port: 443
Validating setup containers: record-example-service.init-1, record-example-service.configure-1
Skipping validating public folder in workflow: record, container: record-example-service.init-1
Validating proxy container: record-example-service.proxy-1
Skipping validating public folder in workflow: record, container: record-example-service.proxy-1
✔ Done validating service: example-service, success!

Validating service: example-custom-container-service
Validating hostname: example-custom-container-service.com
Validating hostname exists in hosts file for hostname: example-custom-container-service.com
Correct hosts mapping found for example-custom-container-service.com
Validating connection to hostname: example-custom-container-service.com, port: 80
Validating setup containers: record-example-custom-container-service.init-1, record-example-custom-container-service.configure-1
Skipping validating public folder in workflow: record, container: record-example-custom-container-service.init-1
Validating proxy container: record-example-custom-container-service.proxy-1
Skipping validating public folder in workflow: record, container: record-example-custom-container-service.proxy-1
Validating local user defined service: example-custom-container-service
✔ Done validating service: example-custom-container-service, success!

✔ Done validating Stoobly scaffold and services, success!
Validation