paulcwarren / ginkgo4j Goto Github PK

View Code? Open in Web Editor NEW

27.0 7.0 2.0 917 KB

A Java BDD Testing Framework (based on RSpec and Ginkgo)

Java 100.00%

tdd bdd java rspec ginkgo junit spring intellij eclipse

ginkgo4j's Introduction

Ginkgo4j

A Java BDD Testing Framework (based on RSpec and ginkgo)

Jump to the docs to see more.

Feature List:-

Structure your BDD-style tests expressively:
- Nestable Describe and Context container blocks
- BeforeEach and AfterEach blocks for setup and teardown
- It blocks that hold your assertions
- JustBeforeEach blocks that separate creation from configuration (also known as the subject action pattern).
Fast testing with parallel execution
Test runners that lets you:
- Focus tests through FDescribe, FContext and FIt constructs
- Test your Spring applications

Requires

Java 8

Getting Started

Add the ginkgo4j to your project as a test dependency. For a maven project add:

<dependency>
    <groupId>com.github.paulcwarren</groupId>
    <artifactId>ginkgo4j</artifactId>
    <version>1.0.14</version>
    <scope>test</scope>
</dependency>

or for a Gradle project add:

compile 'com.github.paulcwarren:ginkgo4j:1.0.14'

or for a Gradle 7 project add:

dependencies {
    testImplementation 'com.github.paulcwarren:ginkgo4j:1.0.14'
}

for other build systems see here.

Create a junit test class
- Add the following imports:

import org.junit.runner.RunWith;
import static com.github.paulcwarren.ginkgo4j.Ginkgo4jDSL.*;
import com.github.paulcwarren.ginkgo4j.Ginkgo4jConfiguration;
import com.github.paulcwarren.ginkgo4j.Ginkgo4jRunner;

Annotate your test class with:-

@RunWith(Ginkgo4jRunner.class)

And the following template:

	{
		Describe("Replace me", () -> {
			It("Replace me too", () -> {
				fail("Not yet implemented");
			});
		});
	}

Optionally, you can control the number of threads used with @Ginkgo4jConfiguration(threads = 1)

Getting Started with Spring

Add the following imports:-

import org.junit.runner.RunWith;
import static com.github.paulcwarren.ginkgo4j.Ginkgo4jDSL.*;
import com.github.paulcwarren.ginkgo4j.Ginkgo4jSpringRunner;

Annotate your test class with:-

@RunWith(Ginkgo4jSpringRunner.class)

Add the following template:

	{
		Describe("Replace me", () -> {
			It("Replace me too", () -> {
				fail("Not yet implemented");
			});
		});
	}
	@Test
	public void noop() {
	}

Screenshots

Eclipse

Intellij

ginkgo4j's People

Stargazers

Watchers

Forkers

jacobjohansen lwoydziak

ginkgo4j's Issues

A Describe within a Context within a Describe thinks there's a non-existent test that fails to start

  {
    Describe("Subscription Store", () -> {

      Context("with an empty subscriptionStore", () -> {
        Describe("creating a subscription", () -> {
          It("Should be happy and free", () -> assertThat("yes").isEqualTo("yes"));
      });
      });
    });

  }

Display context/describe chain when test fails.

package com.github.paulcwarren.ginkgo4j;
import static com.github.paulcwarren.ginkgo4j.Ginkgo4jDSL.AfterEach;
import static com.github.paulcwarren.ginkgo4j.Ginkgo4jDSL.BeforeEach;
import static com.github.paulcwarren.ginkgo4j.Ginkgo4jDSL.Context;
import static com.github.paulcwarren.ginkgo4j.Ginkgo4jDSL.Describe;
import static com.github.paulcwarren.ginkgo4j.Ginkgo4jDSL.It;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.MatcherAssert.assertThat;
import org.junit.Ignore;
import org.junit.runner.RunWith;
import junit.framework.Assert;
@Ignore
@SuppressWarnings("deprecation")
@RunWith(Ginkgo4jRunner.class)
//@Ginkgo4jConfiguration(threads=1)
public class ExampleTests {
{
		Context("parent context", () -> {
			BeforeEach(() -> {
				example = new Example();
			});
			Describe("child context", () -> {
				It("it", () -> {
					Assert.assertTrue(true);
				});
			});
		});
}}

Above example shows the error text when using gradle/junit as test environment:
ExampleTests > It.it FAILED

Would be easier to find test if the error was:
ExampleTests > parent context.child context.it FAILED

Nice work by the way @paulcwarren, I am finding it very easy to use.

Exception in Context -> Tests Ignored

I don't know if this is a valid use case but here goes:

Given:
A context-local variable is defined and assigned in a context block, but not within a beforeEach

When:
The assignment throws an exception, in this case because a field was not set before calling build()

Expected:
All tests in that context block show up as failed or errored

Actual:
No tests in that context block show up at all, in fact the whole file can "go green"

Let me know if you would like an example

When doing multiple BeforeEach and at the end of the Describe section, subsequent BeforeEach is not recognized.

		Describe("multiple BeforeEach", ()->{
			AtomicReference<String> capture = new AtomicReference<>("");
			It("then sets 1st capture", () -> {
			  Assert.assertSame("1st", capture.get());
			});
			Describe("second BeforeEach", ()->{
				It("then sets 2nd capture", () -> {
					Assert.assertSame("2nd", capture.get());
				});
				BeforeEach(() -> {
					capture.set("2nd");
				});
			});
			BeforeEach(() -> {
				capture.set("1st");
			});
		});

The above test recreates the error condition.

Describe block with empty message does not run

e.g.

Describe("", () -> {
    It("stuff", () -> {
        assertThat(true).isTrue();
    });
});

This won't run any tests