package org.exist.xquery;
import org.exist.EXistException;
import org.exist.collections.Collection;
import org.exist.collections.IndexInfo;
import org.exist.collections.triggers.TriggerException;
import org.exist.dom.persistent.DocumentImpl;
import org.exist.security.PermissionDeniedException;
import org.exist.source.StringSource;
import org.exist.storage.BrokerPool;
import org.exist.storage.DBBroker;
import org.exist.storage.lock.Lock.LockMode;
import org.exist.storage.serializers.Serializer;
import org.exist.storage.txn.TransactionException;
import org.exist.storage.txn.TransactionManager;
import org.exist.storage.txn.Txn;
import org.exist.test.ExistEmbeddedServer;
import org.exist.test.TestConstants;
import org.exist.util.DatabaseConfigurationException;
import org.exist.util.LockException;
import org.exist.xmldb.XmldbURI;
import org.exist.xquery.value.Sequence;
import org.exist.util.serializer.SAXSerializer;
import org.exist.util.serializer.SerializerPool;
import org.junit.After;
import org.junit.Test;
import org.xml.sax.InputSource;
import java.io.IOException;
import java.io.StringReader;
import java.io.StringWriter;
import java.util.Optional;
import java.util.Properties;
import javax.xml.transform.OutputKeys;
import org.xml.sax.SAXException;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
/**
* Tests for recovery of database corruption after constructed node operations (in-memory nodes)
* @author Adam Retter <adam.retter@devon.gov.uk>
*/
public class ConstructedNodesRecoveryTest {
private final static String xquery =
"declare variable $categories := \n" +
" <categories>\n" +
" <category uid=\"1\">Fruit</category>\n" +
" <category uid=\"2\">Vegetable</category>\n" +
" <category uid=\"3\">Meat</category>\n" +
" <category uid=\"4\">Dairy</category>\n" +
" </categories>\n" +
";\n\n" +
"for $category in $categories/category return\n" +
" element option {\n" +
" attribute value {\n" +
" $category/@uid\n" +
" },\n" +
" text { $category }\n" +
" }";
private final static String expectedResults [] = {
"Fruit",
"Vegetable",
"Meat",
"Dairy"
};
private final static String testDocument =
"<fruit>" +
"<apple colour=\"green\"/>" +
"<pear colour=\"green\"/>" +
"<orange colour=\"orange\"/>" +
"<dragonfruit colour=\"pink\"/>" +
"<grapefruit colour=\"yellow\"/>" +
"</fruit>";
// we don't use @ClassRule/@Rule as we want to force corruption in some tests
private ExistEmbeddedServer existEmbeddedServer = new ExistEmbeddedServer(true, false);
/**
* Issues a query against constructed nodes and then corrupts the database (intentionally)
*/
@Test
public void constructedNodesCorrupt() throws PermissionDeniedException, DatabaseConfigurationException, LockException, IOException, SAXException, XPathException, EXistException {
constructedNodeQuery(true);
}
/**
* Recovers from corruption (intentional) and then issues a query against constructed nodes
*/
@Test
public void constructedNodesRecover() throws PermissionDeniedException, DatabaseConfigurationException, LockException, IOException, SAXException, XPathException, EXistException {
constructedNodeQuery(false);
}
private void storeTestDocument(DBBroker broker, TransactionManager transact, String documentName) throws PermissionDeniedException, IOException, SAXException, LockException, EXistException {
//create a transaction
try(final Txn transaction = transact.beginTransaction()) {
//get the test collection
Collection root = broker.getOrCreateCollection(transaction, TestConstants.TEST_COLLECTION_URI);
assertNotNull(root);
broker.saveCollection(transaction, root);
//store test document
IndexInfo info = root.validateXMLResource(transaction, broker, XmldbURI.create(documentName), testDocument);
assertNotNull(info);
root.store(transaction, broker, info, new InputSource(new StringReader(testDocument)));
//commit the transaction
transact.commit(transaction);
}
}
private void createTempChildCollection(DBBroker broker, TransactionManager transact, String childCollectionName) throws PermissionDeniedException, IOException, TriggerException, TransactionException {
//create a transaction
try(final Txn transaction = transact.beginTransaction()) {
//get the test collection
Collection root = broker.getOrCreateCollection(transaction, XmldbURI.TEMP_COLLECTION_URI.append(childCollectionName));
assertNotNull(root);
broker.saveCollection(transaction, root);
//commit the transaction
transact.commit(transaction);
}
}
private void testDocumentIsValid(DBBroker broker, TransactionManager transact, String documentName) throws PermissionDeniedException, IOException, SAXException, LockException, TransactionException {
//create a transaction
try(final Txn transaction = transact.beginTransaction()) {
//get the test collection
Collection root = broker.getOrCreateCollection(transaction, TestConstants.TEST_COLLECTION_URI);
assertNotNull(root);
broker.saveCollection(transaction, root);
//get the test document
DocumentImpl doc = root.getDocumentWithLock(broker, XmldbURI.create(documentName), LockMode.READ_LOCK);
Serializer serializer = broker.getSerializer();
serializer.reset();
SAXSerializer sax = null;
StringWriter writer = new StringWriter();
sax = (SAXSerializer) SerializerPool.getInstance().borrowObject(SAXSerializer.class);
Properties outputProperties = new Properties();
outputProperties.setProperty(OutputKeys.INDENT, "no");
outputProperties.setProperty(OutputKeys.ENCODING, "UTF-8");
sax.setOutput(writer, outputProperties);
serializer.setProperties(outputProperties);
serializer.setSAXHandlers(sax, sax);
serializer.toSAX(doc);
SerializerPool.getInstance().returnObject(sax);
assertEquals(testDocument, writer.toString());
transact.commit(transaction);
}
}
private void testTempChildCollectionExists(DBBroker broker, TransactionManager transact, String childCollectionName) throws PermissionDeniedException, IOException, TriggerException, TransactionException {
//create a transaction
try(final Txn transaction = transact.beginTransaction()) {
//get the temp child collection
Collection tempChildCollection = broker.getOrCreateCollection(transaction, XmldbURI.TEMP_COLLECTION_URI.append(childCollectionName));
assertNotNull(tempChildCollection);
broker.saveCollection(transaction, tempChildCollection);
transact.commit(transaction);
}
}
/**
* Performs a query against constructed nodes, with the option of forcefully corrupting the database
*
* @param forceCorruption Should the database be forcefully corrupted
*/
private void constructedNodeQuery(boolean forceCorruption) throws EXistException, DatabaseConfigurationException, LockException, SAXException, PermissionDeniedException, IOException, XPathException {
BrokerPool.FORCE_CORRUPTION = forceCorruption;
BrokerPool pool = startDb();
try(final DBBroker broker = pool.get(Optional.of(pool.getSecurityManager().getSystemSubject()))) {
TransactionManager transact = pool.getTransactionManager();
assertNotNull(transact);
//only store the documents the first time
if(forceCorruption)
{
//store a first test document
storeTestDocument(broker, transact, "testcr1.xml");
//store a second test document
storeTestDocument(broker, transact, "testcr2.xml");
}
//create some child collections in TEMP collection
createTempChildCollection(broker, transact, "testchild1");
createTempChildCollection(broker, transact, "testchild2");
//execute an xquery
XQuery service = pool.getXQueryService();
assertNotNull(service);
CompiledXQuery compiled = service.compile(broker, new XQueryContext(pool), new StringSource(xquery));
assertNotNull(compiled);
Sequence result = service.execute(broker, compiled, null);
assertNotNull(result);
assertEquals(expectedResults.length, result.getItemCount());
for(int i = 0; i < result.getItemCount(); i++)
{
assertEquals(expectedResults[i], (String)result.itemAt(i).getStringValue());
}
//read the first test document
testDocumentIsValid(broker, transact, "testcr1.xml");
//read the second test document
testDocumentIsValid(broker, transact, "testcr1.xml");
//test the child collections exist
testTempChildCollectionExists(broker, transact, "testchild1");
testTempChildCollectionExists(broker, transact, "testchild2");
pool.getJournalManager().get().flush(true, false);
}
}
private BrokerPool startDb() throws EXistException, IOException, DatabaseConfigurationException {
existEmbeddedServer.startDb();
return existEmbeddedServer.getBrokerPool();
}
@After
public void stopDb() {
existEmbeddedServer.stopDb();
}
}