Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vsavkin/guinness

A port of the Jasmine testing framework to Dart.
https://github.com/vsavkin/guinness

Last synced: 9 days ago
JSON representation

A port of the Jasmine testing framework to Dart.

Awesome Lists containing this project

README 

        
# Guinness



Guinness is a port of the Jasmine library to Dart. It is based on the AngularDart implementation of Jasmine.



[![Build Status](https://travis-ci.org/vsavkin/guinness.svg?branch=master)](https://travis-ci.org/vsavkin/guinness)



## Installation



You can find the Guinness installation instructions [here](http://pub.dartlang.org/packages/guinness#installing).



## Importing the Library



```dart

import 'package:guinness/guinness.dart';



main() {

  //you specs

}

```



If you are testing a client-side application, and you want to use html matchers, import the `guinness_html` library.



```dart

import 'package:guinness/guinness_html.dart';



main() {

  guinnessEnableHtmlMatchers();

  //you specs

}

```



## Syntax



Guinness specs are comprised of `describe`, `it`, `beforeEach`, and `afterEach` blocks.



```dart

import 'package:guinness/guinness.dart';



main(){

  describe("syntax", () {

    beforeEach(() {

      print("outer before");

    });



    afterEach(() {

      print("outer after");

    });



    it("runs first", () {

      print("first");

    });



    describe("nested describe", () {

      beforeEach(() {

        print("inner before");

      });



      afterEach(() {

        print("inner after");

      });



      it("runs second", () {

        print("second");

      });

    });

  });

}

```



This will print:



    outer before, first, outer after

    outer before, inner before, second, inner after, outer after



* To exclude a `describe`, change it to `xdescribe`.

* To exclude an `it`, change it to `xit`.

* To make a `describe` exclusive, change it to `ddescribe`.

* To make an `it` exclusive, change it to `iit`.



If there is an `iit` in your spec files, Guinness will run only `iit`s. In this case `ddescribe`s will be ignored.



### Pending Specs



Guinness supports pending describe and it blocks (blocks without a callback).



```dart

describe("pending describe");

xdescribe("pending xdescribe");

ddescribe("pending ddescribe");



it("pending it");

xit("pending xit");

iit("pending iit");

```



## Async



Since Dart has built-in futures, the Guinness framework makes a good use out of them. If you return a future from

`beforeEach`, `afterEach`, or `it`, the framework will wait for that future to be resolved.



For instance:



```dart

beforeEach(connectToTheDatabase);

```



where `connectToTheDatabase` returns a future.



Similarly, you can write:



```dart

afterEach(releaseConnection);

```



You can also write async specs using the following technique:



```dart

it("should return an empty list when the database is empty", () {

  return queryDatabase().then((results){

    expect(results).toEqual([]);

  });

});

```



If a returned future gets rejected, the test fails.



## Expect



They way you write assertions in Guinness is by using the `expect` function, as follows:



```dart

expect(2).toEqual(2);

```



These are a few examples:



```dart

expect(2).toEqual(2);

expect([1,2]).toContain(2);

expect(2).toBe(2);

expect(()=> throw "BOOM").toThrow();

expect(()=> throw "BOOM").toThrow("BOOM");

expect(()=> throw "Invalid Argument").toThrowWith(message: "Invalid");

expect(()=> throw new InvalidArgument()).toThrowWith(anInstanceOf: InvalidArgument);

expect(()=> throw new InvalidArgument()).toThrowWith(type: ArgumentException);

expect(false).toBeFalsy();

expect(null).toBeFalsy();

expect(true).toBeTruthy();

expect("any object").toBeTruthy();

expect("any object").toBeDefined();

expect(null).toBeNull();

expect("not null").toBeNotNull();



expect(2).not.toEqual(1);

expect([1,2]).not.toContain(3);

expect([1,2]).not.toBe([1,2]);

expect((){}).not.toThrow();

expect(null).not.toBeDefined();



expect(new DocumentFragment.html("
some html
"))

    .toHaveHtml("
some html
");



expect(new DocumentFragment.html("
some text
"))

    .toHaveText("some text");



expect(new DivElement()..classes.add('abc'))

    .toHaveClass("abc");



expect(new DivElement()..attributes['attr'] = 'value')

    .toHaveAttribute("attr");



expect(new DocumentFragment.html("
some html
"))

    .not.toHaveHtml("
some other html
");



expect(new DocumentFragment.html("
some text
"))

    .not.toHaveText("some other text");



expect(new DivElement()..classes.add('abc'))

    .not.toHaveClass("def");



expect(new DivElement()..attributes['attr'] = 'value')

    .not.toHaveAttribute("other-attr");



final select = new SelectElement();

select.children

  ..add(new OptionElement(value: "1"))

  ..add(new OptionElement(value: "2", selected: true))

  ..add(new OptionElement(value: "3"));

expect(select).toEqualSelect(["1", ["2"], "3"]);

```



You can also use unittest matchers, like this:



```dart

expect(myObject).to(beValid); //where beValid is a unittest matcher

```



## Migrating from Unittest



To make migration from the unittest library to Guinness easier, `expect` supports an optional second argument.



```dart

expect(myObject, beValid); //same as expect(myObject).to(beValid);

```



This keeps your unittest assertions working, so you can change them one by one.



While transitioning you can have both the unittest and guinness libraries imported:



```dart

import 'package:unittest/unittest.dart' hide expect;

import 'package:guinness/guinness.dart';

```



## Extending Guinness



If you are using a lot of custom matchers, and using `expect(object).to(matcher)` is tedious,

you can extend the library, as follows:



```dart

library test_helper;



import 'guinness.dart' as gns;

export 'guinness.dart';



final _m = gns.guinness.matchers;



class CustomExpect extends gns.Expect {

  CustomExpect(actual) : super(actual);



  toBePositive() => _m.expect(actual > 0, true, reason: 'is not positive');

}



CustomExpect expect(actual) => new CustomExpect(actual);

```



## Spy



Guinness supports Jasmine-like spy functions:



```dart

final s = guinness.createSpy("my spy");

expect(s).not.toHaveBeenCalled();



s(1);

expect(s).toHaveBeenCalled();

expect(s).toHaveBeenCalledOnce();

expect(s).toHaveBeenCalledWith(1);

expect(s).toHaveBeenCalledOnceWith(1);

expect(s).not.toHaveBeenCalledWith(2);



s(2);

expect((){

  expect(s).toHaveBeenCalledOnce();

}).toThrow();



expect((){

  expect(s).toHaveBeenCalledOnceWith(1);

}).toThrow();

```



In addition, Guinness support spy objects:



```dart

class SomeSpy extends SpyObject implements SomeInterface {}



...



final s = new SomeSpy();

s.invoke(1,2);

s.name;

s.name = 'some name';



expect(s.spy("invoke")).toHaveBeenCalled();

expect(s.spy("get:name")).toHaveBeenCalled();

expect(s.spy("set:name")).toHaveBeenCalled();

```



And:



```dart

final s = new SomeSpy();

s.spy("invoke").andCallFake((a,b) => a + b);



expect(s.invoke(1,2)).toEqual(3);

```



You can also use the `mock` and `dart_mocks` libraries with it.



## Guinness and Unittest



Guinness supports pluggable backends, but by default runs on top of the unittest library. Which means that if

unittest.autoStart is set to true, your specs will run automatically.



You can always initialize specs manually:



```dart

guinness.initSpecs();

```



You can also run the specs, like this:



```dart

guinness.runSpecs();

```



Usually, you don't need to worry about it.



## Guinness and Karma



Guinness works with Karma. Just include `initSpecs`, as follows:



```dart

files: [

  "test/main1_test.dart",

  "test/main2_test.dart",

  "packages/guinness/init_specs.dart",

  {pattern: '**/*.dart', watched: true, included: false, served: true}

]

```



## Status



There are a few things that are still not supported (e.g., handling named parameters in expectations).



## Implementation Details



### Key Ideas



The main idea is to treat the Jasmine syntax as a domain specific language. Therefore,

the implementation clearly  separates such things as: syntax, semantic model, and execution model. Let's quickly look

  at the benefits this approach provides:



#### The semantic model is separate from the syntax.



The semantic model consists of It, Describe, Suite, BeforeEach, and AfterEach objects. You can create and analyse

them  without using the context-dependent nested Jasmine syntax.



#### The parsing of specs is separate from the execution of specs.



The library builds a tree of the It, Describe, Suite, BeforeEach, and AfterEach objects first. And after that,

as a  separate step, executes them. It enables all sorts of preprocessing (e.g., filtering, reordering).



#### Pluggable backends.



Since the library is a DSL, there can be multiple backend libraries actually executing the specs. By default,

the  library comes with the unittest backend.



# Contributors



* Google Inc

* Victor Savkin

* Victor Berchet

* Marko Vuksanovic