blob: 5151030d9661e5e4d70c3f0afb2342da54d427e6 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Apache TomEE</title>
<meta name="description"
content="Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling." />
<meta name="keywords" content="tomee,asf,apache,javaee,jee,shade,embedded,test,junit,applicationcomposer,maven,arquillian" />
<meta name="author" content="Luka Cvetinovic for Codrops" />
<link rel="icon" href="../favicon.ico">
<link rel="icon" type="image/png" href="../favicon.png">
<meta name="msapplication-TileColor" content="#80287a">
<meta name="theme-color" content="#80287a">
<link rel="stylesheet" type="text/css" href="../css/normalize.css">
<link rel="stylesheet" type="text/css" href="../css/bootstrap.css">
<link rel="stylesheet" type="text/css" href="../css/owl.css">
<link rel="stylesheet" type="text/css" href="../css/animate.css">
<link rel="stylesheet" type="text/css" href="../fonts/font-awesome-4.1.0/css/font-awesome.min.css">
<link rel="stylesheet" type="text/css" href="../fonts/eleganticons/et-icons.css">
<link rel="stylesheet" type="text/css" href="../css/jqtree.css">
<link rel="stylesheet" type="text/css" href="../css/idea.css">
<link rel="stylesheet" type="text/css" href="../css/cardio.css">
<script type="text/javascript">
<!-- Matomo -->
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
/* We explicitly disable cookie tracking to avoid privacy issues */
_paq.push(['disableCookies']);
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function () {
var u = "//matomo.privacy.apache.org/";
_paq.push(['setTrackerUrl', u + 'matomo.php']);
_paq.push(['setSiteId', '5']);
var d = document, g = d.createElement('script'), s = d.getElementsByTagName('script')[0];
g.async = true;
g.src = u + 'matomo.js';
s.parentNode.insertBefore(g, s);
})();
<!-- End Matomo Code -->
</script>
</head>
<body>
<div class="preloader">
<img src="../img/loader.gif" alt="Preloader image">
</div>
<nav class="navbar">
<div class="container">
<div class="row"> <div class="col-md-12">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/" title="Apache TomEE">
<span>
<img
src="../img/apache_tomee-logo.svg"
onerror="this.src='../img/apache_tomee-logo.jpg'"
height="50"
>
</span>
</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right main-nav">
<li><a href="../docs.html">Documentation</a></li>
<li><a href="../community/index.html">Community</a></li>
<li><a href="../security/security.html">Security</a></li>
<li><a class="btn btn-accent accent-orange no-shadow" href="../download.html">Downloads</a></li>
</ul>
</div>
<!-- /.navbar-collapse -->
</div></div>
</div>
<!-- /.container-fluid -->
</nav>
<div id="main-block" class="container main-block">
<div class="row title">
<div class="col-md-12">
<div class='page-header'>
<h1>iTests Overview</h1>
</div>
</div>
</div>
<div class="row">
<div class="col-md-12">
<div class="sect1">
<h2 id="_motivation">Motivation</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The basic idea behind itests that makes them slightly different than plain junit tests ran by maven is that it&#8217;s assumed that there are other systems (servers, databases, brokers, etc) that need to be started or connected to before the tests can run.
The tests themselves don&#8217;t setup the other systems themselves so that the tests don&#8217;t become coupled with them and you can actually swap out various aspects of those systems behind the back of the tests;
server version, protocol implementation, java version, VM implementation, database provider, operating systems, even using embedded servers and embedded databases.</p>
</div>
<div class="paragraph">
<p>The idea came from the tests in OpenEJB that do this.
It took a lot of work to get them to run as part of the maven build and the itest plugin was the result.</p>
</div>
<div class="paragraph">
<p>Definitely give those a look at: <a href="http://svn.apache.org/viewvc/tomee/tomee/trunk/itests/" class="bare">http://svn.apache.org/viewvc/tomee/tomee/trunk/itests/</a></p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_plugging_in">Plugging in</h2>
<div class="sectionbody">
<div class="paragraph">
<p>You can have systems started and stopped before and after the tests in a number of ways.</p>
</div>
<div class="sect2">
<h3 id="_in_maven_1">In maven 1</h3>
<div class="paragraph">
<p>This series of articles established a basic technique for Container Driven Testing with Maven and OpenEJB using preGoals and postGoals to do server and databse setup and teardown before and after Maven runs the unit tests.
<a href="http://www.theserverside.com/articles/article.tss?l=ContainerDrivenTestingSeries" class="bare">http://www.theserverside.com/articles/article.tss?l=ContainerDrivenTestingSeries</a></p>
</div>
<div class="paragraph">
<p>This concept evolved from OpenEJB into a reusable maven plugin created by Dain Sundstrom that gave these integration tests (itests) their own source directory and added itest:setup and itest:teardown goals to your maven build rather than just using a preGoal on "test:test" for setup and a postGoal on "test:test" for teardown.
The advantage to the new goals is that maven does not call any postGoals on "test:test" if the tests failed;
something the above series of articles hacked around with an odd bit of jelly code.</p>
</div>
<div class="paragraph">
<p>The new itest plugin was checked into Geronimo with the expectation that Geronimo would also use it.
After some time of OpenEJB still being the only consumer of it, it was moved into the Maven repository where they keep it in the Maven sandbox.</p>
</div>
<div class="paragraph">
<p><a href="http://maven.apache.org/plugins-sandbox/itest/" class="bare">http://maven.apache.org/plugins-sandbox/itest/</a></p>
</div>
<div class="paragraph">
<p>ActiveMQ later started using the itest plugin and now has a large suite of their own JMS specific integration tests.</p>
</div>
</div>
<div class="sect2">
<h3 id="_in_maven_2">In maven 2</h3>
<div class="paragraph">
<p>The concept of integration tests (itests) has been built into the lifecycle of maven 2, so it is no longer required to have the itest plugin around to get the extra "itest:setup" and "itest:teardown" goals.
See this document for more info: <a href="http://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html" class="bare">http://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html</a></p>
</div>
</div>
<div class="sect2">
<h3 id="_in_junit_setup_and_teardown">In junit setup and teardown</h3>
<div class="paragraph">
<p>The ejb tests in particular require you to plug in facades for the server and the database so the client (the tests) can say "give me an initial context" or "create these tables i need" in a generic way.
It&#8217;s assumed that those systems were setup and guaranteed in working state in the itest setup phase.
It&#8217;s also guaranteed that the server and database facades know how to contact the server or database to carry out the "give me an initial context" and "create these tables" calls.</p>
</div>
<div class="paragraph">
<p>Here are some implementations of the database provider for reference: - <a href="http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/AxionTestDatabase.java" class="bare">http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/AxionTestDatabase.java</a> - <a href="http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/DerbyTestDatabase.java" class="bare">http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/DerbyTestDatabase.java</a> - <a href="http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/InstantDbTestDatabase.java" class="bare">http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/InstantDbTestDatabase.java</a> - <a href="http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/PostgreSqlTestDatabase.java" class="bare">http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/PostgreSqlTestDatabase.java</a></p>
</div>
<div class="paragraph">
<p>Here are some implementations for the server facades: - <a href="http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/CorbaTestServer.java" class="bare">http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/CorbaTestServer.java</a> - <a href="http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/RemoteTestServer.java" class="bare">http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/RemoteTestServer.java</a> - <a href="http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/IvmTestServer.java" class="bare">http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/IvmTestServer.java</a> - <a href="http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/RiTestServer.java" class="bare">http://cvs.openejb.org/viewrep/openejb/openejb/modules/itests/src/itest/org/openejb/test/RiTestServer.java</a></p>
</div>
<div class="paragraph">
<p>Using the itest concept you could setup any system you need before hand, then just provide an abstraction of that system to the actual tests.
So it&#8217;s not limited to just a server or a database.
You could do queue, topic, clustering heartbeat agent, directory server, etc.</p>
</div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_testing_matrix">Testing matrix</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Even with just what we have we can get quite far.
In a perfect world, we would actually test against the full matrix:</p>
</div>
<div class="paragraph">
<p>Server: Local, Database: Axion Server: Local, Database: Derby Server: Local, Database: PostgreSQL Server: Remote, Database: Axion Server: Remote, Database: Derby Server: Remote, Database: PostgreSQL Server: Corba, Database: Axion Server: Corba, Database: Derby Server: Corba, Database: PostgreSQL</p>
</div>
<div class="paragraph">
<p>We had that going for a short while years ago but it was just too much infrastructure for me to keep running.
It would be nice to get Oracle and MySQL in that list as well.</p>
</div>
<div class="paragraph">
<p>In an even more perfect world we&#8217;d test against not just different Server and Database combinations, but JVM versions as well.</p>
</div>
<div class="paragraph">
<p>Server: Local, Database: Axion, JVM: 1.3 Server: Local, Database: Axion, JVM: 1.4 Server: Local, Database: Axion, JVM: 1.5 Server: Local, Database: Derby, JVM: 1.3 Server: Local, Database: Derby, JVM: 1.4 Server: Local, Database: Derby, JVM: 1.5 Server: Local, Database: PostgreSQL, JVM: 1.3 Server: Local, Database: PostgreSQL, JVM: 1.4 Server: Local, Database: PostgreSQL, JVM: 1.5 Server: Remote, Database: Axion, JVM: 1.3 Server: Remote, Database: Axion, JVM: 1.4 Server: Remote, Database: Axion, JVM: 1.5 Server: Remote, Database: Derby, JVM: 1.3 Server: Remote, Database: Derby, JVM: 1.4 Server: Remote, Database: Derby, JVM: 1.5 Server: Remote, Database: PostgreSQL, JVM: 1.3 Server: Remote, Database: PostgreSQL, JVM: 1.4 Server: Remote, Database: PostgreSQL, JVM: 1.5 Server: Corba, Database: Axion, JVM: 1.3 Server: Corba, Database: Axion, JVM: 1.4 Server: Corba, Database: Axion, JVM: 1.5 Server: Corba, Database: Derby, JVM: 1.3 Server: Corba, Database: Derby, JVM: 1.4 Server: Corba, Database: Derby, JVM: 1.5 Server: Corba, Database: PostgreSQL, JVM: 1.3 Server: Corba, Database: PostgreSQL, JVM: 1.4 Server: Corba, Database: PostgreSQL, JVM: 1.5</p>
</div>
<div class="paragraph">
<p>If you add JVM vendors (Sun, IBM, Apple, BEA) to the list, the combinations goes up to like 109.
Throw on OS implementations and you get an insane number of test runs to complete.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div style="margin-bottom: 30px;"></div>
<footer>
<div class="container">
<div class="row">
<div class="col-sm-6 text-center-mobile">
<h3 class="white">Be simple. Be certified. Be Tomcat.</h3>
<h5 class="light regular light-white">"A good application in a good server"</h5>
<ul class="social-footer">
<li><a href="https://www.facebook.com/ApacheTomEE/"><i class="fa fa-facebook"></i></a></li>
<li><a href="https://twitter.com/apachetomee"><i class="fa fa-twitter"></i></a></li>
</ul>
<h5 class="light regular light-white">
<a href="../privacy-policy.html" class="white">Privacy Policy</a>
</h5>
</div>
<div class="col-sm-6 text-center-mobile">
<div class="row opening-hours">
<div class="col-sm-3 text-center-mobile">
<h5><a href="../latest/docs/" class="white">Documentation</a></h5>
<ul class="list-unstyled">
<li><a href="../latest/docs/admin/configuration/index.html" class="regular light-white">How to configure</a></li>
<li><a href="../latest/docs/admin/file-layout.html" class="regular light-white">Dir. Structure</a></li>
<li><a href="../latest/docs/developer/testing/index.html" class="regular light-white">Testing</a></li>
<li><a href="../latest/docs/admin/cluster/index.html" class="regular light-white">Clustering</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="../latest/examples/" class="white">Examples</a></h5>
<ul class="list-unstyled">
<li><a href="../latest/examples/simple-cdi-interceptor.html" class="regular light-white">CDI Interceptor</a></li>
<li><a href="../latest/examples/rest-cdi.html" class="regular light-white">REST with CDI</a></li>
<li><a href="../latest/examples/ejb-examples.html" class="regular light-white">EJB</a></li>
<li><a href="../latest/examples/jsf-managedBean-and-ejb.html" class="regular light-white">JSF</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="../community/index.html" class="white">Community</a></h5>
<ul class="list-unstyled">
<li><a href="../community/contributors.html" class="regular light-white">Contributors</a></li>
<li><a href="../community/social.html" class="regular light-white">Social</a></li>
<li><a href="../community/sources.html" class="regular light-white">Sources</a></li>
</ul>
</div>
<div class="col-sm-3 text-center-mobile">
<h5><a href="../security/index.html" class="white">Security</a></h5>
<ul class="list-unstyled">
<li><a href="https://apache.org/security" target="_blank" class="regular light-white">Apache Security</a></li>
<li><a href="https://apache.org/security/projects.html" target="_blank" class="regular light-white">Security Projects</a></li>
<li><a href="https://cve.mitre.org" target="_blank" class="regular light-white">CVE</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="row bottom-footer text-center-mobile">
<div class="col-sm-12 light-white">
<p>Copyright &copy; 1999-2022 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache TomEE, TomEE, Apache, the Apache feather logo, and the Apache TomEE project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>
</div>
</div>
</div>
</footer>
<!-- Holder for mobile navigation -->
<div class="mobile-nav">
<ul>
<li><a hef="../latest/docs/admin/index.html">Administrators</a>
<li><a hef="../latest/docs/developer/index.html">Developers</a>
<li><a hef="../latest/docs/advanced/index.html">Advanced</a>
<li><a hef="../community/index.html">Community</a>
</ul>
<a href="#" class="close-link"><i class="arrow_up"></i></a>
</div>
<!-- Scripts -->
<script src="../js/jquery-1.11.1.min.js"></script>
<script src="../js/owl.carousel.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script src="../js/wow.min.js"></script>
<script src="../js/typewriter.js"></script>
<script src="../js/jquery.onepagenav.js"></script>
<script src="../js/tree.jquery.js"></script>
<script src="../js/highlight.pack.js"></script>
<script src="../js/main.js"></script>
</body>
</html>