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

Prerequisites:

  • Download vrest_ie binary

Download:

VersionLinuxMac OS

Windows (64bit)

0.0.1DownloadDownloadDownload

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 utility.
    2. First, move the downloaded binary file to the directory of your choice
    3. Rename the binary file to just vrest_ie with the following command:

      C:\dir\path> move vrest_ie_win_x_y_z.exe vrest_ie.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 vrest_ie with the following command:

      $ mv vrest_ie_linux_x_y_z vrest_ie
    3. Make it executable by executing the following command:

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

Usage Instructions:

Once you install this module on your local machine, you can export the vREST data by executing the following command:

vrest_ie --email=<vrest_email> --password=<vrest_password>
 --export --url="<vrest_testcase_list_url>" --filepath="<absolute_file_path>"


An example of this command will be:

vrest_ie --email=john.doe@example.com --password=password --export --filepath=/absolute/file/path.json
 --url="https://vrest.io/i/demo/g/testcase?projectId=549550cb68e831540bd849b1&versionIds=54d86e3a4908a5a106e6243f"


Note:

  1. If you have not added vrest_ie 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

    --email      : Email ID through which you have registered on vREST
    --password   : Password of your vREST account

    --export     : Set this if you are exporting the data from vREST.
    --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.
    --filepath   : Absolute file path name.
    --help       : To see this help.
  • No labels