File: FileAssert.cs

package info (click to toggle)
mono 4.6.2.7+dfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 778,148 kB
  • ctags: 914,052
  • sloc: cs: 5,779,509; xml: 2,773,713; ansic: 432,645; sh: 14,749; makefile: 12,361; perl: 2,488; python: 1,434; cpp: 849; asm: 531; sql: 95; sed: 16; php: 1
file content (333 lines) | stat: -rw-r--r-- 12,966 bytes parent folder | download | duplicates (2)
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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
// ****************************************************************
// This is free software licensed under the NUnit license. You
// may obtain a copy of the license as well as information regarding
// copyright ownership at http://nunit.org/?p=license&r=2.4.
// ****************************************************************

using System;
using System.IO;
using System.ComponentModel;
using NUnit.Framework.Constraints;

namespace NUnit.Framework
{
	/// <summary>
	/// Summary description for FileAssert.
	/// </summary>
	public class FileAssert
	{
		#region Equals and ReferenceEquals

		/// <summary>
		/// The Equals method throws an AssertionException. This is done 
		/// to make sure there is no mistake by calling this function.
		/// </summary>
		/// <param name="a"></param>
		/// <param name="b"></param>
		[EditorBrowsable(EditorBrowsableState.Never)]
		public static new bool Equals(object a, object b)
		{
			throw new AssertionException("Assert.Equals should not be used for Assertions");
		}

		/// <summary>
		/// override the default ReferenceEquals to throw an AssertionException. This 
		/// implementation makes sure there is no mistake in calling this function 
		/// as part of Assert. 
		/// </summary>
		/// <param name="a"></param>
		/// <param name="b"></param>
		public static new void ReferenceEquals(object a, object b)
		{
			throw new AssertionException("Assert.ReferenceEquals should not be used for Assertions");
		}

		#endregion
				
		#region Constructor

		/// <summary>
		/// We don't actually want any instances of this object, but some people
		/// like to inherit from it to add other static methods. Hence, the
		/// protected constructor disallows any instances of this object. 
		/// </summary>
		protected FileAssert() {}

		#endregion

		#region AreEqual

		#region Streams
		
		/// <summary>
		/// Verifies that two Streams are equal.  Two Streams are considered
		/// equal if both are null, or if both have the same value byte for byte.
		/// If they are not equal an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">The expected Stream</param>
		/// <param name="actual">The actual Stream</param>
		/// <param name="message">The message to display if Streams are not equal</param>
		/// <param name="args">Arguments to be used in formatting the message</param>
		static public void AreEqual(Stream expected, Stream actual, string message, params object[] args)
		{
			Assert.That( actual, new EqualConstraint( expected ), message, args );
		}

		/// <summary>
		/// Verifies that two Streams are equal.  Two Streams are considered
		/// equal if both are null, or if both have the same value byte for byte.
		/// If they are not equal an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">The expected Stream</param>
		/// <param name="actual">The actual Stream</param>
		/// <param name="message">The message to display if objects are not equal</param>
		static public void AreEqual(Stream expected, Stream actual, string message) 
		{
			AreEqual(expected, actual, message, null);
		}

		/// <summary>
		/// Verifies that two Streams are equal.  Two Streams are considered
		/// equal if both are null, or if both have the same value byte for byte.
		/// If they are not equal an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">The expected Stream</param>
		/// <param name="actual">The actual Stream</param>
		static public void AreEqual(Stream expected, Stream actual) 
		{
			AreEqual(expected, actual, string.Empty, null);
		}

		#endregion

		#region FileInfo
		/// <summary>
		/// Verifies that two files are equal.  Two files are considered
		/// equal if both are null, or if both have the same value byte for byte.
		/// If they are not equal an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">A file containing the value that is expected</param>
		/// <param name="actual">A file containing the actual value</param>
		/// <param name="message">The message to display if Streams are not equal</param>
		/// <param name="args">Arguments to be used in formatting the message</param>
		static public void AreEqual(FileInfo expected, FileInfo actual, string message, params object[] args)
		{
			using (FileStream exStream = expected.OpenRead())
			{
				using (FileStream acStream = actual.OpenRead())
				{
					AreEqual(exStream,acStream,message,args);
				}
			}
		}

		/// <summary>
		/// Verifies that two files are equal.  Two files are considered
		/// equal if both are null, or if both have the same value byte for byte.
		/// If they are not equal an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">A file containing the value that is expected</param>
		/// <param name="actual">A file containing the actual value</param>
		/// <param name="message">The message to display if objects are not equal</param>
		static public void AreEqual(FileInfo expected, FileInfo actual, string message) 
		{
			AreEqual(expected, actual, message, null);
		}

		/// <summary>
		/// Verifies that two files are equal.  Two files are considered
		/// equal if both are null, or if both have the same value byte for byte.
		/// If they are not equal an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">A file containing the value that is expected</param>
		/// <param name="actual">A file containing the actual value</param>
		static public void AreEqual(FileInfo expected, FileInfo actual) 
		{
			AreEqual(expected, actual, string.Empty, null);
		}

		#endregion

		#region String
		/// <summary>
		/// Verifies that two files are equal.  Two files are considered
		/// equal if both are null, or if both have the same value byte for byte.
		/// If they are not equal an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">The path to a file containing the value that is expected</param>
		/// <param name="actual">The path to a file containing the actual value</param>
		/// <param name="message">The message to display if Streams are not equal</param>
		/// <param name="args">Arguments to be used in formatting the message</param>
		static public void AreEqual(string expected, string actual, string message, params object[] args)
		{
			using (FileStream exStream = File.OpenRead(expected))
			{
				using (FileStream acStream = File.OpenRead(actual))
				{
					AreEqual(exStream,acStream,message,args);
				}
			}
		}

		/// <summary>
		/// Verifies that two files are equal.  Two files are considered
		/// equal if both are null, or if both have the same value byte for byte.
		/// If they are not equal an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">The path to a file containing the value that is expected</param>
		/// <param name="actual">The path to a file containing the actual value</param>
		/// <param name="message">The message to display if objects are not equal</param>
		static public void AreEqual(string expected, string actual, string message) 
		{
			AreEqual(expected, actual, message, null);
		}

		/// <summary>
		/// Verifies that two files are equal.  Two files are considered
		/// equal if both are null, or if both have the same value byte for byte.
		/// If they are not equal an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">The path to a file containing the value that is expected</param>
		/// <param name="actual">The path to a file containing the actual value</param>
		static public void AreEqual(string expected, string actual) 
		{
			AreEqual(expected, actual, string.Empty, null);
		}

		#endregion

		#endregion

		#region AreNotEqual

		#region Streams
		/// <summary>
		/// Asserts that two Streams are not equal. If they are equal
		/// an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">The expected Stream</param>
		/// <param name="actual">The actual Stream</param>
		/// <param name="message">The message to be displayed when the two Stream are the same.</param>
		/// <param name="args">Arguments to be used in formatting the message</param>
		static public void AreNotEqual( Stream expected, Stream actual, string message, params object[] args)
		{
			Assert.That( actual, new NotConstraint( new EqualConstraint( expected ) ), message, args );
		}

		/// <summary>
		/// Asserts that two Streams are not equal. If they are equal
		/// an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">The expected Stream</param>
		/// <param name="actual">The actual Stream</param>
		/// <param name="message">The message to be displayed when the Streams are the same.</param>
		static public void AreNotEqual(Stream expected, Stream actual, string message) 
		{
			AreNotEqual(expected, actual, message, null);
		}
   
		/// <summary>
		/// Asserts that two Streams are not equal. If they are equal
		/// an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">The expected Stream</param>
		/// <param name="actual">The actual Stream</param>
		static public void AreNotEqual(Stream expected, Stream actual) 
		{
			AreNotEqual(expected, actual, string.Empty, null);
		}
		#endregion
		
		#region FileInfo
		/// <summary>
		/// Asserts that two files are not equal. If they are equal
		/// an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">A file containing the value that is expected</param>
		/// <param name="actual">A file containing the actual value</param>
		/// <param name="message">The message to display if Streams are not equal</param>
		/// <param name="args">Arguments to be used in formatting the message</param>
		static public void AreNotEqual(FileInfo expected, FileInfo actual, string message, params object[] args)
		{
			using (FileStream exStream = expected.OpenRead())
			{
				using (FileStream acStream = actual.OpenRead())
				{
					AreNotEqual(exStream,acStream,message,args);
				}
			}
		}

		/// <summary>
		/// Asserts that two files are not equal. If they are equal
		/// an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">A file containing the value that is expected</param>
		/// <param name="actual">A file containing the actual value</param>
		/// <param name="message">The message to display if objects are not equal</param>
		static public void AreNotEqual(FileInfo expected, FileInfo actual, string message) 
		{
			AreNotEqual(expected, actual, message, null);
		}

		/// <summary>
		/// Asserts that two files are not equal. If they are equal
		/// an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">A file containing the value that is expected</param>
		/// <param name="actual">A file containing the actual value</param>
		static public void AreNotEqual(FileInfo expected, FileInfo actual) 
		{
			AreNotEqual(expected, actual, string.Empty, null);
		}

		#endregion
		
		#region String
		/// <summary>
		/// Asserts that two files are not equal. If they are equal
		/// an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">The path to a file containing the value that is expected</param>
		/// <param name="actual">The path to a file containing the actual value</param>
		/// <param name="message">The message to display if Streams are not equal</param>
		/// <param name="args">Arguments to be used in formatting the message</param>
		static public void AreNotEqual(string expected, string actual, string message, params object[] args)
		{
			using (FileStream exStream = File.OpenRead(expected))
			{
				using (FileStream acStream = File.OpenRead(actual))
				{
					AreNotEqual(exStream,acStream,message,args);
				}
			}
		}

		/// <summary>
		/// Asserts that two files are not equal. If they are equal
		/// an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">The path to a file containing the value that is expected</param>
		/// <param name="actual">The path to a file containing the actual value</param>
		/// <param name="message">The message to display if objects are not equal</param>
		static public void AreNotEqual(string expected, string actual, string message) 
		{
			AreNotEqual(expected, actual, message, null);
		}

		/// <summary>
		/// Asserts that two files are not equal. If they are equal
		/// an <see cref="AssertionException"/> is thrown.
		/// </summary>
		/// <param name="expected">The path to a file containing the value that is expected</param>
		/// <param name="actual">The path to a file containing the actual value</param>
		static public void AreNotEqual(string expected, string actual) 
		{
			AreNotEqual(expected, actual, string.Empty, null);
		}

		#endregion

		#endregion
	}
}