Struct Opts

pub struct Opts { /* private fields */ }

Tool to run tests that exercise the wit-bindgen bindings generator.

This tool is used to (a) generate bindings for a target language, (b) compile the bindings and source code to a wasm component, (c) compose a “runner” and a “test” component together, and (d) execute this component to ensure that it passes. This process is guided by filesystem structure which must adhere to some conventions.

• Tests are located in any directory that contains a test.wit description of the WIT being tested. The <TEST> argument to this command is walked recursively to find test.wit files.

• The test.wit file must have a runner world and a test world. The “runner” should import interfaces that are exported by “test”.

• Adjacent to test.wit should be a number of runner*.* files. There is one runner per source language, for example runner.rs and runner.c. These are source files for the runner world. Source files can start with //@ ... comments to deserialize into config::RuntimeTestConfig, currently that supports:

  //@ args = ['--arguments', 'to', '--the', 'bindings', '--generator']

  or

  //@ args = '--arguments to --the bindings --generator'

• Adjacent to test.wit should also be a number of test*.* files. Like runners there is one per source language. Note that you can have multiple implementations of tests in the same language too, for example test-foo.rs and test-bar.rs. All tests must export the same test world from test.wit, however.

This tool will discover test.wit files, discover runners/tests, and then compile everything and run the combinatorial matrix of runners against tests. It’s expected that each runner.* and test.* perform the same functionality and only differ in source language.

Implementations

impl Opts

pub fn run(&self, wit_bindgen: &Path) -> Result<()>

Trait Implementations

impl Args for Opts

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for Opts

fn clone(&self) -> Opts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Opts

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Opts

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Opts

fn default() -> Opts

Returns the “default value” for a type.

impl FromArgMatches for Opts

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Opts

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.