Smoke Test

Getting Started

Getting Started

CLI Command

Skyramp Generate Command - Integration Testing

% skyramp generate integration rest -h
Generate integration tests for REST protocol

Usage:
skyramp generate integration rest <endpoint_url> --trace <path-to-trace> [flags]
skyramp generate integration rest <endpoint_url> --api-schema <path-to-spec> [flags]
skyramp generate integration rest --help

Arguments:
endpoint_url                       Test is created for this endpoint url

Examples:
skyramp generate integration rest https://skyramp.dev/api/products --api-schema openapi_schema.json

Input Flags:
       --api-schema                     Path to OpenAPI specification
       --exclude                        Comma-separated list of svc/alias/FQDN to exclude from trace collection or test generation from trace
       --include                        Comma-separated list of svc/alias/FQDN to only include in trace collection or test generation from trace
       --request-data                   Sample request data as JSON/YAML blob or @path to a file
       --trace                          Path to trace file from Skyramp worker

Param Flags:
       --auth-header                    Authorization header type
       --form-params                    Form parameters for POST methods
       --path-params                    Comma-separated list of path parameters

Output Flags:
       --deploy-dashboard               Deploy the Skyramp dashboard for test result collection [default = false]
       --framework                      Testing framework for generated test [junit, playwright, pytest, robot] [default = pytest]
       --language                       Language for generated test [java, javascript, python, typescript] [default = python]
       --output                         Generated test name
       --output-dir                     Location to write generated tests
       --overwrite                      Overwrite existing tests without additional confirmation [default = false]

Runtime Flags:
       --docker-network                 Docker network for skyramp worker [default = skyramp]
       --docker-skyramp-port            Docker port for skyramp worker [default = 35142]
  -k,  --insecure                       Skip ssl server verification [default = false]
       --k8s-config                     Path to relevant k8s kubeconfig [default = /Users/koljaheck/.kube/config]
       --k8s-context                    Relevant context, if multiple contexts are specified in kubeconfig
       --k8s-namespace                  Namespace to deploy skyramp worker
       --runtime                        Environment where test should run [docker, k8s, local]

Inherited Flags:
  -h, --help   Show help for command and list available subcommands

Skyramp Generate Command - Integration Testing

% skyramp generate integration rest -h
Generate integration tests for REST protocol

Usage:
skyramp generate integration rest <endpoint_url> --trace <path-to-trace> [flags]
skyramp generate integration rest <endpoint_url> --api-schema <path-to-spec> [flags]
skyramp generate integration rest --help

Arguments:
endpoint_url                       Test is created for this endpoint url

Examples:
skyramp generate integration rest https://skyramp.dev/api/products --api-schema openapi_schema.json

Input Flags:
       --api-schema                     Path to OpenAPI specification
       --exclude                        Comma-separated list of svc/alias/FQDN to exclude from trace collection or test generation from trace
       --include                        Comma-separated list of svc/alias/FQDN to only include in trace collection or test generation from trace
       --request-data                   Sample request data as JSON/YAML blob or @path to a file
       --trace                          Path to trace file from Skyramp worker

Param Flags:
       --auth-header                    Authorization header type
       --form-params                    Form parameters for POST methods
       --path-params                    Comma-separated list of path parameters

Output Flags:
       --deploy-dashboard               Deploy the Skyramp dashboard for test result collection [default = false]
       --framework                      Testing framework for generated test [junit, playwright, pytest, robot] [default = pytest]
       --language                       Language for generated test [java, javascript, python, typescript] [default = python]
       --output                         Generated test name
       --output-dir                     Location to write generated tests
       --overwrite                      Overwrite existing tests without additional confirmation [default = false]

Runtime Flags:
       --docker-network                 Docker network for skyramp worker [default = skyramp]
       --docker-skyramp-port            Docker port for skyramp worker [default = 35142]
  -k,  --insecure                       Skip ssl server verification [default = false]
       --k8s-config                     Path to relevant k8s kubeconfig [default = /Users/koljaheck/.kube/config]
       --k8s-context                    Relevant context, if multiple contexts are specified in kubeconfig
       --k8s-namespace                  Namespace to deploy skyramp worker
       --runtime                        Environment where test should run [docker, k8s, local]

Inherited Flags:
  -h, --help   Show help for command and list available subcommands

Skyramp Generate Command - Integration Testing

% skyramp generate integration rest -h
Generate integration tests for REST protocol

Usage:
skyramp generate integration rest <endpoint_url> --trace <path-to-trace> [flags]
skyramp generate integration rest <endpoint_url> --api-schema <path-to-spec> [flags]
skyramp generate integration rest --help

Arguments:
endpoint_url                       Test is created for this endpoint url

Examples:
skyramp generate integration rest https://skyramp.dev/api/products --api-schema openapi_schema.json

Input Flags:
       --api-schema                     Path to OpenAPI specification
       --exclude                        Comma-separated list of svc/alias/FQDN to exclude from trace collection or test generation from trace
       --include                        Comma-separated list of svc/alias/FQDN to only include in trace collection or test generation from trace
       --request-data                   Sample request data as JSON/YAML blob or @path to a file
       --trace                          Path to trace file from Skyramp worker

Param Flags:
       --auth-header                    Authorization header type
       --form-params                    Form parameters for POST methods
       --path-params                    Comma-separated list of path parameters

Output Flags:
       --deploy-dashboard               Deploy the Skyramp dashboard for test result collection [default = false]
       --framework                      Testing framework for generated test [junit, playwright, pytest, robot] [default = pytest]
       --language                       Language for generated test [java, javascript, python, typescript] [default = python]
       --output                         Generated test name
       --output-dir                     Location to write generated tests
       --overwrite                      Overwrite existing tests without additional confirmation [default = false]

Runtime Flags:
       --docker-network                 Docker network for skyramp worker [default = skyramp]
       --docker-skyramp-port            Docker port for skyramp worker [default = 35142]
  -k,  --insecure                       Skip ssl server verification [default = false]
       --k8s-config                     Path to relevant k8s kubeconfig [default = /Users/koljaheck/.kube/config]
       --k8s-context                    Relevant context, if multiple contexts are specified in kubeconfig
       --k8s-namespace                  Namespace to deploy skyramp worker
       --runtime                        Environment where test should run [docker, k8s, local]

Inherited Flags:
  -h, --help   Show help for command and list available subcommands

© 2025 Skyramp, Inc. All rights reserved.

© 2025 Skyramp, Inc. All rights reserved.

© 2025 Skyramp, Inc. All rights reserved.