/* 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 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.Util;
/**
* <p> Tests related to ddms:publisher elements </p>
*
* @author Brian Uri!
* @since 2.0.0
*/
public class PublisherTest extends AbstractBaseTestCase {
/**
* Constructor
*/
public PublisherTest() {
super("publisher.xml");
}
/**
* Returns a fixture object for testing.
*/
public static Publisher getFixture() {
try {
return (new Publisher(PersonTest.getFixture(), null, null));
}
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 Publisher getInstance(Element element, String message) {
boolean expectFailure = !Util.isEmpty(message);
Publisher component = null;
try {
SecurityAttributesTest.getFixture().addTo(element);
component = new Publisher(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 Publisher getInstance(Publisher.Builder builder, String message) {
boolean expectFailure = !Util.isEmpty(message);
Publisher 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 Publisher.Builder getBaseBuilder() {
DDMSVersion version = DDMSVersion.getCurrentVersion();
Publisher component = getInstance(getValidElement(version.getVersion()), SUCCESS);
return (new Publisher.Builder(component));
}
/**
* Returns the expected output for the test instance of this component
*/
private String getExpectedHTMLTextOutput(OutputFormat format) throws InvalidDDMSException {
Util.requireHTMLText(format);
DDMSVersion version = DDMSVersion.getCurrentVersion();
StringBuffer text = new StringBuffer();
text.append(ServiceTest.getFixture().getHTMLTextOutput(format, "publisher.", ""));
if (version.isAtLeast("4.0.1"))
text.append(buildHTMLTextOutput(format, "publisher.pocType", "DoD-Dist-B"));
text.append(buildHTMLTextOutput(format, "publisher.classification", "U"));
text.append(buildHTMLTextOutput(format, "publisher.ownerProducer", "USA"));
return (text.toString());
}
/**
* Returns the expected JSON output for this unit test
*/
private String getExpectedJSONOutput() {
DDMSVersion version = DDMSVersion.getCurrentVersion();
StringBuffer json = new StringBuffer();
json.append("{\"service\":");
json.append(ServiceTest.getFixture().toJSON()).append(",");
if (version.isAtLeast("4.0.1"))
json.append("\"pocType\":[\"DoD-Dist-B\"],");
json.append(SecurityAttributesTest.getBasicJSON()).append("}");
return (json.toString());
}
/**
* Returns the expected XML output for this unit test
*/
private String getExpectedXMLOutput() {
DDMSVersion version = DDMSVersion.getCurrentVersion();
StringBuffer xml = new StringBuffer();
xml.append("<ddms:publisher ").append(getXmlnsDDMS()).append(" ").append(getXmlnsISM());
if (version.isAtLeast("4.0.1"))
xml.append(" ism:pocType=\"DoD-Dist-B\"");
xml.append(" ism:classification=\"U\" ism:ownerProducer=\"USA\">\n\t<ddms:").append(Service.getName(version)).append(
">\n");
xml.append("\t\t<ddms:name>https://metadata.dod.mil/ebxmlquery/soap</ddms:name>\n");
xml.append("\t</ddms:").append(Service.getName(version)).append(">\n</ddms:publisher>");
return (xml.toString());
}
@Test
public void testNameAndNamespace() {
for (String sVersion : getSupportedVersions()) {
DDMSVersion version = DDMSVersion.setCurrentVersion(sVersion);
assertNameAndNamespace(getInstance(getValidElement(sVersion), SUCCESS), DEFAULT_DDMS_PREFIX,
Publisher.getName(version));
getInstance(getWrongNameElementFixture(), WRONG_NAME_MESSAGE);
}
}
@Test
public void testConstructors() {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
// Element-based
getInstance(getValidElement(sVersion), SUCCESS);
// Data-based via Builder
getBaseBuilder();
}
}
@Test
public void testConstructorsMinimal() {
for (String sVersion : getSupportedVersions()) {
DDMSVersion version = DDMSVersion.setCurrentVersion(sVersion);
// Element-based, No optional fields
Element element = Util.buildDDMSElement(Publisher.getName(version), null);
element.appendChild(OrganizationTest.getFixture().getXOMElementCopy());
Publisher elementComponent = getInstance(element, SUCCESS);
// Data-based, No optional fields
getInstance(new Publisher.Builder(elementComponent), SUCCESS);
}
}
@Test
public void testValidationErrors() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion version = DDMSVersion.setCurrentVersion(sVersion);
// Missing entity
Publisher.Builder builder = getBaseBuilder();
builder.setEntityType(null);
builder.setOrganization(null);
getInstance(builder, "entity must exist.");
if (version.isAtLeast("4.0.1")) {
// Invalid pocType
builder = getBaseBuilder();
builder.setPocTypes(Util.getXsListAsList("Unknown"));
getInstance(builder, "Unknown is not a valid enumeration token");
// Partial Invalid pocType
builder = getBaseBuilder();
builder.setPocTypes(Util.getXsListAsList("DoD-Dist-B Unknown"));
getInstance(builder, "Unknown is not a valid enumeration token");
}
}
}
@Test
public void testValidationWarnings() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
// No warnings
Publisher component = getInstance(getValidElement(sVersion), SUCCESS);
assertEquals(0, component.getValidationWarnings().size());
}
}
@Test
public void testEquality() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion version = DDMSVersion.setCurrentVersion(sVersion);
// Base equality
Publisher elementComponent = getInstance(getValidElement(sVersion), SUCCESS);
Publisher builderComponent = new Publisher.Builder(elementComponent).commit();
assertEquals(elementComponent, builderComponent);
assertEquals(elementComponent.hashCode(), builderComponent.hashCode());
// Different values in each field
Publisher.Builder builder = getBaseBuilder();
builder.setEntityType(Person.getName(version));
builder.setPerson(new Person.Builder(PersonTest.getFixture()));
builder.setOrganization(null);
assertFalse(elementComponent.equals(builder.commit()));
if (version.isAtLeast("4.0.1")) {
builder = getBaseBuilder();
builder.setPocTypes(Util.getXsListAsList("DoD-Dist-C"));
assertFalse(elementComponent.equals(builder.commit()));
}
}
}
@Test
public void testVersionSpecific() throws InvalidDDMSException {
// pocType before 4.0.1
DDMSVersion.setCurrentVersion("3.1");
Publisher.Builder builder = getBaseBuilder();
builder.setPocTypes(Util.getXsListAsList("DoD-Dist-B"));
getInstance(builder, "This component must not have a pocType");
}
@Test
public void testOutput() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
Publisher elementComponent = getInstance(getValidElement(sVersion), 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);
Publisher.Builder builder = new Publisher.Builder();
assertNull(builder.commit());
assertTrue(builder.isEmpty());
builder.setPocTypes(Util.getXsListAsList("DoD-Dist-B"));
assertFalse(builder.isEmpty());
}
}
}