HtmlAnchorTester.cs :  » Testing » NUnitAsp » NUnit » Extensions » Asp » HtmlTester » C# / CSharp Open Source

#region Copyright (c) 2002-2005, Brian Knowles, Jim Shore
/********************************************************************************************************************
'
' Copyright (c) 2002-2005, Brian Knowles, Jim Shore
'
' Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated 
' documentation files (the "Software"), to deal in the Software without restriction, including without limitation 
' the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and
' to permit persons to whom the Software is furnished to do so, subject to the following conditions:
'
' The above copyright notice and this permission notice shall be included in all copies or substantial portions 
' of the Software.
'
' THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
' THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
' AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
' CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
' DEALINGS IN THE SOFTWARE.
'
'*******************************************************************************************************************/
#endregion

using System;
using System.Text.RegularExpressions;
using System.Web;

namespace NUnit.Extensions.Asp.HtmlTester{
  /// <summary>
  /// Tester for System.Web.UI.HtmlControls.HtmlAnchor
  /// </summary>
  public class HtmlAnchorTester : HtmlControlTester
  {
    #region Standard Constructors
    /// <summary>
    /// Create a tester for an HTML tag.  Use this constructor
    /// for testing most tags.
    /// </summary>
    /// <param name="htmlId">The ID of the control to test (look in the
    /// page's ASP.NET source code for the ID).</param>
    public HtmlAnchorTester(string htmlId) : base(htmlId)
    {
    }

    /// <summary>
    /// Create a tester for a server-side HTML control or a tag that's on a 
    /// page with multiple forms.  Use this constructor when the HTML tag you
    /// are testing has the "runat='server'" attribute.
    /// Also use this tester when using the non-default webform or HttpClient.
    /// </summary>
    /// <param name="aspId">The ID of the control to test (look in the
    /// page's ASP.NET source code for the ID).</param>
    /// <param name="container">A tester for the control's container.  
    /// (In the page's ASP.NET source code, look for the tag that the
    /// control is nested in.  That's probably the control's
    /// container.)  If testing a page with multiple forms or a non-default
    /// HttpClient, pass in the WebFormTester for the form this tag is within.</param>
    public HtmlAnchorTester(string aspId, Tester container) : base(aspId, container)
    {
    }

    /// <summary>
    /// Create a tester for an HTML tag using an XPath description.
    /// </summary>
    /// <param name="xpath">The XPath description of the tag.</param>
    /// <param name="description">A human-readable description of this tag (for error reporting).</param>
    public HtmlAnchorTester(string xpath, string description) : base(xpath, description)
    {
    }

    /// <summary>
    /// Create a tester for an HTML tag that's on a page with multiple forms using
    /// an XPath description.
    /// </summary>
    /// <param name="xpath">The XPath description of the tag.</param>
    /// <param name="description">A human-readable description of this tag (for error reporting).</param>
    /// <param name="container">A tester for the control's container.  A WebFormTester
    /// will usually be most appropriate.</param>
    public HtmlAnchorTester(string xpath, string description, Tester container) : base(xpath, description, container)
    {
    }
    #endregion


    [Obsolete("Use HtmlAnchorTester(aspId, container) or HtmlAnchorTester(htmlId) instead")]
    public HtmlAnchorTester(string aspId, Tester container, bool runAtServer) : this(aspId, container)
    {
    }

    /// <summary>
    /// Click the link.  Supports postback and pop-up windows.
    /// </summary>
    public void Click()
    {
      string popupLink = PopupLink;
      if (popupLink != null)
      {
        Browser.FollowLink(popupLink);
        return;
      }
      string hRef = HRef;
      if (Form.IsPostBack(hRef))
      {
        Form.PostBack(hRef);
        return;
      }
      Browser.FollowLink(hRef);
    }
    
    /// <summary>
    /// The HRef of the link.
    /// </summary>
    public string HRef
    {
      get
      {
        return HttpUtility.HtmlDecode(Tag.Attribute("href"));
      }
    }

    /// <summary>
    /// The HRef of the pop-up window's link.  Null if this anchor doesn't have 
    /// a recognizable pop-up link.
    /// </summary>
    public string PopupLink
    {
      get
      {
        string onClick = Tag.OptionalAttribute("onclick");
        if (onClick == null) return null;

        RegexOptions options = RegexOptions.IgnoreCase | RegexOptions.Singleline;
        Match match = Regex.Match(onClick, "window.open\\('(?<link>.*?)'", options);
        if (match.Captures.Count == 1)
        {
          return match.Groups["link"].Value;
        }

        if (match.Captures.Count == 0) return null;
        else
        {
          string message = string.Format("Found more than one 'window.open' call in onclick attribute of {0}, but only expected to find one", HtmlIdAndDescription);
          throw new ParseException(message);
        }
      }
    }
  }
}