Validate HTML5 in C #

Question

We are currently creating an application with green fields in C #. We have extensive user interface tests that use the Selenium Web Driver. These tests (as well as unit tests) are performed by our CI server.

Selenium provides the .PageSource attribute, and it makes sense (for me) to run this source using HTML5 validation as another part of every UI test.

I want to pick up the same thing that http://validator.w3.org/ picks up. As a bonus, I would also like to receive 508 questions.

My problem is that I cannot find anything that will do this locally, and integrates seamlessly into my user interface tests. The W3C site provides SOAP api, however I do not want to get to their site as part of the CI process. They also do not seem to support the SOAP response. I would like not to install a local local W3C server.

The closest I see is http://www.totalvalidator.com/ , for this you will need to write temporary files and analyze reports.

I thought I would see if anyone else knows before I go this route. It is advisable to have a dotnet node that I can invoke.

c

Answer 1

Having spent a whole weekend on this issue, the only solution I see is a commercial library called CSE HTML Validator

It is located here http://www.htmlvalidator.com/htmldownload.html

I wrote a simple shell for him. Here is the code

using Newtonsoft.Json; using System; using System.Collections.Generic; using System.Diagnostics; using System.IO; using System.Linq; [assembly: CLSCompliant(true)] namespace HtmlValidator { public class Validator { #region Constructors... public Validator(string htmlToValidate) { HtmlToValidate = htmlToValidate; HasExecuted = false; Errors = new List<ValidationResult>(); Warnings = new List<ValidationResult>(); OtherMessages = new List<ValidationResult>(); } #endregion #region Properties... public IList<ValidationResult> Errors { get; private set; } public bool HasExecuted { get; private set; } public string HtmlToValidate { get; private set; } public IList<ValidationResult> OtherMessages { get; private set; } public string ResultsString { get; private set; } public string TempFilePath { get; private set; } public IList<ValidationResult> Warnings { get; private set; } #endregion #region Public methods... public void ValidateHtmlFile() { WriteTempFile(); ExecuteValidator(); DeleteTempFile(); ParseResults(); HasExecuted = true; } #endregion #region Private methods... private void DeleteTempFile() { TempFilePath = Path.GetTempFileName(); File.Delete(TempFilePath); } private void ExecuteValidator() { var psi = new ProcessStartInfo(GetHTMLValidatorPath()) { RedirectStandardInput = false, RedirectStandardOutput = true, RedirectStandardError = false, UseShellExecute = false, Arguments = String.Format(@"-e,(stdout),0,16 ""{0}""", TempFilePath) }; var p = new Process { StartInfo = psi }; p.Start(); var stdOut = p.StandardOutput; ResultsString = stdOut.ReadToEnd(); } private static string GetHTMLValidatorPath() { return @"C:\Program Files (x86)\HTMLValidator120\cmdlineprocessor.exe"; } private void ParseResults() { var results = JsonConvert.DeserializeObject<dynamic>(ResultsString); IList<InternalValidationResult> messages = results.messages.ToObject<List<InternalValidationResult>>(); foreach (InternalValidationResult internalValidationResult in messages) { ValidationResult result = new ValidationResult() { Message = internalValidationResult.message, LineNumber = internalValidationResult.linenumber, MessageCategory = internalValidationResult.messagecategory, MessageType = internalValidationResult.messagetype, CharLocation = internalValidationResult.charlocation }; switch (internalValidationResult.messagetype) { case "ERROR": Errors.Add(result); break; case "WARNING": Warnings.Add(result); break; default: OtherMessages.Add(result); break; } } } private void WriteTempFile() { TempFilePath = Path.GetTempFileName(); StreamWriter streamWriter = File.AppendText(TempFilePath); streamWriter.WriteLine(HtmlToValidate); streamWriter.Flush(); streamWriter.Close(); } #endregion } } public class ValidationResult { public string MessageType { get; set; } public string MessageCategory { get; set; } public string Message { get; set; } public int LineNumber { get; set; } public int CharLocation { get; set; } public override string ToString() { return String.Format("{0} Line {1} Char {2}:: {3}", this.MessageType, this.LineNumber, this.CharLocation, this.Message); } } public class InternalValidationResult { /* * DA: this class is used as in intermediate store of messages that come back from the underlying validator. The fields must be cased as per the underlying Json object. * That is why they are ignored. */ #region Properties... [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "charlocation"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "charlocation")] public int charlocation { get; set; } [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "linenumber"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "linenumber")] public int linenumber { get; set; } [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "message"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "message")] public string message { get; set; } [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "messagecategory"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "messagecategory")] public string messagecategory { get; set; } [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", MessageId = "messagetype"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1704:IdentifiersShouldBeSpelledCorrectly", MessageId = "messagetype")] public string messagetype { get; set; } #endregion } 

Use / Testing

  private const string ValidHtml = "<!DOCType html><html><head></head><body><p>Hello World</p></body></html>"; private const string BrokenHtml = "<!DOCType html><html><head></head><body><p>Hello World</p></body>"; [TestMethod] public void CanValidHtmlStringReturnNoErrors() { Validator subject = new Validator(ValidHtml); subject.ValidateHtmlFile(); Assert.IsTrue(subject.HasExecuted); Assert.IsTrue(subject.Errors.Count == 0); } [TestMethod] public void CanInvalidHtmlStringReturnErrors() { Validator subject = new Validator(BrokenHtml); subject.ValidateHtmlFile(); Assert.IsTrue(subject.HasExecuted); Assert.IsTrue(subject.Errors.Count > 0); Assert.IsTrue(subject.Errors[0].ToString().Contains("ERROR")); } 

Answer 2

Looks like this link may have what you want: W3C Automated Validation

You can load the markup validator in the accepted answer and pass your HTML to that. Sorry they are not .NET assemblies: /, but you could wrap them in a DLL if you wanted.

In addition, one answer to this question suggests that the W3C service actually provides a RESTful API, but can return a SOAP response: How can I use the W3C markup validator API in my .NET application?