Cucumber Test a Spring Boot Application

Question

Does anyone know where I can find a sample application where Cucumber is used to test a Spring Boot application through Gradle? I can run the tests fine starting the server on the cmd line and using my IDE, but I need to be able to run them all programmatically on the CI server. I saw the answer on here but that solution did not work for me, most likely because I have multiple step def files.

Here is my setup

build.grade (Mentioned in the other question)

testCompile ("org.springframework.boot:spring-boot-starter-test",
    ...
    "info.cukes:cucumber-spring:${cucumberVersion}")

CucumberTest.java

@RunWith(Cucumber.class)
@CucumberOptions(format = "pretty", features = "src/test/resources")
public class CucumberTest{
}

AbstractSpringTest.java (Extended by all the StepDef files)

@SpringApplicationConfiguration(classes = Application.class)
@RunWith(SpringJUnit4ClassRunner.class)
@Ignore
public abstract class AbstractSpringTest
{ ... }

It's not doing the correct thing on start up because its 1. trying to initialize my step def files and 2. My application is not started and the cucumber tests cannot make a connection.

Thanks.

EDIT: Or if someone can tell me how to start and stop the application using gradle, that would be acceptable as well.

in your gradle configuration start spring-boot before you execute your cucumber test cases. Because your spring-boot app should be in a running condition before executing cucumber test cases. — Manmay, Jun 05 '15 at 14:10
I don't know much groovy/gradle so could you give me an example? It starts itself for my integration tests so I figured I could use a similar mechanism. — jakehschwartz, Jun 05 '15 at 15:23
have you tried `@IntegrationTest` . this will fire up your webserver etc as far as i know. i also use ` testCompile group: 'info.cukes', name: 'cucumber-junit', version:cucumberVersion` next to cucumber-spring. can you run your cucumber tests as junit tests in your ide? — Dude, Jun 09 '15 at 12:33
Yes, I have cucumber-junit included. I cannot run my cucumber tests as junit tests from the IDE. Adding @IntegrationTest to my CucumberTest class and running that class as junit did not solve my problems. — jakehschwartz, Jun 09 '15 at 13:44
have you tried configurating the context for the test? `@ContextConfiguration(classes = YourAppConfig.class, loader = SpringApplicationContextLoader.class)` together with the `@IntegrationTest ` can you run your application through your IDE or isnt that working either? — Dude, Jun 11 '15 at 09:28
I have tried that, yes. I think it is working but there seems to be a bug in Spring Boot. I use @EnableAutoConfiguration(exclude = ...) but those auto configuration classes are not being excluded when I run the tests. I am waiting for verification from the Spring Boot team. — jakehschwartz, Jun 11 '15 at 13:20

score 13 · Accepted Answer · edited Mar 12 '20 at 21:17

13

I have solved the issue with some help from this question.

Here is the repository with the answer: https://github.com/jakehschwartz/spring-boot-cucumber-example

In short, the AbstractSpringTest class needs to have the following annotations:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = DemoApplication.class, loader = SpringApplicationContextLoader.class)
@WebAppConfiguration
@IntegrationTest

edited Mar 12 '20 at 21:17

Saikat

8,190
12
69
94

answered Jun 15 '15 at 14:24

jakehschwartz

945
2
12
31

2

Thank you! One important thing I missed to get this annotations work is presence of `info.cukes:cucumber-spring` in classpath. Didn't noticed that and struggled a little bit trying to run it. – Vladimir Rozhkov Jun 23 '15 at 13:22
2

From Spring Boot 1.2.1 you can use `@WebIntegrationTest` instead of `@WebAppConfiguration` and `@IntegrationTest`. – Francesco Jun 13 '16 at 12:23
the repository code does not work. Tests fail when running `./gradlew clean build` – Martín Zaragoza Oct 19 '18 at 02:22
@MartínZaragoza I'm not surprised it no longer works, the question is over 3 years old. – jakehschwartz Oct 22 '18 at 18:54

Nick Grealy · Answer 2 · 2017-02-18T12:19:26.170

I had a similar symptom, my cucumber wouldn't start up the Spring context...

Turns out I had missed (one of) the following dependencies:

build.gradle

testCompile "info.cukes:cucumber-junit:1.2.4"
testCompile "info.cukes:cucumber-java:1.2.4"
testCompile "info.cukes:cucumber-spring:1.2.4"

StepDefs.java

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(
        loader = SpringApplicationContextLoader.class,
        classes = Application.class
)
@WebIntegrationTest(randomPort = true)
public class StepDefs {

    @Value("${local.server.port}")
    int port;

}

Update: SpringBoot 1.5.1

@ContextConfiguration(
        loader = SpringBootContextLoader.class,
        classes = Application.class
)

I've the same problem and the only thing that works for me searching in other sites is this Update for SpringBoot 1.5.1 — Fernando Sanchiz, Jul 04 '17 at 09:49

score 1 · Answer 3 · answered Feb 16 '16 at 07:51

Further to @jakehschwartz, if you want the web app to start on a random available port, AbstractSpringTest needs:

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = Application.class, loader = SpringApplicationContextLoader.class)
@WebIntegrationTest({"server.port=0"})
public abstract class AbstractSpringTest {

        @Value("${local.server.port}")
        protected int serverPort;
...}

LucasP · Answer 4 · 2015-06-08T13:50:01.580

0

I did something like this to get Spring to work with JUnit parameterized tests. It should be the same concept for Cucumber, but I haven't tried it. I was using XML configuration, so that might make a difference.

RunWithSpringJUnit4

public abstract class RunWithSpringJUnit4 {

    private TestContextManager testContextManager;

    public RunWithSpringJUnit4() {
        try {
            this.testContextManager = new TestContextManager(getClass());
            this.testContextManager.prepareTestInstance(this);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

CucumberTest

@RunWith(Cucumber.class)
@CucumberOptions(format = "pretty", features = "src/test/resources")
public class CucumberTest extends RunWithSpringJUnit4 {
}

edited Jun 08 '15 at 13:50

answered Jun 08 '15 at 13:42

LucasP

1,425
12
22

I don't know if this will work any better because this still won't start my application. – jakehschwartz Jun 08 '15 at 16:26
@JakeSchwartz OK, that's all I have! Good Luck! – LucasP Jun 08 '15 at 17:34

score 0 · Answer 5 · edited May 23 '17 at 11:46

0

First, you'll need to ensure that you have applied spring-boot in gradle. Invoke gradle build which will produce a runnable jar. Instead of having your manifest call for the Spring class as your main, have a wrapper that starts it in a thread, waits for it to settle down and runs Cucumber:

@RunWith(Cucumber.class)
public class LucasePsCucumberTest implements Runnable {
    public static void main(String[] args) {
        Thread t = new Thread(this);
        t.start();
        // wait for t
        cucumber.api.cli.Main(null);
     }
}

edited May 23 '17 at 11:46

Community

1
1

answered Jun 08 '15 at 13:55

hd1

30,506
4
69
81

So you are saying build the jar, run the jar and then run the tests in another thread? – jakehschwartz Jun 08 '15 at 16:24
I think I understand what you are saying but I don't think it will help me. I guess I should go back and edit my original question. I have no problem running cucumber tests. I need to be able to run them through gradle so that my CI server can pass my build. – jakehschwartz Jun 08 '15 at 16:31
@hd1 How you access this from static method? – deFreitas Feb 12 '16 at 14:52

Cucumber Test a Spring Boot Application

5 Answers5

Linked