Struct wgpu_test::FailureCase

pub struct FailureCase {
    pub backends: Option<Backends>,
    pub vendor: Option<u32>,
    pub adapter: Option<&'static str>,
    pub driver: Option<&'static str>,
    pub reasons: Vec<FailureReason>,
    pub behavior: FailureBehavior,
}

Conditions under which a test should fail or be skipped.

By passing a FailureCase to TestParameters::expect_fail, you can mark a test as expected to fail under the indicated conditions. By passing it to TestParameters::skip, you can request that the test be skipped altogether.

If a field is None, then that field does not restrict matches. For example:

FailureCase {
    backends: Some(wgpu::Backends::DX12),
    vendor: None,
    adapter: Some("RTX"),
    driver: None,
    reasons: vec![FailureReason::validation_error().with_message("Some error substring")],
    behavior: FailureBehavior::AssertFailure,
}

This applies to all cards with "RTX' in their name on either Direct3D backend, no matter the vendor ID or driver name.

The strings given here need only appear as a substring in the corresponding AdapterInfo fields. The comparison is case-insensitive.

The default value of FailureCase applies to any test case. That is, there are no criteria to constrain the match.

Fields

backends: Option<Backends>

Backends expected to fail, or None for any backend.

If this is None, or if the test is using one of the backends in backends, then this FailureCase applies.

vendor: Option<u32>

Vendor expected to fail, or None for any vendor.

If Some, this must match AdapterInfo::device, which is usually the PCI device id. Otherwise, this FailureCase applies regardless of vendor.

adapter: Option<&'static str>

Name of adapter expected to fail, or None for any adapter name.

If this is Some(s) and s is a substring of AdapterInfo::name, then this FailureCase applies. If this is None, the adapter name isn’t considered.

driver: Option<&'static str>

Name of driver expected to fail, or None for any driver name.

If this is Some(s) and s is a substring of AdapterInfo::driver, then this FailureCase applies. If this is None, the driver name isn’t considered.

reasons: Vec<FailureReason>

Reason why the test is expected to fail.

If this does not match, the failure will not match this case.

If no reasons are pushed, will match any failure.

behavior: FailureBehavior

Behavior after this case matches a failure.

Implementations

impl FailureCase

pub fn new() -> Self

Create a new failure case.

pub fn always() -> Self

This case applies to all tests.

pub fn never() -> Self

This case applies to no tests.

pub fn backend(backends: Backends) -> Self

Tests running on any of the given backends.

pub fn adapter(adapter: &'static str) -> Self

Tests running on adapter.

For this case to apply, the adapter string must appear as a substring of the adapter’s AdapterInfo::name. The comparison is case-insensitive.

pub fn backend_adapter(backends: Backends, adapter: &'static str) -> Self

Tests running on backend and adapter.

For this case to apply, the test must be using an adapter for one of the given backend bits, and adapter string must appear as a substring of the adapter’s AdapterInfo::name. The string comparison is case-insensitive.

pub fn webgl2() -> Self

Tests running under WebGL.

pub fn molten_vk() -> Self

Tests running on the MoltenVK Vulkan driver on macOS.

pub fn reasons(&self) -> &[FailureReason]

Return the reasons why this case should fail.

pub fn validation_error(self, msg: &'static str) -> Self

Matches this failure case against the given validation error substring.

Substrings are matched case-insensitively.

If multiple reasons are pushed, will match any of them.

pub fn panic(self, msg: &'static str) -> Self

Matches this failure case against the given panic substring.

Substrings are matched case-insensitively.

If multiple reasons are pushed, will match any of them.

pub fn flaky(self) -> Self

Test is flaky with the given configuration. Do not assert failure.

Use this very sparyingly, and match as tightly as you can, including giving a specific failure message.

Trait Implementations

impl Clone for FailureCase

fn clone(&self) -> FailureCase

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for FailureCase

fn default() -> FailureCase

Returns the “default value” for a type.