{"id":12673,"date":"2013-08-08T22:36:00","date_gmt":"2013-08-08T21:36:00","guid":{"rendered":"https:\/\/touk.pl\/blog\/?guid=e258117877c04cf766d376ac47686f1e"},"modified":"2022-08-01T11:43:21","modified_gmt":"2022-08-01T09:43:21","slug":"spock-java-and-maven","status":"publish","type":"post","link":"https:\/\/touk.pl\/blog\/2013\/08\/08\/spock-java-and-maven\/","title":{"rendered":"Spock, Java and Maven"},"content":{"rendered":"
Few months ago I\u2019ve came across Groovy \u2013 powerful language for JVM platform which combines the power of Java with abilities typical for scripting languages (dynamic typing, metaprogramming).<\/div>\n
<\/div>\n
Together with Groovy I\u2019ve discovered spock framework (https:\/\/code.google.com\/p\/spock\/<\/a>) \u2013 specification framework for Groovy (of course you can test Java classes too!). But spock is not only test\/specification framework \u2013 it also contains powerful mocking tools.<\/div>\n
<\/div>\n
Even though spock is dedicated for Groovy there is no problem with using it for Java classes tests. In this post I\u2019m going to describe how to configure Maven project to build and run spock specifications together with traditional JUnit tests.<\/div>\n
<\/div>\n
Firstly, we need to prepare pom.xml and add necessary dependencies and plugins.<\/div>\n
<\/div>\n
Two obligatory libraries are:<\/div>\n
\r\n    org.spockframework<\/groupId>\r\n    spock-core<\/artifactId>\r\n    0.7-groovy-2.0<\/version>\r\n    test<\/scope>\r\n<\/dependency>\r\n\r\n    org.codehaus.groovy<\/groupId>\r\n    groovy-all<\/artifactId>\r\n    ${groovy.version}<\/version>\r\n    test<\/scope>\r\n<\/dependency>\r\n<\/pre>\n
Where groovy.version is property defined in pom.xml for more convenient use and easy version change, just like this:<\/p>\n
\r\n    1.4<\/gmaven-plugin.version>\r\n    2.1.5<\/groovy.version>\r\n<\/properties>\r\n<\/pre>\n
\u00a0<\/p>\n
I\u2019ve added property for gmaven-plugin version for the same reason ;)<\/div>\n
<\/div>\n
Besides these two dependencies, we can use few additional ones providing extra functionality:<\/div>\n
\u00a0<\/p>\n
    \n
  • cglib<\/b> \u2013 for class mocking<\/li>\n
  • objenesis<\/b> \u2013 enables mocking classes without default constructor<\/li>\n<\/ul>\n
    \u00a0<\/p>\n
    To add them to the project put these lines in section of pom.xml:<\/div>\n
    \r\n    cglib<\/groupId>\r\n    cglib-nodep<\/artifactId>\r\n    3.0<\/version>\r\n    test<\/scope>\r\n<\/dependency>\r\n\r\n    org.objenesis<\/groupId>\r\n    objenesis<\/artifactId>\r\n    1.3<\/version>\r\n    test<\/scope>\r\n<\/dependency>\r\n<\/pre>\n
    And that\u2019s all for dependencies section. Now we will focus on plugins necessary to compile Groovy classes. We need to add gmaven-plugin with gmaven-runtime-2.0 dependency in plugins section:<\/div>\n
    \r\n    org.codehaus.gmaven<\/groupId>\r\n    gmaven-plugin<\/artifactId>\r\n    ${gmaven-plugin.version}<\/version>\r\n    \r\n        2.0<\/providerSelection>\r\n    <\/configuration>\r\n    \r\n        \r\n            \r\n                compile<\/goal>\r\n                testCompile<\/goal>\r\n            <\/goals>\r\n        <\/execution>\r\n    <\/executions>\r\n    \r\n        \r\n            org.codehaus.gmaven.runtime<\/groupId>\r\n            gmaven-runtime-2.0<\/artifactId>\r\n            ${gmaven-plugin.version}<\/version>\r\n            \r\n                \r\n                    org.codehaus.groovy<\/groupId>\r\n                    groovy-all<\/artifactId>\r\n                <\/exclusion>\r\n            <\/exclusions>\r\n        <\/dependency>\r\n        \r\n            org.codehaus.groovy<\/groupId>\r\n            groovy-all<\/artifactId>\r\n            ${groovy.version}<\/version>\r\n        <\/dependency>\r\n    <\/dependencies>\r\n<\/plugin>\r\n<\/pre>\n
    With these configuration we can use spock and write our first specifications. But there is one issue: default settings for maven-surefire plugin demand that test classes must end with \u201c..Test\u201d postfix, which is ok when we want to use such naming scheme for our spock tests. But if we want to name them like CommentSpec.groovy or whatever with \u201c..Spec\u201d ending (what in my opinion is much more readable) we need to make little change in surefire plugin configuration:<\/div>\n
    \n
    \r\n    org.apache.maven.plugins\r\n    <\/groupId>\r\n    maven-surefire-plugin\r\n    <\/artifactId>\r\n    2.15<\/version>\r\n    \r\n        \r\n            **\/*Test.java<\/include>\r\n            **\/*Spec.java<\/include>\r\n        <\/includes>\r\n    <\/configuration>\r\n<\/plugin><\/pre>\n<\/div>\n
    As you can see there is a little trick ;) We add include directive for standard Java JUnit test ending with \u201c..Test\u201d postfix, but there is also an entry for spock test ending with \u201c..Spec\u201d. And there is a trick: we must write \u201c**\/*Spec.java\u201d, not \u201c**\/*Spec.groovy\u201d<\/b>, otherwise Maven will not run spock tests (which is strange and I\u2019ve spent some time to figure out why Maven can\u2019t run my specs).  <\/b>Little update:<\/b>\u00a0instead of \u201c*.java<\/b>\u201d postfix for both types of tests we can write \u201c*.class<\/b>\u201d what is in my opinion more readable and clean:<\/div>\n
    \n
    **\/*Test.class<\/include>\r\n**\/*Spec.class<\/include>\r\n<\/pre>\n
    (thanks to Tomek P\u0119ksa <\/b>for pointing this out!)<\/p>\n<\/div>\n
    With such configuration, we can write either traditional JUnit test and put them in src\/test\/java directory or groovy spock specifications and place them in src\/test\/groovy. And both will work together just fine :) In one of my next posts I\u2019ll write something about using spock and its mocking abilities in practice, so stay in tune.<\/div>\n","protected":false},"excerpt":{"rendered":"Few months ago I’ve came across Groovy – powerful language for JVM platform which combines the power of Java with abilities typical for scripting languages (dynamic typing, metaprogramming).\n\nTogether with Groovy I’ve discovered spock framework (https:\/\/code.google.com\/p\/spock\/) – specification framework for Groovy (of course you can test Java classes too!). But spock is not only test\/specification framework – it also contains powerful mocking tools.\n\nEven though spock is dedicated for Groovy there is no problem with using it for Java classes tests. In this post I’m going to describe how to configure Maven project to build and run spock specifications together with traditional JUnit tests.\n\n\nFirstly, we need to prepare pom.xml and add necessary dependencies and plugins.\n\nTwo obligatory libraries are:\n<dependency>    <groupid>org.spockframework<\/groupId>    <artifactid>spock-core<\/artifactId>    <version>0.7-groovy-2.0<\/version>    <scope>test<\/scope><\/dependency><dependency>    <groupid>org.codehaus.groovy<\/groupId>    <artifactid>groovy-all<\/artifactId>    <version>${groovy.version}<\/version>    <scope>test<\/scope><\/dependency>\n Where groovy.version is property defined in pom.xml for more convenient use and easy version change, just like this: \n<properties>    <gmaven-plugin.version>1.4<\/gmaven-plugin.version>    <groovy.version>2.1.5<\/groovy.version><\/properties>\n\nI’ve added property for gmaven-plugin version for the same reason ;) \n\nBesides these two dependencies, we can use few additional ones providing extra functionality:\n\ncglib – for class mocking\nobjenesis – enables mocking classes without default constructor\n\nTo add them to the project put these lines in <dependencies> section of pom.xml:\n<dependency>    <groupid>cglib<\/groupId>    <artifactid>cglib-nodep<\/artifactId>    <version>3.0<\/version>    <scope>test<\/scope><\/dependency><dependency>    <groupid>org.objenesis<\/groupId>    <artifactid>objenesis<\/artifactId>    <version>1.3<\/version>    <scope>test<\/scope><\/dependency>\n\nAnd that’s all for dependencies section. Now we will focus on plugins necessary to compile Groovy classes. We need to add gmaven-plugin with gmaven-runtime-2.0 dependency in plugins section:\n<plugin>    <groupid>org.codehaus.gmaven<\/groupId>    <artifactid>gmaven-plugin<\/artifactId>    <version>${gmaven-plugin.version}<\/version>    <configuration>        <providerselection>2.0<\/providerSelection>    <\/configuration>    <executions>        <execution>            <goals>                <goal>compile<\/goal>                <goal>testCompile<\/goal>            <\/goals>        <\/execution>    <\/executions>    <dependencies>        <dependency>            <groupid>org.codehaus.gmaven.runtime<\/groupId>            <artifactid>gmaven-runtime-2.0<\/artifactId>            <version>${gmaven-plugin.version}<\/version>            <exclusions>                <exclusion>                    <groupid>org.codehaus.groovy<\/groupId>                    <artifactid>groovy-all<\/artifactId>                <\/exclusion>            <\/exclusions>        <\/dependency>        <dependency>            <groupid>org.codehaus.groovy<\/groupId>            <artifactid>groovy-all<\/artifactId>            <version>${groovy.version}<\/version>        <\/dependency>    <\/dependencies><\/plugin>\n\nWith these configuration we can use spock and write our first specifications. But there is one issue: default settings for maven-surefire plugin demand that test classes must end with “..Test” postfix, which is ok when we want to use such naming scheme for our spock tests. But if we want to name them like CommentSpec.groovy or whatever with “..Spec” ending (what in my opinion is much more readable) we need to make little change in surefire plugin configuration:\n<plugin>    <groupid>org.apache.maven.plugins<\/groupId>    <artifactid>maven-surefire-plugin<\/artifactId>    <version>2.15<\/version>    <configuration>        <includes>            <include>**\/*Test.java<\/include>            <include>**\/*Spec.java<\/include>        <\/includes>    <\/configuration><\/plugin>\n\nAs you can see there is a little trick ;) We add include directive for standard Java JUnit test ending with “..Test” postfix, but there is also an entry for spock test ending with “..Spec”. And there is a trick: we must write “**\/*Spec.java”, not “**\/*Spec.groovy”, otherwise Maven will not run spock tests (which is strange and I’ve spent some time to figure out why Maven can’t run my specs).Little update: instead of “*.java” postfix for both types of tests we can write “*.class” what is in my opinion more readable and clean:\n<include>**\/*Test.class<\/include><include>**\/*Spec.class<\/include>\n(thanks to Tomek Pęksa for pointing this out!)\n\nWith such configuration, we can write either traditional JUnit test and put them in src\/test\/java directory or groovy spock specifications and place them in src\/test\/groovy. And both will work together just fine :) In one of my next posts I’ll write something about using spock and its mocking abilities in practice, so stay in tune.\n\n","protected":false},"author":48,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[11],"tags":[50,68,90,411,30],"class_list":{"0":"post-12673","1":"post","2":"type-post","3":"status-publish","4":"format-standard","6":"category-development-design","7":"tag-groovy","8":"tag-java","9":"tag-maven","10":"tag-spock","11":"tag-testing"},"_links":{"self":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts\/12673","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/users\/48"}],"replies":[{"embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/comments?post=12673"}],"version-history":[{"count":6,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts\/12673\/revisions"}],"predecessor-version":[{"id":14751,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/posts\/12673\/revisions\/14751"}],"wp:attachment":[{"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/media?parent=12673"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/categories?post=12673"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/touk.pl\/blog\/wp-json\/wp\/v2\/tags?post=12673"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}