polyspace-access -list-runs

Show all uploaded runs

collapse all in page

    Syntax

    polyspace-access -list-runs projectPath -host <hostname> [login options] [output options]

    Description

    The system command polyspace-access -list-runs lists the run IDs for all runs that were uploaded to the specified Polyspace® Access™ project.

    polyspace-access -list-runs projectPath -host <hostname> [login options] [output options] shows all uploaded runs for the specified project. For each run, you see the run ID and any labels associated with that run.

    example

    Examples

    collapse all

    Assign labels to project runs uploaded to Polyspace Access to help identify certain project runs. The custom labels are in addition to the unique run ID that Polyspace Access assigns to each run.

    View all the runs and labels associated with the project public/Examples/Bug Finder Example, by using the polyspace-access -list-runs command.

    polyspace-access -list-runs "public/Examples/Bug Finder Example" ^
-host myAccessServer -port 1234

login: edoolittle
password:
    Connecting to myAccessServer:1234
Connecting as edoolittle
PROJECT_PATH "public/Examples/Bug Finder Example" RUN_ID 1758 LABELS "1.0"
PROJECT_PATH "public/Examples/Bug Finder Example" RUN_ID 1759 LABELS "1.0"
PROJECT_PATH "public/Examples/Bug Finder Example" RUN_ID 1760 LABELS "1.0" "Fake Branch"
PROJECT_PATH "public/Examples/Bug Finder Example" RUN_ID 1761 LABELS "1.0"

    The project contains four runs with run IDs 1758, 1759, 1760, and 1761. Run 1760 has two labels, "1.0" and "Fake Branch".

    Replace the label "Fake Branch" with the label "Test Branch". Add a label to the project run using the -add-label command. Use the run ID to specify the project run.

    polyspace-access -add-label "Test Branch" -run-id 1760 ^
-host myAccessServer -port 1234

    List the run IDs and labels in the project.

    polyspace-access -list-runs "public/Examples/Bug Finder Example" ^
-host myAccessServer -port 1234

login: edoolittle
password:
    Connecting to myAccessServer:1234
Connecting as edoolittle
PROJECT_PATH "public/Examples/Bug Finder Example" RUN_ID 1758 LABELS "1.0"
PROJECT_PATH "public/Examples/Bug Finder Example" RUN_ID 1759 LABELS "1.0"
PROJECT_PATH "public/Examples/Bug Finder Example" RUN_ID 1760 LABELS "1.0" "Fake Branch" "Test Branch"
PROJECT_PATH "public/Examples/Bug Finder Example" RUN_ID 1761 LABELS "1.0"

    The run with run ID 1760 now has labels "1.0", "Fake Branch", and "Test Branch".

    Remove the "Fake Branch" label from run 1760 by using the polyspace-access -remove-label command.

    polyspace-access -remove-label "Fake Branch" -run-id 1760 ^ 
-host myAccessServer -port 1234 ^

    Input Arguments

    collapse all

    Manage and View Projects

    Absolute path of the project or folder, specified as a string. If the path name includes spaces, use double quotes. Specify the full path to the project or folder starting from the parent folder within Polyspace Access.

    Example: -list-runs public/Folder/projectName

    Example: -list-runs "public/Folder/Project Name with Spaces"

    Connection Configuration

    Polyspace Access machine hostname that you specify in the URL of the Polyspace Access interface, such as https://hostname:portNumber/metrics/index.html. If you are unsure about which hostname to use, contact your Polyspace Access administrator.

    You must specify a hostname with all polyspace-access commands, except the -generate-migration-commands and -encrypt-password commands.

    Example: -host myAccessServer

    Port number that you specify in the URL of the Polyspace Access interface, such as https://hostname:portNumber/metrics/index.html. If you are unsure about which port number to use, contact your Polyspace Access administrator.

    HTTP protocol used to access Polyspace Access, specified as http or https.

    Full path to the text file where you store your login credentials. Use this option if you use a command that requires your Polyspace Access credentials in a script but you do not want to store your credentials in that script. While the script runs, someone inspecting currently running processes cannot see your credentials.

    You can store only one set of credentials in the file, either as -login and -encrypted-password entries on separate lines, for instance: 

    -login jsmith
-encrypted-password LAMMMEACDMKEFELKMNDCONEAPECEEKPL
    You can also store credentials as an -api-key entry:
    -api-key keyValue123
    Make sure that the file where you store your credentials is UTF-8 encoded and that you restrict the read and write permissions on the file. For example, to restrict read and write permissions on file login.txt in Linux®, use this command:
    chmod go-rwx login.txt

    API key you use as a login credential instead of providing your login and encrypted password. To assign an API key to a user, see Configure User Manager or contact your Polyspace Access administrator.

    Use the API key if you use a command that requires your Polyspace Access login credentials as part of an automation script with a CI tool such as Jenkins®. If a user updates their password, you do not need to update the API key associated with that user in your scripts.

    It is recommended that you store the API key in a text file and pass that file to the command by using the -credentials-file option.

    Login username that you use to interact with Polyspace Access.

    Use the options -login and -encryped-password together. If you do not use these two options together, you are prompted to enter your credentials at the command line, unless you use -api-key.

    Login password you use to interact with Polyspace Access. <ENCRYPTED_PASSWORD> is the output of the polyspace-access -encrypt-password command.

    Use the options -login and -encryped-password together. If you do not use these two options together, you are prompted to enter your credentials at the command line, unless you use the -api-key option.

    Number of times the polyspace-access command retries to upload results when you upload from a client machine to the server machine that hosts Polyspace Access before failing. Specify this option to retry the upload command in the event of sporadic network outages. The command waits 10 seconds between retries.

    Full path to command outputs.

    Path to the folder for storing temporary files generated by polyspace-access commands. The default folder path depends on your platform:

    • Windows — C:\Users\%username%\AppData\Local\Temp\ps_results_server

    • Linux — tmp/ps_results_server

    File path where you store the command output log. By default the command does not generate a log file.

    Version History

    Introduced in R2019a