package org.dataone.integration.it.testImplementations;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.io.InputStream;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import org.apache.commons.io.IOUtils;
import org.apache.directory.api.ldap.model.schema.comparators.ObjectIdentifierComparator;
import org.dataone.client.auth.CertificateManager;
import org.dataone.client.v1.types.D1TypeBuilder;
import org.dataone.configuration.Settings;
import org.dataone.integration.APITestUtils;
import org.dataone.integration.ContextAwareTestCaseDataone;
import org.dataone.integration.TestIterationEndingException;
import org.dataone.integration.adapters.CommonCallAdapter;
import org.dataone.integration.it.ContextAwareAdapter;
import org.dataone.integration.webTest.WebTestDescription;
import org.dataone.integration.webTest.WebTestName;
import org.dataone.service.exceptions.BaseException;
import org.dataone.service.exceptions.NotAuthorized;
import org.dataone.service.exceptions.NotFound;
import org.dataone.service.types.v1.Event;
import org.dataone.service.types.v1.Identifier;
import org.dataone.service.types.v1.Node;
import org.dataone.service.types.v1.NodeReference;
import org.dataone.service.types.v1.Subject;
import org.dataone.service.types.v2.Log;
import org.dataone.service.types.v2.LogEntry;
import org.dataone.service.util.Constants;
//import org.dataone.integration.ExampleUtilities;
import org.dataone.service.util.TypeMarshaller;
public class CoreTestImplementations extends ContextAwareAdapter {
public CoreTestImplementations(ContextAwareTestCaseDataone catc) {
super(catc);
}
/**
* Will test the ping call for all nodes. Requires an iterator to go through
* all the nodes (this may iterate across either MN or CN nodes). Also requires
* a version string so it knows against which version of API it should test ping.
*
* @param nodeIterator
* an {@link Iterator} accross MN or CN {@link Node}s
* @param version
* either "v1" or "v2", to match the API version being tested
*/
@WebTestName("ping - test for valid return")
@WebTestDescription("this test uses a certificateless connection, and tests for a valid date that can be deserialized into java.util.Date,"
+ "and also checks that the returned date is within 1 minute of the client date")
public void testPing(Iterator<Node> nodeIterator, String version) {
while (nodeIterator.hasNext())
testPing(nodeIterator.next(), version);
}
/**
* Will run the ping command and test for proper execution.
* Makes use of {@link CommonCallAdapter} to call ping on the correct node type
* (MN or CN) against the correct API version.
* @param node
* @param version
*/
public void testPing(Node node, String version) {
ContextAwareTestCaseDataone.setupClientSubject_NoCert();
CommonCallAdapter callAdapter = new CommonCallAdapter(getSession(Constants.SUBJECT_PUBLIC), node, version);
String currentUrl = callAdapter.getNodeBaseServiceUrl();
try {
// Assume.assumeTrue(APITestUtils.isTierImplemented(mn, "Tier5"));
Date localNow = new Date();
Date pingDate = callAdapter.ping();
assertTrue(callAdapter.getLatestRequestUrl() + " ping should return a valid date", pingDate != null);
// other invalid dates will be thrown as IOExceptions cast to ServiceFailures
assertTrue(callAdapter.getLatestRequestUrl()
+ " returned date should be within 1 minute of time measured on test machine", pingDate.getTime()
- localNow.getTime() < 1000 * 60
&& localNow.getTime() - pingDate.getTime() > -1000 * 60);
} catch (BaseException e) {
fail(callAdapter.getLatestRequestUrl() + " " + e.getClass().getSimpleName() + ": " + e.getDetail_code()
+ ":: " + e.getDescription());
} catch (Exception e) {
e.printStackTrace();
fail(currentUrl + " " + e.getClass().getName() + ": " + e.getMessage());
}
}
@WebTestName("ping - test Date accuracy")
@WebTestDescription("this test checks that the returned date is within 1 minute of the date on the client machine")
public void testPing_AccurateDate(Iterator<Node> nodeIterator, String version) {
while (nodeIterator.hasNext())
testPing(nodeIterator.next(), version);
}
public void testPing_AccurateDate(Node node, String version) {
ContextAwareTestCaseDataone.setupClientSubject_NoCert();
CommonCallAdapter callAdapter = new CommonCallAdapter(getSession(Constants.SUBJECT_PUBLIC), node, version);
String currentUrl = callAdapter.getNodeBaseServiceUrl();
try {
// Assume.assumeTrue(APITestUtils.isTierImplemented(mn, "Tier5"));
Date localNow = new Date();
Date pingDate = callAdapter.ping();
assertTrue(callAdapter.getLatestRequestUrl()
+ " returned date should be within 1 minute of time measured on test machine", pingDate.getTime()
- localNow.getTime() < 1000 * 60
&& localNow.getTime() - pingDate.getTime() > -1000 * 60);
} catch (BaseException e) {
fail(callAdapter.getLatestRequestUrl() + " " + e.getClass().getSimpleName() + ": " + e.getDetail_code()
+ ":: " + e.getDescription());
} catch (Exception e) {
e.printStackTrace();
fail(currentUrl + " " + e.getClass().getName() + ": " + e.getMessage());
}
}
@WebTestName("getCapabilities - test that a Node document is returned")
@WebTestDescription("tests that the getCapabilities() call returns a result of type Node")
public void testGetCapabilities(Iterator<Node> nodeIterator, String version) {
while (nodeIterator.hasNext())
testGetCapabilities(nodeIterator.next(), version);
}
public void testGetCapabilities(Node node, String version) {
CommonCallAdapter callAdapter = new CommonCallAdapter(getSession(Constants.SUBJECT_PUBLIC), node, version);
String currentUrl = node.getBaseURL();
printTestHeader("testGetCapabilities() vs. node: " + currentUrl);
currentUrl = callAdapter.getNodeBaseServiceUrl();
try {
Node capabilitiesNode = callAdapter.getCapabilities();
checkTrue(callAdapter.getLatestRequestUrl(), "getCapabilities returns a Node", capabilitiesNode != null);
} catch (BaseException e) {
handleFail(callAdapter.getLatestRequestUrl(),
e.getClass().getSimpleName() + ": " + e.getDetail_code() + ":: " + e.getDescription());
} catch (Exception e) {
e.printStackTrace();
handleFail(currentUrl, e.getClass().getName() + ": " + e.getMessage());
}
}
@WebTestName("getCapabilities - contactSubject value is valid")
@WebTestDescription("tests that at least one contactSubject element is populated with a RFC2253 compliant Subject value.")
public void testGetCapabilities_HasCompatibleNodeContact(Iterator<Node> nodeIterator, String version) {
while (nodeIterator.hasNext())
testGetCapabilities_HasCompatibleNodeContact(nodeIterator.next(), version);
}
/**
* Tests that at least one of the node contacts is RFC2253 compatible,
* meaning that it could be represented by a CILogon issued certificate
*/
public void testGetCapabilities_HasCompatibleNodeContact(Node node, String version) {
CommonCallAdapter callAdapter = new CommonCallAdapter(getSession(Constants.SUBJECT_PUBLIC), node, version);
String currentUrl = node.getBaseURL();
currentUrl = callAdapter.getNodeBaseServiceUrl();
printTestHeader("testGetCapabilities() vs. node: " + currentUrl);
try {
Node capabilitiesNode = callAdapter.getCapabilities();
checkTrue(callAdapter.getLatestRequestUrl(), "getCapabilities returns a Node", capabilitiesNode != null);
List<Subject> contacts = capabilitiesNode.getContactSubjectList();
boolean found = false;
if (contacts != null) {
for (Subject s : contacts) {
try {
CertificateManager.getInstance().standardizeDN(s.getValue());
found = true;
} catch (IllegalArgumentException e) {
; // this can happen legally, but means that it is not actionable
}
}
}
checkTrue(callAdapter.getLatestRequestUrl(),
"the node should have at least one contactSubject that conforms to RFC2253.", found);
} catch (BaseException e) {
handleFail(callAdapter.getLatestRequestUrl(),
e.getClass().getSimpleName() + ": " + e.getDetail_code() + ":: " + e.getDescription());
} catch (Exception e) {
e.printStackTrace();
handleFail(currentUrl, e.getClass().getName() + ": " + e.getMessage());
}
}
@WebTestName("getCapabilities - nodeIdentity value is valid")
@WebTestDescription("tests that the nodeIdentity field follows naming rules indicated by 'urn:node:[[alpha]|_]{2,23}'")
public void testGetCapabilities_NodeIdentityValidFormat(Iterator<Node> nodeIterator, String version) {
while (nodeIterator.hasNext())
testGetCapabilities_NodeIdentityValidFormat(nodeIterator.next(), version);
}
/**
* Tests that the nodeReference of the node is in the proper urn format.
*/
public void testGetCapabilities_NodeIdentityValidFormat(Node node, String version) {
CommonCallAdapter callAdapter = new CommonCallAdapter(getSession(Constants.SUBJECT_PUBLIC), node, version);
String currentUrl = node.getBaseURL();
printTestHeader("testGetCapabilities() vs. node: " + currentUrl);
currentUrl = callAdapter.getNodeBaseServiceUrl();
try {
Node capabilitiesNode = callAdapter.getCapabilities();
checkTrue(callAdapter.getLatestRequestUrl(), "getCapabilities returns a Node", capabilitiesNode != null);
NodeReference nodeRef = capabilitiesNode.getIdentifier();
checkTrue(callAdapter.getLatestRequestUrl(),
"the node identifier should conform to specification 'urn:node:[\\w_]{2,23}'", nodeRef.getValue()
.matches("^urn:node:[\\w_]{2,23}"));
} catch (BaseException e) {
handleFail(callAdapter.getLatestRequestUrl(),
e.getClass().getSimpleName() + ": " + e.getDetail_code() + ":: " + e.getDescription());
} catch (Exception e) {
e.printStackTrace();
handleFail(currentUrl, e.getClass().getName() + ": " + e.getMessage());
}
}
/**
* Tests that getLogRecords() implements access restrictions properly, testing
* the negative case - where client is not a CN and is public.
* Runs tests across all nodes in the given nodeIterator.
*
* @param nodeIterator
* an {@link Iterator} accross MN or CN {@link Node}s
* @param version
* either "v1" or "v2", to match the API version being tested
*/
@WebTestName("getLogRecords - enforces access restrictions")
@WebTestDescription("this test works by testing the negative case where the client is not"
+ " a CN making the call, but is anonymous")
public void testGetLogRecords_AccessRestriction(Iterator<Node> nodeIterator, String version) {
while (nodeIterator.hasNext())
testGetLogRecords_AccessRestriction(nodeIterator.next(), version);
}
/**
* Tests that getLogRecords() implements access restriction properly, testing
* the negative case - where client is not a CN and is public.
*/
public void testGetLogRecords_AccessRestriction(Node node, String version) {
Settings.getConfiguration().setProperty("D1Client.D1Node.getLogRecords.timeout", "60000");
CommonCallAdapter callAdapter = new CommonCallAdapter(getSession(Constants.SUBJECT_PUBLIC), node, version);
String currentUrl = node.getBaseURL();
printTestHeader("testGetLogRecords_AccessRestriction(...) vs. node: " + currentUrl);
currentUrl = callAdapter.getNodeBaseServiceUrl();
try {
Log eventLog = callAdapter.getLogRecords(null, null, null, null, null, null, null);
checkTrue(callAdapter.getLatestRequestUrl(), "getLogRecords without a client certificate"
+ "should return a Log datatype or NotAuthorized", eventLog != null);
//check that the identifiers in the log entries are all public read
if (eventLog.getLogEntryList().size() > 0) {
LogEntry currentEntry = null;
try {
for (LogEntry le : eventLog.getLogEntryList()) {
currentEntry = le;
try {
callAdapter.describe(null, le.getIdentifier());
} catch (NotFound e) {
; // a semi-valid repsonse. Sometimes logged objects have been deleted.
}
}
} catch (NotAuthorized e) {
handleFail(
callAdapter.getLatestRequestUrl(),
String.format("The returned log should not contain log entries which "
+ "are not publicly available. Got entry %s for identifier %s",
currentEntry.getEntryId(), currentEntry.getIdentifier().getValue()));
}
}
} catch (NotAuthorized e) {
; // a valid response, where access is restricted to CNs
}
catch (BaseException e) {
handleFail(callAdapter.getLatestRequestUrl(), e.getClass().getSimpleName() + ": " + e.getDetail_code()
+ ": " + e.getDescription());
} catch (Exception e) {
e.printStackTrace();
handleFail(currentUrl, e.getClass().getName() + ": " + e.getMessage());
}
}
/**
* Tests that getLogRecords() returns Log object, using the simplest case: no parameters.
* Also tests with all parameters are set. Passes the tests by returning a Log object.
* Runs tests across all nodes in the given nodeIterator.
*
* @param nodeIterator
* an {@link Iterator} accross MN or CN {@link Node}s
* @param version
* either "v1" or "v2", to match the API version being tested
*/
@WebTestName("getLogRecords - test no parameter and every-parameter cases")
@WebTestDescription("test that a Log object is returned, calling with the STAGE CN certificate.")
public void testGetLogRecords(Iterator<Node> nodeIterator, String version) {
while (nodeIterator.hasNext())
testGetLogRecords(nodeIterator.next(), version);
}
/**
* Tests that getLogRecords() returns Log object, using the simplest case: no parameters.
* Also tests with all parameters are set. Passes the tests by returning a Log object.
*/
public void testGetLogRecords(Node node, String version) {
//TODO: change to use a testCNAdmin certificate
Settings.getConfiguration().setProperty("D1Client.D1Node.getLogRecords.timeout", "60000");
String cnSubject = Settings.getConfiguration().getString("dataone.it.cnode.submitter.cn",
"cnDevUNM1");
CommonCallAdapter callAdapter = new CommonCallAdapter(getSession(cnSubject), node, version);
String currentUrl = node.getBaseURL();
printTestHeader("testGetLogRecords(...) vs. node: " + currentUrl);
currentUrl = callAdapter.getNodeBaseServiceUrl();
try {
Log eventLog = callAdapter.getLogRecords(null, null, null, null, null, null, null);
checkTrue(callAdapter.getLatestRequestUrl(), "getLogRecords should return a log datatype", eventLog != null);
Date fromDate = new Date();
Thread.sleep(1000);
Date toDate = new Date();
eventLog = callAdapter.getLogRecords(null, fromDate, toDate, Event.READ.toString(), "pidFilter", 0, 10);
checkTrue(callAdapter.getLatestRequestUrl(), "getLogRecords(<parameters>) returns a Log", eventLog != null);
} catch (NotAuthorized e) {
handleFail(
callAdapter.getLatestRequestUrl(),
"Should not get a NotAuthorized when connecting"
+ "with a cn admin subject . Check NodeList and MN configuration. Msg details:"
+ e.getDetail_code() + ": " + e.getDescription());
} catch (BaseException e) {
handleFail(callAdapter.getLatestRequestUrl(),
e.getClass().getSimpleName() + ": " + e.getDetail_code() + ": " + e.getDescription());
} catch (Exception e) {
e.printStackTrace();
handleFail(currentUrl, e.getClass().getName() + ": " + e.getMessage());
}
}
@WebTestName("getLogRecords - test list slicing behavior")
@WebTestDescription("performs heuristic tests that count and total parameters are correct,"
+ " and that the caller can limit the number of items returned using the count parameter.")
public void testGetLogRecords_Slicing(Iterator<Node> nodeIterator, String version) {
while (nodeIterator.hasNext())
testGetLogRecords_Slicing(nodeIterator.next(), version);
}
/**
* Tests that count and start parameters are functioning, and getCount() and getTotal()
* are reasonable values.
*/
public void testGetLogRecords_Slicing(Node node, String version) {
Settings.getConfiguration().setProperty("D1Client.D1Node.getLogRecords.timeout", "60000");
// TODO: change to testCnAdmin subject when obtained
String cnSubject = Settings.getConfiguration().getString("dataone.it.cnode.submitter.cn",
"cnDevUNM1");
CommonCallAdapter callAdapter = new CommonCallAdapter(getSession(cnSubject), node, version);
String currentUrl = node.getBaseURL();
printTestHeader("testGetLogRecords_Slicing(...) vs. node: " + currentUrl);
currentUrl = callAdapter.getNodeBaseServiceUrl();
try {
Log eventLog = callAdapter.getLogRecords(null, null, null, null, null, null, null);
StringBuffer sb = new StringBuffer();
int i = 0;
if (eventLog.getCount() != eventLog.sizeLogEntryList())
sb.append(++i + ". 'count' attribute should equal the number of LogEntry objects returned. \n");
if (eventLog.getTotal() < eventLog.getCount())
sb.append(++i + ". 'total' attribute should be >= the 'count' attribute in the returned Log. \n");
if (eventLog.getTotal() < eventLog.sizeLogEntryList())
sb.append(++i + "'total' attribute should be >= the number of LogEntry objects returned. \n");
// test that one can limit the count
int halfCount = eventLog.sizeLogEntryList() / 2; // rounds down
eventLog = callAdapter.getLogRecords(null, null, null, null, null, 0, halfCount);
if (eventLog.sizeLogEntryList() != halfCount)
sb.append(++i
+ ". should be able to limit the number of returned LogEntry objects using 'count' parameter.");
// TODO: test that 'start' parameter does what it says
// TODO: paging test
if (i > 0) {
handleFail(callAdapter.getLatestRequestUrl(), "Slicing errors:\n" + sb.toString());
}
} catch (NotAuthorized e) {
handleFail(
callAdapter.getLatestRequestUrl(),
"Should not get a NotAuthorized when connecting"
+ "with a cn admin subject . Check NodeList and MN configuration. Msg details:"
+ e.getDetail_code() + ": " + e.getDescription());
} catch (BaseException e) {
handleFail(callAdapter.getLatestRequestUrl(),
e.getClass().getSimpleName() + ": " + e.getDetail_code() + ": " + e.getDescription());
} catch (Exception e) {
e.printStackTrace();
handleFail(currentUrl, e.getClass().getName() + ": " + e.getMessage());
}
}
@WebTestName("getLogRecords - test event filtering")
@WebTestDescription("Tier 1 MNs might only have READ events, so the test gets the log records from "
+ "a given period and if only one type of event, filters for a different one and "
+ "expect zero of them returned. If 2 types, just expect fewer records from within"
+ "that time period. ")
public void testGetLogRecords_eventFiltering(Iterator<Node> nodeIterator, String version) {
while (nodeIterator.hasNext())
testGetLogRecords_eventFiltering(nodeIterator.next(), version);
}
/**
* Tier 1 MNs might only have READ events, so will get the log records from
* a given period and if only one type, filter for a different one an expect
* zero returned. If 2 types, just expect fewer records.
* Must be careful to check that all the records requested are returned.
*/
public void testGetLogRecords_eventFiltering(Node node, String version) {
Settings.getConfiguration().setProperty("D1Client.D1Node.getLogRecords.timeout", "60000");
// TODO: change to testCnAdmin subject when obtained
String cnSubject = Settings.getConfiguration().getString("dataone.it.cnode.submitter.cn",
"cnDevUNM1");
CommonCallAdapter callAdapter = new CommonCallAdapter(getSession(cnSubject), node, version);
String currentUrl = node.getBaseURL();
printTestHeader("testGetLogRecords_eventFiltering() vs. node: " + currentUrl);
currentUrl = callAdapter.getNodeBaseServiceUrl();
try {
Date toDate = new Date();
// using the paged-implementation to make sure we get them all.
Log entries = APITestUtils.pagedGetLogRecords(callAdapter, null, toDate, null, null, null, null);
if (entries.getCount() == 0) {
// try to create a log event
// if it can't it will throw a TestIterationEndingException
Identifier pid = this.catc.procurePublicReadableTestObject(callAdapter, null);
callAdapter.get(null, pid);
toDate = callAdapter.ping();
entries = APITestUtils.pagedGetLogRecords(callAdapter, null, toDate, null, null, null, null);
}
String targetType = entries.getLogEntry(0).getEvent();
String otherType = null;
List<LogEntry> logEntryList = entries.getLogEntryList();
if(logEntryList == null || logEntryList.size() == 0)
handleFail(callAdapter.getLatestRequestUrl(), "After successfully reading an object, should "
+ "have at least one log record. Got zero");
for (LogEntry le : logEntryList) {
if (!le.getEvent().equals(targetType)) {
otherType = le.getEvent();
break;
}
}
if (otherType == null) {
if (targetType.equals(Event.READ)) {
entries = callAdapter.getLogRecords(null, null, toDate, Event.CREATE.xmlValue(), null, 0, 0);
checkEquals(callAdapter.getLatestRequestUrl(), "Log contains only READ events, "
+ "so should get 0 CREATE events", String.valueOf(entries.getTotal()), "0");
} else {
entries = callAdapter.getLogRecords(null, null, toDate, Event.READ.xmlValue(), null, 0, 0);
checkEquals(callAdapter.getLatestRequestUrl(), "Log contains only " + targetType + " events, "
+ "so should get 0 READ events", String.valueOf(entries.getTotal()), "0");
}
} else {
entries = APITestUtils.pagedGetLogRecords(callAdapter, null, toDate, targetType, null, null, null);
boolean oneTypeOnly = true;
String unfilteredType = null;
for (LogEntry le : entries.getLogEntryList()) {
if (!le.getEvent().equals(targetType)) {
oneTypeOnly = false;
unfilteredType = le.getEvent();
break;
}
}
checkTrue(callAdapter.getLatestRequestUrl(), "Filtered log for the time period should contain only "
+ "logs of type " + targetType + ". Got " + unfilteredType, oneTypeOnly);
}
} catch (NotAuthorized e) {
handleFail(
callAdapter.getLatestRequestUrl(),
"Should not get a NotAuthorized when connecting"
+ "with a cn admin subject . Check NodeList and MN configuration. Msg details:"
+ e.getDetail_code() + ": " + e.getDescription());
} catch (BaseException e) {
handleFail(callAdapter.getLatestRequestUrl(),
e.getClass().getSimpleName() + ": " + e.getDetail_code() + ": " + e.getDescription());
} catch (Exception e) {
e.printStackTrace();
handleFail(currentUrl, e.getClass().getName() + ": " + e.getMessage());
}
}
@WebTestName("getLogRecords - test PID filtering")
@WebTestDescription("Test that pidFilter only returns objects with the given Identifier string "
+ "The test attepmpts to find a negative case and to make sure it is filtered out when the"
+ "filter is applied.")
public void testGetLogRecords_pidFiltering(Iterator<Node> nodeIterator, String version){
while (nodeIterator.hasNext())
testGetLogRecords_pidFiltering(nodeIterator.next(), version);
}
public void testGetLogRecords_pidFiltering(Node node, String version) {
Settings.getConfiguration().setProperty("D1Client.D1Node.getLogRecords.timeout", "60000");
// TODO: change to testCnAdmin subject when obtained
String cnSubject = Settings.getConfiguration().getString("dataone.it.cnode.submitter.cn",
"cnDevUNM1");
CommonCallAdapter callAdapter = new CommonCallAdapter(getSession(cnSubject), node, version);
String currentUrl = node.getBaseURL();
currentUrl = callAdapter.getNodeBaseServiceUrl();
printTestHeader("testGetLogRecords_pidFiltering() vs. node: " + currentUrl);
try {
// Log entries = APITestUtils.pagedGetLogRecords(callAdapter, null, toDate, null, null, null, null);
Log entries = callAdapter.getLogRecords(null, null, null, null, null, null, null);
// if no entries in log, create one
InputStream is = null;
if (entries.getTotal() == 0)
try {
// try to create a log event
// if it can't it will throw a TestIterationEndingException
Identifier pid = this.catc.procurePublicReadableTestObject(callAdapter, null);
is = callAdapter.get(null, pid);
// entries = APITestUtils.pagedGetLogRecords(callAdapter, null, toDate, null, null, null, null);
entries = callAdapter.getLogRecords(null, null, null, null, null, null, null);
} finally {
IOUtils.closeQuietly(is);
}
// should have at least one log entry at this point
if (entries.sizeLogEntryList() > 0) {
// grab 2 identifiers
Identifier targetIdentifier = entries.getLogEntry(0).getIdentifier();
Identifier otherIdentifier = null;
for (LogEntry le : entries.getLogEntryList()) {
if (!le.getIdentifier().equals(targetIdentifier)) {
otherIdentifier = le.getIdentifier();
break;
}
}
if (otherIdentifier == null) {
// no second Identifier available...
// create a new fake targetIdentifier
// filtering on this should yield 0 results
otherIdentifier = targetIdentifier;
targetIdentifier = D1TypeBuilder
.buildIdentifier(targetIdentifier.getValue() + new Date().getTime());
entries = callAdapter.getLogRecords(null, null, null, null, targetIdentifier.getValue(), 0, 0);
checkEquals(callAdapter.getLatestRequestUrl(), "Log should be empty for the derived identifier pattern "
+ targetIdentifier.getValue(), String.valueOf(entries.getTotal()), "0");
} else {
// if there is a second Identifier available
entries = callAdapter.getLogRecords(null, null, null, null, targetIdentifier.getValue(), null, null);
boolean oneTypeOnly = true;
if (entries.sizeLogEntryList() > 0) {
for (LogEntry le : entries.getLogEntryList()) {
if (!le.getIdentifier().equals(targetIdentifier)) {
oneTypeOnly = false;
break;
}
}
// checkTrue(mn.getLatestRequestUrl(), "Filtered log for the time period should " +
// "contain only entries for the target identifier: " + targetIdentifier.getValue(),
// oneTypeOnly);
checkTrue(callAdapter.getLatestRequestUrl(),
"The optional pidFilter parameter is not filtering log records. "
+ "The log would otherwise contain only entries for the target identifier: "
+ targetIdentifier.getValue(), oneTypeOnly);
} else {
handleFail(callAdapter.getLatestRequestUrl(),
"should still get a LogEntry when applying 'pidFilter' parameter");
}
}
} else {
handleFail(callAdapter.getLatestRequestUrl(), "After successfully reading an object, should "
+ "have at least one log record. Got zero");
}
} catch (NotAuthorized e) {
handleFail(
callAdapter.getLatestRequestUrl(),
"Should not get a NotAuthorized when connecting"
+ "with a cn admin subject . Check NodeList and MN configuration. Msg details:"
+ e.getDetail_code() + ": " + e.getDescription());
} catch (BaseException e) {
handleFail(callAdapter.getLatestRequestUrl(),
e.getClass().getSimpleName() + ": " + e.getDetail_code() + ": " + e.getDescription());
} catch (Exception e) {
e.printStackTrace();
handleFail(currentUrl, e.getClass().getName() + ": " + e.getMessage());
}
}
@WebTestName("getLogRecords - date filtering")
@WebTestDescription("Test that the fromDate parameter works and excludes log records occurring before it.")
public void testGetLogRecords_dateFiltering(Iterator<Node> nodeIterator, String version) {
while (nodeIterator.hasNext())
testGetLogRecords_dateFiltering(nodeIterator.next(), version);
}
public void testGetLogRecords_dateFiltering(Node node, String version) {
Settings.getConfiguration().setProperty("D1Client.D1Node.getLogRecords.timeout", "60000");
// TODO: change to testCnAdmin subject when obtained
String cnSubject = Settings.getConfiguration().getString("dataone.it.cnode.submitter.cn",
"cnDevUNM1");
CommonCallAdapter callAdapter = new CommonCallAdapter(getSession(cnSubject), node, version);
String currentUrl = node.getBaseURL();
printTestHeader("testGetLogRecords_DateFiltering(...) vs. node: " + currentUrl);
currentUrl = callAdapter.getNodeBaseServiceUrl();
try {
Log eventLog = callAdapter.getLogRecords(null, null, null, null, null, null, null);
if (eventLog.getLogEntryList() == null || eventLog.getLogEntryList().size() == 0) {
// read an existing object
InputStream is = null;
String objectIdentifier = null;
try {
objectIdentifier = "TierTesting:" + this.catc.createNodeAbbreviation(callAdapter.getNodeBaseServiceUrl())
+ ":Public_READ" + this.catc.getTestObjectSeriesSuffix();
Identifier id = this.catc.procurePublicReadableTestObject(callAdapter, D1TypeBuilder.buildIdentifier(objectIdentifier));
is = callAdapter.get(null, id);
is.close();
Thread.sleep(2000); // just in case...
eventLog = callAdapter.getLogRecords(null, null, null, null, null, null, null);
} catch (TestIterationEndingException e) {
log.error("Unable to create a log record for " + objectIdentifier, e);
} finally {
IOUtils.closeQuietly(is);
}
}
if (eventLog.getLogEntryList() == null || eventLog.getLogEntryList().size() == 0) {
// still zero? something's probably wrong
handleFail(callAdapter.getLatestRequestUrl(), "the event log contains no entries after trying to read an object");
} else {
// try to find log entries with different dates, should be quick...
LogEntry entry0 = eventLog.getLogEntry(0);
Date fromDate = null;
LogEntry excludedEntry = null;
for (LogEntry le : eventLog.getLogEntryList()) {
if (!le.getDateLogged().equals(entry0.getDateLogged())) {
// which is earlier? can't assume chronological order of the list
if (le.getDateLogged().after(entry0.getDateLogged())) {
fromDate = le.getDateLogged();
excludedEntry = entry0;
} else {
fromDate = entry0.getDateLogged();
excludedEntry = le;
}
break;
}
}
if (excludedEntry == null) {
handleFail(callAdapter.getLatestRequestUrl(), "could not find 2 objects with different dateLogged times");
} else {
// call with a fromDate
eventLog = callAdapter.getLogRecords(null, fromDate, null, null, null, null, null);
for (LogEntry le : eventLog.getLogEntryList()) {
if (le.getEntryId().equals(excludedEntry.getEntryId())) {
handleFail(callAdapter.getLatestRequestUrl(), "entryID " + excludedEntry.getEntryId() + " at "
+ excludedEntry.getDateLogged()
+ " should not be in the event log where fromDate set to " + fromDate);
break;
}
}
}
}
} catch (NotAuthorized e) {
handleFail(
callAdapter.getLatestRequestUrl(),
"Should not get a NotAuthorized when connecting"
+ "with a cn admin subject . Check NodeList and MN configuration. Msg details:"
+ e.getDetail_code() + ": " + e.getDescription());
} catch (BaseException e) {
handleFail(callAdapter.getLatestRequestUrl(),
e.getClass().getSimpleName() + " : " + e.getDetail_code() + " : " + e.getDescription());
} catch (Exception e) {
e.printStackTrace();
handleFail(callAdapter.getLatestRequestUrl(), e.getClass().getSimpleName() + " : " + e.getMessage());
}
}
}