Skip to main content

CLI for Rungutan - the first API Load Testing SaaS platform worldwide, 100% Serverless, which helps you simulate workflows to emulate user experience, so it's easier to design workflow oriented strategies.

Project description

rungutan-cli

What is Rungutan?

Rungutan is the first API Load Testing SaaS platform worldwide, 100% Serverless, which helps you simulate workflows to emulate user experience, so it's easier to design workflow oriented strategies.

Why use the CLI?

This CLI has been designed for:

  1. perform load testing directly within a CI/CD process
  2. run any command that you would do on the web platform directly in your terminal

How to install the CLI?

pip install rungutan

How to run the CLI?

  • Set up your authentication mechanism using the Rungutan API key
rungutan configure (--profile some-profile-name)
  • Check the overall help menu
$ rungutan help

usage: rungutan <command> [<args>]

To see help text, you can run:
    rungutan help
    rungutan configure --help
    rungutan domain --help
    rungutan team --help
    rungutan results --help
    rungutan tests --help
    rungutan crons --help

Rungutan CLI utility for interacting with https://rungutan.com

positional arguments:
  command     Command to run

optional arguments:
  -h, --help  show this help message and exit
  • Check the help menu for a specific command
$ rungutan domain --help
usage: rungutan [-h] [--domain_name DOMAIN_NAME] [-p PROFILE]
                [{list,validate,remove,add}]

Domain command system

positional arguments:
  {list,validate,remove,add}

optional arguments:
  -h, --help            show this help message and exit
  --domain_name DOMAIN_NAME
                        Required parameter for subcommand ["validate",
                        "remove", "add"]
  -p PROFILE, --profile PROFILE
                        The profile you'll be using. If not specified, the
                        "default" profile will be used. If no profiles are
                        defined, the following env variables will be checked:
                        * RUNGUTAN_TEAM_ID * RUNGUTAN_API_KEY
  • Actually run a command
$ rungutan domain list
{
    "Domains": [
        {
            "domain_name": "rungutan.com",
            "domain_state": "validated",
            "validation_method": "DNS",
            "submitted_date": "2020-01-22T09:43:08Z",
            "validated_date": "2020-01-22T09:46:19Z",
            "validation_code": "AQICAHhHp5r6gwXOjYqwtC9i+eAkDkjIWY6fFcvReCnBELkoNQE9gtS6zGZytyLbOH36UN9nAAAAZjBkBgkqhkiG9w0BBwagVzBVAgEAMFAGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQMEaZoxNmA88dZOjH1AgEQgCPHSkRXDs7qGl6lpEqoqA/K0deoSpuhveJihfstbYgTz6nQRg=="
        }
    ]
}

Run it as a docker container

  • Using local volume
$ docker run \
  -v ${HOME}/.runtugan:/root/.rungutan \
  rungutancommunity:rungutan-cli "rungutan tests --help"
usage: rungutan [-h] [--test_id TEST_ID] [--test_file TEST_FILE]
                [--test_public {public,private}] [--test_name TEST_NAME]
                [--wait_to_finish] [-p PROFILE]
                [{list,add,cancel,get,preview-credits,set-sharing}]

Tests command system

positional arguments:
  {list,add,cancel,get,preview-credits,set-sharing}

optional arguments:
  -h, --help            show this help message and exit
  --test_id TEST_ID     Required parameter for subcommand ["cancel", "get",
                        "set-sharing"]. Optional parameter for subcommand
                        ["list"]
  --test_file TEST_FILE
                        Required parameter for subcommand ["add", "preview-
                        credits"]
  --test_public {public,private}
                        Required parameter for subcommand ["set-sharing"]
  --test_name TEST_NAME
                        Optional parameter for subcommand ["add", "preview-
                        credits"]. Use it to override the value for
                        "test_name" in your test_file or to simply specify a
                        name for the test
  --wait_to_finish      Optional parameter for subcommand ["add"] Use it to
                        set the CLI to wait for the test to finish before
                        exiting.
  -p PROFILE, --profile PROFILE
                        The profile you'll be using. If not specified, the
                        "default" profile will be used. If no profiles are
                        defined, the following env variables will be checked:
                        * RUNGUTAN_TEAM_ID * RUNGUTAN_API_KEY
  • Or using environment variables
$ docker run \
  -e RUNGUTAN_TEAM_ID=my_team \
  -e RUNGUTAN_API_KEY=my_api_key \
  rungutancommunity:rungutan-cli "rungutan domain --help"
usage: rungutan [-h] [--domain_name DOMAIN_NAME] [-p PROFILE]
                [{list,validate,remove,add}]

Domain command system

positional arguments:
  {list,validate,remove,add}

optional arguments:
  -h, --help            show this help message and exit
  --domain_name DOMAIN_NAME
                        Required parameter for subcommand ["validate",
                        "remove", "add"]
  -p PROFILE, --profile PROFILE
                        The profile you'll be using. If not specified, the
                        "default" profile will be used. If no profiles are
                        defined, the following env variables will be checked:
                        * RUNGUTAN_TEAM_ID * RUNGUTAN_API_KEY

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rungutan-1.1.2.tar.gz (12.4 kB view hashes)

Uploaded Source

Built Distribution

rungutan-1.1.2-py3-none-any.whl (12.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page