mockit.integration.testng.package-info Maven / Gradle / Ivy

Go to download
/*
 * JMockit
 * Copyright (c) 2006-2010 Rogério Liesenfeld
 * All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

/**
 * Provides integration with TestNG test runners, for versions 5.9+.
 * Contains the {@link mockit.integration.testng.Initializer} test listener class that can be specified to TestNG at
 * startup, as well as the "startup mock" implementation for integration with the TestNG test runner.
 * 
 * This integration provides the same benefits to test code as the one for JUnit 4:
 * 

 * 
 * Unexpected invocations specified through the Annotations or the Expectations API are automatically verified just
 * before the execution of a test ends (specifically, immediately after the execution of the test method).
 * 
 * 
 * Any mock classes applied with the Annotations API from inside a test method will be discarded right after the
 * execution of the test method, so it is not necessary to explicitly call {@link mockit.Mockit#tearDownMocks()},
 * be it from inside the test method itself or from an {@code @AfterMethod}/{@code @After} method.
 * The same is not true for mock classes applied in a {@code @BeforeMethod}/{@code @Before} method, however:
 * you will need to explicitly tear down those mock classes in an {@code @AfterMethod}/{@code @After} method,
 * so that the mocked real classes are properly restored to their original definitions.
 * 
 * 
 * Any {@linkplain mockit.MockClass mock class} set up for the whole test class (either through a call to
 * {@link mockit.Mockit#setUpMocks} from inside a {@code @BeforeClass} method, or by annotating the test class with
 * {@link mockit.UsingMocksAndStubs}) will only apply to the test methods in this same test class.
 * That is, you should not explicitly tell JMockit to restore the mocked classes in an {@code @AfterClass} method.
 * 
 * 
 * Test methods will accept mock parameters, whose values are mocked instances automatically created by JMockit
 * and passed by the test runner when the test method gets executed. 
 * 
 * 
 */
package mockit.integration.testng;