/**
* Copyright (C) 2009 - present by OpenGamma Inc. and the OpenGamma group of companies
*
* Please see distribution for license.
*/
package com.opengamma.masterdb.security;
import static org.testng.AssertJUnit.assertEquals;
import static org.testng.AssertJUnit.assertNotNull;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.Iterator;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.opengamma.core.security.Security;
import com.opengamma.financial.security.future.BondFutureDeliverable;
import com.opengamma.financial.security.future.BondFutureSecurity;
import com.opengamma.id.ExternalId;
import com.opengamma.id.ExternalIdBundle;
import com.opengamma.id.UniqueId;
import com.opengamma.master.security.ManageableSecurity;
import com.opengamma.master.security.SecurityDocument;
import com.opengamma.master.security.SecurityMaster;
import com.opengamma.master.security.SecuritySearchRequest;
import com.opengamma.master.security.SecuritySearchResult;
/**
* Generic TestCase for a SecurityMaster implementation. Either inherit from it, or
* delegate through the SecurityMasterTestCaseMethods interface.
*/
public class SecurityMasterTestCase extends SecurityTestCase {
private static final Logger s_logger = LoggerFactory.getLogger(SecurityMasterTestCase.class);
private final SecurityMaster _secMaster;
/**
* TestNG constructor.
*/
public SecurityMasterTestCase() {
_secMaster = null; // handle TestNG
}
/**
* Normal constructor.
*
* @param secMaster the security master
*/
public SecurityMasterTestCase(final SecurityMaster secMaster) {
_secMaster = secMaster;
}
@Override
protected boolean isInitialized() {
return _secMaster != null; // handle TestNG
}
//-------------------------------------------------------------------------
private UniqueId putSecurity(final ManageableSecurity security) {
s_logger.debug("putting security = {}", security);
SecurityDocument document = new SecurityDocument();
document.setSecurity(security);
document = _secMaster.add(document);
assertNotNull(document);
final UniqueId uniqueId = document.getUniqueId();
s_logger.debug("Security {} stored with identifier {}", security.getClass(), uniqueId);
return uniqueId;
}
private UniqueId updateSecurity(final ManageableSecurity security) {
SecurityDocument document = new SecurityDocument();
document.setSecurity(security);
document.setUniqueId(security.getUniqueId());
document = _secMaster.update(document);
assertNotNull(document);
final UniqueId uniqueId = document.getUniqueId();
s_logger.debug("Security {} updated; new identifier {}", security.getClass(), uniqueId);
return uniqueId;
}
private Security getSecurity(final Iterable<ExternalId> identifiers) {
s_logger.debug("Search for security with identifiers {}", identifiers);
final SecuritySearchRequest request = new SecuritySearchRequest();
request.addExternalIds(identifiers);
final SecuritySearchResult result = _secMaster.search(request);
assertNotNull(result);
final List<SecurityDocument> documents = result.getDocuments();
assertNotNull(documents);
assertEquals(true, documents.size() > 0);
final SecurityDocument document = documents.get(documents.size() - 1);
assertNotNull(document);
final Security security = document.getSecurity();
assertNotNull(security);
return security;
}
private Security getSecurity(final UniqueId uniqueId) {
s_logger.debug("Search for security with identifier {}", uniqueId);
final SecurityDocument document = _secMaster.get(uniqueId);
assertNotNull(document);
final Security security = document.getSecurity();
assertNotNull(security);
return security;
}
private void normalizeBondFutureSecurity(final BondFutureSecurity security) {
final List<BondFutureDeliverable> basket = new ArrayList<BondFutureDeliverable>(security.getBasket());
Collections.sort(basket, new Comparator<BondFutureDeliverable>() {
@Override
public int compare(BondFutureDeliverable o1, BondFutureDeliverable o2) {
return o1.getIdentifiers().compareTo(o2.getIdentifiers());
}
});
security.setBasket(basket);
}
/**
* Shuffles things around so that the equality comparison is valid. E.g. sorts stuff that might (correctly) be in an
* arbitrary order.
*/
private void normalizeSecurity (final Security security) {
assertNotNull(security);
if (security instanceof BondFutureSecurity) {
normalizeBondFutureSecurity ((BondFutureSecurity)security);
}
}
@Override
protected <T extends ManageableSecurity> void assertSecurity(final Class<T> securityClass, final T security) {
normalizeSecurity (security);
s_logger.debug("Testing {} instance {}", securityClass, security.hashCode());
final UniqueId uniqueId = putSecurity(security);
assertNotNull(uniqueId);
s_logger.debug("UID = {}", uniqueId);
Security sec;
// retrieve by unique identifier
sec = getSecurity(uniqueId);
normalizeSecurity(sec);
assertEquals(security, sec);
ExternalIdBundle bundle = null;
if (security.getExternalIdBundle().size() > 0) {
final Iterator<ExternalId> iterator = security.getExternalIdBundle().iterator();
bundle = ExternalIdBundle.EMPTY;
// retrieve with one identifier
ExternalId id = iterator.next();
bundle = bundle.withExternalId(id);
sec = getSecurity(bundle);
normalizeSecurity(sec);
assertEquals(security, sec);
// retrieve with one valid and one incorrect identifier
sec = getSecurity(Arrays.asList(id, ExternalId.of("FOO", "BAR")));
normalizeSecurity(sec);
assertEquals(security, sec);
// retrieve with exact bundle
sec = getSecurity(security.getExternalIdBundle());
normalizeSecurity(sec);
assertEquals(security, sec);
}
final String originalName = security.getName ();
final String newName = "UPDATED " + originalName;
security.setName(newName);
final UniqueId newUniqueId = updateSecurity (security);
assertNotNull(newUniqueId);
s_logger.debug("New UID = {}", newUniqueId);
assertEquals(false, uniqueId.equals(newUniqueId));
// retrieve with original uniqueId - gets original
sec = getSecurity(uniqueId);
assertNotNull(sec);
assertEquals("Get by original failed: Old UID: " + uniqueId + " New UID: " + newUniqueId, originalName, sec.getName());
// retrieve with new uniqueId - gets updated
sec = getSecurity(newUniqueId);
assertNotNull(sec);
assertEquals("Get by UID failed: Old UID: " + uniqueId + " New UID: " + newUniqueId, newName, sec.getName());
// retrieve with a "latest" uniqueId - gets updated
sec = getSecurity(uniqueId.toLatest());
assertNotNull(sec);
assertEquals("Get by latest failed: Old UID: " + uniqueId + " New UID: " + newUniqueId, newName, sec.getName());
// retrieving by the earlier bundle - gets updated
if (bundle != null) {
sec = getSecurity(bundle);
assertNotNull(sec);
assertEquals(newName, sec.getName());
}
// TODO: could extend this with delete and correction operations etc ...
}
}