TransactionContextTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIESOR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.aries.tx.control.service.xa.impl;

import static org.apache.aries.tx.control.service.xa.impl.LocalResourceSupport.DISABLED;
import static org.apache.aries.tx.control.service.xa.impl.LocalResourceSupport.ENABLED;
import static org.apache.aries.tx.control.service.xa.impl.LocalResourceSupport.ENFORCE_SINGLE;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import static org.osgi.service.transaction.control.TransactionStatus.ACTIVE;
import static org.osgi.service.transaction.control.TransactionStatus.COMMITTED;
import static org.osgi.service.transaction.control.TransactionStatus.COMMITTING;
import static org.osgi.service.transaction.control.TransactionStatus.MARKED_ROLLBACK;
import static org.osgi.service.transaction.control.TransactionStatus.ROLLED_BACK;
import static org.osgi.service.transaction.control.TransactionStatus.ROLLING_BACK;

import java.util.concurrent.atomic.AtomicInteger;

import javax.transaction.xa.XAException;
import javax.transaction.xa.XAResource;
import javax.transaction.xa.Xid;

import org.apache.aries.tx.control.service.common.impl.AbstractTransactionContextImpl;
import org.apache.geronimo.transaction.manager.RecoveryWorkAroundTransactionManager;
import org.apache.geronimo.transaction.manager.XidFactoryImpl;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.ArgumentCaptor;
import org.mockito.InOrder;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.runners.MockitoJUnitRunner;
import org.osgi.service.transaction.control.LocalResource;
import org.osgi.service.transaction.control.TransactionException;

@RunWith(MockitoJUnitRunner.class)
public class TransactionContextTest {

	@Mock
	XAResource xaResource;
	@Mock
	LocalResource localResource;
	
	AbstractTransactionContextImpl ctx;
	
	@Before
	public void setUp() throws XAException {
		ctx = new TransactionContextImpl(getTxMgr(), false, ENFORCE_SINGLE);
	}

	private RecoveryWorkAroundTransactionManager getTxMgr() throws XAException {
		return new RecoveryWorkAroundTransactionManager(30, new XidFactoryImpl(), null);
	}
	
	@Test
	public void testGetRollbackOnly() {
		assertFalse(ctx.getRollbackOnly());
	}

	@Test
	public void testSetRollbackOnly() {
		ctx.setRollbackOnly();
		assertTrue(ctx.getRollbackOnly());
	}
	
	@Test
	public void testisReadOnlyFalse() {
		assertFalse(ctx.isReadOnly());
	}

	@Test
	public void testisReadOnlyTrue() throws XAException {
		ctx = new TransactionContextImpl(getTxMgr(), true, ENFORCE_SINGLE);
		assertTrue(ctx.isReadOnly());
	}


	@Test
	public void testTransactionKey() {
		assertNotNull(ctx.getTransactionKey());
	}
	
	@Test
	public void testTransactionStatus() {
		assertEquals(ACTIVE, ctx.getTransactionStatus());
		
		ctx.setRollbackOnly();
		
		assertEquals(MARKED_ROLLBACK, ctx.getTransactionStatus());
	}

	@Test
	public void testLocalResourceSupport() {
		assertTrue(ctx.supportsLocal());
	}

	@Test
	public void testLocalResourceSupportEnabled() throws XAException {
		ctx = new TransactionContextImpl(getTxMgr(), true, ENABLED);
		assertTrue(ctx.supportsLocal());
	}

	@Test
	public void testLocalResourceSupportDisabled() throws XAException {
		ctx = new TransactionContextImpl(getTxMgr(), true, DISABLED);
		assertFalse(ctx.supportsLocal());
	}

	@Test
	public void testXAResourceSupport() {
		assertTrue(ctx.supportsXA());
	}

	@Test
	public void testXAResourceRegistration() {
		ctx.registerXAResource(xaResource, null);
	}

	@Test
	public void testRecoverableXAResourceRegistration() {
		ctx.registerXAResource(xaResource, "anId");
	}

	@Test
	public void testScopedValues() {
		assertNull(ctx.getScopedValue("foo"));
		
		Object value = new Object();
		
		ctx.putScopedValue("foo", value);
		
		assertSame(value, ctx.getScopedValue("foo"));
	}
	
	@Test
	public void testPreCompletion() throws Exception {
		
		AtomicInteger value = new AtomicInteger(0);
		
		ctx.preCompletion(() -> {
			assertEquals(ACTIVE, ctx.getTransactionStatus());
			value.compareAndSet(1, 5);
		});
		
		assertEquals(0, value.getAndSet(1));
		
		ctx.finish();
		
		assertEquals(5, value.get());
	}

	@Test
	public void testPreCompletionFail() throws Exception {
		
		AtomicInteger value = new AtomicInteger(0);
		
		ctx.preCompletion(() -> {
			assertEquals(MARKED_ROLLBACK, ctx.getTransactionStatus());
			value.compareAndSet(1, 5);
		});
		
		assertEquals(0, value.getAndSet(1));
		
		
		ctx.setRollbackOnly();
		
		ctx.finish();

		assertEquals(5, value.get());
	}

	@Test
	public void testPostCompletion() throws Exception {
		
		AtomicInteger value = new AtomicInteger(0);
		
		ctx.postCompletion(status -> {
				assertEquals(COMMITTED, status);
				value.compareAndSet(1, 5);
			});
		
		assertEquals(0, value.getAndSet(1));
		
		ctx.finish();
		
		assertEquals(5, value.get());
	}

	@Test
	public void testPostCompletionFail() throws Exception {
		
		AtomicInteger value = new AtomicInteger(0);
		
		ctx.postCompletion(status -> {
			assertEquals(ROLLED_BACK, status);
			value.compareAndSet(1, 5);
		});
		
		assertEquals(0, value.getAndSet(1));
		
		ctx.setRollbackOnly();
		
		ctx.finish();
		
		assertEquals(5, value.get());
	}

	@Test
	public void testPostCompletionIsAfterPreCompletion() throws Exception {
		
		AtomicInteger value = new AtomicInteger(0);
		
		ctx.preCompletion(() -> {
			assertEquals(ACTIVE, ctx.getTransactionStatus());
			value.compareAndSet(0, 3);
		});
		ctx.postCompletion(status -> {
			assertEquals(COMMITTED, status);
			value.compareAndSet(3, 5);
		});
		
		ctx.finish();
		
		assertEquals(5, value.get());
	}

	@Test
	public void testPostCompletionIsStillCalledAfterPreCompletionException() throws Exception {
		
		AtomicInteger value = new AtomicInteger(0);
		
		ctx.preCompletion(() -> {
				value.compareAndSet(0, 3);
				throw new RuntimeException("Boom!");
			});
		ctx.postCompletion(status -> {
			assertEquals(ROLLED_BACK, status);
			value.compareAndSet(3, 5);
		});
		
		ctx.finish();
		
		assertEquals(5, value.get());
	}

	@Test(expected=IllegalStateException.class)
	public void testPreCompletionAfterEnd() throws Exception {
		
		ctx.finish();
		
		ctx.preCompletion(() -> {});
	}

	@Test(expected=IllegalStateException.class)
	public void testPostCompletionAfterEnd() throws Exception {
		
		ctx.finish();
		
		ctx.postCompletion(x -> {});
	}

	@Test
	public void testLocalResource() throws Exception {
		ctx.registerLocalResource(localResource);
		
		Mockito.doAnswer(i -> {
			assertEquals(COMMITTING, ctx.getTransactionStatus());
			return null;
		}).when(localResource).commit();
		
		ctx.finish();
		
		Mockito.verify(localResource).commit();
	}
	
	@Test
	public void testLocalResourceRollbackOnly() throws Exception {
		ctx.registerLocalResource(localResource);
		ctx.setRollbackOnly();
		
		Mockito.doAnswer(i -> {
			assertEquals(ROLLING_BACK, ctx.getTransactionStatus());
			return null;
		}).when(localResource).rollback();
		
		ctx.finish();
		
		Mockito.verify(localResource).rollback();
	}

	@Test
	public void testLocalResourcePreCommitException() throws Exception {
		ctx.registerLocalResource(localResource);
		
		Mockito.doAnswer(i -> {
			assertEquals(ROLLING_BACK, ctx.getTransactionStatus());
			return null;
		}).when(localResource).rollback();
		
		ctx.preCompletion(() -> { throw new IllegalArgumentException(); });
		
		ctx.finish();
		
		Mockito.verify(localResource).rollback();
	}

	@Test
	public void testLocalResourcePostCommitException() throws Exception {
		ctx.registerLocalResource(localResource);
		
		Mockito.doAnswer(i -> {
			assertEquals(COMMITTING, ctx.getTransactionStatus());
			return null;
		}).when(localResource).commit();
		
		ctx.postCompletion(i -> { 
				assertEquals(COMMITTED, ctx.getTransactionStatus());
				throw new IllegalArgumentException(); 
			});
		
		ctx.finish();
		
		Mockito.verify(localResource).commit();
	}

	@Test
	public void testSecondLocalResourceCannotBeAdded() throws Exception {
		
		ctx.registerLocalResource(localResource);
		
		LocalResource localResource2 = Mockito.mock(LocalResource.class);
		try {
			ctx.registerLocalResource(localResource2);
			fail("A second local resource should trigger a failure");
		} catch (TransactionException te) {
			
		}
	}

	@Test
	public void testNoLocalResourceCanBeAddedWhenDisabled() throws Exception {
		ctx = new TransactionContextImpl(getTxMgr(), true, DISABLED);
		
		try {
			ctx.registerLocalResource(localResource);
			fail("A local resource should trigger a failure");
		} catch (TransactionException te) {
			
		}
	}
	
	@Test
	public void testMultipleLocalResourcesFirstFailsSoRollback() throws Exception {
		ctx = new TransactionContextImpl(getTxMgr(), true, ENABLED);
		
		ctx.registerLocalResource(localResource);

		LocalResource localResource2 = Mockito.mock(LocalResource.class);
		ctx.registerLocalResource(localResource2);
		
		Mockito.doAnswer(i -> {
			assertEquals(COMMITTING, ctx.getTransactionStatus());
			throw new TransactionException("Unable to commit");
		}).when(localResource).commit();

		Mockito.doAnswer(i -> {
			assertEquals(ROLLING_BACK, ctx.getTransactionStatus());
			return null;
		}).when(localResource2).rollback();
		
		ctx.finish();
		
		Mockito.verify(localResource).commit();
		Mockito.verify(localResource2).rollback();
	}
	
	@Test
	public void testSingleXAResource() throws Exception {
		ctx.registerXAResource(xaResource, null);
		
		Mockito.doAnswer(i -> {
			assertEquals(COMMITTING, ctx.getTransactionStatus());
			return null;
		}).when(xaResource).commit(Mockito.any(Xid.class), Mockito.eq(true));
		
		ctx.finish();
		
		ArgumentCaptor<Xid> captor = ArgumentCaptor.forClass(Xid.class);
		
		InOrder inOrder = Mockito.inOrder(xaResource);
		
		inOrder.verify(xaResource).start(captor.capture(), Mockito.eq(XAResource.TMNOFLAGS));
		inOrder.verify(xaResource).setTransactionTimeout(Mockito.anyInt());
		inOrder.verify(xaResource).end(Mockito.eq(captor.getValue()), Mockito.eq(XAResource.TMSUCCESS));
		inOrder.verify(xaResource).commit(Mockito.eq(captor.getValue()), Mockito.eq(true));
		
		Mockito.verifyNoMoreInteractions(xaResource);
	}

	@Test
	public void testXAResourceRollbackOnly() throws Exception {
		ctx.registerXAResource(xaResource, null);
		ctx.setRollbackOnly();
		
		Mockito.doAnswer(i -> {
			assertEquals(ROLLING_BACK, ctx.getTransactionStatus());
			return null;
		}).when(xaResource).rollback(Mockito.any(Xid.class));
		
		ctx.finish();
		
		ArgumentCaptor<Xid> captor = ArgumentCaptor.forClass(Xid.class);
		
		InOrder inOrder = Mockito.inOrder(xaResource);
		
		inOrder.verify(xaResource).start(captor.capture(), Mockito.eq(XAResource.TMNOFLAGS));
		inOrder.verify(xaResource).setTransactionTimeout(Mockito.anyInt());
		inOrder.verify(xaResource).end(Mockito.eq(captor.getValue()), Mockito.eq(XAResource.TMFAIL));
		inOrder.verify(xaResource).rollback(Mockito.eq(captor.getValue()));
		
		Mockito.verifyNoMoreInteractions(xaResource);
	}

	@Test
	public void testXAResourcePreCommitException() throws Exception {
		ctx.registerXAResource(xaResource, null);
		
		Mockito.doAnswer(i -> {
			assertEquals(ROLLING_BACK, ctx.getTransactionStatus());
			return null;
		}).when(xaResource).rollback(Mockito.any(Xid.class));
		
		ctx.preCompletion(() -> { throw new IllegalArgumentException(); });
		
		ctx.finish();
		
		ArgumentCaptor<Xid> captor = ArgumentCaptor.forClass(Xid.class);
		
		InOrder inOrder = Mockito.inOrder(xaResource);
		
		inOrder.verify(xaResource).start(captor.capture(), Mockito.eq(XAResource.TMNOFLAGS));
		inOrder.verify(xaResource).setTransactionTimeout(Mockito.anyInt());
		inOrder.verify(xaResource).end(Mockito.eq(captor.getValue()), Mockito.eq(XAResource.TMFAIL));
		inOrder.verify(xaResource).rollback(Mockito.eq(captor.getValue()));
		
		Mockito.verifyNoMoreInteractions(xaResource);
	}

	@Test
	public void testXAResourcePostCommitException() throws Exception {
		ctx.registerXAResource(xaResource, null);
		
		Mockito.doAnswer(i -> {
			assertEquals(COMMITTING, ctx.getTransactionStatus());
			return null;
		}).when(xaResource).commit(Mockito.any(Xid.class), Mockito.eq(true));
		
		ctx.postCompletion(i -> { 
			assertEquals(COMMITTED, ctx.getTransactionStatus());
			throw new IllegalArgumentException(); 
		});
		
		ctx.finish();
		
		ArgumentCaptor<Xid> captor = ArgumentCaptor.forClass(Xid.class);
		
		InOrder inOrder = Mockito.inOrder(xaResource);
		
		inOrder.verify(xaResource).start(captor.capture(), Mockito.eq(XAResource.TMNOFLAGS));
		inOrder.verify(xaResource).setTransactionTimeout(Mockito.anyInt());
		inOrder.verify(xaResource).end(Mockito.eq(captor.getValue()), Mockito.eq(XAResource.TMSUCCESS));
		inOrder.verify(xaResource).commit(Mockito.eq(captor.getValue()), Mockito.eq(true));
		
		Mockito.verifyNoMoreInteractions(xaResource);
	}

	@Test
	public void testLastParticipantSuccessSoCommit() throws Exception {
		
		ctx.registerLocalResource(localResource);
		ctx.registerXAResource(xaResource, null);
		
		Mockito.doAnswer(i -> {
			assertEquals(COMMITTING, ctx.getTransactionStatus());
			return null;
		}).when(localResource).commit();

		Mockito.doAnswer(i -> {
			assertEquals(COMMITTING, ctx.getTransactionStatus());
			return null;
		}).when(xaResource).commit(Mockito.any(Xid.class), Mockito.eq(false));
		
		ctx.finish();
		
		ArgumentCaptor<Xid> captor = ArgumentCaptor.forClass(Xid.class);
		
		InOrder inOrder = Mockito.inOrder(xaResource, localResource);
		
		inOrder.verify(xaResource).start(captor.capture(), Mockito.eq(XAResource.TMNOFLAGS));
		inOrder.verify(xaResource).setTransactionTimeout(Mockito.anyInt());
		inOrder.verify(xaResource).end(Mockito.eq(captor.getValue()), Mockito.eq(XAResource.TMSUCCESS));
		inOrder.verify(xaResource).prepare(captor.getValue());
		inOrder.verify(localResource).commit();
		inOrder.verify(xaResource).commit(Mockito.eq(captor.getValue()), Mockito.eq(false));
		
		Mockito.verifyNoMoreInteractions(xaResource, localResource);
	}

	@Test
	public void testLastParticipantFailsSoRollback() throws Exception {
		
		ctx.registerLocalResource(localResource);
		ctx.registerXAResource(xaResource, null);
		
		Mockito.doAnswer(i -> {
			assertEquals(COMMITTING, ctx.getTransactionStatus());
			throw new TransactionException("Unable to commit");
		}).when(localResource).commit();

		Mockito.doAnswer(i -> {
			assertEquals(ROLLING_BACK, ctx.getTransactionStatus());
			return null;
		}).when(xaResource).rollback(Mockito.any(Xid.class));
		
		ctx.finish();
		
		ArgumentCaptor<Xid> captor = ArgumentCaptor.forClass(Xid.class);
		
		InOrder inOrder = Mockito.inOrder(xaResource, localResource);
		
		inOrder.verify(xaResource).start(captor.capture(), Mockito.eq(XAResource.TMNOFLAGS));
		inOrder.verify(xaResource).setTransactionTimeout(Mockito.anyInt());
		inOrder.verify(xaResource).end(Mockito.eq(captor.getValue()), Mockito.eq(XAResource.TMSUCCESS));
		inOrder.verify(xaResource).prepare(captor.getValue());
		inOrder.verify(localResource).commit();
		inOrder.verify(xaResource).rollback(Mockito.eq(captor.getValue()));
		
		Mockito.verifyNoMoreInteractions(xaResource, localResource);
	}
	
}