Giter Club home page Giter Club logo

lambda-behave's Introduction

Introduction

If you're a Java developer and you've seen the fluent, modern specification frameworks available in other programming languages such as spock or jasmine then Lambda Behave is for you. Its goal is to make testing a more pleasant experience than it currently is with junit.

The changelog explains what features have been added in each release.

Fluent Specifications

The Lambda Behave Specification design has several goals in mind:

  • To read like plain English.
  • To encourage describing tests using long and descriptive sentences, rather than a few words.
  • An API that is fluent and discoverable nearly entirely through IDE auto-completion.
public class StackSpec {{

    Stack<Integer> stack = new Stack<>();

    describe("a stack", it -> {

        it.isSetupWith(stack::clear);

        it.isConcludedWith(stack::clear);

        it.should("be empty when created", expect -> {
            expect.that(stack).isEmpty();
        });

There are many, many, expectations builtin to the framework - not just isEmpty().

Every specification suite starts its declaration using the Suite.describe method. From that point onwards your IDE should be able to auto-complete the domain specific language for declaring specifications, but just in case you want more information, here's the details.

  • If you want to specify a property about your system use it.should.
  • If you want describe an expectation of that property, use expect.that. This will get you to a fluent API restricted to the type of value that you're making the expectation about. The expectation system is based upon hamcrest. Lambda Behave doesn't compromise the ability to compose matchers in favour of fluency - if you want to compose in more complex flavours simply use expect.that(value).is() and then you can use regular Hamcrest matchers. In my experience this is a rare, albeit useful, breakout option.
  • If you want to setup or teardown data before or after each specification use it.isSetupWith and it.isConcludedWith.
  • If you want to setup or teardown data before or after each suite use it.initializesWith and it.completesWith.
  • Don't worry - I know some Java 8 lambdafied APIs don't deal with exceptions very well but you can throw exceptions in all our callbacks and the appropriate error will be reported, not just break the library.

Data Driven Specifications

The ability to parametrise specifications by different data inputs. Data driven tests in TestNG or the @Parameterized junit annotation perform a similar task. @Parameterized only parameterises at the level of a class, whereas Lambda Behave parameterises at the level of a specification.

describe("a pair of numbers", it -> {
    it.uses(4, 2)
      .and(6, 3)
      .toShow("%d / %d is two", (expect, x, y) -> {
          expect.that(x / y).is(2);
      });
});

The API in Lambda Behave is both fluent and also type safe and doesn't rely on reflection magic. The uses method is overloaded to allow a different number of columns of data to be used. It also supports taking streams or lists of data as its inputs, rather than explicitly chaining individual values.

Not only is the specification parameterised by the data, but the description is also parameterised, its name being interpreted as a format String. The aforementioned test would output the following:

a pair of numbers
  4 / 2 is two
  6 / 3 is two

Generated Specifications

Lambda Behave can automatically generate testcases for your to test your code with, similar to quick check or scala check. The Fluent API for this is similar to data driven specifications allows for control over the way that the values are generated and how many need to be generated. Here is an example of how to show that reversing a String twice returns the same String using randomly generated test case values.

it.requires(10)
  .example(asciiStrings())
  .toShow("reversing a String twice returns the original String", (expect, str) -> {
      String same = new StringBuilder(str).reverse().reverse().toString();
      expect.that(same).isEqualTo(str);
  });

All generated specifications follow this common pattern where;

  • The require clause expresses how many values to generate,
  • The example clause states what type of objects to generate and how to generate them, This is overloaded to allow multiple columns of testcase values to be generated.
  • The toShow clause behaves like a toShow clause for a data drive spec. It is type safe against the the different columns. So in the above example the paramter str will have had its type correctly inferred as String.

Downloading Lambda Behave

If you're using a maven project then you can download Lambda Behave using the following pom entry.

<dependency>
    <groupId>com.insightfullogic</groupId>
    <artifactId>lambda-behave</artifactId>
    <version>0.4</version>
    <scope>test</scope>
</dependency>

If you're using a gradle project then you can use:

testCompile group: 'com.insightfullogic', name: 'lambda-behave', version: '0.3'

There's also an example project and there's published Javadoc.

Junit Integration

Lambda Behave also offers a junit runner. This lets you easily integrate into existing your existing test suite, or the tests via an Eclipse, Intellij, Netbeans, Maven, Gradle or Ant. You just add an annotation to enable this, and it can be run through your normal tooling.

@RunWith(JunitSuiteRunner.class)
public class StackSpec {{

Lambdas - what the hell are they?

Conveniently I've written a book on Lambda expressions in Java 8 and the cleaner code they enable!

Licensing

This library is licensed under the liberal MIT license - see LICENSE for the full details. This means that it's free for any use.

More Details and How to contribute

The wiki has more information.

lambda-behave's People

Contributors

alexdik avatar alyphen avatar bangarharshit avatar cheeseng avatar fauxfaux avatar jlleitschuh avatar jypma avatar karianna avatar mansikataria avatar opavlyshak avatar richardwarburton avatar robertfirek avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

lambda-behave's Issues

Heisen Spec Detection

Some specifications totally fail at being reliable and its hard for a developer to detect them. It would be good to be able to write a log describing a test run and be able to offline analyze a log to detect what is heisen or not.

Ability to run individual specs

Currently can only run a whole class at a time in IDEs, due to the way the junit runner interacts. This probably needs plugins. In priority order:

intellij
maven
eclipse

Add support for quickcheck style testing

Would be great to also be able to log and re-use seed values for randomly generated test suites, in order to ensure determinism. This seems to be the main complaint against quickcheck.

Asserts on a different thread

Currently can't support completely async APIs due to expectations throwing exceptions, rather than pushing messages onto some kind of eventbus or handler.

Have the option to lazily generate test cases

Currently we generate all test case instances up front, it would be nice to be able to do it lazily in order to avoid eating the memory required. Unfortunately this is hard to integrate with junit due to junit needing you to specify your test names up front.

java.lang.NoSuchFieldError: NULL with JUnit 4.5

Got the following exception when trying to run with JUnit 4.5 (it was existing project to which I added lamda-behave):

java.lang.NoSuchFieldError: NULL
    at org.junit.runners.ParentRunner.<init>(ParentRunner.java:57)
    at org.junit.internal.requests.ClassRequest.buildRunner(ClassRequest.java:33)
    at org.junit.internal.requests.ClassRequest.getRunner(ClassRequest.java:28)

Works fine with JUnit 4.11. Created this issue mostly to "document" the exception.

Maven JAR analyser unable to read target byte code

Could just be a Maven plugin incompatibility with Java 8. Feel free to assign to me as a low level bug.

[WARNING] Unable to process class com/insightfullogic/lambdabehave/BehaveRunner.class in JarAnalyzer File /Users/karianna/Documents/workspace/jclarity/lambda-behave/lambda-behave/target/lambda-behave-0.2-SNAPSHOT.jar
org.apache.bcel.classfile.ClassFormatException: Invalid byte tag in constant pool: 18
at org.apache.bcel.classfile.Constant.readConstant(Constant.java:146)
at org.apache.bcel.classfile.ConstantPool.(ConstantPool.java:67)
at org.apache.bcel.classfile.ClassParser.readConstantPool(ClassParser.java:222)
at org.apache.bcel.classfile.ClassParser.parse(ClassParser.java:136)
at org.apache.maven.shared.jar.classes.JarClassesAnalysis.analyze(JarClassesAnalysis.java:92)
at org.apache.maven.report.projectinfo.dependencies.Dependencies.getJarDependencyDetails(Dependencies.java:255)
at org.apache.maven.report.projectinfo.dependencies.renderer.DependenciesRenderer.hasSealed(DependenciesRenderer.java:1454)
at org.apache.maven.report.projectinfo.dependencies.renderer.DependenciesRenderer.renderSectionDependencyFileDetails(DependenciesRenderer.java:536)
at org.apache.maven.report.projectinfo.dependencies.renderer.DependenciesRenderer.renderBody(DependenciesRenderer.java:263)
at org.apache.maven.reporting.AbstractMavenReportRenderer.render(AbstractMavenReportRenderer.java:79)
at org.apache.maven.report.projectinfo.DependenciesReport.executeReport(DependenciesReport.java:186)
at org.apache.maven.reporting.AbstractMavenReport.generate(AbstractMavenReport.java:190)
at org.apache.maven.plugins.site.ReportDocumentRenderer.renderDocument(ReportDocumentRenderer.java:219)
at org.apache.maven.doxia.siterenderer.DefaultSiteRenderer.renderModule(DefaultSiteRenderer.java:319)
at org.apache.maven.doxia.siterenderer.DefaultSiteRenderer.render(DefaultSiteRenderer.java:135)
at org.apache.maven.plugins.site.SiteMojo.renderLocale(SiteMojo.java:175)
at org.apache.maven.plugins.site.SiteMojo.execute(SiteMojo.java:138)
at org.apache.maven.plugin.DefaultBuildPluginManager.executeMojo(DefaultBuildPluginManager.java:132)
at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:208)
at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:153)
at org.apache.maven.lifecycle.internal.MojoExecutor.execute(MojoExecutor.java:145)
at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject(LifecycleModuleBuilder.java:116)
at org.apache.maven.lifecycle.internal.LifecycleModuleBuilder.buildProject(LifecycleModuleBuilder.java:80)
at org.apache.maven.lifecycle.internal.builder.singlethreaded.SingleThreadedBuilder.build(SingleThreadedBuilder.java:51)
at org.apache.maven.lifecycle.internal.LifecycleStarter.execute(LifecycleStarter.java:120)
at org.apache.maven.DefaultMaven.doExecute(DefaultMaven.java:347)
at org.apache.maven.DefaultMaven.execute(DefaultMaven.java:154)
at org.apache.maven.cli.MavenCli.execute(MavenCli.java:584)
at org.apache.maven.cli.MavenCli.doMain(MavenCli.java:213)
at org.apache.maven.cli.MavenCli.main(MavenCli.java:157)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:483)
at org.codehaus.plexus.classworlds.launcher.Launcher.launchEnhanced(Launcher.java:289)
at org.codehaus.plexus.classworlds.launcher.Launcher.launch(Launcher.java:229)
at org.codehaus.plexus.classworlds.launcher.Launcher.mainWithExitCode(Launcher.java:415)
at org.codehaus.plexus.classworlds.launcher.Launcher.main(Launcher.java:356)

Fix stack traces in errors

Currently throwing away some stack trace information which tells you where the problem originated from if there's an error. Should show the real origin.

Web Based Runner

Infinitest style always on web runner that re-runs specifications as code changes.

Business Domain class generator combinators

The goal for this issue is to make it easier for people to produce generators for classes in their domain model.

Eg: have a way of producing a constructor for a business domain object such as:

new BDO(someInt, someLong);

With an easy combinator, something like:

constructing(BDO::new).with(integersUpTo(10), longs());

Testng integration

Ideally supporting all the features that junit supports, probably requires removing the dependency of the core on junit.

HTML Report

A nice readable + hostable dashboard style html report, containing all the information in #8 .

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.