/// <summary>
/// Runs axe via scan.js at a specific context, which will be passed as-is to Selenium for scan.js to interpret, and
/// parses/handles the scan.js output per the current builder options.
/// </summary>
/// <param name="rawContextArg">The value to pass as-is to scan.js to use as the axe.run "context" argument</param>
private AxeResult AnalyzeRawContext(object rawContextArg)
{
_webDriver.Inject(_AxeBuilderOptions.ScriptProvider, runOptions);
#pragma warning disable CS0618 // Intentionally falling back to publicly deprecated property for backcompat
string rawOptionsArg = Options == "{}" ? JsonConvert.SerializeObject(runOptions, JsonSerializerSettings) : Options;
#pragma warning restore CS0618
string scanJsContent = EmbeddedResourceProvider.ReadEmbeddedFile("scan.js");
object[] rawArgs = new[] { rawContextArg, rawOptionsArg };
var result = ((IJavaScriptExecutor)_webDriver).ExecuteAsyncScript(scanJsContent, rawArgs);
JObject jObject = JObject.FromObject(result);
if (outputFilePath != null && jObject.Type == JTokenType.Object)
{
Encoding utf8NoBOM = new UTF8Encoding(encoderShouldEmitUTF8Identifier: false);
using (var outputFileWriter = new StreamWriter(outputFilePath, append: false, encoding: utf8NoBOM))
{
jObject.WriteTo(new JsonTextWriter(outputFileWriter));
}
}
return(new AxeResult(jObject));
}
public static void CreateAxeHtmlReport(this ISearchContext context, AxeResult results, string destination, ReportTypes requestedResults)
{
// Get the unwrapped element if we are using a wrapped element
context = context is IWrapsElement ? (context as IWrapsElement).WrappedElement : context;
var violationCount = GetCount(results.Violations);
var incompleteCount = GetCount(results.Incomplete);
var passCount = GetCount(results.Passes);
var inapplicableCount = GetCount(results.Inapplicable);
var doc = new HtmlDocument();
doc.CreateComment("<!DOCTYPE html>\r\n");
var htmlStructure = HtmlNode.CreateNode("<html lang=\"en\"><head><meta charset=\"utf-8\"><meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\"><title>Accessibility Check</title><style></style></head><body><content></content><script></script></body></html>");
doc.DocumentNode.AppendChild(htmlStructure);
doc.DocumentNode.SelectSingleNode("//style").InnerHtml = GetCss(context);
var contentArea = doc.DocumentNode.SelectSingleNode("//content");
var reportTitle = doc.CreateElement("h1");
reportTitle.InnerHtml = "Accessibility Check";
contentArea.AppendChild(reportTitle);
var metaFlex = doc.CreateElement("div");
metaFlex.SetAttributeValue("id", "metadata");
contentArea.AppendChild(metaFlex);
var contextGroup = doc.CreateElement("div");
contextGroup.SetAttributeValue("id", "context");
metaFlex.AppendChild(contextGroup);
var contextHeader = doc.CreateElement("h3");
contextHeader.InnerHtml = "Context:";
contextGroup.AppendChild(contextHeader);
var contextContent = doc.CreateElement("div");
contextContent.SetAttributeValue("class", "emOne");
contextContent.SetAttributeValue("id", "reportContext");
contextContent.InnerHtml = GetContextContent(results);
contextGroup.AppendChild(contextContent);
var imgGroup = doc.CreateElement("div");
imgGroup.SetAttributeValue("id", "image");
metaFlex.AppendChild(imgGroup);
var imageHeader = doc.CreateElement("h3");
imageHeader.InnerHtml = "Image:";
imgGroup.AppendChild(imageHeader);
var imageContent = doc.CreateElement("img");
imageContent.SetAttributeValue("class", "thumbnail");
imageContent.SetAttributeValue("id", "screenshotThumbnail");
imageContent.SetAttributeValue("alt", "A Screenshot of the page");
imageContent.SetAttributeValue("width", "33%");
imageContent.SetAttributeValue("height", "auto");
imgGroup.AppendChild(imageContent);
var countsGroup = doc.CreateElement("div");
countsGroup.SetAttributeValue("id", "counts");
metaFlex.AppendChild(countsGroup);
var countsHeader = doc.CreateElement("h3");
countsHeader.InnerHtml = "Counts:";
countsGroup.AppendChild(countsHeader);
var countsContent = doc.CreateElement("div");
countsContent.SetAttributeValue("class", "emOne");
var countsString = GetCountContent(violationCount, incompleteCount, passCount, inapplicableCount, requestedResults);
countsContent.InnerHtml = countsString.ToString();
countsGroup.AppendChild(countsContent);
var resultsFlex = doc.CreateElement("div");
resultsFlex.SetAttributeValue("id", "results");
contentArea.AppendChild(resultsFlex);
if (!string.IsNullOrEmpty(results.Error))
{
var errorHeader = doc.CreateElement("h2");
errorHeader.InnerHtml = "SCAN ERRORS:";
contentArea.AppendChild(errorHeader);
var errorContent = doc.CreateElement("div");
errorContent.SetAttributeValue("id", "ErrorMessage");
errorContent.InnerHtml = HttpUtility.HtmlEncode(results.Error);
contentArea.AppendChild(errorContent);
}
if (violationCount > 0 && requestedResults.HasFlag(ReportTypes.Violations))
{
GetReadableAxeResults(results.Violations, ResultType.Violations, doc, resultsFlex);
}
if (incompleteCount > 0 && requestedResults.HasFlag(ReportTypes.Incomplete))
{
GetReadableAxeResults(results.Incomplete, ResultType.Incomplete, doc, resultsFlex);
}
if (passCount > 0 && requestedResults.HasFlag(ReportTypes.Passes))
{
GetReadableAxeResults(results.Passes, ResultType.Passes, doc, resultsFlex);
}
if (inapplicableCount > 0 && requestedResults.HasFlag(ReportTypes.Inapplicable))
{
GetReadableAxeResults(results.Inapplicable, ResultType.Inapplicable, doc, resultsFlex);
}
var modal = doc.CreateElement("div");
modal.SetAttributeValue("id", "modal");
contentArea.AppendChild(modal);
var modalClose = doc.CreateElement("div");
modalClose.InnerHtml = "X";
modalClose.SetAttributeValue("id", "modalclose");
modal.AppendChild(modalClose);
var modalImage = doc.CreateElement("img");
modalImage.SetAttributeValue("id", "modalimage");
modal.AppendChild(modalImage);
doc.DocumentNode.SelectSingleNode("//script").InnerHtml = EmbeddedResourceProvider.ReadEmbeddedFile("htmlReporterElements.js");
doc.Save(destination, Encoding.UTF8);
}
private static string GetCss(ISearchContext context)
{
return(EmbeddedResourceProvider.ReadEmbeddedFile("htmlReporter.css").Replace("url('", $"url('{GetDataImageString(context)}"));
}
