root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

[SPR-8240] Documenting TestContext support for @Configuration classes in the reference manual; and polishing the testing content in general.

This commit is contained in:
Sam Brannen 2011-09-29 12:08:05 +00:00
parent 15f217c274
commit ac4cd8c37b
1 changed files with 47 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
spring-framework-reference/src/testing.xml
View File

@ -429,8 +429,8 @@
load and configure an load and configure an
<interfacename>ApplicationContext</interfacename> for test classes. <interfacename>ApplicationContext</interfacename> for test classes.
Specifically, <interfacename>@ContextConfiguration</interfacename> Specifically, <interfacename>@ContextConfiguration</interfacename>
declares either the application context resource declares <emphasis>either</emphasis> the application context
<literal>locations</literal> or the resource <literal>locations</literal> <emphasis>or</emphasis> the
<interfacename>@Configuration</interfacename> <interfacename>@Configuration</interfacename>
<varname>classes</varname> to load as well as the <varname>classes</varname> to load as well as the
<interfacename>ContextLoader</interfacename> strategy to use for <interfacename>ContextLoader</interfacename> strategy to use for
@ -439,18 +439,28 @@
either resource <varname>locations</varname> or configuration either resource <varname>locations</varname> or configuration
<varname>classes</varname>.</para> <varname>classes</varname>.</para>
<programlisting language="java">@ContextConfiguration(locations="example/test-context.xml", loader=CustomContextLoader.class) <programlisting language="java"><emphasis role="bold">@ContextConfiguration</emphasis>(<emphasis
public class CustomConfiguredApplicationContextTests { role="bold">locations</emphasis>="example/test-context.xml", <emphasis
role="bold">loader</emphasis>=CustomContextLoader.class)
public class XmlApplicationContextTests {
<lineannotation>// class body...</lineannotation>
}</programlisting>
<programlisting language="java"><emphasis role="bold">@ContextConfiguration</emphasis>(<emphasis
role="bold">classes</emphasis>=MyConfig.class)
public class ConfigClassApplicationContextTests {
<lineannotation>// class body...</lineannotation> <lineannotation>// class body...</lineannotation>
}</programlisting> }</programlisting>
<note> <note>
<para><interfacename>@ContextConfiguration</interfacename> <para><interfacename>@ContextConfiguration</interfacename>
supports <emphasis>inherited</emphasis> resource locations by provides support for <emphasis>inheriting</emphasis> resource
default. See <link linkend="testcontext-ctx-management">Context locations or configuration classes by default.</para>
management and caching</link> and Javadoc for an example and
further details.</para>
</note> </note>
<para>See <link linkend="testcontext-ctx-management">Context
management and caching</link> and Javadoc for examples and further
details.</para>
</listitem> </listitem>
<listitem> <listitem>
@ -497,17 +507,18 @@ public class CustomConfiguredApplicationContextTests {
<literal>AFTER_EACH_TEST_METHOD</literal>, the context is marked <literal>AFTER_EACH_TEST_METHOD</literal>, the context is marked
dirty after each test method in the class.</para> dirty after each test method in the class.</para>
<programlisting language="java">@DirtiesContext <programlisting language="java"><emphasis role="bold">@DirtiesContext</emphasis>
public class ContextDirtyingTests { public class ContextDirtyingTests {
<lineannotation>// some tests that result in the Spring container being dirtied</lineannotation> <lineannotation>// some tests that result in the Spring container being dirtied</lineannotation>
}</programlisting> }</programlisting>
<programlisting language="java">@DirtiesContext(classMode = ClassMode.AFTER_EACH_TEST_METHOD) <programlisting language="java"><emphasis role="bold">@DirtiesContext</emphasis>(<emphasis
role="bold">classMode</emphasis> = ClassMode.AFTER_EACH_TEST_METHOD)
public class ContextDirtyingTests { public class ContextDirtyingTests {
<lineannotation>// some tests that result in the Spring container being dirtied</lineannotation> <lineannotation>// some tests that result in the Spring container being dirtied</lineannotation>
}</programlisting> }</programlisting>
<programlisting language="java">@DirtiesContext <programlisting language="java"><emphasis role="bold">@DirtiesContext</emphasis>
@Test @Test
public void testProcessWhichDirtiesAppCtx() { public void testProcessWhichDirtiesAppCtx() {
<lineannotation>// some logic that results in the Spring container being dirtied</lineannotation> <lineannotation>// some logic that results in the Spring container being dirtied</lineannotation>
@ -532,7 +543,7 @@ public void testProcessWhichDirtiesAppCtx() {
<interfacename>@ContextConfiguration</interfacename>.</para> <interfacename>@ContextConfiguration</interfacename>.</para>
<programlisting language="java">@ContextConfiguration <programlisting language="java">@ContextConfiguration
@TestExecutionListeners({CustomTestExecutionListener.class, AnotherTestExecutionListener.class}) <emphasis role="bold">@TestExecutionListeners</emphasis>({CustomTestExecutionListener.class, AnotherTestExecutionListener.class})
public class CustomTestExecutionListenerTests { public class CustomTestExecutionListenerTests {
<lineannotation>// class body...</lineannotation> <lineannotation>// class body...</lineannotation>
}</programlisting> }</programlisting>
@ -559,7 +570,9 @@ public class CustomTestExecutionListenerTests {
<interfacename>@ContextConfiguration</interfacename>.</para> <interfacename>@ContextConfiguration</interfacename>.</para>
<programlisting language="java">@ContextConfiguration <programlisting language="java">@ContextConfiguration
@TransactionConfiguration(transactionManager="txMgr", defaultRollback=false) <emphasis role="bold">@TransactionConfiguration</emphasis>(<emphasis
role="bold">transactionManager</emphasis>="txMgr", <emphasis
role="bold">defaultRollback</emphasis>=false)
public class CustomConfiguredTransactionalTests { public class CustomConfiguredTransactionalTests {
<lineannotation>// class body...</lineannotation> <lineannotation>// class body...</lineannotation>
}</programlisting> }</programlisting>
@ -587,7 +600,7 @@ public class CustomConfiguredTransactionalTests {
<interfacename>@Rollback</interfacename> to override the default <interfacename>@Rollback</interfacename> to override the default
rollback flag configured at the class level.</para> rollback flag configured at the class level.</para>
<programlisting language="java">@Rollback(false) <programlisting language="java"><emphasis role="bold">@Rollback</emphasis>(false)
@Test @Test
public void testProcessWithoutRollback() { public void testProcessWithoutRollback() {
<lineannotation>// ...</lineannotation> <lineannotation>// ...</lineannotation>
@ -604,8 +617,8 @@ public void testProcessWithoutRollback() {
via the <interfacename>@Transactional</interfacename> via the <interfacename>@Transactional</interfacename>
annotation.</para> annotation.</para>
<programlisting language="java">@BeforeTransaction <programlisting language="java"><emphasis role="bold">@BeforeTransaction
public void beforeTransaction() { </emphasis>public void beforeTransaction() {
<lineannotation>// logic to be executed before a transaction is started</lineannotation> <lineannotation>// logic to be executed before a transaction is started</lineannotation>
}</programlisting> }</programlisting>
</listitem> </listitem>
@ -620,8 +633,8 @@ public void beforeTransaction() {
via the <interfacename>@Transactional</interfacename> via the <interfacename>@Transactional</interfacename>
annotation.</para> annotation.</para>
<programlisting language="java">@AfterTransaction <programlisting language="java"><emphasis role="bold">@AfterTransaction
public void afterTransaction() { </emphasis>public void afterTransaction() {
<lineannotation>// logic to be executed after a transaction has ended</lineannotation> <lineannotation>// logic to be executed after a transaction has ended</lineannotation>
}</programlisting> }</programlisting>
</listitem> </listitem>
@ -634,7 +647,7 @@ public void afterTransaction() {
test method must <emphasis>not</emphasis> execute in a transactional test method must <emphasis>not</emphasis> execute in a transactional
context.</para> context.</para>
<programlisting language="java">@NotTransactional <programlisting language="java"><emphasis role="bold">@NotTransactional</emphasis>
@Test @Test
public void testProcessWithoutTransaction() { public void testProcessWithoutTransaction() {
<lineannotation>// ...</lineannotation> <lineannotation>// ...</lineannotation>
@ -679,7 +692,8 @@ public void testProcessWithoutTransaction() {
class or to individual methods. Class-level usage overrides class or to individual methods. Class-level usage overrides
method-level usage.</para> method-level usage.</para>
<programlisting language="java">@IfProfileValue(name="java.vendor", value="Sun Microsystems Inc.") <programlisting language="java"><emphasis role="bold">@IfProfileValue</emphasis>(<emphasis
role="bold">name</emphasis>="java.vendor", <emphasis role="bold">value</emphasis>="Sun Microsystems Inc.")
@Test @Test
public void testProcessWhichRunsOnlyOnSunJvm() { public void testProcessWhichRunsOnlyOnSunJvm() {
<lineannotation>// some logic that should run only on Java VMs from Sun Microsystems</lineannotation> <lineannotation>// some logic that should run only on Java VMs from Sun Microsystems</lineannotation>
@ -691,7 +705,8 @@ public void testProcessWhichRunsOnlyOnSunJvm() {
to achieve TestNG-like support for <emphasis>test groups</emphasis> to achieve TestNG-like support for <emphasis>test groups</emphasis>
in a JUnit environment. Consider the following example:</para> in a JUnit environment. Consider the following example:</para>
<programlisting language="java">@IfProfileValue(name="test-groups", values={"unit-tests", "integration-tests"}) <programlisting language="java"><emphasis role="bold">@IfProfileValue</emphasis>(<emphasis
role="bold">name</emphasis>="test-groups", <emphasis role="bold">values</emphasis>={"unit-tests", "integration-tests"})
@Test @Test
public void testProcessWhichRunsForUnitOrIntegrationTestGroups() { public void testProcessWhichRunsForUnitOrIntegrationTestGroups() {
<lineannotation>// some logic that should run only for unit and integration test groups</lineannotation> <lineannotation>// some logic that should run only for unit and integration test groups</lineannotation>
@ -711,7 +726,7 @@ public void testProcessWhichRunsForUnitOrIntegrationTestGroups() {
<classname>SystemProfileValueSource</classname> is used by <classname>SystemProfileValueSource</classname> is used by
default.</para> default.</para>
<programlisting language="java">@ProfileValueSourceConfiguration(CustomProfileValueSource.class) <programlisting language="java"><emphasis role="bold">@ProfileValueSourceConfiguration</emphasis>(CustomProfileValueSource.class)
public class CustomProfileValueSourceTests { public class CustomProfileValueSourceTests {
<lineannotation>// class body...</lineannotation> <lineannotation>// class body...</lineannotation>
}</programlisting> }</programlisting>
@ -731,7 +746,7 @@ public class CustomProfileValueSourceTests {
<emphasis>set up</emphasis> or <emphasis>tear down</emphasis> of the <emphasis>set up</emphasis> or <emphasis>tear down</emphasis> of the
test fixture.</para> test fixture.</para>
<programlisting language="java">@Timed(millis=1000) <programlisting language="java"><emphasis role="bold">@Timed</emphasis>(millis=1000)
public void testProcessWithOneSecondTimeout() { public void testProcessWithOneSecondTimeout() {
<lineannotation>// some logic that should not take longer than 1 second to execute</lineannotation> <lineannotation>// some logic that should not take longer than 1 second to execute</lineannotation>
}</programlisting> }</programlisting>
@ -763,7 +778,7 @@ public void testProcessWithOneSecondTimeout() {
the test method itself as well as any <emphasis>set up</emphasis> or the test method itself as well as any <emphasis>set up</emphasis> or
<emphasis>tear down</emphasis> of the test fixture.</para> <emphasis>tear down</emphasis> of the test fixture.</para>
<programlisting language="java">@Repeat(10) <programlisting language="java"><emphasis role="bold">@Repeat</emphasis>(10)
@Test @Test
public void testProcessRepeatedly() { public void testProcessRepeatedly() {
<lineannotation>// ...</lineannotation> <lineannotation>// ...</lineannotation>
@ -1033,7 +1048,7 @@ public class MyTest {
<programlisting language="java">@RunWith(SpringJUnit4ClassRunner.class) <programlisting language="java">@RunWith(SpringJUnit4ClassRunner.class)
<lineannotation>// ApplicationContext will be loaded from <literal>"/applicationContext.xml"</literal> and <literal>"/applicationContext-test.xml"</literal></lineannotation> <lineannotation>// ApplicationContext will be loaded from <literal>"/applicationContext.xml"</literal> and <literal>"/applicationContext-test.xml"</literal></lineannotation>
<lineannotation>// in the root of the classpath</lineannotation> <lineannotation>// in the root of the classpath</lineannotation>
<emphasis role="bold">@ContextConfiguration(locations={"/applicationContext.xml", "/applicationContext-test.xml"})</emphasis> <emphasis role="bold">@ContextConfiguration({"/applicationContext.xml", "/applicationContext-test.xml"})</emphasis>
public class MyTest { public class MyTest {
<lineannotation>// class body...</lineannotation> <lineannotation>// class body...</lineannotation>
}</programlisting> }</programlisting>
@ -1180,8 +1195,9 @@ public class HibernateTitleRepositoryTests {
private HibernateTitleRepository titleRepository; private HibernateTitleRepository titleRepository;
@Test @Test
public void loadTitle() { @Transactional
Title title = titleRepository.loadTitle(new Long(10)); public void findById() {
Title title = titleRepository.findById(new Long(10));
assertNotNull(title); assertNotNull(title);
} }
}</programlisting> }</programlisting>
@ -1205,8 +1221,9 @@ public class HibernateTitleRepositoryTests {
} }
@Test @Test
public void loadTitle() { @Transactional
Title title = titleRepository.loadTitle(new Long(10)); public void findById() {
Title title = titleRepository.findById(new Long(10));
assertNotNull(title); assertNotNull(title);
} }
}</programlisting> }</programlisting>
@ -1251,7 +1268,7 @@ public class HibernateTitleRepositoryTests {
@Autowired @Autowired
@Override @Override
public void setDataSource(<emphasis role="bold">@Qualifier("myDataSource")</emphasis> DataSource dataSource) { public void setDataSource(<emphasis role="bold">@Qualifier("myDataSource")</emphasis> DataSource dataSource) {
super.setDataSource(dataSource); <emphasis role="bold">super</emphasis>.setDataSource(dataSource);
} }
<lineannotation>// ...</lineannotation></programlisting> <lineannotation>// ...</lineannotation></programlisting>