Page tree
Skip to end of metadata
Go to start of metadata

Prerequisites:

  • Download vrunner binary

Download:

Setup / Installation:

  1. For Windows Machine
    1. This exe file can be executed on command prompt. So, double mouse click on the downloaded file will not help in executing the test cases.
    2. First, move the downloaded binary file to the directory of your choice
    3. Rename the binary file to just vrunner with the following command:

      C:\dir\path> move vrunner_win_x_y_z.exe vrunner.exe
    4. [Optional] Now add this binary file in your execution path by setting the environment variable PATH.

  2. For Linux / Mac Machine
    1. First, move the downloaded binary file to the directory of your choice
    2. Rename the binary file to just vrunner with the following command:

      $ mv vrunner_linux_x_y_z vrunner
    3. Make it executable by executing the following command:

      $ chmod +x vrunner
    4. Now add this binary file in your execution path.

Usage Instructions:

Once you install this module on your local machine, you can execute the vREST test cases by executing the following command:

vrunner --email=<vrest_email> --password=<vrest_password>
        --url="<vrest_testcase_list_url>" [--env=<environment_name>]
        [--nosslcheck=<boolean_value>] [--debug=<boolean_value>] [--logger=<logger_name>]
        [--filepath="<absolute_path_of_log_file>"] [--vrestbaseurl="<vrest_enterprise_base_url_with_trailing_slash>"]

For vREST Enterprise Users

For enterprise users to use vrunner command, they will need to provide the base URL of the hosted vREST application in vrunner command by using the option `--vrestbaseurl`. This option is only applicable for vREST Enterprise Users.


An example of this command will be:

vrunner --email=abc@example.com --password=my_secret_password 
		--url="https://vrest.io/i/demo/g/testcase?projectId=549550cb68e831540bd849b1&versionIds%5B%5D=54d86e3a4908a5a106e6243e"


Note:

  1. If you have not added vrunner into the execution path then specify the full file path to execute the binary.
  2. And make sure, you have enclosed the URL in double quotes.

Options

    -E, --email      : Email ID through which you have registered on vREST
    -P, --password   : Password of your vREST account
    -U, --url        : Provide the test case list URL here. You can find the test
                       case list URL by going to your vREST instance and select Test
                       Cases tab. Now click on button "Copy Current Test Case List
                       URL" available in Left hand side, below the "Filters section".
                       Provide the copied URL in this option. Ensure that you enclose
                       URL in double quotes.
    -N, --env        : (Case-Sensitive) Provide the environment name to initialize the global variables.
                       By default environment `Default` is used.
    -D, --debug      : Should be set if you want debugging console logs.
                       By default debugging information are not logged.
    -S, --nosslcheck : If this argument is `true`, vrunner will process all requests,
                       without Secure Certificate Check.
                       By default Secure Certificate Check is enabled. This option is
                       useful in self-signed certificate issues.
    -L, --logger     : Your desired logging of the vRUNNER execution process and
                       result. This can be either `console` or `json` or `csv` or `xunit`.
                       By default `console` logger is used.
    -F, --filepath   : Valid if other than `console` logger is selected.
                       Absolute path of the log file, into which execution process
                       and result logs will be dumped. If path/file is not present,
                       tool will try to setup that path, and create file automatically.
                       Please note that if file already exists, that will be
                       overwritten. By default it will be the `vrest_logs/logs.[json|xml|csv]`
                       in current directory.
    --vrestbaseurl   : Valid if user is having a hosted vREST enterprise instance. Provide the
                       base URL of the hosted vREST enterprise instance here.

    -H, --help       : To see this help.
  • No labels