MonoRail/Castle.MonoRail.Framework/Test/MockResponse.cs

   1 // Copyright 2004-2007 Castle Project - http://www.castleproject.org/
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     http://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 namespace Castle.MonoRail.Framework.Test
  16 {
  17         using System;
  18         using System.Collections;
  19         using System.Collections.Specialized;
  20         using System.IO;
  21         using System.Web;
  22         using Internal;
  23
  24         /// <summary>
  25         /// Represents a mock implementation of <see cref="IMockResponse"/> for unit test purposes.
  26         /// </summary>
  27         public class MockResponse : IMockResponse
  28         {
  29                 private readonly IDictionary cookies;
  30                 private int statusCode = 400;
  31                 private string contentType = "text/html";
  32                 private string cacheControlHeader = null;
  33                 private string charset = "ISO-8859-1";
  34                 private string redirectedTo;
  35                 private bool wasRedirected = false;
  36                 private bool isClientConnected = false;
  37                 private TextWriter output = new StringWriter();
  38                 private Stream outputStream = new MemoryStream();
  39                 private TextWriter outputStreamWriter;
  40                 private HttpCachePolicy cachePolicy = null;
  41                 private NameValueCollection headers = new NameValueCollection();
  42
  43                 /// <summary>
  44                 /// Initializes a new instance of the <see cref="MockResponse"/> class.
  45                 /// </summary>
  46                 /// <param name="cookies">The cookies.</param>
  47                 public MockResponse(IDictionary cookies)
  48                 {
  49                         this.cookies = cookies;
  50                         outputStreamWriter = new StreamWriter(outputStream);
  51                 }
  52
  53                 /// <summary>
  54                 /// Gets the urls the request was redirected to.
  55                 /// </summary>
  56                 /// <value>The redirected to.</value>
  57                 public virtual string RedirectedTo
  58                 {
  59                         get { return redirectedTo; }
  60                 }
  61
  62                 /// <summary>
  63                 /// Gets the http headers.
  64                 /// </summary>
  65                 /// <value>The headers.</value>
  66                 public virtual NameValueCollection Headers
  67                 {
  68                         get { return headers; }
  69                 }
  70
  71                 #region IResponse Related
  72
  73                 /// <summary>
  74                 /// Appends the header.
  75                 /// </summary>
  76                 /// <param name="name">The name.</param>
  77                 /// <param name="value">The value.</param>
  78                 public void AppendHeader(string name, string value)
  79                 {
  80                         headers[name] = value;
  81                 }
  82
  83                 /// <summary>
  84                 /// Writes the buffer to the browser
  85                 /// </summary>
  86                 /// <param name="buffer">The buffer.</param>
  87                 public virtual void BinaryWrite(byte[] buffer)
  88                 {
  89                         outputStream.Write(buffer, 0, buffer.Length);
  90                 }
  91
  92                 /// <summary>
  93                 /// Writes the stream to the browser
  94                 /// </summary>
  95                 /// <param name="stream">The stream.</param>
  96                 public virtual void BinaryWrite(Stream stream)
  97                 {
  98                         byte[] buffer = new byte[stream.Length];
  99
 100                         stream.Read(buffer, 0, buffer.Length);
 101
 102                         BinaryWrite(buffer);
 103                 }
 104
 105                 /// <summary>
 106                 /// Clears the response (only works if buffered)
 107                 /// </summary>
 108                 public virtual void Clear()
 109                 {
 110                         outputStream.SetLength(0);
 111                 }
 112
 113                 /// <summary>
 114                 /// Clears the response content (only works if buffered).
 115                 /// </summary>
 116                 public virtual void ClearContent()
 117                 {
 118                         outputStreamWriter.Flush();
 119                 }
 120
 121                 /// <summary>
 122                 /// Writes the specified string.
 123                 /// </summary>
 124                 /// <param name="s">The string.</param>
 125                 public virtual void Write(string s)
 126                 {
 127                         outputStreamWriter.Write(s);
 128                 }
 129
 130                 /// <summary>
 131                 /// Writes the specified obj.
 132                 /// </summary>
 133                 /// <param name="obj">The obj.</param>
 134                 public virtual void Write(object obj)
 135                 {
 136                         outputStreamWriter.Write(obj);
 137                 }
 138
 139                 /// <summary>
 140                 /// Writes the specified char.
 141                 /// </summary>
 142                 /// <param name="ch">The char.</param>
 143                 public virtual void Write(char ch)
 144                 {
 145                         outputStreamWriter.Write(ch);
 146                 }
 147
 148                 /// <summary>
 149                 /// Writes the specified buffer.
 150                 /// </summary>
 151                 /// <param name="buffer">The buffer.</param>
 152                 /// <param name="index">The index.</param>
 153                 /// <param name="count">The count.</param>
 154                 public virtual void Write(char[] buffer, int index, int count)
 155                 {
 156                         outputStreamWriter.Write(buffer, index, count);
 157                 }
 158
 159                 /// <summary>
 160                 /// Writes the file.
 161                 /// </summary>
 162                 /// <param name="fileName">Name of the file.</param>
 163                 public virtual void WriteFile(string fileName)
 164                 {
 165                         throw new NotImplementedException();
 166                 }
 167
 168                 /// <summary>
 169                 /// Redirects the specified controller.
 170                 /// </summary>
 171                 /// <param name="controller">The controller.</param>
 172                 /// <param name="action">The action.</param>
 173                 public virtual void Redirect(string controller, string action)
 174                 {
 175                         Redirect(BuildMockUrl(null, controller, action));
 176                 }
 177
 178                 /// <summary>
 179                 /// Redirects the specified area.
 180                 /// </summary>
 181                 /// <param name="area">The area.</param>
 182                 /// <param name="controller">The controller.</param>
 183                 /// <param name="action">The action.</param>
 184                 public virtual void Redirect(string area, string controller, string action)
 185                 {
 186                         Redirect(BuildMockUrl(area, controller, action));
 187                 }
 188
 189                 /// <summary>
 190                 /// Redirects to another controller and action with the specified paramters.
 191                 /// </summary>
 192                 /// <param name="controller">Controller name</param>
 193                 /// <param name="action">Action name</param>
 194                 /// <param name="parameters">Key/value pairings</param>
 195                 public void Redirect(string controller, string action, NameValueCollection parameters)
 196                 {
 197                         Redirect(BuildMockUrl(controller, action, parameters));
 198                 }
 199
 200                 /// <summary>
 201                 /// Redirects to another controller and action with the specified paramters.
 202                 /// </summary>
 203                 /// <param name="area">Area name</param>
 204                 /// <param name="controller">Controller name</param>
 205                 /// <param name="action">Action name</param>
 206                 /// <param name="parameters">Key/value pairings</param>
 207                 public void Redirect(string area, string controller, string action, NameValueCollection parameters)
 208                 {
 209                         Redirect(BuildMockUrl(area, controller, action, parameters));
 210                 }
 211
 212                 /// <summary>
 213                 /// Redirects to another controller and action with the specified paramters.
 214                 /// </summary>
 215                 /// <param name="controller">Controller name</param>
 216                 /// <param name="action">Action name</param>
 217                 /// <param name="parameters">Key/value pairings</param>
 218                 public void Redirect(string controller, string action, IDictionary parameters)
 219                 {
 220                         Redirect(BuildMockUrl(controller, action, parameters));
 221                 }
 222
 223                 /// <summary>
 224                 /// Redirects to another controller and action with the specified paramters.
 225                 /// </summary>
 226                 /// <param name="area">Area name</param>
 227                 /// <param name="controller">Controller name</param>
 228                 /// <param name="action">Action name</param>
 229                 /// <param name="parameters">Key/value pairings</param>
 230                 public void Redirect(string area, string controller, string action, IDictionary parameters)
 231                 {
 232                         Redirect(BuildMockUrl(area, controller, action, parameters));
 233                 }
 234
 235                 /// <summary>
 236                 /// Redirects the specified URL.
 237                 /// </summary>
 238                 /// <param name="url">The URL.</param>
 239                 public virtual void Redirect(string url)
 240                 {
 241                         wasRedirected = true;
 242                         redirectedTo = url;
 243                 }
 244
 245                 /// <summary>
 246                 /// Redirects the specified URL.
 247                 /// </summary>
 248                 /// <param name="url">The URL.</param>
 249                 /// <param name="endProcess">if set to <c>true</c> [end process].</param>
 250                 public virtual void Redirect(string url, bool endProcess)
 251                 {
 252                         Redirect(url);
 253                 }
 254
 255                 /// <summary>
 256                 /// Creates a cookie.
 257                 /// </summary>
 258                 /// <param name="name">The name.</param>
 259                 /// <param name="value">The value.</param>
 260                 public virtual void CreateCookie(string name, string value)
 261                 {
 262                         cookies.Add(name, value);
 263                 }
 264
 265                 /// <summary>
 266                 /// Creates a cookie.
 267                 /// </summary>
 268                 /// <param name="name">The name.</param>
 269                 /// <param name="value">The value.</param>
 270                 /// <param name="expiration">The expiration.</param>
 271                 public virtual void CreateCookie(string name, string value, DateTime expiration)
 272                 {
 273                         CreateCookie(name, value);
 274                 }
 275
 276                 /// <summary>
 277                 /// Creates a cookie.
 278                 /// </summary>
 279                 /// <param name="cookie">The cookie.</param>
 280                 public virtual void CreateCookie(HttpCookie cookie)
 281                 {
 282                         throw new NotSupportedException();
 283                 }
 284
 285                 /// <summary>
 286                 /// Removes a cookie.
 287                 /// </summary>
 288                 /// <param name="name">The name.</param>
 289                 public virtual void RemoveCookie(string name)
 290                 {
 291                         cookies.Remove(name);
 292                 }
 293
 294                 /// <summary>
 295                 /// Gets or sets the status code.
 296                 /// </summary>
 297                 /// <value>The status code.</value>
 298                 public int StatusCode
 299                 {
 300                         get { return statusCode; }
 301                         set { statusCode = value; }
 302                 }
 303
 304                 /// <summary>
 305                 /// Gets or sets the type of the content.
 306                 /// </summary>
 307                 /// <value>The type of the content.</value>
 308                 public string ContentType
 309                 {
 310                         get { return contentType; }
 311                         set { contentType = value; }
 312                 }
 313
 314                 /// <summary>
 315                 /// Gets the caching policy (expiration time, privacy,
 316                 /// vary clauses) of a Web page.
 317                 /// </summary>
 318                 /// <value></value>
 319                 public HttpCachePolicy CachePolicy
 320                 {
 321                         get { return cachePolicy; }
 322                 }
 323
 324                 /// <summary>
 325                 /// Sets the Cache-Control HTTP header to Public or Private.
 326                 /// </summary>
 327                 /// <value></value>
 328                 public string CacheControlHeader
 329                 {
 330                         get { return cacheControlHeader; }
 331                         set { cacheControlHeader = value; }
 332                 }
 333
 334                 /// <summary>
 335                 /// Gets or sets the HTTP character set of the output stream.
 336                 /// </summary>
 337                 /// <value></value>
 338                 public string Charset
 339                 {
 340                         get { return charset; }
 341                         set { charset = value; }
 342                 }
 343
 344                 /// <summary>
 345                 /// Gets the output.
 346                 /// </summary>
 347                 /// <value>The output.</value>
 348                 public virtual TextWriter Output
 349                 {
 350                         get { return output; }
 351                 }
 352
 353                 /// <summary>
 354                 /// Gets the output stream.
 355                 /// </summary>
 356                 /// <value>The output stream.</value>
 357                 public virtual Stream OutputStream
 358                 {
 359                         get { return outputStream; }
 360                 }
 361
 362                 /// <summary>
 363                 /// Gets a value indicating whether the response sent a redirect.
 364                 /// </summary>
 365                 /// <value><c>true</c> if was redirected; otherwise, <c>false</c>.</value>
 366                 public virtual bool WasRedirected
 367                 {
 368                         get { return wasRedirected; }
 369                 }
 370
 371                 /// <summary>
 372                 /// Gets a value indicating whether this instance is client connected.
 373                 /// </summary>
 374                 /// <value>
 375                 ///     <c>true</c> if this instance is client connected; otherwise, <c>false</c>.
 376                 /// </value>
 377                 public virtual bool IsClientConnected
 378                 {
 379                         get { return isClientConnected; }
 380                 }
 381
 382                 #endregion
 383
 384                 private static string BuildMockUrl(string area, string controller, string action, string querystring)
 385                 {
 386                         string mockUrl = "/";
 387
 388                         if (area != null)
 389                         {
 390                                 mockUrl += area + "/";
 391                         }
 392
 393                         mockUrl += controller + "/" + action + ".rails";
 394
 395                         if (querystring != null)
 396                         {
 397                                 mockUrl += "?" + querystring;
 398                         }
 399
 400                         return mockUrl;
 401                 }
 402
 403                 private static string BuildMockUrl(string area, string controller, string action)
 404                 {
 405                         return BuildMockUrl(area, controller, action, (string) null);
 406                 }
 407
 408                 private static string BuildMockUrl(string area, string controller, string action, IDictionary parameters)
 409                 {
 410                         return BuildMockUrl(area, controller, action, ToQueryString(parameters));
 411                 }
 412
 413                 private static string BuildMockUrl(string controller, string action, IDictionary parameters)
 414                 {
 415                         return BuildMockUrl(controller, action, ToQueryString(parameters));
 416                 }
 417
 418                 private static string BuildMockUrl(string area, string controller, string action, NameValueCollection parameters)
 419                 {
 420                         return BuildMockUrl(area, controller, action, ToQueryString(parameters));
 421                 }
 422
 423                 private static string BuildMockUrl(string controller, string action, NameValueCollection parameters)
 424                 {
 425                         return BuildMockUrl(controller, action, ToQueryString(parameters));
 426                 }
 427
 428                 /// <summary>
 429                 /// Creates a querystring string representation of the namevalue collection.
 430                 /// </summary>
 431                 /// <param name="parameters">The parameters.</param>
 432                 /// <returns></returns>
 433                 private static string ToQueryString(NameValueCollection parameters)
 434                 {
 435                         return CommonUtils.BuildQueryString(new MockServerUtility(), parameters, false);
 436                 }
 437
 438                 /// <summary>
 439                 /// Creates a querystring string representation of the entries in the dictionary.
 440                 /// </summary>
 441                 /// <param name="parameters">The parameters.</param>
 442                 /// <returns></returns>
 443                 private static string ToQueryString(IDictionary parameters)
 444                 {
 445                         return CommonUtils.BuildQueryString(new MockServerUtility(), parameters, false);
 446                 }
 447         }
 448 }