Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #126 from krystiankaluzny/master
Enhancements of assertj module
- Loading branch information
Showing
14 changed files
with
998 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
126 changes: 126 additions & 0 deletions
126
xmlunit-assertj/src/main/java/org/xmlunit/assertj/ValidationAssert.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,126 @@ | ||
/* | ||
This file is licensed to You under the Apache License, Version 2.0 | ||
(the "License"); you may not use this file except in compliance with | ||
the License. You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
package org.xmlunit.assertj; | ||
|
||
import org.assertj.core.api.AbstractAssert; | ||
import org.assertj.core.api.Assertions; | ||
import org.xmlunit.builder.Input; | ||
import org.xmlunit.validation.JAXPValidator; | ||
import org.xmlunit.validation.Languages; | ||
import org.xmlunit.validation.ValidationResult; | ||
|
||
import javax.xml.transform.Source; | ||
import javax.xml.validation.Schema; | ||
|
||
import static org.xmlunit.assertj.error.ShouldBeInvalid.shouldBeInvalid; | ||
import static org.xmlunit.assertj.error.ShouldBeValid.shouldBeValid; | ||
|
||
/** | ||
* Assertion methods for XML validation. | ||
* | ||
* <p><b>Simple Example</b></p> | ||
* | ||
* <pre> | ||
* import static org.xmlunit.assertj.XmlAssert.assertThat; | ||
* | ||
* final String xml = "<a><b attr=\"abc\"></b></a>"; | ||
* | ||
* assertThat(xml).isValid(); | ||
* </pre> | ||
* | ||
* @since XMLUnit 2.6.1 | ||
*/ | ||
public class ValidationAssert extends AbstractAssert<ValidationAssert, Source> { | ||
|
||
private final Source[] schemaSources; | ||
private final Schema schema; | ||
|
||
private ValidationAssert(Source actual, Source[] schemaSources, Schema schema) { | ||
super(actual, ValidationAssert.class); | ||
this.schemaSources = schemaSources; | ||
this.schema = schema; | ||
} | ||
|
||
static ValidationAssert create(Object xmlSource, Object... schemaSources) { | ||
|
||
Assertions.assertThat(xmlSource).isNotNull(); | ||
|
||
Assertions.assertThat(schemaSources) | ||
.isNotNull() | ||
.doesNotContainNull(); | ||
|
||
Source source = Input.from(xmlSource).build(); | ||
|
||
Source[] sources = new Source[schemaSources.length]; | ||
|
||
for (int i = 0; i < schemaSources.length; i++) { | ||
sources[i] = Input.from(schemaSources[i]).build(); | ||
} | ||
|
||
return new ValidationAssert(source, sources, null); | ||
} | ||
|
||
static ValidationAssert create(Object xmlSource, Schema schema) { | ||
|
||
Assertions.assertThat(xmlSource).isNotNull(); | ||
Assertions.assertThat(schema).isNotNull(); | ||
|
||
Source source = Input.from(xmlSource).build(); | ||
|
||
return new ValidationAssert(source, null, schema); | ||
} | ||
|
||
static ValidationAssert create(Object xmlSource) { | ||
|
||
Source source = Input.from(xmlSource).build(); | ||
|
||
return new ValidationAssert(source, null, null); | ||
} | ||
|
||
private ValidationResult validate() { | ||
|
||
JAXPValidator validator = new JAXPValidator(Languages.W3C_XML_SCHEMA_NS_URI); | ||
if (schema != null) { | ||
validator.setSchema(schema); | ||
} else if (schemaSources != null && schemaSources.length > 0) { | ||
validator.setSchemaSources(schemaSources); | ||
} | ||
return validator.validateInstance(actual); | ||
} | ||
|
||
/** | ||
* Verifies that actual value is valid against given schema | ||
* | ||
* @throws AssertionError if the actual value is not valid against schema | ||
*/ | ||
public ValidationAssert isValid() { | ||
ValidationResult validationResult = validate(); | ||
if (!validationResult.isValid()) { | ||
throwAssertionError(shouldBeValid(actual.getSystemId(), validationResult.getProblems())); | ||
} | ||
return this; | ||
} | ||
|
||
/** | ||
* Verifies that actual value is not valid against given schema | ||
* | ||
* @throws AssertionError if the actual value is valid against schema | ||
*/ | ||
public void isInvalid() { | ||
ValidationResult validateResult = validate(); | ||
if (validateResult.isValid()) { | ||
throwAssertionError(shouldBeInvalid(actual.getSystemId())); | ||
} | ||
} | ||
} |
168 changes: 168 additions & 0 deletions
168
xmlunit-assertj/src/main/java/org/xmlunit/assertj/ValueAssert.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,168 @@ | ||
/* | ||
This file is licensed to You under the Apache License, Version 2.0 | ||
(the "License"); you may not use this file except in compliance with | ||
the License. You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
package org.xmlunit.assertj; | ||
|
||
import org.assertj.core.api.AbstractBooleanAssert; | ||
import org.assertj.core.api.AbstractCharSequenceAssert; | ||
import org.assertj.core.api.AbstractDoubleAssert; | ||
import org.assertj.core.api.AbstractIntegerAssert; | ||
import org.assertj.core.api.Assertions; | ||
import org.w3c.dom.Node; | ||
import org.xmlunit.builder.Input; | ||
import org.xmlunit.util.Convert; | ||
import org.xmlunit.xpath.JAXPXPathEngine; | ||
|
||
import javax.xml.parsers.DocumentBuilderFactory; | ||
import javax.xml.transform.Source; | ||
import java.util.Map; | ||
|
||
import static org.xmlunit.assertj.error.ShouldBeConvertible.shouldBeConvertible; | ||
|
||
/** | ||
* Assertion methods for {@link String} result of XPath evaluation. | ||
* | ||
* <p><b>Simple Example</b></p> | ||
* | ||
* <pre> | ||
* import static org.xmlunit.assertj.XmlAssert.assertThat; | ||
* | ||
* final String xml = "<a><b attr=\"abc\"></b></a>"; | ||
* | ||
* assertThat(xml).valueByXPath("count(//a/b)").isEqualTo(3); | ||
* </pre> | ||
* | ||
* @since XMLUnit 2.6.1 | ||
*/ | ||
public class ValueAssert extends AbstractCharSequenceAssert<ValueAssert, String> { | ||
|
||
private ValueAssert(String value) { | ||
super(value, ValueAssert.class); | ||
} | ||
|
||
static ValueAssert create(Object xmlSource, Map<String, String> prefix2Uri, DocumentBuilderFactory dbf, String xPath) { | ||
Assertions.assertThat(xPath).isNotBlank(); | ||
|
||
final JAXPXPathEngine engine = new JAXPXPathEngine(); | ||
if (prefix2Uri != null) { | ||
engine.setNamespaceContext(prefix2Uri); | ||
} | ||
|
||
Source s = Input.from(xmlSource).build(); | ||
Node root = dbf != null ? Convert.toNode(s, dbf) : Convert.toNode(s); | ||
String value = engine.evaluate(xPath, root); | ||
|
||
return new ValueAssert(value) | ||
.describedAs("XPath \"%s\" evaluated to value", xPath); | ||
} | ||
|
||
/** | ||
* Returns an {@code Assert} object that allows performing assertions on integer value of the {@link String} under test. | ||
* | ||
* @throws AssertionError if the actual value is {@code null}. | ||
* @throws AssertionError if the actual value does not contain a parsable integer | ||
*/ | ||
public AbstractIntegerAssert<?> asInt() { | ||
isNotNull(); | ||
int value = 0; | ||
try { | ||
value = Integer.parseInt(actual); | ||
} catch (NumberFormatException e) { | ||
throwAssertionError(shouldBeConvertible(actual, "int")); | ||
} | ||
|
||
return Assertions.assertThat(value); | ||
} | ||
|
||
/** | ||
* Returns an {@code Assert} object that allows performing assertions on integer value of the {@link String} under test. | ||
* | ||
* @throws AssertionError if the actual value is {@code null}. | ||
* @throws AssertionError if the actual value does not contain a parsable double | ||
*/ | ||
public AbstractDoubleAssert<?> asDouble() { | ||
isNotNull(); | ||
double value = 0; | ||
try { | ||
value = Double.parseDouble(actual); | ||
} catch (NumberFormatException e) { | ||
throwAssertionError(shouldBeConvertible(actual, "double")); | ||
} | ||
|
||
return Assertions.assertThat(value); | ||
} | ||
|
||
/** | ||
* Returns an {@code Assert} object that allows performing assertions on boolean value of the {@link String} under test. | ||
* <p> | ||
* If actual value after lowercasing is one of the following "true", "false", "1", "0", then it can be parsed to boolean. | ||
* | ||
* @throws AssertionError if the actual value is {@code null}. | ||
* @throws AssertionError if the actual value does not contain a parsable boolean | ||
*/ | ||
public AbstractBooleanAssert<?> asBoolean() { | ||
isNotNull(); | ||
boolean value = false; | ||
switch (actual.toLowerCase()) { | ||
case "1": | ||
case "true": | ||
value = true; | ||
break; | ||
case "0": | ||
case "false": | ||
value = false; | ||
break; | ||
default: | ||
throwAssertionError(shouldBeConvertible(actual, "boolean")); | ||
} | ||
|
||
return Assertions.assertThat(value); | ||
} | ||
|
||
/** | ||
* Returns an {@code XmlAssert} object that allows performing assertions on XML value of the {@link String} under test. | ||
* | ||
* @throws AssertionError if the actual value is {@code null}. | ||
*/ | ||
public XmlAssert asXml() { | ||
isNotNull(); | ||
return XmlAssert.assertThat(actual); | ||
} | ||
|
||
/** | ||
* Try convert the {@link String} under test to int using {@link #asInt()} and compare with given value. | ||
*/ | ||
public ValueAssert isEqualTo(int expected) { | ||
asInt().isEqualTo(expected); | ||
|
||
return this; | ||
} | ||
|
||
/** | ||
* Try convert the {@link String} under test to double using {@link #asDouble()} and compare with given value. | ||
*/ | ||
public ValueAssert isEqualTo(double expected) { | ||
asDouble().isEqualTo(expected); | ||
|
||
return this; | ||
} | ||
|
||
/** | ||
* Try convert the {@link String} under test to boolean using {@link #asBoolean()} and compare with given value. | ||
*/ | ||
public ValueAssert isEqualTo(boolean expected) { | ||
asBoolean().isEqualTo(expected); | ||
|
||
return this; | ||
} | ||
} |
Oops, something went wrong.