Crate test_tools

Module :: test_tools

Tools for writing and running tests.

Basic use-case

use test_tools::*;

#[ cfg( feature = "enabled" ) ]
#[ cfg( not( feature = "no_std" ) ) ]
tests_impls!
{
  fn pass1()
  {
    assert_eq!( true, true );
  }

  //

  fn pass2()
  {
    assert_eq!( 1, 1 );
  }
}

//
#[ cfg( feature = "enabled" ) ]
#[ cfg( not( feature = "no_std" ) ) ]
tests_index!
{
  pass1,
  pass2,
}

To add to your project

cargo add test_tools --dev

Try out from the repository

git clone https://github.com/Wandalen/wTools
cd wTools
cd examples/test_trivial
cargo run

Sample

Modules

• asset
  Test asset helper.
• compiletime
  Try building a program for negative testing.
• dependency
  Namespace with dependencies.
• diagnostics
• diagnostics_tools
• dt
• error_tools
• exposed
  Exposed namespace of the module.
• helper
  Helpers for testing.
• mem
  Collection of tools to manipulate memory.
• mem_tools
  Collection of tools to manipulate memory.
• meta
• meta_tools
• num_traits
  Numeric traits for generic mathematics
• orphan
  Orphan namespace of the module.
• paste
  github crates-io docs-rs
• prelude
  Prelude to use essentials: use my_module::prelude::*.
• process_tools
• process_tools_published
• protected
  Protected namespace of the module.
• rustversion
  github crates-io docs-rs
• smoke_test
  Smoke test checking health of a module.
• test
  Tools for testing.
• trybuild
  github crates-io docs-rs
• typing
  Collection of general purpose tools for type checking.
• typing_tools
  Collection of general purpose tools for type checking.
• version
  Version of Rust compiler

Macros

• _impls_callback
  Internal impls1 macro. Don’t use.
• a_dbg_false
  Asserts that a boolean expression is false at runtime.
• a_dbg_id
  Asserts that two expressions are identical.
• a_dbg_not_id
  Asserts that two expressions are not identical with each other.
• a_dbg_true
  Asserts that a boolean expression is true at runtime.
• a_false
  Asserts that a boolean expression is false at runtime.
• a_id
  Asserts that two expressions are identical to each other (using PartialEq). Prints nice diff.
• a_not_id
  Asserts that two expressions are not identical to each other (using PartialEq). Prints nice diff.
• a_true
  Asserts that a boolean expression is true at runtime.
• bmap
  Literally just a BTreeMap literal with keys and values into’d.
• braces_unwrap
  Unwrap braces of token tree and pass its content to the passed callback. If token tree in not braced then it passed to callback as is.
• bset
  Literally just a BTreeSet literal with values into’d.
• cta_mem_same_size
  Compile-time assertion that two values have the same size.
• cta_ptr_same_size
  Compile-time assertion that memory behind two references have the same size.
• cta_true
  Macro to compare meta condition is true at compile-time.
• cta_type_same_align
  Compile-time assertion of having the same align.
• cta_type_same_size
  Compile-time assertion that two types have the same size.
• doc_file_test
  Test a file with documentation.
• fn_name
  Get name of a function.
• fn_rename
  Macro to rename function.
• fns
  Split functions.
• fns2
  Split functions.
• for_each
• heap
  Literally just a BinaryHeap literal with values into’d.
• hmap
  Literally just a HashMap literal with keys and values into’d.
• hset
  Literally just a HashSet literal with values into’d.
• identity
  Macro which returns its input as is.
• implements
  Macro implements to answer the question: does it implement a trait?
• impls
  Macros to put each function under a named macro to index every function in a class.
• impls1
  Define implementation putting each function under a macro.
• impls2
  Define implementation putting each function under a macro.
• impls3
  Macros to put each function under a named macro to index every function in a class.
• impls_optional
  Define implementation putting each function under a macro.
• index
  Index of items.
• inspect_to_str_type_of
  Macro to inspect type of a variable and its size exporting it as a string.
• inspect_type_of
  Macro to inspect type of a variable and its size printing into stdout and exporting it as a string.
• instance_of
  Macro instance_of to answer the question: does it implement a trait? Alias of the macro implements.
• is_slice
  Macro to answer the question: is it a slice?
• list
  Literally just a LinkedList literal with values into’d.
• meta_idents_concat
• mod_interface
  Protocol of modularity unifying interface of a module and introducing layers.
• num
  Required to convert integets to floats.
• tests_impls
  Define implementation putting each function under a macro and adding attribute #[ test ].
• tests_impls_optional
  Define implementation putting each function under a macro and adding attribute #[ test ].
• tests_index
  Index of items.
• vecd
  Literally just a VecDeque literal with values into’d.

Structs

• SmokeModuleTest
  Context for smoke testing of a module.

Enums

• Either
  The enum Either with variants Left and Right is a general purpose sum type with two cases.

Functions

• smoke_test_for_local_run
  Run smoke test for local version of the module.
• smoke_test_for_published_run
  Run smoke test for published version of the module.
• smoke_test_run
  Run smoke test for the module.
• smoke_tests_run
  Run smoke test for both published and local version of the module.

Attribute Macros

• nightly
• stable