Validating a Workflow

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

Background

Validation

Command

stoobly-agent scaffold validate workflow --app-dir-path <APP-DIR-PATH> <WORKFLOW-NAME>

Arguments

<WORKFLOW-NAME>

Name of the Stoobly workflow you want to validate. The default ones included are:

  • mock

  • record

  • test

Options

--app-dir-path

path to the directory where your scaffolded application is.

Example

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

In this example, we set app-dir-path to a directory which has the application and then specify the workflow name to be "record".

This will then run the test suite and output the results. Here's an example of all the tests passing:

Validating workflow: record
Validating core components: ['build', 'entrypoint', 'stoobly-ui', 'gateway']
Validating core component: gateway
Validating detached for: record-gateway.service-1
Validating core component: stoobly-ui
Validating setup containers: record-build.init-1, record-build.configure-1
Validating core component: entrypoint

Validating service: local-service
Validating hostname: http://local-service.com
Validating setup containers: record-local-service.init-1, record-local-service.configure-1
Skipping validating fixtures folder in workflow: record, container: record-local-service.init-1
Validating proxy container: record-local-service.proxy-1
Skipping validating fixtures folder in workflow: record, container: record-local-service.proxy-1
Validating local user defined service: local-service

Validating service: external-service
Validating hostname: http://http.badssl.com
Validating setup containers: record-external-service.init-1, record-external-service.configure-1
Skipping validating fixtures folder in workflow: record, container: record-external-service.init-1
Validating proxy container: record-external-service.proxy-1
Skipping validating fixtures folder in workflow: record, container: record-external-service.proxy-1

As you can see, the test suite verifies that all of the core components and stoobly-agent proxy containers are working. These are included and managed for you.

Then your services get verified to ensure they are working as expected.

This means that when you record requests for your services, it should work!

Last updated