Release Notes

Spock now supports pluggable mock makers loaded via ServiceLoader #1746

Added mockito mock maker #1753 which supports:

Added support for mocking of static methods also for Java code with the new API SpyStatic() #1756

Add verifyEach method to perform assertions on each element of an Iterable #1887

Add annotation extensions for parameters #1599

Add support for keeping state in extensions #1692

Add feature-scoped interceptors #1844

Add @Snapshot extension for snapshot testing #1873

Add !! as opt-out operator for assertions #1532

Calling old(…​) with multiple arguments is now a compilation error. Previously the additional arguments were simply ignored.

Creating GroovyMock/GroovyStub/GroovySpy for an already mocked type will now fail.

Creating a global GroovyMock/GroovyStub/GroovySpy when parallel execution is enabled, will now require that the spec is annotated with @Isolated or @ResourceLock(org.spockframework.runtime.model.parallel.Resources.META_CLASS_REGISTRY). See Global mocks and parallel execution #1848

@TempDir spock.tempDir.keep has been replaced by spock.tempdir.cleanup. See TempDir Cleanup #1525

Add support for parameter injection of @TempDir

Add cleanup switch for @TempDir #1525

Add support for creation of global Groovy mocks for abstract classes #1754

Add optional reason to @ResourceLock #1890

Add optional reason to @Execution #1576

Add onTimeout support for PollingConditions #1853

Add SpecInfo#getAll…​Methods() methods #1770

Add array support to collection conditions #1734

Add support for logging thread dumps when @Timeout interrupts are ignored #1658

Add implied features to force execution of features even when removed by a build tool #1598

Improve StackTraceFilter by ignoring java.lang.invoke.* #1892

Improve @TempDir field injection, now it happens before field initialization, so it can be used by other field initializers.

Improve Spock-Compiler does not use wrapper types anymore #1765

Improve reduce lock contention of the byte-buddy mock maker, when multiple mocks are created concurrently #1778

Improve @Use on feature and fixture method for parallel execution #1691

Improve IDE support

Improve RunContexts behavior in multithreaded executions #1758, #1846

Improve generic handling by replacing gentyref code with geantyref library #1743

Improve handling of passing null to thrown() to be consistent with mock object creation #1799

Improve old(…​) calls by validating their argument count #1810

Improve robustness of the AST transformation against missing classes in the compile classpath #1704

Improve handling of shared. conditions in @IgnoreIf/@Requires, the condition is now checked before creating data providers #1711

Fix issue with mocks of Groovy classes, where the Groovy MOP for @Internal methods was not honored by the byte-buddy mock maker #1729

Improve support for generic return types for mocks #1731

Fix the lifecycle of simple features #1675

Fix exception when configured baseDir was not existing, now @TempDir will create the baseDir directory if it is missing.

Fix bad error message for collection conditions, when one of the operands is null

Fix docs about initializer method interceptors #1666

Fix possible deadlock, when blocking in mock response generators #1885

Fix SpringSpy not working with DirtiesContext.ClassMode.BEFORE_EACH_TEST_METHOD #1869

Fix null handling for collection conditions #1858

Fix interceptor contexts #1676

Fix properly call IRunListener.specSkipped and .featureSkipped #1811

Fix defining responses for additionalInterfaces #1730

Fix lost execution mode for iteration nodes of implied data-driven features #1615

Fix docs how to register all possible interceptors #1667, #1824

Document @ConditionBlock Annotation #1709

Document old-Method #1708

Document for DetachedMockFactory #1728

Clarify documentation for global Mocks #1755

Add collection conditions #1372

Add support for selecting individual iterations via their unique ID (IDE support required). #1376

Add data. support to conditional extensions #1360. This replaces the current behavior of accessing data variables without any prefix. See Precondition Context for more details.

Add exception translation to JUnit4 Rules #1342

Add option to omit feature name from iterations #1386 and add additional Special Tokens to unroll patterns.

Add optional reason to @Requires and @IgnoreIf #1362

Add shared. support to conditional extensions #1359. See Precondition Context for more details.

Set the owner for condition closures on spec annotations #1357

Update bnd Gradle plugin to 6.0.0 (OSGI) #1377

Fix selector ordering issue #1375

Fix @TempDir not working for @Shared inherited fields #1373

Fix JUnit rule run order #1363

Prevent removal of ErrorSpecNode from execution hierarchy #1358

Fix double invocation of IRunListener.beforeSpec and IRunListener.afterSpec #1344

Fix regression with multi-assignment of method call result #1333

Fix Build MethodSource with the correct spec class name #1345

Automatically test on CI with JDK 17 (only -groovy-3.0 variant)

Spock is now a test engine based on the JUnit Platform

Spock now supports Parallel Execution on the spec and feature level, with powerful tools for shared resource access.

Support for Groovy 3

Data driven tests are now unrolled by default with a more informative naming scheme

Data driven tests can now declare a subset of parameters, which are injected by name instead of position.

Remove @ResourceLockChildren again, as JUnit Platform 5.7.2 makes it obsolete. With the update a READ lock on a parent node, does not force same thread execution on its children. If you are one of the few that have already used @ResourceLockChildren, just replace it with @ResourceLock.

Fix NPE if variable is initialized using a method with the same in features with cleanup blocks or using thrown condition #1266 #1313

Fix implicit this conversion after bugfix in Groovy 3.0.8 #1318

Fix extension-provided method arguments in fixture methods #1305

Update Jvm helper to support versions up to 23 (next LTS release)

The ReportLogExtension vestiges were removed. As this extension was mostly used for an unreleased Spock module, this won’t affect many users. If you are using a Spock Configuration File with a report section, then you must delete everything from this section except for issueNamePrefix and issueUrlPrefix. These two properties are still supported and used by the @Issue extension.

Add support for injection into @Shared fields in spock-spring module which users can opt-in for by adding @EnableSharedInjection to the specification. #76

Add new displayName via INameable for SpecInfo, FeatureInfo, and IterationInfo. This field can be set via extensions to change the reported name. The existing iteration NameProvider now also sets the displayName instead of the name. Modifying the name instead of displayName is now considered deprecated for extensions. #1236

Add support for constructor injection for extensions

Improve final field handling. Final fields are now transformed similar to shared fields, so that we can still delay the initialization but keep them unmodifiable to user code. #1011

Improve parallel extensions to support inheritance #1245

Improve PollingConditions

Improve some AST transformation code regarding error handling

Deprecate AbstractGlobalExtension and replace with IGlobalExtension

Remove unnecessary try-finally construct for assertions

Fix ErrorSpecNode throw Exception in prepare instead of execute this fixes an issue that interceptors for prepare, before, and around were still executed and any Exception they throw would hide the actual cause.

Fix #1294 swallowing of unrecoverable Errors

Fix #1260 Change InteractionRewriter to keep casting of ListExpressions intact

Fix #1282 Make TempDirInterceptor safe for parallel invocation of iterations

Fix #1267 Retry extension behavior for unrolled tests

Fix #1267 Retry extension behavior for unrolled tests

Fix #1229 @TempDir not working for inherited fields

Fix #1232 compile error for nested conditions without top-level condition

Fix #1256 handling of is as getter for boolean properties on Mocks

Fix #1270 handling of is as getter for boolean properties on GroovyMocks

Fix ErrorSpecNode to re-throw Exception in prepare instead of execute, this fixes an issue that interceptors for prepare, before, and around were still executed and any Exception they throw would hide the actual cause.

Fix #1263 ExceptionAdapterExtension to also handle inherited fixture methods

Fix #1279 Cast data variables with type coercion to the declared parameter type

A new MutableClock utility class to support time related testing, see docs.

Defining interactions on property getters within Mock instantiation closures or with closures works now without the need to explicitly qualify the property access with it.:

Foo foo = Stub {
    bar >> 'my stubbed property'
}

A sequence of two or more underscores can be used to separate multiple data tables in one where block.

Type casts in conditions are now properly carried over to properly disambiguate method calls. For more information see issue #1022.

Data tables now support any amount of semicolons to separate data table columns as alternative to pipes and double pipes, but cannot be mixed with them in one table:

where:
a ; b ;; c
1 ; 2 ;; 3

The default unroll pattern changed from the rather generic #featureName[#iterationIndex] to a more fancy version that lists all data variables and their values additionally to the feature name and iteration index. If you prefer to retain the old behaviour, you can set the setting unroll { defaultPattern '#featureName[#iterationIndex]' } in the Spock configuration file and you will get the same result as previously.

If neither a parameter to the @Unroll annotation is given, nor the method name contains a #, now the configuration file setting unroll { defaultPattern } is inspected. If it is set to a non-null string, this value is used as unroll pattern.

IterationInfo now has a property for the iterationIndex and one for a map of data variable names to values. This is typically not interesting for the average user, but might be helpful for authors of Spock extensions.

constructorArgs now properly transport type cast information to the constructor selection, for example to disambiguate multiple candidate constructors:

Spy(constructorArgs: [null as String, (Pattern) null])

Accessing previous data table columns was broken in some cases, now it should work properly, even cross-table and without being disturbed by previous derived data variables.

The order of parameters in a data-driven feature does no longer have to be identical to the declaration order in the where block. Data variables are now injected by name.

Data driven features do no longer have the requirement that either none or all data variables are declared as parameters and that all parameters are also data variables. Now you can either declare none, some, or all data variables as parameters and also have additional method parameters that are no data variables. Those additional parameters must be provided by some Spock extension though. If they are not set at execution time, an exception will be thrown.

Condition closures used in @Requires, @IgnoreIf and @PendingFeatureIf now also get the context passed as argument, so you can use this, typed as org.spockframework.runtime.extension.builtin.PreconditionContext to enable IDE support like code completion:

@IgnoreIf({ PreconditionContext it -> it.os.windows })
def "I'll run everywhere but on Windows"() { ... }

Execution with an unsupported Groovy version can be allowed with -Dspock.iKnowWhatImDoing.disableGroovyVersionCheck=true (#1164)

Relax maximum allowed Groovy version in snapshot builds (#1108)

Upgrade Groovy to 2.5.12 (improved Java 14+ support) and 3.0.4 (fixes #1127)

Upgrade JUnit 4 to 4.13 (in spock-junit4)

Upgrade Hamcrest to 2.2 (from 1.3 provided previously by junit4.jar)

Derived data variables (assignments in where blocks) now also support multi-assignment syntax, including ignoring some values with the wildcard expression.

(a, b, _, c) = row

Multi-variable data pipes now also support nesting.

[a, [_, b]] << [
  [1, [5, 1]],
  [2, [5, 2]]
]

The condition closures for @IgnoreIf, @Requires and @PendingFeatureIf can now access data variables if applied to a data driven feature. This has further implications that are documented in the respective documentation parts and JavaDocs.

Data driven features are now unrolled by default. @Unroll can still be used to specify a custom naming pattern. A simple @Unroll without argument is not needed anymore except when undoing a spec-level @Rollup annotation or if unrolling by default is disabled, so any simple @Unroll annotations can be removed from existing code. You can verify this by looking at the test count which should not have been changed after you removed the simple @Unroll annotations.

@Rollup can now be used on feature and spec level to explicitly roll up any feature where the reporting of single iterations is not wanted.

The setting unroll { unrollByDefault false } in the Spock configuration file can be set to roll up all features by default if not overwritten by explicit @Unroll annotations and thus reinstate the pre Spock 2.0 behaviour.

Updated OSGI support with using bnd (#1154, #1175)

Fix @PendingFeature logic (#1103)

Do not strip type information from arguments (#1134)

Simplify work-around to get the reference to the current closure (#1131)

Set source position for return statement in data provider method (#1116)

Add Spy(T obj, Closure interactions) (#1115)

Reduce number of Groovy dependencies to just groovy.jar (#1109)

Improve ExceptionUtil.sneakyThrow declaration (#1077)

Print up to 5 last mock invocations for a wrong order error (#1093)

Fix EmptyOrDummyResponse returning mock instance for Object (#1092)

Remove unnecessary reflection for Java 8 types in EmptyOrDummyResponse (#1091)

Update old Issue annotations to point to migrated github issues (#1003)

Test Spock with Java 14 (#1155)

Add @PendingFeatureIf annotation (Docs)

Fail-fast for invalid Stub interactions, added new validation that catches more invalid usage of Stub

Forbid spying on Spy instances, as this doesn’t work anyway and leads to wrong expectations (#1029)

Update Jvm helper utility to include new Java versions, removed pre 8 versions

Update docs regarding ByteBuddy, cglib, objenesis

Provide compatibility to both JUnit 5.5.2 and 5.6.0

Add implicit assertions for CodeArgument constraints (#956)

Add power assertion output to asserts with explicit message (#928)

Add support for mixed named and positional arguments in mocks (#919)

Add NamedParam support for groovy-2.5 with backport to 2.4 (#921)

Add special rendering for Set comparisons (#925)

Add identity hash code to type hints in comparison failures if they are identical

Fix erroneous regex where an optional colon was defined instead of a non-capturing group (#931)

Improve CodeArgumentConstraint by supporting assertions (#918)

Improve IDE type inference in MockingApi (#920)

Improve reporting of TooFewInvocationsError (#912)

Improve render class loader for classes in comparison failures (#932)

Improve record class literal values to display FQCN in comparison failures (#935)

Improve filter Java 9+ reflection stack frames

Improve show stacktrace of throwables in comparison failure result

Improve use canonical class name in comparison failure results if present

Improve render otherwise irrelevant expressions if they get a type hint in comparison failure (#936)

Fix do not convert implicit "this" expression like when calling the constructor of a non-static inner class (#930)

Fix class expression recording when there are comments with dots in the same line (#937)

Add support for Java 11+ (#895, #902, #903)

Add Groovy 2.5.0 Variant for better Java 10+ Support

Add @SpringBean and @SpringSpy inspired by @MockBean, Also add @StubBeans (Docs)

Add @UnwrapAopProxy to make automatically unwrap SpringAopProxies

Add @AutoAttach extension (Docs)

Add @Retry extension (Docs)

Add flag to UnrollNameProvider to assert unroll expressions (set the system property spock.assertUnrollExpressions to true) (#767)

Add automatic module name descriptors for Java 9

Add configurable condition to @Retry extension to allow for customizing when retries should be attempted (Docs)

Improve @PendingFeature to now have an optional reason attribute (#907)

Improve @Retry to be declarable on a spec class which will apply it to all feature methods in that class and subclasses (Docs)

Improve StepwiseExtension mark only subsequent features as skipped in case of failure (#893)

Improve in assertions Spock now uses DefaultGroovyMethods.dump instead of toString if a class doesn’t override the default Object.toString.

Improve verifyAll can now also have a target same as with

Improve static type hints for verifyAll and with

Improve reporting of exceptions during cleanup, they are now properly reported as suppressed exceptions instead of hiding the real exception

Improve default responses for stubs, Java 8 types like Optional and Streams now return empty, CompletableFuture completes with null result

Improve support for builder pattern, stubs now return themselves if the return type matches the type of the stub

Improve tapestry support with by supporting @ImportModule

Improve constructorArgs for spies can now accept a map directly without the need to wrap it in a list

Improve Guice Module now automatically attaches detached mocks

Improve unmatched mock messages by using dump instead of inspect for classes which don’t provide a custom toString

Improve spying on concrete instances to enable partial mocking

Fix use String renderer for Class instances (#909)

Fix mark new Spring extensions as @Beta (#890)

Fix exclude groovy-groovysh from compile dependencies (#882)

Fix Retry.Mode.FEATURE and Retry.Mode.SETUP_FEATURE_CLEANUP to make a test pass if a retry was successful.

Fix issue with @SpringBean mocks throwing InvocationTargetException instead of actual declared exceptions (#878, #887)

Fix void methods with implicit targets failing in with and verifyAll (#886)

Fix SpockAssertionErrors and its subclasses now are properly Serializable

Fix Spring injection of JUnit Rules, due to the changes in 1.1 the rules where initialized before Spring could inject them, this has been fixed by performing the injection earlier in the process

Fix SpringMockTestExecutionListener initializes lazy beans

Fix OSGi Import-Package header

Fix re-declare recorder variables (#783), this caused annotations such as @Slf4j to break Specifications

Fix MissingFieldException in DiffedObjectAsBeanRenderer

Fix problems with nested with and verifyAll method calls

Fix assertion of mock invocation order with nested invocations (#475)

Fix ignore inferred type for Spies on existing instance

General dependency update

Add support for Java 11+ (#895, #902, #903)

Improve @PendingFeature to now have an optional reason attribute (#907)

Fix use String renderer for Class instances (#909)

Fix mark new Spring extensions as @Beta (#890)

Fix exclude groovy-groovysh from compile dependencies (#882)

Add configurable condition to @Retry extension to allow for customizing when retries should be attempted (Docs)

Fix Retry.Mode.FEATURE and Retry.Mode.SETUP_FEATURE_CLEANUP to make a test pass if a retry was successful.

Improve @Retry to be declarable on a spec class which will apply it to all feature methods in that class and subclasses (Docs)

Improve StepwiseExtension mark only subsequent features as skipped in case of failure (#893)

Fix issue with @SpringBean mocks throwing InvocationTargetException instead of actual declared exceptions (#878, #887)

Fix void methods with implicit targets failing in with and verifyAll (#886)

Add Groovy 2.5.0 Variant for better Java 10 Support

Add @SpringBean and @SpringSpy inspired by @MockBean, Also add @StubBeans

Add @UnwrapAopProxy to make automatically unwrap SpringAopProxies

Add flag to UnrollNameProvider to assert unroll expressions (set the system property spock.assertUnrollExpressions to true) #767

Add automatic module name descriptors for Java 9

Add @AutoAttach extension (Docs)

Add @Retry extension (Docs)

Fix SpockAssertionErrors and its subclasses now are properly Serializable

Fix Spring injection of JUnit Rules, due to the changes in 1.1 the rules where initialized before Spring could inject them, this has been fixed by performing the injection earlier in the process

Fix SpringMockTestExecutionListener initializes lazy beans

Fix OSGi Import-Package header

Fix re-declare recorder variables (#783), this caused annotations such as @Slf4j to break Specifications

Fix MissingFieldException in DiffedObjectAsBeanRenderer

Fix problems with nested with and verifyAll method calls

Fix assertion of mock invocation order with nested invocations (#475)

Fix ignore inferred type for Spies on existing instance

Improve in assertions Spock now uses DefaultGroovyMethods.dump instead of toString if a class doesn’t override the default Object.toString.

Improve verifyAll can now also have a target same as with

Improve static type hints for verifyAll and with

Improve reporting of exceptions during cleanup, they are now properly reported as suppressed exceptions instead of hiding the real exception

Improve default responses for stubs, Java 8 types like Optional and Streams now return empty, CompletableFuture completes with null result

Improve support for builder pattern, stubs now return themselves if the return type matches the type of the stub

Improve tapestry support with by supporting @ImportModule

Improve constructorArgs for spies can now accept a map directly without the need to wrap it in a list

Improve Guice Module now automatically attaches detached mocks

Improve unmatched mock messages by using dump instead of inspect for classes which don’t provide a custom toString

Improve spying on concrete instances to enable partial mocking

General dependency update

Groovy 2.4.10 introduced a bug that interfered with the way verifyAll works, it has been fixed in 2.4.12

Update docs to include info/examples for Spying instantiated objects

Fix integer overflow that could occur when the OutOfMemoryError protection while comparing huge strings kicked in

Improve rendering for OutOfMemoryError protection

15 merged pull requests

Spies can now be created with an already existing target

Fix for scoped Spring Beans

Fix incompatibility with Spring 2/3 that was introduced in 1.1-rc-1

Fix groovy compatibility

Fix ByteBuddy compatibility

Fix OutOfMemoryError when comparing huge strings

Improve default response for java.util.Optional<T>, will now return empty optional

Improve detection of Spring Boot tests

Improve documentation for global extensions

Support for the new test annotations in Spring Boot 1.4.

Fixed the integration of JUnit method rules which now correctly happen "outside" the setup / cleanup methods.

44 merged pull requests

The verifyAll method can be used to assert multiple boolean expressions without short-circuiting those after a failure. For example:

Detached mocks via the DetachedMockFactory and SpockMockFactoryBean classes see the Spring Module Docs.

Cells in a data table can refer to the current value for a column to the left.

Spy can be used to create partial mocks for Java 8 interfaces with default methods just as it can for abstract classes.

Improved power assert output when an exception occurs evaluating an assertion.

A new @PendingFeature annotation to distinguish incomplete functionality from features with @Ignore.

17 contributors, 21 resolved issues, 18 merged pull requests, some ongoing work. No ground-breaking new features, but significant improvements and fixes across the board.

Minimum runtime requirements raised to JRE 1.6 and Groovy 2.0.

Improved and restyled reference documentation at https://docs.spockframework.org. Generated with Asciidoctor (what else?).

Maven plugin removed. Just let Maven Surefire run your Spock specs like your JUnit tests (see spock-example project).

Official support for Java 1.8, Groovy 2.3 and Groovy 2.4. Make sure to pick the groovy-2.0 binaries for Groovy 2.0/2.1/2.2, groovy-2.3 binaries for Groovy 2.3, and groovy-2.4 binaries for Groovy 2.4 and higher.

Improved infrastructure to allow for easier community involvement: Switch to GitHub issue tracker, Windows and Linux CI builds, pull requests automatically tested, all development on master branch (bye-bye groovy-x.y branches!).

Follow our new Twitter account

Try these new third-party extensions

Check out the upcoming Java Testing with Spock book from Manning

Jordan Black

Fedor Bobin

Leonard Brünings

cetnar

Luke Daley

David Dawson

Scott G

Sean Gilligan

Taha Hafeez

Lari Hotari

Nicklas Lindgren

David W Millar

Peter Niederwieser

Jean-Baptiste Nallet

Opalo

Magda Stożek

Ramazan VARLIKLI

Create a example which uses ConfineMetaClassChanges

Mistakes in PollingConditions sphinx docs

Closure used as data value in where-block can’t be called with method syntax

old() expression blows up when part of failing condition

Reflect subsequent filtering/sorting in a spec’s JUnit description

After/AfterClass/Before/BeforeClass methods from superclass should not be called if they have been overrided in the derived class

Data values in where-block are not resolved in nested closures

spock-maven:0.7-groovy-2.0 has an invalid descriptor (and a workaround for this)

PollingConditions doesn’t report failed assertion

Provide a Specification.with() overload that states the expected target type

Problem with array arguments to mock methods

spock-tapestry should support @javax.inject.Inject and @InjectService

Compilation error when using multi assignment

Groovy mocks should allow to mock final classes/methods

Better generics support for mocks and stubs

GC calls to finalize() on mocks cause strict interaction specifications (0 * _) to fail intermittently

Multiple Assignment in when: and anything in cleanup:

Move OptimizeRunOrderSuite from spock-core to spock-maven to solve a problem with Android’s test runner

Support running on JDK 8

Release binary variants for Groovy 2.3 and Groovy 2.4

Port reference documentation to Asciidoc

Update extensions.rst

allow one column data-table to be passed as parameter

Use https:// link to Maven Central

Change Snapshot Repository to use https:// URL

Fix incorrect code listing in docs

Minor documentation corrections: spelling, code examples. README.md corr…​

added manifest to core.gradle to allow spock core to work in OSGi land

Allow Build on Windows

Small typo fixed

Update interaction_based_testing.rst

Closure used as data value in where-block can’t be called with method syntax

Added docs for Stepwise, Timeout, Use, ConfineMetaClassChanges, AutoClea…​

Spring @ContextHierarchy support

Add groovy console support for the specs project, to ease debugging of the AST.

Update spock-report/src/test/groovy/org/spockframework/report/sample/Fig…​

spock-tapestry: added support for @InjectService, @javax.inject.Inject

missing code

Support overriding Junit After*/Before* methods in the derived class(

Spock Subjects-Collaborators Extension

Spock Reports Extension

Spock reports

Render exceptions in conditions as condition failure

Soft asserts: check all then throw all failures

Detached mocks