Skip to content
This repository has been archived by the owner on Sep 18, 2021. It is now read-only.

MAQEAPI

Jump to bottom
Jeremy Poulin edited this page Oct 9, 2018 · 8 revisions

These static functions are available through the MAQEAPI class. In versions of the libraries up to and including v1.1, this variable was called TestUtils, and the version specification was assumed to be v1, so calling MAQEAPI.v1.runTest would be TestUtils.runTest.

API Version 1

This encapsulates the functions available and supported throughout the v1.y.z release life-cycle of the multiarch-ci-libraries.

MAQEAPI.v1.runTest

If you're looking to run a test on a single architecture, you can use the MAQEAPI.runTest function.

IMPORTANT NOTE
This function is broken in version v1.0. If you are on v1.0, please use runParallelMultiArchTest instead.

As of release v1.0, this function has 6 parameters. The postTest parameter is optional in order to maintain compatibility with previous releases.

script

  • Description: Usually this is just the "this" object of your test. It gives the library access to pipeline steps such as sh.
  • Type: WorkflowScript

arch

  • Description: Specifies the arch to run the test on.
  • Type: String
  • Valid Values: x86_64, ppc64le, aarch64, s390x

config

  • Description: The ProvisioningConfig object. See Provisioning Configuration
  • Type: com.redhat.multiarch.ci.provisioner.ProvisioningConfig

test

  • Description: Closure that takes a single parameter of type com.redhat.multiarch.ci.provisioner.Host and wraps your test.
  • Type: Closure

onTestFailure

  • Description: Closure that takes a two parameters. The first is of type com.redhat.multiarch.ci.provisioner.Host, and the second is of type Exception. This is called in the situation that your test closure fails.
  • Type: Closure

postTest

  • Description: Closure that is run after the test. It takes no parameters, and does nothing by default.
  • Optional: true
  • Type: Closure

MAQEAPI.v1.runParallelMultiArchTest

If you're looking to run a test on a multiple architectures in parallel, you can use the TestUtils.runParallelMultiArchTest function.

This function has 6 parameters.

script

  • Description: Usually this is just the "this" object of your test. It gives the library access to pipeline steps such as sh.
  • Type: WorkflowScript

arches

  • Description: Specifies a comma separated list of arches to run the test on.
  • Type: List<String>
  • Valid Values: A non-empty subset of ['x86_64', 'ppc64le', 'aarch64', 's390x']

config

  • Description: The ProvisioningConfig object. See Provisioning Configuration
  • Type: com.redhat.multiarch.ci.provisioner.ProvisioningConfig

test

  • Description: Closure that takes a single parameter of type com.redhat.multiarch.ci.provisioner.Host and wraps your test.
  • Type: Closure

onTestFailure

  • Description: Closure that takes a two parameters. The first is of type com.redhat.multiarch.ci.provisioner.Host, and the second is of type Exception. This is called in the situation that your test closure fails.
  • Type: Closure

postTest

  • Description: Closure that is run after the individual arch tests. It runs in its own provisioning container. It takes no parameters, and does nothing by default.
  • Optional: true
  • Type: Closure

MAQEAPI.v1.testWrapper

If the arch test specific functions don't solve you use case, you can use test wrapper to spin up a provisioning container and run a closure on it. The function is available in release v1.0 and above.

This function has 3 parameters.

script

  • Description: Usually this is just the "this" object of your test. It gives the library access to pipeline steps such as sh.
  • Type: WorkflowScript

config

  • Description: The ProvisioningConfig object. See Provisioning Configuration
  • Type: com.redhat.multiarch.ci.provisioner.ProvisioningConfig

test

  • Description: Closure that takes no parameters and wraps your test.
  • Type: Closure
Clone this wiki locally