/* 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.resource;
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.security.ism.SecurityAttributesTest;
import buri.ddmsence.util.DDMSVersion;
import buri.ddmsence.util.PropertyReader;
import buri.ddmsence.util.Util;
/**
* <p> Tests related to ddms:addressee elements </p>
*
* <p> Because a ddms:addressee is a local component, we cannot load a valid document from a unit test data file. We
* have to build the well-formed Element ourselves. </p>
*
* @author Brian Uri!
* @since 2.0.0
*/
public class AddresseeTest extends AbstractBaseTestCase {
/**
* Constructor
*/
public AddresseeTest() {
super(null);
removeSupportedVersions("2.0 3.0 3.1");
}
/**
* Returns a fixture object for testing.
*
* @param useOrg true to put an organization in, false for a person
*/
public static Element getFixtureElement(boolean useOrg) {
try {
DDMSVersion version = DDMSVersion.getCurrentVersion();
Element element = Util.buildDDMSElement(Addressee.getName(version), null);
element.addNamespaceDeclaration(PropertyReader.getPrefix("ddms"), version.getNamespace());
element.appendChild(useOrg ? OrganizationTest.getFixture().getXOMElementCopy()
: PersonTest.getFixture().getXOMElementCopy());
SecurityAttributesTest.getFixture().addTo(element);
return (element);
}
catch (InvalidDDMSException e) {
fail("Could not create fixture: " + e.getMessage());
}
return (null);
}
/**
* Returns a fixture object for testing.
*/
public static List<Addressee> getFixtureList() {
try {
List<Addressee> list = new ArrayList<Addressee>();
list.add(new Addressee(getFixtureElement(true)));
return (list);
}
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 Addressee getInstance(Element element, String message) {
boolean expectFailure = !Util.isEmpty(message);
Addressee component = null;
try {
component = new Addressee(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 Addressee getInstance(Addressee.Builder builder, String message) {
boolean expectFailure = !Util.isEmpty(message);
Addressee 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.
*
* @param useOrg true to put an organization in, false for a person
*/
private Addressee.Builder getBaseBuilder(boolean useOrg) {
Addressee component = getInstance(getFixtureElement(useOrg), SUCCESS);
return (new Addressee.Builder(component));
}
/**
* Returns the expected output for the test instance of this component
*/
private String getExpectedHTMLTextOutput(OutputFormat format) throws InvalidDDMSException {
Util.requireHTMLText(format);
StringBuffer text = new StringBuffer();
text.append(buildHTMLTextOutput(format, "addressee.entityType", "organization"));
text.append(buildHTMLTextOutput(format, "addressee.name", "DISA"));
text.append(buildHTMLTextOutput(format, "addressee.classification", "U"));
text.append(buildHTMLTextOutput(format, "addressee.ownerProducer", "USA"));
return (text.toString());
}
/**
* Returns the expected JSON output for this unit test
*/
private String getExpectedJSONOutput() {
StringBuffer json = new StringBuffer();
json.append("{\"organization\":").append(OrganizationTest.getFixture().toJSON());
json.append(",").append(SecurityAttributesTest.getBasicJSON()).append("}");
return (json.toString());
}
/**
* Returns the expected XML output for this unit test
*/
private String getExpectedXMLOutput() {
StringBuffer xml = new StringBuffer();
xml.append("<ddms:addressee ").append(getXmlnsDDMS()).append(" ").append(getXmlnsISM()).append(" ");
xml.append("ism:classification=\"U\" ism:ownerProducer=\"USA\">");
xml.append("<ddms:organization><ddms:name>DISA</ddms:name></ddms:organization>");
xml.append("</ddms:addressee>");
return (xml.toString());
}
@Test
public void testNameAndNamespace() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion version = DDMSVersion.setCurrentVersion(sVersion);
assertNameAndNamespace(getInstance(getFixtureElement(true), SUCCESS), DEFAULT_DDMS_PREFIX,
Addressee.getName(version));
getInstance(getWrongNameElementFixture(), WRONG_NAME_MESSAGE);
}
}
@Test
public void testConstructors() {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
// Element-based, organization
getInstance(getFixtureElement(true), SUCCESS);
// Element-based, person
getInstance(getFixtureElement(false), SUCCESS);
// Data-based via Builder, organization
getBaseBuilder(true);
// Data-based via Builder, person
getBaseBuilder(false);
}
}
@Test
public void testConstructorsMinimal() {
// No tests.
}
@Test
public void testValidationErrors() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
// Missing entity
Addressee.Builder builder = getBaseBuilder(true);
builder.setEntityType(null);
builder.setOrganization(null);
getInstance(builder, "entity must exist.");
// Missing security attributes
builder = getBaseBuilder(true);
builder.setSecurityAttributes(null);
getInstance(builder, "classification must exist.");
// Wrong entity
try {
new Addressee(ServiceTest.getFixture(), SecurityAttributesTest.getFixture());
fail("Constructor allowed invalid data.");
}
catch (InvalidDDMSException e) {
expectMessage(e, "The entity must be a ");
}
}
}
@Test
public void testValidationWarnings() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
// No warnings
Addressee component = getInstance(getFixtureElement(true), SUCCESS);
assertEquals(0, component.getValidationWarnings().size());
}
}
@Test
public void testEquality() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
// Base equality
Addressee elementComponent = getInstance(getFixtureElement(true), SUCCESS);
Addressee builderComponent = new Addressee.Builder(elementComponent).commit();
assertEquals(elementComponent, builderComponent);
assertEquals(elementComponent.hashCode(), builderComponent.hashCode());
// Different values in each field
Addressee.Builder builder = getBaseBuilder(false);
assertFalse(elementComponent.equals(builder.commit()));
}
}
@Test
public void testVersionSpecific() throws InvalidDDMSException {
DDMSVersion.setCurrentVersion("2.0");
getInstance(getFixtureElement(true), "The addressee element must not ");
}
@Test
public void testOutput() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
Addressee elementComponent = getInstance(getFixtureElement(true), SUCCESS);
assertEquals(getExpectedHTMLTextOutput(OutputFormat.HTML), elementComponent.toHTML());
assertEquals(getExpectedHTMLTextOutput(OutputFormat.TEXT), elementComponent.toText());
assertEquals(getExpectedXMLOutput(), elementComponent.toXML());
assertEquals(getExpectedJSONOutput(), elementComponent.toJSON());
assertValidJSON(elementComponent.toJSON());
}
}
@Test
public void testBuilderIsEmpty() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
Addressee.Builder builder = new Addressee.Builder();
assertNull(builder.commit());
assertTrue(builder.isEmpty());
builder.getPerson().setNames(Util.getXsListAsList("Name"));
assertFalse(builder.isEmpty());
}
}
}