/* 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.extensible;
import static org.junit.Assert.*;
import java.util.ArrayList;
import java.util.List;
import nu.xom.Attribute;
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.Keyword;
import buri.ddmsence.util.DDMSVersion;
import buri.ddmsence.util.Util;
import com.google.gson.Gson;
/**
* <p>
* Tests related to the extensible attributes themselves. How they interact with parent classes is tested in those
* classes.
* </p>
*
* @author Brian Uri!
* @since 1.1.0
*/
public class ExtensibleAttributesTest extends AbstractBaseTestCase {
private static final String TEST_NAMESPACE = "http://ddmsence.urizone.net/";
/**
* Constructor
*/
public ExtensibleAttributesTest() {
super(null);
}
/**
* Returns a fixture object for testing.
*/
public static ExtensibleAttributes getFixture() {
try {
List<Attribute> attributes = new ArrayList<Attribute>();
attributes.add(getTestAttribute());
return (new ExtensibleAttributes(attributes));
}
catch (InvalidDDMSException e) {
fail("Could not create fixture: " + e.getMessage());
}
return (null);
}
/**
* Returns generated test data.
*/
private static Attribute getXsiSchemaLocation() {
return (new Attribute("xsi:schemaLocation", "http://www.w3.org/2001/XMLSchema-instance",
"urn:us:mil:ces:metadata:ddms:5 ../DDMS-v5.xsd"));
}
/**
* Returns generated test data.
*/
private static Attribute getXsiNoNamespaceSchemaLocation() {
return (new Attribute("xsi:noNamespaceSchemaLocation", "http://www.w3.org/2001/XMLSchema-instance",
"schema.xsd"));
}
/**
* Returns generated test data.
*/
private static Attribute getTestAttribute() {
return (new Attribute("ddmsence:relevance", TEST_NAMESPACE, "95"));
}
/**
* 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 ExtensibleAttributes getInstance(Element element, String message) {
boolean expectFailure = !Util.isEmpty(message);
ExtensibleAttributes attributes = null;
try {
attributes = new ExtensibleAttributes(element);
checkConstructorSuccess(expectFailure);
}
catch (InvalidDDMSException e) {
checkConstructorFailure(expectFailure, e);
expectMessage(e, message);
}
return (attributes);
}
/**
* 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 ExtensibleAttributes getInstance(ExtensibleAttributes.Builder builder, String message) {
boolean expectFailure = !Util.isEmpty(message);
ExtensibleAttributes 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 test attribute.
*
* This builder can then be modified to test various conditions.
*/
private ExtensibleAttributes.Builder getBaseBuilder() {
try {
List<Attribute> attributes = new ArrayList<Attribute>();
attributes.add(getTestAttribute());
ExtensibleAttributes component = new ExtensibleAttributes(attributes);
return (new ExtensibleAttributes.Builder(component));
}
catch (InvalidDDMSException e) {
checkConstructorFailure(false, e);
}
return (null);
}
/**
* Returns a test element that can be decorated with extensible attributes.
*/
private Element getTestElement() {
try {
return (new Keyword("testValue", null).getXOMElementCopy());
}
catch (InvalidDDMSException e) {
checkConstructorFailure(false, e);
}
return (null);
}
/**
* Returns the expected output for the test instance of this component
*/
private String getExpectedHTMLTextOutput(OutputFormat format) {
Util.requireHTMLText(format);
StringBuffer text = new StringBuffer();
text.append(buildHTMLTextOutput(format, "ddmsence.relevance", "95"));
return (text.toString());
}
/**
* Returns the expected output for the test instance of this component
*/
private String getExpectedJSONOutput() {
StringBuffer text = new StringBuffer();
text.append("{\"ddmsence.relevance\":\"95\"}");
return (text.toString());
}
@Test
public void testConstructors() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
// Element-based
Element element = getTestElement();
element.addAttribute(new Attribute(getTestAttribute()));
getInstance(element, SUCCESS);
// Data-based via Builder
getBaseBuilder();
}
}
@Test
public void testConstructorsMinimal() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
// Element-based, no optional fields
ExtensibleAttributes elementAttributes = getInstance(getTestElement(), SUCCESS);
// Data-based via Builder, no optional fields
getInstance(new ExtensibleAttributes.Builder(elementAttributes), SUCCESS);
}
}
@Test
public void testValidationErrors() {
// No invalid cases right now. The validation occurs when the attributes are added to some component.
}
@Test
public void testValidationWarnings() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
// No warnings
Element element = getTestElement();
element.addAttribute(new Attribute(getTestAttribute()));
ExtensibleAttributes component = getInstance(element, SUCCESS);
assertEquals(0, component.getValidationWarnings().size());
}
}
@Test
public void testEquality() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
// Base equality
Element element = getTestElement();
element.addAttribute(new Attribute(getTestAttribute()));
ExtensibleAttributes elementAttributes = getInstance(element, SUCCESS);
ExtensibleAttributes builderAttributes = new ExtensibleAttributes.Builder(elementAttributes).commit();
assertEquals(elementAttributes, builderAttributes);
assertEquals(elementAttributes.hashCode(), builderAttributes.hashCode());
// Wrong class
Rights wrongComponent = new Rights(true, true, true);
assertFalse(elementAttributes.equals(wrongComponent));
// Different attribute list sizes
ExtensibleAttributes.Builder builder = getBaseBuilder();
Attribute attr = new Attribute("essence:confidence", "http://essence/", "test");
builder.getAttributes().add(new ExtensibleAttributes.AttributeBuilder(attr));
assertFalse(elementAttributes.equals(builder.commit()));
// Different attribute name
builder = getBaseBuilder();
builder.getAttributes().clear();
attr = new Attribute("ddmsence:confidence", TEST_NAMESPACE, "95");
builder.getAttributes().add(new ExtensibleAttributes.AttributeBuilder(attr));
assertFalse(elementAttributes.equals(builder.commit()));
// Different attribute namespace
builder = getBaseBuilder();
builder.getAttributes().clear();
attr = new Attribute("essence:relevance", "http://essence/", "95");
builder.getAttributes().add(new ExtensibleAttributes.AttributeBuilder(attr));
assertFalse(elementAttributes.equals(builder.commit()));
}
}
@Test
public void testVersionSpecific() {
// No tests.
}
@Test
public void testOutput() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
Element element = getTestElement();
element.addAttribute(new Attribute(getTestAttribute()));
ExtensibleAttributes elementAttributes = getInstance(element, SUCCESS);
assertEquals(getExpectedHTMLTextOutput(OutputFormat.HTML), elementAttributes.getHTMLTextOutput(OutputFormat.HTML, ""));
assertEquals(getExpectedHTMLTextOutput(OutputFormat.TEXT), elementAttributes.getHTMLTextOutput(OutputFormat.TEXT, ""));
String json = new Gson().toJson(elementAttributes.getJSONObject());
assertEquals(getExpectedJSONOutput(), json);
assertValidJSON(json);
}
}
@Test
public void testBuilderIsEmpty() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
ExtensibleAttributes.Builder builder = new ExtensibleAttributes.Builder();
assertNotNull(builder.commit());
assertTrue(builder.isEmpty());
builder.getAttributes().add(new ExtensibleAttributes.AttributeBuilder(getTestAttribute()));
assertFalse(builder.isEmpty());
}
}
@Test
public void testBuilderLazyList() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
ExtensibleAttributes.Builder builder = new ExtensibleAttributes.Builder();
assertNotNull(builder.getAttributes().get(1));
assertTrue(builder.commit().getAttributes().isEmpty());
}
}
@Test
public void testAddTo() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
ExtensibleAttributes component = getFixture();
// Base case
Element element = Util.buildDDMSElement("sample", null);
component.addTo(element);
ExtensibleAttributes output = new ExtensibleAttributes(element);
assertEquals(component, output);
// Duplicate
element = getTestElement();
element.addAttribute(getTestAttribute());
try {
component.addTo(element);
fail("addTo() allowed duplicate attribute.");
}
catch (InvalidDDMSException e) {
expectMessage(e, "The extensible attribute with");
}
}
}
@Test
public void testGetNonNull() throws InvalidDDMSException {
ExtensibleAttributes component = new ExtensibleAttributes((List) null);
ExtensibleAttributes output = ExtensibleAttributes.getNonNullInstance(null);
assertEquals(component, output);
output = ExtensibleAttributes.getNonNullInstance(getFixture());
assertEquals(getFixture(), output);
}
@Test
public void testIsEmpty() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
ExtensibleAttributes component = getInstance(getTestElement(), SUCCESS);
assertTrue(component.isEmpty());
}
}
@Test
public void testXsiAttributes() throws InvalidDDMSException {
for (String sVersion : getSupportedVersions()) {
DDMSVersion.setCurrentVersion(sVersion);
Element element = getTestElement();
element.addAttribute(getXsiSchemaLocation());
element.addAttribute(getXsiNoNamespaceSchemaLocation());
ExtensibleAttributes component = getInstance(element, SUCCESS);
assertTrue(component.getAttributes().isEmpty());
}
}
}