/* Copyright 2010 - 2014 by Brian Uri!
This file is part of DDMSence.
This library is free software; you can redistribute it and/or modify
it under the terms of version 3.0 of the GNU Lesser General Public
License as published by the Free Software Foundation.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with DDMSence. If not, see <http://www.gnu.org/licenses/>.
You can contact the author at ddmsence@urizone.net. The DDMSence
home page is located at http://ddmsence.urizone.net/
*/
package buri.ddmsence.ddms.summary;
import static org.junit.Assert.*;
import java.util.ArrayList;
import java.util.List;
import nu.xom.Element;
import org.junit.Test;
import buri.ddmsence.AbstractBaseTestCase;
import buri.ddmsence.ddms.InvalidDDMSException;
import buri.ddmsence.ddms.OutputFormat;
import buri.ddmsence.ddms.resource.Rights;
import buri.ddmsence.ddms.summary.tspi.GeneralAddressClass;
import buri.ddmsence.ddms.summary.tspi.GeneralAddressClassTest;
import buri.ddmsence.ddms.summary.tspi.IntersectionAddress;
import buri.ddmsence.ddms.summary.tspi.IntersectionAddressTest;
import buri.ddmsence.ddms.summary.tspi.LandmarkAddress;
import buri.ddmsence.ddms.summary.tspi.LandmarkAddressTest;
import buri.ddmsence.ddms.summary.tspi.NumberedThoroughfareAddress;
import buri.ddmsence.ddms.summary.tspi.NumberedThoroughfareAddressTest;
import buri.ddmsence.ddms.summary.tspi.TwoNumberAddressRange;
import buri.ddmsence.ddms.summary.tspi.TwoNumberAddressRangeTest;
import buri.ddmsence.ddms.summary.tspi.USPSGeneralDeliveryOffice;
import buri.ddmsence.ddms.summary.tspi.USPSGeneralDeliveryOfficeTest;
import buri.ddmsence.ddms.summary.tspi.USPSPostalDeliveryBox;
import buri.ddmsence.ddms.summary.tspi.USPSPostalDeliveryBoxTest;
import buri.ddmsence.ddms.summary.tspi.USPSPostalDeliveryRoute;
import buri.ddmsence.ddms.summary.tspi.USPSPostalDeliveryRouteTest;
import buri.ddmsence.ddms.summary.tspi.UnnumberedThoroughfareAddress;
import buri.ddmsence.ddms.summary.tspi.UnnumberedThoroughfareAddressTest;
import buri.ddmsence.util.DDMSVersion;
import buri.ddmsence.util.Util;
/**
* <p> Tests related to ddms:postalAddress elements </p>
*
* @author Brian Uri!
* @since 0.9.b
*/
public class PostalAddressTest extends AbstractBaseTestCase {
private static final List<String> TEST_STREETS = new ArrayList<String>();
static {
TEST_STREETS.add("1600 Pennsylvania Avenue, NW");
}
private static final String TEST_CITY = "Washington";
private static final String TEST_STATE = "DC";
private static final String TEST_PROVINCE = "Alberta";
private static final String TEST_POSTAL_CODE = "20500";
/**
* Constructor
*/
public PostalAddressTest() throws InvalidDDMSException {
super("postalAddress.xml");
}
/**
* Returns a fixture object for testing.
*/
public static PostalAddress getFixture() {
try {
if (!DDMSVersion.getCurrentVersion().isAtLeast("5.0"))
return (new PostalAddress(null, null, "VA", null, null, true));
return (new PostalAddress(GeneralAddressClassTest.getFixture()));
}
catch (InvalidDDMSException e) {
fail("Could not create fixture: " + e.getMessage());
}
return (null);
}
/**
* Attempts to build a component from a XOM element.
* @param element the element to build from
* @param message an expected error message. If empty, the constructor is expected to succeed.
*
* @return a valid object
*/
private PostalAddress getInstance(Element element, String message) {
boolean expectFailure = !Util.isEmpty(message);
PostalAddress component = null;
try {
component = new PostalAddress(element);
checkConstructorSuccess(expectFailure);
}
catch (InvalidDDMSException e) {
checkConstructorFailure(expectFailure, e);
expectMessage(e, message);
}
return (component);
}
/**
* Helper method to create an object which is expected to be valid.
*
* @param builder the builder to commit
* @param message an expected error message. If empty, the constructor is expected to succeed.
*
* @return a valid object
*/
private PostalAddress getInstance(PostalAddress.Builder builder, String message) {
boolean expectFailure = !Util.isEmpty(message);
PostalAddress component = null;
try {
component = builder.commit();
checkConstructorSuccess(expectFailure);
}
catch (InvalidDDMSException e) {
checkConstructorFailure(expectFailure, e);
expectMessage(e, message);
}
return (component);
}
/**
* Returns a builder, pre-populated with base data from the XML sample.
*
* This builder can then be modified to test various conditions.
*/
private PostalAddress.Builder getBaseBuilder() {
DDMSVersion version = DDMSVersion.getCurrentVersion();
PostalAddress component = getInstance(getValidElement(version.getVersion()), SUCCESS);
return (new PostalAddress.Builder(component));
}
/**
* Helper method to confirm that a TSPI-based builder can translate into an element-constructor version
* and back again. Getting equal components at each step does a full walkthrough of constructors
* and builder constructors.
*
* @param builder the base builder to test
*/
private void assertFullConversionEquality(PostalAddress.Builder builder) throws InvalidDDMSException {
PostalAddress builderComponent = builder.commit();
PostalAddress elementComponent = new PostalAddress(builderComponent.getXOMElementCopy());
assertEquals(builderComponent, elementComponent);
builderComponent = new PostalAddress.Builder(elementComponent).commit();
assertEquals(elementComponent, builderComponent);
}
/**
* Returns the expected output for the test instance of this component
*/
private String getExpectedHTMLTextOutput(OutputFormat format, boolean hasState) throws InvalidDDMSException {
Util.requireHTMLText(format);
StringBuffer text = new StringBuffer();
if (!DDMSVersion.getCurrentVersion().isAtLeast("5.0")) {
text.append(buildHTMLTextOutput(format, "postalAddress.street", TEST_STREETS.get(0)));
text.append(buildHTMLTextOutput(format, "postalAddress.city", TEST_CITY));
if (hasState)
text.append(buildHTMLTextOutput(format, "postalAddress.state", TEST_STATE));
else
text.append(buildHTMLTextOutput(format, "postalAddress.province", TEST_PROVINCE));
text.append(buildHTMLTextOutput(format, "postalAddress.postalCode", TEST_POSTAL_CODE));
text.append(CountryCodeTest.getFixture().getHTMLTextOutput(format, "postalAddress.", ""));
}
else {
text.append(GeneralAddressClassTest.getFixture().getHTMLTextOutput(format, "postalAddress.", ""));
}
return (text.toString());
}
/**
* Returns the expected JSON output for this unit test
*/
private String getExpectedJSONOutput(boolean hasState) {
StringBuffer json = new StringBuffer();
if (!DDMSVersion.getCurrentVersion().isAtLeast("5.0")) {
json.append("{\"street\":[\"1600 Pennsylvania Avenue, NW\"],\"city\":\"Washington\",");
if (hasState) {
json.append("\"state\":\"DC\",");
}
else {
json.append("\"province\":\"Alberta\",");
}
json.append("\"postalCode\":\"20500\",\"countryCode\":").append(CountryCodeTest.getFixture().toJSON());
json.append("}");
}
else
json.append("{\"addressType\":\"generalAddressClass\"}");
return (json.toString());
}
/**
* Returns the expected XML output for this unit test
*
* @boolean whether this address has a state or a province, ignored in DDMS 5.0
*/
private String getExpectedXMLOutput(boolean hasState) {
StringBuffer xml = new StringBuffer();
xml.append("<ddms:postalAddress ").append(getXmlnsDDMS()).append(">");
if (!DDMSVersion.getCurrentVersion().isAtLeast("5.0")) {
xml.append("<ddms:street>1600 Pennsylvania Avenue, NW</ddms:street>");
xml.append("<ddms:city>Washington</ddms:city>");
if (hasState)
xml.append("<ddms:state>DC</ddms:state>");
else
xml.append("<ddms:province>Alberta</ddms:province>");
xml.append("<ddms:postalCode>20500</ddms:postalCode>");
xml.append("<ddms:countryCode ddms:").append(CountryCodeTest.getTestQualifierName());
xml.append("=\"ISO-3166\" ddms:").append(CountryCodeTest.getTestValueName()).append("=\"USA\" />");
}
else {
xml.append(GeneralAddressClassTest.getFixture().toXML());
}
xml.append("</ddms:postalAddress>");
return (xml.toString());
}
@Test
public void testNameAndNamespace() {
for (String sVersion : getSupportedVersions()) {
DDMSVersion version = DDMSVersion.setCurrentVersion(sVersion);
assertNameAndNamespace(getInstance(getValidElement(sVersion), SUCCESS), DEFAULT_DDMS_PREFIX,
PostalAddress.getName(version));
getInstance(getWrongNameElementFixture(), WRONG_NAME_MESSAGE);
}
}
@Test
public void testConstructors() {
for (String sVersion : getSupportedVersions()) {
DDMSVersion version = DDMSVersion.setCurrentVersion(sVersion);
// Element-based, state or TSPI
getInstance(getValidElement(sVersion), SUCCESS);
// Data-based via Builder, state or TSPI
getBaseBuilder();
// Data-based via Builder, province
if (!version.isAtLeast("5.0")) {
PostalAddress.Builder builder = getBaseBuilder();
builder.setState(null);
builder.setProvince(TEST_PROVINCE);
getInstance(builder, SUCCESS);
}
}
}
@Test
public void testConstructorsMinimal() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion version = DDMSVersion.setCurrentVersion(sVersion);
if (!version.isAtLeast("5.0")) {
// Element-based, No optional fields
Element element = Util.buildDDMSElement(PostalAddress.getName(version), null);
PostalAddress elementComponent = getInstance(element, SUCCESS);
// Data-based, No optional fields
getInstance(new PostalAddress.Builder(elementComponent), SUCCESS);
}
}
}
@Test
public void testValidationErrors() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion version = DDMSVersion.setCurrentVersion(sVersion);
String postalName = PostalAddress.getName(version);
if (!version.isAtLeast("5.0")) {
// Element-based, Either a state or a province but not both.
Element element = Util.buildDDMSElement(postalName, null);
element.appendChild(Util.buildDDMSElement("state", TEST_STATE));
element.appendChild(Util.buildDDMSElement("province", TEST_PROVINCE));
getInstance(element, "Only 1 of state or province must be used.");
// Data-based, Either a state or a province but not both.
PostalAddress.Builder builder = getBaseBuilder();
builder.setProvince(TEST_PROVINCE);
getInstance(builder, "Only 1 of state or province");
// Too many streets
builder = getBaseBuilder();
for (int i = 0; i < 7; i++)
builder.getStreets().add("Street " + i);
getInstance(builder, "No more than 6 street elements must exist.");
}
else {
// Missing TSPI address
try {
new PostalAddress((GeneralAddressClass) null);
fail("Constructor allowed invalid data.");
}
catch (InvalidDDMSException e) {
expectMessage(e, "TSPI address must exist");
}
// Used the old constructor.
try {
new PostalAddress(TEST_STREETS, TEST_CITY, TEST_STATE, TEST_POSTAL_CODE, null, true);
fail("Constructor allowed invalid data.");
}
catch (InvalidDDMSException e) {
expectMessage(e, "postalAddress must be defined with a TSPI address.");
}
// Unknown address type
PostalAddress.Builder builder = getBaseBuilder();
builder.setAddressType("CaveInWoods");
getInstance(builder, "Unknown address type");
}
}
}
@Test
public void testValidationWarnings() {
for (String sVersion : getSupportedVersions()) {
DDMSVersion version = DDMSVersion.setCurrentVersion(sVersion);
// No warnings
PostalAddress component = getInstance(getValidElement(sVersion), SUCCESS);
assertEquals(0, component.getValidationWarnings().size());
if (!version.isAtLeast("5.0")) {
// Completely empty
Element element = Util.buildDDMSElement(PostalAddress.getName(version), null);
component = getInstance(element, SUCCESS);
assertEquals(1, component.getValidationWarnings().size());
String text = "A completely empty ddms:postalAddress element was found.";
String locator = "ddms:postalAddress";
assertWarningEquality(text, locator, component.getValidationWarnings().get(0));
}
}
}
@Test
public void testEquality() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion version = DDMSVersion.setCurrentVersion(sVersion);
// Base equality
PostalAddress elementComponent = getInstance(getValidElement(sVersion), SUCCESS);
PostalAddress builderComponent = new PostalAddress.Builder(elementComponent).commit();
assertEquals(elementComponent, builderComponent);
assertEquals(elementComponent.hashCode(), builderComponent.hashCode());
// Base equality of various TSPI addresses
// Conversion both ways: builder-element and element-builder
if (version.isAtLeast("5.0")) {
PostalAddress.Builder builder = new PostalAddress.Builder();
builder.setAddressType("IntersectionAddress");
builder.setIntersectionAddress(new IntersectionAddress.Builder(IntersectionAddressTest.getFixture()));
assertFullConversionEquality(builder);
builder = new PostalAddress.Builder();
builder.setAddressType("LandmarkAddress");
builder.setLandmarkAddress(new LandmarkAddress.Builder(LandmarkAddressTest.getFixture()));
assertFullConversionEquality(builder);
builder = new PostalAddress.Builder();
builder.setAddressType("NumberedThoroughfareAddress");
builder.setNumberedThoroughfareAddress(new NumberedThoroughfareAddress.Builder(NumberedThoroughfareAddressTest.getFixture()));
assertFullConversionEquality(builder);
builder = new PostalAddress.Builder();
builder.setAddressType("TwoNumberAddressRange");
builder.setTwoNumberAddressRange(new TwoNumberAddressRange.Builder(TwoNumberAddressRangeTest.getFixture()));
assertFullConversionEquality(builder);
builder = new PostalAddress.Builder();
builder.setAddressType("UnnumberedThoroughfareAddress");
builder.setUnnumberedThoroughfareAddress(new UnnumberedThoroughfareAddress.Builder(UnnumberedThoroughfareAddressTest.getFixture()));
assertFullConversionEquality(builder);
builder = new PostalAddress.Builder();
builder.setAddressType("USPSGeneralDeliveryOffice");
builder.setUSPSGeneralDeliveryOffice(new USPSGeneralDeliveryOffice.Builder(USPSGeneralDeliveryOfficeTest.getFixture()));
assertFullConversionEquality(builder);
builder = new PostalAddress.Builder();
builder.setAddressType("USPSPostalDeliveryBox");
builder.setUSPSPostalDeliveryBox(new USPSPostalDeliveryBox.Builder(USPSPostalDeliveryBoxTest.getFixture()));
assertFullConversionEquality(builder);
builder = new PostalAddress.Builder();
builder.setAddressType("USPSPostalDeliveryRoute");
builder.setUSPSPostalDeliveryRoute(new USPSPostalDeliveryRoute.Builder(USPSPostalDeliveryRouteTest.getFixture()));
assertFullConversionEquality(builder);
}
// Wrong class
Rights wrongComponent = new Rights(true, true, true);
assertFalse(elementComponent.equals(wrongComponent));
// Different values in each field
if (!version.isAtLeast("5.0")) {
PostalAddress.Builder builder = getBaseBuilder();
builder.setStreets(null);
assertFalse(elementComponent.equals(builder.commit()));
builder = getBaseBuilder();
builder.setCity(null);
assertFalse(elementComponent.equals(builder.commit()));
builder = getBaseBuilder();
builder.setState(null);
assertFalse(elementComponent.equals(builder.commit()));
builder = getBaseBuilder();
builder.setPostalCode(null);
assertFalse(elementComponent.equals(builder.commit()));
builder = getBaseBuilder();
builder.setCountryCode(null);
assertFalse(elementComponent.equals(builder.commit()));
builder = getBaseBuilder();
builder.setState(null);
builder.setProvince(TEST_PROVINCE);
assertFalse(elementComponent.equals(builder.commit()));
}
}
}
@Test
public void testVersionSpecific() throws InvalidDDMSException {
// Using TSPI in old code is implicit, since classes cannot be instantiated.
// Using old code in DDMS 5.0 is up under testValidationErrors().
}
@Test
public void testOutput() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
PostalAddress elementComponent = getInstance(getValidElement(sVersion), SUCCESS);
assertEquals(getExpectedHTMLTextOutput(OutputFormat.HTML, true), elementComponent.toHTML());
assertEquals(getExpectedHTMLTextOutput(OutputFormat.TEXT, true), elementComponent.toText());
assertEquals(getExpectedXMLOutput(true), elementComponent.toXML());
assertEquals(getExpectedJSONOutput(true), elementComponent.toJSON());
assertValidJSON(elementComponent.toJSON());
PostalAddress.Builder builder = getBaseBuilder();
builder.setState(null);
builder.setProvince(TEST_PROVINCE);
elementComponent = builder.commit();
assertEquals(getExpectedHTMLTextOutput(OutputFormat.HTML, false), elementComponent.toHTML());
assertEquals(getExpectedHTMLTextOutput(OutputFormat.TEXT, false), elementComponent.toText());
assertEquals(getExpectedXMLOutput(false), elementComponent.toXML());
assertEquals(getExpectedJSONOutput(false), elementComponent.toJSON());
assertValidJSON(elementComponent.toJSON());
}
}
@Test
public void testBuilderIsEmpty() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
PostalAddress.Builder builder = new PostalAddress.Builder();
assertNull(builder.commit());
assertTrue(builder.isEmpty());
builder.setCity(TEST_CITY);
assertFalse(builder.isEmpty());
}
}
@Test
public void testBuilderLazyList() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
PostalAddress.Builder builder = new PostalAddress.Builder();
assertNotNull(builder.getStreets().get(1));
}
}
}