Skip to content

Latest commit

 

History

History
181 lines (134 loc) · 5.79 KB

README.md

File metadata and controls

181 lines (134 loc) · 5.79 KB

Levo Actions

Schema Conformance Action

This action executes an Schema Conformance test and reports results to your Levo organization dashboard.

This action will require you to have a Levo account and provide a target url and OAS schema as well.

Usage

- uses: levoai/actions/schema-conformance@v2
  with:
    # Authorization key required to execute the Levo CLI. Please refer to https://app.levo.ai/settings/keys to get your authorization key.
    authorization-key: ''

    # The ID of your organization in Levo dashboard. Please refer to https://app.levo.ai/settings/organization to get your organization id.
    organization-id: ''

    # URL or file path of the application under test OAS schema.
    schema: ''

    # URL for the instance of the application under test.
    target: ''

    # [OPTIONAL] If you decide not to report the result of this execution back to Saas set this value to false. Default: true.
    report: true

    # [OPTIONAL] Use this option to pass CLI extra arguments like headers or verbosity. Please use \\\˝ to escape quotes.
    cli_extra_args: "-H \\\"Authorization: Bearer 1234\\\" --verbosity INFO"

Output

This action will generate two output fields:

outputs:
  success:
    description: '# of succesful test cases'
  failed:
    description: '# of failed test cases'

Test Plan Action

This action executes a test plan and reports results to your Levo organization dashboard.

This action will require you to have a Levo account and provide a target url and test plan LRN.

Usage

- uses: levoai/actions/test-plan@v2
  with:
    # Authorization key required to execute the Levo CLI. Please refer to https://app.levo.ai/settings/keys to get your authorization key.
    authorization-key: ''

    # The ID of your organization in Levo dashboard. Please refer to https://app.levo.ai/settings/organization to get your organization id.
    organization-id: ''

    # URL for the instance of the application under test.
    target: ''

    # Test plan LRN. You can get this value from the test plan section in Saas.
    plan: ''

    # [OPTIONAL] Base64 encoded environment file content.
    base64_env: ''

    # [OPTIONAL] If you decide not to report the result of this execution back to Saas set this value to false. Default: true.
    report: true

    # [OPTIONAL] Use this option to pass CLI extra arguments like headers or verbosity. Please use \\\˝ to escape quotes.
    cli_extra_args: "-H \\\"Authorization: Bearer 1234\\\" --verbosity INFO"

Output

This action will generate two output fields:

outputs:
  success:
    description: '# of successful test cases'
  failed:
    description: '# of failed test cases'
  skipped:
    description: '# of skipped test cases'

Test Application Action

This action executes tests for an application and reports results to your Levo organization dashboard.

This action will require you to have a Levo account and provide an application LRN, a target url, and user details with which you can access your APIs.

Usage

- uses: levoai/actions/test-application@v2
  with:
    # Authorization key required to execute the Levo CLI. Please refer to https://app.levo.ai/settings/keys to get your authorization key.
    authorization-key: ''

    # The ID of your organization in Levo dashboard. Please refer to https://app.levo.ai/settings/organization to get your organization id.
    organization-id: ''

    # URL for the instance of the application under test.
    target: ''

    # Application LRN. You can get this value from the Apps section in Saas.
    app-lrn: ''

    # [OPTIONAL] Test categories in comma separate string. eg - "BASELINE,SSRF,CORS". Leave it blank to run all categories
    categories: ''

    # [OPTIONAL] Base64 encoded environment file content.
    base64_env: ''

    # [OPTIONAL] If you decide not to report the result of this execution back to Saas set this value to false. Default: true.
    report: true

    # [OPTIONAL] Use this option to pass CLI extra arguments like headers or verbosity. Please use \\\˝ to escape quotes.
    cli_extra_args: "-H \\\"Authorization: Bearer 1234\\\" --verbosity INFO"

Output

This action will generate two output fields:

outputs:
  success:
    description: '# of successful test cases'
  failed:
    description: '# of failed test cases'
  skipped:
    description: '# of skipped test cases'

Scan Repository

This action scans a repository and import results to your Levo-app organization dashboard.

This action will require you to have a Levo account and provide a Authorization Key and Organization ID.

Usage

- uses: levoai/actions/[email protected]
  with:
    # Authorization key required to execute the Levo CLI. Please refer to https://app.levo.ai/settings/keys to get your authorization key.
    authorization-key: ''

    # The ID of your organization in Levo dashboard. Please refer to https://app.levo.ai/settings/organization to get your organization id.
    organization-id: ''
    
    # The name of the application to be created in Levo.
    app-name: ''

    # [Optional] The name of the environment in which app must be created in Levo.
    env-name: ''

Output

This action will create an application in Levo[https://app.levo.ai] and import the results of the scan.