0
|
1 <?xml version="1.0"?>
|
|
2 <doc>
|
|
3 <assembly>
|
|
4 <name>xunit.extensions</name>
|
|
5 </assembly>
|
|
6 <members>
|
|
7 <member name="T:Xunit.Extensions.Assertions">
|
|
8 <summary>
|
|
9 A wrapper for Assert which is used by <see cref="T:Xunit.Extensions.TestClass"/>.
|
|
10 </summary>
|
|
11 </member>
|
|
12 <member name="M:Xunit.Extensions.Assertions.Contains``1(``0,System.Collections.Generic.IEnumerable{``0})">
|
|
13 <summary>
|
|
14 Verifies that a collection contains a given object.
|
|
15 </summary>
|
|
16 <typeparam name="T">The type of the object to be verified</typeparam>
|
|
17 <param name="expected">The object expected to be in the collection</param>
|
|
18 <param name="collection">The collection to be inspected</param>
|
|
19 <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the object is not present in the collection</exception>
|
|
20 </member>
|
|
21 <member name="M:Xunit.Extensions.Assertions.Contains``1(``0,System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
|
|
22 <summary>
|
|
23 Verifies that a collection contains a given object, using an equality comparer.
|
|
24 </summary>
|
|
25 <typeparam name="T">The type of the object to be verified</typeparam>
|
|
26 <param name="expected">The object expected to be in the collection</param>
|
|
27 <param name="collection">The collection to be inspected</param>
|
|
28 <param name="comparer">The comparer used to equate objects in the collection with the expected object</param>
|
|
29 <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the object is not present in the collection</exception>
|
|
30 </member>
|
|
31 <member name="M:Xunit.Extensions.Assertions.Contains(System.String,System.String)">
|
|
32 <summary>
|
|
33 Verifies that a string contains a given sub-string, using the current culture.
|
|
34 </summary>
|
|
35 <param name="expectedSubstring">The sub-string expected to be in the string</param>
|
|
36 <param name="actualString">The string to be inspected</param>
|
|
37 <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the sub-string is not present inside the string</exception>
|
|
38 </member>
|
|
39 <member name="M:Xunit.Extensions.Assertions.Contains(System.String,System.String,System.StringComparison)">
|
|
40 <summary>
|
|
41 Verifies that a string contains a given sub-string, using the given comparison type.
|
|
42 </summary>
|
|
43 <param name="expectedSubstring">The sub-string expected to be in the string</param>
|
|
44 <param name="actualString">The string to be inspected</param>
|
|
45 <param name="comparisonType">The type of string comparison to perform</param>
|
|
46 <exception cref="T:Xunit.Sdk.ContainsException">Thrown when the sub-string is not present inside the string</exception>
|
|
47 </member>
|
|
48 <member name="M:Xunit.Extensions.Assertions.DoesNotContain``1(``0,System.Collections.Generic.IEnumerable{``0})">
|
|
49 <summary>
|
|
50 Verifies that a collection does not contain a given object.
|
|
51 </summary>
|
|
52 <typeparam name="T">The type of the object to be compared</typeparam>
|
|
53 <param name="expected">The object that is expected not to be in the collection</param>
|
|
54 <param name="collection">The collection to be inspected</param>
|
|
55 <exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the object is present inside the container</exception>
|
|
56 </member>
|
|
57 <member name="M:Xunit.Extensions.Assertions.DoesNotContain``1(``0,System.Collections.Generic.IEnumerable{``0},System.Collections.Generic.IEqualityComparer{``0})">
|
|
58 <summary>
|
|
59 Verifies that a collection does not contain a given object, using an equality comparer.
|
|
60 </summary>
|
|
61 <typeparam name="T">The type of the object to be compared</typeparam>
|
|
62 <param name="expected">The object that is expected not to be in the collection</param>
|
|
63 <param name="collection">The collection to be inspected</param>
|
|
64 <param name="comparer">The comparer used to equate objects in the collection with the expected object</param>
|
|
65 <exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the object is present inside the container</exception>
|
|
66 </member>
|
|
67 <member name="M:Xunit.Extensions.Assertions.DoesNotContain(System.String,System.String)">
|
|
68 <summary>
|
|
69 Verifies that a string does not contain a given sub-string, using the current culture.
|
|
70 </summary>
|
|
71 <param name="expectedSubstring">The sub-string which is expected not to be in the string</param>
|
|
72 <param name="actualString">The string to be inspected</param>
|
|
73 <exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the sub-string is present inside the string</exception>
|
|
74 </member>
|
|
75 <member name="M:Xunit.Extensions.Assertions.DoesNotContain(System.String,System.String,System.StringComparison)">
|
|
76 <summary>
|
|
77 Verifies that a string does not contain a given sub-string, using the current culture.
|
|
78 </summary>
|
|
79 <param name="expectedSubstring">The sub-string which is expected not to be in the string</param>
|
|
80 <param name="actualString">The string to be inspected</param>
|
|
81 <param name="comparisonType">The type of string comparison to perform</param>
|
|
82 <exception cref="T:Xunit.Sdk.DoesNotContainException">Thrown when the sub-string is present inside the given string</exception>
|
|
83 </member>
|
|
84 <member name="M:Xunit.Extensions.Assertions.DoesNotThrow(Xunit.Assert.ThrowsDelegate)">
|
|
85 <summary>
|
|
86 Verifies that a block of code does not throw any exceptions.
|
|
87 </summary>
|
|
88 <param name="testCode">A delegate to the code to be tested</param>
|
|
89 </member>
|
|
90 <member name="M:Xunit.Extensions.Assertions.Empty(System.Collections.IEnumerable)">
|
|
91 <summary>
|
|
92 Verifies that a collection is empty.
|
|
93 </summary>
|
|
94 <param name="collection">The collection to be inspected</param>
|
|
95 <exception cref="T:System.ArgumentNullException">Thrown when the collection is null</exception>
|
|
96 <exception cref="T:Xunit.Sdk.EmptyException">Thrown when the collection is not empty</exception>
|
|
97 </member>
|
|
98 <member name="M:Xunit.Extensions.Assertions.Equal``1(``0,``0)">
|
|
99 <summary>
|
|
100 Verifies that two objects are equal, using a default comparer.
|
|
101 </summary>
|
|
102 <typeparam name="T">The type of the objects to be compared</typeparam>
|
|
103 <param name="expected">The expected value</param>
|
|
104 <param name="actual">The value to be compared against</param>
|
|
105 <exception cref="T:Xunit.Sdk.EqualException">Thrown when the objects are not equal</exception>
|
|
106 </member>
|
|
107 <member name="M:Xunit.Extensions.Assertions.Equal``1(``0,``0,System.Collections.Generic.IEqualityComparer{``0})">
|
|
108 <summary>
|
|
109 Verifies that two objects are equal, using a custom equatable comparer.
|
|
110 </summary>
|
|
111 <typeparam name="T">The type of the objects to be compared</typeparam>
|
|
112 <param name="expected">The expected value</param>
|
|
113 <param name="actual">The value to be compared against</param>
|
|
114 <param name="comparer">The comparer used to compare the two objects</param>
|
|
115 <exception cref="T:Xunit.Sdk.EqualException">Thrown when the objects are not equal</exception>
|
|
116 </member>
|
|
117 <member name="M:Xunit.Extensions.Assertions.Equal(System.Double,System.Double,System.Int32)">
|
|
118 <summary>
|
|
119 Verifies that two <see cref="T:System.Double"/> values are equal, within the number of decimal
|
|
120 places given by <paramref name="precision"/>.
|
|
121 </summary>
|
|
122 <param name="expected">The expected value</param>
|
|
123 <param name="actual">The value to be compared against</param>
|
|
124 <param name="precision">The number of decimal places (valid values: 0-15)</param>
|
|
125 <exception cref="T:Xunit.Sdk.EqualException">Thrown when the values are not equal</exception>
|
|
126 </member>
|
|
127 <member name="M:Xunit.Extensions.Assertions.Equal(System.Decimal,System.Decimal,System.Int32)">
|
|
128 <summary>
|
|
129 Verifies that two <see cref="T:System.Decimal"/> values are equal, within the number of decimal
|
|
130 places given by <paramref name="precision"/>.
|
|
131 </summary>
|
|
132 <param name="expected">The expected value</param>
|
|
133 <param name="actual">The value to be compared against</param>
|
|
134 <param name="precision">The number of decimal places (valid values: 0-15)</param>
|
|
135 <exception cref="T:Xunit.Sdk.EqualException">Thrown when the values are not equal</exception>
|
|
136 </member>
|
|
137 <member name="M:Xunit.Extensions.Assertions.False(System.Boolean)">
|
|
138 <summary>
|
|
139 Verifies that the condition is false.
|
|
140 </summary>
|
|
141 <param name="condition">The condition to be tested</param>
|
|
142 <exception cref="T:Xunit.Sdk.FalseException">Thrown if the condition is not false</exception>
|
|
143 </member>
|
|
144 <member name="M:Xunit.Extensions.Assertions.False(System.Boolean,System.String)">
|
|
145 <summary>
|
|
146 Verifies that the condition is false.
|
|
147 </summary>
|
|
148 <param name="condition">The condition to be tested</param>
|
|
149 <param name="userMessage">The message to show when the condition is not false</param>
|
|
150 <exception cref="T:Xunit.Sdk.FalseException">Thrown if the condition is not false</exception>
|
|
151 </member>
|
|
152 <member name="M:Xunit.Extensions.Assertions.InRange``1(``0,``0,``0)">
|
|
153 <summary>
|
|
154 Verifies that a value is within a given range.
|
|
155 </summary>
|
|
156 <typeparam name="T">The type of the value to be compared</typeparam>
|
|
157 <param name="actual">The actual value to be evaluated</param>
|
|
158 <param name="low">The (inclusive) low value of the range</param>
|
|
159 <param name="high">The (inclusive) high value of the range</param>
|
|
160 <exception cref="T:Xunit.Sdk.InRangeException">Thrown when the value is not in the given range</exception>
|
|
161 </member>
|
|
162 <member name="M:Xunit.Extensions.Assertions.InRange``1(``0,``0,``0,System.Collections.Generic.IComparer{``0})">
|
|
163 <summary>
|
|
164 Verifies that a value is within a given range, using a comparer.
|
|
165 </summary>
|
|
166 <typeparam name="T">The type of the value to be compared</typeparam>
|
|
167 <param name="actual">The actual value to be evaluated</param>
|
|
168 <param name="low">The (inclusive) low value of the range</param>
|
|
169 <param name="high">The (inclusive) high value of the range</param>
|
|
170 <param name="comparer">The comparer used to evaluate the value's range</param>
|
|
171 <exception cref="T:Xunit.Sdk.InRangeException">Thrown when the value is not in the given range</exception>
|
|
172 </member>
|
|
173 <member name="M:Xunit.Extensions.Assertions.IsAssignableFrom``1(System.Object)">
|
|
174 <summary>
|
|
175 Verifies that an object is of the given type or a derived type.
|
|
176 </summary>
|
|
177 <typeparam name="T">The type the object should be</typeparam>
|
|
178 <param name="object">The object to be evaluated</param>
|
|
179 <returns>The object, casted to type T when successful</returns>
|
|
180 <exception cref="T:Xunit.Sdk.IsAssignableFromException">Thrown when the object is not the given type</exception>
|
|
181 </member>
|
|
182 <member name="M:Xunit.Extensions.Assertions.IsAssignableFrom(System.Type,System.Object)">
|
|
183 <summary>
|
|
184 Verifies that an object is of the given type or a derived type.
|
|
185 </summary>
|
|
186 <param name="expectedType">The type the object should be</param>
|
|
187 <param name="object">The object to be evaluated</param>
|
|
188 <exception cref="T:Xunit.Sdk.IsAssignableFromException">Thrown when the object is not the given type</exception>
|
|
189 </member>
|
|
190 <member name="M:Xunit.Extensions.Assertions.IsNotType``1(System.Object)">
|
|
191 <summary>
|
|
192 Verifies that an object is not exactly the given type.
|
|
193 </summary>
|
|
194 <typeparam name="T">The type the object should not be</typeparam>
|
|
195 <param name="object">The object to be evaluated</param>
|
|
196 <exception cref="T:Xunit.Sdk.IsNotTypeException">Thrown when the object is the given type</exception>
|
|
197 </member>
|
|
198 <member name="M:Xunit.Extensions.Assertions.IsNotType(System.Type,System.Object)">
|
|
199 <summary>
|
|
200 Verifies that an object is not exactly the given type.
|
|
201 </summary>
|
|
202 <param name="expectedType">The type the object should not be</param>
|
|
203 <param name="object">The object to be evaluated</param>
|
|
204 <exception cref="T:Xunit.Sdk.IsNotTypeException">Thrown when the object is the given type</exception>
|
|
205 </member>
|
|
206 <member name="M:Xunit.Extensions.Assertions.IsType``1(System.Object)">
|
|
207 <summary>
|
|
208 Verifies that an object is exactly the given type (and not a derived type).
|
|
209 </summary>
|
|
210 <typeparam name="T">The type the object should be</typeparam>
|
|
211 <param name="object">The object to be evaluated</param>
|
|
212 <returns>The object, casted to type T when successful</returns>
|
|
213 <exception cref="T:Xunit.Sdk.IsTypeException">Thrown when the object is not the given type</exception>
|
|
214 </member>
|
|
215 <member name="M:Xunit.Extensions.Assertions.IsType(System.Type,System.Object)">
|
|
216 <summary>
|
|
217 Verifies that an object is exactly the given type (and not a derived type).
|
|
218 </summary>
|
|
219 <param name="expectedType">The type the object should be</param>
|
|
220 <param name="object">The object to be evaluated</param>
|
|
221 <exception cref="T:Xunit.Sdk.IsTypeException">Thrown when the object is not the given type</exception>
|
|
222 </member>
|
|
223 <member name="M:Xunit.Extensions.Assertions.NotEmpty(System.Collections.IEnumerable)">
|
|
224 <summary>
|
|
225 Verifies that a collection is not empty.
|
|
226 </summary>
|
|
227 <param name="collection">The collection to be inspected</param>
|
|
228 <exception cref="T:System.ArgumentNullException">Thrown when a null collection is passed</exception>
|
|
229 <exception cref="T:Xunit.Sdk.NotEmptyException">Thrown when the collection is empty</exception>
|
|
230 </member>
|
|
231 <member name="M:Xunit.Extensions.Assertions.NotEqual``1(``0,``0)">
|
|
232 <summary>
|
|
233 Verifies that two objects are not equal, using a default comparer.
|
|
234 </summary>
|
|
235 <typeparam name="T">The type of the objects to be compared</typeparam>
|
|
236 <param name="expected">The expected object</param>
|
|
237 <param name="actual">The actual object</param>
|
|
238 <exception cref="T:Xunit.Sdk.NotEqualException">Thrown when the objects are equal</exception>
|
|
239 </member>
|
|
240 <member name="M:Xunit.Extensions.Assertions.NotEqual``1(``0,``0,System.Collections.Generic.IEqualityComparer{``0})">
|
|
241 <summary>
|
|
242 Verifies that two objects are not equal, using a custom equality comparer.
|
|
243 </summary>
|
|
244 <typeparam name="T">The type of the objects to be compared</typeparam>
|
|
245 <param name="expected">The expected object</param>
|
|
246 <param name="actual">The actual object</param>
|
|
247 <param name="comparer">The comparer used to examine the objects</param>
|
|
248 <exception cref="T:Xunit.Sdk.NotEqualException">Thrown when the objects are equal</exception>
|
|
249 </member>
|
|
250 <member name="M:Xunit.Extensions.Assertions.NotInRange``1(``0,``0,``0)">
|
|
251 <summary>
|
|
252 Verifies that a value is not within a given range, using the default comparer.
|
|
253 </summary>
|
|
254 <typeparam name="T">The type of the value to be compared</typeparam>
|
|
255 <param name="actual">The actual value to be evaluated</param>
|
|
256 <param name="low">The (inclusive) low value of the range</param>
|
|
257 <param name="high">The (inclusive) high value of the range</param>
|
|
258 <exception cref="T:Xunit.Sdk.NotInRangeException">Thrown when the value is in the given range</exception>
|
|
259 </member>
|
|
260 <member name="M:Xunit.Extensions.Assertions.NotInRange``1(``0,``0,``0,System.Collections.Generic.IComparer{``0})">
|
|
261 <summary>
|
|
262 Verifies that a value is not within a given range, using a comparer.
|
|
263 </summary>
|
|
264 <typeparam name="T">The type of the value to be compared</typeparam>
|
|
265 <param name="actual">The actual value to be evaluated</param>
|
|
266 <param name="low">The (inclusive) low value of the range</param>
|
|
267 <param name="high">The (inclusive) high value of the range</param>
|
|
268 <param name="comparer">The comparer used to evaluate the value's range</param>
|
|
269 <exception cref="T:Xunit.Sdk.NotInRangeException">Thrown when the value is in the given range</exception>
|
|
270 </member>
|
|
271 <member name="M:Xunit.Extensions.Assertions.NotNull(System.Object)">
|
|
272 <summary>
|
|
273 Verifies that an object reference is not null.
|
|
274 </summary>
|
|
275 <param name="object">The object to be validated</param>
|
|
276 <exception cref="T:Xunit.Sdk.NotNullException">Thrown when the object is not null</exception>
|
|
277 </member>
|
|
278 <member name="M:Xunit.Extensions.Assertions.NotSame(System.Object,System.Object)">
|
|
279 <summary>
|
|
280 Verifies that two objects are not the same instance.
|
|
281 </summary>
|
|
282 <param name="expected">The expected object instance</param>
|
|
283 <param name="actual">The actual object instance</param>
|
|
284 <exception cref="T:Xunit.Sdk.NotSameException">Thrown when the objects are the same instance</exception>
|
|
285 </member>
|
|
286 <member name="M:Xunit.Extensions.Assertions.Null(System.Object)">
|
|
287 <summary>
|
|
288 Verifies that an object reference is null.
|
|
289 </summary>
|
|
290 <param name="object">The object to be inspected</param>
|
|
291 <exception cref="T:Xunit.Sdk.NullException">Thrown when the object reference is not null</exception>
|
|
292 </member>
|
|
293 <member name="M:Xunit.Extensions.Assertions.Same(System.Object,System.Object)">
|
|
294 <summary>
|
|
295 Verifies that two objects are the same instance.
|
|
296 </summary>
|
|
297 <param name="expected">The expected object instance</param>
|
|
298 <param name="actual">The actual object instance</param>
|
|
299 <exception cref="T:Xunit.Sdk.SameException">Thrown when the objects are not the same instance</exception>
|
|
300 </member>
|
|
301 <member name="M:Xunit.Extensions.Assertions.Single(System.Collections.IEnumerable)">
|
|
302 <summary>
|
|
303 Verifies that the given collection contains only a single
|
|
304 element of the given type.
|
|
305 </summary>
|
|
306 <param name="collection">The collection.</param>
|
|
307 <returns>The single item in the collection.</returns>
|
|
308 <exception cref="T:Xunit.Sdk.SingleException">Thrown when the collection does not contain
|
|
309 exactly one element.</exception>
|
|
310 </member>
|
|
311 <member name="M:Xunit.Extensions.Assertions.Single``1(System.Collections.Generic.IEnumerable{``0})">
|
|
312 <summary>
|
|
313 Verifies that the given collection contains only a single
|
|
314 element of the given type.
|
|
315 </summary>
|
|
316 <typeparam name="T">The collection type.</typeparam>
|
|
317 <param name="collection">The collection.</param>
|
|
318 <returns>The single item in the collection.</returns>
|
|
319 <exception cref="T:Xunit.Sdk.SingleException">Thrown when the collection does not contain
|
|
320 exactly one element.</exception>
|
|
321 </member>
|
|
322 <member name="M:Xunit.Extensions.Assertions.Throws``1(Xunit.Assert.ThrowsDelegate)">
|
|
323 <summary>
|
|
324 Verifies that the exact exception is thrown (and not a derived exception type).
|
|
325 </summary>
|
|
326 <typeparam name="T">The type of the exception expected to be thrown</typeparam>
|
|
327 <param name="testCode">A delegate to the code to be tested</param>
|
|
328 <returns>The exception that was thrown, when successful</returns>
|
|
329 <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
|
|
330 </member>
|
|
331 <member name="M:Xunit.Extensions.Assertions.Throws``1(Xunit.Assert.ThrowsDelegateWithReturn)">
|
|
332 <summary>
|
|
333 Verifies that the exact exception is thrown (and not a derived exception type).
|
|
334 Generally used to test property accessors.
|
|
335 </summary>
|
|
336 <typeparam name="T">The type of the exception expected to be thrown</typeparam>
|
|
337 <param name="testCode">A delegate to the code to be tested</param>
|
|
338 <returns>The exception that was thrown, when successful</returns>
|
|
339 <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
|
|
340 </member>
|
|
341 <member name="M:Xunit.Extensions.Assertions.Throws(System.Type,Xunit.Assert.ThrowsDelegate)">
|
|
342 <summary>
|
|
343 Verifies that the exact exception is thrown (and not a derived exception type).
|
|
344 </summary>
|
|
345 <param name="exceptionType">The type of the exception expected to be thrown</param>
|
|
346 <param name="testCode">A delegate to the code to be tested</param>
|
|
347 <returns>The exception that was thrown, when successful</returns>
|
|
348 <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
|
|
349 </member>
|
|
350 <member name="M:Xunit.Extensions.Assertions.Throws(System.Type,Xunit.Assert.ThrowsDelegateWithReturn)">
|
|
351 <summary>
|
|
352 Verifies that the exact exception is thrown (and not a derived exception type).
|
|
353 Generally used to test property accessors.
|
|
354 </summary>
|
|
355 <param name="exceptionType">The type of the exception expected to be thrown</param>
|
|
356 <param name="testCode">A delegate to the code to be tested</param>
|
|
357 <returns>The exception that was thrown, when successful</returns>
|
|
358 <exception cref="T:Xunit.Sdk.ThrowsException">Thrown when an exception was not thrown, or when an exception of the incorrect type is thrown</exception>
|
|
359 </member>
|
|
360 <member name="M:Xunit.Extensions.Assertions.True(System.Boolean)">
|
|
361 <summary>
|
|
362 Verifies that an expression is true.
|
|
363 </summary>
|
|
364 <param name="condition">The condition to be inspected</param>
|
|
365 <exception cref="T:Xunit.Sdk.TrueException">Thrown when the condition is false</exception>
|
|
366 </member>
|
|
367 <member name="M:Xunit.Extensions.Assertions.True(System.Boolean,System.String)">
|
|
368 <summary>
|
|
369 Verifies that an expression is true.
|
|
370 </summary>
|
|
371 <param name="condition">The condition to be inspected</param>
|
|
372 <param name="userMessage">The message to be shown when the condition is false</param>
|
|
373 <exception cref="T:Xunit.Sdk.TrueException">Thrown when the condition is false</exception>
|
|
374 </member>
|
|
375 <member name="T:Xunit.Extensions.TestClass">
|
|
376 <summary>
|
|
377 A class which can be derived from for test classes, which bring an overridable version
|
|
378 of Assert (using the <see cref="T:Xunit.Extensions.Assertions"/> class.
|
|
379 </summary>
|
|
380 </member>
|
|
381 <member name="P:Xunit.Extensions.TestClass.Assert">
|
|
382 <summary>
|
|
383 Gets a class which provides assertions.
|
|
384 </summary>
|
|
385 </member>
|
|
386 <member name="T:Xunit.Extensions.AssumeIdentityAttribute">
|
|
387 <summary>
|
|
388 Apply this attribute to your test method to replace the
|
|
389 <see cref="P:System.Threading.Thread.CurrentPrincipal"/> with another role.
|
|
390 </summary>
|
|
391 </member>
|
|
392 <member name="M:Xunit.Extensions.AssumeIdentityAttribute.#ctor(System.String)">
|
|
393 <summary>
|
|
394 Replaces the identity of the current thread with <paramref name="name"/>.
|
|
395 </summary>
|
|
396 <param name="name">The role's name</param>
|
|
397 </member>
|
|
398 <member name="M:Xunit.Extensions.AssumeIdentityAttribute.After(System.Reflection.MethodInfo)">
|
|
399 <summary>
|
|
400 Restores the original <see cref="P:System.Threading.Thread.CurrentPrincipal"/>.
|
|
401 </summary>
|
|
402 <param name="methodUnderTest">The method under test</param>
|
|
403 </member>
|
|
404 <member name="M:Xunit.Extensions.AssumeIdentityAttribute.Before(System.Reflection.MethodInfo)">
|
|
405 <summary>
|
|
406 Stores the current <see cref="P:System.Threading.Thread.CurrentPrincipal"/> and replaces it with
|
|
407 a new role identified in constructor.
|
|
408 </summary>
|
|
409 <param name="methodUnderTest">The method under test</param>
|
|
410 </member>
|
|
411 <member name="P:Xunit.Extensions.AssumeIdentityAttribute.Name">
|
|
412 <summary>
|
|
413 Gets the name.
|
|
414 </summary>
|
|
415 </member>
|
|
416 <member name="T:Xunit.Extensions.AutoRollbackAttribute">
|
|
417 <summary>
|
|
418 Apply this attribute to your test method to automatically create a
|
|
419 <see cref="T:System.Transactions.TransactionScope"/> that is rolled back when the test is
|
|
420 finished.
|
|
421 </summary>
|
|
422 </member>
|
|
423 <member name="M:Xunit.Extensions.AutoRollbackAttribute.After(System.Reflection.MethodInfo)">
|
|
424 <summary>
|
|
425 Rolls back the transaction.
|
|
426 </summary>
|
|
427 </member>
|
|
428 <member name="M:Xunit.Extensions.AutoRollbackAttribute.Before(System.Reflection.MethodInfo)">
|
|
429 <summary>
|
|
430 Creates the transaction.
|
|
431 </summary>
|
|
432 </member>
|
|
433 <member name="P:Xunit.Extensions.AutoRollbackAttribute.IsolationLevel">
|
|
434 <summary>
|
|
435 Gets or sets the isolation level of the transaction.
|
|
436 Default value is <see cref="P:Xunit.Extensions.AutoRollbackAttribute.IsolationLevel"/>.Unspecified.
|
|
437 </summary>
|
|
438 </member>
|
|
439 <member name="P:Xunit.Extensions.AutoRollbackAttribute.ScopeOption">
|
|
440 <summary>
|
|
441 Gets or sets the scope option for the transaction.
|
|
442 Default value is <see cref="T:System.Transactions.TransactionScopeOption"/>.Required.
|
|
443 </summary>
|
|
444 </member>
|
|
445 <member name="P:Xunit.Extensions.AutoRollbackAttribute.TimeoutInMS">
|
|
446 <summary>
|
|
447 Gets or sets the timeout of the transaction, in milliseconds.
|
|
448 By default, the transaction will not timeout.
|
|
449 </summary>
|
|
450 </member>
|
|
451 <member name="T:Xunit.Extensions.ClassDataAttribute">
|
|
452 <summary>
|
|
453 Provides a data source for a data theory, with the data coming from a class
|
|
454 which must implement IEnumerable<object[]>.
|
|
455 </summary>
|
|
456 </member>
|
|
457 <member name="T:Xunit.Extensions.DataAttribute">
|
|
458 <summary>
|
|
459 Abstract attribute which represents a data source for a data theory.
|
|
460 Data source providers derive from this attribute and implement GetData
|
|
461 to return the data for the theory.
|
|
462 </summary>
|
|
463 </member>
|
|
464 <member name="M:Xunit.Extensions.DataAttribute.GetData(System.Reflection.MethodInfo,System.Type[])">
|
|
465 <summary>
|
|
466 Returns the data to be used to test the theory.
|
|
467 </summary>
|
|
468 <remarks>
|
|
469 The <paramref name="parameterTypes"/> parameter is provided so that the
|
|
470 test data can be converted to the destination parameter type when necessary.
|
|
471 Generally, data should NOT be automatically converted, UNLESS the source data
|
|
472 format does not have rich types (for example, all numbers in Excel spreadsheets
|
|
473 are returned as <see cref="T:System.Double"/> even if they are integers). Derivers of
|
|
474 this class should NOT throw exceptions for mismatched types or mismatched number
|
|
475 of parameters; the test framework will throw these exceptions at the correct
|
|
476 time.
|
|
477 </remarks>
|
|
478 <param name="methodUnderTest">The method that is being tested</param>
|
|
479 <param name="parameterTypes">The types of the parameters for the test method</param>
|
|
480 <returns>The theory data</returns>
|
|
481 </member>
|
|
482 <member name="P:Xunit.Extensions.DataAttribute.TypeId">
|
|
483 <inheritdoc/>
|
|
484 </member>
|
|
485 <member name="M:Xunit.Extensions.ClassDataAttribute.#ctor(System.Type)">
|
|
486 <summary>
|
|
487 Initializes a new instance of the <see cref="T:Xunit.Extensions.ClassDataAttribute"/> class.
|
|
488 </summary>
|
|
489 <param name="class">The class that provides the data.</param>
|
|
490 </member>
|
|
491 <member name="M:Xunit.Extensions.ClassDataAttribute.GetData(System.Reflection.MethodInfo,System.Type[])">
|
|
492 <inheritdoc/>
|
|
493 </member>
|
|
494 <member name="P:Xunit.Extensions.ClassDataAttribute.Class">
|
|
495 <summary>
|
|
496 Gets the type of the class that provides the data.
|
|
497 </summary>
|
|
498 </member>
|
|
499 <member name="T:Xunit.Extensions.DataAdapterDataAttribute">
|
|
500 <summary>
|
|
501 Represents an implementation of <see cref="T:Xunit.Extensions.DataAttribute"/> which uses an
|
|
502 instance of <see cref="T:System.Data.IDataAdapter"/> to get the data for a <see cref="T:Xunit.Extensions.TheoryAttribute"/>
|
|
503 decorated test method.
|
|
504 </summary>
|
|
505 </member>
|
|
506 <member name="M:Xunit.Extensions.DataAdapterDataAttribute.GetData(System.Reflection.MethodInfo,System.Type[])">
|
|
507 <inheritdoc/>
|
|
508 </member>
|
|
509 <member name="M:Xunit.Extensions.DataAdapterDataAttribute.ConvertParameter(System.Object,System.Type)">
|
|
510 <summary>
|
|
511 Converts a parameter to its destination parameter type, if necessary.
|
|
512 </summary>
|
|
513 <param name="parameter">The parameter value</param>
|
|
514 <param name="parameterType">The destination parameter type (null if not known)</param>
|
|
515 <returns>The converted parameter value</returns>
|
|
516 </member>
|
|
517 <member name="P:Xunit.Extensions.DataAdapterDataAttribute.DataAdapter">
|
|
518 <summary>
|
|
519 Gets the data adapter to be used to retrieve the test data.
|
|
520 </summary>
|
|
521 </member>
|
|
522 <member name="T:Xunit.Extensions.InlineDataAttribute">
|
|
523 <summary>
|
|
524 Provides a data source for a data theory, with the data coming from inline values.
|
|
525 </summary>
|
|
526 </member>
|
|
527 <member name="M:Xunit.Extensions.InlineDataAttribute.#ctor(System.Object[])">
|
|
528 <summary>
|
|
529 Initializes a new instance of the <see cref="T:Xunit.Extensions.InlineDataAttribute"/> class.
|
|
530 </summary>
|
|
531 <param name="dataValues">The data values to pass to the theory</param>
|
|
532 </member>
|
|
533 <member name="M:Xunit.Extensions.InlineDataAttribute.GetData(System.Reflection.MethodInfo,System.Type[])">
|
|
534 <summary>
|
|
535 Returns the data to be used to test the theory.
|
|
536 </summary>
|
|
537 <param name="methodUnderTest">The method that is being tested</param>
|
|
538 <param name="parameterTypes">The types of the parameters for the test method</param>
|
|
539 <returns>The theory data, in table form</returns>
|
|
540 </member>
|
|
541 <member name="P:Xunit.Extensions.InlineDataAttribute.DataValues">
|
|
542 <summary>
|
|
543 Gets the data values.
|
|
544 </summary>
|
|
545 </member>
|
|
546 <member name="T:Xunit.Extensions.OleDbDataAttribute">
|
|
547 <summary>
|
|
548 Provides a data source for a data theory, with the data coming from an OLEDB connection.
|
|
549 </summary>
|
|
550 </member>
|
|
551 <member name="M:Xunit.Extensions.OleDbDataAttribute.#ctor(System.String,System.String)">
|
|
552 <summary>
|
|
553 Creates a new instance of <see cref="T:Xunit.Extensions.OleDbDataAttribute"/>.
|
|
554 </summary>
|
|
555 <param name="connectionString">The OLEDB connection string to the data</param>
|
|
556 <param name="selectStatement">The SELECT statement used to return the data for the theory</param>
|
|
557 </member>
|
|
558 <member name="P:Xunit.Extensions.OleDbDataAttribute.ConnectionString">
|
|
559 <summary>
|
|
560 Gets the connection string.
|
|
561 </summary>
|
|
562 </member>
|
|
563 <member name="P:Xunit.Extensions.OleDbDataAttribute.SelectStatement">
|
|
564 <summary>
|
|
565 Gets the select statement.
|
|
566 </summary>
|
|
567 </member>
|
|
568 <member name="P:Xunit.Extensions.OleDbDataAttribute.DataAdapter">
|
|
569 <inheritdoc/>
|
|
570 </member>
|
|
571 <member name="T:Xunit.Extensions.PropertyDataAttribute">
|
|
572 <summary>
|
|
573 Provides a data source for a data theory, with the data coming from a public static property on the test class.
|
|
574 The property must return IEnumerable<object[]> with the test data.
|
|
575 </summary>
|
|
576 </member>
|
|
577 <member name="M:Xunit.Extensions.PropertyDataAttribute.#ctor(System.String)">
|
|
578 <summary>
|
|
579 Creates a new instance of <see cref="T:Xunit.Extensions.PropertyDataAttribute"/>/
|
|
580 </summary>
|
|
581 <param name="propertyName">The name of the public static property on the test class that will provide the test data</param>
|
|
582 </member>
|
|
583 <member name="M:Xunit.Extensions.PropertyDataAttribute.GetData(System.Reflection.MethodInfo,System.Type[])">
|
|
584 <summary>
|
|
585 Returns the data to be used to test the theory.
|
|
586 </summary>
|
|
587 <param name="methodUnderTest">The method that is being tested</param>
|
|
588 <param name="parameterTypes">The types of the parameters for the test method</param>
|
|
589 <returns>The theory data, in table form</returns>
|
|
590 </member>
|
|
591 <member name="P:Xunit.Extensions.PropertyDataAttribute.PropertyName">
|
|
592 <summary>
|
|
593 Gets the property name.
|
|
594 </summary>
|
|
595 </member>
|
|
596 <member name="T:Xunit.Extensions.SqlServerDataAttribute">
|
|
597 <summary>
|
|
598 Provides a data source for a data theory, with the data coming a Microsoft SQL Server.
|
|
599 </summary>
|
|
600 </member>
|
|
601 <member name="M:Xunit.Extensions.SqlServerDataAttribute.#ctor(System.String,System.String,System.String)">
|
|
602 <summary>
|
|
603 Creates a new instance of <see cref="T:Xunit.Extensions.SqlServerDataAttribute"/>, using a trusted connection.
|
|
604 </summary>
|
|
605 <param name="serverName">The server name of the Microsoft SQL Server</param>
|
|
606 <param name="databaseName">The database name</param>
|
|
607 <param name="selectStatement">The SQL SELECT statement to return the data for the data theory</param>
|
|
608 </member>
|
|
609 <member name="M:Xunit.Extensions.SqlServerDataAttribute.#ctor(System.String,System.String,System.String,System.String,System.String)">
|
|
610 <summary>
|
|
611 Creates a new instance of <see cref="T:Xunit.Extensions.SqlServerDataAttribute"/>, using the provided username and password.
|
|
612 </summary>
|
|
613 <param name="serverName">The server name of the Microsoft SQL Server</param>
|
|
614 <param name="databaseName">The database name</param>
|
|
615 <param name="username">The username for the server</param>
|
|
616 <param name="password">The password for the server</param>
|
|
617 <param name="selectStatement">The SQL SELECT statement to return the data for the data theory</param>
|
|
618 </member>
|
|
619 <member name="T:Xunit.Extensions.ExcelDataAttribute">
|
|
620 <summary>
|
|
621 Provides a data source for a data theory, with the data coming a Microsoft Excel (.xls) spreadsheet.
|
|
622 </summary>
|
|
623 </member>
|
|
624 <member name="M:Xunit.Extensions.ExcelDataAttribute.#ctor(System.String,System.String)">
|
|
625 <summary>
|
|
626 Creates a new instance of <see cref="T:Xunit.Extensions.ExcelDataAttribute"/>.
|
|
627 </summary>
|
|
628 <param name="filename">The filename of the XLS spreadsheet file; if the filename provided
|
|
629 is relative, then it is relative to the location of xunit.extensions.dll.</param>
|
|
630 <param name="selectStatement">The SELECT statement that returns the data for the theory</param>
|
|
631 </member>
|
|
632 <member name="M:Xunit.Extensions.ExcelDataAttribute.ConvertParameter(System.Object,System.Type)">
|
|
633 <inheritdoc/>
|
|
634 </member>
|
|
635 <member name="T:Xunit.Extensions.Clock">
|
|
636 <summary>
|
|
637 A wrapper around the static operations on <see cref="T:System.DateTime"/> which allows time
|
|
638 to be frozen using the <see cref="T:Xunit.Extensions.FreezeClockAttribute"/>. The clock begins in the
|
|
639 thawed state; that is, calls to <see cref="P:Xunit.Extensions.Clock.Now"/>, <see cref="P:Xunit.Extensions.Clock.Today"/>, and
|
|
640 <see cref="P:Xunit.Extensions.Clock.UtcNow"/> return current (non-frozen) values.
|
|
641 </summary>
|
|
642 </member>
|
|
643 <member name="M:Xunit.Extensions.Clock.Freeze">
|
|
644 <summary>
|
|
645 Freezes the clock with the current time.
|
|
646 Until <see cref="M:Xunit.Extensions.Clock.Thaw"/> is called, all calls to <see cref="P:Xunit.Extensions.Clock.Now"/>, <see cref="P:Xunit.Extensions.Clock.Today"/>, and
|
|
647 <see cref="P:Xunit.Extensions.Clock.UtcNow"/> will return the exact same values.
|
|
648 </summary>
|
|
649 </member>
|
|
650 <member name="M:Xunit.Extensions.Clock.FreezeLocal(System.DateTime)">
|
|
651 <summary>
|
|
652 Freezes the clock with the given date and time, considered to be local time.
|
|
653 Until <see cref="M:Xunit.Extensions.Clock.Thaw"/> is called, all calls to <see cref="P:Xunit.Extensions.Clock.Now"/>, <see cref="P:Xunit.Extensions.Clock.Today"/>, and
|
|
654 <see cref="P:Xunit.Extensions.Clock.UtcNow"/> will return the exact same values.
|
|
655 </summary>
|
|
656 <param name="localDateTime">The local date and time to freeze to</param>
|
|
657 </member>
|
|
658 <member name="M:Xunit.Extensions.Clock.FreezeUtc(System.DateTime)">
|
|
659 <summary>
|
|
660 Freezes the clock with the given date and time, considered to be Coordinated Universal Time (UTC).
|
|
661 Until <see cref="M:Xunit.Extensions.Clock.Thaw"/> is called, all calls to <see cref="P:Xunit.Extensions.Clock.Now"/>, <see cref="P:Xunit.Extensions.Clock.Today"/>, and
|
|
662 <see cref="P:Xunit.Extensions.Clock.UtcNow"/> will return the exact same values.
|
|
663 </summary>
|
|
664 <param name="utcDateTime">The UTC date and time to freeze to</param>
|
|
665 </member>
|
|
666 <member name="M:Xunit.Extensions.Clock.Thaw">
|
|
667 <summary>
|
|
668 Thaws the clock so that <see cref="P:Xunit.Extensions.Clock.Now"/>, <see cref="P:Xunit.Extensions.Clock.Today"/>, and <see cref="P:Xunit.Extensions.Clock.UtcNow"/>
|
|
669 return normal values.
|
|
670 </summary>
|
|
671 </member>
|
|
672 <member name="P:Xunit.Extensions.Clock.Now">
|
|
673 <summary>
|
|
674 Gets a <see cref="T:System.DateTime"/> object that is set to the current date and time on this computer,
|
|
675 expressed as the local time.
|
|
676 </summary>
|
|
677 </member>
|
|
678 <member name="P:Xunit.Extensions.Clock.Today">
|
|
679 <summary>
|
|
680 Gets the current date.
|
|
681 </summary>
|
|
682 </member>
|
|
683 <member name="P:Xunit.Extensions.Clock.UtcNow">
|
|
684 <summary>
|
|
685 Gets a <see cref="T:System.DateTime"/> object that is set to the current date and time on this computer,
|
|
686 expressed as the Coordinated Universal Time (UTC).
|
|
687 </summary>
|
|
688 </member>
|
|
689 <member name="T:Xunit.Extensions.FreezeClockAttribute">
|
|
690 <summary>
|
|
691 Apply this attribute to your test method to freeze the time represented by the
|
|
692 <see cref="T:Xunit.Extensions.Clock"/> class.
|
|
693 </summary>
|
|
694 </member>
|
|
695 <member name="M:Xunit.Extensions.FreezeClockAttribute.#ctor">
|
|
696 <summary>
|
|
697 Freeze the clock with the current date and time.
|
|
698 </summary>
|
|
699 </member>
|
|
700 <member name="M:Xunit.Extensions.FreezeClockAttribute.#ctor(System.Int32,System.Int32,System.Int32)">
|
|
701 <summary>
|
|
702 Freeze the clock with the given date, considered to be local time.
|
|
703 </summary>
|
|
704 <param name="year">The frozen year</param>
|
|
705 <param name="month">The frozen month</param>
|
|
706 <param name="day">The frozen day</param>
|
|
707 </member>
|
|
708 <member name="M:Xunit.Extensions.FreezeClockAttribute.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)">
|
|
709 <summary>
|
|
710 Freeze the clock with the given date and time, considered to be in local time.
|
|
711 </summary>
|
|
712 <param name="year">The frozen year</param>
|
|
713 <param name="month">The frozen month</param>
|
|
714 <param name="day">The frozen day</param>
|
|
715 <param name="hour">The frozen hour</param>
|
|
716 <param name="minute">The frozen minute</param>
|
|
717 <param name="second">The frozen second</param>
|
|
718 </member>
|
|
719 <member name="M:Xunit.Extensions.FreezeClockAttribute.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.DateTimeKind)">
|
|
720 <summary>
|
|
721 Freeze the clock with the given date and time, with the given kind of time.
|
|
722 </summary>
|
|
723 <param name="year">The frozen year</param>
|
|
724 <param name="month">The frozen month</param>
|
|
725 <param name="day">The frozen day</param>
|
|
726 <param name="hour">The frozen hour</param>
|
|
727 <param name="minute">The frozen minute</param>
|
|
728 <param name="second">The frozen second</param>
|
|
729 <param name="kind">The frozen time kind</param>
|
|
730 </member>
|
|
731 <member name="M:Xunit.Extensions.FreezeClockAttribute.After(System.Reflection.MethodInfo)">
|
|
732 <summary>
|
|
733 Thaws the clock.
|
|
734 </summary>
|
|
735 <param name="methodUnderTest">The method under test</param>
|
|
736 </member>
|
|
737 <member name="M:Xunit.Extensions.FreezeClockAttribute.Before(System.Reflection.MethodInfo)">
|
|
738 <summary>
|
|
739 Freezes the clock.
|
|
740 </summary>
|
|
741 <param name="methodUnderTest">The method under test</param>
|
|
742 </member>
|
|
743 <member name="T:Xunit.Extensions.TheoryAttribute">
|
|
744 <summary>
|
|
745 Marks a test method as being a data theory. Data theories are tests which are fed
|
|
746 various bits of data from a data source, mapping to parameters on the test method.
|
|
747 If the data source contains multiple rows, then the test method is executed
|
|
748 multiple times (once with each data row).
|
|
749 </summary>
|
|
750 </member>
|
|
751 <member name="M:Xunit.Extensions.TheoryAttribute.EnumerateTestCommands(Xunit.Sdk.IMethodInfo)">
|
|
752 <summary>
|
|
753 Creates instances of <see cref="T:Xunit.Extensions.TheoryCommand"/> which represent individual intended
|
|
754 invocations of the test method, one per data row in the data source.
|
|
755 </summary>
|
|
756 <param name="method">The method under test</param>
|
|
757 <returns>An enumerator through the desired test method invocations</returns>
|
|
758 </member>
|
|
759 <member name="T:Xunit.Extensions.TheoryCommand">
|
|
760 <summary>
|
|
761 Represents a single invocation of a data theory test method.
|
|
762 </summary>
|
|
763 </member>
|
|
764 <member name="M:Xunit.Extensions.TheoryCommand.#ctor(Xunit.Sdk.IMethodInfo,System.Object[])">
|
|
765 <summary>
|
|
766 Creates a new instance of <see cref="T:Xunit.Extensions.TheoryCommand"/>.
|
|
767 </summary>
|
|
768 <param name="testMethod">The method under test</param>
|
|
769 <param name="parameters">The parameters to be passed to the test method</param>
|
|
770 </member>
|
|
771 <member name="M:Xunit.Extensions.TheoryCommand.#ctor(Xunit.Sdk.IMethodInfo,System.Object[],System.Type[])">
|
|
772 <summary>
|
|
773 Creates a new instance of <see cref="T:Xunit.Extensions.TheoryCommand"/> based on a generic theory.
|
|
774 </summary>
|
|
775 <param name="testMethod">The method under test</param>
|
|
776 <param name="parameters">The parameters to be passed to the test method</param>
|
|
777 <param name="genericTypes">The generic types that were used to resolved the generic method.</param>
|
|
778 </member>
|
|
779 <member name="M:Xunit.Extensions.TheoryCommand.Execute(System.Object)">
|
|
780 <inheritdoc/>
|
|
781 </member>
|
|
782 <member name="P:Xunit.Extensions.TheoryCommand.Parameters">
|
|
783 <summary>
|
|
784 Gets the parameter values that are passed to the test method.
|
|
785 </summary>
|
|
786 </member>
|
|
787 <member name="T:Xunit.Extensions.TraceAttribute">
|
|
788 <summary>
|
|
789 Apply to a test method to trace the method begin and end.
|
|
790 </summary>
|
|
791 </member>
|
|
792 <member name="M:Xunit.Extensions.TraceAttribute.Before(System.Reflection.MethodInfo)">
|
|
793 <summary>
|
|
794 This method is called before the test method is executed.
|
|
795 </summary>
|
|
796 <param name="methodUnderTest">The method under test</param>
|
|
797 </member>
|
|
798 <member name="M:Xunit.Extensions.TraceAttribute.After(System.Reflection.MethodInfo)">
|
|
799 <summary>
|
|
800 This method is called after the test method is executed.
|
|
801 </summary>
|
|
802 <param name="methodUnderTest">The method under test</param>
|
|
803 </member>
|
|
804 </members>
|
|
805 </doc>
|