aweXpect.Xml 4.2.0

aweXpect.Xml

aweXpect.Xml extends aweXpect with expectations for XML strings and System.Xml.Linq.

Installation

dotnet add package aweXpect.Xml

The package brings Expect.That with it, but not the expectations for strings, numbers or collections, so reference aweXpect as well, e.g. for the IsEqualTo of IsEqualTo(…).AsXml(). The expectations live in the namespace aweXpect, so using aweXpect; is all you need.

The examples write That(...) instead of Expect.That(...), which needs using static aweXpect.Expect; (see Getting started).

At a glance

string xml = """<track title="Let It Be" artist="The Beatles" />""";

// verify that a string is a well-formed XML document
await That(xml).IsValidXml();

// verify that a string is equal to the expected XML, compared by its content instead of its formatting
await That(xml).IsEqualTo("""<track artist="The Beatles" title="Let It Be"></track>""").AsXml();

// verify that an XElement or XDocument contains the expected XML, ignoring additional nodes
XElement track = XElement.Parse(
    """<track title="Let It Be" artist="The Beatles"><genre>rock</genre></track>""");
await That(track).Matches("""<track title="Let It Be"><genre>rock</genre></track>""");

// verify single attributes, child elements and their values
await That(track).HasAttribute("artist").EqualTo("The Beatles").And
    .HasElement("genre", genre => genre.HasValue().EqualTo("rock"));

If the element was not closed, i.e. <track title="Let It Be" artist="The Beatles">, the expectation would fail with:

Expected that xml
is valid XML,
but it could not be parsed: Unexpected end of file has occurred. The following elements are not closed: track. Line 1, position 47.

Overview

Expectations for string:

Expectations for XElement and XDocument:

The comparisons can be relaxed with the options IgnoringAdditionalNodes(), IgnoringElementOrder() and IgnoringMember(path) or IgnoringMembers(path => …), see Matching XML.

Documentation

The full documentation is available at docs.testably.org:

• XML strings: comparing and validating strings as XML
• Matching XML: Matches and MatchesExactly, and the options to relax the comparison
• Attributes and child elements: verifying single attributes, child elements and values