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
– Manmay, Commented Jun 5, 2015 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
– jakehschwartz, Commented Jun 5, 2015 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
– Dude, Commented Jun 9, 2015 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
– jakehschwartz, Commented Jun 9, 2015 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
– Dude, Commented Jun 11, 2015 at 9:28

Saikat · Accepted Answer · 2020-03-12 21:17:37Z

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, 2020 at 21:17

Saikat

17.5k22 gold badges127 silver badges146 bronze badges

answered Jun 15, 2015 at 14:24

jakehschwartz

1,0052 gold badges13 silver badges33 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Vova Rozhkov Over a year ago

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.

Francesco Over a year ago

From Spring Boot 1.2.1 you can use @WebIntegrationTest instead of @WebAppConfiguration and @IntegrationTest.

Martín Zaragoza Over a year ago

the repository code does not work. Tests fail when running ./gradlew clean build

jakehschwartz Over a year ago

@MartínZaragoza I'm not surprised it no longer works, the question is over 3 years old.

Nick Grealy · Accepted Answer · 2017-02-18 12:19:26Z

7

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
)

edited Feb 18, 2017 at 12:19

answered Aug 16, 2016 at 14:48

Nick Grealy

26.2k9 gold badges112 silver badges127 bronze badges

1 Comment

Fernando Sanchiz Over a year ago

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

Joe Stepowski · Accepted Answer · 2016-02-16 07:51:54Z

1

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;
...}

answered Feb 16, 2016 at 7:51

Joe Stepowski

6661 gold badge6 silver badges8 bronze badges

Comments

LucasP · Accepted Answer · 2015-06-08 13:50:01Z

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 8, 2015 at 13:50

answered Jun 8, 2015 at 13:42

LucasP

1,73516 silver badges24 bronze badges

2 Comments

jakehschwartz Over a year ago

I don't know if this will work any better because this still won't start my application.

LucasP Over a year ago

@JakeSchwartz OK, that's all I have! Good Luck!

Community · Accepted Answer · 2017-05-23 11:46:19Z

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, 2017 at 11:46

CommunityBot

11 silver badge

answered Jun 8, 2015 at 13:55

hd1

34.9k5 gold badges83 silver badges95 bronze badges

3 Comments

jakehschwartz Over a year ago

So you are saying build the jar, run the jar and then run the tests in another thread?

jakehschwartz Over a year ago

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.

deFreitas Over a year ago

@hd1 How you access this from static method?

Collectives™ on Stack Overflow

Cucumber Test a Spring Boot Application

5 Answers 5

4 Comments

1 Comment

Comments

2 Comments

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

4 Comments

1 Comment

Comments

2 Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related