1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
//! Provides a Rust trait similar to [Default](https://doc.rust-lang.org/std/default/trait.Default.html) that can be used in tests. //! //! Often tests need to construct mock instances of structs. For example: //! ```rust //! struct User { //! id: usize, //! name: String, //! email: String, //! admin: bool //! } //! ``` //! //! While it's tempting to define Default, often tests need mock values for types that //! shouldn't apply in production code. Sometimes, tests need values for types that don't even implement Default. //! //! This crate provides [DefaultTest](./trait.DefaultTest.html), a trait which can provide default instances with mock values. //! Tests can construct instances, and use the spread operator to override values. //! ```rust //! # struct User { //! # id: usize, //! # name: String, //! # email: String, //! # admin: bool //! # } //! use default_test::DefaultTest; //! //! impl DefaultTest for User { //! fn default_test() -> Self { //! User { //! id: 0, //! name: "name".into(), //! email: "email".into(), //! admin: false //! } //! } //! } //! //! #[cfg(test)] //! mod tests { //! #[test] //! fn test() { //! let user = User { //! id: 99 //! ..User::test_default() //! }; //! // ... //! } //! } //! ``` //! //! This style makes tests much more stable, and when adding a field to a struct, it reduces the amount of required edits in your unit tests. //! //! ## Roadmap: //! - Derive macro which fills sensible defaults that would be useful in unit test implementations. //! String files would be filled with their property name, and other types may use T::default() or unique values. /// A trait for giving a type a useful default value, in the scope of unit tests. /// /// Sometimes, unit tests need to construct a mock value when working with structs, such as: /// ```rust /// struct User { /// id: usize, /// name: String, /// email: String, /// admin: bool /// } /// ``` /// /// DefaultTest can be used to define default mocked values for use in tests. /// Tests can construct instances, and use the spread operator to override values. /// ```rust /// # struct User { /// # id: usize, /// # name: String, /// # email: String, /// # admin: bool /// # } /// use default_test::DefaultTest; /// /// impl DefaultTest for User { /// fn default_test() -> Self { /// User { /// id: 0, /// name: "name".into(), /// email: "email".into(), /// admin: false /// } /// } /// } /// /// #[cfg(test)] /// mod tests { /// #[test] /// fn test() { /// let user = User { /// id: 99 /// ..User::test_default() /// }; /// // ... /// } /// } /// ``` pub trait DefaultTest { /// Returns a "default value" for a type, containing mocked values suitable for use in tests. /// Default values may contain literals, unique numbers, etc, to make test assertions easier to work with. /// # Examples /// ``` /// use default_test::DefaultTest; /// let x: String = DefaultTest::default_test(); /// ``` /// Make your own: /// ``` /// use default_test::DefaultTest; /// /// struct Foo { /// bar: String /// } /// /// impl DefaultTest for Foo { /// fn default_test() -> Self { /// Self { /// bar: "bar".into() /// } /// } /// } fn default_test() -> Self; } impl DefaultTest for bool { fn default_test() -> Self { false } } impl DefaultTest for char { fn default_test() -> Self { '-' } } impl DefaultTest for &str { fn default_test() -> Self { "string" } } impl DefaultTest for String { fn default_test() -> Self { "string".into() } } impl DefaultTest for usize { fn default_test() -> Self { 0 } } impl DefaultTest for isize { fn default_test() -> Self { 0 } } impl DefaultTest for u8 { fn default_test() -> Self { 0 } } impl DefaultTest for i8 { fn default_test() -> Self { 0 } } impl DefaultTest for u16 { fn default_test() -> Self { 0 } } impl DefaultTest for i16 { fn default_test() -> Self { 0 } } impl DefaultTest for u32 { fn default_test() -> Self { 0 } } impl DefaultTest for i32 { fn default_test() -> Self { 0 } } impl DefaultTest for u64 { fn default_test() -> Self { 0 } } impl DefaultTest for i64 { fn default_test() -> Self { 0 } } impl DefaultTest for u128 { fn default_test() -> Self { 0 } } impl DefaultTest for i128 { fn default_test() -> Self { 0 } } impl DefaultTest for f32 { fn default_test() -> Self { 0.0 } } impl DefaultTest for f64 { fn default_test() -> Self { 0.0 } } // impl<T, E> DefaultTest for Result<T, E> // where // T: DefaultTest, // { // fn default_test() -> Self { // Ok(T::default_test()) // } // } // impl<T> DefaultTest for Option<T> // where // T: DefaultTest, // { // fn default_test() -> Self { // Some(T::default_test()) // } // }