| |
| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <HTML> |
| <HEAD> |
| <!-- $PAGETITLE --> |
| <TITLE>OpenEJB - Unit Testing Transactions</TITLE> |
| <LINK href="http://openejb.apache.org/all.css" rel="stylesheet" type="text/css"> |
| <!--[if IE]><link rel="stylesheet" type="text/css" media="screen, projection" href="openejb.apache.org/ie.css"><![endif]--> |
| |
| <LINK rel="SHORTCUT ICON" href="http://openejb.apache.org/images/favicon.ico"> |
| <META http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| </HEAD> |
| <BODY> |
| |
| <!-- Delay the loading of the external javascript file needed for labels (as it takes too long to load and visibly holds loading of the page body) --> |
| <!-- To do this without javascript errors over undefined functions, we need to declare stubs here (that are overrided later by the proper implementations) --> |
| <SCRIPT language="JavaScript" type="text/javascript"> |
| function doAddLabel(hideTextfieldAfterAddParam) |
| { |
| // stub |
| } |
| |
| function onAddLabel() |
| { |
| // stub |
| } |
| |
| function showLabelsInput() |
| { |
| // stub |
| } |
| </SCRIPT> |
| |
| <A name="top"></A> |
| <TABLE class="frameTable" cellpadding="0" cellspacing="0" border="0"> |
| <TR class="Row1"> |
| <TD class="Col1"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD> |
| <TD class="Col2"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD> |
| <TD class="Col3"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD> |
| <TD class="Col4"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD> |
| <TD class="Col5"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD> |
| </TR> |
| <TR class="Row2"> |
| <TD class="Col1"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD> |
| <TD class="Col2"> </TD> |
| <TD class="Col3" id="breadcrumbs"> |
| <!-- $TOP_NAV_BAR --> |
| <A href="../OPENEJB/index.html" title="Index">Home</A> | <A href="../OPENEJB/download.html" title="Download">Download</A> | <A href="../OPENEJB/mailing-lists.html" title="Mailing Lists">Lists</A> | <A href="http://issues.apache.org/jira/browse/OPENEJB" class="external-link" rel="nofollow">Issues</A> |
| |
| </TD> |
| <TD class="Col4"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD> |
| <TD class="Col5"> </TD> |
| </TR> |
| <TR class="Row3"> |
| <TD class="Col1"><IMG alt="" class="Row3Img" id="thinLine" src="http://openejb.apache.org/images/line_sm.gif"></TD> |
| <TD class="Col2"><IMG alt="" class="Row3Img" src="http://openejb.apache.org/images/dotTrans.gif"></TD> |
| <TD class="Col3"><IMG alt="" class="Row3Img" src="http://openejb.apache.org/images/dotTrans.gif"></TD> |
| <TD class="Col4"><IMG alt="" src="http://openejb.apache.org/images/dotTrans.gif"></TD> |
| <TD class="Col5"><IMG alt="" class="Row3Img" src="http://openejb.apache.org/images/dotTrans.gif"></TD> |
| </TR> |
| <TR class="Row4"> |
| <TD class="Col1"> |
| <SPAN id="Navigation"> |
| |
| <H3><A name="Navigation-Overview"></A>Overview</H3> |
| |
| <UL class="alternate" type="square"> |
| <LI><A href="../OPENEJB/index.html" title="Index">Home</A></LI> |
| <LI><A href="../OPENEJB/news.html" title="News">News</A></LI> |
| <LI><A href="../OPENEJB/faq.html" title="FAQ">FAQ</A></LI> |
| <LI><A href="../OPENEJB/download.html" title="Download">Download</A></LI> |
| <LI><A href="index.html" title="Index">Documentation</A></LI> |
| <LI><A href="../OPENEJB/examples.html" title="Examples">Examples</A></LI> |
| <LI><A href="http://cwiki.apache.org/confluence/display/OPENEJB/Lightening%20Demos" class="external-link" rel="nofollow">Lightning Demos</A></LI> |
| <LI><A href="../OPENEJB/mailing-lists.html" title="Mailing Lists">Mailing Lists</A></LI> |
| <LI><A href="../OPENEJB/source-code.html" title="Source Code">Source Code</A></LI> |
| <LI><A href="http://blogs.apache.org/openejb" class="external-link" rel="nofollow">Project Blog</A></LI> |
| </UL> |
| |
| |
| <H3><A name="Navigation-Servers"></A>Servers</H3> |
| |
| <UL class="alternate" type="square"> |
| <LI><A href="../OPENEJB/local-server.html" title="Local Server">Local</A></LI> |
| <LI><A href="../OPENEJB/remote-server.html" title="Remote Server">Remote</A></LI> |
| </UL> |
| |
| |
| <H3><A name="Navigation-Integrations"></A>Integrations</H3> |
| |
| <UL class="alternate" type="square"> |
| <LI><A href="tomcat.html" title="Tomcat">Tomcat</A></LI> |
| <LI><A href="../OPENEJB/geronimo.html" title="Geronimo">Geronimo</A></LI> |
| <LI><A href="../OPENEJB/webobjects.html" title="WebObjects">WebObjects</A></LI> |
| </UL> |
| |
| |
| <H3><A name="Navigation-Community"></A>Community</H3> |
| |
| <UL class="alternate" type="square"> |
| <LI><A href="../OPENEJB/team.html" title="Team">Team</A></LI> |
| <LI><A href="../OPENEJB/articles.html" title="Articles">Articles</A></LI> |
| <LI><A href="http://webchat.freenode.net/?channels=openejb" class="external-link" rel="nofollow">IRC</A></LI> |
| </UL> |
| |
| |
| <H3><A name="Navigation-RelatedProjects"></A>Related Projects</H3> |
| |
| <UL class="alternate" type="square"> |
| <LI><A href="http://activemq.apache.org/" class="external-link" rel="nofollow">ActiveMQ</A></LI> |
| <LI><A href="http://openjpa.apache.org/" class="external-link" rel="nofollow">OpenJPA</A></LI> |
| <LI><A href="http://cxf.apache.org/" class="external-link" rel="nofollow">CXF</A></LI> |
| </UL> |
| |
| |
| <H3><A name="Navigation-Index"></A>Index</H3> |
| <UL class="alternate" type="square"> |
| <LI><A href="../OPENEJB/space-index.html" title="Space Index">Site Index</A></LI> |
| <LI><A href="space-index.html" title="Space Index">Doc Index</A></LI> |
| </UL> |
| |
| <H3> |
| <A name="Navigation-Feeds"></A> |
| Feeds |
| </H3> |
| |
| <UL class="feeds"> |
| <LI> |
| <A href="http://cwiki.apache.org/confluence/spaces/rss.action?key=OPENEJB&newPages=false"> |
| <IMG src="http://openejb.apache.org/images/rss.gif"></A> |
| <A class="feedsText" href="http://cwiki.apache.org/confluence/spaces/rss.action?key=OPENEJB&newPages=false">Site</A> |
| </LI> |
| |
| <LI><A href="http://cwiki.apache.org/confluence/spaces/blogrss.action?key=OPENEJB"> |
| <IMG src="http://openejb.apache.org/images/rss.gif"></A> |
| <A class="feedsText" href="http://cwiki.apache.org/confluence/spaces/blogrss.action?key=OPENEJB">News</A> |
| </LI> |
| </UL> |
| </SPAN> |
| </TD> |
| <TD class="Col2"> </TD> |
| <TD class="Col3"> |
| <TABLE id="PageHeader" border="0" width="100%"> |
| <TR> |
| <TD> |
| <A href="http://openejb.org/"> |
| <IMG hspace="0" src="http://openejb.apache.org/images/logo_openejb.gif" vspace="0"> |
| </A> |
| </TD> |
| <TD align="right"> |
| <A href="http://www.apache.org/"> |
| <IMG src="http://www.apache.org/images/asf-logo.gif" width="258" height="66"> |
| </A> |
| </TD> |
| </TR> |
| <TR> |
| <TD id="page_title"> |
| <!-- $TITLE --> |
| Unit Testing Transactions |
| </TD> |
| |
| <TD align="right"> |
| <BR><BR> |
| <!-- Google CSE Search Box Begins --> |
| <FORM id="searchbox_010475492895890475512:_t4iqjrgx90" action="http://www.google.com/cse"> |
| <INPUT type="hidden" name="cx" value="010475492895890475512:_t4iqjrgx90"> |
| <INPUT type="hidden" name="cof" value="FORID:0"> |
| <INPUT name="q" type="text" size="25"> |
| <INPUT type="submit" name="sa" value="Search"> |
| </FORM> |
| <SCRIPT type="text/javascript" src="http://www.google.com/coop/cse/brand?form=searchbox_010475492895890475512:_t4iqjrgx90"></SCRIPT> |
| <!-- Google CSE Search Box Ends --> |
| |
| </TD> |
| </TR> |
| </TABLE> |
| <P> |
| <!-- $BODY --> |
| <DIV id="PageContent"> |
| <H1><A name="UnitTestingTransactions-Basicsetup"></A>Basic setup</H1> |
| |
| <P>Add the following interface and bean to your test sources (they could even be inner classes of a test case):</P> |
| |
| <H2><A name="UnitTestingTransactions-Businessinterface"></A>Business interface</H2> |
| |
| <DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> |
| <PRE class="code-java"> |
| <SPAN class="code-keyword">public</SPAN> <SPAN class="code-keyword">interface</SPAN> Caller { |
| <SPAN class="code-keyword">public</SPAN> <V> V call(Callable<V> callable) <SPAN class="code-keyword">throws</SPAN> Exception; |
| } |
| </PRE> |
| </DIV></DIV> |
| |
| <H2><A name="UnitTestingTransactions-BeanImplementation%28s%29"></A>Bean Implementation(s)</H2> |
| |
| <DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> |
| <PRE class="code-java"> |
| <SPAN class="code-keyword">import</SPAN> java.util.concurrent.Callable; |
| |
| @Stateless |
| @TransactionAttribute(REQUIRES_NEW) |
| <SPAN class="code-keyword">public</SPAN> class TransactionBean <SPAN class="code-keyword">implements</SPAN> Caller { |
| <SPAN class="code-keyword">public</SPAN> <V> V call(Callable<V> callable) <SPAN class="code-keyword">throws</SPAN> Exception { |
| <SPAN class="code-keyword">return</SPAN> callable.call(); |
| } |
| } |
| </PRE> |
| </DIV></DIV> |
| |
| <H2><A name="UnitTestingTransactions-Havethemdiscovered"></A>Have them discovered</H2> |
| |
| <P>In src/test/resources/ (or related) create an META-INF/ejb-jar.xml containing the text "<ejb-jar/>"</P> |
| |
| <H2><A name="UnitTestingTransactions-Whatweaccomplished"></A>What we accomplished</H2> |
| |
| <P>Essentially what we've done is added an ejb that will be picked up as part of your test code and deployed. You can then look it up and use it to execute test code with any particular transaction or security constraints that you want. The above bean specifies REQUIRES_NEW; functionally the same as REQUIRED as the test case itself won't have a transaction, but a little cleaner and more explicit. </P> |
| |
| <P>You could also annotate the bean with @RunAs("manager") for example and test that your security restrictions are how you like them. You can have as many of these test beans in your test code as you like, each with it's own transaction and security constraints allowing you to write some incredibly thorough tests.</P> |
| |
| <P>You do not need to use java.util.concurrent.Callable, any similar interface of your creation could work just as well. You may want something with return type void, for example, to eliminate useless 'return null' statements.</P> |
| |
| <H1><A name="UnitTestingTransactions-Usage"></A>Usage</H1> |
| |
| <P>There are a number of style choices for using the above bean, specifically around the creation of the Callable object you pass in, and it all really depends on what looks nice to you.</P> |
| |
| <P>In the examples below, the Movies bean being tested is simply a thin layer around JPA that allows us to use enforce various transaction semantics.</P> |
| |
| <DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> |
| <PRE class="code-java"> |
| <SPAN class="code-keyword">import</SPAN> javax.ejb.Stateful; |
| <SPAN class="code-keyword">import</SPAN> javax.ejb.TransactionAttribute; |
| <SPAN class="code-keyword">import</SPAN> <SPAN class="code-keyword">static</SPAN> javax.ejb.TransactionAttributeType.MANDATORY; |
| <SPAN class="code-keyword">import</SPAN> javax.persistence.EntityManager; |
| <SPAN class="code-keyword">import</SPAN> javax.persistence.PersistenceContext; |
| <SPAN class="code-keyword">import</SPAN> javax.persistence.PersistenceContextType; |
| <SPAN class="code-keyword">import</SPAN> javax.persistence.Query; |
| <SPAN class="code-keyword">import</SPAN> java.util.List; |
| |
| @Stateful(name = <SPAN class="code-quote">"Movies"</SPAN>) |
| @TransactionAttribute(MANDATORY) |
| <SPAN class="code-keyword">public</SPAN> class MoviesImpl <SPAN class="code-keyword">implements</SPAN> Movies { |
| |
| @PersistenceContext(unitName = <SPAN class="code-quote">"movie-unit"</SPAN>, type = PersistenceContextType.TRANSACTION) |
| <SPAN class="code-keyword">private</SPAN> EntityManager entityManager; |
| |
| <SPAN class="code-keyword">public</SPAN> void addMovie(Movie movie) <SPAN class="code-keyword">throws</SPAN> Exception { |
| entityManager.persist(movie); |
| } |
| |
| <SPAN class="code-keyword">public</SPAN> void deleteMovie(Movie movie) <SPAN class="code-keyword">throws</SPAN> Exception { |
| entityManager.remove(movie); |
| } |
| |
| <SPAN class="code-keyword">public</SPAN> List<Movie> getMovies() <SPAN class="code-keyword">throws</SPAN> Exception { |
| Query query = entityManager.createQuery(<SPAN class="code-quote">"SELECT m from Movie as m"</SPAN>); |
| <SPAN class="code-keyword">return</SPAN> query.getResultList(); |
| } |
| } |
| |
| </PRE> |
| </DIV></DIV> |
| |
| <P>Test code below.</P> |
| |
| <H2><A name="UnitTestingTransactions-Pureinlined"></A>Pure inlined</H2> |
| |
| <P>The Callable can be created right in the test method itself.</P> |
| |
| <DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> |
| <PRE class="code-java"> |
| <SPAN class="code-keyword">public</SPAN> class MoviesTest <SPAN class="code-keyword">extends</SPAN> TestCase { |
| <SPAN class="code-keyword">private</SPAN> Context context; |
| |
| <SPAN class="code-keyword">protected</SPAN> void setUp() <SPAN class="code-keyword">throws</SPAN> Exception { |
| <SPAN class="code-comment">// initialize jndi context as usual |
| </SPAN> } |
| |
| <SPAN class="code-keyword">public</SPAN> void test() <SPAN class="code-keyword">throws</SPAN> Exception { |
| Caller transactionBean = (Caller) context.lookup(<SPAN class="code-quote">"TransactionBeanLocal"</SPAN>); |
| |
| transactionBean.call(<SPAN class="code-keyword">new</SPAN> Callable() { |
| <SPAN class="code-keyword">public</SPAN> <SPAN class="code-object">Object</SPAN> call() <SPAN class="code-keyword">throws</SPAN> Exception { |
| Movies movies = (Movies) context.lookup(<SPAN class="code-quote">"MoviesLocal"</SPAN>); |
| |
| movies.addMovie(<SPAN class="code-keyword">new</SPAN> Movie(<SPAN class="code-quote">"Quentin Tarantino"</SPAN>, <SPAN class="code-quote">"Reservoir Dogs"</SPAN>, 1992)); |
| movies.addMovie(<SPAN class="code-keyword">new</SPAN> Movie(<SPAN class="code-quote">"Joel Coen"</SPAN>, <SPAN class="code-quote">"Fargo"</SPAN>, 1996)); |
| movies.addMovie(<SPAN class="code-keyword">new</SPAN> Movie(<SPAN class="code-quote">"Joel Coen"</SPAN>, <SPAN class="code-quote">"The Big Lebowski"</SPAN>, 1998)); |
| |
| List<Movie> list = movies.getMovies(); |
| assertEquals(<SPAN class="code-quote">"List.size()"</SPAN>, 3, list.size()); |
| |
| <SPAN class="code-keyword">for</SPAN> (Movie movie : list) { |
| movies.deleteMovie(movie); |
| } |
| |
| assertEquals(<SPAN class="code-quote">"Movies.getMovies()"</SPAN>, 0, movies.getMovies().size()); |
| |
| <SPAN class="code-keyword">return</SPAN> <SPAN class="code-keyword">null</SPAN>; |
| } |
| }); |
| } |
| } |
| </PRE> |
| </DIV></DIV> |
| |
| <H2><A name="UnitTestingTransactions-Sametestcode%2Cdifferenttransactionscenarios"></A>Same test code, different transaction scenarios</H2> |
| |
| <P>Maybe you'd like to test how things behave with and without a transaction to guarantee everyone is doing the right thing in all situations. Negative testing is often a very good way to stomp out dangerous bugs.</P> |
| |
| <DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent"> |
| <PRE class="code-java"> |
| <SPAN class="code-keyword">public</SPAN> class MoviesTest <SPAN class="code-keyword">extends</SPAN> TestCase { |
| <SPAN class="code-keyword">private</SPAN> Context context; |
| |
| <SPAN class="code-keyword">protected</SPAN> void setUp() <SPAN class="code-keyword">throws</SPAN> Exception { |
| <SPAN class="code-comment">// initialize jndi context as usual |
| </SPAN> } |
| |
| <SPAN class="code-keyword">private</SPAN> void doWork() <SPAN class="code-keyword">throws</SPAN> Exception { |
| Movies movies = (Movies) context.lookup(<SPAN class="code-quote">"MoviesLocal"</SPAN>); |
| |
| movies.addMovie(<SPAN class="code-keyword">new</SPAN> Movie(<SPAN class="code-quote">"Quentin Tarantino"</SPAN>, <SPAN class="code-quote">"Reservoir Dogs"</SPAN>, 1992)); |
| movies.addMovie(<SPAN class="code-keyword">new</SPAN> Movie(<SPAN class="code-quote">"Joel Coen"</SPAN>, <SPAN class="code-quote">"Fargo"</SPAN>, 1996)); |
| movies.addMovie(<SPAN class="code-keyword">new</SPAN> Movie(<SPAN class="code-quote">"Joel Coen"</SPAN>, <SPAN class="code-quote">"The Big Lebowski"</SPAN>, 1998)); |
| |
| List<Movie> list = movies.getMovies(); |
| assertEquals(<SPAN class="code-quote">"List.size()"</SPAN>, 3, list.size()); |
| |
| <SPAN class="code-keyword">for</SPAN> (Movie movie : list) { |
| movies.deleteMovie(movie); |
| } |
| |
| assertEquals(<SPAN class="code-quote">"Movies.getMovies()"</SPAN>, 0, movies.getMovies().size()); |
| } |
| |
| <SPAN class="code-keyword">public</SPAN> void testWithTransaction() <SPAN class="code-keyword">throws</SPAN> Exception { |
| Caller transactionBean = (Caller) context.lookup(<SPAN class="code-quote">"TransactionBeanLocal"</SPAN>); |
| |
| transactionBean.call(<SPAN class="code-keyword">new</SPAN> Callable(){ |
| <SPAN class="code-keyword">public</SPAN> <SPAN class="code-object">Object</SPAN> call() <SPAN class="code-keyword">throws</SPAN> Exception { |
| doWork(); |
| <SPAN class="code-keyword">return</SPAN> <SPAN class="code-keyword">null</SPAN>; |
| } |
| }); |
| } |
| |
| <SPAN class="code-keyword">public</SPAN> void testWithoutTransaction() <SPAN class="code-keyword">throws</SPAN> Exception { |
| <SPAN class="code-keyword">try</SPAN> { |
| doWork(); |
| fail(<SPAN class="code-quote">"The Movies bean should be using TransactionAttributeType.MANDATORY"</SPAN>); |
| } <SPAN class="code-keyword">catch</SPAN> (javax.transaction.TransactionRequiredException e) { |
| <SPAN class="code-comment">// good, our Movies bean is using TransactionAttributeType.MANDATORY as we want |
| </SPAN> } |
| } |
| } |
| </PRE> |
| </DIV></DIV> |
| </DIV> |
| </P> |
| </TD> |
| <TD class="Col4"><IMG src="http://openejb.apache.org/images/dotTrans.gif"></TD> |
| <TD class="Col5"> |
| |
| |
| </TD> |
| </TR> |
| <TR class="Row5"> |
| <TD class="Col1"> </TD> |
| <TD class="Col2"> </TD> |
| <TD class="Col3"> |
| <BR> |
| <BR> |
| <IMG width="100%" height="1" src="http://openejb.apache.org/images/line_light.gif"> |
| <TABLE width="100%"> |
| <TR> |
| <TD> |
| <SPAN class="bodyGrey"> |
| <SMALL> |
| <NOTICE><!-- $FOOTER --> |
| Apache OpenEJB is an project of The Apache Software Foundation (ASF) |
| </NOTICE> |
| <BR> |
| Site Powered by |
| <A href="http://atlassian.com/">Atlassian</A> |
| <A href="http://atlassian.com/confluence/">Confluence</A> |
| . |
| </SMALL> |
| </SPAN> |
| </TD> |
| <TD align="right"> |
| <A style="color:#999;font-size:small;font-weight:normal;" href="https://cwiki.apache.org/confluence/pages/editpage.action?spaceKey=OPENEJBx30&title=Unit%20Testing%20Transactions">[ edit ]</A> |
| </TD> |
| </TR> |
| </TABLE> |
| <BR> |
| </TD> |
| <TD class="Col4"><IMG src="http://openejb.apache.org/images/dotTrans.gif"></TD> |
| <TD class="Col5"> </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- Needed for composition plugin --> |
| <!-- delay the loading of large javascript files to the end so that they don't interfere with the loading of page content --> |
| <SPAN style="display: none"> |
| <SCRIPT type="text/javascript" language="JavaScript" src="http://cwiki.apache.org/confluence/labels-javascript"></SCRIPT> |
| |
| <SCRIPT src="http://www.google-analytics.com/urchin.js" type="text/javascript"> |
| </SCRIPT> |
| <SCRIPT type="text/javascript"> |
| _uacct = "UA-2717626-1"; |
| urchinTracker(); |
| </SCRIPT> |
| </SPAN> |
| |
| </BODY> |
| </HTML> |
