Requests, Bundle, Results, and Baseline CLI APIs

About XPRESSO Requests, Bundle, Results, and Baseline CLI APIs

XPRESSO provides the following public CLI APIs to manage (see API details for specific support) for Requests, Bundle, Results, and Baseline information:

Request CLI APIs

XPRESSO request get

• description: get a specific XPRESSO request info

• mandatory arguments: --id:

  • description: XPRESSO request ID
  • usage: XPRESSO request get --id REQ0000001-1-run

• optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO request list

• description: get a list of XPRESSO requests and related info

• mandatory arguments: none

• optional arguments:

  --filter:

  • description: filtering requests based on defined criteria (tags, owner, date_created)
  • usage: XPRESSO request list --filter tags=a,b,c owner=chuck date_created=2019-03-22

  --limit:

  • description: limit the number of matching output
  • usage: XPRESSO request list --limit 10

  --also refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO request submit

• description: submit a XPRESSO request

• mandatory arguments: either --job and --profile (default: DEFAULT), or --bundle

• optional arguments:

  --job:

  • description: job name
  • usage: XPRESSO request submit --job my_job

  --profile:

  • description: profile name, if not specified, 'DEFAULT' will be applied as the profile name.
  • usage: XPRESSO request submit --job my_job --profile my_profile

  --bundle:

  • description: bundle name. mutually exclusive with --job and --profile
  • usage: XPRESSO request submit --bundle my_bundle

  --runtime:

  • description: max runtime in seconds
  • usage: XPRESSO request submit --job my_job --runtime 3600

  --submitted-for:

  • description: user that the request submitted for
  • usage: XPRESSO request submit --job my_job --submitted-for kel2

  --branch:

  • description: branch name
  • usage: XPRESSO request submit --job my_job --branch my_branch

  --label:

  • description: label name
  • usage: XPRESSO request submit --job my_job --label my_label

  --images:

  • description: images path
  • usage: XPRESSO request submit --job my_job --images path_1 path_2 path_3

  --webhooks:

  • description: webhooks name
  • usage: XPRESSO request submit --job my_job --webhooks name_1 name_2 name_3

  --description:

  • description: request description
  • usage: XPRESSO request submit --job my_job --description "this is my description"

  --tags:

  • description: request tag(s)
  • usage: XPRESSO request submit --job my_job --tags tag1 tag2 tag3

  --testbeds:

  • description: testbed name(s); mutually exclusive with --topology
  • usage: XPRESSO request submit --job my_job --testbeds tb1 tb2

  --topology:

  • description: topology name; mutually exclusive with --testbeds
  • usage: XPRESSO request submit --job my_job --topology my_topology

  --clean:

  • description: flag to indicate if involving clean
  • usage: XPRESSO request submit --job my_job --clean

  --interest-list:

  • description: interest list
  • usage: XPRESSO request submit --job my_job --interest-list user@cisco.com user2@cisco.com

  --env-vars:

  • description: XPRESSO environment variables
  • usage: XPRESSO request submit --job my_job --env-vars="SERVER=test.cisco.com PORT=123"

  --harness-args:

  • description: XPRESSO harness arguments
  • usage: XPRESSO request submit --job my_job --harness-args="loglevel=INFO submitter=kel2 no_mail"

  --job-args:

  • description: XPRESSO job arguments
  • usage: XPRESSO request submit --job my_job --job-args="--k1=v1 -k2=v2 k3=v3 k4=1,2,3 k5". k1: double dash arg, k2: single dash arg, k3: kwarg, k4: list arg, k5: boolean arg.

  --is-baseline:

  • description: flag to indicate if set the current request to be a baseline run
  • usage: XPRESSO request submit --job my_job --is-baseline

  --compare-baseline:

  • description: flag to indicate if use the current request run result to compare a baseline result
  • usage: XPRESSO request submit --job my_job --compare-baseline

  --compare-id:

  • description: baseline result ID to compare with. If not been provided, and --compare-baseline is specified, latest baseline will be used to do the comparison.
  • usage: XPRESSO request submit --job my_job --compare-id REQ00000002-1-run

  --category:

  • description: baseline category list
  • usage: XPRESSO request submit --job my_job --category nightly weekly monthly

  --also refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO request stop

• description: stop an XPRESSO request

• mandatory arguments:

  --id:

  • description: request ID to stop
  • usage: XPRESSO request stop --id REQ0000001-1-run --reason "some valid reason"

  --reason:

  • description: reason to stop a request
  • usage: XPRESSO request stop --id REQ0000001-1-run --reason "some valid reason"

• optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

Bundle Requests CLI APIs

XPRESSO bundle get

• description: get a specific XPRESSO bundle info

• mandatory arguments:

  --name:

  • description: XPRESSO bundle name
  • usage: XPRESSO bundle get --name my_bundle

• optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO bundle list

• description: get a list of XPRESSO bundles info

• mandatory arguments: none

• optional arguments:

  --filter:

  • description: filtering bundles based on defined criteria (tags, name, owner, date_created)
  • usage: XPRESSO bundle list --filter tags=a,b,c name=my_bundle owner=chuck date_created=2019-03-22

  --limit:

  • description: limit the number of matching output
  • usage: XPRESSO bundle list --limit 10

  --also refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

Result CLI APIs

XPRESSO result compare

• description: compare two XPRESSO run results

• mandatory arguments:

  --ids:

  • description: two XPRESSO run result IDs
  • usage: XPRESSO result compare --ids REQ0000001-1-run REQ0000002-1-run

• optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO result attach

• description: attach bug(s) attribute(s) with a XPRESSO run result

• mandatory arguments:

  --id:

  • description: XPRESSO run result ID
  • usage: XPRESSO result attach --id REQ0000001-1-run --bugs bug1 bug2 bug3 --attributes att1 att2 att3

  --bugs:

  • description: bugs to attach
  • usage: XPRESSO result attach --id REQ0000001-1-run --bugs bug1 bug2 bug3 --attributes att1 att2 att3

  --attributes:

  • description: ddts attributes to attach
  • usage: XPRESSO result attach --id REQ0000001-1-run --bugs bug1 bug2 bug3 --attributes att1 att2 att3

• optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

Baseline CLI APIs

XPRESSO baseline compare

• description: compare a XPRESSO run result with its baseline run result

• mandatory arguments:

  --ids:

  • description: XPRESSO run result ID, or XPRESSO run result ID and baseline run result ID. If baseline run result ID is not provided, latest baseline will be used for comparison.
  • usage: XPRESSO baseline compare --ids REQ0000002-1-run or XPRESSO baseline compare --ids REQ0000002-1-run REQ0000001-1-run

• optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO baseline list

• description: get a list of XPRESSO baseline info

• mandatory arguments: none

• optional arguments:

  --filter:

  • description: filtering baselines based on defined criteria (branch, label, category)
  • usage: XPRESSO baseline list --filter branch=b1,b2,b3 label=l1,l2, category=c1,c2

  --limit:

  • description: limit the number of matching output
  • usage: XPRESSO baseline list --limit 10

  --also refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO baseline propagate

• description: propagates the current baseline attributes to all previous baselines in a test case family

• mandatory arguments:

  --ids:

  • description: XPRESSO run result ID
  • usage: XPRESSO baseline propagate --ids REQ0000002-1-run

• optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO baseline set

• description: set a xpresso xpresso baseline

• mandatory arguments:

  --id:

  • description: xpresso run result ID
  • usage: xpresso baseline set --id REQ0000001-1-run

• optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO baseline set-attribute

• description: sets the baseline test case attributes

• mandatory arguments:

  --id:

  • description: xpresso run result ID
  • usage: xpresso baseline set-attribute --id REQ0000001-1-run --test unique_test_id

  --test:

  • description: xpresso unique test ID
  • usage: xpresso baseline set-attribute --id REQ0000001-1-run --test unique_test_id

• optional arguments:

  --compare-ignore

  • description: flag to indicate if the current test in the baseline compare should be ignored (true or false)
  • usage: xpresso baseline set-attribute --id REQ0000001-1-run --test unique_test_id --compare ignore or xpresso baseline set-attribute --id REQ0000001-1-run --test unique_test_id --compare ignore false

  --is-intermitted

  • description: flag to indicate if test case result is not stable or consistent (true or false)
  • usage: xpresso baseline set-attribute --id REQ0000001-1-run --test unique_test_id --is-intermitted or xpresso baseline set-attribute --id REQ0000001-1-run --test unique_test_id --is-intermitted false

  --is-mustpass

  • description: flag to indicate if test case must pass in the baseline compare (true or false)
  • usage: xpresso baseline set-attribute --id REQ0000001-1-run --test unique_test_id --is-mustpass or xpresso baseline set-attribute --id REQ0000001-1-run --test unique_test_id --is-mustpass false

  --persistent-note

  • description: Note to explain ongoing issue(s) with a is-intermitted flagged test cases.

  • usage: xpresso baseline set-attribute --id REQ0000001-1-run --test unique_test_id --persistent-note "Ongoing issue with false reading"

  • --also refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO baseline unset

• description: unset a xpresso baseline

• mandatory arguments:

  --id:

  • description: xpresso run result ID
  • usage: xpresso baseline unset --id REQ0000001-1-run

  --reason:

  • description: unset baseline reason
  • usage: xpresso baseline unset --id REQ0000001-1-run --reason "some valid reason"

• optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO baseline unset-attribute

• description: unsets (removes) the baseline test case attributes

• mandatory arguments:

  --id:

  • description: xpresso run result ID
  • usage: xpresso baseline unset-attribute --id REQ0000001-1-run

  --test:

  • description: xpresso unique test ID
  • usage: xpresso baseline unset-attribute --id REQ0000001-1-run --test unique_test_id

• optional arguments:

• optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO baseline update

• description: updates the current baseline properties with user-defined category values

• mandatory arguments:

  --ids:

  • description: xpresso run result ID
  • usage: xpresso baseline update --ids REQ0000002-1-run

  --category:

  • description: this flags indicates which category the baseline belongs to (either by a defined category or no-defined catagory "".)
  • usage: XPRESSO baseline update --ids REQ0000002-1-run --category weekly, monthly, yearly or no-defined category:XPRESSO baseline update --ids REQ0000002-1-run --category ""

• optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.